brlapi_keycodes(3)

1Types and Defines fore BrlAPI Key CodBTeryslp(Ae3Ps)Iand Defines fore BrlAPI Key Codes(3)
2
3
4

NAME

6       Types and Defines fore BrlAPI Key Codes -
7       #define BRLAPI_KEY_CMD_NOOP   (BRLAPI_KEY_CMD(0) + 0)
8       #define BRLAPI_KEY_CMD_LNUP   (BRLAPI_KEY_CMD(0) + 1)
9       #define BRLAPI_KEY_CMD_LNDN   (BRLAPI_KEY_CMD(0) + 2)
10       #define BRLAPI_KEY_CMD_WINUP   (BRLAPI_KEY_CMD(0) + 3)
11       #define BRLAPI_KEY_CMD_WINDN   (BRLAPI_KEY_CMD(0) + 4)
12       #define BRLAPI_KEY_CMD_PRDIFLN   (BRLAPI_KEY_CMD(0) + 5)
13       #define BRLAPI_KEY_CMD_NXDIFLN   (BRLAPI_KEY_CMD(0) + 6)
14       #define BRLAPI_KEY_CMD_ATTRUP   (BRLAPI_KEY_CMD(0) + 7)
15       #define BRLAPI_KEY_CMD_ATTRDN   (BRLAPI_KEY_CMD(0) + 8)
16       #define BRLAPI_KEY_CMD_TOP   (BRLAPI_KEY_CMD(0) + 9)
17       #define BRLAPI_KEY_CMD_BOT   (BRLAPI_KEY_CMD(0) + 10)
18       #define BRLAPI_KEY_CMD_TOP_LEFT   (BRLAPI_KEY_CMD(0) + 11)
19       #define BRLAPI_KEY_CMD_BOT_LEFT   (BRLAPI_KEY_CMD(0) + 12)
20       #define BRLAPI_KEY_CMD_PRPGRPH   (BRLAPI_KEY_CMD(0) + 13)
21       #define BRLAPI_KEY_CMD_NXPGRPH   (BRLAPI_KEY_CMD(0) + 14)
22       #define BRLAPI_KEY_CMD_PRPROMPT   (BRLAPI_KEY_CMD(0) + 15)
23       #define BRLAPI_KEY_CMD_NXPROMPT   (BRLAPI_KEY_CMD(0) + 16)
24       #define BRLAPI_KEY_CMD_PRSEARCH   (BRLAPI_KEY_CMD(0) + 17)
25       #define BRLAPI_KEY_CMD_NXSEARCH   (BRLAPI_KEY_CMD(0) + 18)
26       #define BRLAPI_KEY_CMD_CHRLT   (BRLAPI_KEY_CMD(0) + 19)
27       #define BRLAPI_KEY_CMD_CHRRT   (BRLAPI_KEY_CMD(0) + 20)
28       #define BRLAPI_KEY_CMD_HWINLT   (BRLAPI_KEY_CMD(0) + 21)
29       #define BRLAPI_KEY_CMD_HWINRT   (BRLAPI_KEY_CMD(0) + 22)
30       #define BRLAPI_KEY_CMD_FWINLT   (BRLAPI_KEY_CMD(0) + 23)
31       #define BRLAPI_KEY_CMD_FWINRT   (BRLAPI_KEY_CMD(0) + 24)
32       #define BRLAPI_KEY_CMD_FWINLTSKIP   (BRLAPI_KEY_CMD(0) + 25)
33       #define BRLAPI_KEY_CMD_FWINRTSKIP   (BRLAPI_KEY_CMD(0) + 26)
34       #define BRLAPI_KEY_CMD_LNBEG   (BRLAPI_KEY_CMD(0) + 27)
35       #define BRLAPI_KEY_CMD_LNEND   (BRLAPI_KEY_CMD(0) + 28)
36       #define BRLAPI_KEY_CMD_HOME   (BRLAPI_KEY_CMD(0) + 29)
37       #define BRLAPI_KEY_CMD_BACK   (BRLAPI_KEY_CMD(0) + 30)
38       #define BRLAPI_KEY_CMD_RETURN   (BRLAPI_KEY_CMD(0) + 31)
39       #define BRLAPI_KEY_CMD_FREEZE   (BRLAPI_KEY_CMD(0) + 32)
40       #define BRLAPI_KEY_CMD_DISPMD   (BRLAPI_KEY_CMD(0) + 33)
41       #define BRLAPI_KEY_CMD_SIXDOTS   (BRLAPI_KEY_CMD(0) + 34)
42       #define BRLAPI_KEY_CMD_SLIDEWIN   (BRLAPI_KEY_CMD(0) + 35)
43       #define BRLAPI_KEY_CMD_SKPIDLNS   (BRLAPI_KEY_CMD(0) + 36)
44       #define BRLAPI_KEY_CMD_SKPBLNKWINS   (BRLAPI_KEY_CMD(0) + 37)
45       #define BRLAPI_KEY_CMD_CSRVIS   (BRLAPI_KEY_CMD(0) + 38)
46       #define BRLAPI_KEY_CMD_CSRHIDE   (BRLAPI_KEY_CMD(0) + 39)
47       #define BRLAPI_KEY_CMD_CSRTRK   (BRLAPI_KEY_CMD(0) + 40)
48       #define BRLAPI_KEY_CMD_CSRSIZE   (BRLAPI_KEY_CMD(0) + 41)
49       #define BRLAPI_KEY_CMD_CSRBLINK   (BRLAPI_KEY_CMD(0) + 42)
50       #define BRLAPI_KEY_CMD_ATTRVIS   (BRLAPI_KEY_CMD(0) + 43)
51       #define BRLAPI_KEY_CMD_ATTRBLINK   (BRLAPI_KEY_CMD(0) + 44)
52       #define BRLAPI_KEY_CMD_CAPBLINK   (BRLAPI_KEY_CMD(0) + 45)
53       #define BRLAPI_KEY_CMD_TUNES   (BRLAPI_KEY_CMD(0) + 46)
54       #define BRLAPI_KEY_CMD_AUTOREPEAT   (BRLAPI_KEY_CMD(0) + 47)
55       #define BRLAPI_KEY_CMD_AUTOSPEAK   (BRLAPI_KEY_CMD(0) + 48)
56       #define BRLAPI_KEY_CMD_HELP   (BRLAPI_KEY_CMD(0) + 49)
57       #define BRLAPI_KEY_CMD_INFO   (BRLAPI_KEY_CMD(0) + 50)
58       #define BRLAPI_KEY_CMD_LEARN   (BRLAPI_KEY_CMD(0) + 51)
59       #define BRLAPI_KEY_CMD_PREFMENU   (BRLAPI_KEY_CMD(0) + 52)
60       #define BRLAPI_KEY_CMD_PREFSAVE   (BRLAPI_KEY_CMD(0) + 53)
61       #define BRLAPI_KEY_CMD_PREFLOAD   (BRLAPI_KEY_CMD(0) + 54)
62       #define BRLAPI_KEY_CMD_MENU_FIRST_ITEM   (BRLAPI_KEY_CMD(0) + 55)
63       #define BRLAPI_KEY_CMD_MENU_LAST_ITEM   (BRLAPI_KEY_CMD(0) + 56)
64       #define BRLAPI_KEY_CMD_MENU_PREV_ITEM   (BRLAPI_KEY_CMD(0) + 57)
65       #define BRLAPI_KEY_CMD_MENU_NEXT_ITEM   (BRLAPI_KEY_CMD(0) + 58)
66       #define BRLAPI_KEY_CMD_MENU_PREV_SETTING   (BRLAPI_KEY_CMD(0) + 59)
67       #define BRLAPI_KEY_CMD_MENU_NEXT_SETTING   (BRLAPI_KEY_CMD(0) + 60)
68       #define BRLAPI_KEY_CMD_MUTE   (BRLAPI_KEY_CMD(0) + 61)
69       #define BRLAPI_KEY_CMD_SPKHOME   (BRLAPI_KEY_CMD(0) + 62)
70       #define BRLAPI_KEY_CMD_SAY_LINE   (BRLAPI_KEY_CMD(0) + 63)
71       #define BRLAPI_KEY_CMD_SAY_ABOVE   (BRLAPI_KEY_CMD(0) + 64)
72       #define BRLAPI_KEY_CMD_SAY_BELOW   (BRLAPI_KEY_CMD(0) + 65)
73       #define BRLAPI_KEY_CMD_SAY_SLOWER   (BRLAPI_KEY_CMD(0) + 66)
74       #define BRLAPI_KEY_CMD_SAY_FASTER   (BRLAPI_KEY_CMD(0) + 67)
75       #define BRLAPI_KEY_CMD_SAY_SOFTER   (BRLAPI_KEY_CMD(0) + 68)
76       #define BRLAPI_KEY_CMD_SAY_LOUDER   (BRLAPI_KEY_CMD(0) + 69)
77       #define BRLAPI_KEY_CMD_SWITCHVT_PREV   (BRLAPI_KEY_CMD(0) + 70)
78       #define BRLAPI_KEY_CMD_SWITCHVT_NEXT   (BRLAPI_KEY_CMD(0) + 71)
79       #define BRLAPI_KEY_CMD_CSRJMP_VERT   (BRLAPI_KEY_CMD(0) + 72)
80       #define BRLAPI_KEY_CMD_PASTE   (BRLAPI_KEY_CMD(0) + 73)
81       #define BRLAPI_KEY_CMD_RESTARTBRL   (BRLAPI_KEY_CMD(0) + 74)
82       #define BRLAPI_KEY_CMD_RESTARTSPEECH   (BRLAPI_KEY_CMD(0) + 75)
83       #define BRLAPI_KEY_CMD_OFFLINE   (BRLAPI_KEY_CMD(0) + 76)
84       #define BRLAPI_KEY_FLG_TOGGLE_ON   [22mBRLAPI_KEY_FLG(0X0100)
85       #define BRLAPI_KEY_FLG_TOGGLE_OFF   [22mBRLAPI_KEY_FLG(0X0200)
86       #define BRLAPI_KEY_FLG_TOGGLE_MASK   (BRLAPI_KEY_FLG_TOGGLE_ON |
87           BRLAPI_KEY_FLG_TOGGLE_OFF)
88       #define BRLAPI_KEY_FLG_ROUTE   [22mBRLAPI_KEY_FLG(0X0400)
89       #define BRLAPI_KEY_FLG_REPEAT_INITIAL   [22mBRLAPI_KEY_FLG(0X8000)
90       #define BRLAPI_KEY_FLG_REPEAT_DELAY   [22mBRLAPI_KEY_FLG(0X4000)
91       #define BRLAPI_KEY_FLG_REPEAT_MASK   (BRLAPI_KEY_FLG_REPEAT_INITIAL |
92           BRLAPI_KEY_FLG_REPEAT_DELAY)
93       #define BRLAPI_KEY_CMD_ROUTE   [22mBRLAPI_KEY_CMD(0X01)
94       #define BRLAPI_KEY_CMD_CUTBEGIN   [22mBRLAPI_KEY_CMD(0X02)
95       #define BRLAPI_KEY_CMD_CUTAPPEND   [22mBRLAPI_KEY_CMD(0X03)
96       #define BRLAPI_KEY_CMD_CUTRECT   [22mBRLAPI_KEY_CMD(0X04)
97       #define BRLAPI_KEY_CMD_CUTLINE   [22mBRLAPI_KEY_CMD(0X05)
98       #define BRLAPI_KEY_CMD_SWITCHVT   [22mBRLAPI_KEY_CMD(0X06)
99       #define BRLAPI_KEY_CMD_PRINDENT   [22mBRLAPI_KEY_CMD(0X07)
100       #define BRLAPI_KEY_CMD_NXINDENT   [22mBRLAPI_KEY_CMD(0X08)
101       #define BRLAPI_KEY_CMD_DESCCHAR   [22mBRLAPI_KEY_CMD(0X09)
102       #define BRLAPI_KEY_CMD_SETLEFT   [22mBRLAPI_KEY_CMD(0X0A)
103       #define BRLAPI_KEY_CMD_SETMARK   [22mBRLAPI_KEY_CMD(0X0B)
104       #define BRLAPI_KEY_CMD_GOTOMARK   [22mBRLAPI_KEY_CMD(0X0C)
105       #define BRLAPI_KEY_CMD_GOTOLINE   [22mBRLAPI_KEY_CMD(0X0D)
106       #define BRLAPI_KEY_FLG_LINE_SCALED   [22mBRLAPI_KEY_FLG(0X0100)
107       #define BRLAPI_KEY_FLG_LINE_TOLEFT   [22mBRLAPI_KEY_FLG(0X0200)
108       #define BRLAPI_KEY_CMD_PRDIFCHAR   [22mBRLAPI_KEY_CMD(0X0E)
109       #define BRLAPI_KEY_CMD_NXDIFCHAR   [22mBRLAPI_KEY_CMD(0X0F)
110       #define BRLAPI_KEY_CMD_PASSDOTS   [22mBRLAPI_KEY_CMD(0X22)
111       #define BRLAPI_KEY_FLG_SHIFT   [22mBRLAPI_KEY_FLG(0X01)
112       #define BRLAPI_KEY_FLG_UPPER   [22mBRLAPI_KEY_FLG(0X02)
113       #define BRLAPI_KEY_FLG_CONTROL   [22mBRLAPI_KEY_FLG(0X04)
114       #define BRLAPI_KEY_FLG_META   [22mBRLAPI_KEY_FLG(0X08)
115       #define BRLAPI_DOT1   0001
116       #define BRLAPI_DOT2   0002
117       #define BRLAPI_DOT3   0004
118       #define BRLAPI_DOT4   0010
119       #define BRLAPI_DOT5   0020
120       #define BRLAPI_DOT6   0040
121       #define BRLAPI_DOT7   0100
122       #define BRLAPI_DOT8   0200
123       #define BRLAPI_DOTC   0400
124       #define BRLAPI_KEY_CMD_PASSAT   [22mBRLAPI_KEY_CMD(0X23)
125       #define BRLAPI_KEY_CMD_PASSXT   [22mBRLAPI_KEY_CMD(0X24)
126       #define BRLAPI_KEY_CMD_PASSPS2   [22mBRLAPI_KEY_CMD(0X25)
127       #define BRLAPI_KEY_FLG_KBD_RELEASE   [22mBRLAPI_KEY_FLG(0X0100)
128       #define BRLAPI_KEY_FLG_KBD_EMUL0   [22mBRLAPI_KEY_FLG(0X0200)
129       #define BRLAPI_KEY_FLG_KBD_EMUL1   [22mBRLAPI_KEY_FLG(0X0400)
130       #define BRLAPI_DOTS(dot1, dot2, dot3, dot4, dot5, dot6, dot7, dot8)
131       #define BRLAPI_DOT_CHORD   256
132
133   Defines
134       #define BRLAPI_PRIxKEYCODE   PRIx64
135       #define BRLAPI_PRIuKEYCODE   PRIu64
136       #define BRLAPI_KEY_MAX   UINT64_C(0XFFFFFFFFFFFFFFFF)
137       #define BRLAPI_KEY_FLAGS_MASK   UINT64_C(0XFFFFFFFF00000000)
138       #define BRLAPI_KEY_FLAGS_SHIFT   32
139       #define BRLAPI_KEY_FLG(v)   ((brlapi_keyCode_t)(v) <<
140           BRLAPI_KEY_FLAGS_SHIFT)
141       #define BRLAPI_KEY_FLG_MOD1   [22mBRLAPI_KEY_FLG(0x00000008)
142       #define BRLAPI_KEY_FLG_MOD2   [22mBRLAPI_KEY_FLG(0x00000010)
143       #define BRLAPI_KEY_FLG_MOD3   [22mBRLAPI_KEY_FLG(0x00000020)
144       #define BRLAPI_KEY_FLG_MOD4   [22mBRLAPI_KEY_FLG(0x00000040)
145       #define BRLAPI_KEY_FLG_MOD5   [22mBRLAPI_KEY_FLG(0x00000080)
146       #define BRLAPI_KEY_TYPE_MASK   UINT64_C(0X00000000E0000000)
147       #define BRLAPI_KEY_TYPE_SHIFT   29
148       #define BRLAPI_KEY_TYPE_CMD   UINT64_C(0X0000000020000000)
149       #define BRLAPI_KEY_TYPE_SYM   UINT64_C(0X0000000000000000)
150       #define BRLAPI_KEY_CODE_MASK   UINT64_C(0X000000001FFFFFFF)
151       #define BRLAPI_KEY_CODE_SHIFT   0
152       #define BRLAPI_KEY_CMD_BLK_MASK   [22mUINT64_C(0X1FFF0000)
153       #define BRLAPI_KEY_CMD_BLK_SHIFT   16
154       #define BRLAPI_KEY_CMD_ARG_MASK   [22mUINT64_C(0X0000FFFF)
155       #define BRLAPI_KEY_CMD_ARG_SHIFT   0
156       #define BRLAPI_KEY_CMD(v)   ((v) << BRLAPI_KEY_CMD_BLK_SHIFT)
157       #define BRLAPI_KEY_SYM_BACKSPACE   [22mUINT64_C(0X0000FF08)
158       #define BRLAPI_KEY_SYM_TAB   [22mUINT64_C(0X0000FF09)
159       #define BRLAPI_KEY_SYM_LINEFEED   [22mUINT64_C(0X0000FF0D)
160       #define BRLAPI_KEY_SYM_ESCAPE   [22mUINT64_C(0X0000FF1B)
161       #define BRLAPI_KEY_SYM_HOME   [22mUINT64_C(0X0000FF50)
162       #define BRLAPI_KEY_SYM_LEFT   [22mUINT64_C(0X0000FF51)
163       #define BRLAPI_KEY_SYM_UP   [22mUINT64_C(0X0000FF52)
164       #define BRLAPI_KEY_SYM_RIGHT   [22mUINT64_C(0X0000FF53)
165       #define BRLAPI_KEY_SYM_DOWN   [22mUINT64_C(0X0000FF54)
166       #define BRLAPI_KEY_SYM_PAGE_UP   [22mUINT64_C(0X0000FF55)
167       #define BRLAPI_KEY_SYM_PAGE_DOWN   [22mUINT64_C(0X0000FF56)
168       #define BRLAPI_KEY_SYM_END   [22mUINT64_C(0X0000FF57)
169       #define BRLAPI_KEY_SYM_INSERT   [22mUINT64_C(0X0000FF63)
170       #define BRLAPI_KEY_SYM_FUNCTION   [22mUINT64_C(0X0000FFBE)
171       #define BRLAPI_KEY_SYM_DELETE   [22mUINT64_C(0X0000FFFF)
172       #define BRLAPI_KEY_SYM_UNICODE   [22mUINT64_C(0X01000000)
173
174   Typedefs
175       typedef uint64_t brlapi_keyCode_t
176

Detailed Description

178       Key codes are unsigned 64 bit integers. This 64-bit space is split into
179       3 parts:
180
181       · bits 63-32 (BRLAPI_KEY_FLAGS_MASK), flags: bits 39-32 are standard X
182         modifiers (shift, control, meta, ...). Other flags are used for some
183         commands, see documentation of BRLAPI_KEY_FLG_* for their respective
184         uses.
185
186       · bits 31-29 (BRLAPI_KEY_TYPE_MASK), key type: either
187         BRLAPI_KEY_TYPE_CMD for braille commands, or BRLAPI_KEY_TYPE_SYM for
188         standard X keysyms.
189
190       · bits 28-0 (BRLAPI_KEY_CODE_MASK), key code: for braille commands, see
191         BRLAPI_KEY_CMD_* ; for standard X keysyms, this is the keysym value,
192         see X11 documentation, a complete list is probably available on your
193         system in /usr/include/X11/keysymdef.h
194
195       The third part is itself split into two parts: a command number and a
196       command value. The relative sizes of these parts vary according to the
197       key type.
198
199       For a braille command, bits 28-16 (BRLAPI_KEY_CMD_BLK_MASK) hold the
200       braille command number, while bits 15-0 (BRLAPI_KEY_CMD_ARG_MASK) hold
201       the command value.
202
203       For a X keysym, if it is a unicode keysym (0x1uvwxyz), then the command
204       number part is 0x1000000 and the value part is 0xuvwxyz. Else, the
205       command part is held by bits 28-8 and the value part is held by bits
206       7-0. This permits to easily handle usual cases like 0x00xy (latin1),
207       0x01xy (latin2), XK_Backspace (0xff08, backspace), XK_Tab (0xff09,
208       tab), ...
209
210       For instance, if key == 0x0000000020010008,
211
212       · (key & BRLAPI_KEY_TYPE_MASK) == BRLAPI_KEY_TYPE_CMD, so it's a
213         braille command
214
215       · (key & BRLAPI_KEY_CMD_BLK_MASK) == BRLAPI_KEY_CMD_ROUTE, so it's the
216         braille route command.
217
218       · (key & BRLAPI_KEY_CMD_ARG_MASK) == 8, so the highlighted cell is the
219         9th one (cells are numbered from 0)
220
221       · (key & BRLAPI_KEY_FLAGS_MASK) == 0, so no modifier key was pressed
222         during the command, and no particular flag applies to the command.
223
224       if key == 0x000000010000FF09,
225
226       · (key & BRLAPI_KEY_TYPE_MASK) == BRLAPI_KEY_TYPE_SYM, so it's a keysym
227
228       · (key & BRLAPI_KEY_CODE_MASK) == XK_Tab, so it's the tab key.
229         BRLAPI_KEY_SYM_TAB can also be used here, as well as a few other
230         BRLAPI_KEY_SYM_* constants which are provided to avoid having to
231         include X11/keysymdef.h
232
233       · (key & BRLAPI_KEY_FLAGS_MASK) == BRLAPI_KEY_FLG_SHIFT, so the shift
234         modifier was pressed during the command.
235
236       in the X11 standard some keysyms are directly unicode, for instance if
237       key == 0x0000000001001EA0,
238
239       · (key & BRLAPI_KEY_TYPE_MASK) == BRLAPI_KEY_TYPE_SYM, so it's a keysym
240
241       · (key & BRLAPI_KEY_SYM_UNICODE) != 0 so it's a unicode keysym, whose
242         value is key & (BRLAPI_KEY_SYM_UNICODE-1). Of course, one can also
243         consider (key & BRLAPI_KEY_CODE_MASK) == XK_Abelowdot
244
245       · (key & BRLAPI_KEY_FLAGS_MASK) == 0, so no modifier key was pressed
246         during the command, and no particular flag applies to the command.
247
248       The brlapi_expandKeyCode() function may be used for splitting key codes
249       into these parts.
250

Define Documentation

252   #define BRLAPI_DOT1   0001
253       upper-left dot of standard braille cell
254
255   #define BRLAPI_DOT2   0002
256       middle-left dot of standard braille cell
257
258   #define BRLAPI_DOT3   0004
259       lower-left dot of standard braille cell
260
261   #define BRLAPI_DOT4   0010
262       upper-right dot of standard braille cell
263
264   #define BRLAPI_DOT5   0020
265       middle-right dot of standard braille cell
266
267   #define BRLAPI_DOT6   0040
268       lower-right dot of standard braille cell
269
270   #define BRLAPI_DOT7   0100
271       lower-left dot of computer braille cell
272
273   #define BRLAPI_DOT8   0200
274       lower-right dot of computer braille cell
275
276   #define BRLAPI_DOT_CHORD   256
277       space key
278
279   #define BRLAPI_DOTC   0400
280       space key pressed
281
282   #define BRLAPI_DOTS(dot1, dot2, dot3, dot4, dot5, dot6, dot7, dot8)
283       Value:
284
285       (  ((dot1)? BRLAPI_DOT1: 0) |   ((dot2)? BRLAPI_DOT2: 0) |   ((dot3)? BRLAPI_DOT3: 0) |   ((dot4)? BRLAPI_DOT4: 0) |   ((dot5)? BRLAPI_DOT5: 0) |   ((dot6)? BRLAPI_DOT6: 0) |   ((dot7)? BRLAPI_DOT7: 0) |   ((dot8)? BRLAPI_DOT8: 0) )
286       Helper macro to easily produce braille patterns
287
288   #define BRLAPI_KEY_CMD(v)   ((v) << BRLAPI_KEY_CMD_BLK_SHIFT)
289   #define BRLAPI_KEY_CMD_ARG_MASK   UINT64_C(0X0000FFFF)
290       Mask for braille command value
291
292   #define BRLAPI_KEY_CMD_ARG_SHIFT   0
293       Shift for braille command value
294
295   #define BRLAPI_KEY_CMD_ATTRBLINK   (BRLAPI_KEY_CMD(0) + 44)
296       toggle attribute blinking on/off
297
298   #define BRLAPI_KEY_CMD_ATTRDN   (BRLAPI_KEY_CMD(0) + 8)
299       go down to nearest line with different highlighting
300
301   #define BRLAPI_KEY_CMD_ATTRUP   (BRLAPI_KEY_CMD(0) + 7)
302       go up to nearest line with different highlighting
303
304   #define BRLAPI_KEY_CMD_ATTRVIS   (BRLAPI_KEY_CMD(0) + 43)
305       toggle attribute underlining on/off
306
307   #define BRLAPI_KEY_CMD_AUTOREPEAT   (BRLAPI_KEY_CMD(0) + 47)
308       toggle autorepeat on/off
309
310   #define BRLAPI_KEY_CMD_AUTOSPEAK   (BRLAPI_KEY_CMD(0) + 48)
311       toggle autospeak on/off
312
313   #define BRLAPI_KEY_CMD_BACK   (BRLAPI_KEY_CMD(0) + 30)
314       go back (undo unexpected cursor tracking motion)
315
316   #define BRLAPI_KEY_CMD_BLK_MASK   UINT64_C(0X1FFF0000)
317       Mask for braille command type
318
319   #define BRLAPI_KEY_CMD_BLK_SHIFT   16
320       Shift for braille command type
321
322   #define BRLAPI_KEY_CMD_BOT   (BRLAPI_KEY_CMD(0) + 10)
323       go to bottom line
324
325   #define BRLAPI_KEY_CMD_BOT_LEFT   (BRLAPI_KEY_CMD(0) + 12)
326       go to beginning of bottom line
327
328   #define BRLAPI_KEY_CMD_CAPBLINK   (BRLAPI_KEY_CMD(0) + 45)
329       toggle capital letter blinking on/off
330
331   #define BRLAPI_KEY_CMD_CHRLT   (BRLAPI_KEY_CMD(0) + 19)
332       go left one character
333
334   #define BRLAPI_KEY_CMD_CHRRT   (BRLAPI_KEY_CMD(0) + 20)
335       go right one character
336
337   #define BRLAPI_KEY_CMD_CSRBLINK   (BRLAPI_KEY_CMD(0) + 42)
338       toggle cursor blinking on/off
339
340   #define BRLAPI_KEY_CMD_CSRHIDE   (BRLAPI_KEY_CMD(0) + 39)
341       toggle hidden cursor on/off
342
343   #define BRLAPI_KEY_CMD_CSRJMP_VERT   (BRLAPI_KEY_CMD(0) + 72)
344       bring cursor to line (no horizontal motion)
345
346   #define BRLAPI_KEY_CMD_CSRSIZE   (BRLAPI_KEY_CMD(0) + 41)
347       toggle cursor style block/underline
348
349   #define BRLAPI_KEY_CMD_CSRTRK   (BRLAPI_KEY_CMD(0) + 40)
350       toggle cursor tracking on/off
351
352   #define BRLAPI_KEY_CMD_CSRVIS   (BRLAPI_KEY_CMD(0) + 38)
353       toggle cursor visibility on/off
354
355   #define BRLAPI_KEY_CMD_CUTAPPEND   BRLAPI_KEY_CMD(0X03)
356       append to existing cut buffer from character
357
358   #define BRLAPI_KEY_CMD_CUTBEGIN   BRLAPI_KEY_CMD(0X02)
359       start new cut buffer at character
360
361   #define BRLAPI_KEY_CMD_CUTLINE   BRLAPI_KEY_CMD(0X05)
362       linear cut to character
363
364   #define BRLAPI_KEY_CMD_CUTRECT   BRLAPI_KEY_CMD(0X04)
365       rectangular cut to character
366
367   #define BRLAPI_KEY_CMD_DESCCHAR   BRLAPI_KEY_CMD(0X09)
368       describe character
369
370   #define BRLAPI_KEY_CMD_DISPMD   (BRLAPI_KEY_CMD(0) + 33)
371       toggle display mode attributes/text
372
373   #define BRLAPI_KEY_CMD_FREEZE   (BRLAPI_KEY_CMD(0) + 32)
374       toggle screen mode frozen/live
375
376   #define BRLAPI_KEY_CMD_FWINLT   (BRLAPI_KEY_CMD(0) + 23)
377       go left one window
378
379   #define BRLAPI_KEY_CMD_FWINLTSKIP   (BRLAPI_KEY_CMD(0) + 25)
380       go left to nearest non-blank window
381
382   #define BRLAPI_KEY_CMD_FWINRT   (BRLAPI_KEY_CMD(0) + 24)
383       go right one window
384
385   #define BRLAPI_KEY_CMD_FWINRTSKIP   (BRLAPI_KEY_CMD(0) + 26)
386       go right to nearest non-blank window
387
388   #define BRLAPI_KEY_CMD_GOTOLINE   BRLAPI_KEY_CMD(0X0D)
389       go to line
390
391   #define BRLAPI_KEY_CMD_GOTOMARK   BRLAPI_KEY_CMD(0X0C)
392       go to remembered window position
393
394   #define BRLAPI_KEY_CMD_HELP   (BRLAPI_KEY_CMD(0) + 49)
395       enter/leave help display
396
397   #define BRLAPI_KEY_CMD_HOME   (BRLAPI_KEY_CMD(0) + 29)
398       go to cursor
399
400   #define BRLAPI_KEY_CMD_HWINLT   (BRLAPI_KEY_CMD(0) + 21)
401       go left half a window
402
403   #define BRLAPI_KEY_CMD_HWINRT   (BRLAPI_KEY_CMD(0) + 22)
404       go right half a window
405
406   #define BRLAPI_KEY_CMD_INFO   (BRLAPI_KEY_CMD(0) + 50)
407       enter/leave status display
408
409   #define BRLAPI_KEY_CMD_LEARN   (BRLAPI_KEY_CMD(0) + 51)
410       enter/leave command learn mode
411
412   #define BRLAPI_KEY_CMD_LNBEG   (BRLAPI_KEY_CMD(0) + 27)
413       go to beginning of line
414
415   #define BRLAPI_KEY_CMD_LNDN   (BRLAPI_KEY_CMD(0) + 2)
416       go down one line
417
418   #define BRLAPI_KEY_CMD_LNEND   (BRLAPI_KEY_CMD(0) + 28)
419       go to end of line
420
421   #define BRLAPI_KEY_CMD_LNUP   (BRLAPI_KEY_CMD(0) + 1)
422       go up one line
423
424   #define BRLAPI_KEY_CMD_MENU_FIRST_ITEM   (BRLAPI_KEY_CMD(0) + 55)
425       go to first item in menu
426
427   #define BRLAPI_KEY_CMD_MENU_LAST_ITEM   (BRLAPI_KEY_CMD(0) + 56)
428       go to last item in menu
429
430   #define BRLAPI_KEY_CMD_MENU_NEXT_ITEM   (BRLAPI_KEY_CMD(0) + 58)
431       go to next item in menu
432
433   #define BRLAPI_KEY_CMD_MENU_NEXT_SETTING   (BRLAPI_KEY_CMD(0) + 60)
434       change current item in menu to next choice
435
436   #define BRLAPI_KEY_CMD_MENU_PREV_ITEM   (BRLAPI_KEY_CMD(0) + 57)
437       go to previous item in menu
438
439   #define BRLAPI_KEY_CMD_MENU_PREV_SETTING   (BRLAPI_KEY_CMD(0) + 59)
440       change current item in menu to previous choice
441
442   #define BRLAPI_KEY_CMD_MUTE   (BRLAPI_KEY_CMD(0) + 61)
443       stop speaking immediately
444
445   #define BRLAPI_KEY_CMD_NOOP   (BRLAPI_KEY_CMD(0) + 0)
446       do nothing
447
448   #define BRLAPI_KEY_CMD_NXDIFCHAR   BRLAPI_KEY_CMD(0X0F)
449       go down to nearest line with different character
450
451   #define BRLAPI_KEY_CMD_NXDIFLN   (BRLAPI_KEY_CMD(0) + 6)
452       go down to nearest line with different content
453
454   #define BRLAPI_KEY_CMD_NXINDENT   BRLAPI_KEY_CMD(0X08)
455       go down to nearest line without greater indent
456
457   #define BRLAPI_KEY_CMD_NXPGRPH   (BRLAPI_KEY_CMD(0) + 14)
458       go down to first line of next paragraph
459
460   #define BRLAPI_KEY_CMD_NXPROMPT   (BRLAPI_KEY_CMD(0) + 16)
461       go down to next command prompt
462
463   #define BRLAPI_KEY_CMD_NXSEARCH   (BRLAPI_KEY_CMD(0) + 18)
464       search forward for content of cut buffer
465
466   #define BRLAPI_KEY_CMD_OFFLINE   (BRLAPI_KEY_CMD(0) + 76)
467       braille display temporarily unavailable
468
469   #define BRLAPI_KEY_CMD_PASSAT   BRLAPI_KEY_CMD(0X23)
470       input AT (aka set 2) keyboard scan code
471
472   #define BRLAPI_KEY_CMD_PASSDOTS   BRLAPI_KEY_CMD(0X22)
473       input character as braille dots
474
475   #define BRLAPI_KEY_CMD_PASSPS2   BRLAPI_KEY_CMD(0X25)
476       input PS/2 (aka set 3) keyboard scan code
477
478   #define BRLAPI_KEY_CMD_PASSXT   BRLAPI_KEY_CMD(0X24)
479       input XT (aka set 1) keyboard scan code
480
481   #define BRLAPI_KEY_CMD_PASTE   (BRLAPI_KEY_CMD(0) + 73)
482       insert cut buffer at cursor
483
484   #define BRLAPI_KEY_CMD_PRDIFCHAR   BRLAPI_KEY_CMD(0X0E)
485       go up to nearest line with different character
486
487   #define BRLAPI_KEY_CMD_PRDIFLN   (BRLAPI_KEY_CMD(0) + 5)
488       go up to nearest line with different content
489
490   #define BRLAPI_KEY_CMD_PREFLOAD   (BRLAPI_KEY_CMD(0) + 54)
491       restore saved preferences
492
493   #define BRLAPI_KEY_CMD_PREFMENU   (BRLAPI_KEY_CMD(0) + 52)
494       enter/leave preferences menu
495
496   #define BRLAPI_KEY_CMD_PREFSAVE   (BRLAPI_KEY_CMD(0) + 53)
497       save current preferences
498
499   #define BRLAPI_KEY_CMD_PRINDENT   BRLAPI_KEY_CMD(0X07)
500       go up to nearest line without greater indent
501
502   #define BRLAPI_KEY_CMD_PRPGRPH   (BRLAPI_KEY_CMD(0) + 13)
503       go up to last line of previous paragraph
504
505   #define BRLAPI_KEY_CMD_PRPROMPT   (BRLAPI_KEY_CMD(0) + 15)
506       go up to previous command prompt
507
508   #define BRLAPI_KEY_CMD_PRSEARCH   (BRLAPI_KEY_CMD(0) + 17)
509       search backward for content of cut buffer
510
511   #define BRLAPI_KEY_CMD_RESTARTBRL   (BRLAPI_KEY_CMD(0) + 74)
512       reinitialize braille driver
513
514   #define BRLAPI_KEY_CMD_RESTARTSPEECH   (BRLAPI_KEY_CMD(0) + 75)
515       reinitialize speech driver
516
517   #define BRLAPI_KEY_CMD_RETURN   (BRLAPI_KEY_CMD(0) + 31)
518       go back (after cursor tracking) or to cursor (cursor not in window)
519
520   #define BRLAPI_KEY_CMD_ROUTE   BRLAPI_KEY_CMD(0X01)
521       bring cursor to character
522
523   #define BRLAPI_KEY_CMD_SAY_ABOVE   (BRLAPI_KEY_CMD(0) + 64)
524       speak from top of screen through current line
525
526   #define BRLAPI_KEY_CMD_SAY_BELOW   (BRLAPI_KEY_CMD(0) + 65)
527       speak from current line through bottom of screen
528
529   #define BRLAPI_KEY_CMD_SAY_FASTER   (BRLAPI_KEY_CMD(0) + 67)
530       increase speech rate
531
532   #define BRLAPI_KEY_CMD_SAY_LINE   (BRLAPI_KEY_CMD(0) + 63)
533       speak current line
534
535   #define BRLAPI_KEY_CMD_SAY_LOUDER   (BRLAPI_KEY_CMD(0) + 69)
536       increase speech volume
537
538   #define BRLAPI_KEY_CMD_SAY_SLOWER   (BRLAPI_KEY_CMD(0) + 66)
539       decrease speech rate
540
541   #define BRLAPI_KEY_CMD_SAY_SOFTER   (BRLAPI_KEY_CMD(0) + 68)
542       decrease speech volume
543
544   #define BRLAPI_KEY_CMD_SETLEFT   BRLAPI_KEY_CMD(0X0A)
545       position left end of window at character
546
547   #define BRLAPI_KEY_CMD_SETMARK   BRLAPI_KEY_CMD(0X0B)
548       remember current window position
549
550   #define BRLAPI_KEY_CMD_SIXDOTS   (BRLAPI_KEY_CMD(0) + 34)
551       toggle text style 6-dot/8-dot
552
553   #define BRLAPI_KEY_CMD_SKPBLNKWINS   (BRLAPI_KEY_CMD(0) + 37)
554       toggle skipping of blank windows on/off
555
556   #define BRLAPI_KEY_CMD_SKPIDLNS   (BRLAPI_KEY_CMD(0) + 36)
557       toggle skipping of lines with identical content on/off
558
559   #define BRLAPI_KEY_CMD_SLIDEWIN   (BRLAPI_KEY_CMD(0) + 35)
560       toggle sliding window on/off
561
562   #define BRLAPI_KEY_CMD_SPKHOME   (BRLAPI_KEY_CMD(0) + 62)
563       go to current (most recent) speech position
564
565   #define BRLAPI_KEY_CMD_SWITCHVT   BRLAPI_KEY_CMD(0X06)
566       switch to virtual terminal
567
568   #define BRLAPI_KEY_CMD_SWITCHVT_NEXT   (BRLAPI_KEY_CMD(0) + 71)
569       switch to next virtual terminal
570
571   #define BRLAPI_KEY_CMD_SWITCHVT_PREV   (BRLAPI_KEY_CMD(0) + 70)
572       switch to previous virtual terminal
573
574   #define BRLAPI_KEY_CMD_TOP   (BRLAPI_KEY_CMD(0) + 9)
575       go to top line
576
577   #define BRLAPI_KEY_CMD_TOP_LEFT   (BRLAPI_KEY_CMD(0) + 11)
578       go to beginning of top line
579
580   #define BRLAPI_KEY_CMD_TUNES   (BRLAPI_KEY_CMD(0) + 46)
581       toggle alert tunes on/off
582
583   #define BRLAPI_KEY_CMD_WINDN   (BRLAPI_KEY_CMD(0) + 4)
584       go down several lines
585
586   #define BRLAPI_KEY_CMD_WINUP   (BRLAPI_KEY_CMD(0) + 3)
587       go up several lines
588
589   #define BRLAPI_KEY_CODE_MASK   UINT64_C(0X000000001FFFFFFF)
590       Mask for code of brlapi_keyCode_t
591
592   #define BRLAPI_KEY_CODE_SHIFT   0
593       Shift for code of brlapi_keyCode_t
594
595   #define BRLAPI_KEY_FLAGS_MASK   UINT64_C(0XFFFFFFFF00000000)
596       Mask for flags of brlapi_keyCode_t
597
598   #define BRLAPI_KEY_FLAGS_SHIFT   32
599       Shift for flags of brlapi_keyCode_t
600
601   #define BRLAPI_KEY_FLG(v)   ((brlapi_keyCode_t)(v) <<
602       BRLAPI_KEY_FLAGS_SHIFT)
603   #define BRLAPI_KEY_FLG_CONTROL   BRLAPI_KEY_FLG(0X04)
604       control key pressed
605
606   #define BRLAPI_KEY_FLG_KBD_EMUL0   BRLAPI_KEY_FLG(0X0200)
607       it is an emulation 0 scan code
608
609   #define BRLAPI_KEY_FLG_KBD_EMUL1   BRLAPI_KEY_FLG(0X0400)
610       it is an emulation 1 scan code
611
612   #define BRLAPI_KEY_FLG_KBD_RELEASE   BRLAPI_KEY_FLG(0X0100)
613       it is a release scan code
614
615   #define BRLAPI_KEY_FLG_LINE_SCALED   BRLAPI_KEY_FLG(0X0100)
616       scale arg=0X00-0XFF to screen height
617
618   #define BRLAPI_KEY_FLG_LINE_TOLEFT   BRLAPI_KEY_FLG(0X0200)
619       go to beginning of line
620
621   #define BRLAPI_KEY_FLG_META   BRLAPI_KEY_FLG(0X08)
622       meta key pressed
623
624   #define BRLAPI_KEY_FLG_MOD1   BRLAPI_KEY_FLG(0x00000008)
625       Standard X modifiers Mod1 modifier (AKA meta)
626
627   #define BRLAPI_KEY_FLG_MOD2   BRLAPI_KEY_FLG(0x00000010)
628       Mod2 modifier (usually numlock)
629
630   #define BRLAPI_KEY_FLG_MOD3   BRLAPI_KEY_FLG(0x00000020)
631       Mod3 modifier
632
633   #define BRLAPI_KEY_FLG_MOD4   BRLAPI_KEY_FLG(0x00000040)
634       Mod4 modifier
635
636   #define BRLAPI_KEY_FLG_MOD5   BRLAPI_KEY_FLG(0x00000080)
637       Mod5 modifier (usually Alt-Gr)
638
639   #define BRLAPI_KEY_FLG_REPEAT_DELAY   BRLAPI_KEY_FLG(0X4000)
640       wait before repeating
641
642   #define BRLAPI_KEY_FLG_REPEAT_INITIAL   BRLAPI_KEY_FLG(0X8000)
643       execute command on key press
644
645   #define BRLAPI_KEY_FLG_REPEAT_MASK   (BRLAPI_KEY_FLG_REPEAT_INITIAL |
646       BRLAPI_KEY_FLG_REPEAT_DELAY)
647       mask for all repeat flags
648
649   #define BRLAPI_KEY_FLG_ROUTE   BRLAPI_KEY_FLG(0X0400)
650       bring cursor into window after function
651
652   #define BRLAPI_KEY_FLG_SHIFT   BRLAPI_KEY_FLG(0X01)
653       shift key pressed
654
655   #define BRLAPI_KEY_FLG_TOGGLE_MASK   (BRLAPI_KEY_FLG_TOGGLE_ON |
656       BRLAPI_KEY_FLG_TOGGLE_OFF)
657       mask for all toggle flags
658
659   #define BRLAPI_KEY_FLG_TOGGLE_OFF   BRLAPI_KEY_FLG(0X0200)
660       disable feature
661
662   #define BRLAPI_KEY_FLG_TOGGLE_ON   BRLAPI_KEY_FLG(0X0100)
663       enable feature
664
665   #define BRLAPI_KEY_FLG_UPPER   BRLAPI_KEY_FLG(0X02)
666       convert to uppercase
667
668   #define BRLAPI_KEY_MAX   UINT64_C(0XFFFFFFFFFFFFFFFF)
669       Brlapi_keyCode_t's biggest value
670
671       As defined in <stdint.h>
672
673   #define BRLAPI_KEY_SYM_BACKSPACE   UINT64_C(0X0000FF08)
674       Standard X keysyms
675
676   #define BRLAPI_KEY_SYM_DELETE   UINT64_C(0X0000FFFF)
677   #define BRLAPI_KEY_SYM_DOWN   UINT64_C(0X0000FF54)
678   #define BRLAPI_KEY_SYM_END   UINT64_C(0X0000FF57)
679   #define BRLAPI_KEY_SYM_ESCAPE   UINT64_C(0X0000FF1B)
680   #define BRLAPI_KEY_SYM_FUNCTION   UINT64_C(0X0000FFBE)
681   #define BRLAPI_KEY_SYM_HOME   UINT64_C(0X0000FF50)
682   #define BRLAPI_KEY_SYM_INSERT   UINT64_C(0X0000FF63)
683   #define BRLAPI_KEY_SYM_LEFT   UINT64_C(0X0000FF51)
684   #define BRLAPI_KEY_SYM_LINEFEED   UINT64_C(0X0000FF0D)
685   #define BRLAPI_KEY_SYM_PAGE_DOWN   UINT64_C(0X0000FF56)
686   #define BRLAPI_KEY_SYM_PAGE_UP   UINT64_C(0X0000FF55)
687   #define BRLAPI_KEY_SYM_RIGHT   UINT64_C(0X0000FF53)
688   #define BRLAPI_KEY_SYM_TAB   UINT64_C(0X0000FF09)
689   #define BRLAPI_KEY_SYM_UNICODE   UINT64_C(0X01000000)
690   #define BRLAPI_KEY_SYM_UP   UINT64_C(0X0000FF52)
691   #define BRLAPI_KEY_TYPE_CMD   UINT64_C(0X0000000020000000)
692       Braille command brlapi_keyCode_t
693
694   #define BRLAPI_KEY_TYPE_MASK   UINT64_C(0X00000000E0000000)
695       Mask for type of brlapi_keyCode_t
696
697   #define BRLAPI_KEY_TYPE_SHIFT   29
698       Shift for type of brlapi_keyCode_t
699
700   #define BRLAPI_KEY_TYPE_SYM   UINT64_C(0X0000000000000000)
701       X Keysym brlapi_keyCode_t
702
703   #define BRLAPI_PRIuKEYCODE   PRIu64
704       Unsigned print format for brlapi_keyCode_t
705
706   #define BRLAPI_PRIxKEYCODE   PRIx64
707       Hex print format for brlapi_keyCode_t
708

Typedef Documentation

710   typedef uint64_t brlapi_keyCode_t
711Version 1.0                       7 OTcytpe2s00a9nd Defines fore BrlAPI Key Codes(3)