BrlAPI  1.0
brlapi_constants.h
Go to the documentation of this file.
1 /*
2  * libbrlapi - A library providing access to braille terminals for applications.
3  *
4  * Copyright (C) 2002-2015 by
5  * Samuel Thibault <Samuel.Thibault@ens-lyon.org>
6  * S├ębastien Hinderer <Sebastien.Hinderer@ens-lyon.org>
7  *
8  * libbrlapi comes with ABSOLUTELY NO WARRANTY.
9  *
10  * This is free software, placed under the terms of the
11  * GNU Lesser General Public License, as published by the Free Software
12  * Foundation; either version 2.1 of the License, or (at your option) any
13  * later version. Please see the file LICENSE-LGPL for details.
14  *
15  * Web Page: http://brltty.com/
16  *
17  * This software is maintained by Dave Mielke <dave@mielke.cc>.
18  */
19 
20 #ifndef BRLAPI_INCLUDED_CONSTANTS
21 #define BRLAPI_INCLUDED_CONSTANTS
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif /* __cplusplus */
26 
34 #define BRLAPI_KEY_CMD_NOOP (BRLAPI_KEY_CMD(0) + 0)
35 
36 #define BRLAPI_KEY_CMD_LNUP (BRLAPI_KEY_CMD(0) + 1)
37 
38 #define BRLAPI_KEY_CMD_LNDN (BRLAPI_KEY_CMD(0) + 2)
39 
40 #define BRLAPI_KEY_CMD_WINUP (BRLAPI_KEY_CMD(0) + 3)
41 
42 #define BRLAPI_KEY_CMD_WINDN (BRLAPI_KEY_CMD(0) + 4)
43 
44 #define BRLAPI_KEY_CMD_PRDIFLN (BRLAPI_KEY_CMD(0) + 5)
45 
46 #define BRLAPI_KEY_CMD_NXDIFLN (BRLAPI_KEY_CMD(0) + 6)
47 
48 #define BRLAPI_KEY_CMD_ATTRUP (BRLAPI_KEY_CMD(0) + 7)
49 
50 #define BRLAPI_KEY_CMD_ATTRDN (BRLAPI_KEY_CMD(0) + 8)
51 
52 #define BRLAPI_KEY_CMD_TOP (BRLAPI_KEY_CMD(0) + 9)
53 
54 #define BRLAPI_KEY_CMD_BOT (BRLAPI_KEY_CMD(0) + 10)
55 
56 #define BRLAPI_KEY_CMD_TOP_LEFT (BRLAPI_KEY_CMD(0) + 11)
57 
58 #define BRLAPI_KEY_CMD_BOT_LEFT (BRLAPI_KEY_CMD(0) + 12)
59 
60 #define BRLAPI_KEY_CMD_PRPGRPH (BRLAPI_KEY_CMD(0) + 13)
61 
62 #define BRLAPI_KEY_CMD_NXPGRPH (BRLAPI_KEY_CMD(0) + 14)
63 
64 #define BRLAPI_KEY_CMD_PRPROMPT (BRLAPI_KEY_CMD(0) + 15)
65 
66 #define BRLAPI_KEY_CMD_NXPROMPT (BRLAPI_KEY_CMD(0) + 16)
67 
68 #define BRLAPI_KEY_CMD_PRSEARCH (BRLAPI_KEY_CMD(0) + 17)
69 
70 #define BRLAPI_KEY_CMD_NXSEARCH (BRLAPI_KEY_CMD(0) + 18)
71 
72 #define BRLAPI_KEY_CMD_CHRLT (BRLAPI_KEY_CMD(0) + 19)
73 
74 #define BRLAPI_KEY_CMD_CHRRT (BRLAPI_KEY_CMD(0) + 20)
75 
76 #define BRLAPI_KEY_CMD_HWINLT (BRLAPI_KEY_CMD(0) + 21)
77 
78 #define BRLAPI_KEY_CMD_HWINRT (BRLAPI_KEY_CMD(0) + 22)
79 
80 #define BRLAPI_KEY_CMD_FWINLT (BRLAPI_KEY_CMD(0) + 23)
81 
82 #define BRLAPI_KEY_CMD_FWINRT (BRLAPI_KEY_CMD(0) + 24)
83 
84 #define BRLAPI_KEY_CMD_FWINLTSKIP (BRLAPI_KEY_CMD(0) + 25)
85 
86 #define BRLAPI_KEY_CMD_FWINRTSKIP (BRLAPI_KEY_CMD(0) + 26)
87 
88 #define BRLAPI_KEY_CMD_LNBEG (BRLAPI_KEY_CMD(0) + 27)
89 
90 #define BRLAPI_KEY_CMD_LNEND (BRLAPI_KEY_CMD(0) + 28)
91 
92 #define BRLAPI_KEY_CMD_HOME (BRLAPI_KEY_CMD(0) + 29)
93 
94 #define BRLAPI_KEY_CMD_BACK (BRLAPI_KEY_CMD(0) + 30)
95 
96 #define BRLAPI_KEY_CMD_RETURN (BRLAPI_KEY_CMD(0) + 31)
97 
98 #define BRLAPI_KEY_CMD_FREEZE (BRLAPI_KEY_CMD(0) + 32)
99 
100 #define BRLAPI_KEY_CMD_DISPMD (BRLAPI_KEY_CMD(0) + 33)
101 
102 #define BRLAPI_KEY_CMD_SIXDOTS (BRLAPI_KEY_CMD(0) + 34)
103 
104 #define BRLAPI_KEY_CMD_SLIDEWIN (BRLAPI_KEY_CMD(0) + 35)
105 
106 #define BRLAPI_KEY_CMD_SKPIDLNS (BRLAPI_KEY_CMD(0) + 36)
107 
108 #define BRLAPI_KEY_CMD_SKPBLNKWINS (BRLAPI_KEY_CMD(0) + 37)
109 
110 #define BRLAPI_KEY_CMD_CSRVIS (BRLAPI_KEY_CMD(0) + 38)
111 
112 #define BRLAPI_KEY_CMD_CSRHIDE (BRLAPI_KEY_CMD(0) + 39)
113 
114 #define BRLAPI_KEY_CMD_CSRTRK (BRLAPI_KEY_CMD(0) + 40)
115 
116 #define BRLAPI_KEY_CMD_CSRSIZE (BRLAPI_KEY_CMD(0) + 41)
117 
118 #define BRLAPI_KEY_CMD_CSRBLINK (BRLAPI_KEY_CMD(0) + 42)
119 
120 #define BRLAPI_KEY_CMD_ATTRVIS (BRLAPI_KEY_CMD(0) + 43)
121 
122 #define BRLAPI_KEY_CMD_ATTRBLINK (BRLAPI_KEY_CMD(0) + 44)
123 
124 #define BRLAPI_KEY_CMD_CAPBLINK (BRLAPI_KEY_CMD(0) + 45)
125 
126 #define BRLAPI_KEY_CMD_TUNES (BRLAPI_KEY_CMD(0) + 46)
127 
128 #define BRLAPI_KEY_CMD_AUTOREPEAT (BRLAPI_KEY_CMD(0) + 47)
129 
130 #define BRLAPI_KEY_CMD_AUTOSPEAK (BRLAPI_KEY_CMD(0) + 48)
131 
132 #define BRLAPI_KEY_CMD_HELP (BRLAPI_KEY_CMD(0) + 49)
133 
134 #define BRLAPI_KEY_CMD_INFO (BRLAPI_KEY_CMD(0) + 50)
135 
136 #define BRLAPI_KEY_CMD_LEARN (BRLAPI_KEY_CMD(0) + 51)
137 
138 #define BRLAPI_KEY_CMD_PREFMENU (BRLAPI_KEY_CMD(0) + 52)
139 
140 #define BRLAPI_KEY_CMD_PREFSAVE (BRLAPI_KEY_CMD(0) + 53)
141 
142 #define BRLAPI_KEY_CMD_PREFLOAD (BRLAPI_KEY_CMD(0) + 54)
143 
144 #define BRLAPI_KEY_CMD_MENU_FIRST_ITEM (BRLAPI_KEY_CMD(0) + 55)
145 
146 #define BRLAPI_KEY_CMD_MENU_LAST_ITEM (BRLAPI_KEY_CMD(0) + 56)
147 
148 #define BRLAPI_KEY_CMD_MENU_PREV_ITEM (BRLAPI_KEY_CMD(0) + 57)
149 
150 #define BRLAPI_KEY_CMD_MENU_NEXT_ITEM (BRLAPI_KEY_CMD(0) + 58)
151 
152 #define BRLAPI_KEY_CMD_MENU_PREV_SETTING (BRLAPI_KEY_CMD(0) + 59)
153 
154 #define BRLAPI_KEY_CMD_MENU_NEXT_SETTING (BRLAPI_KEY_CMD(0) + 60)
155 
156 #define BRLAPI_KEY_CMD_MUTE (BRLAPI_KEY_CMD(0) + 61)
157 
158 #define BRLAPI_KEY_CMD_SPKHOME (BRLAPI_KEY_CMD(0) + 62)
159 
160 #define BRLAPI_KEY_CMD_SAY_LINE (BRLAPI_KEY_CMD(0) + 63)
161 
162 #define BRLAPI_KEY_CMD_SAY_ABOVE (BRLAPI_KEY_CMD(0) + 64)
163 
164 #define BRLAPI_KEY_CMD_SAY_BELOW (BRLAPI_KEY_CMD(0) + 65)
165 
166 #define BRLAPI_KEY_CMD_SAY_SLOWER (BRLAPI_KEY_CMD(0) + 66)
167 
168 #define BRLAPI_KEY_CMD_SAY_FASTER (BRLAPI_KEY_CMD(0) + 67)
169 
170 #define BRLAPI_KEY_CMD_SAY_SOFTER (BRLAPI_KEY_CMD(0) + 68)
171 
172 #define BRLAPI_KEY_CMD_SAY_LOUDER (BRLAPI_KEY_CMD(0) + 69)
173 
174 #define BRLAPI_KEY_CMD_SWITCHVT_PREV (BRLAPI_KEY_CMD(0) + 70)
175 
176 #define BRLAPI_KEY_CMD_SWITCHVT_NEXT (BRLAPI_KEY_CMD(0) + 71)
177 
178 #define BRLAPI_KEY_CMD_CSRJMP_VERT (BRLAPI_KEY_CMD(0) + 72)
179 
180 #define BRLAPI_KEY_CMD_PASTE (BRLAPI_KEY_CMD(0) + 73)
181 
182 #define BRLAPI_KEY_CMD_RESTARTBRL (BRLAPI_KEY_CMD(0) + 74)
183 
184 #define BRLAPI_KEY_CMD_RESTARTSPEECH (BRLAPI_KEY_CMD(0) + 75)
185 
186 #define BRLAPI_KEY_CMD_OFFLINE (BRLAPI_KEY_CMD(0) + 76)
187 
188 #define BRLAPI_KEY_CMD_SHIFT (BRLAPI_KEY_CMD(0) + 77)
189 
190 #define BRLAPI_KEY_CMD_UPPER (BRLAPI_KEY_CMD(0) + 78)
191 
192 #define BRLAPI_KEY_CMD_CONTROL (BRLAPI_KEY_CMD(0) + 79)
193 
194 #define BRLAPI_KEY_CMD_META (BRLAPI_KEY_CMD(0) + 80)
195 
196 #define BRLAPI_KEY_CMD_TIME (BRLAPI_KEY_CMD(0) + 81)
197 
198 #define BRLAPI_KEY_CMD_MENU_PREV_LEVEL (BRLAPI_KEY_CMD(0) + 82)
199 
200 #define BRLAPI_KEY_CMD_ASPK_SEL_LINE (BRLAPI_KEY_CMD(0) + 83)
201 
202 #define BRLAPI_KEY_CMD_ASPK_SEL_CHAR (BRLAPI_KEY_CMD(0) + 84)
203 
204 #define BRLAPI_KEY_CMD_ASPK_INS_CHARS (BRLAPI_KEY_CMD(0) + 85)
205 
206 #define BRLAPI_KEY_CMD_ASPK_DEL_CHARS (BRLAPI_KEY_CMD(0) + 86)
207 
208 #define BRLAPI_KEY_CMD_ASPK_REP_CHARS (BRLAPI_KEY_CMD(0) + 87)
209 
210 #define BRLAPI_KEY_CMD_ASPK_CMP_WORDS (BRLAPI_KEY_CMD(0) + 88)
211 
212 #define BRLAPI_KEY_CMD_SPEAK_CURR_CHAR (BRLAPI_KEY_CMD(0) + 89)
213 
214 #define BRLAPI_KEY_CMD_SPEAK_PREV_CHAR (BRLAPI_KEY_CMD(0) + 90)
215 
216 #define BRLAPI_KEY_CMD_SPEAK_NEXT_CHAR (BRLAPI_KEY_CMD(0) + 91)
217 
218 #define BRLAPI_KEY_CMD_SPEAK_CURR_WORD (BRLAPI_KEY_CMD(0) + 92)
219 
220 #define BRLAPI_KEY_CMD_SPEAK_PREV_WORD (BRLAPI_KEY_CMD(0) + 93)
221 
222 #define BRLAPI_KEY_CMD_SPEAK_NEXT_WORD (BRLAPI_KEY_CMD(0) + 94)
223 
224 #define BRLAPI_KEY_CMD_SPEAK_CURR_LINE (BRLAPI_KEY_CMD(0) + 95)
225 
226 #define BRLAPI_KEY_CMD_SPEAK_PREV_LINE (BRLAPI_KEY_CMD(0) + 96)
227 
228 #define BRLAPI_KEY_CMD_SPEAK_NEXT_LINE (BRLAPI_KEY_CMD(0) + 97)
229 
230 #define BRLAPI_KEY_CMD_SPEAK_FRST_CHAR (BRLAPI_KEY_CMD(0) + 98)
231 
232 #define BRLAPI_KEY_CMD_SPEAK_LAST_CHAR (BRLAPI_KEY_CMD(0) + 99)
233 
234 #define BRLAPI_KEY_CMD_SPEAK_FRST_LINE (BRLAPI_KEY_CMD(0) + 100)
235 
236 #define BRLAPI_KEY_CMD_SPEAK_LAST_LINE (BRLAPI_KEY_CMD(0) + 101)
237 
238 #define BRLAPI_KEY_CMD_DESC_CURR_CHAR (BRLAPI_KEY_CMD(0) + 102)
239 
240 #define BRLAPI_KEY_CMD_SPELL_CURR_WORD (BRLAPI_KEY_CMD(0) + 103)
241 
242 #define BRLAPI_KEY_CMD_ROUTE_CURR_LOCN (BRLAPI_KEY_CMD(0) + 104)
243 
244 #define BRLAPI_KEY_CMD_SPEAK_CURR_LOCN (BRLAPI_KEY_CMD(0) + 105)
245 
246 #define BRLAPI_KEY_CMD_SHOW_CURR_LOCN (BRLAPI_KEY_CMD(0) + 106)
247 
248 #define BRLAPI_KEY_CMD_CLIP_SAVE (BRLAPI_KEY_CMD(0) + 107)
249 
250 #define BRLAPI_KEY_CMD_CLIP_RESTORE (BRLAPI_KEY_CMD(0) + 108)
251 
252 #define BRLAPI_KEY_CMD_BRLUCDOTS (BRLAPI_KEY_CMD(0) + 109)
253 
254 #define BRLAPI_KEY_CMD_BRLKBD (BRLAPI_KEY_CMD(0) + 110)
255 
256 #define BRLAPI_KEY_CMD_UNSTICK (BRLAPI_KEY_CMD(0) + 111)
257 
258 #define BRLAPI_KEY_CMD_ALTGR (BRLAPI_KEY_CMD(0) + 112)
259 
260 #define BRLAPI_KEY_CMD_GUI (BRLAPI_KEY_CMD(0) + 113)
261 
262 #define BRLAPI_KEY_CMD_BRL_STOP (BRLAPI_KEY_CMD(0) + 114)
263 
264 #define BRLAPI_KEY_CMD_BRL_START (BRLAPI_KEY_CMD(0) + 115)
265 
266 #define BRLAPI_KEY_CMD_SPK_STOP (BRLAPI_KEY_CMD(0) + 116)
267 
268 #define BRLAPI_KEY_CMD_SPK_START (BRLAPI_KEY_CMD(0) + 117)
269 
270 #define BRLAPI_KEY_CMD_SCR_STOP (BRLAPI_KEY_CMD(0) + 118)
271 
272 #define BRLAPI_KEY_CMD_SCR_START (BRLAPI_KEY_CMD(0) + 119)
273 
274 #define BRLAPI_KEY_CMD_SELECTVT_PREV (BRLAPI_KEY_CMD(0) + 120)
275 
276 #define BRLAPI_KEY_CMD_SELECTVT_NEXT (BRLAPI_KEY_CMD(0) + 121)
277 
278 #define BRLAPI_KEY_CMD_PRNBWIN (BRLAPI_KEY_CMD(0) + 122)
279 
280 #define BRLAPI_KEY_CMD_NXNBWIN (BRLAPI_KEY_CMD(0) + 123)
281 
282 #define BRLAPI_KEY_CMD_TOUCH_NAV (BRLAPI_KEY_CMD(0) + 124)
283 
284 #define BRLAPI_KEY_CMD_ROUTE BRLAPI_KEY_CMD(1)
285 
286 #define BRLAPI_KEY_CMD_CLIP_NEW BRLAPI_KEY_CMD(2)
287 
288 #define BRLAPI_KEY_CMD_CUTBEGIN BRLAPI_KEY_CMD(2)
289 
290 #define BRLAPI_KEY_CMD_CLIP_ADD BRLAPI_KEY_CMD(3)
291 
292 #define BRLAPI_KEY_CMD_CUTAPPEND BRLAPI_KEY_CMD(3)
293 
294 #define BRLAPI_KEY_CMD_COPY_RECT BRLAPI_KEY_CMD(4)
295 
296 #define BRLAPI_KEY_CMD_CUTRECT BRLAPI_KEY_CMD(4)
297 
298 #define BRLAPI_KEY_CMD_COPY_LINE BRLAPI_KEY_CMD(5)
299 
300 #define BRLAPI_KEY_CMD_CUTLINE BRLAPI_KEY_CMD(5)
301 
302 #define BRLAPI_KEY_CMD_SWITCHVT BRLAPI_KEY_CMD(6)
303 
304 #define BRLAPI_KEY_CMD_PRINDENT BRLAPI_KEY_CMD(7)
305 
306 #define BRLAPI_KEY_CMD_NXINDENT BRLAPI_KEY_CMD(8)
307 
308 #define BRLAPI_KEY_CMD_DESCCHAR BRLAPI_KEY_CMD(9)
309 
310 #define BRLAPI_KEY_CMD_SETLEFT BRLAPI_KEY_CMD(10)
311 
312 #define BRLAPI_KEY_CMD_SETMARK BRLAPI_KEY_CMD(11)
313 
314 #define BRLAPI_KEY_CMD_GOTOMARK BRLAPI_KEY_CMD(12)
315 
316 #define BRLAPI_KEY_CMD_GOTOLINE BRLAPI_KEY_CMD(13)
317 
318 #define BRLAPI_KEY_CMD_PRDIFCHAR BRLAPI_KEY_CMD(14)
319 
320 #define BRLAPI_KEY_CMD_NXDIFCHAR BRLAPI_KEY_CMD(15)
321 
322 #define BRLAPI_KEY_CMD_CLIP_COPY BRLAPI_KEY_CMD(16)
323 
324 #define BRLAPI_KEY_CMD_COPYCHARS BRLAPI_KEY_CMD(16)
325 
326 #define BRLAPI_KEY_CMD_CLIP_APPEND BRLAPI_KEY_CMD(17)
327 
328 #define BRLAPI_KEY_CMD_APNDCHARS BRLAPI_KEY_CMD(17)
329 
330 #define BRLAPI_KEY_CMD_PASTE_HISTORY BRLAPI_KEY_CMD(18)
331 
332 #define BRLAPI_KEY_CMD_SET_TEXT_TABLE BRLAPI_KEY_CMD(19)
333 
334 #define BRLAPI_KEY_CMD_SET_ATTRIBUTES_TABLE BRLAPI_KEY_CMD(20)
335 
336 #define BRLAPI_KEY_CMD_SET_CONTRACTION_TABLE BRLAPI_KEY_CMD(21)
337 
338 #define BRLAPI_KEY_CMD_SET_KEYBOARD_TABLE BRLAPI_KEY_CMD(22)
339 
340 #define BRLAPI_KEY_CMD_SET_LANGUAGE_PROFILE BRLAPI_KEY_CMD(23)
341 
342 #define BRLAPI_KEY_CMD_SELECTVT BRLAPI_KEY_CMD(30)
343 
344 #define BRLAPI_KEY_CMD_ALERT BRLAPI_KEY_CMD(31)
345 
346 #define BRLAPI_KEY_CMD_PASSDOTS BRLAPI_KEY_CMD(34)
347 
348 #define BRLAPI_KEY_CMD_PASSAT BRLAPI_KEY_CMD(35)
349 
350 #define BRLAPI_KEY_CMD_PASSXT BRLAPI_KEY_CMD(36)
351 
352 #define BRLAPI_KEY_CMD_PASSPS2 BRLAPI_KEY_CMD(37)
353 
354 #define BRLAPI_KEY_CMD_CONTEXT BRLAPI_KEY_CMD(38)
355 
356 #define BRLAPI_KEY_CMD_TOUCH_AT BRLAPI_KEY_CMD(39)
357 
358 #define BRLAPI_KEY_FLG_TOGGLE_ON BRLAPI_KEY_FLG(0X0100)
359 
360 #define BRLAPI_KEY_FLG_TOGGLE_OFF BRLAPI_KEY_FLG(0X0200)
361 
362 #define BRLAPI_KEY_FLG_TOGGLE_MASK (BRLAPI_KEY_FLG_TOGGLE_ON | BRLAPI_KEY_FLG_TOGGLE_OFF)
363 
364 #define BRLAPI_KEY_FLG_MOTION_ROUTE BRLAPI_KEY_FLG(0X0400)
365 
366 #define BRLAPI_KEY_FLG_MOTION_SCALED BRLAPI_KEY_FLG(0X0800)
367 
368 #define BRLAPI_KEY_FLG_MOTION_TOLEFT BRLAPI_KEY_FLG(0X1000)
369 
370 #define BRLAPI_KEY_FLG_SHIFT BRLAPI_KEY_FLG(0X01)
371 
372 #define BRLAPI_KEY_FLG_UPPER BRLAPI_KEY_FLG(0X02)
373 
374 #define BRLAPI_KEY_FLG_CONTROL BRLAPI_KEY_FLG(0X04)
375 
376 #define BRLAPI_KEY_FLG_META BRLAPI_KEY_FLG(0X08)
377 
378 #define BRLAPI_KEY_FLG_ALTGR BRLAPI_KEY_FLG(0X10)
379 
380 #define BRLAPI_KEY_FLG_GUI BRLAPI_KEY_FLG(0X20)
381 
382 #define BRLAPI_KEY_FLG_KBD_RELEASE BRLAPI_KEY_FLG(0X0100)
383 
384 #define BRLAPI_KEY_FLG_KBD_EMUL0 BRLAPI_KEY_FLG(0X0200)
385 
386 #define BRLAPI_KEY_FLG_KBD_EMUL1 BRLAPI_KEY_FLG(0X0400)
387 
388 #define BRLAPI_DOT1 1
389 
390 #define BRLAPI_DOT2 2
391 
392 #define BRLAPI_DOT3 4
393 
394 #define BRLAPI_DOT4 8
395 
396 #define BRLAPI_DOT5 16
397 
398 #define BRLAPI_DOT6 32
399 
400 #define BRLAPI_DOT7 64
401 
402 #define BRLAPI_DOT8 128
403 
404 #define BRLAPI_DOTC 256
405 
407 #define BRLAPI_DOTS(dot1, dot2, dot3, dot4, dot5, dot6, dot7, dot8) (\
408  ((dot1)? BRLAPI_DOT1: 0) | \
409  ((dot2)? BRLAPI_DOT2: 0) | \
410  ((dot3)? BRLAPI_DOT3: 0) | \
411  ((dot4)? BRLAPI_DOT4: 0) | \
412  ((dot5)? BRLAPI_DOT5: 0) | \
413  ((dot6)? BRLAPI_DOT6: 0) | \
414  ((dot7)? BRLAPI_DOT7: 0) | \
415  ((dot8)? BRLAPI_DOT8: 0) \
416 )
417 
419 #define BRLAPI_DOT_CHORD 256
420 
423 #ifdef __cplusplus
424 }
425 #endif /* __cplusplus */
426 
427 #endif /* BRLAPI_INCLUDED_CONSTANTS */