@girs/gdk-3.0 4.2.0 → 4.4.0
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 +8 -8
- package/gdk-3.0.d.ts +394 -0
- package/package.json +11 -11
package/gdk-3.0.d.ts
CHANGED
|
@@ -8888,6 +8888,7 @@ export namespace Gdk {
|
|
|
8888
8888
|
* it is up to the window manager to pick one, typically it will
|
|
8889
8889
|
* be the current workspace.
|
|
8890
8890
|
* @param desktop the number of a workspace, or -1
|
|
8891
|
+
* @since 2.14
|
|
8891
8892
|
*/
|
|
8892
8893
|
set_desktop(desktop: number): void;
|
|
8893
8894
|
|
|
@@ -8895,6 +8896,8 @@ export namespace Gdk {
|
|
|
8895
8896
|
* Sets the display on which applications will be launched when
|
|
8896
8897
|
* using this context. See also `gdk_app_launch_context_set_screen()`.
|
|
8897
8898
|
* @param display a {@link Gdk.Display}
|
|
8899
|
+
* @since 2.14
|
|
8900
|
+
* @deprecated since 3.0: Use `gdk_display_get_app_launch_context()` instead
|
|
8898
8901
|
*/
|
|
8899
8902
|
set_display(display: Display): void;
|
|
8900
8903
|
|
|
@@ -8907,6 +8910,7 @@ export namespace Gdk {
|
|
|
8907
8910
|
*
|
|
8908
8911
|
* See also `gdk_app_launch_context_set_icon_name()`.
|
|
8909
8912
|
* @param icon a {@link Gio.Icon}, or `null`
|
|
8913
|
+
* @since 2.14
|
|
8910
8914
|
*/
|
|
8911
8915
|
set_icon(icon: Gio.Icon | null): void;
|
|
8912
8916
|
|
|
@@ -8920,6 +8924,7 @@ export namespace Gdk {
|
|
|
8920
8924
|
* the file that is passed to launched application or from the {@link Gio.AppInfo}
|
|
8921
8925
|
* for the launched application itself.
|
|
8922
8926
|
* @param icon_name an icon name, or `null`
|
|
8927
|
+
* @since 2.14
|
|
8923
8928
|
*/
|
|
8924
8929
|
set_icon_name(icon_name: string | null): void;
|
|
8925
8930
|
|
|
@@ -8934,6 +8939,7 @@ export namespace Gdk {
|
|
|
8934
8939
|
* If neither `screen` or `display` are set, the default screen and
|
|
8935
8940
|
* display are used.
|
|
8936
8941
|
* @param screen a {@link Gdk.Screen}
|
|
8942
|
+
* @since 2.14
|
|
8937
8943
|
*/
|
|
8938
8944
|
set_screen(screen: Screen): void;
|
|
8939
8945
|
|
|
@@ -8946,6 +8952,7 @@ export namespace Gdk {
|
|
|
8946
8952
|
* typing in another window. This is also known as 'focus stealing
|
|
8947
8953
|
* prevention'.
|
|
8948
8954
|
* @param timestamp a timestamp
|
|
8955
|
+
* @since 2.14
|
|
8949
8956
|
*/
|
|
8950
8957
|
set_timestamp(timestamp: number): void;
|
|
8951
8958
|
}
|
|
@@ -9032,12 +9039,14 @@ export namespace Gdk {
|
|
|
9032
9039
|
/**
|
|
9033
9040
|
* Returns the cursor type for this cursor.
|
|
9034
9041
|
* @returns a {@link Gdk.CursorType}
|
|
9042
|
+
* @since 2.22
|
|
9035
9043
|
*/
|
|
9036
9044
|
get_cursor_type(): CursorType;
|
|
9037
9045
|
|
|
9038
9046
|
/**
|
|
9039
9047
|
* Returns the display on which the {@link Gdk.Cursor} is defined.
|
|
9040
9048
|
* @returns the {@link Gdk.Display} associated to `cursor`
|
|
9049
|
+
* @since 2.2
|
|
9041
9050
|
*/
|
|
9042
9051
|
get_display(): Display;
|
|
9043
9052
|
|
|
@@ -9048,6 +9057,7 @@ export namespace Gdk {
|
|
|
9048
9057
|
* on the cursor, GDK may not be able to obtain the image data. In this
|
|
9049
9058
|
* case, `null` is returned.
|
|
9050
9059
|
* @returns a {@link GdkPixbuf.Pixbuf} representing `cursor`, or `null`
|
|
9060
|
+
* @since 2.8
|
|
9051
9061
|
*/
|
|
9052
9062
|
get_image(): GdkPixbuf.Pixbuf | null;
|
|
9053
9063
|
|
|
@@ -9058,18 +9068,21 @@ export namespace Gdk {
|
|
|
9058
9068
|
* on the cursor, GDK may not be able to obtain the image data. In this
|
|
9059
9069
|
* case, `null` is returned.
|
|
9060
9070
|
* @returns a {@link cairo.Surface} representing `cursor`, or `null`
|
|
9071
|
+
* @since 3.10
|
|
9061
9072
|
*/
|
|
9062
9073
|
get_surface(): [cairo.Surface | null, number, number];
|
|
9063
9074
|
|
|
9064
9075
|
/**
|
|
9065
9076
|
* Adds a reference to `cursor`.
|
|
9066
9077
|
* @returns Same `cursor` that was passed in
|
|
9078
|
+
* @deprecated since 3.0: Use `g_object_ref()` instead
|
|
9067
9079
|
*/
|
|
9068
9080
|
ref(): Cursor;
|
|
9069
9081
|
|
|
9070
9082
|
/**
|
|
9071
9083
|
* Removes a reference from `cursor`, deallocating the cursor
|
|
9072
9084
|
* if no references remain.
|
|
9085
|
+
* @deprecated since 3.0: Use `g_object_unref()` instead
|
|
9073
9086
|
*/
|
|
9074
9087
|
unref(): void;
|
|
9075
9088
|
}
|
|
@@ -9377,6 +9390,7 @@ export namespace Gdk {
|
|
|
9377
9390
|
* This is not public API and must not be used by applications.
|
|
9378
9391
|
* @param display the display for which to get the grab information
|
|
9379
9392
|
* @param device device to get the grab information from
|
|
9393
|
+
* @deprecated since 3.16: The symbol was never meant to be used outside of GTK+
|
|
9380
9394
|
*/
|
|
9381
9395
|
static grab_info_libgtk_only(display: Display, device: Device): [boolean, Window, boolean];
|
|
9382
9396
|
|
|
@@ -9392,11 +9406,13 @@ export namespace Gdk {
|
|
|
9392
9406
|
* If `device` is of type {@link Gdk.DeviceType.FLOATING}, `null` will be
|
|
9393
9407
|
* returned, as there is no associated device.
|
|
9394
9408
|
* @returns The associated device, or `null`
|
|
9409
|
+
* @since 3.0
|
|
9395
9410
|
*/
|
|
9396
9411
|
get_associated_device(): Device | null;
|
|
9397
9412
|
|
|
9398
9413
|
/**
|
|
9399
9414
|
* Returns the axes currently available on the device.
|
|
9415
|
+
* @since 3.22
|
|
9400
9416
|
*/
|
|
9401
9417
|
get_axes(): AxisFlags;
|
|
9402
9418
|
|
|
@@ -9404,18 +9420,21 @@ export namespace Gdk {
|
|
|
9404
9420
|
* Returns the axis use for `index_`.
|
|
9405
9421
|
* @param index_ the index of the axis.
|
|
9406
9422
|
* @returns a {@link Gdk.AxisUse} specifying how the axis is used.
|
|
9423
|
+
* @since 2.20
|
|
9407
9424
|
*/
|
|
9408
9425
|
get_axis_use(index_: number): AxisUse;
|
|
9409
9426
|
|
|
9410
9427
|
/**
|
|
9411
9428
|
* Returns the device type for `device`.
|
|
9412
9429
|
* @returns the {@link Gdk.DeviceType} for `device`.
|
|
9430
|
+
* @since 3.0
|
|
9413
9431
|
*/
|
|
9414
9432
|
get_device_type(): DeviceType;
|
|
9415
9433
|
|
|
9416
9434
|
/**
|
|
9417
9435
|
* Returns the {@link Gdk.Display} to which `device` pertains.
|
|
9418
9436
|
* @returns a {@link Gdk.Display}. This memory is owned by GTK+, and must not be freed or unreffed.
|
|
9437
|
+
* @since 3.0
|
|
9419
9438
|
*/
|
|
9420
9439
|
get_display(): Display;
|
|
9421
9440
|
|
|
@@ -9423,6 +9442,7 @@ export namespace Gdk {
|
|
|
9423
9442
|
* Determines whether the pointer follows device motion.
|
|
9424
9443
|
* This is not meaningful for keyboard devices, which don't have a pointer.
|
|
9425
9444
|
* @returns `true` if the pointer follows device motion
|
|
9445
|
+
* @since 2.20
|
|
9426
9446
|
*/
|
|
9427
9447
|
get_has_cursor(): boolean;
|
|
9428
9448
|
|
|
@@ -9431,6 +9451,7 @@ export namespace Gdk {
|
|
|
9431
9451
|
* and fill in `keyval` and `modifiers` with the keyval settings.
|
|
9432
9452
|
* @param index_ the index of the macro button to get.
|
|
9433
9453
|
* @returns `true` if keyval is set for `index`.
|
|
9454
|
+
* @since 2.20
|
|
9434
9455
|
*/
|
|
9435
9456
|
get_key(index_: number): [boolean, number, ModifierType];
|
|
9436
9457
|
|
|
@@ -9441,30 +9462,35 @@ export namespace Gdk {
|
|
|
9441
9462
|
* `null` may be returned even if the pointer is physically over one of this
|
|
9442
9463
|
* application's windows.
|
|
9443
9464
|
* @returns the last window the device
|
|
9465
|
+
* @since 3.12
|
|
9444
9466
|
*/
|
|
9445
9467
|
get_last_event_window(): Window | null;
|
|
9446
9468
|
|
|
9447
9469
|
/**
|
|
9448
9470
|
* Determines the mode of the device.
|
|
9449
9471
|
* @returns a {@link Gdk.InputSource}
|
|
9472
|
+
* @since 2.20
|
|
9450
9473
|
*/
|
|
9451
9474
|
get_mode(): InputMode;
|
|
9452
9475
|
|
|
9453
9476
|
/**
|
|
9454
9477
|
* Returns the number of axes the device currently has.
|
|
9455
9478
|
* @returns the number of axes.
|
|
9479
|
+
* @since 3.0
|
|
9456
9480
|
*/
|
|
9457
9481
|
get_n_axes(): number;
|
|
9458
9482
|
|
|
9459
9483
|
/**
|
|
9460
9484
|
* Returns the number of keys the device currently has.
|
|
9461
9485
|
* @returns the number of keys.
|
|
9486
|
+
* @since 2.24
|
|
9462
9487
|
*/
|
|
9463
9488
|
get_n_keys(): number;
|
|
9464
9489
|
|
|
9465
9490
|
/**
|
|
9466
9491
|
* Determines the name of the device.
|
|
9467
9492
|
* @returns a name
|
|
9493
|
+
* @since 2.20
|
|
9468
9494
|
*/
|
|
9469
9495
|
get_name(): string;
|
|
9470
9496
|
|
|
@@ -9473,6 +9499,7 @@ export namespace Gdk {
|
|
|
9473
9499
|
* coordinates are those of its master pointer, This function
|
|
9474
9500
|
* may not be called on devices of type {@link Gdk.DeviceType.SLAVE},
|
|
9475
9501
|
* unless there is an ongoing grab on them, see `gdk_device_grab()`.
|
|
9502
|
+
* @since 3.0
|
|
9476
9503
|
*/
|
|
9477
9504
|
get_position(): [Screen | null, number, number];
|
|
9478
9505
|
|
|
@@ -9481,6 +9508,7 @@ export namespace Gdk {
|
|
|
9481
9508
|
* coordinates are those of its master pointer, this function
|
|
9482
9509
|
* may not be called on devices of type {@link Gdk.DeviceType.SLAVE},
|
|
9483
9510
|
* unless there is an ongoing grab on them. See `gdk_device_grab()`.
|
|
9511
|
+
* @since 3.10
|
|
9484
9512
|
*/
|
|
9485
9513
|
get_position_double(): [Screen | null, number, number];
|
|
9486
9514
|
|
|
@@ -9489,18 +9517,21 @@ export namespace Gdk {
|
|
|
9489
9517
|
* be obtained. This ID is retrieved from the device, and is thus constant for
|
|
9490
9518
|
* it. See `gdk_device_get_vendor_id()` for more information.
|
|
9491
9519
|
* @returns the product ID, or `null`
|
|
9520
|
+
* @since 3.16
|
|
9492
9521
|
*/
|
|
9493
9522
|
get_product_id(): string | null;
|
|
9494
9523
|
|
|
9495
9524
|
/**
|
|
9496
9525
|
* Returns the {@link Gdk.Seat} the device belongs to.
|
|
9497
9526
|
* @returns A {@link Gdk.Seat}. This memory is owned by GTK+ and must not be freed.
|
|
9527
|
+
* @since 3.20
|
|
9498
9528
|
*/
|
|
9499
9529
|
get_seat(): Seat;
|
|
9500
9530
|
|
|
9501
9531
|
/**
|
|
9502
9532
|
* Determines the type of the device.
|
|
9503
9533
|
* @returns a {@link Gdk.InputSource}
|
|
9534
|
+
* @since 2.20
|
|
9504
9535
|
*/
|
|
9505
9536
|
get_source(): InputSource;
|
|
9506
9537
|
|
|
@@ -9534,6 +9565,7 @@ export namespace Gdk {
|
|
|
9534
9565
|
* ```
|
|
9535
9566
|
*
|
|
9536
9567
|
* @returns the vendor ID, or `null`
|
|
9568
|
+
* @since 3.16
|
|
9537
9569
|
*/
|
|
9538
9570
|
get_vendor_id(): string | null;
|
|
9539
9571
|
|
|
@@ -9545,6 +9577,7 @@ export namespace Gdk {
|
|
|
9545
9577
|
* function may not be called on devices of type {@link Gdk.DeviceType.SLAVE},
|
|
9546
9578
|
* unless there is an ongoing grab on them, see `gdk_device_grab()`.
|
|
9547
9579
|
* @returns the {@link Gdk.Window} under the device position, or `null`.
|
|
9580
|
+
* @since 3.0
|
|
9548
9581
|
*/
|
|
9549
9582
|
get_window_at_position(): [Window | null, number, number];
|
|
9550
9583
|
|
|
@@ -9557,6 +9590,7 @@ export namespace Gdk {
|
|
|
9557
9590
|
* function may not be called on devices of type {@link Gdk.DeviceType.SLAVE},
|
|
9558
9591
|
* unless there is an ongoing grab on them, see `gdk_device_grab()`.
|
|
9559
9592
|
* @returns the {@link Gdk.Window} under the device position, or `null`.
|
|
9593
|
+
* @since 3.0
|
|
9560
9594
|
*/
|
|
9561
9595
|
get_window_at_position_double(): [Window | null, number, number];
|
|
9562
9596
|
|
|
@@ -9589,6 +9623,8 @@ export namespace Gdk {
|
|
|
9589
9623
|
* @param cursor the cursor to display while the grab is active if the device is a pointer. If this is `null` then the normal cursors are used for `window` and its descendants, and the cursor for `window` is used elsewhere.
|
|
9590
9624
|
* @param time_ the timestamp of the event which led to this pointer grab. This usually comes from the {@link Gdk.Event} struct, though `GDK_CURRENT_TIME` can be used if the time isn’t known.
|
|
9591
9625
|
* @returns {@link Gdk.GrabStatus.SUCCESS} if the grab was successful.
|
|
9626
|
+
* @since 3.0
|
|
9627
|
+
* @deprecated since 3.20.: Use `gdk_seat_grab()` instead.
|
|
9592
9628
|
*/
|
|
9593
9629
|
grab(window: Window, grab_ownership: GrabOwnership, owner_events: boolean, event_mask: EventMask, cursor: Cursor | null, time_: number): GrabStatus;
|
|
9594
9630
|
|
|
@@ -9596,6 +9632,7 @@ export namespace Gdk {
|
|
|
9596
9632
|
* Returns a {@link GLib.List} of `GdkAtoms`, containing the labels for
|
|
9597
9633
|
* the axes that `device` currently has.
|
|
9598
9634
|
* @returns A {@link GLib.List} of `GdkAtoms`, free with `g_list_free()`.
|
|
9635
|
+
* @since 3.0
|
|
9599
9636
|
*/
|
|
9600
9637
|
list_axes(): Atom[];
|
|
9601
9638
|
|
|
@@ -9639,6 +9676,8 @@ export namespace Gdk {
|
|
|
9639
9676
|
/**
|
|
9640
9677
|
* Release any grab on `device`.
|
|
9641
9678
|
* @param time_ a timestap (e.g. `GDK_CURRENT_TIME`).
|
|
9679
|
+
* @since 3.0
|
|
9680
|
+
* @deprecated since 3.20.: Use `gdk_seat_ungrab()` instead.
|
|
9642
9681
|
*/
|
|
9643
9682
|
ungrab(time_: number): void;
|
|
9644
9683
|
|
|
@@ -9657,6 +9696,7 @@ export namespace Gdk {
|
|
|
9657
9696
|
* @param screen the screen to warp `device` to.
|
|
9658
9697
|
* @param x the X coordinate of the destination.
|
|
9659
9698
|
* @param y the Y coordinate of the destination.
|
|
9699
|
+
* @since 3.0
|
|
9660
9700
|
*/
|
|
9661
9701
|
warp(screen: Screen, x: number, y: number): void;
|
|
9662
9702
|
}
|
|
@@ -9869,12 +9909,15 @@ export namespace Gdk {
|
|
|
9869
9909
|
* You should use this function seldomly, only in code that isn’t triggered by a {@link Gdk.Event}
|
|
9870
9910
|
* and there aren’t other means to get a meaningful {@link Gdk.Device} to operate on.
|
|
9871
9911
|
* @returns The client pointer. This memory is owned by GDK and must not be freed or unreferenced.
|
|
9912
|
+
* @since 3.0
|
|
9913
|
+
* @deprecated since 3.20: Use `gdk_seat_get_pointer()` instead.
|
|
9872
9914
|
*/
|
|
9873
9915
|
get_client_pointer(): Device;
|
|
9874
9916
|
|
|
9875
9917
|
/**
|
|
9876
9918
|
* Gets the {@link Gdk.Display} associated to `device_manager`.
|
|
9877
9919
|
* @returns the {@link Gdk.Display} to which `device_manager` is associated to, or `null`. This memory is owned by GDK and must not be freed or unreferenced.
|
|
9920
|
+
* @since 3.0
|
|
9878
9921
|
*/
|
|
9879
9922
|
get_display(): Display | null;
|
|
9880
9923
|
|
|
@@ -9883,6 +9926,8 @@ export namespace Gdk {
|
|
|
9883
9926
|
* `device_manager`.
|
|
9884
9927
|
* @param type device type to get.
|
|
9885
9928
|
* @returns a list of `GdkDevices`. The returned list must be freed with g_list_free (). The list elements are owned by GTK+ and must not be freed or unreffed.
|
|
9929
|
+
* @since 3.0
|
|
9930
|
+
* @deprecated since 3.20: , use `gdk_seat_get_pointer()`, `gdk_seat_get_keyboard()` and `gdk_seat_get_slaves()` instead.
|
|
9886
9931
|
*/
|
|
9887
9932
|
list_devices(type: DeviceType): Device[];
|
|
9888
9933
|
}
|
|
@@ -9990,6 +10035,7 @@ export namespace Gdk {
|
|
|
9990
10035
|
* may support multiple devices with the same {@link Gdk.DeviceToolType},
|
|
9991
10036
|
* but having different hardware identificators.
|
|
9992
10037
|
* @returns The hardware identificator of this tool.
|
|
10038
|
+
* @since 3.22
|
|
9993
10039
|
*/
|
|
9994
10040
|
get_hardware_id(): number;
|
|
9995
10041
|
|
|
@@ -9997,12 +10043,14 @@ export namespace Gdk {
|
|
|
9997
10043
|
* Gets the serial of this tool, this value can be used to identify a
|
|
9998
10044
|
* physical tool (eg. a tablet pen) across program executions.
|
|
9999
10045
|
* @returns The serial ID for this tool
|
|
10046
|
+
* @since 3.22
|
|
10000
10047
|
*/
|
|
10001
10048
|
get_serial(): number;
|
|
10002
10049
|
|
|
10003
10050
|
/**
|
|
10004
10051
|
* Gets the {@link Gdk.DeviceToolType} of the tool.
|
|
10005
10052
|
* @returns The physical type for this tool. This can be used to figure out what sort of pen is being used, such as an airbrush or a pencil.
|
|
10053
|
+
* @since 3.22
|
|
10006
10054
|
*/
|
|
10007
10055
|
get_tool_type(): DeviceToolType;
|
|
10008
10056
|
}
|
|
@@ -10120,12 +10168,14 @@ export namespace Gdk {
|
|
|
10120
10168
|
* Gets the default {@link Gdk.Display}. This is a convenience
|
|
10121
10169
|
* function for:
|
|
10122
10170
|
* `gdk_display_manager_get_default_display (gdk_display_manager_get ())`.
|
|
10171
|
+
* @since 2.2
|
|
10123
10172
|
*/
|
|
10124
10173
|
static get_default(): Display | null;
|
|
10125
10174
|
|
|
10126
10175
|
/**
|
|
10127
10176
|
* Opens a display.
|
|
10128
10177
|
* @param display_name the name of the display to open
|
|
10178
|
+
* @since 2.2
|
|
10129
10179
|
*/
|
|
10130
10180
|
static open(display_name: string): Display | null;
|
|
10131
10181
|
|
|
@@ -10135,18 +10185,21 @@ export namespace Gdk {
|
|
|
10135
10185
|
* it. `gdk_parse_args()` must have been called first. If the default
|
|
10136
10186
|
* display has previously been set, simply returns that. An internal
|
|
10137
10187
|
* function that should not be used by applications.
|
|
10188
|
+
* @deprecated since 3.16: This symbol was never meant to be used outside of GTK+
|
|
10138
10189
|
*/
|
|
10139
10190
|
static open_default_libgtk_only(): Display | null;
|
|
10140
10191
|
|
|
10141
10192
|
// Methods
|
|
10142
10193
|
/**
|
|
10143
10194
|
* Emits a short beep on `display`
|
|
10195
|
+
* @since 2.2
|
|
10144
10196
|
*/
|
|
10145
10197
|
beep(): void;
|
|
10146
10198
|
|
|
10147
10199
|
/**
|
|
10148
10200
|
* Closes the connection to the windowing system for the given display,
|
|
10149
10201
|
* and cleans up associated resources.
|
|
10202
|
+
* @since 2.2
|
|
10150
10203
|
*/
|
|
10151
10204
|
close(): void;
|
|
10152
10205
|
|
|
@@ -10167,6 +10220,7 @@ export namespace Gdk {
|
|
|
10167
10220
|
*
|
|
10168
10221
|
* This is most useful for X11. On windowing systems where requests are
|
|
10169
10222
|
* handled synchronously, this function will do nothing.
|
|
10223
|
+
* @since 2.4
|
|
10170
10224
|
*/
|
|
10171
10225
|
flush(): void;
|
|
10172
10226
|
|
|
@@ -10174,12 +10228,14 @@ export namespace Gdk {
|
|
|
10174
10228
|
* Returns a {@link Gdk.AppLaunchContext} suitable for launching
|
|
10175
10229
|
* applications on the given display.
|
|
10176
10230
|
* @returns a new {@link Gdk.AppLaunchContext} for `display`. Free with `g_object_unref()` when done
|
|
10231
|
+
* @since 3.0
|
|
10177
10232
|
*/
|
|
10178
10233
|
get_app_launch_context(): AppLaunchContext;
|
|
10179
10234
|
|
|
10180
10235
|
/**
|
|
10181
10236
|
* Returns the default size to use for cursors on `display`.
|
|
10182
10237
|
* @returns the default cursor size.
|
|
10238
|
+
* @since 2.4
|
|
10183
10239
|
*/
|
|
10184
10240
|
get_default_cursor_size(): number;
|
|
10185
10241
|
|
|
@@ -10188,24 +10244,29 @@ export namespace Gdk {
|
|
|
10188
10244
|
* on `display`. This window is implicitly created by GDK.
|
|
10189
10245
|
* See `gdk_window_set_group()`.
|
|
10190
10246
|
* @returns The default group leader window for `display`
|
|
10247
|
+
* @since 2.4
|
|
10191
10248
|
*/
|
|
10192
10249
|
get_default_group(): Window;
|
|
10193
10250
|
|
|
10194
10251
|
/**
|
|
10195
10252
|
* Get the default {@link Gdk.Screen} for `display`.
|
|
10196
10253
|
* @returns the default {@link Gdk.Screen} object for `display`
|
|
10254
|
+
* @since 2.2
|
|
10197
10255
|
*/
|
|
10198
10256
|
get_default_screen(): Screen;
|
|
10199
10257
|
|
|
10200
10258
|
/**
|
|
10201
10259
|
* Returns the default {@link Gdk.Seat} for this display.
|
|
10202
10260
|
* @returns the default seat.
|
|
10261
|
+
* @since 3.20
|
|
10203
10262
|
*/
|
|
10204
10263
|
get_default_seat(): Seat;
|
|
10205
10264
|
|
|
10206
10265
|
/**
|
|
10207
10266
|
* Returns the {@link Gdk.DeviceManager} associated to `display`.
|
|
10208
10267
|
* @returns A {@link Gdk.DeviceManager}, or `null`. This memory is owned by GDK and must not be freed or unreferenced.
|
|
10268
|
+
* @since 3.0
|
|
10269
|
+
* @deprecated since 3.20.: Use `gdk_display_get_default_seat()` and {@link Gdk.Seat} operations.
|
|
10209
10270
|
*/
|
|
10210
10271
|
get_device_manager(): DeviceManager | null;
|
|
10211
10272
|
|
|
@@ -10213,11 +10274,13 @@ export namespace Gdk {
|
|
|
10213
10274
|
* Gets the next {@link Gdk.Event} to be processed for `display`, fetching events from the
|
|
10214
10275
|
* windowing system if necessary.
|
|
10215
10276
|
* @returns the next {@link Gdk.Event} to be processed, or `null` if no events are pending. The returned {@link Gdk.Event} should be freed with `gdk_event_free()`.
|
|
10277
|
+
* @since 2.2
|
|
10216
10278
|
*/
|
|
10217
10279
|
get_event(): Event | null;
|
|
10218
10280
|
|
|
10219
10281
|
/**
|
|
10220
10282
|
* Gets the maximal size to use for cursors on `display`.
|
|
10283
|
+
* @since 2.4
|
|
10221
10284
|
*/
|
|
10222
10285
|
get_maximal_cursor_size(): [number, number];
|
|
10223
10286
|
|
|
@@ -10225,6 +10288,7 @@ export namespace Gdk {
|
|
|
10225
10288
|
* Gets a monitor associated with this display.
|
|
10226
10289
|
* @param monitor_num number of the monitor
|
|
10227
10290
|
* @returns the {@link Gdk.Monitor}, or `null` if `monitor_num` is not a valid monitor number
|
|
10291
|
+
* @since 3.22
|
|
10228
10292
|
*/
|
|
10229
10293
|
get_monitor(monitor_num: number): Monitor | null;
|
|
10230
10294
|
|
|
@@ -10234,6 +10298,7 @@ export namespace Gdk {
|
|
|
10234
10298
|
* @param x the x coordinate of the point
|
|
10235
10299
|
* @param y the y coordinate of the point
|
|
10236
10300
|
* @returns the monitor containing the point
|
|
10301
|
+
* @since 3.22
|
|
10237
10302
|
*/
|
|
10238
10303
|
get_monitor_at_point(x: number, y: number): Monitor;
|
|
10239
10304
|
|
|
@@ -10243,6 +10308,7 @@ export namespace Gdk {
|
|
|
10243
10308
|
* of all monitors.
|
|
10244
10309
|
* @param window a {@link Gdk.Window}
|
|
10245
10310
|
* @returns the monitor with the largest overlap with `window`
|
|
10311
|
+
* @since 3.22
|
|
10246
10312
|
*/
|
|
10247
10313
|
get_monitor_at_window(window: Window): Monitor;
|
|
10248
10314
|
|
|
@@ -10252,24 +10318,30 @@ export namespace Gdk {
|
|
|
10252
10318
|
* The returned number is valid until the next emission of the
|
|
10253
10319
|
* {@link Gdk.Display.SignalSignatures.monitor_added | Gdk.Display::monitor-added} or {@link Gdk.Display.SignalSignatures.monitor_removed | Gdk.Display::monitor-removed} signal.
|
|
10254
10320
|
* @returns the number of monitors
|
|
10321
|
+
* @since 3.22
|
|
10255
10322
|
*/
|
|
10256
10323
|
get_n_monitors(): number;
|
|
10257
10324
|
|
|
10258
10325
|
/**
|
|
10259
10326
|
* Gets the number of screen managed by the `display`.
|
|
10260
10327
|
* @returns number of screens.
|
|
10328
|
+
* @since 2.2
|
|
10329
|
+
* @deprecated since 3.10: The number of screens is always 1.
|
|
10261
10330
|
*/
|
|
10262
10331
|
get_n_screens(): number;
|
|
10263
10332
|
|
|
10264
10333
|
/**
|
|
10265
10334
|
* Gets the name of the display.
|
|
10266
10335
|
* @returns a string representing the display name. This string is owned by GDK and should not be modified or freed.
|
|
10336
|
+
* @since 2.2
|
|
10267
10337
|
*/
|
|
10268
10338
|
get_name(): string;
|
|
10269
10339
|
|
|
10270
10340
|
/**
|
|
10271
10341
|
* Gets the current location of the pointer and the current modifier
|
|
10272
10342
|
* mask for a given display.
|
|
10343
|
+
* @since 2.2
|
|
10344
|
+
* @deprecated since 3.0: Use `gdk_device_get_position()` instead.
|
|
10273
10345
|
*/
|
|
10274
10346
|
get_pointer(): [Screen | null, number, number, ModifierType | null];
|
|
10275
10347
|
|
|
@@ -10281,6 +10353,7 @@ export namespace Gdk {
|
|
|
10281
10353
|
* manager to place the windows, specialized desktop applications
|
|
10282
10354
|
* such as panels should place themselves on the primary monitor.
|
|
10283
10355
|
* @returns the primary monitor, or `null` if no primary monitor is configured by the user
|
|
10356
|
+
* @since 3.22
|
|
10284
10357
|
*/
|
|
10285
10358
|
get_primary_monitor(): Monitor | null;
|
|
10286
10359
|
|
|
@@ -10288,6 +10361,8 @@ export namespace Gdk {
|
|
|
10288
10361
|
* Returns a screen object for one of the screens of the display.
|
|
10289
10362
|
* @param screen_num the screen number
|
|
10290
10363
|
* @returns the {@link Gdk.Screen} object
|
|
10364
|
+
* @since 2.2
|
|
10365
|
+
* @deprecated since 3.20: There is only one screen; use `gdk_display_get_default_screen()` to get it.
|
|
10291
10366
|
*/
|
|
10292
10367
|
get_screen(screen_num: number): Screen;
|
|
10293
10368
|
|
|
@@ -10297,6 +10372,8 @@ export namespace Gdk {
|
|
|
10297
10372
|
* if the window under the mouse pointer is not known to GDK (for example,
|
|
10298
10373
|
* belongs to another application).
|
|
10299
10374
|
* @returns the window under the mouse pointer, or `null`
|
|
10375
|
+
* @since 2.2
|
|
10376
|
+
* @deprecated since 3.0: Use `gdk_device_get_window_at_position()` instead.
|
|
10300
10377
|
*/
|
|
10301
10378
|
get_window_at_pointer(): [Window | null, number, number];
|
|
10302
10379
|
|
|
@@ -10304,18 +10381,22 @@ export namespace Gdk {
|
|
|
10304
10381
|
* Returns whether the display has events that are waiting
|
|
10305
10382
|
* to be processed.
|
|
10306
10383
|
* @returns `true` if there are events ready to be processed.
|
|
10384
|
+
* @since 3.0
|
|
10307
10385
|
*/
|
|
10308
10386
|
has_pending(): boolean;
|
|
10309
10387
|
|
|
10310
10388
|
/**
|
|
10311
10389
|
* Finds out if the display has been closed.
|
|
10312
10390
|
* @returns `true` if the display is closed.
|
|
10391
|
+
* @since 2.22
|
|
10313
10392
|
*/
|
|
10314
10393
|
is_closed(): boolean;
|
|
10315
10394
|
|
|
10316
10395
|
/**
|
|
10317
10396
|
* Release any keyboard grab
|
|
10318
10397
|
* @param time_ a timestap (e.g #GDK_CURRENT_TIME).
|
|
10398
|
+
* @since 2.2
|
|
10399
|
+
* @deprecated since 3.0: Use `gdk_device_ungrab()`, together with `gdk_device_grab()` instead.
|
|
10319
10400
|
*/
|
|
10320
10401
|
keyboard_ungrab(time_: number): void;
|
|
10321
10402
|
|
|
@@ -10323,12 +10404,15 @@ export namespace Gdk {
|
|
|
10323
10404
|
* Returns the list of available input devices attached to `display`.
|
|
10324
10405
|
* The list is statically allocated and should not be freed.
|
|
10325
10406
|
* @returns a list of {@link Gdk.Device}
|
|
10407
|
+
* @since 2.2
|
|
10408
|
+
* @deprecated since 3.0: Use `gdk_device_manager_list_devices()` instead.
|
|
10326
10409
|
*/
|
|
10327
10410
|
list_devices(): Device[];
|
|
10328
10411
|
|
|
10329
10412
|
/**
|
|
10330
10413
|
* Returns the list of seats known to `display`.
|
|
10331
10414
|
* @returns the list of seats known to the {@link Gdk.Display}
|
|
10415
|
+
* @since 3.20
|
|
10332
10416
|
*/
|
|
10333
10417
|
list_seats(): Seat[];
|
|
10334
10418
|
|
|
@@ -10341,6 +10425,7 @@ export namespace Gdk {
|
|
|
10341
10425
|
* `gtk_window_set_auto_startup_notification()` is called to
|
|
10342
10426
|
* disable that feature.
|
|
10343
10427
|
* @param startup_id a startup-notification identifier, for which notification process should be completed
|
|
10428
|
+
* @since 3.0
|
|
10344
10429
|
*/
|
|
10345
10430
|
notify_startup_complete(startup_id: string): void;
|
|
10346
10431
|
|
|
@@ -10350,18 +10435,23 @@ export namespace Gdk {
|
|
|
10350
10435
|
* not get more events from the windowing system. It only checks the events
|
|
10351
10436
|
* that have already been moved to the GDK event queue.)
|
|
10352
10437
|
* @returns a copy of the first {@link Gdk.Event} on the event queue, or `null` if no events are in the queue. The returned {@link Gdk.Event} should be freed with `gdk_event_free()`.
|
|
10438
|
+
* @since 2.2
|
|
10353
10439
|
*/
|
|
10354
10440
|
peek_event(): Event | null;
|
|
10355
10441
|
|
|
10356
10442
|
/**
|
|
10357
10443
|
* Test if the pointer is grabbed.
|
|
10358
10444
|
* @returns `true` if an active X pointer grab is in effect
|
|
10445
|
+
* @since 2.2
|
|
10446
|
+
* @deprecated since 3.0: Use `gdk_display_device_is_grabbed()` instead.
|
|
10359
10447
|
*/
|
|
10360
10448
|
pointer_is_grabbed(): boolean;
|
|
10361
10449
|
|
|
10362
10450
|
/**
|
|
10363
10451
|
* Release any pointer grab.
|
|
10364
10452
|
* @param time_ a timestap (e.g. `GDK_CURRENT_TIME`).
|
|
10453
|
+
* @since 2.2
|
|
10454
|
+
* @deprecated since 3.0: Use `gdk_device_ungrab()`, together with `gdk_device_grab()` instead.
|
|
10365
10455
|
*/
|
|
10366
10456
|
pointer_ungrab(time_: number): void;
|
|
10367
10457
|
|
|
@@ -10369,6 +10459,7 @@ export namespace Gdk {
|
|
|
10369
10459
|
* Appends a copy of the given event onto the front of the event
|
|
10370
10460
|
* queue for `display`.
|
|
10371
10461
|
* @param event a {@link Gdk.Event}.
|
|
10462
|
+
* @since 2.2
|
|
10372
10463
|
*/
|
|
10373
10464
|
put_event(event: Event): void;
|
|
10374
10465
|
|
|
@@ -10377,6 +10468,7 @@ export namespace Gdk {
|
|
|
10377
10468
|
* of the selection named by the given atom.
|
|
10378
10469
|
* @param selection the {@link Gdk.Atom} naming the selection for which ownership change notification is requested
|
|
10379
10470
|
* @returns whether {@link Gdk.EventOwnerChange} events will be sent.
|
|
10471
|
+
* @since 2.6
|
|
10380
10472
|
*/
|
|
10381
10473
|
request_selection_notification(selection: Atom): boolean;
|
|
10382
10474
|
|
|
@@ -10387,6 +10479,7 @@ export namespace Gdk {
|
|
|
10387
10479
|
* Applications should not set this, it is a global
|
|
10388
10480
|
* user-configured setting.
|
|
10389
10481
|
* @param distance distance in pixels
|
|
10482
|
+
* @since 2.4
|
|
10390
10483
|
*/
|
|
10391
10484
|
set_double_click_distance(distance: number): void;
|
|
10392
10485
|
|
|
@@ -10396,6 +10489,7 @@ export namespace Gdk {
|
|
|
10396
10489
|
* Applications should not set this, it is a global
|
|
10397
10490
|
* user-configured setting.
|
|
10398
10491
|
* @param msec double click time in milliseconds (thousandths of a second)
|
|
10492
|
+
* @since 2.2
|
|
10399
10493
|
*/
|
|
10400
10494
|
set_double_click_time(msec: number): void;
|
|
10401
10495
|
|
|
@@ -10407,6 +10501,7 @@ export namespace Gdk {
|
|
|
10407
10501
|
* @param clipboard_window a {@link Gdk.Window} belonging to the clipboard owner
|
|
10408
10502
|
* @param time_ a timestamp
|
|
10409
10503
|
* @param targets an array of targets that should be saved, or `null` if all available targets should be saved.
|
|
10504
|
+
* @since 2.6
|
|
10410
10505
|
*/
|
|
10411
10506
|
store_clipboard(clipboard_window: Window, time_: number, targets: Atom[] | null): void;
|
|
10412
10507
|
|
|
@@ -10416,6 +10511,7 @@ export namespace Gdk {
|
|
|
10416
10511
|
* application has quit. On X11 this checks if a clipboard daemon is
|
|
10417
10512
|
* running.
|
|
10418
10513
|
* @returns `true` if the display supports clipboard persistance.
|
|
10514
|
+
* @since 2.6
|
|
10419
10515
|
*/
|
|
10420
10516
|
supports_clipboard_persistence(): boolean;
|
|
10421
10517
|
|
|
@@ -10426,6 +10522,8 @@ export namespace Gdk {
|
|
|
10426
10522
|
* Currently this only works on X11 with XComposite and
|
|
10427
10523
|
* XDamage extensions available.
|
|
10428
10524
|
* @returns `true` if windows may be composited.
|
|
10525
|
+
* @since 2.12
|
|
10526
|
+
* @deprecated since 3.16: Compositing is an outdated technology that only ever worked on X11.
|
|
10429
10527
|
*/
|
|
10430
10528
|
supports_composite(): boolean;
|
|
10431
10529
|
|
|
@@ -10434,6 +10532,7 @@ export namespace Gdk {
|
|
|
10434
10532
|
* on `display`. Otherwise, cursors are restricted to bilevel
|
|
10435
10533
|
* alpha (i.e. a mask).
|
|
10436
10534
|
* @returns whether cursors can have alpha channels.
|
|
10535
|
+
* @since 2.4
|
|
10437
10536
|
*/
|
|
10438
10537
|
supports_cursor_alpha(): boolean;
|
|
10439
10538
|
|
|
@@ -10442,6 +10541,7 @@ export namespace Gdk {
|
|
|
10442
10541
|
* on `display`. Otherwise, cursors have only a forground
|
|
10443
10542
|
* and a background color.
|
|
10444
10543
|
* @returns whether cursors can have multiple colors.
|
|
10544
|
+
* @since 2.4
|
|
10445
10545
|
*/
|
|
10446
10546
|
supports_cursor_color(): boolean;
|
|
10447
10547
|
|
|
@@ -10449,6 +10549,7 @@ export namespace Gdk {
|
|
|
10449
10549
|
* Returns `true` if `gdk_window_input_shape_combine_mask()` can
|
|
10450
10550
|
* be used to modify the input shape of windows on `display`.
|
|
10451
10551
|
* @returns `true` if windows with modified input shape are supported
|
|
10552
|
+
* @since 2.10
|
|
10452
10553
|
*/
|
|
10453
10554
|
supports_input_shapes(): boolean;
|
|
10454
10555
|
|
|
@@ -10456,6 +10557,7 @@ export namespace Gdk {
|
|
|
10456
10557
|
* Returns whether {@link Gdk.EventOwnerChange} events will be
|
|
10457
10558
|
* sent when the owner of a selection changes.
|
|
10458
10559
|
* @returns whether {@link Gdk.EventOwnerChange} events will be sent.
|
|
10560
|
+
* @since 2.6
|
|
10459
10561
|
*/
|
|
10460
10562
|
supports_selection_notification(): boolean;
|
|
10461
10563
|
|
|
@@ -10463,6 +10565,7 @@ export namespace Gdk {
|
|
|
10463
10565
|
* Returns `true` if `gdk_window_shape_combine_mask()` can
|
|
10464
10566
|
* be used to create shaped windows on `display`.
|
|
10465
10567
|
* @returns `true` if shaped windows are supported
|
|
10568
|
+
* @since 2.10
|
|
10466
10569
|
*/
|
|
10467
10570
|
supports_shapes(): boolean;
|
|
10468
10571
|
|
|
@@ -10476,6 +10579,7 @@ export namespace Gdk {
|
|
|
10476
10579
|
*
|
|
10477
10580
|
* This is most useful for X11. On windowing systems where requests are
|
|
10478
10581
|
* handled synchronously, this function will do nothing.
|
|
10582
|
+
* @since 2.2
|
|
10479
10583
|
*/
|
|
10480
10584
|
sync(): void;
|
|
10481
10585
|
|
|
@@ -10494,6 +10598,8 @@ export namespace Gdk {
|
|
|
10494
10598
|
* @param screen the screen of `display` to warp the pointer to
|
|
10495
10599
|
* @param x the x coordinate of the destination
|
|
10496
10600
|
* @param y the y coordinate of the destination
|
|
10601
|
+
* @since 2.8
|
|
10602
|
+
* @deprecated since 3.0: Use `gdk_device_warp()` instead.
|
|
10497
10603
|
*/
|
|
10498
10604
|
warp_pointer(screen: Screen, x: number, y: number): void;
|
|
10499
10605
|
}
|
|
@@ -10609,6 +10715,7 @@ export namespace Gdk {
|
|
|
10609
10715
|
* of the supported GDK backends to use (in case GDK has been compiled
|
|
10610
10716
|
* with multiple backends). Applications can use `gdk_set_allowed_backends()`
|
|
10611
10717
|
* to limit what backends can be used.
|
|
10718
|
+
* @since 2.2
|
|
10612
10719
|
*/
|
|
10613
10720
|
static get(): DisplayManager;
|
|
10614
10721
|
|
|
@@ -10616,12 +10723,14 @@ export namespace Gdk {
|
|
|
10616
10723
|
/**
|
|
10617
10724
|
* Gets the default {@link Gdk.Display}.
|
|
10618
10725
|
* @returns a {@link Gdk.Display}, or `null` if there is no default display.
|
|
10726
|
+
* @since 2.2
|
|
10619
10727
|
*/
|
|
10620
10728
|
get_default_display(): Display | null;
|
|
10621
10729
|
|
|
10622
10730
|
/**
|
|
10623
10731
|
* List all currently open displays.
|
|
10624
10732
|
* @returns a newly allocated {@link GLib.SList} of {@link Gdk.Display} objects. Free with `g_slist_free()` when you are done with it.
|
|
10733
|
+
* @since 2.2
|
|
10625
10734
|
*/
|
|
10626
10735
|
list_displays(): Display[];
|
|
10627
10736
|
|
|
@@ -10629,12 +10738,14 @@ export namespace Gdk {
|
|
|
10629
10738
|
* Opens a display.
|
|
10630
10739
|
* @param name the name of the display to open
|
|
10631
10740
|
* @returns a {@link Gdk.Display}, or `null` if the display could not be opened
|
|
10741
|
+
* @since 3.0
|
|
10632
10742
|
*/
|
|
10633
10743
|
open_display(name: string): Display | null;
|
|
10634
10744
|
|
|
10635
10745
|
/**
|
|
10636
10746
|
* Sets `display` as the default display.
|
|
10637
10747
|
* @param display a {@link Gdk.Display}
|
|
10748
|
+
* @since 2.2
|
|
10638
10749
|
*/
|
|
10639
10750
|
set_default_display(display: Display): void;
|
|
10640
10751
|
}
|
|
@@ -10733,12 +10844,14 @@ export namespace Gdk {
|
|
|
10733
10844
|
* Determines the bitmask of actions proposed by the source if
|
|
10734
10845
|
* `gdk_drag_context_get_suggested_action()` returns {@link Gdk.DragAction.ASK}.
|
|
10735
10846
|
* @returns the {@link Gdk.DragAction} flags
|
|
10847
|
+
* @since 2.22
|
|
10736
10848
|
*/
|
|
10737
10849
|
get_actions(): DragAction;
|
|
10738
10850
|
|
|
10739
10851
|
/**
|
|
10740
10852
|
* Returns the destination window for the DND operation.
|
|
10741
10853
|
* @returns a {@link Gdk.Window}
|
|
10854
|
+
* @since 3.0
|
|
10742
10855
|
*/
|
|
10743
10856
|
get_dest_window(): Window;
|
|
10744
10857
|
|
|
@@ -10756,36 +10869,42 @@ export namespace Gdk {
|
|
|
10756
10869
|
* The window is owned by `context` and will be destroyed when
|
|
10757
10870
|
* the drag operation is over.
|
|
10758
10871
|
* @returns the drag window, or `null`
|
|
10872
|
+
* @since 3.20
|
|
10759
10873
|
*/
|
|
10760
10874
|
get_drag_window(): Window | null;
|
|
10761
10875
|
|
|
10762
10876
|
/**
|
|
10763
10877
|
* Returns the drag protocol that is used by this context.
|
|
10764
10878
|
* @returns the drag protocol
|
|
10879
|
+
* @since 3.0
|
|
10765
10880
|
*/
|
|
10766
10881
|
get_protocol(): DragProtocol;
|
|
10767
10882
|
|
|
10768
10883
|
/**
|
|
10769
10884
|
* Determines the action chosen by the drag destination.
|
|
10770
10885
|
* @returns a {@link Gdk.DragAction} value
|
|
10886
|
+
* @since 2.22
|
|
10771
10887
|
*/
|
|
10772
10888
|
get_selected_action(): DragAction;
|
|
10773
10889
|
|
|
10774
10890
|
/**
|
|
10775
10891
|
* Returns the {@link Gdk.Window} where the DND operation started.
|
|
10776
10892
|
* @returns a {@link Gdk.Window}
|
|
10893
|
+
* @since 2.22
|
|
10777
10894
|
*/
|
|
10778
10895
|
get_source_window(): Window;
|
|
10779
10896
|
|
|
10780
10897
|
/**
|
|
10781
10898
|
* Determines the suggested drag action of the context.
|
|
10782
10899
|
* @returns a {@link Gdk.DragAction} value
|
|
10900
|
+
* @since 2.22
|
|
10783
10901
|
*/
|
|
10784
10902
|
get_suggested_action(): DragAction;
|
|
10785
10903
|
|
|
10786
10904
|
/**
|
|
10787
10905
|
* Retrieves the list of targets of the context.
|
|
10788
10906
|
* @returns a {@link GLib.List} of targets
|
|
10907
|
+
* @since 2.22
|
|
10789
10908
|
*/
|
|
10790
10909
|
list_targets(): Atom[];
|
|
10791
10910
|
|
|
@@ -10809,6 +10928,7 @@ export namespace Gdk {
|
|
|
10809
10928
|
* @param ipc_window Window to use for IPC messaging/events
|
|
10810
10929
|
* @param actions the actions supported by the drag source
|
|
10811
10930
|
* @returns `TRUE` if the drag and drop operation is managed.
|
|
10931
|
+
* @since 3.20
|
|
10812
10932
|
*/
|
|
10813
10933
|
manage_dnd(ipc_window: Window, actions: DragAction): boolean;
|
|
10814
10934
|
|
|
@@ -10825,6 +10945,7 @@ export namespace Gdk {
|
|
|
10825
10945
|
* top left corner of the drag window.
|
|
10826
10946
|
* @param hot_x x coordinate of the drag window hotspot
|
|
10827
10947
|
* @param hot_y y coordinate of the drag window hotspot
|
|
10948
|
+
* @since 3.20
|
|
10828
10949
|
*/
|
|
10829
10950
|
set_hotspot(hot_x: number, hot_y: number): void;
|
|
10830
10951
|
}
|
|
@@ -10911,24 +11032,28 @@ export namespace Gdk {
|
|
|
10911
11032
|
* {@link Gdk.DrawingContext} is valid, that is between a call to
|
|
10912
11033
|
* `gdk_window_begin_draw_frame()` and `gdk_window_end_draw_frame()`.
|
|
10913
11034
|
* @returns a Cairo context to be used to draw the contents of the {@link Gdk.Window}. The context is owned by the {@link Gdk.DrawingContext} and should not be destroyed
|
|
11035
|
+
* @since 3.22
|
|
10914
11036
|
*/
|
|
10915
11037
|
get_cairo_context(): cairo.Context;
|
|
10916
11038
|
|
|
10917
11039
|
/**
|
|
10918
11040
|
* Retrieves a copy of the clip region used when creating the `context`.
|
|
10919
11041
|
* @returns a Cairo region
|
|
11042
|
+
* @since 3.22
|
|
10920
11043
|
*/
|
|
10921
11044
|
get_clip(): cairo.Region | null;
|
|
10922
11045
|
|
|
10923
11046
|
/**
|
|
10924
11047
|
* Retrieves the window that created the drawing `context`.
|
|
10925
11048
|
* @returns a {@link Gdk.Window}
|
|
11049
|
+
* @since 3.22
|
|
10926
11050
|
*/
|
|
10927
11051
|
get_window(): Window;
|
|
10928
11052
|
|
|
10929
11053
|
/**
|
|
10930
11054
|
* Checks whether the given {@link Gdk.DrawingContext} is valid.
|
|
10931
11055
|
* @returns `true` if the context is valid
|
|
11056
|
+
* @since 3.22
|
|
10932
11057
|
*/
|
|
10933
11058
|
is_valid(): boolean;
|
|
10934
11059
|
}
|
|
@@ -11077,18 +11202,21 @@ export namespace Gdk {
|
|
|
11077
11202
|
* This function may be called multiple times and frames will be
|
|
11078
11203
|
* requested until `gdk_frame_clock_end_updating()` is called the same
|
|
11079
11204
|
* number of times.
|
|
11205
|
+
* @since 3.8
|
|
11080
11206
|
*/
|
|
11081
11207
|
begin_updating(): void;
|
|
11082
11208
|
|
|
11083
11209
|
/**
|
|
11084
11210
|
* Stops updates for an animation. See the documentation for
|
|
11085
11211
|
* `gdk_frame_clock_begin_updating()`.
|
|
11212
|
+
* @since 3.8
|
|
11086
11213
|
*/
|
|
11087
11214
|
end_updating(): void;
|
|
11088
11215
|
|
|
11089
11216
|
/**
|
|
11090
11217
|
* Gets the frame timings for the current frame.
|
|
11091
11218
|
* @returns the {@link Gdk.FrameTimings} for the frame currently being processed, or even no frame is being processed, for the previous frame. Before any frames have been processed, returns `null`.
|
|
11219
|
+
* @since 3.8
|
|
11092
11220
|
*/
|
|
11093
11221
|
get_current_timings(): FrameTimings | null;
|
|
11094
11222
|
|
|
@@ -11096,6 +11224,7 @@ export namespace Gdk {
|
|
|
11096
11224
|
* A {@link Gdk.FrameClock} maintains a 64-bit counter that increments for
|
|
11097
11225
|
* each frame drawn.
|
|
11098
11226
|
* @returns inside frame processing, the value of the frame counter for the current frame. Outside of frame processing, the frame counter for the last frame.
|
|
11227
|
+
* @since 3.8
|
|
11099
11228
|
*/
|
|
11100
11229
|
get_frame_counter(): number;
|
|
11101
11230
|
|
|
@@ -11107,6 +11236,7 @@ export namespace Gdk {
|
|
|
11107
11236
|
* the actual previous frame time, or if that’s too old, an updated
|
|
11108
11237
|
* time.
|
|
11109
11238
|
* @returns a timestamp in microseconds, in the timescale of of `g_get_monotonic_time()`.
|
|
11239
|
+
* @since 3.8
|
|
11110
11240
|
*/
|
|
11111
11241
|
get_frame_time(): number;
|
|
11112
11242
|
|
|
@@ -11118,6 +11248,7 @@ export namespace Gdk {
|
|
|
11118
11248
|
* `gdk_frame_clock_get_history_start()` and
|
|
11119
11249
|
* `gdk_frame_clock_get_frame_counter()`, inclusive.
|
|
11120
11250
|
* @returns the frame counter value for the oldest frame that is available in the internal frame history of the {@link Gdk.FrameClock}.
|
|
11251
|
+
* @since 3.8
|
|
11121
11252
|
*/
|
|
11122
11253
|
get_history_start(): number;
|
|
11123
11254
|
|
|
@@ -11128,6 +11259,7 @@ export namespace Gdk {
|
|
|
11128
11259
|
* predicts a presentation time that is a multiple of the refresh
|
|
11129
11260
|
* interval after the last presentation time, and later than `base_time`.
|
|
11130
11261
|
* @param base_time base time for determining a presentaton time
|
|
11262
|
+
* @since 3.8
|
|
11131
11263
|
*/
|
|
11132
11264
|
get_refresh_info(base_time: bigint | number): [number, number];
|
|
11133
11265
|
|
|
@@ -11137,6 +11269,7 @@ export namespace Gdk {
|
|
|
11137
11269
|
* object may not yet be complete: see `gdk_frame_timings_get_complete()`.
|
|
11138
11270
|
* @param frame_counter the frame counter value identifying the frame to be received.
|
|
11139
11271
|
* @returns the {@link Gdk.FrameTimings} object for the specified frame, or `null` if it is not available. See `gdk_frame_clock_get_history_start()`.
|
|
11272
|
+
* @since 3.8
|
|
11140
11273
|
*/
|
|
11141
11274
|
get_timings(frame_counter: bigint | number): FrameTimings | null;
|
|
11142
11275
|
|
|
@@ -11152,6 +11285,7 @@ export namespace Gdk {
|
|
|
11152
11285
|
* this allows GTK+ to adjust system parameters to get maximally
|
|
11153
11286
|
* smooth animations.
|
|
11154
11287
|
* @param phase the phase that is requested
|
|
11288
|
+
* @since 3.8
|
|
11155
11289
|
*/
|
|
11156
11290
|
request_phase(phase: FrameClockPhase): void;
|
|
11157
11291
|
}
|
|
@@ -11295,11 +11429,13 @@ export namespace Gdk {
|
|
|
11295
11429
|
*
|
|
11296
11430
|
* Any OpenGL call after this function returns will be ignored
|
|
11297
11431
|
* until `gdk_gl_context_make_current()` is called.
|
|
11432
|
+
* @since 3.16
|
|
11298
11433
|
*/
|
|
11299
11434
|
static clear_current(): void;
|
|
11300
11435
|
|
|
11301
11436
|
/**
|
|
11302
11437
|
* Retrieves the current {@link Gdk.GLContext}.
|
|
11438
|
+
* @since 3.16
|
|
11303
11439
|
*/
|
|
11304
11440
|
static get_current(): GLContext | null;
|
|
11305
11441
|
|
|
@@ -11307,36 +11443,42 @@ export namespace Gdk {
|
|
|
11307
11443
|
/**
|
|
11308
11444
|
* Retrieves the value set using `gdk_gl_context_set_debug_enabled()`.
|
|
11309
11445
|
* @returns `true` if debugging is enabled
|
|
11446
|
+
* @since 3.16
|
|
11310
11447
|
*/
|
|
11311
11448
|
get_debug_enabled(): boolean;
|
|
11312
11449
|
|
|
11313
11450
|
/**
|
|
11314
11451
|
* Retrieves the {@link Gdk.Display} the `context` is created for
|
|
11315
11452
|
* @returns a {@link Gdk.Display} or `null`
|
|
11453
|
+
* @since 3.16
|
|
11316
11454
|
*/
|
|
11317
11455
|
get_display(): Display | null;
|
|
11318
11456
|
|
|
11319
11457
|
/**
|
|
11320
11458
|
* Retrieves the value set using `gdk_gl_context_set_forward_compatible()`.
|
|
11321
11459
|
* @returns `true` if the context should be forward compatible
|
|
11460
|
+
* @since 3.16
|
|
11322
11461
|
*/
|
|
11323
11462
|
get_forward_compatible(): boolean;
|
|
11324
11463
|
|
|
11325
11464
|
/**
|
|
11326
11465
|
* Retrieves the major and minor version requested by calling
|
|
11327
11466
|
* `gdk_gl_context_set_required_version()`.
|
|
11467
|
+
* @since 3.16
|
|
11328
11468
|
*/
|
|
11329
11469
|
get_required_version(): [number, number];
|
|
11330
11470
|
|
|
11331
11471
|
/**
|
|
11332
11472
|
* Retrieves the {@link Gdk.GLContext} that this `context` share data with.
|
|
11333
11473
|
* @returns a {@link Gdk.GLContext} or `null`
|
|
11474
|
+
* @since 3.16
|
|
11334
11475
|
*/
|
|
11335
11476
|
get_shared_context(): GLContext | null;
|
|
11336
11477
|
|
|
11337
11478
|
/**
|
|
11338
11479
|
* Checks whether the `context` is using an OpenGL or OpenGL ES profile.
|
|
11339
11480
|
* @returns `true` if the {@link Gdk.GLContext} is using an OpenGL ES profile
|
|
11481
|
+
* @since 3.22
|
|
11340
11482
|
*/
|
|
11341
11483
|
get_use_es(): boolean;
|
|
11342
11484
|
|
|
@@ -11344,12 +11486,14 @@ export namespace Gdk {
|
|
|
11344
11486
|
* Retrieves the OpenGL version of the `context`.
|
|
11345
11487
|
*
|
|
11346
11488
|
* The `context` must be realized prior to calling this function.
|
|
11489
|
+
* @since 3.16
|
|
11347
11490
|
*/
|
|
11348
11491
|
get_version(): [number, number];
|
|
11349
11492
|
|
|
11350
11493
|
/**
|
|
11351
11494
|
* Retrieves the {@link Gdk.Window} used by the `context`.
|
|
11352
11495
|
* @returns a {@link Gdk.Window} or `null`
|
|
11496
|
+
* @since 3.16
|
|
11353
11497
|
*/
|
|
11354
11498
|
get_window(): Window | null;
|
|
11355
11499
|
|
|
@@ -11371,11 +11515,13 @@ export namespace Gdk {
|
|
|
11371
11515
|
* of OpenGL API to use, or whether to do extension discovery, or what
|
|
11372
11516
|
* kind of shader programs to load.
|
|
11373
11517
|
* @returns `true` if the GL context is in legacy mode
|
|
11518
|
+
* @since 3.20
|
|
11374
11519
|
*/
|
|
11375
11520
|
is_legacy(): boolean;
|
|
11376
11521
|
|
|
11377
11522
|
/**
|
|
11378
11523
|
* Makes the `context` the current one.
|
|
11524
|
+
* @since 3.16
|
|
11379
11525
|
*/
|
|
11380
11526
|
make_current(): void;
|
|
11381
11527
|
|
|
@@ -11384,6 +11530,7 @@ export namespace Gdk {
|
|
|
11384
11530
|
*
|
|
11385
11531
|
* It is safe to call this function on a realized {@link Gdk.GLContext}.
|
|
11386
11532
|
* @returns `true` if the context is realized
|
|
11533
|
+
* @since 3.16
|
|
11387
11534
|
*/
|
|
11388
11535
|
realize(): boolean;
|
|
11389
11536
|
|
|
@@ -11395,6 +11542,7 @@ export namespace Gdk {
|
|
|
11395
11542
|
* The {@link Gdk.GLContext} must not be realized or made current prior to
|
|
11396
11543
|
* calling this function.
|
|
11397
11544
|
* @param enabled whether to enable debugging in the context
|
|
11545
|
+
* @since 3.16
|
|
11398
11546
|
*/
|
|
11399
11547
|
set_debug_enabled(enabled: boolean): void;
|
|
11400
11548
|
|
|
@@ -11409,6 +11557,7 @@ export namespace Gdk {
|
|
|
11409
11557
|
* The {@link Gdk.GLContext} must not be realized or made current prior to calling
|
|
11410
11558
|
* this function.
|
|
11411
11559
|
* @param compatible whether the context should be forward compatible
|
|
11560
|
+
* @since 3.16
|
|
11412
11561
|
*/
|
|
11413
11562
|
set_forward_compatible(compatible: boolean): void;
|
|
11414
11563
|
|
|
@@ -11421,6 +11570,7 @@ export namespace Gdk {
|
|
|
11421
11570
|
* this function.
|
|
11422
11571
|
* @param major the major version to request
|
|
11423
11572
|
* @param minor the minor version to request
|
|
11573
|
+
* @since 3.16
|
|
11424
11574
|
*/
|
|
11425
11575
|
set_required_version(major: number, minor: number): void;
|
|
11426
11576
|
|
|
@@ -11438,6 +11588,7 @@ export namespace Gdk {
|
|
|
11438
11588
|
* calling `gdk_gl_context_realize()` to decide whether to use the OpenGL or
|
|
11439
11589
|
* OpenGL ES API, extensions, or shaders.
|
|
11440
11590
|
* @param use_es whether the context should use OpenGL ES instead of OpenGL, or -1 to allow auto-detection
|
|
11591
|
+
* @since 3.22
|
|
11441
11592
|
*/
|
|
11442
11593
|
set_use_es(use_es: number): void;
|
|
11443
11594
|
}
|
|
@@ -11519,12 +11670,14 @@ export namespace Gdk {
|
|
|
11519
11670
|
// Static methods
|
|
11520
11671
|
/**
|
|
11521
11672
|
* Returns the {@link Gdk.Keymap} attached to the default display.
|
|
11673
|
+
* @deprecated since 3.22: Use `gdk_keymap_get_for_display()` instead
|
|
11522
11674
|
*/
|
|
11523
11675
|
static get_default(): Keymap;
|
|
11524
11676
|
|
|
11525
11677
|
/**
|
|
11526
11678
|
* Returns the {@link Gdk.Keymap} attached to `display`.
|
|
11527
11679
|
* @param display the {@link Gdk.Display}.
|
|
11680
|
+
* @since 2.2
|
|
11528
11681
|
*/
|
|
11529
11682
|
static get_for_display(display: Display): Keymap;
|
|
11530
11683
|
|
|
@@ -11541,12 +11694,14 @@ export namespace Gdk {
|
|
|
11541
11694
|
* This function is useful when matching key events against
|
|
11542
11695
|
* accelerators.
|
|
11543
11696
|
* @param state pointer to the modifier mask to change
|
|
11697
|
+
* @since 2.20
|
|
11544
11698
|
*/
|
|
11545
11699
|
add_virtual_modifiers(state: ModifierType): ModifierType;
|
|
11546
11700
|
|
|
11547
11701
|
/**
|
|
11548
11702
|
* Returns whether the Caps Lock modifer is locked.
|
|
11549
11703
|
* @returns `true` if Caps Lock is on
|
|
11704
|
+
* @since 2.16
|
|
11550
11705
|
*/
|
|
11551
11706
|
get_caps_lock_state(): boolean;
|
|
11552
11707
|
|
|
@@ -11597,24 +11752,28 @@ export namespace Gdk {
|
|
|
11597
11752
|
* expected result.
|
|
11598
11753
|
* @param intent the use case for the modifier mask
|
|
11599
11754
|
* @returns the modifier mask used for `intent`.
|
|
11755
|
+
* @since 3.4
|
|
11600
11756
|
*/
|
|
11601
11757
|
get_modifier_mask(intent: ModifierIntent): ModifierType;
|
|
11602
11758
|
|
|
11603
11759
|
/**
|
|
11604
11760
|
* Returns the current modifier state.
|
|
11605
11761
|
* @returns the current modifier state.
|
|
11762
|
+
* @since 3.4
|
|
11606
11763
|
*/
|
|
11607
11764
|
get_modifier_state(): number;
|
|
11608
11765
|
|
|
11609
11766
|
/**
|
|
11610
11767
|
* Returns whether the Num Lock modifer is locked.
|
|
11611
11768
|
* @returns `true` if Num Lock is on
|
|
11769
|
+
* @since 3.0
|
|
11612
11770
|
*/
|
|
11613
11771
|
get_num_lock_state(): boolean;
|
|
11614
11772
|
|
|
11615
11773
|
/**
|
|
11616
11774
|
* Returns whether the Scroll Lock modifer is locked.
|
|
11617
11775
|
* @returns `true` if Scroll Lock is on
|
|
11776
|
+
* @since 3.18
|
|
11618
11777
|
*/
|
|
11619
11778
|
get_scroll_lock_state(): boolean;
|
|
11620
11779
|
|
|
@@ -11622,6 +11781,7 @@ export namespace Gdk {
|
|
|
11622
11781
|
* Determines if keyboard layouts for both right-to-left and left-to-right
|
|
11623
11782
|
* languages are in use.
|
|
11624
11783
|
* @returns `true` if there are layouts in both directions, `false` otherwise
|
|
11784
|
+
* @since 2.12
|
|
11625
11785
|
*/
|
|
11626
11786
|
have_bidi_layouts(): boolean;
|
|
11627
11787
|
|
|
@@ -11645,6 +11805,7 @@ export namespace Gdk {
|
|
|
11645
11805
|
* accelerators.
|
|
11646
11806
|
* @param state pointer to the modifier state to map
|
|
11647
11807
|
* @returns `false` if two virtual modifiers were mapped to the same non-virtual modifier. Note that `false` is also returned if a virtual modifier is mapped to a non-virtual modifier that was already set in `state`.
|
|
11808
|
+
* @since 2.20
|
|
11648
11809
|
*/
|
|
11649
11810
|
map_virtual_modifiers(state: ModifierType): [boolean, ModifierType];
|
|
11650
11811
|
|
|
@@ -11882,6 +12043,7 @@ export namespace Gdk {
|
|
|
11882
12043
|
/**
|
|
11883
12044
|
* Gets the display that this monitor belongs to.
|
|
11884
12045
|
* @returns the display
|
|
12046
|
+
* @since 3.22
|
|
11885
12047
|
*/
|
|
11886
12048
|
get_display(): Display;
|
|
11887
12049
|
|
|
@@ -11889,12 +12051,14 @@ export namespace Gdk {
|
|
|
11889
12051
|
* Retrieves the size and position of an individual monitor within the
|
|
11890
12052
|
* display coordinate space. The returned geometry is in ”application pixels”,
|
|
11891
12053
|
* not in ”device pixels” (see `gdk_monitor_get_scale_factor()`).
|
|
12054
|
+
* @since 3.22
|
|
11892
12055
|
*/
|
|
11893
12056
|
get_geometry(): Rectangle;
|
|
11894
12057
|
|
|
11895
12058
|
/**
|
|
11896
12059
|
* Gets the height in millimeters of the monitor.
|
|
11897
12060
|
* @returns the physical height of the monitor
|
|
12061
|
+
* @since 3.22
|
|
11898
12062
|
*/
|
|
11899
12063
|
get_height_mm(): number;
|
|
11900
12064
|
|
|
@@ -11921,6 +12085,7 @@ export namespace Gdk {
|
|
|
11921
12085
|
* The value is in milli-Hertz, so a refresh rate of 60Hz
|
|
11922
12086
|
* is returned as 60000.
|
|
11923
12087
|
* @returns the refresh rate in milli-Hertz, or 0
|
|
12088
|
+
* @since 3.22
|
|
11924
12089
|
*/
|
|
11925
12090
|
get_refresh_rate(): number;
|
|
11926
12091
|
|
|
@@ -11933,6 +12098,7 @@ export namespace Gdk {
|
|
|
11933
12098
|
* particular monitor, but most of the time you’re drawing to a window
|
|
11934
12099
|
* where it is better to use `gdk_window_get_scale_factor()` instead.
|
|
11935
12100
|
* @returns the scale factor
|
|
12101
|
+
* @since 3.22
|
|
11936
12102
|
*/
|
|
11937
12103
|
get_scale_factor(): number;
|
|
11938
12104
|
|
|
@@ -11940,12 +12106,14 @@ export namespace Gdk {
|
|
|
11940
12106
|
* Gets information about the layout of red, green and blue
|
|
11941
12107
|
* primaries for each pixel in this monitor, if available.
|
|
11942
12108
|
* @returns the subpixel layout
|
|
12109
|
+
* @since 3.22
|
|
11943
12110
|
*/
|
|
11944
12111
|
get_subpixel_layout(): SubpixelLayout;
|
|
11945
12112
|
|
|
11946
12113
|
/**
|
|
11947
12114
|
* Gets the width in millimeters of the monitor.
|
|
11948
12115
|
* @returns the physical width of the monitor
|
|
12116
|
+
* @since 3.22
|
|
11949
12117
|
*/
|
|
11950
12118
|
get_width_mm(): number;
|
|
11951
12119
|
|
|
@@ -11962,6 +12130,7 @@ export namespace Gdk {
|
|
|
11962
12130
|
* Note that not all backends may have a concept of workarea. This
|
|
11963
12131
|
* function will return the monitor geometry if a workarea is not
|
|
11964
12132
|
* available, or does not apply.
|
|
12133
|
+
* @since 3.22
|
|
11965
12134
|
*/
|
|
11966
12135
|
get_workarea(): Rectangle;
|
|
11967
12136
|
|
|
@@ -11969,6 +12138,7 @@ export namespace Gdk {
|
|
|
11969
12138
|
* Gets whether this monitor should be considered primary
|
|
11970
12139
|
* (see `gdk_display_get_primary_monitor()`).
|
|
11971
12140
|
* @returns `true` if `monitor` is primary
|
|
12141
|
+
* @since 3.22
|
|
11972
12142
|
*/
|
|
11973
12143
|
is_primary(): boolean;
|
|
11974
12144
|
}
|
|
@@ -12077,6 +12247,7 @@ export namespace Gdk {
|
|
|
12077
12247
|
/**
|
|
12078
12248
|
* Gets the default screen for the default display. (See
|
|
12079
12249
|
* gdk_display_get_default ()).
|
|
12250
|
+
* @since 2.2
|
|
12080
12251
|
*/
|
|
12081
12252
|
static get_default(): Screen | null;
|
|
12082
12253
|
|
|
@@ -12084,12 +12255,14 @@ export namespace Gdk {
|
|
|
12084
12255
|
* Gets the height of the default screen in pixels. The returned
|
|
12085
12256
|
* size is in ”application pixels”, not in ”device pixels” (see
|
|
12086
12257
|
* `gdk_screen_get_monitor_scale_factor()`).
|
|
12258
|
+
* @deprecated since 3.22: Use per-monitor information
|
|
12087
12259
|
*/
|
|
12088
12260
|
static height(): number;
|
|
12089
12261
|
|
|
12090
12262
|
/**
|
|
12091
12263
|
* Returns the height of the default screen in millimeters.
|
|
12092
12264
|
* Note that on many X servers this value will not be correct.
|
|
12265
|
+
* @deprecated since 3.22: Use per-monitor information
|
|
12093
12266
|
*/
|
|
12094
12267
|
static height_mm(): number;
|
|
12095
12268
|
|
|
@@ -12097,12 +12270,14 @@ export namespace Gdk {
|
|
|
12097
12270
|
* Gets the width of the default screen in pixels. The returned
|
|
12098
12271
|
* size is in ”application pixels”, not in ”device pixels” (see
|
|
12099
12272
|
* `gdk_screen_get_monitor_scale_factor()`).
|
|
12273
|
+
* @deprecated since 3.22: Use per-monitor information
|
|
12100
12274
|
*/
|
|
12101
12275
|
static width(): number;
|
|
12102
12276
|
|
|
12103
12277
|
/**
|
|
12104
12278
|
* Returns the width of the default screen in millimeters.
|
|
12105
12279
|
* Note that on many X servers this value will not be correct.
|
|
12280
|
+
* @deprecated since 3.22: Use per-monitor information
|
|
12106
12281
|
*/
|
|
12107
12282
|
static width_mm(): number;
|
|
12108
12283
|
|
|
@@ -12123,18 +12298,22 @@ export namespace Gdk {
|
|
|
12123
12298
|
* The returned window should be unrefed using `g_object_unref()` when
|
|
12124
12299
|
* no longer needed.
|
|
12125
12300
|
* @returns the currently active window, or `null`.
|
|
12301
|
+
* @since 2.10
|
|
12302
|
+
* @deprecated since 3.22
|
|
12126
12303
|
*/
|
|
12127
12304
|
get_active_window(): Window | null;
|
|
12128
12305
|
|
|
12129
12306
|
/**
|
|
12130
12307
|
* Gets the display to which the `screen` belongs.
|
|
12131
12308
|
* @returns the display to which `screen` belongs
|
|
12309
|
+
* @since 2.2
|
|
12132
12310
|
*/
|
|
12133
12311
|
get_display(): Display;
|
|
12134
12312
|
|
|
12135
12313
|
/**
|
|
12136
12314
|
* Gets any options previously set with `gdk_screen_set_font_options()`.
|
|
12137
12315
|
* @returns the current font options, or `null` if no default font options have been set.
|
|
12316
|
+
* @since 2.10
|
|
12138
12317
|
*/
|
|
12139
12318
|
get_font_options(): cairo.FontOptions | null;
|
|
12140
12319
|
|
|
@@ -12143,6 +12322,8 @@ export namespace Gdk {
|
|
|
12143
12322
|
* ”application pixels”, not in ”device pixels” (see
|
|
12144
12323
|
* `gdk_screen_get_monitor_scale_factor()`).
|
|
12145
12324
|
* @returns the height of `screen` in pixels.
|
|
12325
|
+
* @since 2.2
|
|
12326
|
+
* @deprecated since 3.22: Use per-monitor information instead
|
|
12146
12327
|
*/
|
|
12147
12328
|
get_height(): number;
|
|
12148
12329
|
|
|
@@ -12153,6 +12334,8 @@ export namespace Gdk {
|
|
|
12153
12334
|
* has multiple monitors of different resolution. It is recommended
|
|
12154
12335
|
* to use the monitor dimensions instead.
|
|
12155
12336
|
* @returns the heigth of `screen` in millimeters.
|
|
12337
|
+
* @since 2.2
|
|
12338
|
+
* @deprecated since 3.22: Use per-monitor information instead
|
|
12156
12339
|
*/
|
|
12157
12340
|
get_height_mm(): number;
|
|
12158
12341
|
|
|
@@ -12161,6 +12344,8 @@ export namespace Gdk {
|
|
|
12161
12344
|
* @param x the x coordinate in the virtual screen.
|
|
12162
12345
|
* @param y the y coordinate in the virtual screen.
|
|
12163
12346
|
* @returns the monitor number in which the point (`x`,`y`) lies, or a monitor close to (`x`,`y`) if the point is not in any monitor.
|
|
12347
|
+
* @since 2.2
|
|
12348
|
+
* @deprecated since 3.22: Use `gdk_display_get_monitor_at_point()` instead
|
|
12164
12349
|
*/
|
|
12165
12350
|
get_monitor_at_point(x: number, y: number): number;
|
|
12166
12351
|
|
|
@@ -12169,6 +12354,8 @@ export namespace Gdk {
|
|
|
12169
12354
|
* bounding rectangle of `window` resides.
|
|
12170
12355
|
* @param window a {@link Gdk.Window}
|
|
12171
12356
|
* @returns the monitor number in which most of `window` is located, or if `window` does not intersect any monitors, a monitor, close to `window`.
|
|
12357
|
+
* @since 2.2
|
|
12358
|
+
* @deprecated since 3.22: Use `gdk_display_get_monitor_at_window()` instead
|
|
12172
12359
|
*/
|
|
12173
12360
|
get_monitor_at_window(window: Window): number;
|
|
12174
12361
|
|
|
@@ -12184,6 +12371,8 @@ export namespace Gdk {
|
|
|
12184
12371
|
* Note that the size of the entire screen area can be retrieved via
|
|
12185
12372
|
* `gdk_screen_get_width()` and `gdk_screen_get_height()`.
|
|
12186
12373
|
* @param monitor_num the monitor number
|
|
12374
|
+
* @since 2.2
|
|
12375
|
+
* @deprecated since 3.22: Use `gdk_monitor_get_geometry()` instead
|
|
12187
12376
|
*/
|
|
12188
12377
|
get_monitor_geometry(monitor_num: number): Rectangle | null;
|
|
12189
12378
|
|
|
@@ -12191,6 +12380,8 @@ export namespace Gdk {
|
|
|
12191
12380
|
* Gets the height in millimeters of the specified monitor.
|
|
12192
12381
|
* @param monitor_num number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
|
|
12193
12382
|
* @returns the height of the monitor, or -1 if not available
|
|
12383
|
+
* @since 2.14
|
|
12384
|
+
* @deprecated since 3.22: Use `gdk_monitor_get_height_mm()` instead
|
|
12194
12385
|
*/
|
|
12195
12386
|
get_monitor_height_mm(monitor_num: number): number;
|
|
12196
12387
|
|
|
@@ -12200,6 +12391,8 @@ export namespace Gdk {
|
|
|
12200
12391
|
* product name of the display device.
|
|
12201
12392
|
* @param monitor_num number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
|
|
12202
12393
|
* @returns a newly-allocated string containing the name of the monitor, or `null` if the name cannot be determined
|
|
12394
|
+
* @since 2.14
|
|
12395
|
+
* @deprecated since 3.22: Use `gdk_monitor_get_model()` instead
|
|
12203
12396
|
*/
|
|
12204
12397
|
get_monitor_plug_name(monitor_num: number): string | null;
|
|
12205
12398
|
|
|
@@ -12213,6 +12406,8 @@ export namespace Gdk {
|
|
|
12213
12406
|
* where it is better to use `gdk_window_get_scale_factor()` instead.
|
|
12214
12407
|
* @param monitor_num number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
|
|
12215
12408
|
* @returns the scale factor
|
|
12409
|
+
* @since 3.10
|
|
12410
|
+
* @deprecated since 3.22: Use `gdk_monitor_get_scale_factor()` instead
|
|
12216
12411
|
*/
|
|
12217
12412
|
get_monitor_scale_factor(monitor_num: number): number;
|
|
12218
12413
|
|
|
@@ -12220,6 +12415,8 @@ export namespace Gdk {
|
|
|
12220
12415
|
* Gets the width in millimeters of the specified monitor, if available.
|
|
12221
12416
|
* @param monitor_num number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
|
|
12222
12417
|
* @returns the width of the monitor, or -1 if not available
|
|
12418
|
+
* @since 2.14
|
|
12419
|
+
* @deprecated since 3.22: Use `gdk_monitor_get_width_mm()` instead
|
|
12223
12420
|
*/
|
|
12224
12421
|
get_monitor_width_mm(monitor_num: number): number;
|
|
12225
12422
|
|
|
@@ -12240,12 +12437,16 @@ export namespace Gdk {
|
|
|
12240
12437
|
* Monitor numbers start at 0. To obtain the number of monitors of
|
|
12241
12438
|
* `screen`, use `gdk_screen_get_n_monitors()`.
|
|
12242
12439
|
* @param monitor_num the monitor number
|
|
12440
|
+
* @since 3.4
|
|
12441
|
+
* @deprecated since 3.22: Use `gdk_monitor_get_workarea()` instead
|
|
12243
12442
|
*/
|
|
12244
12443
|
get_monitor_workarea(monitor_num: number): Rectangle | null;
|
|
12245
12444
|
|
|
12246
12445
|
/**
|
|
12247
12446
|
* Returns the number of monitors which `screen` consists of.
|
|
12248
12447
|
* @returns number of monitors which `screen` consists of
|
|
12448
|
+
* @since 2.2
|
|
12449
|
+
* @deprecated since 3.22: Use `gdk_display_get_n_monitors()` instead
|
|
12249
12450
|
*/
|
|
12250
12451
|
get_n_monitors(): number;
|
|
12251
12452
|
|
|
@@ -12253,6 +12454,8 @@ export namespace Gdk {
|
|
|
12253
12454
|
* Gets the index of `screen` among the screens in the display
|
|
12254
12455
|
* to which it belongs. (See `gdk_screen_get_display()`)
|
|
12255
12456
|
* @returns the index
|
|
12457
|
+
* @since 2.2
|
|
12458
|
+
* @deprecated since 3.22
|
|
12256
12459
|
*/
|
|
12257
12460
|
get_number(): number;
|
|
12258
12461
|
|
|
@@ -12266,6 +12469,8 @@ export namespace Gdk {
|
|
|
12266
12469
|
* If no primary monitor is configured by the user, the return value
|
|
12267
12470
|
* will be 0, defaulting to the first monitor.
|
|
12268
12471
|
* @returns An integer index for the primary monitor, or 0 if none is configured.
|
|
12472
|
+
* @since 2.20
|
|
12473
|
+
* @deprecated since 3.22: Use `gdk_display_get_primary_monitor()` instead
|
|
12269
12474
|
*/
|
|
12270
12475
|
get_primary_monitor(): number;
|
|
12271
12476
|
|
|
@@ -12273,6 +12478,7 @@ export namespace Gdk {
|
|
|
12273
12478
|
* Gets the resolution for font handling on the screen; see
|
|
12274
12479
|
* `gdk_screen_set_resolution()` for full details.
|
|
12275
12480
|
* @returns the current resolution, or -1 if no resolution has been set.
|
|
12481
|
+
* @since 2.10
|
|
12276
12482
|
*/
|
|
12277
12483
|
get_resolution(): number;
|
|
12278
12484
|
|
|
@@ -12291,12 +12497,14 @@ export namespace Gdk {
|
|
|
12291
12497
|
* For setting an overall opacity for a top-level window, see
|
|
12292
12498
|
* `gdk_window_set_opacity()`.
|
|
12293
12499
|
* @returns a visual to use for windows with an alpha channel or `null` if the capability is not available.
|
|
12500
|
+
* @since 2.8
|
|
12294
12501
|
*/
|
|
12295
12502
|
get_rgba_visual(): Visual | null;
|
|
12296
12503
|
|
|
12297
12504
|
/**
|
|
12298
12505
|
* Gets the root window of `screen`.
|
|
12299
12506
|
* @returns the root window
|
|
12507
|
+
* @since 2.2
|
|
12300
12508
|
*/
|
|
12301
12509
|
get_root_window(): Window;
|
|
12302
12510
|
|
|
@@ -12309,6 +12517,7 @@ export namespace Gdk {
|
|
|
12309
12517
|
* @param name the name of the setting
|
|
12310
12518
|
* @param value location to store the value of the setting
|
|
12311
12519
|
* @returns `true` if the setting existed and a value was stored in `value`, `false` otherwise.
|
|
12520
|
+
* @since 2.2
|
|
12312
12521
|
*/
|
|
12313
12522
|
get_setting(name: string, value: GObject.Value | any): boolean;
|
|
12314
12523
|
|
|
@@ -12317,6 +12526,7 @@ export namespace Gdk {
|
|
|
12317
12526
|
* This is the visual for the root window of the display.
|
|
12318
12527
|
* The return value should not be freed.
|
|
12319
12528
|
* @returns the system visual
|
|
12529
|
+
* @since 2.2
|
|
12320
12530
|
*/
|
|
12321
12531
|
get_system_visual(): Visual;
|
|
12322
12532
|
|
|
@@ -12328,6 +12538,7 @@ export namespace Gdk {
|
|
|
12328
12538
|
* The returned list should be freed with `g_list_free()`, but
|
|
12329
12539
|
* its elements need not be freed.
|
|
12330
12540
|
* @returns list of toplevel windows, free with `g_list_free()`
|
|
12541
|
+
* @since 2.2
|
|
12331
12542
|
*/
|
|
12332
12543
|
get_toplevel_windows(): Window[];
|
|
12333
12544
|
|
|
@@ -12336,6 +12547,8 @@ export namespace Gdk {
|
|
|
12336
12547
|
* ”application pixels”, not in ”device pixels” (see
|
|
12337
12548
|
* `gdk_screen_get_monitor_scale_factor()`).
|
|
12338
12549
|
* @returns the width of `screen` in pixels.
|
|
12550
|
+
* @since 2.2
|
|
12551
|
+
* @deprecated since 3.22: Use per-monitor information instead
|
|
12339
12552
|
*/
|
|
12340
12553
|
get_width(): number;
|
|
12341
12554
|
|
|
@@ -12346,6 +12559,8 @@ export namespace Gdk {
|
|
|
12346
12559
|
* has multiple monitors of different resolution. It is recommended
|
|
12347
12560
|
* to use the monitor dimensions instead.
|
|
12348
12561
|
* @returns the width of `screen` in millimeters.
|
|
12562
|
+
* @since 2.2
|
|
12563
|
+
* @deprecated since 3.22: Use per-monitor information instead
|
|
12349
12564
|
*/
|
|
12350
12565
|
get_width_mm(): number;
|
|
12351
12566
|
|
|
@@ -12366,6 +12581,7 @@ export namespace Gdk {
|
|
|
12366
12581
|
* windows it contains, so it should be freed using `g_list_free()` and
|
|
12367
12582
|
* its windows unrefed using `g_object_unref()` when no longer needed.
|
|
12368
12583
|
* @returns a list of `GdkWindows` for the current window stack, or `null`.
|
|
12584
|
+
* @since 2.10
|
|
12369
12585
|
*/
|
|
12370
12586
|
get_window_stack(): Window[] | null;
|
|
12371
12587
|
|
|
@@ -12377,6 +12593,7 @@ export namespace Gdk {
|
|
|
12377
12593
|
* On X11 this function returns whether a compositing manager is
|
|
12378
12594
|
* compositing `screen`.
|
|
12379
12595
|
* @returns Whether windows with RGBA visuals can reasonably be expected to have their alpha channels drawn correctly on the screen.
|
|
12596
|
+
* @since 2.10
|
|
12380
12597
|
*/
|
|
12381
12598
|
is_composited(): boolean;
|
|
12382
12599
|
|
|
@@ -12388,6 +12605,7 @@ export namespace Gdk {
|
|
|
12388
12605
|
*
|
|
12389
12606
|
* Call `g_list_free()` on the return value when you’re finished with it.
|
|
12390
12607
|
* @returns a list of visuals; the list must be freed, but not its contents
|
|
12608
|
+
* @since 2.2
|
|
12391
12609
|
*/
|
|
12392
12610
|
list_visuals(): Visual[];
|
|
12393
12611
|
|
|
@@ -12395,6 +12613,8 @@ export namespace Gdk {
|
|
|
12395
12613
|
* Determines the name to pass to `gdk_display_open()` to get
|
|
12396
12614
|
* a {@link Gdk.Display} with this screen as the default screen.
|
|
12397
12615
|
* @returns a newly allocated string, free with `g_free()`
|
|
12616
|
+
* @since 2.2
|
|
12617
|
+
* @deprecated since 3.22
|
|
12398
12618
|
*/
|
|
12399
12619
|
make_display_name(): string;
|
|
12400
12620
|
|
|
@@ -12405,6 +12625,7 @@ export namespace Gdk {
|
|
|
12405
12625
|
* default set of font options does not affect contexts that
|
|
12406
12626
|
* have already been created.
|
|
12407
12627
|
* @param options a {@link cairo.FontOptions}, or `null` to unset any previously set default font options.
|
|
12628
|
+
* @since 2.10
|
|
12408
12629
|
*/
|
|
12409
12630
|
set_font_options(options: cairo.FontOptions | null): void;
|
|
12410
12631
|
|
|
@@ -12414,6 +12635,7 @@ export namespace Gdk {
|
|
|
12414
12635
|
* and cairo units. The default value is 96, meaning that a 10 point
|
|
12415
12636
|
* font will be 13 units high. (10 * 96. / 72. = 13.3).
|
|
12416
12637
|
* @param dpi the resolution in “dots per inch”. (Physical inches aren’t actually involved; the terminology is conventional.)
|
|
12638
|
+
* @since 2.10
|
|
12417
12639
|
*/
|
|
12418
12640
|
set_resolution(dpi: number): void;
|
|
12419
12641
|
}
|
|
@@ -12514,6 +12736,7 @@ export namespace Gdk {
|
|
|
12514
12736
|
/**
|
|
12515
12737
|
* Returns the capabilities this {@link Gdk.Seat} currently has.
|
|
12516
12738
|
* @returns the seat capabilities
|
|
12739
|
+
* @since 3.20
|
|
12517
12740
|
*/
|
|
12518
12741
|
get_capabilities(): SeatCapabilities;
|
|
12519
12742
|
|
|
@@ -12526,12 +12749,14 @@ export namespace Gdk {
|
|
|
12526
12749
|
/**
|
|
12527
12750
|
* Returns the master device that routes keyboard events.
|
|
12528
12751
|
* @returns a master {@link Gdk.Device} with keyboard capabilities. This object is owned by GTK+ and must not be freed.
|
|
12752
|
+
* @since 3.20
|
|
12529
12753
|
*/
|
|
12530
12754
|
get_keyboard(): Device | null;
|
|
12531
12755
|
|
|
12532
12756
|
/**
|
|
12533
12757
|
* Returns the master device that routes pointer events.
|
|
12534
12758
|
* @returns a master {@link Gdk.Device} with pointer capabilities. This object is owned by GTK+ and must not be freed.
|
|
12759
|
+
* @since 3.20
|
|
12535
12760
|
*/
|
|
12536
12761
|
get_pointer(): Device | null;
|
|
12537
12762
|
|
|
@@ -12539,6 +12764,7 @@ export namespace Gdk {
|
|
|
12539
12764
|
* Returns the slave devices that match the given capabilities.
|
|
12540
12765
|
* @param capabilities capabilities to get devices for
|
|
12541
12766
|
* @returns A list of `GdkDevices`. The list must be freed with `g_list_free()`, the elements are owned by GDK and must not be freed.
|
|
12767
|
+
* @since 3.20
|
|
12542
12768
|
*/
|
|
12543
12769
|
get_slaves(capabilities: SeatCapabilities): Device[];
|
|
12544
12770
|
|
|
@@ -12574,11 +12800,13 @@ export namespace Gdk {
|
|
|
12574
12800
|
* @param event the event that is triggering the grab, or `null` if none is available.
|
|
12575
12801
|
* @param prepare_func function to prepare the window to be grabbed, it can be `null` if `window` is visible before this call.
|
|
12576
12802
|
* @returns {@link Gdk.GrabStatus.SUCCESS} if the grab was successful.
|
|
12803
|
+
* @since 3.20
|
|
12577
12804
|
*/
|
|
12578
12805
|
grab(window: Window, capabilities: SeatCapabilities, owner_events: boolean, cursor: Cursor | null, event: Event | null, prepare_func: SeatGrabPrepareFunc | null): GrabStatus;
|
|
12579
12806
|
|
|
12580
12807
|
/**
|
|
12581
12808
|
* Releases a grab added through `gdk_seat_grab()`.
|
|
12809
|
+
* @since 3.20
|
|
12582
12810
|
*/
|
|
12583
12811
|
ungrab(): void;
|
|
12584
12812
|
}
|
|
@@ -12631,6 +12859,7 @@ export namespace Gdk {
|
|
|
12631
12859
|
/**
|
|
12632
12860
|
* Get the visual with the most available colors for the default
|
|
12633
12861
|
* GDK screen. The return value should not be freed.
|
|
12862
|
+
* @deprecated since 3.22: Visual selection should be done using `gdk_screen_get_system_visual()` and `gdk_screen_get_rgba_visual()`
|
|
12634
12863
|
*/
|
|
12635
12864
|
static get_best(): Visual;
|
|
12636
12865
|
|
|
@@ -12638,11 +12867,13 @@ export namespace Gdk {
|
|
|
12638
12867
|
* Get the best available depth for the default GDK screen. “Best”
|
|
12639
12868
|
* means “largest,” i.e. 32 preferred over 24 preferred over 8 bits
|
|
12640
12869
|
* per pixel.
|
|
12870
|
+
* @deprecated since 3.22: Visual selection should be done using `gdk_screen_get_system_visual()` and `gdk_screen_get_rgba_visual()`
|
|
12641
12871
|
*/
|
|
12642
12872
|
static get_best_depth(): number;
|
|
12643
12873
|
|
|
12644
12874
|
/**
|
|
12645
12875
|
* Return the best available visual type for the default GDK screen.
|
|
12876
|
+
* @deprecated since 3.22: Visual selection should be done using `gdk_screen_get_system_visual()` and `gdk_screen_get_rgba_visual()`
|
|
12646
12877
|
*/
|
|
12647
12878
|
static get_best_type(): VisualType;
|
|
12648
12879
|
|
|
@@ -12651,6 +12882,7 @@ export namespace Gdk {
|
|
|
12651
12882
|
* `gdk_visual_get_best_with_type()`.
|
|
12652
12883
|
* @param depth a bit depth
|
|
12653
12884
|
* @param visual_type a visual type
|
|
12885
|
+
* @deprecated since 3.22: Visual selection should be done using `gdk_screen_get_system_visual()` and `gdk_screen_get_rgba_visual()`
|
|
12654
12886
|
*/
|
|
12655
12887
|
static get_best_with_both(depth: number, visual_type: VisualType): Visual | null;
|
|
12656
12888
|
|
|
@@ -12660,6 +12892,7 @@ export namespace Gdk {
|
|
|
12660
12892
|
* over grayscale or fixed-colormap visuals. The return value should
|
|
12661
12893
|
* not be freed. `null` may be returned if no visual supports `depth`.
|
|
12662
12894
|
* @param depth a bit depth
|
|
12895
|
+
* @deprecated since 3.22: Visual selection should be done using `gdk_screen_get_system_visual()` and `gdk_screen_get_rgba_visual()`
|
|
12663
12896
|
*/
|
|
12664
12897
|
static get_best_with_depth(depth: number): Visual;
|
|
12665
12898
|
|
|
@@ -12669,6 +12902,7 @@ export namespace Gdk {
|
|
|
12669
12902
|
* should not be freed. `null` may be returned if no visual has type
|
|
12670
12903
|
* `visual_type`.
|
|
12671
12904
|
* @param visual_type a visual type
|
|
12905
|
+
* @deprecated since 3.22: Visual selection should be done using `gdk_screen_get_system_visual()` and `gdk_screen_get_rgba_visual()`
|
|
12672
12906
|
*/
|
|
12673
12907
|
static get_best_with_type(visual_type: VisualType): Visual;
|
|
12674
12908
|
|
|
@@ -12676,6 +12910,7 @@ export namespace Gdk {
|
|
|
12676
12910
|
* Get the system’s default visual for the default GDK screen.
|
|
12677
12911
|
* This is the visual for the root window of the display.
|
|
12678
12912
|
* The return value should not be freed.
|
|
12913
|
+
* @deprecated since 3.22: Use gdk_screen_get_system_visual (gdk_screen_get_default ()).
|
|
12679
12914
|
*/
|
|
12680
12915
|
static get_system(): Visual;
|
|
12681
12916
|
|
|
@@ -12685,6 +12920,8 @@ export namespace Gdk {
|
|
|
12685
12920
|
*
|
|
12686
12921
|
* Not all GDK backend provide a meaningful value for this function.
|
|
12687
12922
|
* @returns The number of significant bits per color value for `visual`.
|
|
12923
|
+
* @since 2.22
|
|
12924
|
+
* @deprecated since 3.22.: Use `gdk_visual_get_red_pixel_details()` and its variants to learn about the pixel layout of TrueColor and DirectColor visuals
|
|
12688
12925
|
*/
|
|
12689
12926
|
get_bits_per_rgb(): number;
|
|
12690
12927
|
|
|
@@ -12694,6 +12931,7 @@ export namespace Gdk {
|
|
|
12694
12931
|
* The “shift” is the number of bits left we must shift a primary for it
|
|
12695
12932
|
* to be in position (according to the "mask"). Finally, "precision" refers
|
|
12696
12933
|
* to how much precision the pixel value contains for a particular primary.
|
|
12934
|
+
* @since 2.22
|
|
12697
12935
|
*/
|
|
12698
12936
|
get_blue_pixel_details(): [number, number, number];
|
|
12699
12937
|
|
|
@@ -12704,6 +12942,8 @@ export namespace Gdk {
|
|
|
12704
12942
|
* when working with XImages, and not all backends return
|
|
12705
12943
|
* meaningful information for this.
|
|
12706
12944
|
* @returns A {@link Gdk.ByteOrder} stating the byte order of `visual`.
|
|
12945
|
+
* @since 2.22
|
|
12946
|
+
* @deprecated since 3.22: This information is not useful
|
|
12707
12947
|
*/
|
|
12708
12948
|
get_byte_order(): ByteOrder;
|
|
12709
12949
|
|
|
@@ -12712,12 +12952,15 @@ export namespace Gdk {
|
|
|
12712
12952
|
*
|
|
12713
12953
|
* You have to use platform-specific APIs to manipulate colormaps.
|
|
12714
12954
|
* @returns The size of a colormap that is suitable for `visual`.
|
|
12955
|
+
* @since 2.22
|
|
12956
|
+
* @deprecated since 3.22: This information is not useful, since GDK does not provide APIs to operate on colormaps.
|
|
12715
12957
|
*/
|
|
12716
12958
|
get_colormap_size(): number;
|
|
12717
12959
|
|
|
12718
12960
|
/**
|
|
12719
12961
|
* Returns the bit depth of this visual.
|
|
12720
12962
|
* @returns The bit depth of this visual.
|
|
12963
|
+
* @since 2.22
|
|
12721
12964
|
*/
|
|
12722
12965
|
get_depth(): number;
|
|
12723
12966
|
|
|
@@ -12727,6 +12970,7 @@ export namespace Gdk {
|
|
|
12727
12970
|
* The “shift” is the number of bits left we must shift a primary for it
|
|
12728
12971
|
* to be in position (according to the "mask"). Finally, "precision" refers
|
|
12729
12972
|
* to how much precision the pixel value contains for a particular primary.
|
|
12973
|
+
* @since 2.22
|
|
12730
12974
|
*/
|
|
12731
12975
|
get_green_pixel_details(): [number, number, number];
|
|
12732
12976
|
|
|
@@ -12736,18 +12980,21 @@ export namespace Gdk {
|
|
|
12736
12980
|
* The “shift” is the number of bits left we must shift a primary for it
|
|
12737
12981
|
* to be in position (according to the "mask"). Finally, "precision" refers
|
|
12738
12982
|
* to how much precision the pixel value contains for a particular primary.
|
|
12983
|
+
* @since 2.22
|
|
12739
12984
|
*/
|
|
12740
12985
|
get_red_pixel_details(): [number, number, number];
|
|
12741
12986
|
|
|
12742
12987
|
/**
|
|
12743
12988
|
* Gets the screen to which this visual belongs
|
|
12744
12989
|
* @returns the screen to which this visual belongs.
|
|
12990
|
+
* @since 2.2
|
|
12745
12991
|
*/
|
|
12746
12992
|
get_screen(): Screen;
|
|
12747
12993
|
|
|
12748
12994
|
/**
|
|
12749
12995
|
* Returns the type of visual this is (PseudoColor, TrueColor, etc).
|
|
12750
12996
|
* @returns A {@link Gdk.VisualType} stating the type of `visual`.
|
|
12997
|
+
* @since 2.22
|
|
12751
12998
|
*/
|
|
12752
12999
|
get_visual_type(): VisualType;
|
|
12753
13000
|
}
|
|
@@ -12880,6 +13127,7 @@ export namespace Gdk {
|
|
|
12880
13127
|
*
|
|
12881
13128
|
* NOTE: For multihead-aware widgets or applications use
|
|
12882
13129
|
* `gdk_display_get_window_at_pointer()` instead.
|
|
13130
|
+
* @deprecated since 3.0: Use `gdk_device_get_window_at_position()` instead.
|
|
12883
13131
|
*/
|
|
12884
13132
|
static at_pointer(): [Window, number, number];
|
|
12885
13133
|
|
|
@@ -12896,6 +13144,7 @@ export namespace Gdk {
|
|
|
12896
13144
|
/**
|
|
12897
13145
|
* Calls `gdk_window_process_updates()` for all windows (see {@link Gdk.Window})
|
|
12898
13146
|
* in the application.
|
|
13147
|
+
* @deprecated since 3.22
|
|
12899
13148
|
*/
|
|
12900
13149
|
static process_all_updates(): void;
|
|
12901
13150
|
|
|
@@ -12920,6 +13169,7 @@ export namespace Gdk {
|
|
|
12920
13169
|
* yourself, though you might want to use this function to enable
|
|
12921
13170
|
* updates sometime after application startup time.
|
|
12922
13171
|
* @param setting `true` to turn on update debugging
|
|
13172
|
+
* @deprecated since 3.22
|
|
12923
13173
|
*/
|
|
12924
13174
|
static set_debug_updates(setting: boolean): void;
|
|
12925
13175
|
|
|
@@ -12954,6 +13204,7 @@ export namespace Gdk {
|
|
|
12954
13204
|
* Emits a short beep associated to `window` in the appropriate
|
|
12955
13205
|
* display, if supported. Otherwise, emits a short beep on
|
|
12956
13206
|
* the display just as `gdk_display_beep()`.
|
|
13207
|
+
* @since 2.12
|
|
12957
13208
|
*/
|
|
12958
13209
|
beep(): void;
|
|
12959
13210
|
|
|
@@ -12987,6 +13238,7 @@ export namespace Gdk {
|
|
|
12987
13238
|
* explicitly.
|
|
12988
13239
|
* @param region a Cairo region
|
|
12989
13240
|
* @returns a {@link Gdk.DrawingContext} context that should be used to draw the contents of the window; the returned context is owned by GDK.
|
|
13241
|
+
* @since 3.22
|
|
12990
13242
|
*/
|
|
12991
13243
|
begin_draw_frame(region: cairo.Region): DrawingContext;
|
|
12992
13244
|
|
|
@@ -13014,6 +13266,7 @@ export namespace Gdk {
|
|
|
13014
13266
|
* @param root_x root window X coordinate of mouse click that began the drag
|
|
13015
13267
|
* @param root_y root window Y coordinate of mouse click that began the drag
|
|
13016
13268
|
* @param timestamp timestamp of mouse click that began the drag
|
|
13269
|
+
* @since 3.4
|
|
13017
13270
|
*/
|
|
13018
13271
|
begin_move_drag_for_device(device: Device, button: number, root_x: number, root_y: number, timestamp: number): void;
|
|
13019
13272
|
|
|
@@ -13022,6 +13275,7 @@ export namespace Gdk {
|
|
|
13022
13275
|
* creates a rectangular region for you. See
|
|
13023
13276
|
* `gdk_window_begin_paint_region()` for details.
|
|
13024
13277
|
* @param rectangle rectangle you intend to draw to
|
|
13278
|
+
* @deprecated since 3.22: Use `gdk_window_begin_draw_frame()` instead
|
|
13025
13279
|
*/
|
|
13026
13280
|
begin_paint_rect(rectangle: Rectangle): void;
|
|
13027
13281
|
|
|
@@ -13065,6 +13319,7 @@ export namespace Gdk {
|
|
|
13065
13319
|
* `gdk_window_end_paint()` is required for each call to
|
|
13066
13320
|
* `gdk_window_begin_paint_region()`.
|
|
13067
13321
|
* @param region region you intend to draw to
|
|
13322
|
+
* @deprecated since 3.22: Use `gdk_window_begin_draw_frame()` instead
|
|
13068
13323
|
*/
|
|
13069
13324
|
begin_paint_region(region: cairo.Region): void;
|
|
13070
13325
|
|
|
@@ -13095,11 +13350,14 @@ export namespace Gdk {
|
|
|
13095
13350
|
* @param root_x root window X coordinate of mouse click that began the drag
|
|
13096
13351
|
* @param root_y root window Y coordinate of mouse click that began the drag
|
|
13097
13352
|
* @param timestamp timestamp of mouse click that began the drag (use `gdk_event_get_time()`)
|
|
13353
|
+
* @since 3.4
|
|
13098
13354
|
*/
|
|
13099
13355
|
begin_resize_drag_for_device(edge: WindowEdge, device: Device, button: number, root_x: number, root_y: number, timestamp: number): void;
|
|
13100
13356
|
|
|
13101
13357
|
/**
|
|
13102
13358
|
* Does nothing, present only for compatiblity.
|
|
13359
|
+
* @since 2.6
|
|
13360
|
+
* @deprecated since 3.8: this function is no longer needed
|
|
13103
13361
|
*/
|
|
13104
13362
|
configure_finished(): void;
|
|
13105
13363
|
|
|
@@ -13122,6 +13380,7 @@ export namespace Gdk {
|
|
|
13122
13380
|
* See also: `gdk_window_coords_to_parent()`
|
|
13123
13381
|
* @param parent_x X coordinate in parent’s coordinate system
|
|
13124
13382
|
* @param parent_y Y coordinate in parent’s coordinate system
|
|
13383
|
+
* @since 2.22
|
|
13125
13384
|
*/
|
|
13126
13385
|
coords_from_parent(parent_x: number, parent_y: number): [number, number];
|
|
13127
13386
|
|
|
@@ -13144,6 +13403,7 @@ export namespace Gdk {
|
|
|
13144
13403
|
* See also: `gdk_window_coords_from_parent()`
|
|
13145
13404
|
* @param x X coordinate in child’s coordinate system
|
|
13146
13405
|
* @param y Y coordinate in child’s coordinate system
|
|
13406
|
+
* @since 2.22
|
|
13147
13407
|
*/
|
|
13148
13408
|
coords_to_parent(x: number, y: number): [number, number];
|
|
13149
13409
|
|
|
@@ -13157,6 +13417,7 @@ export namespace Gdk {
|
|
|
13157
13417
|
* Before using the returned {@link Gdk.GLContext}, you will need to
|
|
13158
13418
|
* call `gdk_gl_context_make_current()` or `gdk_gl_context_realize()`.
|
|
13159
13419
|
* @returns the newly created {@link Gdk.GLContext}, or `null` on error
|
|
13420
|
+
* @since 3.16
|
|
13160
13421
|
*/
|
|
13161
13422
|
create_gl_context(): GLContext;
|
|
13162
13423
|
|
|
@@ -13196,6 +13457,7 @@ export namespace Gdk {
|
|
|
13196
13457
|
* @param height height of the new surface
|
|
13197
13458
|
* @param scale the scale of the new surface, or 0 to use same as `window`
|
|
13198
13459
|
* @returns a pointer to the newly allocated surface. The caller owns the surface and should call `cairo_surface_destroy()` when done with it. This function always returns a valid pointer, but it will return a pointer to a “nil” surface if `other` is already in an error state or any other error occurs.
|
|
13460
|
+
* @since 3.10
|
|
13199
13461
|
*/
|
|
13200
13462
|
create_similar_image_surface(format: cairo.Format, width: number, height: number, scale: number): cairo.Surface;
|
|
13201
13463
|
|
|
@@ -13213,6 +13475,7 @@ export namespace Gdk {
|
|
|
13213
13475
|
* @param width width of the new surface
|
|
13214
13476
|
* @param height height of the new surface
|
|
13215
13477
|
* @returns a pointer to the newly allocated surface. The caller owns the surface and should call `cairo_surface_destroy()` when done with it. This function always returns a valid pointer, but it will return a pointer to a “nil” surface if `other` is already in an error state or any other error occurs.
|
|
13478
|
+
* @since 2.22
|
|
13216
13479
|
*/
|
|
13217
13480
|
create_similar_surface(content: cairo.Content, width: number, height: number): cairo.Surface;
|
|
13218
13481
|
|
|
@@ -13239,6 +13502,8 @@ export namespace Gdk {
|
|
|
13239
13502
|
|
|
13240
13503
|
/**
|
|
13241
13504
|
* Does nothing, present only for compatiblity.
|
|
13505
|
+
* @since 2.6
|
|
13506
|
+
* @deprecated since 3.8: this function is no longer needed
|
|
13242
13507
|
*/
|
|
13243
13508
|
enable_synchronized_configure(): void;
|
|
13244
13509
|
|
|
@@ -13251,6 +13516,7 @@ export namespace Gdk {
|
|
|
13251
13516
|
* It is an error to call this function without a matching
|
|
13252
13517
|
* `gdk_window_begin_frame()` first.
|
|
13253
13518
|
* @param context the {@link Gdk.DrawingContext} created by `gdk_window_begin_draw_frame()`
|
|
13519
|
+
* @since 3.22
|
|
13254
13520
|
*/
|
|
13255
13521
|
end_draw_frame(context: DrawingContext): void;
|
|
13256
13522
|
|
|
@@ -13274,11 +13540,14 @@ export namespace Gdk {
|
|
|
13274
13540
|
*
|
|
13275
13541
|
* Some backends may not support native child windows.
|
|
13276
13542
|
* @returns `true` if the window has a native window, `false` otherwise
|
|
13543
|
+
* @since 2.18
|
|
13277
13544
|
*/
|
|
13278
13545
|
ensure_native(): boolean;
|
|
13279
13546
|
|
|
13280
13547
|
/**
|
|
13281
13548
|
* This function does nothing.
|
|
13549
|
+
* @since 2.18
|
|
13550
|
+
* @deprecated since 3.14
|
|
13282
13551
|
*/
|
|
13283
13552
|
flush(): void;
|
|
13284
13553
|
|
|
@@ -13300,6 +13569,7 @@ export namespace Gdk {
|
|
|
13300
13569
|
*
|
|
13301
13570
|
* This function is not part of the GDK public API and is only
|
|
13302
13571
|
* for use by GTK+.
|
|
13572
|
+
* @deprecated since 3.16: This symbol was never meant to be used outside of GTK+
|
|
13303
13573
|
*/
|
|
13304
13574
|
freeze_toplevel_updates_libgtk_only(): void;
|
|
13305
13575
|
|
|
@@ -13326,6 +13596,7 @@ export namespace Gdk {
|
|
|
13326
13596
|
* fullscreenification actually happening. But it will happen with
|
|
13327
13597
|
* most standard window managers, and GDK makes a best effort to get
|
|
13328
13598
|
* it to happen.
|
|
13599
|
+
* @since 2.2
|
|
13329
13600
|
*/
|
|
13330
13601
|
fullscreen(): void;
|
|
13331
13602
|
|
|
@@ -13342,6 +13613,7 @@ export namespace Gdk {
|
|
|
13342
13613
|
* This function informs GDK that the geometry of an embedded
|
|
13343
13614
|
* offscreen window has changed. This is necessary for GDK to keep
|
|
13344
13615
|
* track of which offscreen window the pointer is in.
|
|
13616
|
+
* @since 2.18
|
|
13345
13617
|
*/
|
|
13346
13618
|
geometry_changed(): void;
|
|
13347
13619
|
|
|
@@ -13349,12 +13621,15 @@ export namespace Gdk {
|
|
|
13349
13621
|
* Determines whether or not the desktop environment shuld be hinted that
|
|
13350
13622
|
* the window does not want to receive input focus.
|
|
13351
13623
|
* @returns whether or not the window should receive input focus.
|
|
13624
|
+
* @since 2.22
|
|
13352
13625
|
*/
|
|
13353
13626
|
get_accept_focus(): boolean;
|
|
13354
13627
|
|
|
13355
13628
|
/**
|
|
13356
13629
|
* Gets the pattern used to clear the background on `window`.
|
|
13357
13630
|
* @returns The pattern to use for the background or `null` if there is no background.
|
|
13631
|
+
* @since 2.22
|
|
13632
|
+
* @deprecated since 3.22: Don't use this function
|
|
13358
13633
|
*/
|
|
13359
13634
|
get_background_pattern(): cairo.Pattern | null;
|
|
13360
13635
|
|
|
@@ -13381,6 +13656,7 @@ export namespace Gdk {
|
|
|
13381
13656
|
* lowest window is first.
|
|
13382
13657
|
* @param user_data user data to look for
|
|
13383
13658
|
* @returns list of child windows inside `window`
|
|
13659
|
+
* @since 3.10
|
|
13384
13660
|
*/
|
|
13385
13661
|
get_children_with_user_data(user_data: null): Window[];
|
|
13386
13662
|
|
|
@@ -13399,6 +13675,8 @@ export namespace Gdk {
|
|
|
13399
13675
|
*
|
|
13400
13676
|
* See `gdk_window_set_composited()`.
|
|
13401
13677
|
* @returns `true` if the window is composited.
|
|
13678
|
+
* @since 2.22
|
|
13679
|
+
* @deprecated since 3.16: Compositing is an outdated technology that only ever worked on X11.
|
|
13402
13680
|
*/
|
|
13403
13681
|
get_composited(): boolean;
|
|
13404
13682
|
|
|
@@ -13408,6 +13686,7 @@ export namespace Gdk {
|
|
|
13408
13686
|
* there is no custom cursor set on the specified window, and it is
|
|
13409
13687
|
* using the cursor for its parent window.
|
|
13410
13688
|
* @returns a {@link Gdk.Cursor}, or `null`. The returned object is owned by the {@link Gdk.Window} and should not be unreferenced directly. Use `gdk_window_set_cursor()` to unset the cursor of the window
|
|
13689
|
+
* @since 2.18
|
|
13411
13690
|
*/
|
|
13412
13691
|
get_cursor(): Cursor | null;
|
|
13413
13692
|
|
|
@@ -13425,6 +13704,7 @@ export namespace Gdk {
|
|
|
13425
13704
|
* using the cursor for its parent window.
|
|
13426
13705
|
* @param device a master, pointer {@link Gdk.Device}.
|
|
13427
13706
|
* @returns a {@link Gdk.Cursor}, or `null`. The returned object is owned by the {@link Gdk.Window} and should not be unreferenced directly. Use `gdk_window_set_cursor()` to unset the cursor of the window
|
|
13707
|
+
* @since 3.0
|
|
13428
13708
|
*/
|
|
13429
13709
|
get_device_cursor(device: Device): Cursor | null;
|
|
13430
13710
|
|
|
@@ -13432,6 +13712,7 @@ export namespace Gdk {
|
|
|
13432
13712
|
* Returns the event mask for `window` corresponding to an specific device.
|
|
13433
13713
|
* @param device a {@link Gdk.Device}.
|
|
13434
13714
|
* @returns device event mask for `window`
|
|
13715
|
+
* @since 3.0
|
|
13435
13716
|
*/
|
|
13436
13717
|
get_device_events(device: Device): EventMask;
|
|
13437
13718
|
|
|
@@ -13443,6 +13724,7 @@ export namespace Gdk {
|
|
|
13443
13724
|
* Use `gdk_window_get_device_position_double()` if you need subpixel precision.
|
|
13444
13725
|
* @param device pointer {@link Gdk.Device} to query to.
|
|
13445
13726
|
* @returns The window underneath `device` (as with `gdk_device_get_window_at_position()`), or `null` if the window is not known to GDK.
|
|
13727
|
+
* @since 3.0
|
|
13446
13728
|
*/
|
|
13447
13729
|
get_device_position(device: Device): [Window | null, number, number, ModifierType | null];
|
|
13448
13730
|
|
|
@@ -13452,18 +13734,21 @@ export namespace Gdk {
|
|
|
13452
13734
|
* corner of `window`.
|
|
13453
13735
|
* @param device pointer {@link Gdk.Device} to query to.
|
|
13454
13736
|
* @returns The window underneath `device` (as with `gdk_device_get_window_at_position()`), or `null` if the window is not known to GDK.
|
|
13737
|
+
* @since 3.10
|
|
13455
13738
|
*/
|
|
13456
13739
|
get_device_position_double(device: Device): [Window | null, number, number, ModifierType | null];
|
|
13457
13740
|
|
|
13458
13741
|
/**
|
|
13459
13742
|
* Gets the {@link Gdk.Display} associated with a {@link Gdk.Window}.
|
|
13460
13743
|
* @returns the {@link Gdk.Display} associated with `window`
|
|
13744
|
+
* @since 2.24
|
|
13461
13745
|
*/
|
|
13462
13746
|
get_display(): Display;
|
|
13463
13747
|
|
|
13464
13748
|
/**
|
|
13465
13749
|
* Finds out the DND protocol supported by a window.
|
|
13466
13750
|
* @returns the supported DND protocol.
|
|
13751
|
+
* @since 3.0
|
|
13467
13752
|
*/
|
|
13468
13753
|
get_drag_protocol(): [DragProtocol, Window | null];
|
|
13469
13754
|
|
|
@@ -13474,6 +13759,7 @@ export namespace Gdk {
|
|
|
13474
13759
|
*
|
|
13475
13760
|
* See also: `gdk_offscreen_window_get_embedder()`
|
|
13476
13761
|
* @returns effective parent of `window`
|
|
13762
|
+
* @since 2.22
|
|
13477
13763
|
*/
|
|
13478
13764
|
get_effective_parent(): Window;
|
|
13479
13765
|
|
|
@@ -13485,12 +13771,14 @@ export namespace Gdk {
|
|
|
13485
13771
|
*
|
|
13486
13772
|
* See also: `gdk_offscreen_window_get_embedder()`
|
|
13487
13773
|
* @returns the effective toplevel window containing `window`
|
|
13774
|
+
* @since 2.22
|
|
13488
13775
|
*/
|
|
13489
13776
|
get_effective_toplevel(): Window;
|
|
13490
13777
|
|
|
13491
13778
|
/**
|
|
13492
13779
|
* Get the current event compression setting for this window.
|
|
13493
13780
|
* @returns `true` if motion events will be compressed
|
|
13781
|
+
* @since 3.12
|
|
13494
13782
|
*/
|
|
13495
13783
|
get_event_compression(): boolean;
|
|
13496
13784
|
|
|
@@ -13505,6 +13793,7 @@ export namespace Gdk {
|
|
|
13505
13793
|
* Determines whether or not the desktop environment should be hinted that the
|
|
13506
13794
|
* window does not want to receive input focus when it is mapped.
|
|
13507
13795
|
* @returns whether or not the window wants to receive input focus when it is mapped.
|
|
13796
|
+
* @since 2.22
|
|
13508
13797
|
*/
|
|
13509
13798
|
get_focus_on_map(): boolean;
|
|
13510
13799
|
|
|
@@ -13513,6 +13802,7 @@ export namespace Gdk {
|
|
|
13513
13802
|
* never changes unless the window is reparented to a new toplevel
|
|
13514
13803
|
* window.
|
|
13515
13804
|
* @returns the frame clock
|
|
13805
|
+
* @since 3.8
|
|
13516
13806
|
*/
|
|
13517
13807
|
get_frame_clock(): FrameClock;
|
|
13518
13808
|
|
|
@@ -13527,6 +13817,7 @@ export namespace Gdk {
|
|
|
13527
13817
|
/**
|
|
13528
13818
|
* Obtains the {@link Gdk.FullscreenMode} of the `window`.
|
|
13529
13819
|
* @returns The {@link Gdk.FullscreenMode} applied to the window when fullscreen.
|
|
13820
|
+
* @since 3.8
|
|
13530
13821
|
*/
|
|
13531
13822
|
get_fullscreen_mode(): FullscreenMode;
|
|
13532
13823
|
|
|
@@ -13557,6 +13848,7 @@ export namespace Gdk {
|
|
|
13557
13848
|
/**
|
|
13558
13849
|
* Returns the group leader window for `window`. See `gdk_window_set_group()`.
|
|
13559
13850
|
* @returns the group leader window for `window`
|
|
13851
|
+
* @since 2.4
|
|
13560
13852
|
*/
|
|
13561
13853
|
get_group(): Window;
|
|
13562
13854
|
|
|
@@ -13567,6 +13859,7 @@ export namespace Gdk {
|
|
|
13567
13859
|
* most-recently-processed configure event, rather than the current
|
|
13568
13860
|
* size on the X server.
|
|
13569
13861
|
* @returns The height of `window`
|
|
13862
|
+
* @since 2.24
|
|
13570
13863
|
*/
|
|
13571
13864
|
get_height(): number;
|
|
13572
13865
|
|
|
@@ -13574,6 +13867,7 @@ export namespace Gdk {
|
|
|
13574
13867
|
* Determines whether or not the window manager is hinted that `window`
|
|
13575
13868
|
* has modal behaviour.
|
|
13576
13869
|
* @returns whether or not the window has the modal hint set.
|
|
13870
|
+
* @since 2.22
|
|
13577
13871
|
*/
|
|
13578
13872
|
get_modal_hint(): boolean;
|
|
13579
13873
|
|
|
@@ -13607,6 +13901,7 @@ export namespace Gdk {
|
|
|
13607
13901
|
* below.
|
|
13608
13902
|
*
|
|
13609
13903
|
* See `gdk_window_set_pass_through()` for details
|
|
13904
|
+
* @since 3.18
|
|
13610
13905
|
*/
|
|
13611
13906
|
get_pass_through(): boolean;
|
|
13612
13907
|
|
|
@@ -13615,6 +13910,7 @@ export namespace Gdk {
|
|
|
13615
13910
|
* The position is given in coordinates relative to the upper left
|
|
13616
13911
|
* corner of `window`.
|
|
13617
13912
|
* @returns the window containing the pointer (as with `gdk_window_at_pointer()`), or `null` if the window containing the pointer isn’t known to GDK
|
|
13913
|
+
* @deprecated since 3.0: Use `gdk_window_get_device_position()` instead.
|
|
13618
13914
|
*/
|
|
13619
13915
|
get_pointer(): [Window | null, number, number, ModifierType | null];
|
|
13620
13916
|
|
|
@@ -13636,6 +13932,7 @@ export namespace Gdk {
|
|
|
13636
13932
|
* in any position in the window, not just the origin.
|
|
13637
13933
|
* @param x X coordinate in window
|
|
13638
13934
|
* @param y Y coordinate in window
|
|
13935
|
+
* @since 2.18
|
|
13639
13936
|
*/
|
|
13640
13937
|
get_root_coords(x: number, y: number): [number, number];
|
|
13641
13938
|
|
|
@@ -13659,12 +13956,14 @@ export namespace Gdk {
|
|
|
13659
13956
|
* The scale of a window may change during runtime, if this happens
|
|
13660
13957
|
* a configure event will be sent to the toplevel window.
|
|
13661
13958
|
* @returns the scale factor
|
|
13959
|
+
* @since 3.10
|
|
13662
13960
|
*/
|
|
13663
13961
|
get_scale_factor(): number;
|
|
13664
13962
|
|
|
13665
13963
|
/**
|
|
13666
13964
|
* Gets the {@link Gdk.Screen} associated with a {@link Gdk.Window}.
|
|
13667
13965
|
* @returns the {@link Gdk.Screen} associated with `window`
|
|
13966
|
+
* @since 2.24
|
|
13668
13967
|
*/
|
|
13669
13968
|
get_screen(): Screen;
|
|
13670
13969
|
|
|
@@ -13687,6 +13986,7 @@ export namespace Gdk {
|
|
|
13687
13986
|
* Returns `true` if the window is aware of the existence of multiple
|
|
13688
13987
|
* devices.
|
|
13689
13988
|
* @returns `true` if the window handles multidevice features.
|
|
13989
|
+
* @since 3.0
|
|
13690
13990
|
*/
|
|
13691
13991
|
get_support_multidevice(): boolean;
|
|
13692
13992
|
|
|
@@ -13708,6 +14008,7 @@ export namespace Gdk {
|
|
|
13708
14008
|
/**
|
|
13709
14009
|
* This function returns the type hint set for a window.
|
|
13710
14010
|
* @returns The type hint set for `window`
|
|
14011
|
+
* @since 2.10
|
|
13711
14012
|
*/
|
|
13712
14013
|
get_type_hint(): WindowTypeHint;
|
|
13713
14014
|
|
|
@@ -13740,6 +14041,7 @@ export namespace Gdk {
|
|
|
13740
14041
|
/**
|
|
13741
14042
|
* Gets the {@link Gdk.Visual} describing the pixel format of `window`.
|
|
13742
14043
|
* @returns a {@link Gdk.Visual}
|
|
14044
|
+
* @since 2.24
|
|
13743
14045
|
*/
|
|
13744
14046
|
get_visual(): Visual;
|
|
13745
14047
|
|
|
@@ -13750,6 +14052,7 @@ export namespace Gdk {
|
|
|
13750
14052
|
* most-recently-processed configure event, rather than the current
|
|
13751
14053
|
* size on the X server.
|
|
13752
14054
|
* @returns The width of `window`
|
|
14055
|
+
* @since 2.24
|
|
13753
14056
|
*/
|
|
13754
14057
|
get_width(): number;
|
|
13755
14058
|
|
|
@@ -13763,6 +14066,7 @@ export namespace Gdk {
|
|
|
13763
14066
|
* Checks whether the window has a native window or not. Note that
|
|
13764
14067
|
* you can use `gdk_window_ensure_native()` if a native window is needed.
|
|
13765
14068
|
* @returns `true` if the `window` has a native window, `false` otherwise.
|
|
14069
|
+
* @since 2.22
|
|
13766
14070
|
*/
|
|
13767
14071
|
has_native(): boolean;
|
|
13768
14072
|
|
|
@@ -13803,6 +14107,7 @@ export namespace Gdk {
|
|
|
13803
14107
|
* @param shape_region region of window to be non-transparent
|
|
13804
14108
|
* @param offset_x X position of `shape_region` in `window` coordinates
|
|
13805
14109
|
* @param offset_y Y position of `shape_region` in `window` coordinates
|
|
14110
|
+
* @since 2.10
|
|
13806
14111
|
*/
|
|
13807
14112
|
input_shape_combine_region(shape_region: cairo.Region, offset_x: number, offset_y: number): void;
|
|
13808
14113
|
|
|
@@ -13863,18 +14168,21 @@ export namespace Gdk {
|
|
|
13863
14168
|
/**
|
|
13864
14169
|
* Check to see if a window is destroyed..
|
|
13865
14170
|
* @returns `true` if the window is destroyed
|
|
14171
|
+
* @since 2.18
|
|
13866
14172
|
*/
|
|
13867
14173
|
is_destroyed(): boolean;
|
|
13868
14174
|
|
|
13869
14175
|
/**
|
|
13870
14176
|
* Determines whether or not the window is an input only window.
|
|
13871
14177
|
* @returns `true` if `window` is input only
|
|
14178
|
+
* @since 2.22
|
|
13872
14179
|
*/
|
|
13873
14180
|
is_input_only(): boolean;
|
|
13874
14181
|
|
|
13875
14182
|
/**
|
|
13876
14183
|
* Determines whether or not the window is shaped.
|
|
13877
14184
|
* @returns `true` if `window` is shaped
|
|
14185
|
+
* @since 2.22
|
|
13878
14186
|
*/
|
|
13879
14187
|
is_shaped(): boolean;
|
|
13880
14188
|
|
|
@@ -13918,6 +14226,7 @@ export namespace Gdk {
|
|
|
13918
14226
|
* This is typically called automatically by GTK+ and you don't need
|
|
13919
14227
|
* to care about this.
|
|
13920
14228
|
* @param cr a {@link cairo.Context}
|
|
14229
|
+
* @since 3.16
|
|
13921
14230
|
*/
|
|
13922
14231
|
mark_paint_from_clip(cr: cairo.Context): void;
|
|
13923
14232
|
|
|
@@ -13945,6 +14254,7 @@ export namespace Gdk {
|
|
|
13945
14254
|
* This function is distinct from `gdk_window_set_child_input_shapes()`
|
|
13946
14255
|
* because it includes `window`’s input shape mask in the set of
|
|
13947
14256
|
* shapes to be merged.
|
|
14257
|
+
* @since 2.10
|
|
13948
14258
|
*/
|
|
13949
14259
|
merge_child_input_shapes(): void;
|
|
13950
14260
|
|
|
@@ -13983,6 +14293,7 @@ export namespace Gdk {
|
|
|
13983
14293
|
* @param region The {@link cairo.Region} to move
|
|
13984
14294
|
* @param dx Amount to move in the X direction
|
|
13985
14295
|
* @param dy Amount to move in the Y direction
|
|
14296
|
+
* @since 2.8
|
|
13986
14297
|
*/
|
|
13987
14298
|
move_region(region: cairo.Region, dx: number, dy: number): void;
|
|
13988
14299
|
|
|
@@ -14020,6 +14331,7 @@ export namespace Gdk {
|
|
|
14020
14331
|
* @param anchor_hints positioning hints to use when limited on space
|
|
14021
14332
|
* @param rect_anchor_dx horizontal offset to shift `window`, i.e. `rect`'s anchor point
|
|
14022
14333
|
* @param rect_anchor_dy vertical offset to shift `window`, i.e. `rect`'s anchor point
|
|
14334
|
+
* @since 3.24
|
|
14023
14335
|
*/
|
|
14024
14336
|
move_to_rect(rect: Rectangle, rect_anchor: Gravity, window_anchor: Gravity, anchor_hints: AnchorHints, rect_anchor_dx: number, rect_anchor_dy: number): void;
|
|
14025
14337
|
|
|
@@ -14040,6 +14352,7 @@ export namespace Gdk {
|
|
|
14040
14352
|
* case, where GDK delivers them in an idle handler). Occasionally
|
|
14041
14353
|
* this is useful to produce nicer scrolling behavior, for example.
|
|
14042
14354
|
* @param update_children whether to also process updates for child windows
|
|
14355
|
+
* @deprecated since 3.22
|
|
14043
14356
|
*/
|
|
14044
14357
|
process_updates(update_children: boolean): void;
|
|
14045
14358
|
|
|
@@ -14095,6 +14408,7 @@ export namespace Gdk {
|
|
|
14095
14408
|
* requests the restack, does not guarantee it.
|
|
14096
14409
|
* @param sibling a {@link Gdk.Window} that is a sibling of `window`, or `null`
|
|
14097
14410
|
* @param above a boolean
|
|
14411
|
+
* @since 2.18
|
|
14098
14412
|
*/
|
|
14099
14413
|
restack(sibling: Window | null, above: boolean): void;
|
|
14100
14414
|
|
|
@@ -14122,6 +14436,7 @@ export namespace Gdk {
|
|
|
14122
14436
|
* On X, it is the responsibility of the window manager to interpret this
|
|
14123
14437
|
* hint. ICCCM-compliant window manager usually respect it.
|
|
14124
14438
|
* @param accept_focus `true` if the window should receive input focus
|
|
14439
|
+
* @since 2.4
|
|
14125
14440
|
*/
|
|
14126
14441
|
set_accept_focus(accept_focus: boolean): void;
|
|
14127
14442
|
|
|
@@ -14133,6 +14448,7 @@ export namespace Gdk {
|
|
|
14133
14448
|
* `gtk_style_context_set_background()` — if you're implementing a
|
|
14134
14449
|
* custom widget.
|
|
14135
14450
|
* @param color a {@link Gdk.Color}
|
|
14451
|
+
* @deprecated since 3.4: Don't use this function
|
|
14136
14452
|
*/
|
|
14137
14453
|
set_background(color: Color): void;
|
|
14138
14454
|
|
|
@@ -14146,6 +14462,7 @@ export namespace Gdk {
|
|
|
14146
14462
|
* The windowing system will normally fill a window with its background
|
|
14147
14463
|
* when the window is obscured then exposed.
|
|
14148
14464
|
* @param pattern a pattern to use, or `null`
|
|
14465
|
+
* @deprecated since 3.22: Don't use this function
|
|
14149
14466
|
*/
|
|
14150
14467
|
set_background_pattern(pattern: cairo.Pattern | null): void;
|
|
14151
14468
|
|
|
@@ -14154,6 +14471,7 @@ export namespace Gdk {
|
|
|
14154
14471
|
*
|
|
14155
14472
|
* See also `gdk_window_set_background_pattern()`.
|
|
14156
14473
|
* @param rgba a {@link Gdk.RGBA} color
|
|
14474
|
+
* @deprecated since 3.22: Don't use this function
|
|
14157
14475
|
*/
|
|
14158
14476
|
set_background_rgba(rgba: RGBA): void;
|
|
14159
14477
|
|
|
@@ -14162,6 +14480,7 @@ export namespace Gdk {
|
|
|
14162
14480
|
* for all children of `window`, ignoring the input shape mask of `window`
|
|
14163
14481
|
* itself. Contrast with `gdk_window_merge_child_input_shapes()` which includes
|
|
14164
14482
|
* the input shape mask of `window` in the masks to be merged.
|
|
14483
|
+
* @since 2.10
|
|
14165
14484
|
*/
|
|
14166
14485
|
set_child_input_shapes(): void;
|
|
14167
14486
|
|
|
@@ -14197,6 +14516,8 @@ export namespace Gdk {
|
|
|
14197
14516
|
* setting a window as composited is supported before
|
|
14198
14517
|
* attempting to do so.
|
|
14199
14518
|
* @param composited `true` to set the window as composited
|
|
14519
|
+
* @since 2.12
|
|
14520
|
+
* @deprecated since 3.16: Compositing is an outdated technology that only ever worked on X11.
|
|
14200
14521
|
*/
|
|
14201
14522
|
set_composited(composited: boolean): void;
|
|
14202
14523
|
|
|
@@ -14242,6 +14563,7 @@ export namespace Gdk {
|
|
|
14242
14563
|
* use this default.
|
|
14243
14564
|
* @param device a master, pointer {@link Gdk.Device}
|
|
14244
14565
|
* @param cursor a {@link Gdk.Cursor}
|
|
14566
|
+
* @since 3.0
|
|
14245
14567
|
*/
|
|
14246
14568
|
set_device_cursor(device: Device, cursor: Cursor): void;
|
|
14247
14569
|
|
|
@@ -14255,6 +14577,7 @@ export namespace Gdk {
|
|
|
14255
14577
|
* See the [input handling overview][event-masks] for details.
|
|
14256
14578
|
* @param device {@link Gdk.Device} to enable events for.
|
|
14257
14579
|
* @param event_mask event mask for `window`
|
|
14580
|
+
* @since 3.0
|
|
14258
14581
|
*/
|
|
14259
14582
|
set_device_events(device: Device, event_mask: EventMask): void;
|
|
14260
14583
|
|
|
@@ -14268,6 +14591,7 @@ export namespace Gdk {
|
|
|
14268
14591
|
*
|
|
14269
14592
|
* By default, event compression is enabled.
|
|
14270
14593
|
* @param event_compression `true` if motion events should be compressed
|
|
14594
|
+
* @since 3.12
|
|
14271
14595
|
*/
|
|
14272
14596
|
set_event_compression(event_compression: boolean): void;
|
|
14273
14597
|
|
|
@@ -14293,6 +14617,7 @@ export namespace Gdk {
|
|
|
14293
14617
|
* this hint. Window managers following the freedesktop.org window
|
|
14294
14618
|
* manager extension specification should respect it.
|
|
14295
14619
|
* @param focus_on_map `true` if the window should receive input focus when mapped
|
|
14620
|
+
* @since 2.6
|
|
14296
14621
|
*/
|
|
14297
14622
|
set_focus_on_map(focus_on_map: boolean): void;
|
|
14298
14623
|
|
|
@@ -14315,6 +14640,7 @@ export namespace Gdk {
|
|
|
14315
14640
|
* window to span over the multiple monitors when #GDK_FULLSCREEN_ON_ALL_MONITORS
|
|
14316
14641
|
* is specified.
|
|
14317
14642
|
* @param mode fullscreen mode
|
|
14643
|
+
* @since 3.8
|
|
14318
14644
|
*/
|
|
14319
14645
|
set_fullscreen_mode(mode: FullscreenMode): void;
|
|
14320
14646
|
|
|
@@ -14420,6 +14746,7 @@ export namespace Gdk {
|
|
|
14420
14746
|
* But it will happen with most standard window managers,
|
|
14421
14747
|
* and GDK makes a best effort to get it to happen.
|
|
14422
14748
|
* @param setting whether to keep `window` above other windows
|
|
14749
|
+
* @since 2.4
|
|
14423
14750
|
*/
|
|
14424
14751
|
set_keep_above(setting: boolean): void;
|
|
14425
14752
|
|
|
@@ -14434,6 +14761,7 @@ export namespace Gdk {
|
|
|
14434
14761
|
* But it will happen with most standard window managers,
|
|
14435
14762
|
* and GDK makes a best effort to get it to happen.
|
|
14436
14763
|
* @param setting whether to keep `window` below other windows
|
|
14764
|
+
* @since 2.4
|
|
14437
14765
|
*/
|
|
14438
14766
|
set_keep_below(setting: boolean): void;
|
|
14439
14767
|
|
|
@@ -14470,6 +14798,7 @@ export namespace Gdk {
|
|
|
14470
14798
|
*
|
|
14471
14799
|
* Support for non-toplevel windows was added in 3.8.
|
|
14472
14800
|
* @param opacity opacity
|
|
14801
|
+
* @since 2.12
|
|
14473
14802
|
*/
|
|
14474
14803
|
set_opacity(opacity: number): void;
|
|
14475
14804
|
|
|
@@ -14488,6 +14817,7 @@ export namespace Gdk {
|
|
|
14488
14817
|
* are. If your window background is not opaque, please update this
|
|
14489
14818
|
* property in your `GtkWidget::style-updated` handler.
|
|
14490
14819
|
* @param region a region, or `null`
|
|
14820
|
+
* @since 3.10
|
|
14491
14821
|
*/
|
|
14492
14822
|
set_opaque_region(region: cairo.Region | null): void;
|
|
14493
14823
|
|
|
@@ -14524,6 +14854,7 @@ export namespace Gdk {
|
|
|
14524
14854
|
* that cases you would get the in-between related events such as the pointer
|
|
14525
14855
|
* enter/leave events on its way to the destination window.
|
|
14526
14856
|
* @param pass_through a boolean
|
|
14857
|
+
* @since 3.18
|
|
14527
14858
|
*/
|
|
14528
14859
|
set_pass_through(pass_through: boolean): void;
|
|
14529
14860
|
|
|
@@ -14558,6 +14889,7 @@ export namespace Gdk {
|
|
|
14558
14889
|
* @param right The right extent
|
|
14559
14890
|
* @param top The top extent
|
|
14560
14891
|
* @param bottom The bottom extent
|
|
14892
|
+
* @since 3.12
|
|
14561
14893
|
*/
|
|
14562
14894
|
set_shadow_width(left: number, right: number, top: number, bottom: number): void;
|
|
14563
14895
|
|
|
@@ -14571,6 +14903,7 @@ export namespace Gdk {
|
|
|
14571
14903
|
* allow the window to be treated according to standard policy for
|
|
14572
14904
|
* its semantic type.
|
|
14573
14905
|
* @param skips_pager `true` to skip the pager
|
|
14906
|
+
* @since 2.2
|
|
14574
14907
|
*/
|
|
14575
14908
|
set_skip_pager_hint(skips_pager: boolean): void;
|
|
14576
14909
|
|
|
@@ -14582,6 +14915,7 @@ export namespace Gdk {
|
|
|
14582
14915
|
* instead you should allow the window to be treated according to
|
|
14583
14916
|
* standard policy for its semantic type.
|
|
14584
14917
|
* @param skips_taskbar `true` to skip the taskbar
|
|
14918
|
+
* @since 2.2
|
|
14585
14919
|
*/
|
|
14586
14920
|
set_skip_taskbar_hint(skips_taskbar: boolean): void;
|
|
14587
14921
|
|
|
@@ -14592,6 +14926,7 @@ export namespace Gdk {
|
|
|
14592
14926
|
* after this call, and devices being attached/detached.
|
|
14593
14927
|
* @param source a {@link Gdk.InputSource} to define the source class.
|
|
14594
14928
|
* @param event_mask event mask for `window`
|
|
14929
|
+
* @since 3.0
|
|
14595
14930
|
*/
|
|
14596
14931
|
set_source_events(source: InputSource, event_mask: EventMask): void;
|
|
14597
14932
|
|
|
@@ -14599,6 +14934,7 @@ export namespace Gdk {
|
|
|
14599
14934
|
* When using GTK+, typically you should use `gtk_window_set_startup_id()`
|
|
14600
14935
|
* instead of this low-level function.
|
|
14601
14936
|
* @param startup_id a string with startup-notification identifier
|
|
14937
|
+
* @since 2.12
|
|
14602
14938
|
*/
|
|
14603
14939
|
set_startup_id(startup_id: string): void;
|
|
14604
14940
|
|
|
@@ -14609,6 +14945,7 @@ export namespace Gdk {
|
|
|
14609
14945
|
* windowing system. Don’t worry about it.
|
|
14610
14946
|
* @param use_static `true` to turn on static gravity
|
|
14611
14947
|
* @returns `false`
|
|
14948
|
+
* @deprecated since 3.16: static gravities haven't worked on anything but X11 for a long time.
|
|
14612
14949
|
*/
|
|
14613
14950
|
set_static_gravities(use_static: boolean): boolean;
|
|
14614
14951
|
|
|
@@ -14618,6 +14955,7 @@ export namespace Gdk {
|
|
|
14618
14955
|
* Multidevice aware windows will need to handle properly multiple,
|
|
14619
14956
|
* per device enter/leave events, device grabs and grab ownerships.
|
|
14620
14957
|
* @param support_multidevice `true` to enable multidevice support in `window`.
|
|
14958
|
+
* @since 3.0
|
|
14621
14959
|
*/
|
|
14622
14960
|
set_support_multidevice(support_multidevice: boolean): void;
|
|
14623
14961
|
|
|
@@ -14658,6 +14996,7 @@ export namespace Gdk {
|
|
|
14658
14996
|
* Toggles whether a window needs the user's
|
|
14659
14997
|
* urgent attention.
|
|
14660
14998
|
* @param urgent `true` if the window is urgent
|
|
14999
|
+
* @since 2.8
|
|
14661
15000
|
*/
|
|
14662
15001
|
set_urgency_hint(urgent: boolean): void;
|
|
14663
15002
|
|
|
@@ -14726,6 +15065,7 @@ export namespace Gdk {
|
|
|
14726
15065
|
* on the window decorations.
|
|
14727
15066
|
* @param event a {@link Gdk.Event} to show the menu for
|
|
14728
15067
|
* @returns `true` if the window menu was shown and `false` otherwise.
|
|
15068
|
+
* @since 3.14
|
|
14729
15069
|
*/
|
|
14730
15070
|
show_window_menu(event: Event): boolean;
|
|
14731
15071
|
|
|
@@ -14748,6 +15088,7 @@ export namespace Gdk {
|
|
|
14748
15088
|
*
|
|
14749
15089
|
* This function is not part of the GDK public API and is only
|
|
14750
15090
|
* for use by GTK+.
|
|
15091
|
+
* @deprecated since 3.16: This symbol was never meant to be used outside of GTK+
|
|
14751
15092
|
*/
|
|
14752
15093
|
thaw_toplevel_updates_libgtk_only(): void;
|
|
14753
15094
|
|
|
@@ -14767,6 +15108,7 @@ export namespace Gdk {
|
|
|
14767
15108
|
* unfullscreenification actually happening. But it will happen with
|
|
14768
15109
|
* most standard window managers, and GDK makes a best effort to get
|
|
14769
15110
|
* it to happen.
|
|
15111
|
+
* @since 2.2
|
|
14770
15112
|
*/
|
|
14771
15113
|
unfullscreen(): void;
|
|
14772
15114
|
|
|
@@ -14828,6 +15170,7 @@ export namespace Gdk {
|
|
|
14828
15170
|
* ever unload the module again (e.g. do not use this function in
|
|
14829
15171
|
* GTK+ theme engines).
|
|
14830
15172
|
* @param atom_name a static string
|
|
15173
|
+
* @since 2.10
|
|
14831
15174
|
*/
|
|
14832
15175
|
static intern_static_string(atom_name: string): Atom;
|
|
14833
15176
|
|
|
@@ -14880,6 +15223,7 @@ export namespace Gdk {
|
|
|
14880
15223
|
* (White in the four forms is “\#fff”, “\#ffffff”, “\#fffffffff”
|
|
14881
15224
|
* and “\#ffffffffffff”).
|
|
14882
15225
|
* @param spec the string specifying the color
|
|
15226
|
+
* @deprecated since 3.14: Use {@link Gdk.RGBA}
|
|
14883
15227
|
*/
|
|
14884
15228
|
static parse(spec: string): [boolean, Color];
|
|
14885
15229
|
|
|
@@ -14889,6 +15233,7 @@ export namespace Gdk {
|
|
|
14889
15233
|
*
|
|
14890
15234
|
* The result must be freed using `gdk_color_free()`.
|
|
14891
15235
|
* @returns a copy of `color`
|
|
15236
|
+
* @deprecated since 3.14: Use {@link Gdk.RGBA}
|
|
14892
15237
|
*/
|
|
14893
15238
|
copy(): Color;
|
|
14894
15239
|
|
|
@@ -14896,11 +15241,13 @@ export namespace Gdk {
|
|
|
14896
15241
|
* Compares two colors.
|
|
14897
15242
|
* @param colorb another {@link Gdk.Color}
|
|
14898
15243
|
* @returns `true` if the two colors compare equal
|
|
15244
|
+
* @deprecated since 3.14: Use {@link Gdk.RGBA}
|
|
14899
15245
|
*/
|
|
14900
15246
|
equal(colorb: Color): boolean;
|
|
14901
15247
|
|
|
14902
15248
|
/**
|
|
14903
15249
|
* Frees a {@link Gdk.Color} created with `gdk_color_copy()`.
|
|
15250
|
+
* @deprecated since 3.14: Use {@link Gdk.RGBA}
|
|
14904
15251
|
*/
|
|
14905
15252
|
free(): void;
|
|
14906
15253
|
|
|
@@ -14908,6 +15255,7 @@ export namespace Gdk {
|
|
|
14908
15255
|
* A hash function suitable for using for a hash
|
|
14909
15256
|
* table that stores `GdkColors`.
|
|
14910
15257
|
* @returns The hash function applied to `color`
|
|
15258
|
+
* @deprecated since 3.14: Use {@link Gdk.RGBA}
|
|
14911
15259
|
*/
|
|
14912
15260
|
hash(): number;
|
|
14913
15261
|
|
|
@@ -14918,6 +15266,8 @@ export namespace Gdk {
|
|
|
14918
15266
|
*
|
|
14919
15267
|
* The returned string can be parsed by `gdk_color_parse()`.
|
|
14920
15268
|
* @returns a newly-allocated text string
|
|
15269
|
+
* @since 2.12
|
|
15270
|
+
* @deprecated since 3.14: Use {@link Gdk.RGBA}
|
|
14921
15271
|
*/
|
|
14922
15272
|
to_string(): string;
|
|
14923
15273
|
}
|
|
@@ -15672,6 +16022,7 @@ export namespace Gdk {
|
|
|
15672
16022
|
* `true` for a frame, you can be certain that no further values
|
|
15673
16023
|
* will become available and be stored in the {@link Gdk.FrameTimings}.
|
|
15674
16024
|
* @returns `true` if all information that will be available for the frame has been filled in.
|
|
16025
|
+
* @since 3.8
|
|
15675
16026
|
*/
|
|
15676
16027
|
get_complete(): boolean;
|
|
15677
16028
|
|
|
@@ -15679,6 +16030,7 @@ export namespace Gdk {
|
|
|
15679
16030
|
* Gets the frame counter value of the {@link Gdk.FrameClock} when this
|
|
15680
16031
|
* this frame was drawn.
|
|
15681
16032
|
* @returns the frame counter value for this frame
|
|
16033
|
+
* @since 3.8
|
|
15682
16034
|
*/
|
|
15683
16035
|
get_frame_counter(): number;
|
|
15684
16036
|
|
|
@@ -15701,6 +16053,7 @@ export namespace Gdk {
|
|
|
15701
16053
|
* that want exact control over latency. For example, a movie player
|
|
15702
16054
|
* may want this information for Audio/Video synchronization.
|
|
15703
16055
|
* @returns The predicted time at which the frame will be presented, in the timescale of `g_get_monotonic_time()`, or 0 if no predicted presentation time is available.
|
|
16056
|
+
* @since 3.8
|
|
15704
16057
|
*/
|
|
15705
16058
|
get_predicted_presentation_time(): number;
|
|
15706
16059
|
|
|
@@ -15708,6 +16061,7 @@ export namespace Gdk {
|
|
|
15708
16061
|
* Reurns the presentation time. This is the time at which the frame
|
|
15709
16062
|
* became visible to the user.
|
|
15710
16063
|
* @returns the time the frame was displayed to the user, in the timescale of `g_get_monotonic_time()`, or 0 if no presentation time is available. See `gdk_frame_timings_get_complete()`
|
|
16064
|
+
* @since 3.8
|
|
15711
16065
|
*/
|
|
15712
16066
|
get_presentation_time(): number;
|
|
15713
16067
|
|
|
@@ -15716,18 +16070,21 @@ export namespace Gdk {
|
|
|
15716
16070
|
* the display that this frame was displayed on. Frame presentation
|
|
15717
16071
|
* usually happens during the “vertical blanking interval”.
|
|
15718
16072
|
* @returns the refresh interval of the display, in microseconds, or 0 if the refresh interval is not available. See `gdk_frame_timings_get_complete()`.
|
|
16073
|
+
* @since 3.8
|
|
15719
16074
|
*/
|
|
15720
16075
|
get_refresh_interval(): number;
|
|
15721
16076
|
|
|
15722
16077
|
/**
|
|
15723
16078
|
* Increases the reference count of `timings`.
|
|
15724
16079
|
* @returns `timings`
|
|
16080
|
+
* @since 3.8
|
|
15725
16081
|
*/
|
|
15726
16082
|
ref(): FrameTimings;
|
|
15727
16083
|
|
|
15728
16084
|
/**
|
|
15729
16085
|
* Decreases the reference count of `timings`. If `timings`
|
|
15730
16086
|
* is no longer referenced, it will be freed.
|
|
16087
|
+
* @since 3.8
|
|
15731
16088
|
*/
|
|
15732
16089
|
unref(): void;
|
|
15733
16090
|
}
|
|
@@ -15903,6 +16260,7 @@ export namespace Gdk {
|
|
|
15903
16260
|
*
|
|
15904
16261
|
* The result must be freed through `gdk_rgba_free()`.
|
|
15905
16262
|
* @returns A newly allocated {@link Gdk.RGBA}, with the same contents as `rgba`
|
|
16263
|
+
* @since 3.0
|
|
15906
16264
|
*/
|
|
15907
16265
|
copy(): RGBA;
|
|
15908
16266
|
|
|
@@ -15910,11 +16268,13 @@ export namespace Gdk {
|
|
|
15910
16268
|
* Compares two RGBA colors.
|
|
15911
16269
|
* @param p2 another {@link Gdk.RGBA} pointer
|
|
15912
16270
|
* @returns `true` if the two colors compare equal
|
|
16271
|
+
* @since 3.0
|
|
15913
16272
|
*/
|
|
15914
16273
|
equal(p2: RGBA): boolean;
|
|
15915
16274
|
|
|
15916
16275
|
/**
|
|
15917
16276
|
* Frees a {@link Gdk.RGBA} created with `gdk_rgba_copy()`
|
|
16277
|
+
* @since 3.0
|
|
15918
16278
|
*/
|
|
15919
16279
|
free(): void;
|
|
15920
16280
|
|
|
@@ -15922,6 +16282,7 @@ export namespace Gdk {
|
|
|
15922
16282
|
* A hash function suitable for using for a hash
|
|
15923
16283
|
* table that stores `GdkRGBAs`.
|
|
15924
16284
|
* @returns The hash value for `p`
|
|
16285
|
+
* @since 3.0
|
|
15925
16286
|
*/
|
|
15926
16287
|
hash(): number;
|
|
15927
16288
|
|
|
@@ -15943,6 +16304,7 @@ export namespace Gdk {
|
|
|
15943
16304
|
* a is a floating point value in the range 0 to 1.
|
|
15944
16305
|
* @param spec the string specifying the color
|
|
15945
16306
|
* @returns `true` if the parsing succeeded
|
|
16307
|
+
* @since 3.0
|
|
15946
16308
|
*/
|
|
15947
16309
|
parse(spec: string): boolean;
|
|
15948
16310
|
|
|
@@ -15963,6 +16325,7 @@ export namespace Gdk {
|
|
|
15963
16325
|
* integers. If this is a concern, you should use a
|
|
15964
16326
|
* different representation.
|
|
15965
16327
|
* @returns A newly allocated text string
|
|
16328
|
+
* @since 3.0
|
|
15966
16329
|
*/
|
|
15967
16330
|
to_string(): string;
|
|
15968
16331
|
}
|
|
@@ -15999,6 +16362,7 @@ export namespace Gdk {
|
|
|
15999
16362
|
* Checks if the two given rectangles are equal.
|
|
16000
16363
|
* @param rect2 a {@link Gdk.Rectangle}
|
|
16001
16364
|
* @returns `true` if the rectangles are equal.
|
|
16365
|
+
* @since 3.20
|
|
16002
16366
|
*/
|
|
16003
16367
|
equal(rect2: Rectangle): boolean;
|
|
16004
16368
|
|
|
@@ -16196,6 +16560,7 @@ export namespace Gdk {
|
|
|
16196
16560
|
* ```
|
|
16197
16561
|
*
|
|
16198
16562
|
* @param event a valid {@link Gdk.Event}
|
|
16563
|
+
* @since 2.12
|
|
16199
16564
|
*/
|
|
16200
16565
|
static request_motions(event: EventMotion): void;
|
|
16201
16566
|
|
|
@@ -16207,6 +16572,7 @@ export namespace Gdk {
|
|
|
16207
16572
|
* Y axis.
|
|
16208
16573
|
* @param event2 second {@link Gdk.Event}
|
|
16209
16574
|
* @returns `true` if the angle could be calculated.
|
|
16575
|
+
* @since 3.0
|
|
16210
16576
|
*/
|
|
16211
16577
|
_get_angle(event2: Event): [boolean, number];
|
|
16212
16578
|
|
|
@@ -16215,6 +16581,7 @@ export namespace Gdk {
|
|
|
16215
16581
|
* will be returned in `x` and `y`.
|
|
16216
16582
|
* @param event2 second {@link Gdk.Event}
|
|
16217
16583
|
* @returns `true` if the center could be calculated.
|
|
16584
|
+
* @since 3.0
|
|
16218
16585
|
*/
|
|
16219
16586
|
_get_center(event2: Event): [boolean, number, number];
|
|
16220
16587
|
|
|
@@ -16223,6 +16590,7 @@ export namespace Gdk {
|
|
|
16223
16590
|
* (as in a straight line going from `event1` to `event2`) will be returned.
|
|
16224
16591
|
* @param event2 second {@link Gdk.Event}
|
|
16225
16592
|
* @returns `true` if the distance could be calculated.
|
|
16593
|
+
* @since 3.0
|
|
16226
16594
|
*/
|
|
16227
16595
|
_get_distance(event2: Event): [boolean, number];
|
|
16228
16596
|
|
|
@@ -16252,12 +16620,14 @@ export namespace Gdk {
|
|
|
16252
16620
|
/**
|
|
16253
16621
|
* Extract the button number from an event.
|
|
16254
16622
|
* @returns `true` if the event delivered a button number
|
|
16623
|
+
* @since 3.2
|
|
16255
16624
|
*/
|
|
16256
16625
|
get_button(): [boolean, number];
|
|
16257
16626
|
|
|
16258
16627
|
/**
|
|
16259
16628
|
* Extracts the click count from an event.
|
|
16260
16629
|
* @returns `true` if the event delivered a click count
|
|
16630
|
+
* @since 3.2
|
|
16261
16631
|
*/
|
|
16262
16632
|
get_click_count(): [boolean, number];
|
|
16263
16633
|
|
|
@@ -16271,6 +16641,7 @@ export namespace Gdk {
|
|
|
16271
16641
|
* If the event contains a “device” field, this function will return
|
|
16272
16642
|
* it, else it will return `null`.
|
|
16273
16643
|
* @returns a {@link Gdk.Device}, or `null`.
|
|
16644
|
+
* @since 3.0
|
|
16274
16645
|
*/
|
|
16275
16646
|
get_device(): Device | null;
|
|
16276
16647
|
|
|
@@ -16284,6 +16655,7 @@ export namespace Gdk {
|
|
|
16284
16655
|
* the application lifetime, if settings must be stored
|
|
16285
16656
|
* persistently across runs, see `gdk_device_tool_get_serial()`
|
|
16286
16657
|
* @returns The current device tool, or `null`
|
|
16658
|
+
* @since 3.22
|
|
16287
16659
|
*/
|
|
16288
16660
|
get_device_tool(): DeviceTool;
|
|
16289
16661
|
|
|
@@ -16292,12 +16664,14 @@ export namespace Gdk {
|
|
|
16292
16664
|
* {@link Gdk.EventType.TOUCH_END} or {@link Gdk.EventType.TOUCH_CANCEL}, returns the {@link Gdk.EventSequence}
|
|
16293
16665
|
* to which the event belongs. Otherwise, return `null`.
|
|
16294
16666
|
* @returns the event sequence that the event belongs to
|
|
16667
|
+
* @since 3.4
|
|
16295
16668
|
*/
|
|
16296
16669
|
get_event_sequence(): EventSequence;
|
|
16297
16670
|
|
|
16298
16671
|
/**
|
|
16299
16672
|
* Retrieves the type of the event.
|
|
16300
16673
|
* @returns a {@link Gdk.EventType}
|
|
16674
|
+
* @since 3.10
|
|
16301
16675
|
*/
|
|
16302
16676
|
get_event_type(): EventType;
|
|
16303
16677
|
|
|
@@ -16306,12 +16680,14 @@ export namespace Gdk {
|
|
|
16306
16680
|
*
|
|
16307
16681
|
* Also see `gdk_event_get_scancode()`.
|
|
16308
16682
|
* @returns `true` if the event delivered a hardware keycode
|
|
16683
|
+
* @since 3.2
|
|
16309
16684
|
*/
|
|
16310
16685
|
get_keycode(): [boolean, number];
|
|
16311
16686
|
|
|
16312
16687
|
/**
|
|
16313
16688
|
* Extracts the keyval from an event.
|
|
16314
16689
|
* @returns `true` if the event delivered a key symbol
|
|
16690
|
+
* @since 3.2
|
|
16315
16691
|
*/
|
|
16316
16692
|
get_keyval(): [boolean, number];
|
|
16317
16693
|
|
|
@@ -16320,6 +16696,7 @@ export namespace Gdk {
|
|
|
16320
16696
|
* Returns whether this event is an 'emulated' pointer event (typically
|
|
16321
16697
|
* from a touch event), as opposed to a real one.
|
|
16322
16698
|
* @returns `true` if this event is emulated
|
|
16699
|
+
* @since 3.22
|
|
16323
16700
|
*/
|
|
16324
16701
|
get_pointer_emulated(): boolean;
|
|
16325
16702
|
|
|
@@ -16336,6 +16713,7 @@ export namespace Gdk {
|
|
|
16336
16713
|
* word of WM_KEY{DOWN,UP} lParam which contains the scancode and
|
|
16337
16714
|
* some extended flags.
|
|
16338
16715
|
* @returns The associated keyboard scancode or 0
|
|
16716
|
+
* @since 3.22
|
|
16339
16717
|
*/
|
|
16340
16718
|
get_scancode(): number;
|
|
16341
16719
|
|
|
@@ -16348,6 +16726,7 @@ export namespace Gdk {
|
|
|
16348
16726
|
* to which `event->motion.x_root` and
|
|
16349
16727
|
* `event->motion.y_root` are relative.
|
|
16350
16728
|
* @returns the screen for the event
|
|
16729
|
+
* @since 2.2
|
|
16351
16730
|
*/
|
|
16352
16731
|
get_screen(): Screen;
|
|
16353
16732
|
|
|
@@ -16356,6 +16735,7 @@ export namespace Gdk {
|
|
|
16356
16735
|
*
|
|
16357
16736
|
* See also: `gdk_event_get_scroll_direction()`
|
|
16358
16737
|
* @returns `true` if the event contains smooth scroll information and `false` otherwise
|
|
16738
|
+
* @since 3.4
|
|
16359
16739
|
*/
|
|
16360
16740
|
get_scroll_deltas(): [boolean, number, number];
|
|
16361
16741
|
|
|
@@ -16401,12 +16781,14 @@ export namespace Gdk {
|
|
|
16401
16781
|
* ```
|
|
16402
16782
|
*
|
|
16403
16783
|
* @returns `true` if the event delivered a scroll direction and `false` otherwise
|
|
16784
|
+
* @since 3.2
|
|
16404
16785
|
*/
|
|
16405
16786
|
get_scroll_direction(): [boolean, ScrollDirection];
|
|
16406
16787
|
|
|
16407
16788
|
/**
|
|
16408
16789
|
* Returns the {@link Gdk.Seat} this event was generated for.
|
|
16409
16790
|
* @returns The {@link Gdk.Seat} of this event
|
|
16791
|
+
* @since 3.20
|
|
16410
16792
|
*/
|
|
16411
16793
|
get_seat(): Seat;
|
|
16412
16794
|
|
|
@@ -16421,6 +16803,7 @@ export namespace Gdk {
|
|
|
16421
16803
|
* If the event does not contain a device field, this function will
|
|
16422
16804
|
* return `null`.
|
|
16423
16805
|
* @returns a {@link Gdk.Device}, or `null`.
|
|
16806
|
+
* @since 3.0
|
|
16424
16807
|
*/
|
|
16425
16808
|
get_source_device(): Device | null;
|
|
16426
16809
|
|
|
@@ -16443,6 +16826,7 @@ export namespace Gdk {
|
|
|
16443
16826
|
/**
|
|
16444
16827
|
* Extracts the {@link Gdk.Window} associated with an event.
|
|
16445
16828
|
* @returns The {@link Gdk.Window} associated with the event
|
|
16829
|
+
* @since 3.10
|
|
16446
16830
|
*/
|
|
16447
16831
|
get_window(): Window;
|
|
16448
16832
|
|
|
@@ -16455,6 +16839,7 @@ export namespace Gdk {
|
|
|
16455
16839
|
*
|
|
16456
16840
|
* Stop scroll events always have a a delta of 0/0.
|
|
16457
16841
|
* @returns `true` if the event is a scroll stop event
|
|
16842
|
+
* @since 3.20
|
|
16458
16843
|
*/
|
|
16459
16844
|
is_scroll_stop_event(): boolean;
|
|
16460
16845
|
|
|
@@ -16470,12 +16855,14 @@ export namespace Gdk {
|
|
|
16470
16855
|
* have been allocated by GTK+, for instance, by
|
|
16471
16856
|
* `gdk_event_copy()`.
|
|
16472
16857
|
* @param device a {@link Gdk.Device}
|
|
16858
|
+
* @since 3.0
|
|
16473
16859
|
*/
|
|
16474
16860
|
set_device(device: Device): void;
|
|
16475
16861
|
|
|
16476
16862
|
/**
|
|
16477
16863
|
* Sets the device tool for this event, should be rarely used.
|
|
16478
16864
|
* @param tool tool to set on the event, or `null`
|
|
16865
|
+
* @since 3.22
|
|
16479
16866
|
*/
|
|
16480
16867
|
set_device_tool(tool: DeviceTool | null): void;
|
|
16481
16868
|
|
|
@@ -16484,6 +16871,7 @@ export namespace Gdk {
|
|
|
16484
16871
|
* have been allocated by GTK+, for instance, by
|
|
16485
16872
|
* `gdk_event_copy()`.
|
|
16486
16873
|
* @param screen a {@link Gdk.Screen}
|
|
16874
|
+
* @since 2.2
|
|
16487
16875
|
*/
|
|
16488
16876
|
set_screen(screen: Screen): void;
|
|
16489
16877
|
|
|
@@ -16493,6 +16881,7 @@ export namespace Gdk {
|
|
|
16493
16881
|
* The event must have been allocated by GTK+,
|
|
16494
16882
|
* for instance by `gdk_event_copy()`.
|
|
16495
16883
|
* @param device a {@link Gdk.Device}
|
|
16884
|
+
* @since 3.0
|
|
16496
16885
|
*/
|
|
16497
16886
|
set_source_device(device: Device): void;
|
|
16498
16887
|
|
|
@@ -16507,6 +16896,7 @@ export namespace Gdk {
|
|
|
16507
16896
|
* This function should always be used instead of simply checking for
|
|
16508
16897
|
* event->button == `GDK_BUTTON_SECONDARY`.
|
|
16509
16898
|
* @returns `true` if the event should trigger a context menu.
|
|
16899
|
+
* @since 3.4
|
|
16510
16900
|
*/
|
|
16511
16901
|
triggers_context_menu(): boolean;
|
|
16512
16902
|
}
|
|
@@ -16551,6 +16941,7 @@ export namespace Gdk {
|
|
|
16551
16941
|
* @param feature the feature type to get the group from
|
|
16552
16942
|
* @param feature_idx the index of the feature to get the group from
|
|
16553
16943
|
* @returns The group number of the queried pad feature.
|
|
16944
|
+
* @since 3.22
|
|
16554
16945
|
*/
|
|
16555
16946
|
get_feature_group(feature: DevicePadFeature, feature_idx: number): number;
|
|
16556
16947
|
|
|
@@ -16558,6 +16949,7 @@ export namespace Gdk {
|
|
|
16558
16949
|
* Returns the number of modes that `group` may have.
|
|
16559
16950
|
* @param group_idx group to get the number of available modes from
|
|
16560
16951
|
* @returns The number of modes available in `group`.
|
|
16952
|
+
* @since 3.22
|
|
16561
16953
|
*/
|
|
16562
16954
|
get_group_n_modes(group_idx: number): number;
|
|
16563
16955
|
|
|
@@ -16565,6 +16957,7 @@ export namespace Gdk {
|
|
|
16565
16957
|
* Returns the number of features a tablet pad has.
|
|
16566
16958
|
* @param feature a pad feature
|
|
16567
16959
|
* @returns The amount of elements of type `feature` that this pad has.
|
|
16960
|
+
* @since 3.22
|
|
16568
16961
|
*/
|
|
16569
16962
|
get_n_features(feature: DevicePadFeature): number;
|
|
16570
16963
|
|
|
@@ -16574,6 +16967,7 @@ export namespace Gdk {
|
|
|
16574
16967
|
* buttons/strip/rings that is affected collectively by a same
|
|
16575
16968
|
* current mode.
|
|
16576
16969
|
* @returns The number of button/ring/strip groups in the pad.
|
|
16970
|
+
* @since 3.22
|
|
16577
16971
|
*/
|
|
16578
16972
|
get_n_groups(): number;
|
|
16579
16973
|
}
|