xcb_xkb_get_map(3)

1xcb_xkb_get_map(3)               XCB Requests               xcb_xkb_get_map(3)
2
3
4

NAME

6       xcb_xkb_get_map -
7

SYNOPSIS

9       #include <xcb/xkb.h>
10
11   Request function
12       xcb_xkb_get_map_cookie_t xcb_xkb_get_map(xcb_connection_t *conn,
13              xcb_xkb_device_spec_t deviceSpec, uint16_t full,
14              uint16_t partial, uint8_t firstType, uint8_t nTypes,
15              xcb_keycode_t firstKeySym, uint8_t nKeySyms,
16              xcb_keycode_t firstKeyAction, uint8_t nKeyActions,
17              xcb_keycode_t firstKeyBehavior, uint8_t nKeyBehaviors,
18              uint16_t virtualMods, xcb_keycode_t firstKeyExplicit,
19              uint8_t nKeyExplicit, xcb_keycode_t firstModMapKey,
20              uint8_t nModMapKeys, xcb_keycode_t firstVModMapKey,
21              uint8_t nVModMapKeys);
22
23   Reply datastructure
24       typedef struct xcb_xkb_get_map_reply_t {
25           uint8_t       response_type;
26           uint8_t       deviceID;
27           uint16_t      sequence;
28           uint32_t      length;
29           uint8_t       pad0[2];
30           xcb_keycode_t minKeyCode;
31           xcb_keycode_t maxKeyCode;
32           uint16_t      present;
33           uint8_t       firstType;
34           uint8_t       nTypes;
35           uint8_t       totalTypes;
36           xcb_keycode_t firstKeySym;
37           uint16_t      totalSyms;
38           uint8_t       nKeySyms;
39           xcb_keycode_t firstKeyAction;
40           uint16_t      totalActions;
41           uint8_t       nKeyActions;
42           xcb_keycode_t firstKeyBehavior;
43           uint8_t       nKeyBehaviors;
44           uint8_t       totalKeyBehaviors;
45           xcb_keycode_t firstKeyExplicit;
46           uint8_t       nKeyExplicit;
47           uint8_t       totalKeyExplicit;
48           xcb_keycode_t firstModMapKey;
49           uint8_t       nModMapKeys;
50           uint8_t       totalModMapKeys;
51           xcb_keycode_t firstVModMapKey;
52           uint8_t       nVModMapKeys;
53           uint8_t       totalVModMapKeys;
54           uint8_t       pad1;
55           uint16_t      virtualMods;
56       } xcb_xkb_get_map_reply_t;
57
58   Reply function
59       xcb_xkb_get_map_reply_t *xcb_xkb_get_map_reply(xcb_connection_t *conn,
60              xcb_xkb_get_map_cookie_t cookie, xcb_generic_error_t **e);
61
62   Reply accessors
63       xcb_xkb_get_map_map_t *xcb_xkb_get_map_map (const
64       xcb_xkb_get_map_request_t *reply)
65

REQUEST ARGUMENTS

67       conn      The XCB connection to X11.
68
69       deviceSpec
70                 TODO: NOT YET DOCUMENTED.
71
72       full      TODO: NOT YET DOCUMENTED.
73
74       partial   TODO: NOT YET DOCUMENTED.
75
76       firstType TODO: NOT YET DOCUMENTED.
77
78       nTypes    TODO: NOT YET DOCUMENTED.
79
80       firstKeySym
81                 TODO: NOT YET DOCUMENTED.
82
83       nKeySyms  TODO: NOT YET DOCUMENTED.
84
85       firstKeyAction
86                 TODO: NOT YET DOCUMENTED.
87
88       nKeyActions
89                 TODO: NOT YET DOCUMENTED.
90
91       firstKeyBehavior
92                 TODO: NOT YET DOCUMENTED.
93
94       nKeyBehaviors
95                 TODO: NOT YET DOCUMENTED.
96
97       virtualMods
98                 TODO: NOT YET DOCUMENTED.
99
100       firstKeyExplicit
101                 TODO: NOT YET DOCUMENTED.
102
103       nKeyExplicit
104                 TODO: NOT YET DOCUMENTED.
105
106       firstModMapKey
107                 TODO: NOT YET DOCUMENTED.
108
109       nModMapKeys
110                 TODO: NOT YET DOCUMENTED.
111
112       firstVModMapKey
113                 TODO: NOT YET DOCUMENTED.
114
115       nVModMapKeys
116                 TODO: NOT YET DOCUMENTED.
117

REPLY FIELDS

119       response_type
120                 The type of this reply, in this case XCB_XKB_GET_MAP. This
121                 field is also present in the xcb_generic_reply_t and can be
122                 used to tell replies apart from each other.
123
124       sequence  The sequence number of the last request processed by the X11
125                 server.
126
127       length    The length of the reply, in words (a word is 4 bytes).
128
129       deviceID  TODO: NOT YET DOCUMENTED.
130
131       minKeyCode
132                 TODO: NOT YET DOCUMENTED.
133
134       maxKeyCode
135                 TODO: NOT YET DOCUMENTED.
136
137       present   TODO: NOT YET DOCUMENTED.
138
139       firstType TODO: NOT YET DOCUMENTED.
140
141       nTypes    TODO: NOT YET DOCUMENTED.
142
143       totalTypes
144                 TODO: NOT YET DOCUMENTED.
145
146       firstKeySym
147                 TODO: NOT YET DOCUMENTED.
148
149       totalSyms TODO: NOT YET DOCUMENTED.
150
151       nKeySyms  TODO: NOT YET DOCUMENTED.
152
153       firstKeyAction
154                 TODO: NOT YET DOCUMENTED.
155
156       totalActions
157                 TODO: NOT YET DOCUMENTED.
158
159       nKeyActions
160                 TODO: NOT YET DOCUMENTED.
161
162       firstKeyBehavior
163                 TODO: NOT YET DOCUMENTED.
164
165       nKeyBehaviors
166                 TODO: NOT YET DOCUMENTED.
167
168       totalKeyBehaviors
169                 TODO: NOT YET DOCUMENTED.
170
171       firstKeyExplicit
172                 TODO: NOT YET DOCUMENTED.
173
174       nKeyExplicit
175                 TODO: NOT YET DOCUMENTED.
176
177       totalKeyExplicit
178                 TODO: NOT YET DOCUMENTED.
179
180       firstModMapKey
181                 TODO: NOT YET DOCUMENTED.
182
183       nModMapKeys
184                 TODO: NOT YET DOCUMENTED.
185
186       totalModMapKeys
187                 TODO: NOT YET DOCUMENTED.
188
189       firstVModMapKey
190                 TODO: NOT YET DOCUMENTED.
191
192       nVModMapKeys
193                 TODO: NOT YET DOCUMENTED.
194
195       totalVModMapKeys
196                 TODO: NOT YET DOCUMENTED.
197
198       virtualMods
199                 TODO: NOT YET DOCUMENTED.
200

DESCRIPTION

RETURN VALUE

203       Returns an xcb_xkb_get_map_cookie_t. Errors have to be handled when
204       calling the reply function xcb_xkb_get_map_reply.
205
206       If you want to handle errors in the event loop instead, use
207       xcb_xkb_get_map_unchecked. See xcb-requests(3) for details.
208

ERRORS

210       This request does never generate any errors.
211

AUTHOR

214       Generated from xkb.xml. Contact xcb@lists.freedesktop.org for correc‐
215       tions and improvements.
216
217
218
219X Version 11                      libxcb 1.12               xcb_xkb_get_map(3)