This repository has been archived by the owner on Dec 9, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathGtkLayerShell-0.1.gir
704 lines (693 loc) · 31.3 KB
/
GtkLayerShell-0.1.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
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
<?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 version="1.2"
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">
<include name="Gtk" version="3.0"/>
<package name="gtk-layer-shell-0"/>
<c:include name="gtk-layer-shell/gtk-layer-shell.h"/>
<namespace name="GtkLayerShell"
version="0.1"
shared-library="libgtk-layer-shell.so.0"
c:identifier-prefixes="GtkLayerShell"
c:symbol-prefixes="gtk_layer">
<enumeration name="Edge" c:type="GtkLayerShellEdge">
<source-position filename="include/gtk-layer-shell.h" line="72"/>
<member name="left" value="0" c:identifier="GTK_LAYER_SHELL_EDGE_LEFT">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="59">The left edge of the screen.</doc>
</member>
<member name="right" value="1" c:identifier="GTK_LAYER_SHELL_EDGE_RIGHT">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="60">The right edge of the screen.</doc>
</member>
<member name="top" value="2" c:identifier="GTK_LAYER_SHELL_EDGE_TOP">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="61">The top edge of the screen.</doc>
</member>
<member name="bottom"
value="3"
c:identifier="GTK_LAYER_SHELL_EDGE_BOTTOM">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="62">The bottom edge of the screen.</doc>
</member>
<member name="entry_number"
value="4"
c:identifier="GTK_LAYER_SHELL_EDGE_ENTRY_NUMBER">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="63">Should not be used except to get the number of entries. (NOTE: may change in
future releases as more entries are added)</doc>
</member>
</enumeration>
<enumeration name="KeyboardMode" c:type="GtkLayerShellKeyboardMode">
<source-position filename="include/gtk-layer-shell.h" line="88"/>
<member name="none"
value="0"
c:identifier="GTK_LAYER_SHELL_KEYBOARD_MODE_NONE">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="76">This window should not receive keyboard events.</doc>
</member>
<member name="exclusive"
value="1"
c:identifier="GTK_LAYER_SHELL_KEYBOARD_MODE_EXCLUSIVE">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="77">This window should have exclusive focus if it is on the top or overlay layer.</doc>
</member>
<member name="on_demand"
value="2"
c:identifier="GTK_LAYER_SHELL_KEYBOARD_MODE_ON_DEMAND">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="78">The user should be able to focus and unfocues this window in an implementation
defined way. Not supported for protocol version < 4.</doc>
</member>
<member name="entry_number"
value="3"
c:identifier="GTK_LAYER_SHELL_KEYBOARD_MODE_ENTRY_NUMBER">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="80">Should not be used except to get the number of entries. (NOTE: may change in
future releases as more entries are added)</doc>
</member>
</enumeration>
<enumeration name="Layer" c:type="GtkLayerShellLayer">
<source-position filename="include/gtk-layer-shell.h" line="55"/>
<member name="background"
value="0"
c:identifier="GTK_LAYER_SHELL_LAYER_BACKGROUND">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="42">The background layer.</doc>
</member>
<member name="bottom"
value="1"
c:identifier="GTK_LAYER_SHELL_LAYER_BOTTOM">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="43">The bottom layer.</doc>
</member>
<member name="top" value="2" c:identifier="GTK_LAYER_SHELL_LAYER_TOP">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="44">The top layer.</doc>
</member>
<member name="overlay"
value="3"
c:identifier="GTK_LAYER_SHELL_LAYER_OVERLAY">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="45">The overlay layer.</doc>
</member>
<member name="entry_number"
value="4"
c:identifier="GTK_LAYER_SHELL_LAYER_ENTRY_NUMBER">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="46">Should not be used except to get the number of entries. (NOTE: may change in
future releases as more entries are added)</doc>
</member>
</enumeration>
<function name="auto_exclusive_zone_enable"
c:identifier="gtk_layer_auto_exclusive_zone_enable">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="319">When auto exclusive zone is enabled, exclusive zone is automatically set to the
size of the @window + relevant margin. To disable auto exclusive zone, just set the
exclusive zone to 0 or any other fixed value.
NOTE: you can control the auto exclusive zone by changing the margin on the non-anchored
edge. This behavior is specific to gtk-layer-shell and not part of the underlying protocol</doc>
<source-position filename="include/gtk-layer-shell.h" line="330"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="321">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
</parameters>
</function>
<function name="auto_exclusive_zone_is_enabled"
c:identifier="gtk_layer_auto_exclusive_zone_is_enabled"
version="0.5">
<source-position filename="include/gtk-layer-shell.h" line="340"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="336">if the surface's exclusive zone is set to change based on the window's size</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="334">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
</parameters>
</function>
<function name="get_anchor"
c:identifier="gtk_layer_get_anchor"
version="0.5">
<source-position filename="include/gtk-layer-shell.h" line="270"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="266">if this surface is anchored to the given edge.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="264">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
<parameter name="edge" transfer-ownership="none">
<type name="Edge" c:type="GtkLayerShellEdge"/>
</parameter>
</parameters>
</function>
<function name="get_exclusive_zone"
c:identifier="gtk_layer_get_exclusive_zone"
version="0.5">
<source-position filename="include/gtk-layer-shell.h" line="317"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="313">the window's exclusive zone (which may have been set manually or automatically)</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="311">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
</parameters>
</function>
<function name="get_keyboard_interactivity"
c:identifier="gtk_layer_get_keyboard_interactivity"
version="0.5"
deprecated="1"
deprecated-version="0.6">
<doc-deprecated xml:space="preserve">Use gtk_layer_get_keyboard_mode () instead.</doc-deprecated>
<source-position filename="include/gtk-layer-shell.h" line="388"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="383">if keyboard interactivity is enabled</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="381">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
</parameters>
</function>
<function name="get_keyboard_mode"
c:identifier="gtk_layer_get_keyboard_mode"
version="0.6">
<source-position filename="include/gtk-layer-shell.h" line="364"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="360">current keyboard interactivity mode for @window.</doc>
<type name="KeyboardMode" c:type="GtkLayerShellKeyboardMode"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="358">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
</parameters>
</function>
<function name="get_layer"
c:identifier="gtk_layer_get_layer"
version="0.5">
<source-position filename="include/gtk-layer-shell.h" line="221"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="217">the current layer.</doc>
<type name="Layer" c:type="GtkLayerShellLayer"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="215">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
</parameters>
</function>
<function name="get_major_version"
c:identifier="gtk_layer_get_major_version"
version="0.4">
<source-position filename="include/gtk-layer-shell.h" line="97"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="93">the major version number of the GTK Layer Shell library</doc>
<type name="guint" c:type="guint"/>
</return-value>
</function>
<function name="get_margin"
c:identifier="gtk_layer_get_margin"
version="0.5">
<source-position filename="include/gtk-layer-shell.h" line="293"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="289">the size of the margin for the given edge.</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="287">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
<parameter name="edge" transfer-ownership="none">
<type name="Edge" c:type="GtkLayerShellEdge"/>
</parameter>
</parameters>
</function>
<function name="get_micro_version"
c:identifier="gtk_layer_get_micro_version"
version="0.4">
<source-position filename="include/gtk-layer-shell.h" line="115"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="111">the micro/patch version number of the GTK Layer Shell library</doc>
<type name="guint" c:type="guint"/>
</return-value>
</function>
<function name="get_minor_version"
c:identifier="gtk_layer_get_minor_version"
version="0.4">
<source-position filename="include/gtk-layer-shell.h" line="106"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="102">the minor version number of the GTK Layer Shell library</doc>
<type name="guint" c:type="guint"/>
</return-value>
</function>
<function name="get_monitor"
c:identifier="gtk_layer_get_monitor"
version="0.5">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="235">NOTE: To get which monitor the surface is actually on, use
gdk_display_get_monitor_at_window().</doc>
<source-position filename="include/gtk-layer-shell.h" line="246"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="242">the monitor this surface will/has requested to be on, can be %NULL.</doc>
<type name="Gdk.Monitor" c:type="GdkMonitor*"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="237">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
</parameters>
</function>
<function name="get_namespace"
c:identifier="gtk_layer_get_namespace"
version="0.5">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="186">NOTE: this function does not return ownership of the string. Do not free the returned string.
Future calls into the library may invalidate the returned string.</doc>
<source-position filename="include/gtk-layer-shell.h" line="198"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="193">a reference to the namespace property. If namespace is unset, returns the
default namespace ("gtk-layer-shell"). Never returns %NULL.</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="188">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
</parameters>
</function>
<function name="get_protocol_version"
c:identifier="gtk_layer_get_protocol_version"
version="0.6">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="129">May block for a Wayland roundtrip the first time it's called.</doc>
<source-position filename="include/gtk-layer-shell.h" line="139"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="134">version of the zwlr_layer_shell_v1 protocol supported by the
compositor or 0 if the protocol is not supported.</doc>
<type name="guint" c:type="guint"/>
</return-value>
</function>
<function name="get_zwlr_layer_surface_v1"
c:identifier="gtk_layer_get_zwlr_layer_surface_v1"
version="0.4">
<source-position filename="include/gtk-layer-shell.h" line="168"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="164">The underlying layer surface Wayland object</doc>
<type name="gpointer" c:type="zwlr_layer_surface_v1*"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="162">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
</parameters>
</function>
<docsection name="gtk-layer-shell">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="17">There is also a [version of this library compatible with GTK4](https://github.com/wmww/gtk4-layer-shell/)
# Forcing Window Size
If you wish to force your layer surface window to be a different size than it
is by default:
|[<!-- language="C" -->
gtk_widget_set_size_request (GTK_WIDGET (layer_gtk_window), width, height);
// force the window to resize to the new request
gtk_window_resize (layer_gtk_window, 1, 1);
]|
If width or height is -1, the default is used for that axis. If the window is
anchored to opposite edges of the output (see gtk_layer_set_anchor ()), the
size request is ignored. If you later wish to use the default window size,
simply repeat the two calls but with both width and height as -1.</doc>
</docsection>
<function name="init_for_window" c:identifier="gtk_layer_init_for_window">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="141">Set the @window up to be a layer surface once it is mapped. this must be called before
the @window is realized.</doc>
<source-position filename="include/gtk-layer-shell.h" line="148"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="143">A #GtkWindow to be turned into a layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
</parameters>
</function>
<function name="is_layer_window"
c:identifier="gtk_layer_is_layer_window"
version="0.5">
<source-position filename="include/gtk-layer-shell.h" line="158"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="154">if @window has been initialized as a layer surface.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="152">A #GtkWindow that may or may not have a layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
</parameters>
</function>
<function name="is_supported"
c:identifier="gtk_layer_is_supported"
version="0.5">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="117">May block for a Wayland roundtrip the first time it's called.</doc>
<source-position filename="include/gtk-layer-shell.h" line="127"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="122">%TRUE if the platform is Wayland and Wayland compositor supports the
zwlr_layer_shell_v1 protocol.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
</function>
<function name="set_anchor" c:identifier="gtk_layer_set_anchor">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="248">Set whether @window should be anchored to @edge.
- If two perpendicular edges are anchored, the surface with be anchored to that corner
- If two opposite edges are anchored, the window will be stretched across the screen in that direction
Default is %FALSE for each #GtkLayerShellEdge</doc>
<source-position filename="include/gtk-layer-shell.h" line="260"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="250">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
<parameter name="edge" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="251">A #GtkLayerShellEdge this layer surface may be anchored to.</doc>
<type name="Edge" c:type="GtkLayerShellEdge"/>
</parameter>
<parameter name="anchor_to_edge" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="252">Whether or not to anchor this layer surface to @edge.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="set_exclusive_zone"
c:identifier="gtk_layer_set_exclusive_zone">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="295">Has no effect unless the surface is anchored to an edge. Requests that the compositor
does not place other surfaces within the given exclusive zone of the anchored edge.
For example, a panel can request to not be covered by maximized windows. See
wlr-layer-shell-unstable-v1.xml for details.
Default is 0</doc>
<source-position filename="include/gtk-layer-shell.h" line="307"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="297">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
<parameter name="exclusive_zone" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="298">The size of the exclusive zone.</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="set_keyboard_interactivity"
c:identifier="gtk_layer_set_keyboard_interactivity"
deprecated="1"
deprecated-version="0.6">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="366">Whether the @window should receive keyboard events from the compositor.
Default is %FALSE</doc>
<doc-deprecated xml:space="preserve">Use gtk_layer_set_keyboard_mode () instead.</doc-deprecated>
<source-position filename="include/gtk-layer-shell.h" line="377"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="368">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
<parameter name="interactivity" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="369">Whether the layer surface should receive keyboard events.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="set_keyboard_mode"
c:identifier="gtk_layer_set_keyboard_mode"
version="0.6">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="342">Sets if/when @window should receive keyboard events from the compositor, see
GtkLayerShellKeyboardMode for details.
Default is %GTK_LAYER_SHELL_KEYBOARD_MODE_NONE</doc>
<source-position filename="include/gtk-layer-shell.h" line="354"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="344">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
<parameter name="mode" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="345">The type of keyboard interactivity requested.</doc>
<type name="KeyboardMode" c:type="GtkLayerShellKeyboardMode"/>
</parameter>
</parameters>
</function>
<function name="set_layer" c:identifier="gtk_layer_set_layer">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="200">Set the "layer" on which the surface appears (controls if it is over top of or below other surfaces). The layer may
be changed on-the-fly in the current version of the layer shell protocol, but on compositors that only support an
older version the @window is remapped so the change can take effect.
Default is %GTK_LAYER_SHELL_LAYER_TOP</doc>
<source-position filename="include/gtk-layer-shell.h" line="211"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="202">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
<parameter name="layer" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="203">The layer on which this surface appears.</doc>
<type name="Layer" c:type="GtkLayerShellLayer"/>
</parameter>
</parameters>
</function>
<function name="set_margin" c:identifier="gtk_layer_set_margin">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="272">Set the margin for a specific @edge of a @window. Effects both surface's distance from
the edge and its exclusive zone size (if auto exclusive zone enabled).
Default is 0 for each #GtkLayerShellEdge</doc>
<source-position filename="include/gtk-layer-shell.h" line="283"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="274">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
<parameter name="edge" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="275">The #GtkLayerShellEdge for which to set the margin.</doc>
<type name="Edge" c:type="GtkLayerShellEdge"/>
</parameter>
<parameter name="margin_size" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="276">The margin for @edge to be set.</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="set_monitor" c:identifier="gtk_layer_set_monitor">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="223">Set the output for the window to be placed on, or %NULL to let the compositor choose.
If the window is currently mapped, it will get remapped so the change can take effect.
Default is %NULL</doc>
<source-position filename="include/gtk-layer-shell.h" line="233"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="225">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
<parameter name="monitor" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="226">The output this layer surface will be placed on (%NULL to let the compositor decide).</doc>
<type name="Gdk.Monitor" c:type="GdkMonitor*"/>
</parameter>
</parameters>
</function>
<function name="set_namespace" c:identifier="gtk_layer_set_namespace">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="170">Set the "namespace" of the surface.
No one is quite sure what this is for, but it probably should be something generic
("panel", "osk", etc). The @name_space string is copied, and caller maintains
ownership of original. If the window is currently mapped, it will get remapped so
the change can take effect.
Default is "gtk-layer-shell" (which will be used if set to %NULL)</doc>
<source-position filename="include/gtk-layer-shell.h" line="184"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="window" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="172">A layer surface.</doc>
<type name="Gtk.Window" c:type="GtkWindow*"/>
</parameter>
<parameter name="name_space" transfer-ownership="none">
<doc xml:space="preserve"
filename="include/gtk-layer-shell.h"
line="173">The namespace of this layer surface.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
</namespace>
</repository>