Source file river_xkb_bindings_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
[@@@ocaml.warning "-27-34"]
open struct
module Imports = struct
include River_xkb_bindings_v1_proto
include River_window_management_v1_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
(** Xkbcommon bindings global interface.
This global interface should only be advertised to the client if the
river_window_manager_v1 global is also advertised. *)
module River_xkb_bindings_v1 = struct
type 'v t = ([`River_xkb_bindings_v1], 'v, [`Server]) Proxy.t
module Error = River_xkb_bindings_v1_proto.River_xkb_bindings_v1.Error
(** {2 Version 1} *)
(** {2 Version 2, 3} *)
(**/**)
class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
method user_data = S.No_data
method metadata = (module River_xkb_bindings_v1_proto.River_xkb_bindings_v1)
method max_version = 3l
method private virtual on_destroy : [> ] t -> unit
method private virtual on_get_xkb_binding : [> ] t -> seat:([`River_seat_v1], [> Imports.River_seat_v1.versions], [`Server]) Proxy.t ->
([`River_xkb_binding_v1], 'v, [`Server]) Proxy.t -> keysym:int32 ->
modifiers:Imports.River_seat_v1.Modifiers.t -> unit
method private virtual on_get_seat : [> ] t -> ([`River_xkb_bindings_seat_v1], 'v, [`Server]) Proxy.t ->
seat:([`River_seat_v1], [> Imports.River_seat_v1.versions], [`Server]) Proxy.t ->
unit
method dispatch (_proxy : 'v t) _msg =
let _proxy = Proxy.cast_version _proxy in
match Msg.op _msg with
| 0 ->
Proxy.shutdown_recv _proxy;
_self#on_destroy _proxy
| 1 ->
let seat : ([`River_seat_v1], _, _) Proxy.t =
let Proxy.Proxy p = Msg.get_int _msg |> Proxy.lookup_other _proxy in
match Proxy.ty p with
| Imports.River_seat_v1.T -> p
| _ -> Proxy.wrong_type ~parent:_proxy ~expected:"river_seat_v1" p
in
let id : ([`River_xkb_binding_v1], _, _) Proxy.t =
Msg.get_int _msg |> Proxy.Handler.accept_new _proxy (module Imports.River_xkb_binding_v1) in
let keysym = Msg.get_int _msg in
let modifiers = Msg.get_int _msg |> Imports.River_seat_v1.Modifiers.of_int32 in
_self#on_get_xkb_binding _proxy ~seat id ~keysym ~modifiers
| 2 ->
let id : ([`River_xkb_bindings_seat_v1], _, _) Proxy.t =
Msg.get_int _msg |> Proxy.Handler.accept_new _proxy (module Imports.River_xkb_bindings_seat_v1) in
let seat : ([`River_seat_v1], _, _) Proxy.t =
let Proxy.Proxy p = Msg.get_int _msg |> Proxy.lookup_other _proxy in
match Proxy.ty p with
| Imports.River_seat_v1.T -> p
| _ -> Proxy.wrong_type ~parent:_proxy ~expected:"river_seat_v1" p
in
_self#on_get_seat _proxy id ~seat
| _ -> 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] as 'v] _handlers_unsafe
(**/**)
method private virtual on_destroy : [> `V1 | `V2 | `V3] t -> unit
(** Destroy the river_xkb_bindings_v1 object.
This request indicates that the client will no longer use the
river_xkb_bindings_v1 object. *)
method private virtual on_get_xkb_binding : [> `V1 | `V2 | `V3] t -> seat:([`River_seat_v1], [> Imports.River_seat_v1.versions], [`Server]) Proxy.t ->
([`River_xkb_binding_v1], 'v, [`Server]) Proxy.t -> keysym:int32 ->
modifiers:Imports.River_seat_v1.Modifiers.t -> unit
(** Define a new xkbcommon key binding.
Define a key binding for the given seat in terms of an xkbcommon keysym
and other configurable properties.
The new key binding is not enabled until initial configuration is
completed and the enable request is made during a manage sequence. *)
method private virtual on_get_seat : [> `V2 | `V3] t -> ([`River_xkb_bindings_seat_v1], 'v, [`Server]) Proxy.t ->
seat:([`River_seat_v1], [> Imports.River_seat_v1.versions], [`Server]) Proxy.t ->
unit
(** Manage seat-specific state.
Create an object to manage seat-specific xkb bindings state.
It is a protocol error to make this request more than once for a given
river_seat_v1 object. *)
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] as 'v] _handlers_unsafe
(**/**)
method private virtual on_destroy : [> `V2 | `V3] t -> unit
(** Destroy the river_xkb_bindings_v1 object.
This request indicates that the client will no longer use the
river_xkb_bindings_v1 object. *)
method private virtual on_get_xkb_binding : [> `V2 | `V3] t -> seat:([`River_seat_v1], [> Imports.River_seat_v1.versions], [`Server]) Proxy.t ->
([`River_xkb_binding_v1], 'v, [`Server]) Proxy.t -> keysym:int32 ->
modifiers:Imports.River_seat_v1.Modifiers.t -> unit
(** Define a new xkbcommon key binding.
Define a key binding for the given seat in terms of an xkbcommon keysym
and other configurable properties.
The new key binding is not enabled until initial configuration is
completed and the enable request is made during a manage sequence. *)
method private virtual on_get_seat : [> `V2 | `V3] t -> ([`River_xkb_bindings_seat_v1], 'v, [`Server]) Proxy.t ->
seat:([`River_seat_v1], [> Imports.River_seat_v1.versions], [`Server]) Proxy.t ->
unit
(** Manage seat-specific state.
Create an object to manage seat-specific xkb bindings state.
It is a protocol error to make this request more than once for a given
river_seat_v1 object. *)
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] as 'v] _handlers_unsafe
(**/**)
method private virtual on_destroy : [> `V3] t -> unit
(** Destroy the river_xkb_bindings_v1 object.
This request indicates that the client will no longer use the
river_xkb_bindings_v1 object. *)
method private virtual on_get_xkb_binding : [> `V3] t -> seat:([`River_seat_v1], [> Imports.River_seat_v1.versions], [`Server]) Proxy.t ->
([`River_xkb_binding_v1], 'v, [`Server]) Proxy.t -> keysym:int32 ->
modifiers:Imports.River_seat_v1.Modifiers.t -> unit
(** Define a new xkbcommon key binding.
Define a key binding for the given seat in terms of an xkbcommon keysym
and other configurable properties.
The new key binding is not enabled until initial configuration is
completed and the enable request is made during a manage sequence. *)
method private virtual on_get_seat : [> `V3] t -> ([`River_xkb_bindings_seat_v1], 'v, [`Server]) Proxy.t ->
seat:([`River_seat_v1], [> Imports.River_seat_v1.versions], [`Server]) Proxy.t ->
unit
(** Manage seat-specific state.
Create an object to manage seat-specific xkb bindings state.
It is a protocol error to make this request more than once for a given
river_seat_v1 object. *)
method min_version = 3l
method bind_version : [`V3] = `V3
end
end
(** Configure a xkb key binding, receive trigger events.
This object allows the window manager to configure a xkbcommon key binding
and receive events when the key binding is triggered.
The new key binding is not enabled until the enable request is made during
a manage sequence.
Normally, all key events are sent to the surface with keyboard focus by
the compositor. Key events that trigger a key binding are not sent to the
surface with keyboard focus.
If multiple key bindings would be triggered by a single physical key event
on the compositor side, it is compositor policy which key binding(s) will
receive press/release events or if all of the matched key bindings receive
press/release events.
Key bindings might be matched by the same physical key event due to shared
keysym and modifiers. The layout override feature may also cause the same
physical key event to trigger two key bindings with different keysyms and
different layout overrides configured. *)
module River_xkb_binding_v1 = struct
type 'v t = ([`River_xkb_binding_v1], 'v, [`Server]) Proxy.t
(** {2 Version 1} *)
(** The key triggering the binding has been released.
This event indicates that the physical key triggering the binding has
been released.
Releasing the modifiers for the binding without releasing the "main"
physical key that produces the bound keysym does not trigger the release
event. This event is sent when the "main" key is released, even if the
modifiers have changed since the pressed event.
This event will be followed by a manage_start event after all other new
state has been sent by the server.
The compositor should wait for the manage sequence to complete before
processing further input events. This allows the window manager client
to, for example, modify key bindings and keyboard focus without racing
against future input events. The window manager should of course respond
as soon as possible as the capacity of the compositor to buffer incoming
input events is finite. *)
let released (_t:([< `V1 | `V2 | `V3] as 'v) t) =
let _msg = Proxy.alloc _t ~op:1 ~ints:0 ~strings:[] ~arrays:[] in
Proxy.send _t _msg
(** The key triggering the binding has been pressed.
This event indicates that the physical key triggering the binding has
been pressed.
This event will be followed by a manage_start event after all other new
state has been sent by the server.
The compositor should wait for the manage sequence to complete before
processing further input events. This allows the window manager client
to, for example, modify key bindings and keyboard focus without racing
against future input events. The window manager should of course respond
as soon as possible as the capacity of the compositor to buffer incoming
input events is finite. *)
let pressed (_t:([< `V1 | `V2 | `V3] as 'v) t) =
let _msg = Proxy.alloc _t ~op:0 ~ints:0 ~strings:[] ~arrays:[] in
Proxy.send _t _msg
(** {2 Version 2, 3} *)
(** Repeating should be stopped.
This event indicates that repeating should be stopped for the binding if
the window manager has been repeating some action since the pressed
event.
This event is generally sent when some other (possibly unbound) key is
pressed after the pressed event is sent and before the released event
is sent for this binding.
This event will be followed by a manage_start event after all other new
state has been sent by the server. *)
let stop_repeat (_t:([< `V2 | `V3] as 'v) t) =
let _msg = Proxy.alloc _t ~op:2 ~ints:0 ~strings:[] ~arrays:[] in
Proxy.send _t _msg
(**/**)
class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
method user_data = S.No_data
method metadata = (module River_xkb_bindings_v1_proto.River_xkb_binding_v1)
method max_version = 3l
method private virtual on_destroy : [> ] t -> unit
method private virtual on_set_layout_override : [> ] t -> layout:int32 -> unit
method private virtual on_enable : [> ] t -> unit
method private virtual on_disable : [> ] t -> unit
method dispatch (_proxy : 'v t) _msg =
let _proxy = Proxy.cast_version _proxy in
match Msg.op _msg with
| 0 ->
Proxy.shutdown_recv _proxy;
_self#on_destroy _proxy
| 1 ->
let layout = Msg.get_int _msg in
_self#on_set_layout_override _proxy ~layout
| 2 ->
_self#on_enable _proxy
| 3 ->
_self#on_disable _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] as 'v] _handlers_unsafe
(**/**)
method private virtual on_destroy : [> `V1 | `V2 | `V3] t -> unit
(** Destroy the xkb binding object.
This request indicates that the client will no longer use the xkb key
binding object and that it may be safely destroyed. *)
method private virtual on_set_layout_override : [> `V1 | `V2 | `V3] t -> layout:int32 -> unit
(** Override currently active xkb layout.
Specify an xkb layout that should be used to translate key events for
the purpose of triggering this key binding irrespective of the currently
active xkb layout.
The layout argument is a 0-indexed xkbcommon layout number for the
keyboard that generated the key event.
If this request is never made, the currently active xkb layout of the
keyboard that generated the key event will be used.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
method private virtual on_enable : [> `V1 | `V2 | `V3] t -> unit
(** Enable the key binding.
This request should be made after all initial configuration has been
completed and the window manager wishes the key binding to be able to be
triggered.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
method private virtual on_disable : [> `V1 | `V2 | `V3] t -> unit
(** Disable the key binding.
This request may be used to temporarily disable the key binding. It may
be later re-enabled with the enable request.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
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] as 'v] _handlers_unsafe
(**/**)
method private virtual on_destroy : [> `V2 | `V3] t -> unit
(** Destroy the xkb binding object.
This request indicates that the client will no longer use the xkb key
binding object and that it may be safely destroyed. *)
method private virtual on_set_layout_override : [> `V2 | `V3] t -> layout:int32 -> unit
(** Override currently active xkb layout.
Specify an xkb layout that should be used to translate key events for
the purpose of triggering this key binding irrespective of the currently
active xkb layout.
The layout argument is a 0-indexed xkbcommon layout number for the
keyboard that generated the key event.
If this request is never made, the currently active xkb layout of the
keyboard that generated the key event will be used.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
method private virtual on_enable : [> `V2 | `V3] t -> unit
(** Enable the key binding.
This request should be made after all initial configuration has been
completed and the window manager wishes the key binding to be able to be
triggered.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
method private virtual on_disable : [> `V2 | `V3] t -> unit
(** Disable the key binding.
This request may be used to temporarily disable the key binding. It may
be later re-enabled with the enable request.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
method min_version = 2l
end
(** Handler for a proxy with version >= 3. *)
class virtual ['v] v3 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
(**/**)
inherit [[< `V3] as 'v] _handlers_unsafe
(**/**)
method private virtual on_destroy : [> `V3] t -> unit
(** Destroy the xkb binding object.
This request indicates that the client will no longer use the xkb key
binding object and that it may be safely destroyed. *)
method private virtual on_set_layout_override : [> `V3] t -> layout:int32 -> unit
(** Override currently active xkb layout.
Specify an xkb layout that should be used to translate key events for
the purpose of triggering this key binding irrespective of the currently
active xkb layout.
The layout argument is a 0-indexed xkbcommon layout number for the
keyboard that generated the key event.
If this request is never made, the currently active xkb layout of the
keyboard that generated the key event will be used.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
method private virtual on_enable : [> `V3] t -> unit
(** Enable the key binding.
This request should be made after all initial configuration has been
completed and the window manager wishes the key binding to be able to be
triggered.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
method private virtual on_disable : [> `V3] t -> unit
(** Disable the key binding.
This request may be used to temporarily disable the key binding. It may
be later re-enabled with the enable request.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
method min_version = 3l
end
end
(** Xkb bindings seat.
This object manages xkb bindings state associated with a specific seat. *)
module River_xkb_bindings_seat_v1 = struct
type 'v t = ([`River_xkb_bindings_seat_v1], 'v, [`Server]) Proxy.t
(** {2 Version 2} *)
(** An unbound key press event was eaten.
An unbound key press event was eaten due to the ensure_next_key_eaten
request.
This event will be followed by a manage_start event after all other new
state has been sent by the server. *)
let ate_unbound_key (_t:([< `V2 | `V3] as 'v) t) =
let _msg = Proxy.alloc _t ~op:0 ~ints:0 ~strings:[] ~arrays:[] in
Proxy.send _t _msg
(** {2 Version 3} *)
(** Active modifiers for the seat changed.
The set of currently active modifiers for the seat changed. This event
is only sent when there is a change in state for modifiers marked as
watched using the modifiers_watch request.
The old and new arguments convey the set of modifiers active before and
after the change. All modifiers are included in the old and new
arguments, including modifiers that are not watched.
Since this event is only sent when there is a change in state for
watched modifiers, it follows that at least one watched modifier is
active in old but inactive in new or vice-versa.
This event will be followed by a manage_start event after all other new
state has been sent by the server.
The compositor should wait for the manage sequence to complete before
processing further input events. This allows the window manager client
to, for example, modify key bindings and keyboard focus without racing
against future input events. The window manager should of course respond
as soon as possible as the capacity of the compositor to buffer incoming
input events is finite. *)
let modifiers_update (_t:([< `V3] as 'v) t) ~old ~new_ =
let _msg = Proxy.alloc _t ~op:1 ~ints:2 ~strings:[] ~arrays:[] in
Msg.add_int _msg (Imports.River_seat_v1.Modifiers.to_int32 old);
Msg.add_int _msg (Imports.River_seat_v1.Modifiers.to_int32 new_);
Proxy.send _t _msg
(**/**)
class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
method user_data = S.No_data
method metadata = (module River_xkb_bindings_v1_proto.River_xkb_bindings_seat_v1)
method max_version = 3l
method private virtual on_destroy : [> ] t -> unit
method private virtual on_ensure_next_key_eaten : [> ] t -> unit
method private virtual on_cancel_ensure_next_key_eaten : [> ] t -> unit
method private virtual on_modifiers_watch : [> ] t -> modifiers:Imports.River_seat_v1.Modifiers.t -> unit
method dispatch (_proxy : 'v t) _msg =
let _proxy = Proxy.cast_version _proxy in
match Msg.op _msg with
| 0 ->
Proxy.shutdown_recv _proxy;
_self#on_destroy _proxy
| 1 ->
_self#on_ensure_next_key_eaten _proxy
| 2 ->
_self#on_cancel_ensure_next_key_eaten _proxy
| 3 ->
let modifiers = Msg.get_int _msg |> Imports.River_seat_v1.Modifiers.of_int32 in
_self#on_modifiers_watch _proxy ~modifiers
| _ -> 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] as 'v] _handlers_unsafe
(**/**)
method private virtual on_destroy : [> `V2 | `V3] t -> unit
(** Destroy the object.
This request indicates that the client will no longer use the object and
that it may be safely destroyed. *)
method private virtual on_ensure_next_key_eaten : [> `V2 | `V3] t -> unit
(** Ensure the next key press event is eaten.
Ensure that the next non-modifier key press and corresponding release
events for this seat are not sent to the currently focused surface.
If the next non-modifier key press triggers a binding, the
pressed/released events are sent to the river_xkb_binding_v1 object as
usual.
If the next non-modifier key press does not trigger a binding, the
ate_unbound_key event is sent instead.
Rationale: the window manager may wish to implement "chorded"
keybindings where triggering a binding activates a "submap" with a
different set of keybindings. Without a way to eat the next key
press event, there is no good way for the window manager to know that it
should error out and exit the submap when a key not bound in the submap
is pressed.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
method private virtual on_cancel_ensure_next_key_eaten : [> `V2 | `V3] t -> unit
(** Cancel an ensure_next_key_eaten request.
This requests cancels the effect of the latest ensure_next_key_eaten
request if no key has been eaten due to the request yet. This request
has no effect if a key has already been eaten or no
ensure_next_key_eaten was made.
Rationale: the window manager may wish cancel an uncompleted "chorded"
keybinding after a timeout of a few seconds. Note that since this
timeout use-case requires the window manager to trigger a manage sequence
with the river_window_manager_v1.manage_dirty request it is possible that
the ate_unbound_key key event may be sent before the window manager has
a chance to make the cancel_ensure_next_key_eaten request.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
method private virtual on_modifiers_watch : [> `V3] t -> modifiers:Imports.River_seat_v1.Modifiers.t -> unit
(** Watch for change in active modifiers.
Request that the server send the modifiers_update event whenever a state
change occurs for at least one of the modifiers specified by the
modifiers argument.
The window manager should make this request with the modifiers argument
set to 0 when it no longer wishes to take action based on a change in
modifiers.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
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] as 'v] _handlers_unsafe
(**/**)
method private virtual on_destroy : [> `V2 | `V3] t -> unit
(** Destroy the object.
This request indicates that the client will no longer use the object and
that it may be safely destroyed. *)
method private virtual on_ensure_next_key_eaten : [> `V2 | `V3] t -> unit
(** Ensure the next key press event is eaten.
Ensure that the next non-modifier key press and corresponding release
events for this seat are not sent to the currently focused surface.
If the next non-modifier key press triggers a binding, the
pressed/released events are sent to the river_xkb_binding_v1 object as
usual.
If the next non-modifier key press does not trigger a binding, the
ate_unbound_key event is sent instead.
Rationale: the window manager may wish to implement "chorded"
keybindings where triggering a binding activates a "submap" with a
different set of keybindings. Without a way to eat the next key
press event, there is no good way for the window manager to know that it
should error out and exit the submap when a key not bound in the submap
is pressed.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
method private virtual on_cancel_ensure_next_key_eaten : [> `V2 | `V3] t -> unit
(** Cancel an ensure_next_key_eaten request.
This requests cancels the effect of the latest ensure_next_key_eaten
request if no key has been eaten due to the request yet. This request
has no effect if a key has already been eaten or no
ensure_next_key_eaten was made.
Rationale: the window manager may wish cancel an uncompleted "chorded"
keybinding after a timeout of a few seconds. Note that since this
timeout use-case requires the window manager to trigger a manage sequence
with the river_window_manager_v1.manage_dirty request it is possible that
the ate_unbound_key key event may be sent before the window manager has
a chance to make the cancel_ensure_next_key_eaten request.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
method private virtual on_modifiers_watch : [> `V3] t -> modifiers:Imports.River_seat_v1.Modifiers.t -> unit
(** Watch for change in active modifiers.
Request that the server send the modifiers_update event whenever a state
change occurs for at least one of the modifiers specified by the
modifiers argument.
The window manager should make this request with the modifiers argument
set to 0 when it no longer wishes to take action based on a change in
modifiers.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
method min_version = 2l
end
(** Handler for a proxy with version >= 3. *)
class virtual ['v] v3 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
(**/**)
inherit [[< `V3] as 'v] _handlers_unsafe
(**/**)
method private virtual on_destroy : [> `V3] t -> unit
(** Destroy the object.
This request indicates that the client will no longer use the object and
that it may be safely destroyed. *)
method private virtual on_ensure_next_key_eaten : [> `V3] t -> unit
(** Ensure the next key press event is eaten.
Ensure that the next non-modifier key press and corresponding release
events for this seat are not sent to the currently focused surface.
If the next non-modifier key press triggers a binding, the
pressed/released events are sent to the river_xkb_binding_v1 object as
usual.
If the next non-modifier key press does not trigger a binding, the
ate_unbound_key event is sent instead.
Rationale: the window manager may wish to implement "chorded"
keybindings where triggering a binding activates a "submap" with a
different set of keybindings. Without a way to eat the next key
press event, there is no good way for the window manager to know that it
should error out and exit the submap when a key not bound in the submap
is pressed.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
method private virtual on_cancel_ensure_next_key_eaten : [> `V3] t -> unit
(** Cancel an ensure_next_key_eaten request.
This requests cancels the effect of the latest ensure_next_key_eaten
request if no key has been eaten due to the request yet. This request
has no effect if a key has already been eaten or no
ensure_next_key_eaten was made.
Rationale: the window manager may wish cancel an uncompleted "chorded"
keybinding after a timeout of a few seconds. Note that since this
timeout use-case requires the window manager to trigger a manage sequence
with the river_window_manager_v1.manage_dirty request it is possible that
the ate_unbound_key key event may be sent before the window manager has
a chance to make the cancel_ensure_next_key_eaten request.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
method private virtual on_modifiers_watch : [> `V3] t -> modifiers:Imports.River_seat_v1.Modifiers.t -> unit
(** Watch for change in active modifiers.
Request that the server send the modifiers_update event whenever a state
change occurs for at least one of the modifiers specified by the
modifiers argument.
The window manager should make this request with the modifiers argument
set to 0 when it no longer wishes to take action based on a change in
modifiers.
This request modifies window management state and may only be made as
part of a manage sequence, see the river_window_manager_v1 description. *)
method min_version = 3l
end
end