package wayland

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file wlr_layer_shell_unstable_v1_server.ml

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
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
(* This file was generated automatically by wayland-scanner-ocaml *)

[@@@ocaml.warning "-27"]
open struct
  module Imports = struct
    include Wlr_layer_shell_unstable_v1_proto
    include Wayland.Wayland_proto
    include Xdg_shell_proto
  end
  
  module Proxy = Wayland.Proxy
  module Msg = Wayland.Msg
  module Fixed = Wayland.Fixed
  module Iface_reg = Wayland.Iface_reg
  module S = Wayland.S
end


(** Create surfaces that are layers of the desktop.
    
    Clients can use this interface to assign the surface_layer role to
    wl_surfaces. Such surfaces are assigned to a "layer" of the output and
    rendered with a defined z-depth respective to each other. They may also be
    anchored to the edges and corners of a screen and specify input handling
    semantics. This interface should be suitable for the implementation of
    many desktop shell components, and a broad number of other applications
    that interact with the desktop. *)
module Zwlr_layer_shell_v1 = struct
  type 'v t = ([`Zwlr_layer_shell_v1], 'v, [`Server]) Proxy.t
  module Error = Wlr_layer_shell_unstable_v1_proto.Zwlr_layer_shell_v1.Error
  
  module Layer = Wlr_layer_shell_unstable_v1_proto.Zwlr_layer_shell_v1.Layer
  
  (** {2 Version 1, 2} *)
  
  
  (** {2 Version 3, 4, 5} *)
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Wlr_layer_shell_unstable_v1_proto.Zwlr_layer_shell_v1)
    method max_version = 5l
    
    method private virtual on_get_layer_surface : [> ] t -> ([`Zwlr_layer_surface_v1], 'v, [`Server]) Proxy.t ->
                                                  surface:([`Wl_surface], [> Imports.Wl_surface.versions], [`Server]) Proxy.t ->
                                                  output:([`Wl_output], [> Imports.Wl_output.versions], [`Server]) Proxy.t option ->
                                                  layer:Imports.Zwlr_layer_shell_v1.Layer.t -> namespace:string -> unit
    
    method private virtual on_destroy : [> ] t -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        let id : ([`Zwlr_layer_surface_v1], _, _) Proxy.t =
          Msg.get_int _msg |> Proxy.Handler.accept_new _proxy (module Imports.Zwlr_layer_surface_v1) in
        let surface : ([`Wl_surface], _, _) Proxy.t =
          let Proxy.Proxy p = Msg.get_int _msg |> Proxy.lookup_other _proxy in
          match Proxy.ty p with
          | Imports.Wl_surface.T -> p
          | _ -> Proxy.wrong_type ~parent:_proxy ~expected:"wl_surface" p
          in
        let output : ([`Wl_output], _, _) Proxy.t option =
          match Msg.get_int _msg with
          | 0l -> None
          | id ->
            let Proxy.Proxy p = Proxy.lookup_other _proxy id in
            match Proxy.ty p with
            | Imports.Wl_output.T -> Some p
            | _ -> Proxy.wrong_type ~parent:_proxy ~expected:"wl_output" p
          in
        let layer = Msg.get_int _msg |> Imports.Zwlr_layer_shell_v1.Layer.of_int32 in
        let namespace = Msg.get_string _msg in
        _self#on_get_layer_surface _proxy id ~surface ~output ~layer ~namespace
      | 1 ->
        Proxy.shutdown_recv _proxy;
        _self#on_destroy _proxy 
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1 | `V2 | `V3 | `V4 | `V5] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_get_layer_surface : [> `V1 | `V2 | `V3 | `V4 | `V5] t -> ([`Zwlr_layer_surface_v1], 'v, [`Server]) Proxy.t ->
                                                  surface:([`Wl_surface], [> Imports.Wl_surface.versions], [`Server]) Proxy.t ->
                                                  output:([`Wl_output], [> Imports.Wl_output.versions], [`Server]) Proxy.t option ->
                                                  layer:Imports.Zwlr_layer_shell_v1.Layer.t -> namespace:string -> unit
    
    (** Create a layer_surface from a surface.
        
        Create a layer surface for an existing surface. This assigns the role of
        layer_surface, or raises a protocol error if another role is already
        assigned.
        
        Creating a layer surface from a wl_surface which has a buffer attached
        or committed is a client error, and any attempts by a client to attach
        or manipulate a buffer prior to the first layer_surface.configure call
        must also be treated as errors.
        
        After creating a layer_surface object and setting it up, the client
        must perform an initial commit without any buffer attached.
        The compositor will reply with a layer_surface.configure event.
        The client must acknowledge it and is then allowed to attach a buffer
        to map the surface.
        
        You may pass NULL for output to allow the compositor to decide which
        output to use. Generally this will be the one that the user most
        recently interacted with.
        
        Clients can specify a namespace that defines the purpose of the layer
        surface. *)
    
    method private virtual on_destroy : [> `V3 | `V4 | `V5] t -> unit
    
    (** Destroy the layer_shell object.
        
        This request indicates that the client will not use the layer_shell
        object any more. Objects that have been created through this instance
        are not affected. *)
    
    method min_version = 1l
    method bind_version : [`V1] = `V1
  end
  
  (** Handler for a proxy with version >= 2. *)
  class virtual ['v] v2 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V2 | `V3 | `V4 | `V5] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_get_layer_surface : [> `V2 | `V3 | `V4 | `V5] t -> ([`Zwlr_layer_surface_v1], 'v, [`Server]) Proxy.t ->
                                                  surface:([`Wl_surface], [> Imports.Wl_surface.versions], [`Server]) Proxy.t ->
                                                  output:([`Wl_output], [> Imports.Wl_output.versions], [`Server]) Proxy.t option ->
                                                  layer:Imports.Zwlr_layer_shell_v1.Layer.t -> namespace:string -> unit
    
    (** Create a layer_surface from a surface.
        
        Create a layer surface for an existing surface. This assigns the role of
        layer_surface, or raises a protocol error if another role is already
        assigned.
        
        Creating a layer surface from a wl_surface which has a buffer attached
        or committed is a client error, and any attempts by a client to attach
        or manipulate a buffer prior to the first layer_surface.configure call
        must also be treated as errors.
        
        After creating a layer_surface object and setting it up, the client
        must perform an initial commit without any buffer attached.
        The compositor will reply with a layer_surface.configure event.
        The client must acknowledge it and is then allowed to attach a buffer
        to map the surface.
        
        You may pass NULL for output to allow the compositor to decide which
        output to use. Generally this will be the one that the user most
        recently interacted with.
        
        Clients can specify a namespace that defines the purpose of the layer
        surface. *)
    
    method private virtual on_destroy : [> `V3 | `V4 | `V5] t -> unit
    
    (** Destroy the layer_shell object.
        
        This request indicates that the client will not use the layer_shell
        object any more. Objects that have been created through this instance
        are not affected. *)
    
    method min_version = 2l
    method bind_version : [`V2] = `V2
  end
  
  (** Handler for a proxy with version >= 3. *)
  class virtual ['v] v3 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V3 | `V4 | `V5] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_get_layer_surface : [> `V3 | `V4 | `V5] t -> ([`Zwlr_layer_surface_v1], 'v, [`Server]) Proxy.t ->
                                                  surface:([`Wl_surface], [> Imports.Wl_surface.versions], [`Server]) Proxy.t ->
                                                  output:([`Wl_output], [> Imports.Wl_output.versions], [`Server]) Proxy.t option ->
                                                  layer:Imports.Zwlr_layer_shell_v1.Layer.t -> namespace:string -> unit
    
    (** Create a layer_surface from a surface.
        
        Create a layer surface for an existing surface. This assigns the role of
        layer_surface, or raises a protocol error if another role is already
        assigned.
        
        Creating a layer surface from a wl_surface which has a buffer attached
        or committed is a client error, and any attempts by a client to attach
        or manipulate a buffer prior to the first layer_surface.configure call
        must also be treated as errors.
        
        After creating a layer_surface object and setting it up, the client
        must perform an initial commit without any buffer attached.
        The compositor will reply with a layer_surface.configure event.
        The client must acknowledge it and is then allowed to attach a buffer
        to map the surface.
        
        You may pass NULL for output to allow the compositor to decide which
        output to use. Generally this will be the one that the user most
        recently interacted with.
        
        Clients can specify a namespace that defines the purpose of the layer
        surface. *)
    
    method private virtual on_destroy : [> `V3 | `V4 | `V5] t -> unit
    
    (** Destroy the layer_shell object.
        
        This request indicates that the client will not use the layer_shell
        object any more. Objects that have been created through this instance
        are not affected. *)
    
    method min_version = 3l
    method bind_version : [`V3] = `V3
  end
  
  (** Handler for a proxy with version >= 4. *)
  class virtual ['v] v4 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V4 | `V5] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_get_layer_surface : [> `V4 | `V5] t -> ([`Zwlr_layer_surface_v1], 'v, [`Server]) Proxy.t ->
                                                  surface:([`Wl_surface], [> Imports.Wl_surface.versions], [`Server]) Proxy.t ->
                                                  output:([`Wl_output], [> Imports.Wl_output.versions], [`Server]) Proxy.t option ->
                                                  layer:Imports.Zwlr_layer_shell_v1.Layer.t -> namespace:string -> unit
    
    (** Create a layer_surface from a surface.
        
        Create a layer surface for an existing surface. This assigns the role of
        layer_surface, or raises a protocol error if another role is already
        assigned.
        
        Creating a layer surface from a wl_surface which has a buffer attached
        or committed is a client error, and any attempts by a client to attach
        or manipulate a buffer prior to the first layer_surface.configure call
        must also be treated as errors.
        
        After creating a layer_surface object and setting it up, the client
        must perform an initial commit without any buffer attached.
        The compositor will reply with a layer_surface.configure event.
        The client must acknowledge it and is then allowed to attach a buffer
        to map the surface.
        
        You may pass NULL for output to allow the compositor to decide which
        output to use. Generally this will be the one that the user most
        recently interacted with.
        
        Clients can specify a namespace that defines the purpose of the layer
        surface. *)
    
    method private virtual on_destroy : [> `V4 | `V5] t -> unit
    
    (** Destroy the layer_shell object.
        
        This request indicates that the client will not use the layer_shell
        object any more. Objects that have been created through this instance
        are not affected. *)
    
    method min_version = 4l
    method bind_version : [`V4] = `V4
  end
  
  (** Handler for a proxy with version >= 5. *)
  class virtual ['v] v5 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V5] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_get_layer_surface : [> `V5] t -> ([`Zwlr_layer_surface_v1], 'v, [`Server]) Proxy.t ->
                                                  surface:([`Wl_surface], [> Imports.Wl_surface.versions], [`Server]) Proxy.t ->
                                                  output:([`Wl_output], [> Imports.Wl_output.versions], [`Server]) Proxy.t option ->
                                                  layer:Imports.Zwlr_layer_shell_v1.Layer.t -> namespace:string -> unit
    
    (** Create a layer_surface from a surface.
        
        Create a layer surface for an existing surface. This assigns the role of
        layer_surface, or raises a protocol error if another role is already
        assigned.
        
        Creating a layer surface from a wl_surface which has a buffer attached
        or committed is a client error, and any attempts by a client to attach
        or manipulate a buffer prior to the first layer_surface.configure call
        must also be treated as errors.
        
        After creating a layer_surface object and setting it up, the client
        must perform an initial commit without any buffer attached.
        The compositor will reply with a layer_surface.configure event.
        The client must acknowledge it and is then allowed to attach a buffer
        to map the surface.
        
        You may pass NULL for output to allow the compositor to decide which
        output to use. Generally this will be the one that the user most
        recently interacted with.
        
        Clients can specify a namespace that defines the purpose of the layer
        surface. *)
    
    method private virtual on_destroy : [> `V5] t -> unit
    
    (** Destroy the layer_shell object.
        
        This request indicates that the client will not use the layer_shell
        object any more. Objects that have been created through this instance
        are not affected. *)
    
    method min_version = 5l
    method bind_version : [`V5] = `V5
  end
end

(** Layer metadata interface.
    
    An interface that may be implemented by a wl_surface, for surfaces that
    are designed to be rendered as a layer of a stacked desktop-like
    environment.
    
    Layer surface state (layer, size, anchor, exclusive zone,
    margin, interactivity) is double-buffered, and will be applied at the
    time wl_surface.commit of the corresponding wl_surface is called.
    
    Attaching a null buffer to a layer surface unmaps it.
    
    Unmapping a layer_surface means that the surface cannot be shown by the
    compositor until it is explicitly mapped again. The layer_surface
    returns to the state it had right after layer_shell.get_layer_surface.
    The client can re-map the surface by performing a commit without any
    buffer attached, waiting for a configure event and handling it as usual. *)
module Zwlr_layer_surface_v1 = struct
  type 'v t = ([`Zwlr_layer_surface_v1], 'v, [`Server]) Proxy.t
  module Keyboard_interactivity = Wlr_layer_shell_unstable_v1_proto.Zwlr_layer_surface_v1.Keyboard_interactivity
  
  module Error = Wlr_layer_shell_unstable_v1_proto.Zwlr_layer_surface_v1.Error
  
  module Anchor = Wlr_layer_shell_unstable_v1_proto.Zwlr_layer_surface_v1.Anchor
  
  (** {2 Version 1} *)
  
  (** Surface should be closed.
      
      The closed event is sent by the compositor when the surface will no
      longer be shown. The output may have been destroyed or the user may
      have asked for it to be removed. Further changes to the surface will be
      ignored. The client should destroy the resource after receiving this
      event, and create a new surface if they so choose. *)
  let closed (_t:([< `V1 | `V2 | `V3 | `V4 | `V5] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:1 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg
  
  (** Suggest a surface change.
      
      The configure event asks the client to resize its surface.
      
      Clients should arrange their surface for the new states, and then send
      an ack_configure request with the serial sent in this configure event at
      some point before committing the new surface.
      
      The client is free to dismiss all but the last configure event it
      received.
      
      The width and height arguments specify the size of the window in
      surface-local coordinates.
      
      The size is a hint, in the sense that the client is free to ignore it if
      it doesn't resize, pick a smaller size (to satisfy aspect ratio or
      resize in steps of NxM pixels). If the client picks a smaller size and
      is anchored to two opposite anchors (e.g. 'top' and 'bottom'), the
      surface will be centered on this axis.
      
      If the width or height arguments are zero, it means the client should
      decide its own window dimension. *)
  let configure (_t:([< `V1 | `V2 | `V3 | `V4 | `V5] as 'v) t) ~serial ~width ~height =
    let _msg = Proxy.alloc _t ~op:0 ~ints:3 ~strings:[] ~arrays:[] in
    Msg.add_int _msg serial;
    Msg.add_int _msg width;
    Msg.add_int _msg height;
    Proxy.send _t _msg
  
  
  (** {2 Version 2, 3, 4} *)
  
  
  (** {2 Version 5} *)
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Wlr_layer_shell_unstable_v1_proto.Zwlr_layer_surface_v1)
    method max_version = 5l
    
    method private virtual on_set_size : [> ] t -> width:int32 -> height:int32 -> unit
    
    method private virtual on_set_anchor : [> ] t -> anchor:Imports.Zwlr_layer_surface_v1.Anchor.t -> unit
    
    method private virtual on_set_exclusive_zone : [> ] t -> zone:int32 -> unit
    
    method private virtual on_set_margin : [> ] t -> top:int32 -> right:int32 -> bottom:int32 -> left:int32 -> unit
    
    method private virtual on_set_keyboard_interactivity : [> ] t -> keyboard_interactivity:Imports.Zwlr_layer_surface_v1.Keyboard_interactivity.t ->
                                                           unit
    
    method private virtual on_get_popup : [> ] t -> popup:([`Xdg_popup], [> Imports.Xdg_popup.versions], [`Server]) Proxy.t ->
                                          unit
    
    method private virtual on_ack_configure : [> ] t -> serial:int32 -> unit
    
    method private virtual on_destroy : [> ] t -> unit
    
    method private virtual on_set_layer : [> ] t -> layer:Imports.Zwlr_layer_shell_v1.Layer.t -> unit
    
    method private virtual on_set_exclusive_edge : [> ] t -> edge:Imports.Zwlr_layer_surface_v1.Anchor.t -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        let width = Msg.get_int _msg in
        let height = Msg.get_int _msg in
        _self#on_set_size _proxy ~width ~height
      | 1 ->
        let anchor = Msg.get_int _msg |> Imports.Zwlr_layer_surface_v1.Anchor.of_int32 in
        _self#on_set_anchor _proxy ~anchor
      | 2 ->
        let zone = Msg.get_int _msg in
        _self#on_set_exclusive_zone _proxy ~zone
      | 3 ->
        let top = Msg.get_int _msg in
        let right = Msg.get_int _msg in
        let bottom = Msg.get_int _msg in
        let left = Msg.get_int _msg in
        _self#on_set_margin _proxy ~top ~right ~bottom ~left
      | 4 ->
        let keyboard_interactivity = Msg.get_int _msg |> Imports.Zwlr_layer_surface_v1.Keyboard_interactivity.of_int32 in
        _self#on_set_keyboard_interactivity _proxy ~keyboard_interactivity
      | 5 ->
        let popup : ([`Xdg_popup], _, _) Proxy.t =
          let Proxy.Proxy p = Msg.get_int _msg |> Proxy.lookup_other _proxy in
          match Proxy.ty p with
          | Imports.Xdg_popup.T -> p
          | _ -> Proxy.wrong_type ~parent:_proxy ~expected:"xdg_popup" p
          in
        _self#on_get_popup _proxy ~popup
      | 6 ->
        let serial = Msg.get_int _msg in
        _self#on_ack_configure _proxy ~serial
      | 7 ->
        Proxy.shutdown_recv _proxy;
        _self#on_destroy _proxy 
      | 8 ->
        let layer = Msg.get_int _msg |> Imports.Zwlr_layer_shell_v1.Layer.of_int32 in
        _self#on_set_layer _proxy ~layer
      | 9 ->
        let edge = Msg.get_int _msg |> Imports.Zwlr_layer_surface_v1.Anchor.of_int32 in
        _self#on_set_exclusive_edge _proxy ~edge
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1 | `V2 | `V3 | `V4 | `V5] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_set_size : [> `V1 | `V2 | `V3 | `V4 | `V5] t -> width:int32 -> height:int32 -> unit
    
    (** Sets the size of the surface.
        
        Sets the size of the surface in surface-local coordinates. The
        compositor will display the surface centered with respect to its
        anchors.
        
        If you pass 0 for either value, the compositor will assign it and
        inform you of the assignment in the configure event. You must set your
        anchor to opposite edges in the dimensions you omit; not doing so is a
        protocol error. Both values are 0 by default.
        
        Size is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_anchor : [> `V1 | `V2 | `V3 | `V4 | `V5] t -> anchor:Imports.Zwlr_layer_surface_v1.Anchor.t ->
                                           unit
    
    (** Configures the anchor point of the surface.
        
        Requests that the compositor anchor the surface to the specified edges
        and corners. If two orthogonal edges are specified (e.g. 'top' and
        'left'), then the anchor point will be the intersection of the edges
        (e.g. the top left corner of the output); otherwise the anchor point
        will be centered on that edge, or in the center if none is specified.
        
        Anchor is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_exclusive_zone : [> `V1 | `V2 | `V3 | `V4 | `V5] t -> zone:int32 -> unit
    
    (** Configures the exclusive geometry of this surface.
        
        Requests that the compositor avoids occluding an area with other
        surfaces. The compositor's use of this information is
        implementation-dependent - do not assume that this region will not
        actually be occluded.
        
        A positive value is only meaningful if the surface is anchored to one
        edge or an edge and both perpendicular edges. If the surface is not
        anchored, anchored to only two perpendicular edges (a corner), anchored
        to only two parallel edges or anchored to all edges, a positive value
        will be treated the same as zero.
        
        A positive zone is the distance from the edge in surface-local
        coordinates to consider exclusive.
        
        Surfaces that do not wish to have an exclusive zone may instead specify
        how they should interact with surfaces that do. If set to zero, the
        surface indicates that it would like to be moved to avoid occluding
        surfaces with a positive exclusive zone. If set to -1, the surface
        indicates that it would not like to be moved to accommodate for other
        surfaces, and the compositor should extend it all the way to the edges
        it is anchored to.
        
        For example, a panel might set its exclusive zone to 10, so that
        maximized shell surfaces are not shown on top of it. A notification
        might set its exclusive zone to 0, so that it is moved to avoid
        occluding the panel, but shell surfaces are shown underneath it. A
        wallpaper or lock screen might set their exclusive zone to -1, so that
        they stretch below or over the panel.
        
        The default value is 0.
        
        Exclusive zone is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_margin : [> `V1 | `V2 | `V3 | `V4 | `V5] t -> top:int32 -> right:int32 ->
                                           bottom:int32 -> left:int32 -> unit
    
    (** Sets a margin from the anchor point.
        
        Requests that the surface be placed some distance away from the anchor
        point on the output, in surface-local coordinates. Setting this value
        for edges you are not anchored to has no effect.
        
        The exclusive zone includes the margin.
        
        Margin is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_keyboard_interactivity : [> `V1 | `V2 | `V3 | `V4 | `V5] t -> keyboard_interactivity:Imports.Zwlr_layer_surface_v1.Keyboard_interactivity.t ->
                                                           unit
    
    (** Requests keyboard events.
        
        Set how keyboard events are delivered to this surface. By default,
        layer shell surfaces do not receive keyboard events; this request can
        be used to change this.
        
        This setting is inherited by child surfaces set by the get_popup
        request.
        
        Layer surfaces receive pointer, touch, and tablet events normally. If
        you do not want to receive them, set the input region on your surface
        to an empty region.
        
        Keyboard interactivity is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_get_popup : [> `V1 | `V2 | `V3 | `V4 | `V5] t -> popup:([`Xdg_popup], [> Imports.Xdg_popup.versions], [`Server]) Proxy.t ->
                                          unit
    
    (** Assign this layer_surface as an xdg_popup parent.
        
        This assigns an xdg_popup's parent to this layer_surface.  This popup
        should have been created via xdg_surface::get_popup with the parent set
        to NULL, and this request must be invoked before committing the popup's
        initial state.
        
        See the documentation of xdg_popup for more details about what an
        xdg_popup is and how it is used. *)
    
    method private virtual on_ack_configure : [> `V1 | `V2 | `V3 | `V4 | `V5] t -> serial:int32 -> unit
    
    (** Ack a configure event.
        
        When a configure event is received, if a client commits the
        surface in response to the configure event, then the client
        must make an ack_configure request sometime before the commit
        request, passing along the serial of the configure event.
        
        If the client receives multiple configure events before it
        can respond to one, it only has to ack the last configure event.
        
        A client is not required to commit immediately after sending
        an ack_configure request - it may even ack_configure several times
        before its next surface commit.
        
        A client may send multiple ack_configure requests before committing, but
        only the last request sent before a commit indicates which configure
        event the client really is responding to. *)
    
    method private virtual on_destroy : [> `V1 | `V2 | `V3 | `V4 | `V5] t -> unit
    
    (** Destroy the layer_surface.
        
        This request destroys the layer surface. *)
    
    method private virtual on_set_layer : [> `V2 | `V3 | `V4 | `V5] t -> layer:Imports.Zwlr_layer_shell_v1.Layer.t ->
                                          unit
    
    (** Change the layer of the surface.
        
        Change the layer that the surface is rendered on.
        
        Layer is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_exclusive_edge : [> `V5] t -> edge:Imports.Zwlr_layer_surface_v1.Anchor.t -> unit
    
    (** Set the edge the exclusive zone will be applied to.
        
        Requests an edge for the exclusive zone to apply. The exclusive
        edge will be automatically deduced from anchor points when possible,
        but when the surface is anchored to a corner, it will be necessary
        to set it explicitly to disambiguate, as it is not possible to deduce
        which one of the two corner edges should be used.
        
        The edge must be one the surface is anchored to, otherwise the
        invalid_exclusive_edge protocol error will be raised. *)
    
    method min_version = 1l
  end
  
  (** Handler for a proxy with version >= 2. *)
  class virtual ['v] v2 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V2 | `V3 | `V4 | `V5] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_set_size : [> `V2 | `V3 | `V4 | `V5] t -> width:int32 -> height:int32 -> unit
    
    (** Sets the size of the surface.
        
        Sets the size of the surface in surface-local coordinates. The
        compositor will display the surface centered with respect to its
        anchors.
        
        If you pass 0 for either value, the compositor will assign it and
        inform you of the assignment in the configure event. You must set your
        anchor to opposite edges in the dimensions you omit; not doing so is a
        protocol error. Both values are 0 by default.
        
        Size is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_anchor : [> `V2 | `V3 | `V4 | `V5] t -> anchor:Imports.Zwlr_layer_surface_v1.Anchor.t ->
                                           unit
    
    (** Configures the anchor point of the surface.
        
        Requests that the compositor anchor the surface to the specified edges
        and corners. If two orthogonal edges are specified (e.g. 'top' and
        'left'), then the anchor point will be the intersection of the edges
        (e.g. the top left corner of the output); otherwise the anchor point
        will be centered on that edge, or in the center if none is specified.
        
        Anchor is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_exclusive_zone : [> `V2 | `V3 | `V4 | `V5] t -> zone:int32 -> unit
    
    (** Configures the exclusive geometry of this surface.
        
        Requests that the compositor avoids occluding an area with other
        surfaces. The compositor's use of this information is
        implementation-dependent - do not assume that this region will not
        actually be occluded.
        
        A positive value is only meaningful if the surface is anchored to one
        edge or an edge and both perpendicular edges. If the surface is not
        anchored, anchored to only two perpendicular edges (a corner), anchored
        to only two parallel edges or anchored to all edges, a positive value
        will be treated the same as zero.
        
        A positive zone is the distance from the edge in surface-local
        coordinates to consider exclusive.
        
        Surfaces that do not wish to have an exclusive zone may instead specify
        how they should interact with surfaces that do. If set to zero, the
        surface indicates that it would like to be moved to avoid occluding
        surfaces with a positive exclusive zone. If set to -1, the surface
        indicates that it would not like to be moved to accommodate for other
        surfaces, and the compositor should extend it all the way to the edges
        it is anchored to.
        
        For example, a panel might set its exclusive zone to 10, so that
        maximized shell surfaces are not shown on top of it. A notification
        might set its exclusive zone to 0, so that it is moved to avoid
        occluding the panel, but shell surfaces are shown underneath it. A
        wallpaper or lock screen might set their exclusive zone to -1, so that
        they stretch below or over the panel.
        
        The default value is 0.
        
        Exclusive zone is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_margin : [> `V2 | `V3 | `V4 | `V5] t -> top:int32 -> right:int32 -> bottom:int32 ->
                                           left:int32 -> unit
    
    (** Sets a margin from the anchor point.
        
        Requests that the surface be placed some distance away from the anchor
        point on the output, in surface-local coordinates. Setting this value
        for edges you are not anchored to has no effect.
        
        The exclusive zone includes the margin.
        
        Margin is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_keyboard_interactivity : [> `V2 | `V3 | `V4 | `V5] t -> keyboard_interactivity:Imports.Zwlr_layer_surface_v1.Keyboard_interactivity.t ->
                                                           unit
    
    (** Requests keyboard events.
        
        Set how keyboard events are delivered to this surface. By default,
        layer shell surfaces do not receive keyboard events; this request can
        be used to change this.
        
        This setting is inherited by child surfaces set by the get_popup
        request.
        
        Layer surfaces receive pointer, touch, and tablet events normally. If
        you do not want to receive them, set the input region on your surface
        to an empty region.
        
        Keyboard interactivity is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_get_popup : [> `V2 | `V3 | `V4 | `V5] t -> popup:([`Xdg_popup], [> Imports.Xdg_popup.versions], [`Server]) Proxy.t ->
                                          unit
    
    (** Assign this layer_surface as an xdg_popup parent.
        
        This assigns an xdg_popup's parent to this layer_surface.  This popup
        should have been created via xdg_surface::get_popup with the parent set
        to NULL, and this request must be invoked before committing the popup's
        initial state.
        
        See the documentation of xdg_popup for more details about what an
        xdg_popup is and how it is used. *)
    
    method private virtual on_ack_configure : [> `V2 | `V3 | `V4 | `V5] t -> serial:int32 -> unit
    
    (** Ack a configure event.
        
        When a configure event is received, if a client commits the
        surface in response to the configure event, then the client
        must make an ack_configure request sometime before the commit
        request, passing along the serial of the configure event.
        
        If the client receives multiple configure events before it
        can respond to one, it only has to ack the last configure event.
        
        A client is not required to commit immediately after sending
        an ack_configure request - it may even ack_configure several times
        before its next surface commit.
        
        A client may send multiple ack_configure requests before committing, but
        only the last request sent before a commit indicates which configure
        event the client really is responding to. *)
    
    method private virtual on_destroy : [> `V2 | `V3 | `V4 | `V5] t -> unit
    
    (** Destroy the layer_surface.
        
        This request destroys the layer surface. *)
    
    method private virtual on_set_layer : [> `V2 | `V3 | `V4 | `V5] t -> layer:Imports.Zwlr_layer_shell_v1.Layer.t ->
                                          unit
    
    (** Change the layer of the surface.
        
        Change the layer that the surface is rendered on.
        
        Layer is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_exclusive_edge : [> `V5] t -> edge:Imports.Zwlr_layer_surface_v1.Anchor.t -> unit
    
    (** Set the edge the exclusive zone will be applied to.
        
        Requests an edge for the exclusive zone to apply. The exclusive
        edge will be automatically deduced from anchor points when possible,
        but when the surface is anchored to a corner, it will be necessary
        to set it explicitly to disambiguate, as it is not possible to deduce
        which one of the two corner edges should be used.
        
        The edge must be one the surface is anchored to, otherwise the
        invalid_exclusive_edge protocol error will be raised. *)
    
    method min_version = 2l
  end
  
  (** Handler for a proxy with version >= 3. *)
  class virtual ['v] v3 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V3 | `V4 | `V5] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_set_size : [> `V3 | `V4 | `V5] t -> width:int32 -> height:int32 -> unit
    
    (** Sets the size of the surface.
        
        Sets the size of the surface in surface-local coordinates. The
        compositor will display the surface centered with respect to its
        anchors.
        
        If you pass 0 for either value, the compositor will assign it and
        inform you of the assignment in the configure event. You must set your
        anchor to opposite edges in the dimensions you omit; not doing so is a
        protocol error. Both values are 0 by default.
        
        Size is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_anchor : [> `V3 | `V4 | `V5] t -> anchor:Imports.Zwlr_layer_surface_v1.Anchor.t ->
                                           unit
    
    (** Configures the anchor point of the surface.
        
        Requests that the compositor anchor the surface to the specified edges
        and corners. If two orthogonal edges are specified (e.g. 'top' and
        'left'), then the anchor point will be the intersection of the edges
        (e.g. the top left corner of the output); otherwise the anchor point
        will be centered on that edge, or in the center if none is specified.
        
        Anchor is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_exclusive_zone : [> `V3 | `V4 | `V5] t -> zone:int32 -> unit
    
    (** Configures the exclusive geometry of this surface.
        
        Requests that the compositor avoids occluding an area with other
        surfaces. The compositor's use of this information is
        implementation-dependent - do not assume that this region will not
        actually be occluded.
        
        A positive value is only meaningful if the surface is anchored to one
        edge or an edge and both perpendicular edges. If the surface is not
        anchored, anchored to only two perpendicular edges (a corner), anchored
        to only two parallel edges or anchored to all edges, a positive value
        will be treated the same as zero.
        
        A positive zone is the distance from the edge in surface-local
        coordinates to consider exclusive.
        
        Surfaces that do not wish to have an exclusive zone may instead specify
        how they should interact with surfaces that do. If set to zero, the
        surface indicates that it would like to be moved to avoid occluding
        surfaces with a positive exclusive zone. If set to -1, the surface
        indicates that it would not like to be moved to accommodate for other
        surfaces, and the compositor should extend it all the way to the edges
        it is anchored to.
        
        For example, a panel might set its exclusive zone to 10, so that
        maximized shell surfaces are not shown on top of it. A notification
        might set its exclusive zone to 0, so that it is moved to avoid
        occluding the panel, but shell surfaces are shown underneath it. A
        wallpaper or lock screen might set their exclusive zone to -1, so that
        they stretch below or over the panel.
        
        The default value is 0.
        
        Exclusive zone is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_margin : [> `V3 | `V4 | `V5] t -> top:int32 -> right:int32 -> bottom:int32 ->
                                           left:int32 -> unit
    
    (** Sets a margin from the anchor point.
        
        Requests that the surface be placed some distance away from the anchor
        point on the output, in surface-local coordinates. Setting this value
        for edges you are not anchored to has no effect.
        
        The exclusive zone includes the margin.
        
        Margin is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_keyboard_interactivity : [> `V3 | `V4 | `V5] t -> keyboard_interactivity:Imports.Zwlr_layer_surface_v1.Keyboard_interactivity.t ->
                                                           unit
    
    (** Requests keyboard events.
        
        Set how keyboard events are delivered to this surface. By default,
        layer shell surfaces do not receive keyboard events; this request can
        be used to change this.
        
        This setting is inherited by child surfaces set by the get_popup
        request.
        
        Layer surfaces receive pointer, touch, and tablet events normally. If
        you do not want to receive them, set the input region on your surface
        to an empty region.
        
        Keyboard interactivity is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_get_popup : [> `V3 | `V4 | `V5] t -> popup:([`Xdg_popup], [> Imports.Xdg_popup.versions], [`Server]) Proxy.t ->
                                          unit
    
    (** Assign this layer_surface as an xdg_popup parent.
        
        This assigns an xdg_popup's parent to this layer_surface.  This popup
        should have been created via xdg_surface::get_popup with the parent set
        to NULL, and this request must be invoked before committing the popup's
        initial state.
        
        See the documentation of xdg_popup for more details about what an
        xdg_popup is and how it is used. *)
    
    method private virtual on_ack_configure : [> `V3 | `V4 | `V5] t -> serial:int32 -> unit
    
    (** Ack a configure event.
        
        When a configure event is received, if a client commits the
        surface in response to the configure event, then the client
        must make an ack_configure request sometime before the commit
        request, passing along the serial of the configure event.
        
        If the client receives multiple configure events before it
        can respond to one, it only has to ack the last configure event.
        
        A client is not required to commit immediately after sending
        an ack_configure request - it may even ack_configure several times
        before its next surface commit.
        
        A client may send multiple ack_configure requests before committing, but
        only the last request sent before a commit indicates which configure
        event the client really is responding to. *)
    
    method private virtual on_destroy : [> `V3 | `V4 | `V5] t -> unit
    
    (** Destroy the layer_surface.
        
        This request destroys the layer surface. *)
    
    method private virtual on_set_layer : [> `V3 | `V4 | `V5] t -> layer:Imports.Zwlr_layer_shell_v1.Layer.t -> unit
    
    (** Change the layer of the surface.
        
        Change the layer that the surface is rendered on.
        
        Layer is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_exclusive_edge : [> `V5] t -> edge:Imports.Zwlr_layer_surface_v1.Anchor.t -> unit
    
    (** Set the edge the exclusive zone will be applied to.
        
        Requests an edge for the exclusive zone to apply. The exclusive
        edge will be automatically deduced from anchor points when possible,
        but when the surface is anchored to a corner, it will be necessary
        to set it explicitly to disambiguate, as it is not possible to deduce
        which one of the two corner edges should be used.
        
        The edge must be one the surface is anchored to, otherwise the
        invalid_exclusive_edge protocol error will be raised. *)
    
    method min_version = 3l
  end
  
  (** Handler for a proxy with version >= 4. *)
  class virtual ['v] v4 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V4 | `V5] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_set_size : [> `V4 | `V5] t -> width:int32 -> height:int32 -> unit
    
    (** Sets the size of the surface.
        
        Sets the size of the surface in surface-local coordinates. The
        compositor will display the surface centered with respect to its
        anchors.
        
        If you pass 0 for either value, the compositor will assign it and
        inform you of the assignment in the configure event. You must set your
        anchor to opposite edges in the dimensions you omit; not doing so is a
        protocol error. Both values are 0 by default.
        
        Size is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_anchor : [> `V4 | `V5] t -> anchor:Imports.Zwlr_layer_surface_v1.Anchor.t -> unit
    
    (** Configures the anchor point of the surface.
        
        Requests that the compositor anchor the surface to the specified edges
        and corners. If two orthogonal edges are specified (e.g. 'top' and
        'left'), then the anchor point will be the intersection of the edges
        (e.g. the top left corner of the output); otherwise the anchor point
        will be centered on that edge, or in the center if none is specified.
        
        Anchor is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_exclusive_zone : [> `V4 | `V5] t -> zone:int32 -> unit
    
    (** Configures the exclusive geometry of this surface.
        
        Requests that the compositor avoids occluding an area with other
        surfaces. The compositor's use of this information is
        implementation-dependent - do not assume that this region will not
        actually be occluded.
        
        A positive value is only meaningful if the surface is anchored to one
        edge or an edge and both perpendicular edges. If the surface is not
        anchored, anchored to only two perpendicular edges (a corner), anchored
        to only two parallel edges or anchored to all edges, a positive value
        will be treated the same as zero.
        
        A positive zone is the distance from the edge in surface-local
        coordinates to consider exclusive.
        
        Surfaces that do not wish to have an exclusive zone may instead specify
        how they should interact with surfaces that do. If set to zero, the
        surface indicates that it would like to be moved to avoid occluding
        surfaces with a positive exclusive zone. If set to -1, the surface
        indicates that it would not like to be moved to accommodate for other
        surfaces, and the compositor should extend it all the way to the edges
        it is anchored to.
        
        For example, a panel might set its exclusive zone to 10, so that
        maximized shell surfaces are not shown on top of it. A notification
        might set its exclusive zone to 0, so that it is moved to avoid
        occluding the panel, but shell surfaces are shown underneath it. A
        wallpaper or lock screen might set their exclusive zone to -1, so that
        they stretch below or over the panel.
        
        The default value is 0.
        
        Exclusive zone is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_margin : [> `V4 | `V5] t -> top:int32 -> right:int32 -> bottom:int32 -> left:int32 ->
                                           unit
    
    (** Sets a margin from the anchor point.
        
        Requests that the surface be placed some distance away from the anchor
        point on the output, in surface-local coordinates. Setting this value
        for edges you are not anchored to has no effect.
        
        The exclusive zone includes the margin.
        
        Margin is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_keyboard_interactivity : [> `V4 | `V5] t -> keyboard_interactivity:Imports.Zwlr_layer_surface_v1.Keyboard_interactivity.t ->
                                                           unit
    
    (** Requests keyboard events.
        
        Set how keyboard events are delivered to this surface. By default,
        layer shell surfaces do not receive keyboard events; this request can
        be used to change this.
        
        This setting is inherited by child surfaces set by the get_popup
        request.
        
        Layer surfaces receive pointer, touch, and tablet events normally. If
        you do not want to receive them, set the input region on your surface
        to an empty region.
        
        Keyboard interactivity is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_get_popup : [> `V4 | `V5] t -> popup:([`Xdg_popup], [> Imports.Xdg_popup.versions], [`Server]) Proxy.t ->
                                          unit
    
    (** Assign this layer_surface as an xdg_popup parent.
        
        This assigns an xdg_popup's parent to this layer_surface.  This popup
        should have been created via xdg_surface::get_popup with the parent set
        to NULL, and this request must be invoked before committing the popup's
        initial state.
        
        See the documentation of xdg_popup for more details about what an
        xdg_popup is and how it is used. *)
    
    method private virtual on_ack_configure : [> `V4 | `V5] t -> serial:int32 -> unit
    
    (** Ack a configure event.
        
        When a configure event is received, if a client commits the
        surface in response to the configure event, then the client
        must make an ack_configure request sometime before the commit
        request, passing along the serial of the configure event.
        
        If the client receives multiple configure events before it
        can respond to one, it only has to ack the last configure event.
        
        A client is not required to commit immediately after sending
        an ack_configure request - it may even ack_configure several times
        before its next surface commit.
        
        A client may send multiple ack_configure requests before committing, but
        only the last request sent before a commit indicates which configure
        event the client really is responding to. *)
    
    method private virtual on_destroy : [> `V4 | `V5] t -> unit
    
    (** Destroy the layer_surface.
        
        This request destroys the layer surface. *)
    
    method private virtual on_set_layer : [> `V4 | `V5] t -> layer:Imports.Zwlr_layer_shell_v1.Layer.t -> unit
    
    (** Change the layer of the surface.
        
        Change the layer that the surface is rendered on.
        
        Layer is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_exclusive_edge : [> `V5] t -> edge:Imports.Zwlr_layer_surface_v1.Anchor.t -> unit
    
    (** Set the edge the exclusive zone will be applied to.
        
        Requests an edge for the exclusive zone to apply. The exclusive
        edge will be automatically deduced from anchor points when possible,
        but when the surface is anchored to a corner, it will be necessary
        to set it explicitly to disambiguate, as it is not possible to deduce
        which one of the two corner edges should be used.
        
        The edge must be one the surface is anchored to, otherwise the
        invalid_exclusive_edge protocol error will be raised. *)
    
    method min_version = 4l
  end
  
  (** Handler for a proxy with version >= 5. *)
  class virtual ['v] v5 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V5] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_set_size : [> `V5] t -> width:int32 -> height:int32 -> unit
    
    (** Sets the size of the surface.
        
        Sets the size of the surface in surface-local coordinates. The
        compositor will display the surface centered with respect to its
        anchors.
        
        If you pass 0 for either value, the compositor will assign it and
        inform you of the assignment in the configure event. You must set your
        anchor to opposite edges in the dimensions you omit; not doing so is a
        protocol error. Both values are 0 by default.
        
        Size is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_anchor : [> `V5] t -> anchor:Imports.Zwlr_layer_surface_v1.Anchor.t -> unit
    
    (** Configures the anchor point of the surface.
        
        Requests that the compositor anchor the surface to the specified edges
        and corners. If two orthogonal edges are specified (e.g. 'top' and
        'left'), then the anchor point will be the intersection of the edges
        (e.g. the top left corner of the output); otherwise the anchor point
        will be centered on that edge, or in the center if none is specified.
        
        Anchor is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_exclusive_zone : [> `V5] t -> zone:int32 -> unit
    
    (** Configures the exclusive geometry of this surface.
        
        Requests that the compositor avoids occluding an area with other
        surfaces. The compositor's use of this information is
        implementation-dependent - do not assume that this region will not
        actually be occluded.
        
        A positive value is only meaningful if the surface is anchored to one
        edge or an edge and both perpendicular edges. If the surface is not
        anchored, anchored to only two perpendicular edges (a corner), anchored
        to only two parallel edges or anchored to all edges, a positive value
        will be treated the same as zero.
        
        A positive zone is the distance from the edge in surface-local
        coordinates to consider exclusive.
        
        Surfaces that do not wish to have an exclusive zone may instead specify
        how they should interact with surfaces that do. If set to zero, the
        surface indicates that it would like to be moved to avoid occluding
        surfaces with a positive exclusive zone. If set to -1, the surface
        indicates that it would not like to be moved to accommodate for other
        surfaces, and the compositor should extend it all the way to the edges
        it is anchored to.
        
        For example, a panel might set its exclusive zone to 10, so that
        maximized shell surfaces are not shown on top of it. A notification
        might set its exclusive zone to 0, so that it is moved to avoid
        occluding the panel, but shell surfaces are shown underneath it. A
        wallpaper or lock screen might set their exclusive zone to -1, so that
        they stretch below or over the panel.
        
        The default value is 0.
        
        Exclusive zone is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_margin : [> `V5] t -> top:int32 -> right:int32 -> bottom:int32 -> left:int32 -> unit
    
    (** Sets a margin from the anchor point.
        
        Requests that the surface be placed some distance away from the anchor
        point on the output, in surface-local coordinates. Setting this value
        for edges you are not anchored to has no effect.
        
        The exclusive zone includes the margin.
        
        Margin is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_keyboard_interactivity : [> `V5] t -> keyboard_interactivity:Imports.Zwlr_layer_surface_v1.Keyboard_interactivity.t ->
                                                           unit
    
    (** Requests keyboard events.
        
        Set how keyboard events are delivered to this surface. By default,
        layer shell surfaces do not receive keyboard events; this request can
        be used to change this.
        
        This setting is inherited by child surfaces set by the get_popup
        request.
        
        Layer surfaces receive pointer, touch, and tablet events normally. If
        you do not want to receive them, set the input region on your surface
        to an empty region.
        
        Keyboard interactivity is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_get_popup : [> `V5] t -> popup:([`Xdg_popup], [> Imports.Xdg_popup.versions], [`Server]) Proxy.t ->
                                          unit
    
    (** Assign this layer_surface as an xdg_popup parent.
        
        This assigns an xdg_popup's parent to this layer_surface.  This popup
        should have been created via xdg_surface::get_popup with the parent set
        to NULL, and this request must be invoked before committing the popup's
        initial state.
        
        See the documentation of xdg_popup for more details about what an
        xdg_popup is and how it is used. *)
    
    method private virtual on_ack_configure : [> `V5] t -> serial:int32 -> unit
    
    (** Ack a configure event.
        
        When a configure event is received, if a client commits the
        surface in response to the configure event, then the client
        must make an ack_configure request sometime before the commit
        request, passing along the serial of the configure event.
        
        If the client receives multiple configure events before it
        can respond to one, it only has to ack the last configure event.
        
        A client is not required to commit immediately after sending
        an ack_configure request - it may even ack_configure several times
        before its next surface commit.
        
        A client may send multiple ack_configure requests before committing, but
        only the last request sent before a commit indicates which configure
        event the client really is responding to. *)
    
    method private virtual on_destroy : [> `V5] t -> unit
    
    (** Destroy the layer_surface.
        
        This request destroys the layer surface. *)
    
    method private virtual on_set_layer : [> `V5] t -> layer:Imports.Zwlr_layer_shell_v1.Layer.t -> unit
    
    (** Change the layer of the surface.
        
        Change the layer that the surface is rendered on.
        
        Layer is double-buffered, see wl_surface.commit. *)
    
    method private virtual on_set_exclusive_edge : [> `V5] t -> edge:Imports.Zwlr_layer_surface_v1.Anchor.t -> unit
    
    (** Set the edge the exclusive zone will be applied to.
        
        Requests an edge for the exclusive zone to apply. The exclusive
        edge will be automatically deduced from anchor points when possible,
        but when the surface is anchored to a corner, it will be necessary
        to set it explicitly to disambiguate, as it is not possible to deduce
        which one of the two corner edges should be used.
        
        The edge must be one the surface is anchored to, otherwise the
        invalid_exclusive_edge protocol error will be raised. *)
    
    method min_version = 5l
  end
end
OCaml

Innovation. Community. Security.