BRLAPI_KEY_CMD_CUTLINE(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_CMD_SHUTDOWN   (BRLAPI_KEY_CMD(0) + 77)
85       #define BRLAPI_KEY_FLG_TOGGLE_ON   [22mBRLAPI_KEY_FLG(0X0100)
86       #define BRLAPI_KEY_FLG_TOGGLE_OFF   [22mBRLAPI_KEY_FLG(0X0200)
87       #define BRLAPI_KEY_FLG_TOGGLE_MASK   (BRLAPI_KEY_FLG_TOGGLE_ON |
88           BRLAPI_KEY_FLG_TOGGLE_OFF)
89       #define BRLAPI_KEY_FLG_ROUTE   [22mBRLAPI_KEY_FLG(0X0400)
90       #define BRLAPI_KEY_FLG_REPEAT_INITIAL   [22mBRLAPI_KEY_FLG(0X8000)
91       #define BRLAPI_KEY_FLG_REPEAT_DELAY   [22mBRLAPI_KEY_FLG(0X4000)
92       #define BRLAPI_KEY_FLG_REPEAT_MASK   (BRLAPI_KEY_FLG_REPEAT_INITIAL |
93           BRLAPI_KEY_FLG_REPEAT_DELAY)
94       #define BRLAPI_KEY_CMD_ROUTE   [22mBRLAPI_KEY_CMD(0X01)
95       #define BRLAPI_KEY_CMD_CUTBEGIN   [22mBRLAPI_KEY_CMD(0X02)
96       #define BRLAPI_KEY_CMD_CUTAPPEND   [22mBRLAPI_KEY_CMD(0X03)
97       #define BRLAPI_KEY_CMD_CUTRECT   [22mBRLAPI_KEY_CMD(0X04)
98       #define BRLAPI_KEY_CMD_CUTLINE   [22mBRLAPI_KEY_CMD(0X05)
99       #define BRLAPI_KEY_CMD_SWITCHVT   [22mBRLAPI_KEY_CMD(0X06)
100       #define BRLAPI_KEY_CMD_PRINDENT   [22mBRLAPI_KEY_CMD(0X07)
101       #define BRLAPI_KEY_CMD_NXINDENT   [22mBRLAPI_KEY_CMD(0X08)
102       #define BRLAPI_KEY_CMD_DESCCHAR   [22mBRLAPI_KEY_CMD(0X09)
103       #define BRLAPI_KEY_CMD_SETLEFT   [22mBRLAPI_KEY_CMD(0X0A)
104       #define BRLAPI_KEY_CMD_SETMARK   [22mBRLAPI_KEY_CMD(0X0B)
105       #define BRLAPI_KEY_CMD_GOTOMARK   [22mBRLAPI_KEY_CMD(0X0C)
106       #define BRLAPI_KEY_CMD_GOTOLINE   [22mBRLAPI_KEY_CMD(0X0D)
107       #define BRLAPI_KEY_FLG_LINE_SCALED   [22mBRLAPI_KEY_FLG(0X0100)
108       #define BRLAPI_KEY_FLG_LINE_TOLEFT   [22mBRLAPI_KEY_FLG(0X0200)
109       #define BRLAPI_KEY_CMD_PRDIFCHAR   [22mBRLAPI_KEY_CMD(0X0E)
110       #define BRLAPI_KEY_CMD_NXDIFCHAR   [22mBRLAPI_KEY_CMD(0X0F)
111       #define BRLAPI_KEY_CMD_PASSDOTS   [22mBRLAPI_KEY_CMD(0X22)
112       #define BRLAPI_KEY_FLG_SHIFT   [22mBRLAPI_KEY_FLG(0X01)
113       #define BRLAPI_KEY_FLG_UPPER   [22mBRLAPI_KEY_FLG(0X02)
114       #define BRLAPI_KEY_FLG_CONTROL   [22mBRLAPI_KEY_FLG(0X04)
115       #define BRLAPI_KEY_FLG_META   [22mBRLAPI_KEY_FLG(0X08)
116       #define BRLAPI_KEY_CMD_PASSAT   [22mBRLAPI_KEY_CMD(0X23)
117       #define BRLAPI_KEY_CMD_PASSXT   [22mBRLAPI_KEY_CMD(0X24)
118       #define BRLAPI_KEY_CMD_PASSPS2   [22mBRLAPI_KEY_CMD(0X25)
119       #define BRLAPI_KEY_FLG_KBD_RELEASE   [22mBRLAPI_KEY_FLG(0X0100)
120       #define BRLAPI_KEY_FLG_KBD_EMUL0   [22mBRLAPI_KEY_FLG(0X0200)
121       #define BRLAPI_KEY_FLG_KBD_EMUL1   [22mBRLAPI_KEY_FLG(0X0400)
122       #define BRLAPI_DOT1   0001
123       #define BRLAPI_DOT2   0002
124       #define BRLAPI_DOT3   0004
125       #define BRLAPI_DOT4   0010
126       #define BRLAPI_DOT5   0020
127       #define BRLAPI_DOT6   0040
128       #define BRLAPI_DOT7   0100
129       #define BRLAPI_DOT8   0200
130
131   Defines
132       #define BRLAPI_PRIxKEYCODE   PRIx64
133       #define BRLAPI_PRIuKEYCODE   PRIu64
134       #define BRLAPI_KEY_MAX   UINT64_C(0XFFFFFFFFFFFFFFFF)
135       #define BRLAPI_KEY_FLAGS_MASK   UINT64_C(0XFFFFFFFF00000000)
136       #define BRLAPI_KEY_FLAGS_SHIFT   32
137       #define BRLAPI_KEY_FLG(v)   ((brlapi_keyCode_t)(v) <<
138           BRLAPI_KEY_FLAGS_SHIFT)
139       #define BRLAPI_KEY_FLG_MOD1   [22mBRLAPI_KEY_FLG(0x00000008)
140       #define BRLAPI_KEY_FLG_MOD2   [22mBRLAPI_KEY_FLG(0x00000010)
141       #define BRLAPI_KEY_FLG_MOD3   [22mBRLAPI_KEY_FLG(0x00000020)
142       #define BRLAPI_KEY_FLG_MOD4   [22mBRLAPI_KEY_FLG(0x00000040)
143       #define BRLAPI_KEY_FLG_MOD5   [22mBRLAPI_KEY_FLG(0x00000080)
144       #define BRLAPI_KEY_TYPE_MASK   UINT64_C(0X00000000E0000000)
145       #define BRLAPI_KEY_TYPE_SHIFT   29
146       #define BRLAPI_KEY_TYPE_CMD   UINT64_C(0X0000000020000000)
147       #define BRLAPI_KEY_TYPE_SYM   UINT64_C(0X0000000000000000)
148       #define BRLAPI_KEY_CODE_MASK   UINT64_C(0X000000001FFFFFFF)
149       #define BRLAPI_KEY_CODE_SHIFT   0
150       #define BRLAPI_KEY_CMD_BLK_MASK   [22mUINT64_C(0X1FFF0000)
151       #define BRLAPI_KEY_CMD_BLK_SHIFT   16
152       #define BRLAPI_KEY_CMD_ARG_MASK   [22mUINT64_C(0X0000FFFF)
153       #define BRLAPI_KEY_CMD_ARG_SHIFT   0
154       #define BRLAPI_KEY_CMD(v)   ((v) << BRLAPI_KEY_CMD_BLK_SHIFT)
155       #define BRLAPI_KEY_SYM_BACKSPACE   [22mUINT64_C(0X0000FF08)
156       #define BRLAPI_KEY_SYM_TAB   [22mUINT64_C(0X0000FF09)
157       #define BRLAPI_KEY_SYM_LINEFEED   [22mUINT64_C(0X0000FF0D)
158       #define BRLAPI_KEY_SYM_ESCAPE   [22mUINT64_C(0X0000FF1B)
159       #define BRLAPI_KEY_SYM_HOME   [22mUINT64_C(0X0000FF50)
160       #define BRLAPI_KEY_SYM_LEFT   [22mUINT64_C(0X0000FF51)
161       #define BRLAPI_KEY_SYM_UP   [22mUINT64_C(0X0000FF52)
162       #define BRLAPI_KEY_SYM_RIGHT   [22mUINT64_C(0X0000FF53)
163       #define BRLAPI_KEY_SYM_DOWN   [22mUINT64_C(0X0000FF54)
164       #define BRLAPI_KEY_SYM_PAGE_UP   [22mUINT64_C(0X0000FF55)
165       #define BRLAPI_KEY_SYM_PAGE_DOWN   [22mUINT64_C(0X0000FF56)
166       #define BRLAPI_KEY_SYM_END   [22mUINT64_C(0X0000FF57)
167       #define BRLAPI_KEY_SYM_INSERT   [22mUINT64_C(0X0000FF63)
168       #define BRLAPI_KEY_SYM_FUNCTION   [22mUINT64_C(0X0000FFBE)
169       #define BRLAPI_KEY_SYM_DELETE   [22mUINT64_C(0X0000FFFF)
170       #define BRLAPI_KEY_SYM_UNICODE   [22mUINT64_C(0X01000000)
171
172   Typedefs
173       typedef uint64_t brlapi_keyCode_t
174

Detailed Description

176       Key codes are unsigned 64 bit integers. This 64-bit space is split into
177       3 parts:
178
179       · bits 63-32 (BRLAPI_KEY_FLAGS_MASK), flags: bits 39-32 are standard X
180         modifiers (shift, control, meta, ...). Other flags are used for some
181         commands, see documentation of BRLAPI_KEY_FLG_* for their respective
182         uses.
183
184       · bits 31-29 (BRLAPI_KEY_TYPE_MASK), key type: either
185         BRLAPI_KEY_TYPE_CMD for braille commands, or BRLAPI_KEY_TYPE_SYM for
186         standard X keysyms.
187
188       · bits 28-0 (BRLAPI_KEY_CODE_MASK), key code: for braille commands, see
189         BRLAPI_KEY_CMD_* ; for standard X keysyms, this is the keysym value,
190         see X11 documentation, a complete list is probably available on your
191         system in /usr/include/X11/keysymdef.h
192
193       The third part is itself split into two parts: a command number and a
194       command value. The relative sizes of these parts vary according to the
195       key type.
196
197       For a braille command, bits 28-16 (BRLAPI_KEY_CMD_BLK_MASK) hold the
198       braille command number, while bits 15-0 (BRLAPI_KEY_CMD_ARG_MASK) hold
199       the command value.
200
201       For a X keysym, if it is a unicode keysym (0x1uvwxyz), then the command
202       number part is 0x1000000 and the value part is 0xuvwxyz. Else, the
203       command part is held by bits 28-8 and the value part is held by bits
204       7-0. This permits to easily handle usual cases like 0x00xy (latin1),
205       0x01xy (latin2), 0xff08 (backspace), 0xff09 (tab), ...
206
207       For instance, if key == 0x20010008,
208
209       · key & BRLAPI_KEY_TYPE_MASK == BRLAPI_KEY_TYPE_CMD, so it's a braille
210         command
211
212       · key & BRLAPI_KEY_CMD_BLK_MASK == BRLAPI_KEY_CMD_ROUTE, so it's the
213         braille route command.
214
215       · key & BRLAPI_KEY_CMD_ARG_MASK == 8, so the highlighted cell is the
216         9th one (cells are numbered from 0)
217
218       · key & BRLAPI_KEY_FLAGS_MASK == 0, so no modifier key was pressed
219         during the command, and no particular flag applies to the command.
220
221       The brlapi_expandKeyCode() function may be used for splitting key codes
222       into these 4 parts.
223

Define Documentation

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

Typedef Documentation

674   typedef uint64_t brlapi_keyCode_t
675Version 1.0                       4 JTuynpe2s00a7nd Defines fore BrlAPI Key Codes(3)