@girs/gdk-4.0 4.0.0-3.2.8 → 4.0.0-3.2.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/gdk-4.0)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Gdk-4.0, generated from library version 4.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.8.
8
+ GJS TypeScript type definitions for Gdk-4.0, generated from library version 4.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.9.
9
9
 
10
10
 
11
11
  ## Install
package/gdk-4.0.d.cts CHANGED
@@ -3876,7 +3876,8 @@ export function keyval_to_upper(keyval: number): number
3876
3876
  * This is often useful for implementing the
3877
3877
  * [vfunc`Gdk`.Paintable.get_current_image] virtual function
3878
3878
  * when the paintable is in an incomplete state (like a
3879
- * [class`Gtk`.MediaStream] before receiving the first frame).
3879
+ * [GtkMediaStream](../gtk4/class.MediaStream.html) before receiving
3880
+ * the first frame).
3880
3881
  * @param intrinsic_width The intrinsic width to report. Can be 0 for no width.
3881
3882
  * @param intrinsic_height The intrinsic height to report. Can be 0 for no height.
3882
3883
  * @returns a `GdkPaintable`
@@ -4520,7 +4521,8 @@ export class Paintable extends GObject.Object {
4520
4521
  * This is often useful for implementing the
4521
4522
  * [vfunc`Gdk`.Paintable.get_current_image] virtual function
4522
4523
  * when the paintable is in an incomplete state (like a
4523
- * [class`Gtk`.MediaStream] before receiving the first frame).
4524
+ * [GtkMediaStream](../gtk4/class.MediaStream.html) before receiving
4525
+ * the first frame).
4524
4526
  * @param intrinsic_width The intrinsic width to report. Can be 0 for no width.
4525
4527
  * @param intrinsic_height The intrinsic height to report. Can be 0 for no height.
4526
4528
  * @returns a `GdkPaintable`
@@ -4816,8 +4818,9 @@ export interface Toplevel extends Surface {
4816
4818
  /**
4817
4819
  * Sets keyboard focus to `surface`.
4818
4820
  *
4819
- * In most cases, [method`Gtk`.Window.present_with_time] should be
4820
- * used on a [class`Gtk`.Window], rather than calling this function.
4821
+ * In most cases, [gtk_window_present_with_time()](../gtk4/method.Window.present_with_time.html)
4822
+ * should be used on a [GtkWindow](../gtk4/class.Window.html), rather than
4823
+ * calling this function.
4821
4824
  * @param timestamp timestamp of the event triggering the surface focus
4822
4825
  */
4823
4826
  focus(timestamp: number): void
@@ -4935,8 +4938,8 @@ export interface Toplevel extends Surface {
4935
4938
  * Sets the startup notification ID.
4936
4939
  *
4937
4940
  * When using GTK, typically you should use
4938
- * [method`Gtk`.Window.set_startup_id] instead of this
4939
- * low-level function.
4941
+ * [gtk_window_set_startup_id()](../gtk4/method.Window.set_startup_id.html)
4942
+ * instead of this low-level function.
4940
4943
  * @param startup_id a string with startup-notification identifier
4941
4944
  */
4942
4945
  set_startup_id(startup_id: string): void
@@ -4956,8 +4959,8 @@ export interface Toplevel extends Surface {
4956
4959
  * allows the window manager to do things like center `surface`
4957
4960
  * on `parent` and keep `surface` above `parent`.
4958
4961
  *
4959
- * See [method`Gtk`.Window.set_transient_for] if you’re using
4960
- * [class`Gtk`.Window] or [class`Gtk`.Dialog].
4962
+ * See [gtk_window_set_transient_for()](../gtk4/method.Window.set_transient_for.html)
4963
+ * if you’re using [GtkWindow](../gtk4/class.Window.html).
4961
4964
  * @param parent another toplevel `GdkSurface`
4962
4965
  */
4963
4966
  set_transient_for(parent: Surface): void
@@ -5577,8 +5580,9 @@ export interface Clipboard {
5577
5580
  * exit. Depending on the platform, the functionality may not be available
5578
5581
  * unless a "clipboard manager" is running.
5579
5582
  *
5580
- * This function is called automatically when a [class`Gtk`.Application] is
5581
- * shut down, so you likely don't need to call it.
5583
+ * This function is called automatically when a
5584
+ * [GtkApplication](../gtk4/class.Application.html)
5585
+ * is shut down, so you likely don't need to call it.
5582
5586
  * @param io_priority the I/O priority of the request
5583
5587
  * @param cancellable optional `GCancellable` object
5584
5588
  * @param callback callback to call when the request is satisfied
@@ -5601,8 +5605,9 @@ export interface Clipboard {
5601
5605
  * exit. Depending on the platform, the functionality may not be available
5602
5606
  * unless a "clipboard manager" is running.
5603
5607
  *
5604
- * This function is called automatically when a [class`Gtk`.Application] is
5605
- * shut down, so you likely don't need to call it.
5608
+ * This function is called automatically when a
5609
+ * [GtkApplication](../gtk4/class.Application.html)
5610
+ * is shut down, so you likely don't need to call it.
5606
5611
  * @param io_priority the I/O priority of the request
5607
5612
  * @param cancellable optional `GCancellable` object
5608
5613
  * @returns A Promise of: %TRUE if storing was successful.
@@ -6358,7 +6363,8 @@ export interface Cursor {
6358
6363
  * Cursors by themselves are not very interesting: they must be bound to a
6359
6364
  * window for users to see them. This is done with [method`Gdk`.Surface.set_cursor]
6360
6365
  * or [method`Gdk`.Surface.set_device_cursor]. Applications will typically
6361
- * use higher-level GTK functions such as [method`Gtk`.Widget.set_cursor] instead.
6366
+ * use higher-level GTK functions such as [gtk_widget_set_cursor()](../gtk4/method.Widget.set_cursor.html)
6367
+ * instead.
6362
6368
  *
6363
6369
  * Cursors are not bound to a given [class`Gdk`.Display], so they can be shared.
6364
6370
  * However, the appearance of cursors may vary when used on different
@@ -7225,9 +7231,9 @@ export interface Display {
7225
7231
  * Indicates to the GUI environment that the application has
7226
7232
  * finished loading, using a given identifier.
7227
7233
  *
7228
- * GTK will call this function automatically for [class`Gtk`.Window]
7234
+ * GTK will call this function automatically for [GtkWindow](../gtk4/class.Window.html)
7229
7235
  * with custom startup-notification identifier unless
7230
- * [method`Gtk`.Window.set_auto_startup_notification]
7236
+ * [gtk_window_set_auto_startup_notification()](../gtk4/method.Window.set_auto_startup_notification.html)
7231
7237
  * is called to disable that feature.
7232
7238
  * @param startup_id a startup-notification identifier, for which notification process should be completed
7233
7239
  */
@@ -7251,8 +7257,7 @@ export interface Display {
7251
7257
  */
7252
7258
  prepare_gl(): boolean
7253
7259
  /**
7254
- * Appends the given event onto the front of the event
7255
- * queue for `display`.
7260
+ * Adds the given event to the event queue for `display`.
7256
7261
  * @param event a `GdkEvent`
7257
7262
  */
7258
7263
  put_event(event: Event): void
@@ -7850,8 +7855,8 @@ export interface DrawContext {
7850
7855
  *
7851
7856
  * When using GTK, the widget system automatically places calls to
7852
7857
  * gdk_draw_context_begin_frame() and gdk_draw_context_end_frame() via the
7853
- * use of [class`Gsk`.Renderer]s, so application code does not need to call
7854
- * these functions explicitly.
7858
+ * use of [GskRenderer](../gsk4/class.Renderer.html)s, so application code
7859
+ * does not need to call these functions explicitly.
7855
7860
  * @param region minimum region that should be drawn
7856
7861
  */
7857
7862
  begin_frame(region: cairo.Region): void
@@ -10079,7 +10084,7 @@ export interface Snapshot {
10079
10084
  /**
10080
10085
  * Base type for snapshot operations.
10081
10086
  *
10082
- * The subclass of `GdkSnapshot` used by GTK is [class`Gtk`.Snapshot].
10087
+ * The subclass of `GdkSnapshot` used by GTK is [GtkSnapshot](../gtk4/class.Snapshot.html).
10083
10088
  * @class
10084
10089
  */
10085
10090
  export class Snapshot extends GObject.Object {
@@ -10367,7 +10372,7 @@ export interface Surface {
10367
10372
  * For toplevel surfaces, withdraws them, so they will no longer be
10368
10373
  * known to the window manager; for all surfaces, unmaps them, so
10369
10374
  * they won’t be displayed. Normally done automatically as
10370
- * part of [method`Gtk`.Widget.hide].
10375
+ * part of [gtk_widget_hide()](../gtk4/method.Widget.hide.html).
10371
10376
  */
10372
10377
  hide(): void
10373
10378
  /**
@@ -10446,7 +10451,7 @@ export interface Surface {
10446
10451
  * GTK will update this property automatically if the `surface` background
10447
10452
  * is opaque, as we know where the opaque regions are. If your surface
10448
10453
  * background is not opaque, please update this property in your
10449
- * [vfunc`Gtk`.Widget.css_changed] handler.
10454
+ * [GtkWidgetClass.css_changed](../gtk4/vfunc.Widget.css_changed.html) handler.
10450
10455
  * @param region a region, or %NULL to make the entire surface opaque
10451
10456
  */
10452
10457
  set_opaque_region(region: cairo.Region | null): void
@@ -10516,7 +10521,7 @@ export interface Surface {
10516
10521
  * A `GdkSurface` is a rectangular region on the screen.
10517
10522
  *
10518
10523
  * It’s a low-level object, used to implement high-level objects
10519
- * such as [class`Gtk`.Window] or [class`Gtk`.Dialog] in GTK.
10524
+ * such as [GtkWindow](../gtk4/class.Window.html).
10520
10525
  *
10521
10526
  * The surfaces you see in practice are either [iface`Gdk`.Toplevel] or
10522
10527
  * [iface`Gdk`.Popup], and those interfaces provide much of the required
@@ -11739,9 +11744,9 @@ export interface PopupLayout {
11739
11744
  * [method`Gdk`.Popup.get_position_x], [method`Gdk`.Popup.get_position_y],
11740
11745
  * [method`Gdk`.Popup.get_rect_anchor] and [method`Gdk`.Popup.get_surface_anchor]
11741
11746
  * after the popup has been presented. This can be used to adjust the rendering.
11742
- * For example, [class`Gtk`.Popover] changes its arrow position accordingly.
11743
- * But you have to be careful avoid changing the size of the popover, or it
11744
- * has to be presented again.
11747
+ * For example, [GtkPopover](../gtk4/class.Popover.html) changes its arrow position
11748
+ * accordingly. But you have to be careful avoid changing the size of the popover,
11749
+ * or it has to be presented again.
11745
11750
  * @record
11746
11751
  */
11747
11752
  export class PopupLayout {
package/gdk-4.0.d.ts CHANGED
@@ -3878,7 +3878,8 @@ function keyval_to_upper(keyval: number): number
3878
3878
  * This is often useful for implementing the
3879
3879
  * [vfunc`Gdk`.Paintable.get_current_image] virtual function
3880
3880
  * when the paintable is in an incomplete state (like a
3881
- * [class`Gtk`.MediaStream] before receiving the first frame).
3881
+ * [GtkMediaStream](../gtk4/class.MediaStream.html) before receiving
3882
+ * the first frame).
3882
3883
  * @param intrinsic_width The intrinsic width to report. Can be 0 for no width.
3883
3884
  * @param intrinsic_height The intrinsic height to report. Can be 0 for no height.
3884
3885
  * @returns a `GdkPaintable`
@@ -4522,7 +4523,8 @@ class Paintable extends GObject.Object {
4522
4523
  * This is often useful for implementing the
4523
4524
  * [vfunc`Gdk`.Paintable.get_current_image] virtual function
4524
4525
  * when the paintable is in an incomplete state (like a
4525
- * [class`Gtk`.MediaStream] before receiving the first frame).
4526
+ * [GtkMediaStream](../gtk4/class.MediaStream.html) before receiving
4527
+ * the first frame).
4526
4528
  * @param intrinsic_width The intrinsic width to report. Can be 0 for no width.
4527
4529
  * @param intrinsic_height The intrinsic height to report. Can be 0 for no height.
4528
4530
  * @returns a `GdkPaintable`
@@ -4818,8 +4820,9 @@ interface Toplevel extends Surface {
4818
4820
  /**
4819
4821
  * Sets keyboard focus to `surface`.
4820
4822
  *
4821
- * In most cases, [method`Gtk`.Window.present_with_time] should be
4822
- * used on a [class`Gtk`.Window], rather than calling this function.
4823
+ * In most cases, [gtk_window_present_with_time()](../gtk4/method.Window.present_with_time.html)
4824
+ * should be used on a [GtkWindow](../gtk4/class.Window.html), rather than
4825
+ * calling this function.
4823
4826
  * @param timestamp timestamp of the event triggering the surface focus
4824
4827
  */
4825
4828
  focus(timestamp: number): void
@@ -4937,8 +4940,8 @@ interface Toplevel extends Surface {
4937
4940
  * Sets the startup notification ID.
4938
4941
  *
4939
4942
  * When using GTK, typically you should use
4940
- * [method`Gtk`.Window.set_startup_id] instead of this
4941
- * low-level function.
4943
+ * [gtk_window_set_startup_id()](../gtk4/method.Window.set_startup_id.html)
4944
+ * instead of this low-level function.
4942
4945
  * @param startup_id a string with startup-notification identifier
4943
4946
  */
4944
4947
  set_startup_id(startup_id: string): void
@@ -4958,8 +4961,8 @@ interface Toplevel extends Surface {
4958
4961
  * allows the window manager to do things like center `surface`
4959
4962
  * on `parent` and keep `surface` above `parent`.
4960
4963
  *
4961
- * See [method`Gtk`.Window.set_transient_for] if you’re using
4962
- * [class`Gtk`.Window] or [class`Gtk`.Dialog].
4964
+ * See [gtk_window_set_transient_for()](../gtk4/method.Window.set_transient_for.html)
4965
+ * if you’re using [GtkWindow](../gtk4/class.Window.html).
4963
4966
  * @param parent another toplevel `GdkSurface`
4964
4967
  */
4965
4968
  set_transient_for(parent: Surface): void
@@ -5579,8 +5582,9 @@ interface Clipboard {
5579
5582
  * exit. Depending on the platform, the functionality may not be available
5580
5583
  * unless a "clipboard manager" is running.
5581
5584
  *
5582
- * This function is called automatically when a [class`Gtk`.Application] is
5583
- * shut down, so you likely don't need to call it.
5585
+ * This function is called automatically when a
5586
+ * [GtkApplication](../gtk4/class.Application.html)
5587
+ * is shut down, so you likely don't need to call it.
5584
5588
  * @param io_priority the I/O priority of the request
5585
5589
  * @param cancellable optional `GCancellable` object
5586
5590
  * @param callback callback to call when the request is satisfied
@@ -5603,8 +5607,9 @@ interface Clipboard {
5603
5607
  * exit. Depending on the platform, the functionality may not be available
5604
5608
  * unless a "clipboard manager" is running.
5605
5609
  *
5606
- * This function is called automatically when a [class`Gtk`.Application] is
5607
- * shut down, so you likely don't need to call it.
5610
+ * This function is called automatically when a
5611
+ * [GtkApplication](../gtk4/class.Application.html)
5612
+ * is shut down, so you likely don't need to call it.
5608
5613
  * @param io_priority the I/O priority of the request
5609
5614
  * @param cancellable optional `GCancellable` object
5610
5615
  * @returns A Promise of: %TRUE if storing was successful.
@@ -6360,7 +6365,8 @@ interface Cursor {
6360
6365
  * Cursors by themselves are not very interesting: they must be bound to a
6361
6366
  * window for users to see them. This is done with [method`Gdk`.Surface.set_cursor]
6362
6367
  * or [method`Gdk`.Surface.set_device_cursor]. Applications will typically
6363
- * use higher-level GTK functions such as [method`Gtk`.Widget.set_cursor] instead.
6368
+ * use higher-level GTK functions such as [gtk_widget_set_cursor()](../gtk4/method.Widget.set_cursor.html)
6369
+ * instead.
6364
6370
  *
6365
6371
  * Cursors are not bound to a given [class`Gdk`.Display], so they can be shared.
6366
6372
  * However, the appearance of cursors may vary when used on different
@@ -7227,9 +7233,9 @@ interface Display {
7227
7233
  * Indicates to the GUI environment that the application has
7228
7234
  * finished loading, using a given identifier.
7229
7235
  *
7230
- * GTK will call this function automatically for [class`Gtk`.Window]
7236
+ * GTK will call this function automatically for [GtkWindow](../gtk4/class.Window.html)
7231
7237
  * with custom startup-notification identifier unless
7232
- * [method`Gtk`.Window.set_auto_startup_notification]
7238
+ * [gtk_window_set_auto_startup_notification()](../gtk4/method.Window.set_auto_startup_notification.html)
7233
7239
  * is called to disable that feature.
7234
7240
  * @param startup_id a startup-notification identifier, for which notification process should be completed
7235
7241
  */
@@ -7253,8 +7259,7 @@ interface Display {
7253
7259
  */
7254
7260
  prepare_gl(): boolean
7255
7261
  /**
7256
- * Appends the given event onto the front of the event
7257
- * queue for `display`.
7262
+ * Adds the given event to the event queue for `display`.
7258
7263
  * @param event a `GdkEvent`
7259
7264
  */
7260
7265
  put_event(event: Event): void
@@ -7852,8 +7857,8 @@ interface DrawContext {
7852
7857
  *
7853
7858
  * When using GTK, the widget system automatically places calls to
7854
7859
  * gdk_draw_context_begin_frame() and gdk_draw_context_end_frame() via the
7855
- * use of [class`Gsk`.Renderer]s, so application code does not need to call
7856
- * these functions explicitly.
7860
+ * use of [GskRenderer](../gsk4/class.Renderer.html)s, so application code
7861
+ * does not need to call these functions explicitly.
7857
7862
  * @param region minimum region that should be drawn
7858
7863
  */
7859
7864
  begin_frame(region: cairo.Region): void
@@ -10081,7 +10086,7 @@ interface Snapshot {
10081
10086
  /**
10082
10087
  * Base type for snapshot operations.
10083
10088
  *
10084
- * The subclass of `GdkSnapshot` used by GTK is [class`Gtk`.Snapshot].
10089
+ * The subclass of `GdkSnapshot` used by GTK is [GtkSnapshot](../gtk4/class.Snapshot.html).
10085
10090
  * @class
10086
10091
  */
10087
10092
  class Snapshot extends GObject.Object {
@@ -10369,7 +10374,7 @@ interface Surface {
10369
10374
  * For toplevel surfaces, withdraws them, so they will no longer be
10370
10375
  * known to the window manager; for all surfaces, unmaps them, so
10371
10376
  * they won’t be displayed. Normally done automatically as
10372
- * part of [method`Gtk`.Widget.hide].
10377
+ * part of [gtk_widget_hide()](../gtk4/method.Widget.hide.html).
10373
10378
  */
10374
10379
  hide(): void
10375
10380
  /**
@@ -10448,7 +10453,7 @@ interface Surface {
10448
10453
  * GTK will update this property automatically if the `surface` background
10449
10454
  * is opaque, as we know where the opaque regions are. If your surface
10450
10455
  * background is not opaque, please update this property in your
10451
- * [vfunc`Gtk`.Widget.css_changed] handler.
10456
+ * [GtkWidgetClass.css_changed](../gtk4/vfunc.Widget.css_changed.html) handler.
10452
10457
  * @param region a region, or %NULL to make the entire surface opaque
10453
10458
  */
10454
10459
  set_opaque_region(region: cairo.Region | null): void
@@ -10518,7 +10523,7 @@ interface Surface {
10518
10523
  * A `GdkSurface` is a rectangular region on the screen.
10519
10524
  *
10520
10525
  * It’s a low-level object, used to implement high-level objects
10521
- * such as [class`Gtk`.Window] or [class`Gtk`.Dialog] in GTK.
10526
+ * such as [GtkWindow](../gtk4/class.Window.html).
10522
10527
  *
10523
10528
  * The surfaces you see in practice are either [iface`Gdk`.Toplevel] or
10524
10529
  * [iface`Gdk`.Popup], and those interfaces provide much of the required
@@ -11741,9 +11746,9 @@ interface PopupLayout {
11741
11746
  * [method`Gdk`.Popup.get_position_x], [method`Gdk`.Popup.get_position_y],
11742
11747
  * [method`Gdk`.Popup.get_rect_anchor] and [method`Gdk`.Popup.get_surface_anchor]
11743
11748
  * after the popup has been presented. This can be used to adjust the rendering.
11744
- * For example, [class`Gtk`.Popover] changes its arrow position accordingly.
11745
- * But you have to be careful avoid changing the size of the popover, or it
11746
- * has to be presented again.
11749
+ * For example, [GtkPopover](../gtk4/class.Popover.html) changes its arrow position
11750
+ * accordingly. But you have to be careful avoid changing the size of the popover,
11751
+ * or it has to be presented again.
11747
11752
  * @record
11748
11753
  */
11749
11754
  class PopupLayout {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/gdk-4.0",
3
- "version": "4.0.0-3.2.8",
3
+ "version": "4.0.0-3.2.9",
4
4
  "description": "GJS TypeScript type definitions for Gdk-4.0, generated from library version 4.0.0",
5
5
  "type": "module",
6
6
  "module": "gdk-4.0.js",
@@ -31,17 +31,17 @@
31
31
  "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit gdk-4.0.d.cts"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/cairo-1.0": "^1.0.0-3.2.8",
35
- "@girs/freetype2-2.0": "^2.0.0-3.2.8",
36
- "@girs/gdkpixbuf-2.0": "^2.0.0-3.2.8",
37
- "@girs/gio-2.0": "^2.77.0-3.2.8",
38
- "@girs/gjs": "^3.2.8",
39
- "@girs/glib-2.0": "^2.77.0-3.2.8",
40
- "@girs/gmodule-2.0": "^2.0.0-3.2.8",
41
- "@girs/gobject-2.0": "^2.77.0-3.2.8",
42
- "@girs/harfbuzz-0.0": "^8.1.1-3.2.8",
43
- "@girs/pango-1.0": "^1.51.0-3.2.8",
44
- "@girs/pangocairo-1.0": "^1.0.0-3.2.8"
34
+ "@girs/cairo-1.0": "^1.0.0-3.2.9",
35
+ "@girs/freetype2-2.0": "^2.0.0-3.2.9",
36
+ "@girs/gdkpixbuf-2.0": "^2.0.0-3.2.9",
37
+ "@girs/gio-2.0": "^2.78.0-3.2.9",
38
+ "@girs/gjs": "^3.2.9",
39
+ "@girs/glib-2.0": "^2.78.0-3.2.9",
40
+ "@girs/gmodule-2.0": "^2.0.0-3.2.9",
41
+ "@girs/gobject-2.0": "^2.78.0-3.2.9",
42
+ "@girs/harfbuzz-0.0": "^8.2.1-3.2.9",
43
+ "@girs/pango-1.0": "^1.51.0-3.2.9",
44
+ "@girs/pangocairo-1.0": "^1.0.0-3.2.9"
45
45
  },
46
46
  "devDependencies": {
47
47
  "typescript": "*"