summaryrefslogtreecommitdiff
path: root/specs/ch06.xml
blob: 6351760534e4ce17dde86a5145597c8d856450bd (plain)
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
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
<chapter id='key_event_processing_in_the_server'>
<title>Key Event Processing in the Server</title>

<para>
This section describes the steps involved in processing a key event within the
server when XKB is present. Key events can be generated due to keyboard
activity and passed to XKB by the DDX layer, or they can be synthesized by
another extension, such as XTEST.
</para>

<sect1 id='applying_global_controls'>
<title>Applying Global Controls</title>

<para>
When the X Keyboard Extension receives a key event, it first checks the global
key controls to decide whether to process the event immediately or at all. The
global key controls which might affect the event, in descending order of
priority, are:
</para>

<itemizedlist>
<listitem>
  <para>If a key is pressed while the <emphasis>
BounceKeys</emphasis>
 control is enabled, the extension generates the event only if the key is
active. When a key is released, the server deactivates the key and starts a
<emphasis>
bounce keys timer</emphasis>
 with an interval specified by the debounce delay.
  </para>
  <para>
If the bounce keys timer expires or if some other key is pressed before the
timer expires, the server reactivates the corresponding key and deactivates the
timer. Neither expiration nor deactivation of a bounce keys timer causes an
event.</para>
</listitem>
<listitem>
  <para>If the <emphasis>
SlowKeys</emphasis>
 control is enabled, the extension sets a <emphasis>
slow keys timer</emphasis>
 with an interval specified by the slow keys delay, but does not process the
key event immediately. The corresponding key release deactivates this timer.
  </para>
  <para>
If the slow keys timer expires, the server generates a key press for the
corresponding key, sends an <emphasis>
XkbAccessXNotify</emphasis>
 and deactivates the timer.
   </para>
</listitem>
<listitem>
  <para>The extension processes key press events normally whether or not the
<emphasis>
RepeatKeys</emphasis>
 control is active, but if <emphasis>
RepeatKeys</emphasis>
 are enabled and per-key autorepeat is enabled for the event key, the extension
processes key press events normally, but it also initiates an <emphasis>
autorepeat timer</emphasis>
 with an interval specified by the autorepeat delay. The corresponding key
release deactivates the timer.
  </para>
  <para>
If the autorepeat timer expires, the server generates a key release and a key
press for the corresponding key and reschedules the timer according to the
autorepeat interval.
  </para>
</listitem>
</itemizedlist>

<para>
Key events are processed by each global control in turn: if the <emphasis>
BounceKeys</emphasis>
 control accepts a key event, <emphasis>
SlowKeys</emphasis>
 considers it. Once <emphasis>
SlowKeys</emphasis>
 allows or synthesizes an event, the <emphasis>
RepeatKeys</emphasis>
 control acts on it.
</para>


</sect1>
<sect1 id='key_behavior'>
<title>Key Behavior</title>

<para>
Once an event is accepted by all of the controls or generated by a timer, the
server checks the per-key behavior of the corresponding key. This extension
currently defines the following key behaviors:
</para>

<informaltable frame='none'>
<tgroup cols='2'>
<colspec align="left" colsep="0"/>
<colspec align="left" colsep="0"/>
<thead>
  <row rowsep='1'>
    <entry>Behavior</entry>
    <entry>Effect</entry>
  </row>
</thead>
<tbody>
  <row rowsep='0'>
    <entry><emphasis>
KB_Default</emphasis>
 </entry>
    <entry>Press and release events are processed normally.</entry>
  </row>
  <row rowsep='0'>
    <entry><emphasis>
KB_Lock</emphasis>
 </entry>
    <entry>If a key is logically up (i.e. the corresponding bit of the core key
map is cleared) when it is pressed, the key press is processed normally and the
corresponding release is ignored. If the key is logically down when pressed,
the key press is ignored but the corresponding release is processed normally.
</entry>
  </row>
  <row rowsep='0'>
    <entry>
    <para>
    <emphasis>
KB_RadioGroup
</emphasis>
    </para>
    <para>
      flags: CARD8
    </para>
    <para>
      index: CARD8
    </para>
    </entry>
    <entry><para>If another member of the radio group specified by <emphasis>
index</emphasis>
 is logically down when a key is pressed, the server synthesizes a key release
for the member that is logically down and then processes the new key press
event normally. </para>
<para>
If the key itself is logically down when pressed, the key press event is
ignored, but the processing of the corresponding key release depends on the
value of the <emphasis>
RGAllowNone</emphasis>
 bit in <emphasis>
flags</emphasis>
. If it is set, the key release is processed normally; otherwise the key
release is also ignored.
</para>
<para>
All other key release events are ignored.</para>
  </entry>
  </row>
  <row rowsep='0'>
    <entry>
   <para>
    <emphasis>
KB_Overlay1
</emphasis>
   </para>
   <para>
      key: KEYCODE
   </para>
      </entry>
    <entry>If the <emphasis>
Overlay1</emphasis>
 control is enabled, events from this key are reported as if they came from the
key specified in <emphasis>
key</emphasis>
. Otherwise, press and release events are processed normally.</entry>
  </row>
  <row rowsep='0'>
    <entry>
   <para>
    <emphasis>
KB_Overlay2
</emphasis>
   </para>
   <para>
      key: KEYCODE
   </para>
      </entry>
    <entry>If the <emphasis>
Overlay2</emphasis>
 control is enabled, events from this key are reported as if they came from the
key specified in <emphasis>
key</emphasis>
. Otherwise, press and release events are processed normally.</entry>
  </row>
</tbody>
</tgroup>
</informaltable>

<para>
The X server uses key behavior to determine whether to process or filter out
any given key event; key behavior is independent of keyboard modifier or group
state (each key has exactly one behavior.
</para>

<para>
Key behaviors can be used to simulate any of these types of keys or to indicate
an unmodifiable physical, electrical or software driver characteristic of a
key. An optional <emphasis>
permanent</emphasis>
 flag can modify any of the supported behaviors and indicates that behavior
describes an unalterable physical, electrical or software aspect of the
keyboard. Permanent behaviors cannot be changed or set by the <emphasis>
XkbSetMap</emphasis>
 request. The <emphasis>
permanent</emphasis>
 flag indicates a characteristic of the underlying system that XKB cannot
affect, so XKB treats all permanent behaviors as if they were <emphasis>
KB_Default</emphasis>
 and does not filter key events described in the table above.
</para>


</sect1>
<sect1 id='key_actions'>
<title>Key Actions</title>

<para>
Once the server has applied the global controls and per-key behavior and has
decided to process a key event, it applies <emphasis>
key actions</emphasis>
 to determine the effects of the key on the internal state of the server. A key
action consists of an operator and some optional data. XKB supports actions
which:
</para>

<itemizedlist>
<listitem>
  <para>change base, latched or locked modifiers or group
  </para>
</listitem>
<listitem>
  <para>move the core pointer or simulate core pointer button events
  </para>
</listitem>
<listitem>
  <para>change most aspects of keyboard behavior
  </para>
</listitem>
<listitem>
  <para>terminate or suspend the server
  </para>
</listitem>
<listitem>
  <para>send a message to interested clients
  </para>
</listitem>
<listitem>
  <para>simulate events on other keys
  </para>
</listitem>
</itemizedlist>

<para>
Each key has an optional list of actions. If present, this list parallels the
list of symbols associated with the key (i.e. it has one action per symbol
associated with the key). For key press events, the server looks up the action
to be applied from this list using the key symbol mapping associated with the
event key, just as a client looks up symbols as described in <link
linkend="determining_the_keysym_associated_with_a_key_event">Determining the KeySym Associated with a
Key Event</link>; if the event key does not have any actions, the server uses
the <emphasis>
SA_NoAction</emphasis>
 event for that key regardless of modifier or group state.
</para>


<para>
Key actions have essentially two halves; the effects on the server when the key
is pressed and the effects when the key is released. The action applied for a
key press event determines the further actions, if any, that are applied to the
corresponding release event or to events that occur while the key is held down.
Clients can change the actions associated with a key while the key is down
without changing the action applied next time the key is released; subsequent
press-release pairs will use the newly bound key action.
</para>


<para>
Most actions directly change the state of the keyboard or server; some actions
also modify other actions that occur simultaneously with them. Two actions
occur simultaneously if the keys which invoke the actions are both logically
down at the same time, regardless of the order in which they are pressed or
delay between the activation of one and the other.
</para>


<para>
Most actions which affect keyboard modifier state accept a modifier definition
(see <link linkend="virtual_modifiers">Virtual Modifiers</link>)
named <emphasis>
mods</emphasis>
 and a boolean flag name <emphasis>
useModMap</emphasis>
 among their arguments. These two fields combine to specify the modifiers
affected by the action as follows: If <emphasis>
useModMap</emphasis>
 is <emphasis>
True</emphasis>
, the action sets any modifiers bound by the modifier mapping to the key that
initiated the action; otherwise, the action sets the modifiers specified by
<emphasis>
mods</emphasis>
. For brevity in the text of the following definitions, we refer to this
combination of <emphasis>
useModMap</emphasis>
 and <emphasis>
mods</emphasis>
 as the "action modifiers."
</para>


<para>
The X Keyboard Extension supports the following actions:
</para>

<informaltable frame='none'>
<tgroup cols='2'>
<colspec align="left" colsep="0"/>
<colspec align="left" colsep="0"/>
<thead>
  <row rowsep='1'>
    <entry>Action</entry>
    <entry>Effect</entry>
  </row>
</thead>
<tbody>
  <row rowsep='0'>
    <entry><emphasis>SA_NoAction</emphasis></entry>
    <entry>
      <itemizedlist>
        <listitem>
          <para>
No direct effect, though <emphasis>SA_NoAction</emphasis>
 events may change the effect of other server actions (see below).
          </para>
        </listitem>
      </itemizedlist>
    </entry>
  </row>
  <row rowsep='0'>
    <entry>
    <para>
    <emphasis>SA_SetMods</emphasis>
    </para>
    <para>
      mods: MOD_DEF
    </para>
    <para>
      useModMap: BOOL
    </para>
    <para>
      clearLocks: BOOL
    </para>
    </entry>
    <entry>
      <itemizedlist>
      <listitem>
        <para>
Key press adds any action modifiers to the keyboard’s base modifiers<emphasis>.</emphasis>
        </para>
      </listitem>
      <listitem>
        <para>Key release clears any action modifiers in the keyboard’s base
modifiers, provided that no other key which affects the same modifiers is
logically down.
        </para>
      </listitem>
      <listitem>
        <para>If no keys were operated simultaneously with this key and <emphasis>
clearLocks</emphasis>
 is set, release unlocks any action modifiers.
        </para>
      </listitem>
      </itemizedlist>
    </entry>
  </row>
  <row rowsep='0'>
    <entry>
    <para>
    <emphasis>
SA_LatchMods
</emphasis>
    </para>
    <para>
      mods: MOD_DEF
    </para>
    <para>
      useModMap: BOOL
    </para>
    <para>
      clearLocks: BOOL
    </para>
    <para>
      latchToLock: BOOL
    </para>
      </entry>
<entry>
<itemizedlist>
<listitem>
  <para>Key press and release events have the same effect as for <emphasis>
SA_SetMods</emphasis>
; if no keys were operated simultaneously with the latching modifier key, key
release events have the following additional effects:
  </para>
</listitem>
<listitem>
  <para>Modifiers that were unlocked due to <emphasis>
clearLocks</emphasis>
 have no further effect.
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
latchToLock</emphasis>
 is set, key release locks and then unlatches any remaining action modifiers
that are already latched.
  </para>
</listitem>
<listitem>
  <para>Finally, key release latches any action modifiers that were not used by
the <emphasis>
clearLocks</emphasis>
 or <emphasis>
latchToLock</emphasis>
 flags.
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
  <row rowsep='0'>
    <entry>
    <para>
    <emphasis>
SA_LockMods
    </emphasis>
    </para>
    <para>
      mods: MOD_DEF
    </para>
    <para>
      useModMap: BOOL
    </para>
    <para>
      noLock: BOOL
    </para>
    <para>
      noUnlock: BOOL
    </para>
      </entry>
<entry>
<itemizedlist>
<listitem>
  <para>Key press sets the base and possibly the locked state of any action
modifiers. If <emphasis>
noLock</emphasis>
 is <emphasis>
True</emphasis>
, only the base state is changed.
  </para>
</listitem>
<listitem>
  <para>For key release events, clears any action modifiers in the keyboard’s
base modifiers, provided that no other key which affects the same modifiers is
down. If <emphasis>
noUnlock</emphasis>
 is <emphasis>
False</emphasis>
 and any of the action modifiers were locked before the corresponding key press
occurred, key release unlocks them.
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
  <row rowsep='0'>
    <entry>
    <para>
    <emphasis>
SA_SetGroup
</emphasis>
    </para>
    <para>
      group: INT8
    </para>
    <para>
      groupAbsolute: BOOL
    </para>
    <para>
      clearLocks: BOOL
    </para>
      </entry>
<entry>
<itemizedlist>
<listitem>
  <para>If <emphasis>
groupAbsolute</emphasis>
 is set, key press events change the base keyboard group to <emphasis>
group</emphasis>
; otherwise, they add <emphasis>
group</emphasis>
 to the base keyboard group. In either case, the resulting effective keyboard
group is brought back into range depending on the value of the <emphasis>
GroupsWrap</emphasis>
 control for the keyboard.
  </para>
</listitem>
<listitem>
  <para>If an <emphasis>
SA_ISOLock</emphasis>
 key is pressed while this key is held down, key release has no effect,
otherwise it cancels the effects of the press.
  </para>
</listitem>
<listitem>
  <para>If no keys were operated simultaneously with this key and <emphasis>
clearLocks</emphasis>
 is set, key release also sets the locked keyboard group to <emphasis>
Group1</emphasis>
.
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
  <row rowsep='0'>
    <entry>
    <para>
    <emphasis>
SA_LatchGroup
    </emphasis>
    </para>
    <para>
      group: INT8
    </para>
    <para>
      groupAbsolute: BOOL
    </para>
    <para>
      clearLocks: BOOL
    </para>
    <para>
      latchToLock: BOOL
    </para>
      </entry>
<entry>
<itemizedlist>
<listitem>
  <para>Key press and release events have the same effect as an <emphasis>
SA_SetGroup</emphasis>
 action; if no keys were operated simultaneously with the latching group key
and the <emphasis>
clearLocks</emphasis>
 flag was not set or had no effect, key release has the following additional
effects:
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
latchToLock</emphasis>
 is set and the latched keyboard group is non-zero, the key release adds the
delta applied by the corresponding key press to the locked keyboard group and
subtracts it from the latched keyboard group. The locked and effective keyboard
group are brought back into range according to the value of the global
<emphasis>
GroupsWrap</emphasis>
 control for the keyboard.
  </para>
</listitem>
<listitem>
  <para>Otherwise, key release adds the key press delta to the latched keyboard
group.
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
  <row rowsep='0'>
    <entry>
    <para>
    <emphasis>
SA_LockGroup
    </emphasis>
    </para>
    <para>
      group: INT8
    </para>
    <para>
      groupAbsolute: BOOL
    </para>
    </entry>
<entry>
<itemizedlist>
<listitem>
  <para>If <emphasis>
groupAbsolute</emphasis>
 is set, key press sets the locked keyboard group to <emphasis>
group</emphasis>
. Otherwise, key press adds <emphasis>
group</emphasis>
 to the locked keyboard group. In either case, the resulting locked and
effective group is brought back into range depending on the value of the
<emphasis>
GroupsWrap</emphasis>
 control for the keyboard.
  </para>
</listitem>
<listitem>
  <para>Key release has no effect.
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
  <row rowsep='0'>
    <entry>
    <para>
    <emphasis>
SA_MovePtr
</emphasis>
    </para>
    <para>
      x, y: INT16
    </para>
    <para>
      noAccel: BOOL
    </para>
    <para>
      absoluteX: BOOL
    </para>
    <para>
      absoluteY: BOOL
    </para>
      </entry>
<entry>
<itemizedlist>
<listitem>
  <para>If <emphasis>
MouseKeys</emphasis>
 are not enabled, this action behaves like <emphasis>
SA_NoAction</emphasis>
, otherwise this action cancels any pending repeat key timers for this key and
has the following additional effects.
  </para>
</listitem>
<listitem>
  <para>Key press generates a core pointer <emphasis>
MotionNotify</emphasis>
 event instead of the usual <emphasis>
KeyPress</emphasis>
. If <emphasis>
absoluteX</emphasis>
 is <emphasis>
True</emphasis>
, <emphasis>
x</emphasis>
 specifies the new pointer X coordinate, otherwise <emphasis>
x</emphasis>
 is added to the current pointer X coordinate; <emphasis>
absoluteY</emphasis>
 and <emphasis>
y</emphasis>
 specify the new Y coordinate in the same way.
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
noAccel</emphasis>
 is <emphasis>
False</emphasis>
, and the <emphasis>
MouseKeysAccel</emphasis>
 keyboard control is enabled, key press also initiates the mouse keys timer for
this key; every time this timer expires, the cursor moves again. The distance
the cursor moves in these subsequent events is determined by the mouse keys
acceleration as described in <link linkend="the_mousekeysaccel_control">The
MouseKeysAccel Control</link>.
  </para>
</listitem>
<listitem>
  <para>Key release disables the mouse keys timer (if it was initiated by the
corresponding key press) but has no other effect and is ignored (does not
generate an event of any type).
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
  <row rowsep='0'>
    <entry>
    <para>
    <emphasis>
SA_PtrBtn
   </emphasis>
    </para>
    <para>
      button: CARD8
    </para>
    <para>
      count: CARD8
    </para>
    <para>
      useDfltBtn: BOOL
    </para>
      </entry>
<entry>
<itemizedlist>
<listitem>
  <para>If <emphasis>
MouseKeys</emphasis>
 are not enabled, this action behaves like <emphasis>
SA_NoAction</emphasis>
.
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
useDfltBtn</emphasis>
 is set, the event is generated for the current default core button. Otherwise,
the event is generated for the button specified by <emphasis>
button</emphasis>
.
  </para>
</listitem>
<listitem>
  <para>If the mouse button specified for this action is logically down, the
key press and corresponding release are ignored and have no effect.
  </para>
</listitem>
<listitem>
  <para>Otherwise, key press causes one or more core pointer button events
instead of the usual key press. If <emphasis>
count</emphasis>
 is <emphasis>
0</emphasis>
, key press generates a single <emphasis>
ButtonPress</emphasis>
 event; if <emphasis>
count</emphasis>
 is greater than <emphasis>
0</emphasis>
, key press generates <emphasis>
count</emphasis>
 pairs of <emphasis>
ButtonPress</emphasis>
 and <emphasis>
ButtonRelease</emphasis>
 events.
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
count</emphasis>
 is <emphasis>
0</emphasis>
, key release generates a core pointer <emphasis>
ButtonRelease</emphasis>
 which matches the event generated by the corresponding key press; if count is
non-zero, key release does not cause a <emphasis>
ButtonRelease</emphasis>
 event. Key release never causes a key release event.
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
  <row rowsep='0'>
    <entry>
    <para>
    <emphasis>
SA_LockPtrBtn
</emphasis>
    </para>
    <para>
      button: BUTTON
    </para>
    <para>
      noLock: BOOL
    </para>
    <para>
      noUnlock: BOOL
    </para>
    <para>
      useDfltBtn: BOOL
    </para>
      </entry>
<entry>
<itemizedlist>
<listitem>
  <para>If <emphasis>
MouseKeys</emphasis>
 are not enabled, this action behaves like <emphasis>
SA_NoAction</emphasis>
.
  </para>
</listitem>
<listitem>
  <para>Otherwise, if the button specified by <emphasis>
useDfltBtn</emphasis>
 and <emphasis>
button</emphasis>
 is not locked, key press causes a <emphasis>
ButtonPress</emphasis>
 instead of a key press and locks the button. If the button is already locked
or if <emphasis>
noLock</emphasis>
 is <emphasis>
True</emphasis>
, key press is ignored and has no effect.
  </para>
</listitem>
<listitem>
  <para>If the corresponding key press was ignored, and if <emphasis>
noUnlock</emphasis>
 is <emphasis>
False</emphasis>
, key release generates a <emphasis>
ButtonRelease</emphasis>
 event instead of a key release event and unlocks the specified button. If the
corresponding key press locked a button, key release is ignored and has no
effect.
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
  <row rowsep='0'>
    <entry>
    <para>
    <emphasis>
SA_SetPtrDflt
</emphasis>
    </para>
    <para>
      affect: CARD8
    </para>
    <para>
      value: CARD8
    </para>
    <para>
      dfltBtnAbs: BOOL
    </para>
      </entry>
<entry>
<itemizedlist>
<listitem>
  <para>If <emphasis>
MouseKeys</emphasis>
 are not enabled, this action behaves like <emphasis>
SA_NoAction</emphasis>
.
  </para>
</listitem>
<listitem>
  <para>Otherwise, both key press and key release are ignored, but key press
changes the pointer value specified by <emphasis>
affect </emphasis>
to <emphasis>
value</emphasis>
, as follows:
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
which</emphasis>
 is <emphasis>
SA_AffectDfltBtn</emphasis>
, <emphasis>
value</emphasis>
 and <emphasis>
dfltBtnAbs</emphasis>
 specify the default pointer button used by the various pointer actions as
follow: If <emphasis>
dfltBtnAbs </emphasis>
is True, value specifies the button to be used, otherwise, <emphasis>
value</emphasis>
 specifies the amount to be added to the current default button. In either
case, illegal button choices are wrapped back into range.
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
  <row rowsep='0'>
    <entry>
      <para>
    <emphasis>
SA_ISOLock
</emphasis>
      </para>
      <para>
      dfltIsGroup: <emphasis>
False
</emphasis>
      </para>
      <para>
      mods: MOD_DEF
      </para>
      <para>
      useModMap: BOOL
      </para>
      <para>
      noLock: BOOL
      </para>
      <para>
      noUnlock: BOOL
      </para>
      <para>
      noAffectMods: BOOL
      </para>
      <para>
      noAffectGrp: BOOL
      </para>
      <para>
      noAffectPtr: BOOL
      </para>
      <para>
      noAffectCtrls: BOOL
      </para>
      <para>
or
      </para>
      <para>
      dfltIsGroup: <emphasis>
True
</emphasis>
      </para>
      <para>
      group: INT8
      </para>
      <para>
      groupAbsolute: BOOL
      </para>
      <para>
      noAffectMods: BOOL
      </para>
      <para>
      noAffectGrp: BOOL
      </para>
      <para>
      noAffectPtr: BOOL
      </para>
      <para>
      noAffectCtrls: BOOL
      </para>
      </entry>
<entry>
<itemizedlist>
<listitem>
  <para>If <emphasis>
dfltIsGroup</emphasis>
 is <emphasis>
True</emphasis>
, key press sets the base group specified by <emphasis>
groupAbsolute</emphasis>
 and <emphasis>
group</emphasis>
. Otherwise, key press sets the action modifiers in the keyboard’s base
modifiers.
  </para>
</listitem>
<listitem>
  <para>Key release clears the base modifiers or group that were set by the key
press; it may have additional effects if no other appropriate actions occur
simultaneously with the <emphasis>
SA_ISOLock</emphasis>
 operation.
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
noAffectMods</emphasis>
 is <emphasis>
False</emphasis>
, any <emphasis>
SA_SetMods</emphasis>
 or <emphasis>
SA_LatchMods</emphasis>
 actions that occur simultaneously with the <emphasis>
ISOLock</emphasis>
 action are treated as <emphasis>
SA_LockMods</emphasis>
 instead.
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
noAffectGrp</emphasis>
 is <emphasis>
False</emphasis>
, any <emphasis>
SA_SetGroup</emphasis>
 or <emphasis>
SA_LatchGroup</emphasis>
 actions that occur simultaneously with this action are treated as <emphasis>
SA_LockGroup</emphasis>
 actions instead.
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
noAffectPtr</emphasis>
 is <emphasis>
False</emphasis>
, <emphasis>
SA_PtrBtn</emphasis>
 actions that occur simultaneously with the <emphasis>
SA_ISOLock</emphasis>
 action are treated as <emphasis>
SA_LockPtrBtn</emphasis>
 actions instead.
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
noAffectCtrls</emphasis>
 is <emphasis>
False</emphasis>
, any <emphasis>
SA_SetControls</emphasis>
 actions that occur simultaneously with the <emphasis>
SA_ISOLock</emphasis>
 action are treated as <emphasis>
SA_LockControls</emphasis>
 actions instead.
  </para>
</listitem>
<listitem>
  <para>If no other actions were transformed by the <emphasis>
SA_ISOLock</emphasis>
 action, key release locks the group or modifiers specified by the action
arguments.
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
  <row rowsep='0'>
    <entry><emphasis>
SA_TerminateServer</emphasis>
 </entry>
<entry>
<itemizedlist>
<listitem>
  <para>Key press terminates the server. Key release is ignored.
  </para>
</listitem>
<listitem>
  <para>This action is optional; servers are free to ignore it. If ignored, it
behaves like <emphasis>
SA_NoAction</emphasis>
.
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
  <row rowsep='0'>
    <entry>
    <para>
    <emphasis>
SA_SwitchScreen
</emphasis>
      </para>
      <para>
      num: INT8
      </para>
      <para>
      switchApp: BOOL
      </para>
      <para>
      screenAbs: BOOL
      </para>
</entry>
<entry>
<itemizedlist>
<listitem>
  <para>If the server supports this action and multiple screens or displays
(either virtual or real), this action changes to the active screen indicated by
<emphasis>
num</emphasis>
 and <emphasis>
screenAbs</emphasis>
. If <emphasis>
screenAbs</emphasis>
 is <emphasis>
True</emphasis>
, num specifies the index of the new screen; otherwise, num specifies an offset
from the current screen to the new screen.
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
switchApp</emphasis>
 is <emphasis>
False</emphasis>
, it should switch to another screen on the same server. Otherwise it should
switch to another X server or application which shares the same physical
display.
  </para>
</listitem>
<listitem>
  <para>This action is optional; servers are free to ignore the action or any
of its flags if they do not support the requested behavior. If the action is
ignored, it behaves like <emphasis>
SA_NoAction</emphasis>
, otherwise neither key press nor release generate an event.
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
  <row rowsep='0'>
    <entry>
      <para><emphasis>SA_SetControls</emphasis></para>
      <para>controls: KB_BOOLCTRLMASK</para>
    </entry>
    <entry>
      <itemizedlist>
        <listitem>
          <para>
Key press enables any boolean controls that are specified in <emphasis>
controls</emphasis>
 and not already enabled at the time of the key press. Key release disables any
controls that were enabled by the corresponding key press. This action can
cause <emphasis>
XkbControlsNotify</emphasis>
 events.
          </para>
	</listitem>
	</itemizedlist>
     </entry>
  </row>
  <row rowsep='0'>
    <entry>
      <para><emphasis>SA_LockControls</emphasis></para>
      <para>
      controls: KB_BOOLCTRLMASK
      </para>
      <para>
      noLock: BOOL
      </para>
      <para>
      noUnlock: BOOL
      </para>
    </entry>
    <entry>
<itemizedlist>
<listitem>
  <para>If <emphasis>
noLock</emphasis>
 is <emphasis>
False</emphasis>
, key press locks and enables any controls that are specified in <emphasis>
controls</emphasis>
 and not already locked at the time of the key press.
</para>
<para>
If <emphasis>
noUnlock</emphasis>
 is <emphasis>
False</emphasis>
, key release unlocks and disables any controls that are specified in <emphasis>
controls</emphasis>
 and were not enabled at the time of the corresponding key press.
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
  <row rowsep='0'>
    <entry>
      <para>
    <emphasis>
SA_ActionMessage</emphasis>
:
      pressMsg: BOOL
      </para>
      <para>
      releaseMsg: BOOL
      </para>
      <para>
      genEvent: BOOL
      </para>
      <para>
      message: STRING
      </para>
      </entry>
<entry>
<itemizedlist>
<listitem>
  <para>if <emphasis>
pressMsg</emphasis>
 is <emphasis>
True</emphasis>
, key press generates an <emphasis>
XkbActionMessage</emphasis>
 event which reports the keycode, event type and the contents of <emphasis>
message</emphasis>
.
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
releaseMsg</emphasis>
 is <emphasis>
True</emphasis>
, key release generates an <emphasis>
XkbActionMessage</emphasis>
 event which reports the keycode, event type and contents of <emphasis>
message</emphasis>
.
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
genEvent</emphasis>
 is <emphasis>
True</emphasis>
, both press and release generate key press and key release events, regardless
of whether they also cause an <emphasis>
XkbActionMessage</emphasis>
.
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
  <row rowsep='0'>
    <entry>
    <para>
    <emphasis>
SA_RedirectKey
</emphasis>
    </para>
    <para>
      newKey: KEYCODE
    </para>
    <para>
      modsMask: KEYMASK
    </para>
    <para>
      mods: KEYMASK
    </para>
    <para>
      vmodsMask: CARD16
    </para>
    <para>
      vmods: CARD16
    </para>
      </entry>
<entry>
<itemizedlist>
<listitem>
  <para>Key press causes a key press event for the key specified by <emphasis>
newKey</emphasis>
 instead of for the actual key. The state reported in this event reports of the
current effective modifiers changed as follow: Any real modifiers specified in
<emphasis>
modsMask</emphasis>
 are set to corresponding values from <emphasis>
mods</emphasis>
. Any real modifiers bound to the virtual modifiers specified in <emphasis>
vmodsMask</emphasis>
 are either set or cleared, depending on the corresponding value in <emphasis>
vmods</emphasis>
. If the real and virtual modifier definitions specify conflicting values for a
single modifier, the real modifier definition has priority.
  </para>
</listitem>
<listitem>
  <para>Key release causes a key release event for the key specified by
<emphasis>
newKey</emphasis>
; the state field for this event consists of the effective keyboard modifiers
at the time of the release, changed as described above.
  </para>
</listitem>
<listitem>
  <para>The <emphasis>
SA_RedirectKey</emphasis>
 action normally redirects to another key on the same device as the key or
button which caused the event, unless that device does not belong to the input
extension KEYCLASS, in which case this action causes an event on the core
keyboard device.
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
  <row rowsep='0'>
    <entry>
    <para>
    <emphasis>
SA_DeviceBtn
</emphasis>
    </para>
    <para>
      count: CARD8
    </para>
    <para>
      button: BUTTON
    </para>
    <para>
      device: CARD8
    </para>
      </entry>
<entry>
<itemizedlist>
<listitem>
  <para>The <emphasis>
device</emphasis>
 field specifies the ID of an extension device; the <emphasis>
button</emphasis>
 field specifies the index of a button on that device. If the button specified
by this action is logically down, the key press and corresponding release are
ignored and have no effect. If the device or button specified by this action
are illegal, this action behaves like <emphasis>
SA_NoAction</emphasis>
.
  </para>
</listitem>
<listitem>
  <para>Otherwise, key press causes one or more input extension device button
events instead of the usual key press event. If <emphasis>
count</emphasis>
 is <emphasis>
0</emphasis>
, key press generates a single <emphasis>
DeviceButtonPress</emphasis>
 event; if <emphasis>
count</emphasis>
 is greater than <emphasis>
0</emphasis>
, key press generates <emphasis>
count</emphasis>
 pairs of <emphasis>
DeviceButtonPress</emphasis>
 and <emphasis>
DeviceButtonRelease</emphasis>
 events.
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
count</emphasis>
 is <emphasis>
0</emphasis>
, key release generates an input extension <emphasis>
DeviceButtonRelease</emphasis>
 which matches the event generated by the corresponding key press; if count is
non-zero, key release does not cause a <emphasis>
DeviceButtonRelease</emphasis>
 event. Key release never causes a key release event.
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
  <row rowsep='0'>
    <entry>
    <para>
    <emphasis>
SA_LockDeviceBtn
</emphasis>
    </para>
    <para>
      button: BUTTON
    </para>
    <para>
      device: CARD8
    </para>
    <para>
      noLock: BOOL
    </para>
    <para>
      noUnlock: BOOL
    </para>
      </entry>
<entry>
<itemizedlist>
<listitem>
  <para>The <emphasis>
device</emphasis>
 field specifies the ID of an extension device; the <emphasis>
button</emphasis>
 field specifies the index of a button on that device. If the device or button
specified by this action are illegal, it behaves like <emphasis>
SA_NoAction</emphasis>
.
  </para>
</listitem>
<listitem>
  <para>Otherwise, if the specified button is not locked and if <emphasis>
noLock</emphasis>
 is <emphasis>
False</emphasis>
, key press causes an input extension <emphasis>
DeviceButtonPress</emphasis>
 event instead of a key press event and locks the button. If the button is
already locked or if <emphasis>
noLock</emphasis>
 is <emphasis>
True</emphasis>
, key press is ignored and has no effect.
  </para>
</listitem>
<listitem>
  <para>If the corresponding key press was ignored, and if <emphasis>
noUnlock</emphasis>
 is <emphasis>
False</emphasis>
, key release generates an input extension <emphasis>
DeviceButtonRelease</emphasis>
 event instead of a core protocol or input extension key release event and
unlocks the specified button. If the corresponding key press locked a button,
key release is ignored and has no effect.
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
  <row rowsep='0'>
    <entry>
<para>
    <emphasis>
SA_DeviceValuator
</emphasis>
</para>
<para>
      <emphasis>
device</emphasis>
: CARD8
</para>
<para>
      <emphasis>
val1What</emphasis>
: SA_DVOP
</para>
<para>
      <emphasis>
val1</emphasis>
: CARD8
</para>
<para>
      <emphasis>
val1Value</emphasis>
: INT8
</para>
<para>
      <emphasis>
val1Scale</emphasis>
: 0...7
</para>
<para>
      <emphasis>
val2What</emphasis>
: BOOL
</para>
<para>
      <emphasis>
val2</emphasis>
: CARD8
</para>
<para>
      <emphasis>
val2Value</emphasis>
: INT8
</para>
<para>
      <emphasis>
val2Scale</emphasis>
: 0...7
</para>
</entry>
<entry>
<itemizedlist>
<listitem>
  <para>The <emphasis>
device</emphasis>
 field specifies the ID of an extension device; <emphasis>
val1</emphasis>
 and <emphasis>
val2</emphasis>
 specify valuators on that device. If <emphasis>
device</emphasis>
 is illegal or if neither <emphasis>
val1</emphasis>
 nor <emphasis>
val2</emphasis>
 specifies a legal valuator, this action behaves like <emphasis>
SA_NoAction</emphasis>
.
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
valn</emphasis>
 specifies a legal valuator and <emphasis>
valnWhat</emphasis>
 is not <emphasis>
SA_IgnoreVal</emphasis>
, the specified value is adjusted as specified by <emphasis>
valnWhat</emphasis>
:
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
valnWhat</emphasis>
 is <emphasis>
SA_SetValMin</emphasis>
, <emphasis>
valn</emphasis>
 is set to its minimum legal value.
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
valnWhat</emphasis>
 is <emphasis>
SA_SetValCenter</emphasis>
, <emphasis>
valn</emphasis>
 is centered (to (max-min)/2).
  </para>
</listitem>
<listitem>
  <para>If <emphasis>
valnWhat</emphasis>
 is <emphasis>
SA_SetValMax</emphasis>
, <emphasis>
valn</emphasis>
 is set to its maximum legal value.
  </para>
</listitem>
<listitem>
  <para>if <emphasis>
valnWhat</emphasis>
 is <emphasis>
SA_SetValRelative</emphasis>
, <mediaobject>
 <imageobject> <imagedata format="SVG" fileref="XKBproto-4.svg"/>
 </imageobject>
 </mediaobject>

 is added to <emphasis>
valn</emphasis>
.
  </para>
</listitem>
<listitem>
  <para>if <emphasis>
valnWhat</emphasis>
 is <emphasis>
SA_SetValAbsolute</emphasis>
, <emphasis>
valn</emphasis>
 is set to <mediaobject>
 <imageobject> <imagedata format="SVG" fileref="XKBproto-5.svg"/>
 </imageobject>
 </mediaobject>

.
  </para>
</listitem>
<listitem>
  <para>Illegal values for <emphasis>
SA_SetValRelative</emphasis>
 or <emphasis>
SA_SetValAbsolute</emphasis>
 are clamped into range.
  </para>
</listitem>
</itemizedlist>
</entry>
  </row>
</tbody>
</tgroup>
</informaltable>

<para>
If <emphasis>
StickyKeys</emphasis>
 are enabled, all <emphasis>
SA_SetMods</emphasis>
 and <emphasis>
SA_SetGroup</emphasis>
 actions act like <emphasis>
SA_LatchMods</emphasis>
 and <emphasis>
SA_LatchGroup</emphasis>
 respectively. If the <emphasis>
LatchToLock</emphasis>
 AccessX option is set, either action behaves as if both the <emphasis>
SA_ClearLocks</emphasis>
 and <emphasis>
SA_LatchToLock</emphasis>
 flags are set.
</para>


<para>
Actions which cause an event from another key or from a button on another
device immediately generate the specified event. These actions do not consider
the behavior or actions (if any) that are bound to the key or button to which
the event is redirected.
</para>


<para>
Core events generated by server actions contain the keyboard state that was in
effect at the time the key event occurred; the reported state does not reflect
any changes in state that occur as a result of the actions bound to the key
event that caused them.
</para>


<para>
Events sent to clients that have not issued an <emphasis>
XkbUseExtension</emphasis>
 request contain a compatibility state in place of the actual XKB keyboard
state. See <link linkend="effects_of_xkb_on_core_protocol_events">Effects of XKB on Core
Protocol Events</link> for a description of this compatibility mapping.
</para>


</sect1>
<sect1 id='delivering_a_key_or_button_event_to_a_client'>
<title>Delivering a Key or Button Event to a Client</title>

<para>
The window and client that receive core protocol and input extension key or
button events are determined using the focus policy, window hierarchy and
passive grabs as specified by the core protocol and the input extension, with
the following changes:
</para>

<itemizedlist>
<listitem>
  <para>A passive grab triggers if the modifier state specified in the grab
matches the grab compatibility state (described in <link
linkend="compatibility_components_of_keyboard_state">Compatibility Components of Keyboard
State</link>). Clients can choose to use the XKB grab state instead by setting
the <emphasis>
GrabsUseXKBState</emphasis>
 per-client flag. This flag affects all passive grabs that are requested by the
client which sets it but does not affect passive grabs that are set by any
other client.
  </para>
</listitem>
<listitem>
  <para>The state field of events which trigger a passive grab reports the XKB
or compatibility grab state in effect at the time the grab is triggered; the
state field of the corresponding release event reports the corresponding grab
state in effect when the key or button is released.
  </para>
</listitem>
<listitem>
  <para>If the <emphasis>
LookupStateWhenGrabbed</emphasis>
 per-client flag is set, all key or button events that occur while a keyboard
or pointer grab is active contain the XKB or compatibility lookup state,
depending on the value of the <emphasis>
GrabsUseXKBState</emphasis>
 per-client flag. If <emphasis>
LookupStateWhenGrabbed</emphasis>
 is not set, they include the XKB or compatibility grab state, instead.
  </para>
</listitem>
<listitem>
  <para>Otherwise, the state field of events that do not trigger a passive grab
report is derived from the XKB effective modifiers and group, as described in
<link linkend="computing_a_state_field_from_an_xkb_state">Computing A State Field from an
XKB State</link>.
  </para>
</listitem>
<listitem>
  <para>If a key release event is the result of an autorepeating key that is
being held down, and the client to which the event is reported has requested
detectable autorepeat (see <link linkend="detectable_autorepeat">
Detectable Autorepeat</link>), the event is not delivered to the client.
  </para>
</listitem>
</itemizedlist>

<para>
The following section explains the intent of the XKB interactions with core
protocol grabs and the reason that the per-client flags are needed.
</para>


<sect2 id='xkb_interactions_with_core_protocol_grabs'>
<title>XKB Interactions With Core Protocol Grabs</title>

<para>
XKB provides the separate lookup and grab states to help work around some
difficulties with the way the core protocol specifies passive grabs.
Unfortunately, many clients work around those problems differently, and the way
that XKB handles grabs and reports keyboard state can sometimes interact with
those client workarounds in unexpected and unpleasant ways.
</para>


<para>
To provide more reasonable behavior for clients that are aware of XKB without
causing problems for clients that are unaware of XKB, this extension provides
two per-client flags that specify the way that XKB and the core protocol should
interact.
</para>

<itemizedlist>
<listitem>
  <para>The largest problems arise from the fact that an XKB state field
encodes an explicit keyboard group in bits 13-14 (as described in <link
linkend="computing_a_state_field_from_an_xkb_state">Computing A State Field from an XKB
State</link>), while pre-XKB clients use one of the eight keyboard modifiers
to select an alternate keyboard group. To make existing clients behave
reasonably, XKB normally uses the compatibility grab state instead of the XKB
grab state to determine whether or not a passive grab is triggered. XKB-aware
clients can set the <emphasis>
GrabsUseXKBState</emphasis>
 per-client flag to indicate that they are specifying passive grabs using an
XKB state.
  </para>
</listitem>
<listitem>
  <para>Some toolkits start an active grab when a passive grab is triggered, in
order to have more control over the conditions under which the grab is
terminated. Unfortunately, the fact that XKB reports a different state in
events that trigger or terminate grabs means that this grab simulation can fail
to terminate the grab under some conditions. To work around this problem, XKB
normally reports the grab state in all events whenever a grab is active.
Clients which do not use active grabs like this can set the <emphasis>
LookupStateWhenGrabbed</emphasis>
 per-client flag in order to receive the same state component whether or not a
grab is active.
  </para>
<para>
The <emphasis>
GrabsUseXKBState</emphasis>
 per-client flag also applies to the state of events sent while a grab is
active. If it is set, events during a grab contain the XKB lookup or grab
state; by default, events during a grab contain the compatibility lookup or
grab state.</para>
</listitem>
</itemizedlist>

<para>
The state used to trigger a passive grab is controlled by the setting of the
<emphasis>
GrabsUseXKBState</emphasis>
 per-client flag at the time the grab is registered. Changing this flag does
not affect existing passive grabs.
</para>
</sect2>
</sect1>
</chapter>