1XkbSelectEventDetails(3) XKB FUNCTIONS XkbSelectEventDetails(3)
2
6 XkbSelectEventDetails - Selects or deselects for a specific Xkb event
7 and optionally places conditions on when events of that type are
8 reported to your client
9
11 Bool XkbSelectEventDetails (Display *display, unsigned int device_spec,
12 unsigned int event_type, unsigned long int bits_to_change,
13 unsigned long int values_for_bits);
14
16 display
17 connection to the X server
18 device_spec
20 device ID, or XkbUseCoreKbd
21 event_type
23 Xkb event type of interest
24 bits_to_change
26 determines events to be selected / deselected
27 values_for_bits
29 1=>select, 0->deselect; for events in bits_to_change
30
32 Xkb events are selected using an event mask, much the same as normal
33 core X events are selected. However, unlike selecting core X events,
34 where you must specify the selection status (on or off) for all possi‐
35 ble event types whenever you wish to change the selection criteria for
36 any one event, Xkb allows you to restrict the specification to only the
37 event types you wish to change. This means that you do not need to
38 remember the event selection values for all possible types each time
39 you want to change one of them.
40 Many Xkb event types are generated under several different circum‐
42 stances. When selecting to receive an Xkb event, you may specify either
43 that you want it delivered under all circumstances, or that you want it
44 delivered only for a subset of the possible circumstances.
45 You can also deselect an event type that was previously selected for,
47 using the same granularity.
48 Xkb provides two functions to select and deselect delivery of Xkb
50 events. XkbSelectEvents allows you to select or deselect delivery of
51 more than one Xkb event type at once. Events selected using XkbSe‐
52 lectEvents are delivered to your program under all circumstances that
53 generate the events. To restrict delivery of an event to a subset of
54 the conditions under which it occurs, use XkbSelectEventDetails. XkbSe‐
55 lectEventDetails only allows you to change the selection conditions for
56 a single event at a time, but it provides a means of fine-tuning the
57 conditions under which the event is delivered.
58 To select or deselect for a specific Xkb event and optionally place
60 conditions on when events of that type are reported to your client, use
61 XkbSelectEventDetails. This allows you to exercise a finer granularity
62 of control over delivery of Xkb events with XkbSelectEvents.
63 While XkbSelectEvents allows multiple events to be selected, XkbSe‐
65 lectEventDetails changes the selection criteria for a single type of
66 Xkb event. The interpretation of the bits_to_change and values_for_bits
67 masks depends on the event type in question.
68 XkbSelectEventDetails changes the Xkb event selection mask for the key‐
70 board specified by device_spec and the Xkb event specified by
71 event_type. To turn on event selection for an event detail, set the
72 bit for the detail in the bits_to_change parameter and set the corre‐
73 sponding bit in the values_for_bits parameter. To turn off event detail
74 selection for a detail, set the bit for the detail in the
75 bits_to_change parameter and do not set the corresponding bit in the
76 values_for_bits parameter.
77 If an invalid event type is specified, a BadValue protocol error
79 results. If a bit is not set in the bits_to_change parameter, but the
80 corresponding bit is set in the values_for_bits parameter, a BadMatch
81 protocol error results. If an undefined bit is set in either the
82 bits_to_change or the values_for_bits parameter, a BadValue protocol
83 error results.
84 For each type of Xkb event, the legal event details that you can spec‐
86 ify in the XkbSelectEventDetails request are listed in the chapters
87 that describe each event in detail.
88
90 BadMatch A compatible version of Xkb was not available in the
91 server or an argument has correct type and range, but is
92 otherwise invalid
93 BadValue An argument is out of range
95
97 XkbSelectEvents(3), XkbUseCoreKbd(3)
98X Version 11 libX11 1.6.5 XkbSelectEventDetails(3)