# brlapi_constants.h

Go to the documentation of this file.

    00001 /*
    00002  * libbrlapi - A library providing access to braille terminals for applications.
    00003  *
    00004  * Copyright (C) 2002-2012 by
    00005  *   Samuel Thibault <Samuel.Thibault@ens-lyon.org>
    00006  *   Sébastien Hinderer <Sebastien.Hinderer@ens-lyon.org>
    00007  *
    00008  * libbrlapi comes with ABSOLUTELY NO WARRANTY.
    00009  *
    00010  * This is free software, placed under the terms of the
    00011  * GNU Lesser General Public License, as published by the Free Software
    00012  * Foundation; either version 2.1 of the License, or (at your option) any
    00013  * later version. Please see the file LICENSE-LGPL for details.
    00014  *
    00015  * Web Page: http://mielke.cc/brltty/
    00016  *
    00017  * This software is maintained by Dave Mielke <dave@mielke.cc>.
    00018  */
    00019
    00020 #ifndef BRLAPI_INCLUDED_CONSTANTS
    00021 #define BRLAPI_INCLUDED_CONSTANTS
    00022
    00023 #ifdef __cplusplus
    00024 extern "C" {
    00025 #endif /* __cplusplus */
    00026
    00034 #define BRLAPI_KEY_CMD_NOOP (BRLAPI_KEY_CMD(0) + 0)
    00035
    00036 #define BRLAPI_KEY_CMD_LNUP (BRLAPI_KEY_CMD(0) + 1)
    00037
    00038 #define BRLAPI_KEY_CMD_LNDN (BRLAPI_KEY_CMD(0) + 2)
    00039
    00040 #define BRLAPI_KEY_CMD_WINUP (BRLAPI_KEY_CMD(0) + 3)
    00041
    00042 #define BRLAPI_KEY_CMD_WINDN (BRLAPI_KEY_CMD(0) + 4)
    00043
    00044 #define BRLAPI_KEY_CMD_PRDIFLN (BRLAPI_KEY_CMD(0) + 5)
    00045
    00046 #define BRLAPI_KEY_CMD_NXDIFLN (BRLAPI_KEY_CMD(0) + 6)
    00047
    00048 #define BRLAPI_KEY_CMD_ATTRUP (BRLAPI_KEY_CMD(0) + 7)
    00049
    00050 #define BRLAPI_KEY_CMD_ATTRDN (BRLAPI_KEY_CMD(0) + 8)
    00051
    00052 #define BRLAPI_KEY_CMD_TOP (BRLAPI_KEY_CMD(0) + 9)
    00053
    00054 #define BRLAPI_KEY_CMD_BOT (BRLAPI_KEY_CMD(0) + 10)
    00055
    00056 #define BRLAPI_KEY_CMD_TOP_LEFT (BRLAPI_KEY_CMD(0) + 11)
    00057
    00058 #define BRLAPI_KEY_CMD_BOT_LEFT (BRLAPI_KEY_CMD(0) + 12)
    00059
    00060 #define BRLAPI_KEY_CMD_PRPGRPH (BRLAPI_KEY_CMD(0) + 13)
    00061
    00062 #define BRLAPI_KEY_CMD_NXPGRPH (BRLAPI_KEY_CMD(0) + 14)
    00063
    00064 #define BRLAPI_KEY_CMD_PRPROMPT (BRLAPI_KEY_CMD(0) + 15)
    00065
    00066 #define BRLAPI_KEY_CMD_NXPROMPT (BRLAPI_KEY_CMD(0) + 16)
    00067
    00068 #define BRLAPI_KEY_CMD_PRSEARCH (BRLAPI_KEY_CMD(0) + 17)
    00069
    00070 #define BRLAPI_KEY_CMD_NXSEARCH (BRLAPI_KEY_CMD(0) + 18)
    00071
    00072 #define BRLAPI_KEY_CMD_CHRLT (BRLAPI_KEY_CMD(0) + 19)
    00073
    00074 #define BRLAPI_KEY_CMD_CHRRT (BRLAPI_KEY_CMD(0) + 20)
    00075
    00076 #define BRLAPI_KEY_CMD_HWINLT (BRLAPI_KEY_CMD(0) + 21)
    00077
    00078 #define BRLAPI_KEY_CMD_HWINRT (BRLAPI_KEY_CMD(0) + 22)
    00079
    00080 #define BRLAPI_KEY_CMD_FWINLT (BRLAPI_KEY_CMD(0) + 23)
    00081
    00082 #define BRLAPI_KEY_CMD_FWINRT (BRLAPI_KEY_CMD(0) + 24)
    00083
    00084 #define BRLAPI_KEY_CMD_FWINLTSKIP (BRLAPI_KEY_CMD(0) + 25)
    00085
    00086 #define BRLAPI_KEY_CMD_FWINRTSKIP (BRLAPI_KEY_CMD(0) + 26)
    00087
    00088 #define BRLAPI_KEY_CMD_LNBEG (BRLAPI_KEY_CMD(0) + 27)
    00089
    00090 #define BRLAPI_KEY_CMD_LNEND (BRLAPI_KEY_CMD(0) + 28)
    00091
    00092 #define BRLAPI_KEY_CMD_HOME (BRLAPI_KEY_CMD(0) + 29)
    00093
    00094 #define BRLAPI_KEY_CMD_BACK (BRLAPI_KEY_CMD(0) + 30)
    00095
    00096 #define BRLAPI_KEY_CMD_RETURN (BRLAPI_KEY_CMD(0) + 31)
    00097
    00098 #define BRLAPI_KEY_CMD_FREEZE (BRLAPI_KEY_CMD(0) + 32)
    00099
    00100 #define BRLAPI_KEY_CMD_DISPMD (BRLAPI_KEY_CMD(0) + 33)
    00101
    00102 #define BRLAPI_KEY_CMD_SIXDOTS (BRLAPI_KEY_CMD(0) + 34)
    00103
    00104 #define BRLAPI_KEY_CMD_SLIDEWIN (BRLAPI_KEY_CMD(0) + 35)
    00105
    00106 #define BRLAPI_KEY_CMD_SKPIDLNS (BRLAPI_KEY_CMD(0) + 36)
    00107
    00108 #define BRLAPI_KEY_CMD_SKPBLNKWINS (BRLAPI_KEY_CMD(0) + 37)
    00109
    00110 #define BRLAPI_KEY_CMD_CSRVIS (BRLAPI_KEY_CMD(0) + 38)
    00111
    00112 #define BRLAPI_KEY_CMD_CSRHIDE (BRLAPI_KEY_CMD(0) + 39)
    00113
    00114 #define BRLAPI_KEY_CMD_CSRTRK (BRLAPI_KEY_CMD(0) + 40)
    00115
    00116 #define BRLAPI_KEY_CMD_CSRSIZE (BRLAPI_KEY_CMD(0) + 41)
    00117
    00118 #define BRLAPI_KEY_CMD_CSRBLINK (BRLAPI_KEY_CMD(0) + 42)
    00119
    00120 #define BRLAPI_KEY_CMD_ATTRVIS (BRLAPI_KEY_CMD(0) + 43)
    00121
    00122 #define BRLAPI_KEY_CMD_ATTRBLINK (BRLAPI_KEY_CMD(0) + 44)
    00123
    00124 #define BRLAPI_KEY_CMD_CAPBLINK (BRLAPI_KEY_CMD(0) + 45)
    00125
    00126 #define BRLAPI_KEY_CMD_TUNES (BRLAPI_KEY_CMD(0) + 46)
    00127
    00128 #define BRLAPI_KEY_CMD_AUTOREPEAT (BRLAPI_KEY_CMD(0) + 47)
    00129
    00130 #define BRLAPI_KEY_CMD_AUTOSPEAK (BRLAPI_KEY_CMD(0) + 48)
    00131
    00132 #define BRLAPI_KEY_CMD_HELP (BRLAPI_KEY_CMD(0) + 49)
    00133
    00134 #define BRLAPI_KEY_CMD_INFO (BRLAPI_KEY_CMD(0) + 50)
    00135
    00136 #define BRLAPI_KEY_CMD_LEARN (BRLAPI_KEY_CMD(0) + 51)
    00137
    00138 #define BRLAPI_KEY_CMD_PREFMENU (BRLAPI_KEY_CMD(0) + 52)
    00139
    00140 #define BRLAPI_KEY_CMD_PREFSAVE (BRLAPI_KEY_CMD(0) + 53)
    00141
    00142 #define BRLAPI_KEY_CMD_PREFLOAD (BRLAPI_KEY_CMD(0) + 54)
    00143
    00144 #define BRLAPI_KEY_CMD_MENU_FIRST_ITEM (BRLAPI_KEY_CMD(0) + 55)
    00145
    00146 #define BRLAPI_KEY_CMD_MENU_LAST_ITEM (BRLAPI_KEY_CMD(0) + 56)
    00147
    00148 #define BRLAPI_KEY_CMD_MENU_PREV_ITEM (BRLAPI_KEY_CMD(0) + 57)
    00149
    00150 #define BRLAPI_KEY_CMD_MENU_NEXT_ITEM (BRLAPI_KEY_CMD(0) + 58)
    00151
    00152 #define BRLAPI_KEY_CMD_MENU_PREV_SETTING (BRLAPI_KEY_CMD(0) + 59)
    00153
    00154 #define BRLAPI_KEY_CMD_MENU_NEXT_SETTING (BRLAPI_KEY_CMD(0) + 60)
    00155
    00156 #define BRLAPI_KEY_CMD_MUTE (BRLAPI_KEY_CMD(0) + 61)
    00157
    00158 #define BRLAPI_KEY_CMD_SPKHOME (BRLAPI_KEY_CMD(0) + 62)
    00159
    00160 #define BRLAPI_KEY_CMD_SAY_LINE (BRLAPI_KEY_CMD(0) + 63)
    00161
    00162 #define BRLAPI_KEY_CMD_SAY_ABOVE (BRLAPI_KEY_CMD(0) + 64)
    00163
    00164 #define BRLAPI_KEY_CMD_SAY_BELOW (BRLAPI_KEY_CMD(0) + 65)
    00165
    00166 #define BRLAPI_KEY_CMD_SAY_SLOWER (BRLAPI_KEY_CMD(0) + 66)
    00167
    00168 #define BRLAPI_KEY_CMD_SAY_FASTER (BRLAPI_KEY_CMD(0) + 67)
    00169
    00170 #define BRLAPI_KEY_CMD_SAY_SOFTER (BRLAPI_KEY_CMD(0) + 68)
    00171
    00172 #define BRLAPI_KEY_CMD_SAY_LOUDER (BRLAPI_KEY_CMD(0) + 69)
    00173
    00174 #define BRLAPI_KEY_CMD_SWITCHVT_PREV (BRLAPI_KEY_CMD(0) + 70)
    00175
    00176 #define BRLAPI_KEY_CMD_SWITCHVT_NEXT (BRLAPI_KEY_CMD(0) + 71)
    00177
    00178 #define BRLAPI_KEY_CMD_CSRJMP_VERT (BRLAPI_KEY_CMD(0) + 72)
    00179
    00180 #define BRLAPI_KEY_CMD_PASTE (BRLAPI_KEY_CMD(0) + 73)
    00181
    00182 #define BRLAPI_KEY_CMD_RESTARTBRL (BRLAPI_KEY_CMD(0) + 74)
    00183
    00184 #define BRLAPI_KEY_CMD_RESTARTSPEECH (BRLAPI_KEY_CMD(0) + 75)
    00185
    00186 #define BRLAPI_KEY_CMD_OFFLINE (BRLAPI_KEY_CMD(0) + 76)
    00187
    00188 #define BRLAPI_KEY_CMD_SHIFT (BRLAPI_KEY_CMD(0) + 77)
    00189
    00190 #define BRLAPI_KEY_CMD_UPPER (BRLAPI_KEY_CMD(0) + 78)
    00191
    00192 #define BRLAPI_KEY_CMD_CONTROL (BRLAPI_KEY_CMD(0) + 79)
    00193
    00194 #define BRLAPI_KEY_CMD_META (BRLAPI_KEY_CMD(0) + 80)
    00195
    00196 #define BRLAPI_KEY_CMD_TIME (BRLAPI_KEY_CMD(0) + 81)
    00197
    00198 #define BRLAPI_KEY_CMD_MENU_PREV_LEVEL (BRLAPI_KEY_CMD(0) + 82)
    00199
    00200 #define BRLAPI_KEY_CMD_ASPK_SEL_LINE (BRLAPI_KEY_CMD(0) + 83)
    00201
    00202 #define BRLAPI_KEY_CMD_ASPK_SEL_CHAR (BRLAPI_KEY_CMD(0) + 84)
    00203
    00204 #define BRLAPI_KEY_CMD_ASPK_INS_CHARS (BRLAPI_KEY_CMD(0) + 85)
    00205
    00206 #define BRLAPI_KEY_CMD_ASPK_DEL_CHARS (BRLAPI_KEY_CMD(0) + 86)
    00207
    00208 #define BRLAPI_KEY_CMD_ASPK_REP_CHARS (BRLAPI_KEY_CMD(0) + 87)
    00209
    00210 #define BRLAPI_KEY_CMD_ASPK_CMP_WORDS (BRLAPI_KEY_CMD(0) + 88)
    00211
    00212 #define BRLAPI_KEY_CMD_SPEAK_CURR_CHAR (BRLAPI_KEY_CMD(0) + 89)
    00213
    00214 #define BRLAPI_KEY_CMD_SPEAK_PREV_CHAR (BRLAPI_KEY_CMD(0) + 90)
    00215
    00216 #define BRLAPI_KEY_CMD_SPEAK_NEXT_CHAR (BRLAPI_KEY_CMD(0) + 91)
    00217
    00218 #define BRLAPI_KEY_CMD_SPEAK_CURR_WORD (BRLAPI_KEY_CMD(0) + 92)
    00219
    00220 #define BRLAPI_KEY_CMD_SPEAK_PREV_WORD (BRLAPI_KEY_CMD(0) + 93)
    00221
    00222 #define BRLAPI_KEY_CMD_SPEAK_NEXT_WORD (BRLAPI_KEY_CMD(0) + 94)
    00223
    00224 #define BRLAPI_KEY_CMD_SPEAK_CURR_LINE (BRLAPI_KEY_CMD(0) + 95)
    00225
    00226 #define BRLAPI_KEY_CMD_SPEAK_PREV_LINE (BRLAPI_KEY_CMD(0) + 96)
    00227
    00228 #define BRLAPI_KEY_CMD_SPEAK_NEXT_LINE (BRLAPI_KEY_CMD(0) + 97)
    00229
    00230 #define BRLAPI_KEY_CMD_SPEAK_FRST_CHAR (BRLAPI_KEY_CMD(0) + 98)
    00231
    00232 #define BRLAPI_KEY_CMD_SPEAK_LAST_CHAR (BRLAPI_KEY_CMD(0) + 99)
    00233
    00234 #define BRLAPI_KEY_CMD_SPEAK_FRST_LINE (BRLAPI_KEY_CMD(0) + 100)
    00235
    00236 #define BRLAPI_KEY_CMD_SPEAK_LAST_LINE (BRLAPI_KEY_CMD(0) + 101)
    00237
    00238 #define BRLAPI_KEY_CMD_DESC_CURR_CHAR (BRLAPI_KEY_CMD(0) + 102)
    00239
    00240 #define BRLAPI_KEY_CMD_SPELL_CURR_WORD (BRLAPI_KEY_CMD(0) + 103)
    00241
    00242 #define BRLAPI_KEY_CMD_ROUTE_CURR_LOCN (BRLAPI_KEY_CMD(0) + 104)
    00243
    00244 #define BRLAPI_KEY_CMD_SPEAK_CURR_LOCN (BRLAPI_KEY_CMD(0) + 105)
    00245
    00246 #define BRLAPI_KEY_CMD_SHOW_CURR_LOCN (BRLAPI_KEY_CMD(0) + 106)
    00247
    00248 #define BRLAPI_KEY_FLG_TOGGLE_ON BRLAPI_KEY_FLG(0X0100)
    00249
    00250 #define BRLAPI_KEY_FLG_TOGGLE_OFF BRLAPI_KEY_FLG(0X0200)
    00251
    00252 #define BRLAPI_KEY_FLG_TOGGLE_MASK (BRLAPI_KEY_FLG_TOGGLE_ON | BRLAPI_KEY_FLG_TOGGLE_OFF)
    00253
    00254 #define BRLAPI_KEY_FLG_MOTION_ROUTE BRLAPI_KEY_FLG(0X0400)
    00255
    00256 #define BRLAPI_KEY_FLG_REPEAT_INITIAL BRLAPI_KEY_FLG(0X8000)
    00257
    00258 #define BRLAPI_KEY_FLG_REPEAT_DELAY BRLAPI_KEY_FLG(0X4000)
    00259
    00260 #define BRLAPI_KEY_FLG_REPEAT_MASK (BRLAPI_KEY_FLG_REPEAT_INITIAL | BRLAPI_KEY_FLG_REPEAT_DELAY)
    00261
    00262 #define BRLAPI_KEY_CMD_ROUTE BRLAPI_KEY_CMD(0X01)
    00263
    00264 #define BRLAPI_KEY_CMD_CLIP_NEW BRLAPI_KEY_CMD(0X02)
    00265
    00266 #define BRLAPI_KEY_CMD_CUTBEGIN BRLAPI_KEY_CMD(0X02)
    00267
    00268 #define BRLAPI_KEY_CMD_CLIP_ADD BRLAPI_KEY_CMD(0X03)
    00269
    00270 #define BRLAPI_KEY_CMD_CUTAPPEND BRLAPI_KEY_CMD(0X03)
    00271
    00272 #define BRLAPI_KEY_CMD_COPY_RECT BRLAPI_KEY_CMD(0X04)
    00273
    00274 #define BRLAPI_KEY_CMD_CUTRECT BRLAPI_KEY_CMD(0X04)
    00275
    00276 #define BRLAPI_KEY_CMD_COPY_LINE BRLAPI_KEY_CMD(0X05)
    00277
    00278 #define BRLAPI_KEY_CMD_CUTLINE BRLAPI_KEY_CMD(0X05)
    00279
    00280 #define BRLAPI_KEY_CMD_SWITCHVT BRLAPI_KEY_CMD(0X06)
    00281
    00282 #define BRLAPI_KEY_CMD_PRINDENT BRLAPI_KEY_CMD(0X07)
    00283
    00284 #define BRLAPI_KEY_CMD_NXINDENT BRLAPI_KEY_CMD(0X08)
    00285
    00286 #define BRLAPI_KEY_CMD_DESCCHAR BRLAPI_KEY_CMD(0X09)
    00287
    00288 #define BRLAPI_KEY_CMD_SETLEFT BRLAPI_KEY_CMD(0X0A)
    00289
    00290 #define BRLAPI_KEY_CMD_SETMARK BRLAPI_KEY_CMD(0X0B)
    00291
    00292 #define BRLAPI_KEY_CMD_GOTOMARK BRLAPI_KEY_CMD(0X0C)
    00293
    00294 #define BRLAPI_KEY_CMD_GOTOLINE BRLAPI_KEY_CMD(0X0D)
    00295
    00296 #define BRLAPI_KEY_FLG_LINE_SCALED BRLAPI_KEY_FLG(0X0100)
    00297
    00298 #define BRLAPI_KEY_FLG_LINE_TOLEFT BRLAPI_KEY_FLG(0X0200)
    00299
    00300 #define BRLAPI_KEY_CMD_PRDIFCHAR BRLAPI_KEY_CMD(0X0E)
    00301
    00302 #define BRLAPI_KEY_CMD_NXDIFCHAR BRLAPI_KEY_CMD(0X0F)
    00303
    00304 #define BRLAPI_KEY_CMD_CLIP_COPY BRLAPI_KEY_CMD(0X10)
    00305
    00306 #define BRLAPI_KEY_CMD_COPYCHARS BRLAPI_KEY_CMD(0X10)
    00307
    00308 #define BRLAPI_KEY_CMD_CLIP_APPEND BRLAPI_KEY_CMD(0X11)
    00309
    00310 #define BRLAPI_KEY_CMD_APNDCHARS BRLAPI_KEY_CMD(0X11)
    00311
    00312 #define BRLAPI_KEY_CMD_PWGEN BRLAPI_KEY_CMD(0X12)
    00313
    00314 #define BRLAPI_KEY_CMD_PASSDOTS BRLAPI_KEY_CMD(0X22)
    00315
    00316 #define BRLAPI_KEY_FLG_SHIFT BRLAPI_KEY_FLG(0X01)
    00317
    00318 #define BRLAPI_KEY_FLG_UPPER BRLAPI_KEY_FLG(0X02)
    00319
    00320 #define BRLAPI_KEY_FLG_CONTROL BRLAPI_KEY_FLG(0X04)
    00321
    00322 #define BRLAPI_KEY_FLG_META BRLAPI_KEY_FLG(0X08)
    00323
    00324 #define BRLAPI_DOT1 0001
    00325
    00326 #define BRLAPI_DOT2 0002
    00327
    00328 #define BRLAPI_DOT3 0004
    00329
    00330 #define BRLAPI_DOT4 0010
    00331
    00332 #define BRLAPI_DOT5 0020
    00333
    00334 #define BRLAPI_DOT6 0040
    00335
    00336 #define BRLAPI_DOT7 0100
    00337
    00338 #define BRLAPI_DOT8 0200
    00339
    00340 #define BRLAPI_DOTC 0400
    00341
    00342 #define BRLAPI_KEY_CMD_PASSAT BRLAPI_KEY_CMD(0X23)
    00343
    00344 #define BRLAPI_KEY_CMD_PASSXT BRLAPI_KEY_CMD(0X24)
    00345
    00346 #define BRLAPI_KEY_CMD_PASSPS2 BRLAPI_KEY_CMD(0X25)
    00347
    00348 #define BRLAPI_KEY_FLG_KBD_RELEASE BRLAPI_KEY_FLG(0X0100)
    00349
    00350 #define BRLAPI_KEY_FLG_KBD_EMUL0 BRLAPI_KEY_FLG(0X0200)
    00351
    00352 #define BRLAPI_KEY_FLG_KBD_EMUL1 BRLAPI_KEY_FLG(0X0400)
    00353
    00354 #define BRLAPI_KEY_CMD_CONTEXT BRLAPI_KEY_CMD(0X26)
    00355
    00357 #define BRLAPI_DOTS(dot1, dot2, dot3, dot4, dot5, dot6, dot7, dot8) (\
    00358   ((dot1)? BRLAPI_DOT1: 0) | \
    00359   ((dot2)? BRLAPI_DOT2: 0) | \
    00360   ((dot3)? BRLAPI_DOT3: 0) | \
    00361   ((dot4)? BRLAPI_DOT4: 0) | \
    00362   ((dot5)? BRLAPI_DOT5: 0) | \
    00363   ((dot6)? BRLAPI_DOT6: 0) | \
    00364   ((dot7)? BRLAPI_DOT7: 0) | \
    00365   ((dot8)? BRLAPI_DOT8: 0) \
    00366 )
    00367
    00369 #define BRLAPI_DOT_CHORD 256
    00370
    00373 #ifdef __cplusplus
    00374 }
    00375 #endif /* __cplusplus */
    00376
    00377 #endif /* BRLAPI_INCLUDED_CONSTANTS */