-
-
Notifications
You must be signed in to change notification settings - Fork 46
/
GdkWayland-4.0.gir
604 lines (579 loc) · 29.9 KB
/
GdkWayland-4.0.gir
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
<?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository xmlns="http://www.gtk.org/introspection/core/1.0" xmlns:c="http://www.gtk.org/introspection/c/1.0" xmlns:glib="http://www.gtk.org/introspection/glib/1.0" version="1.2">
<include name="Gdk" version="4.0"/>
<package name="gtk4-wayland"/>
<c:include name="gdk/wayland/gdkwayland.h"/>
<namespace name="GdkWayland" version="4.0" shared-library="libgtk-4.so.1" c:identifier-prefixes="Gdk" c:symbol-prefixes="gdk">
<function-macro name="IS_WAYLAND_DEVICE" c:identifier="GDK_IS_WAYLAND_DEVICE" introspectable="0">
<parameters>
<parameter name="o">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_WAYLAND_DEVICE_CLASS" c:identifier="GDK_IS_WAYLAND_DEVICE_CLASS" introspectable="0">
<parameters>
<parameter name="c">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_WAYLAND_DISPLAY" c:identifier="GDK_IS_WAYLAND_DISPLAY" introspectable="0">
<parameters>
<parameter name="object">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_WAYLAND_DISPLAY_CLASS" c:identifier="GDK_IS_WAYLAND_DISPLAY_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_WAYLAND_MONITOR" c:identifier="GDK_IS_WAYLAND_MONITOR" introspectable="0">
<parameters>
<parameter name="object">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_WAYLAND_POPUP" c:identifier="GDK_IS_WAYLAND_POPUP" introspectable="0">
<parameters>
<parameter name="object">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_WAYLAND_SEAT" c:identifier="GDK_IS_WAYLAND_SEAT" introspectable="0">
<parameters>
<parameter name="o">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_WAYLAND_SURFACE" c:identifier="GDK_IS_WAYLAND_SURFACE" introspectable="0">
<parameters>
<parameter name="object">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_WAYLAND_TOPLEVEL" c:identifier="GDK_IS_WAYLAND_TOPLEVEL" introspectable="0">
<parameters>
<parameter name="object">
</parameter>
</parameters>
</function-macro>
<function-macro name="WAYLAND_DEVICE" c:identifier="GDK_WAYLAND_DEVICE" introspectable="0">
<parameters>
<parameter name="o">
</parameter>
</parameters>
</function-macro>
<function-macro name="WAYLAND_DEVICE_CLASS" c:identifier="GDK_WAYLAND_DEVICE_CLASS" introspectable="0">
<parameters>
<parameter name="c">
</parameter>
</parameters>
</function-macro>
<function-macro name="WAYLAND_DEVICE_GET_CLASS" c:identifier="GDK_WAYLAND_DEVICE_GET_CLASS" introspectable="0">
<parameters>
<parameter name="o">
</parameter>
</parameters>
</function-macro>
<function-macro name="WAYLAND_DISPLAY" c:identifier="GDK_WAYLAND_DISPLAY" introspectable="0">
<parameters>
<parameter name="object">
</parameter>
</parameters>
</function-macro>
<function-macro name="WAYLAND_DISPLAY_CLASS" c:identifier="GDK_WAYLAND_DISPLAY_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="WAYLAND_DISPLAY_GET_CLASS" c:identifier="GDK_WAYLAND_DISPLAY_GET_CLASS" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="WAYLAND_GL_CONTEXT" c:identifier="GDK_WAYLAND_GL_CONTEXT" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="WAYLAND_IS_GL_CONTEXT" c:identifier="GDK_WAYLAND_IS_GL_CONTEXT" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="WAYLAND_MONITOR" c:identifier="GDK_WAYLAND_MONITOR" introspectable="0">
<parameters>
<parameter name="object">
</parameter>
</parameters>
</function-macro>
<function-macro name="WAYLAND_POPUP" c:identifier="GDK_WAYLAND_POPUP" introspectable="0">
<parameters>
<parameter name="object">
</parameter>
</parameters>
</function-macro>
<function-macro name="WAYLAND_SEAT" c:identifier="GDK_WAYLAND_SEAT" introspectable="0">
<parameters>
<parameter name="o">
</parameter>
</parameters>
</function-macro>
<function-macro name="WAYLAND_SURFACE" c:identifier="GDK_WAYLAND_SURFACE" introspectable="0">
<parameters>
<parameter name="object">
</parameter>
</parameters>
</function-macro>
<function-macro name="WAYLAND_TOPLEVEL" c:identifier="GDK_WAYLAND_TOPLEVEL" introspectable="0">
<parameters>
<parameter name="object">
</parameter>
</parameters>
</function-macro>
<class name="WaylandDevice" c:symbol-prefix="wayland_device" c:type="GdkWaylandDevice" parent="Gdk.Device" glib:type-name="GdkWaylandDevice" glib:get-type="gdk_wayland_device_get_type" glib:type-struct="WaylandDeviceClass">
<doc xml:space="preserve">The Wayland implementation of `GdkDevice`.
Beyond the regular [[email protected]] API, the Wayland implementation
provides access to Wayland objects such as the `wl_seat` with
[[email protected]_wl_seat], the `wl_keyboard` with
[[email protected]_wl_keyboard] and the `wl_pointer` with
[[email protected]_wl_pointer].</doc>
<method name="get_node_path" c:identifier="gdk_wayland_device_get_node_path">
<doc xml:space="preserve">Returns the `/dev/input/event*` path of this device.
For `GdkDevice`s that possibly coalesce multiple hardware
devices (eg. mouse, keyboard, touch,...), this function
will return %NULL.
This is most notably implemented for devices of type
%GDK_SOURCE_PEN, %GDK_SOURCE_TABLET_PAD.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the `/dev/input/event*`
path of this device</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="device" transfer-ownership="none">
<doc xml:space="preserve">a `GdkDevice`</doc>
<type name="WaylandDevice" c:type="GdkDevice*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_wl_keyboard" c:identifier="gdk_wayland_device_get_wl_keyboard" introspectable="0">
<doc xml:space="preserve">Returns the Wayland `wl_keyboard` of a `GdkDevice`.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a Wayland `wl_keyboard`</doc>
<type name="gpointer" c:type="gpointer"/>
</return-value>
<parameters>
<instance-parameter name="device" transfer-ownership="none">
<doc xml:space="preserve">a `GdkDevice`</doc>
<type name="WaylandDevice" c:type="GdkDevice*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_wl_pointer" c:identifier="gdk_wayland_device_get_wl_pointer" introspectable="0">
<doc xml:space="preserve">Returns the Wayland `wl_pointer` of a `GdkDevice`.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a Wayland `wl_pointer`</doc>
<type name="gpointer" c:type="gpointer"/>
</return-value>
<parameters>
<instance-parameter name="device" transfer-ownership="none">
<doc xml:space="preserve">a `GdkDevice`</doc>
<type name="WaylandDevice" c:type="GdkDevice*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_wl_seat" c:identifier="gdk_wayland_device_get_wl_seat" introspectable="0">
<doc xml:space="preserve">Returns the Wayland `wl_seat` of a `GdkDevice`.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a Wayland `wl_seat`</doc>
<type name="gpointer" c:type="gpointer"/>
</return-value>
<parameters>
<instance-parameter name="device" transfer-ownership="none">
<doc xml:space="preserve">a `GdkDevice`</doc>
<type name="WaylandDevice" c:type="GdkDevice*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_xkb_keymap" c:identifier="gdk_wayland_device_get_xkb_keymap" version="4.4">
<doc xml:space="preserve">Returns the `xkb_keymap` of a `GdkDevice`.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a `struct xkb_keymap`</doc>
<type name="gpointer" c:type="gpointer"/>
</return-value>
<parameters>
<instance-parameter name="device" transfer-ownership="none">
<doc xml:space="preserve">a `GdkDevice`</doc>
<type name="WaylandDevice" c:type="GdkDevice*"/>
</instance-parameter>
</parameters>
</method>
</class>
<record name="WaylandDeviceClass" c:type="GdkWaylandDeviceClass" disguised="1" opaque="1" glib:is-gtype-struct-for="WaylandDevice"/>
<class name="WaylandDisplay" c:symbol-prefix="wayland_display" c:type="GdkWaylandDisplay" parent="Gdk.Display" glib:type-name="GdkWaylandDisplay" glib:get-type="gdk_wayland_display_get_type" glib:type-struct="WaylandDisplayClass">
<doc xml:space="preserve">The Wayland implementation of `GdkDisplay`.
Beyond the regular [[email protected]] API, the Wayland implementation
provides access to Wayland objects such as the `wl_display` with
[[email protected]_wl_display], the `wl_compositor` with
[[email protected]_wl_compositor].
You can find out what Wayland globals are supported by a display
with [[email protected]_registry].</doc>
<method name="get_egl_display" c:identifier="gdk_wayland_display_get_egl_display" version="4.4">
<doc xml:space="preserve">Retrieves the EGL display connection object for the given GDK display.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the EGL display</doc>
<type name="gpointer" c:type="gpointer"/>
</return-value>
<parameters>
<instance-parameter name="display" transfer-ownership="none">
<doc xml:space="preserve">a Wayland display</doc>
<type name="WaylandDisplay" c:type="GdkDisplay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_startup_notification_id" c:identifier="gdk_wayland_display_get_startup_notification_id" deprecated="1" deprecated-version="4.10.">
<doc xml:space="preserve">Gets the startup notification ID for a Wayland display, or %NULL
if no ID has been defined.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the startup notification ID for @display</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="display" transfer-ownership="none">
<doc xml:space="preserve">a `GdkDisplay`</doc>
<type name="WaylandDisplay" c:type="GdkDisplay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_wl_compositor" c:identifier="gdk_wayland_display_get_wl_compositor" introspectable="0">
<doc xml:space="preserve">Returns the Wayland `wl_compositor` of a `GdkDisplay`.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a Wayland `wl_compositor`</doc>
<type name="gpointer" c:type="gpointer"/>
</return-value>
<parameters>
<instance-parameter name="display" transfer-ownership="none">
<doc xml:space="preserve">a `GdkDisplay`</doc>
<type name="WaylandDisplay" c:type="GdkDisplay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_wl_display" c:identifier="gdk_wayland_display_get_wl_display" introspectable="0">
<doc xml:space="preserve">Returns the Wayland `wl_display` of a `GdkDisplay`.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a Wayland `wl_display`</doc>
<type name="gpointer" c:type="gpointer"/>
</return-value>
<parameters>
<instance-parameter name="display" transfer-ownership="none">
<doc xml:space="preserve">a `GdkDisplay`</doc>
<type name="WaylandDisplay" c:type="GdkDisplay*"/>
</instance-parameter>
</parameters>
</method>
<method name="query_registry" c:identifier="gdk_wayland_display_query_registry">
<doc xml:space="preserve">Returns %TRUE if the interface was found in the display
`wl_registry.global` handler.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the global is offered by the compositor</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="display" transfer-ownership="none">
<doc xml:space="preserve">a `GdkDisplay`</doc>
<type name="WaylandDisplay" c:type="GdkDisplay*"/>
</instance-parameter>
<parameter name="global" transfer-ownership="none">
<doc xml:space="preserve">global interface to query in the registry</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_cursor_theme" c:identifier="gdk_wayland_display_set_cursor_theme" deprecated="1" deprecated-version="4.16">
<doc xml:space="preserve">Sets the cursor theme for the given @display.</doc>
<doc-deprecated xml:space="preserve">Use the cursor-related properties of
[GtkSettings](../gtk4/class.Settings.html) to set the cursor theme</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="display" transfer-ownership="none">
<doc xml:space="preserve">a `GdkDisplay`</doc>
<type name="WaylandDisplay" c:type="GdkDisplay*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">the new cursor theme</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="size" transfer-ownership="none">
<doc xml:space="preserve">the size to use for cursors</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="set_startup_notification_id" c:identifier="gdk_wayland_display_set_startup_notification_id" deprecated="1" deprecated-version="4.10.">
<doc xml:space="preserve">Sets the startup notification ID for a display.
This is usually taken from the value of the `DESKTOP_STARTUP_ID`
environment variable, but in some cases (such as the application not
being launched using exec()) it can come from other sources.
The startup ID is also what is used to signal that the startup is
complete (for example, when opening a window or when calling
[[email protected]_startup_complete]).</doc>
<doc-deprecated xml:space="preserve">Use [[email protected]_startup_id]</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="display" transfer-ownership="none">
<doc xml:space="preserve">a `GdkDisplay`</doc>
<type name="WaylandDisplay" c:type="GdkDisplay*"/>
</instance-parameter>
<parameter name="startup_id" transfer-ownership="none">
<doc xml:space="preserve">the startup notification ID (must be valid utf8)</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
</class>
<record name="WaylandDisplayClass" c:type="GdkWaylandDisplayClass" disguised="1" opaque="1" glib:is-gtype-struct-for="WaylandDisplay"/>
<class name="WaylandGLContext" c:symbol-prefix="wayland_gl_context" c:type="GdkWaylandGLContext" parent="Gdk.GLContext" glib:type-name="GdkWaylandGLContext" glib:get-type="gdk_wayland_gl_context_get_type" glib:type-struct="WaylandGLContextClass">
<doc xml:space="preserve">The Wayland implementation of `GdkGLContext`.</doc>
</class>
<record name="WaylandGLContextClass" c:type="GdkWaylandGLContextClass" disguised="1" opaque="1" glib:is-gtype-struct-for="WaylandGLContext"/>
<class name="WaylandMonitor" c:symbol-prefix="wayland_monitor" c:type="GdkWaylandMonitor" parent="Gdk.Monitor" glib:type-name="GdkWaylandMonitor" glib:get-type="gdk_wayland_monitor_get_type" glib:type-struct="WaylandMonitorClass">
<doc xml:space="preserve">The Wayland implementation of `GdkMonitor`.
Beyond the [[email protected]] API, the Wayland implementation
offers access to the Wayland `wl_output` object with
[[email protected]_wl_output].</doc>
<method name="get_wl_output" c:identifier="gdk_wayland_monitor_get_wl_output" introspectable="0">
<doc xml:space="preserve">Returns the Wayland `wl_output` of a `GdkMonitor`.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a Wayland `wl_output`</doc>
<type name="gpointer" c:type="gpointer"/>
</return-value>
<parameters>
<instance-parameter name="monitor" transfer-ownership="none">
<doc xml:space="preserve">a `GdkMonitor`</doc>
<type name="WaylandMonitor" c:type="GdkMonitor*"/>
</instance-parameter>
</parameters>
</method>
</class>
<record name="WaylandMonitorClass" c:type="GdkWaylandMonitorClass" disguised="1" opaque="1" glib:is-gtype-struct-for="WaylandMonitor"/>
<class name="WaylandPopup" c:symbol-prefix="wayland_popup" c:type="GdkWaylandPopup" parent="WaylandSurface" glib:type-name="GdkWaylandPopup" glib:get-type="gdk_wayland_popup_get_type">
<doc xml:space="preserve">The Wayland implementation of `GdkPopup`.</doc>
<implements name="Gdk.Popup"/>
</class>
<class name="WaylandSeat" c:symbol-prefix="wayland_seat" c:type="GdkWaylandSeat" parent="Gdk.Seat" glib:type-name="GdkWaylandSeat" glib:get-type="gdk_wayland_seat_get_type" glib:type-struct="WaylandSeatClass">
<doc xml:space="preserve">The Wayland implementation of `GdkSeat`.
Beyond the regular [[email protected]] API, the Wayland implementation
provides access to the Wayland `wl_seat` object with
[[email protected]_wl_seat].</doc>
<method name="get_wl_seat" c:identifier="gdk_wayland_seat_get_wl_seat" introspectable="0">
<doc xml:space="preserve">Returns the Wayland `wl_seat` of a `GdkSeat`.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a Wayland `wl_seat`</doc>
<type name="gpointer" c:type="gpointer"/>
</return-value>
<parameters>
<instance-parameter name="seat" transfer-ownership="none">
<doc xml:space="preserve">a `GdkSeat`</doc>
<type name="WaylandSeat" c:type="GdkSeat*"/>
</instance-parameter>
</parameters>
</method>
</class>
<record name="WaylandSeatClass" c:type="GdkWaylandSeatClass" disguised="1" opaque="1" glib:is-gtype-struct-for="WaylandSeat"/>
<class name="WaylandSurface" c:symbol-prefix="wayland_surface" c:type="GdkWaylandSurface" parent="Gdk.Surface" glib:type-name="GdkWaylandSurface" glib:get-type="gdk_wayland_surface_get_type">
<doc xml:space="preserve">The Wayland implementation of `GdkSurface`.
Beyond the [[email protected]] API, the Wayland implementation offers
access to the Wayland `wl_surface` object with
[[email protected]_wl_surface].</doc>
<function name="force_next_commit" c:identifier="gdk_wayland_surface_force_next_commit">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="surface" transfer-ownership="none">
<type name="Gdk.Surface" c:type="GdkSurface*"/>
</parameter>
</parameters>
</function>
<method name="get_wl_surface" c:identifier="gdk_wayland_surface_get_wl_surface" introspectable="0">
<doc xml:space="preserve">Returns the Wayland `wl_surface` of a `GdkSurface`.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a Wayland `wl_surface`</doc>
<type name="gpointer" c:type="gpointer"/>
</return-value>
<parameters>
<instance-parameter name="surface" transfer-ownership="none">
<doc xml:space="preserve">a `GdkSurface`</doc>
<type name="WaylandSurface" c:type="GdkSurface*"/>
</instance-parameter>
</parameters>
</method>
</class>
<class name="WaylandToplevel" c:symbol-prefix="wayland_toplevel" c:type="GdkWaylandToplevel" parent="WaylandSurface" glib:type-name="GdkWaylandToplevel" glib:get-type="gdk_wayland_toplevel_get_type">
<doc xml:space="preserve">The Wayland implementation of `GdkToplevel`.
Beyond the [[email protected]] API, the Wayland implementation
has API to set up cross-process parent-child relationships between
surfaces with [[email protected]_handle] and
[[email protected]_transient_for_exported].</doc>
<implements name="Gdk.Toplevel"/>
<method name="drop_exported_handle" c:identifier="gdk_wayland_toplevel_drop_exported_handle" version="4.12">
<doc xml:space="preserve">Destroy a handle that was obtained with gdk_wayland_toplevel_export_handle().
Note that this API depends on an unstable Wayland protocol,
and thus may require changes in the future.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="toplevel" transfer-ownership="none">
<doc xml:space="preserve">the `GdkToplevel` that was exported</doc>
<type name="WaylandToplevel" c:type="GdkToplevel*"/>
</instance-parameter>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">the handle to drop</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="export_handle" c:identifier="gdk_wayland_toplevel_export_handle">
<doc xml:space="preserve">Asynchronously obtains a handle for a surface that can be passed
to other processes.
When the handle has been obtained, @callback will be called.
It is an error to call this function on a surface that is already
exported.
When the handle is no longer needed, [[email protected]_handle]
should be called to clean up resources.
The main purpose for obtaining a handle is to mark a surface
from another surface as transient for this one, see
[[email protected]_transient_for_exported].
Before 4.12, this API could not safely be used multiple times,
since there was no reference counting for handles. Starting with
4.12, every call to this function obtains a new handle, and every
call to [[email protected]_exported_handle] drops
just the handle that it is given.
Note that this API depends on an unstable Wayland protocol,
and thus may require changes in the future.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the handle has been requested, %FALSE if
an error occurred.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="toplevel" transfer-ownership="none">
<doc xml:space="preserve">the `GdkToplevel` to obtain a handle for</doc>
<type name="WaylandToplevel" c:type="GdkToplevel*"/>
</instance-parameter>
<parameter name="callback" transfer-ownership="none" scope="notified" closure="1" destroy="2">
<doc xml:space="preserve">callback to call with the handle</doc>
<type name="WaylandToplevelExported" c:type="GdkWaylandToplevelExported"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">user data for @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="destroy_func" transfer-ownership="none" scope="async">
<doc xml:space="preserve">destroy notify for @user_data</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<method name="set_application_id" c:identifier="gdk_wayland_toplevel_set_application_id">
<doc xml:space="preserve">Sets the application id on a `GdkToplevel`.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="toplevel" transfer-ownership="none">
<doc xml:space="preserve">a `GdkToplevel`</doc>
<type name="WaylandToplevel" c:type="GdkToplevel*"/>
</instance-parameter>
<parameter name="application_id" transfer-ownership="none">
<doc xml:space="preserve">the application id for the @toplevel</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_transient_for_exported" c:identifier="gdk_wayland_toplevel_set_transient_for_exported">
<doc xml:space="preserve">Marks @toplevel as transient for the surface to which the given
@parent_handle_str refers.
Typically, the handle will originate from a
[[email protected]_handle] call in another process.
Note that this API depends on an unstable Wayland protocol,
and thus may require changes in the future.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the surface has been marked as transient,
%FALSE if an error occurred.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="toplevel" transfer-ownership="none">
<doc xml:space="preserve">the `GdkToplevel` to make as transient</doc>
<type name="WaylandToplevel" c:type="GdkToplevel*"/>
</instance-parameter>
<parameter name="parent_handle_str" transfer-ownership="none">
<doc xml:space="preserve">an exported handle for a surface</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="unexport_handle" c:identifier="gdk_wayland_toplevel_unexport_handle" deprecated="1" deprecated-version="4.12">
<doc xml:space="preserve">Destroys the handle that was obtained with
gdk_wayland_toplevel_export_handle().
It is an error to call this function on a surface that
does not have a handle.
Since 4.12, this function does nothing. Use
[[email protected]_exported_handle] instead to drop a
handle that was obtained with [[email protected]_handle].
Note that this API depends on an unstable Wayland protocol,
and thus may require changes in the future.</doc>
<doc-deprecated xml:space="preserve">Use [[email protected]_exported_handle]
instead, this function does nothing</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="toplevel" transfer-ownership="none">
<doc xml:space="preserve">the `GdkToplevel` to unexport</doc>
<type name="WaylandToplevel" c:type="GdkToplevel*"/>
</instance-parameter>
</parameters>
</method>
</class>
<callback name="WaylandToplevelExported" c:type="GdkWaylandToplevelExported">
<doc xml:space="preserve">Callback that gets called when the handle for a surface has been
obtained from the Wayland compositor.
This callback is used in [[email protected]_handle].
The @handle can be passed to other processes, for the purpose of
marking surfaces as transient for out-of-process surfaces.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="toplevel" transfer-ownership="none">
<doc xml:space="preserve">the `GdkToplevel` that is exported</doc>
<type name="WaylandToplevel" c:type="GdkToplevel*"/>
</parameter>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">the handle</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" nullable="1" allow-none="1" closure="2">
<doc xml:space="preserve">user data that was passed to [[email protected]_handle]</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
</namespace>
</repository>