brlapi_brldefs.h 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454
  1. /*
  2. * BRLTTY - A background process providing access to the console screen (when in
  3. * text mode) for a blind person using a refreshable braille display.
  4. *
  5. * Copyright (C) 1995-2020 by The BRLTTY Developers.
  6. *
  7. * BRLTTY comes with ABSOLUTELY NO WARRANTY.
  8. *
  9. * This is free software, placed under the terms of the
  10. * GNU Lesser General Public License, as published by the Free Software
  11. * Foundation; either version 2.1 of the License, or (at your option) any
  12. * later version. Please see the file LICENSE-LGPL for details.
  13. *
  14. * Web Page: http://brltty.app/
  15. *
  16. * This software is maintained by Dave Mielke <dave@mielke.cc>.
  17. */
  18. #ifndef BRLAPI_INCLUDED_BRLDEFS
  19. #define BRLAPI_INCLUDED_BRLDEFS
  20. #ifdef __cplusplus
  21. extern "C" {
  22. #endif /* __cplusplus */
  23. #define BRL_FLG_PUT(fLG) BRLAPI_KEY_FLG_PUT(fLG)
  24. /** do nothing */
  25. #define BRL_CMD_NOOP (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_NOOP)
  26. /** go up one line */
  27. #define BRL_CMD_LNUP (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_LNUP)
  28. /** go down one line */
  29. #define BRL_CMD_LNDN (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_LNDN)
  30. /** go up several lines */
  31. #define BRL_CMD_WINUP (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_WINUP)
  32. /** go down several lines */
  33. #define BRL_CMD_WINDN (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_WINDN)
  34. /** go up to nearest line with different content */
  35. #define BRL_CMD_PRDIFLN (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_PRDIFLN)
  36. /** go down to nearest line with different content */
  37. #define BRL_CMD_NXDIFLN (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_NXDIFLN)
  38. /** go up to nearest line with different highlighting */
  39. #define BRL_CMD_ATTRUP (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_ATTRUP)
  40. /** go down to nearest line with different highlighting */
  41. #define BRL_CMD_ATTRDN (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_ATTRDN)
  42. /** go to top line */
  43. #define BRL_CMD_TOP (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_TOP)
  44. /** go to bottom line */
  45. #define BRL_CMD_BOT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_BOT)
  46. /** go to beginning of top line */
  47. #define BRL_CMD_TOP_LEFT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_TOP_LEFT)
  48. /** go to beginning of bottom line */
  49. #define BRL_CMD_BOT_LEFT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_BOT_LEFT)
  50. /** go up to first line of paragraph */
  51. #define BRL_CMD_PRPGRPH (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_PRPGRPH)
  52. /** go down to first line of next paragraph */
  53. #define BRL_CMD_NXPGRPH (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_NXPGRPH)
  54. /** go up to previous command prompt */
  55. #define BRL_CMD_PRPROMPT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_PRPROMPT)
  56. /** go down to next command prompt */
  57. #define BRL_CMD_NXPROMPT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_NXPROMPT)
  58. /** search backward for clipboard text */
  59. #define BRL_CMD_PRSEARCH (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_PRSEARCH)
  60. /** search forward for clipboard text */
  61. #define BRL_CMD_NXSEARCH (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_NXSEARCH)
  62. /** go left one character */
  63. #define BRL_CMD_CHRLT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CHRLT)
  64. /** go right one character */
  65. #define BRL_CMD_CHRRT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CHRRT)
  66. /** go left half a braille window */
  67. #define BRL_CMD_HWINLT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_HWINLT)
  68. /** go right half a braille window */
  69. #define BRL_CMD_HWINRT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_HWINRT)
  70. /** go backward one braille window */
  71. #define BRL_CMD_FWINLT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_FWINLT)
  72. /** go forward one braille window */
  73. #define BRL_CMD_FWINRT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_FWINRT)
  74. /** go backward skipping blank braille windows */
  75. #define BRL_CMD_FWINLTSKIP (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_FWINLTSKIP)
  76. /** go forward skipping blank braille windows */
  77. #define BRL_CMD_FWINRTSKIP (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_FWINRTSKIP)
  78. /** go to beginning of line */
  79. #define BRL_CMD_LNBEG (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_LNBEG)
  80. /** go to end of line */
  81. #define BRL_CMD_LNEND (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_LNEND)
  82. /** go to screen cursor */
  83. #define BRL_CMD_HOME (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_HOME)
  84. /** go back after cursor tracking */
  85. #define BRL_CMD_BACK (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_BACK)
  86. /** go to screen cursor or go back after cursor tracking */
  87. #define BRL_CMD_RETURN (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_RETURN)
  88. /** set screen image frozen/unfrozen */
  89. #define BRL_CMD_FREEZE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_FREEZE)
  90. /** set display mode attributes/text */
  91. #define BRL_CMD_DISPMD (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_DISPMD)
  92. /** set text style 6-dot/8-dot */
  93. #define BRL_CMD_SIXDOTS (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SIXDOTS)
  94. /** set sliding braille window on/off */
  95. #define BRL_CMD_SLIDEWIN (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SLIDEWIN)
  96. /** set skipping of lines with identical content on/off */
  97. #define BRL_CMD_SKPIDLNS (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SKPIDLNS)
  98. /** set skipping of blank braille windows on/off */
  99. #define BRL_CMD_SKPBLNKWINS (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SKPBLNKWINS)
  100. /** set screen cursor visibility on/off */
  101. #define BRL_CMD_CSRVIS (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CSRVIS)
  102. /** set hidden screen cursor on/off */
  103. #define BRL_CMD_CSRHIDE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CSRHIDE)
  104. /** set track screen cursor on/off */
  105. #define BRL_CMD_CSRTRK (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CSRTRK)
  106. /** set screen cursor style block/underline */
  107. #define BRL_CMD_CSRSIZE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CSRSIZE)
  108. /** set screen cursor blinking on/off */
  109. #define BRL_CMD_CSRBLINK (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CSRBLINK)
  110. /** set attribute underlining on/off */
  111. #define BRL_CMD_ATTRVIS (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_ATTRVIS)
  112. /** set attribute blinking on/off */
  113. #define BRL_CMD_ATTRBLINK (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_ATTRBLINK)
  114. /** set capital letter blinking on/off */
  115. #define BRL_CMD_CAPBLINK (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CAPBLINK)
  116. /** set alert tunes on/off */
  117. #define BRL_CMD_TUNES (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_TUNES)
  118. /** set autorepeat on/off */
  119. #define BRL_CMD_AUTOREPEAT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_AUTOREPEAT)
  120. /** set autospeak on/off */
  121. #define BRL_CMD_AUTOSPEAK (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_AUTOSPEAK)
  122. /** enter/leave help display */
  123. #define BRL_CMD_HELP (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_HELP)
  124. /** enter/leave status display */
  125. #define BRL_CMD_INFO (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_INFO)
  126. /** enter/leave command learn mode */
  127. #define BRL_CMD_LEARN (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_LEARN)
  128. /** enter/leave preferences menu */
  129. #define BRL_CMD_PREFMENU (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_PREFMENU)
  130. /** save preferences to disk */
  131. #define BRL_CMD_PREFSAVE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_PREFSAVE)
  132. /** restore preferences from disk */
  133. #define BRL_CMD_PREFLOAD (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_PREFLOAD)
  134. /** go up to first item */
  135. #define BRL_CMD_MENU_FIRST_ITEM (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_MENU_FIRST_ITEM)
  136. /** go down to last item */
  137. #define BRL_CMD_MENU_LAST_ITEM (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_MENU_LAST_ITEM)
  138. /** go up to previous item */
  139. #define BRL_CMD_MENU_PREV_ITEM (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_MENU_PREV_ITEM)
  140. /** go down to next item */
  141. #define BRL_CMD_MENU_NEXT_ITEM (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_MENU_NEXT_ITEM)
  142. /** select previous choice */
  143. #define BRL_CMD_MENU_PREV_SETTING (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_MENU_PREV_SETTING)
  144. /** select next choice */
  145. #define BRL_CMD_MENU_NEXT_SETTING (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_MENU_NEXT_SETTING)
  146. /** stop speaking */
  147. #define BRL_CMD_MUTE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_MUTE)
  148. /** go to current speaking position */
  149. #define BRL_CMD_SPKHOME (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPKHOME)
  150. /** speak current line */
  151. #define BRL_CMD_SAY_LINE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SAY_LINE)
  152. /** speak from top of screen through current line */
  153. #define BRL_CMD_SAY_ABOVE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SAY_ABOVE)
  154. /** speak from current line through bottom of screen */
  155. #define BRL_CMD_SAY_BELOW (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SAY_BELOW)
  156. /** decrease speaking rate */
  157. #define BRL_CMD_SAY_SLOWER (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SAY_SLOWER)
  158. /** increase speaking rate */
  159. #define BRL_CMD_SAY_FASTER (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SAY_FASTER)
  160. /** decrease speaking volume */
  161. #define BRL_CMD_SAY_SOFTER (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SAY_SOFTER)
  162. /** increase speaking volume */
  163. #define BRL_CMD_SAY_LOUDER (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SAY_LOUDER)
  164. /** switch to the previous virtual terminal */
  165. #define BRL_CMD_SWITCHVT_PREV (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SWITCHVT_PREV)
  166. /** switch to the next virtual terminal */
  167. #define BRL_CMD_SWITCHVT_NEXT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SWITCHVT_NEXT)
  168. /** bring screen cursor to current line */
  169. #define BRL_CMD_CSRJMP_VERT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CSRJMP_VERT)
  170. /** insert clipboard text after screen cursor */
  171. #define BRL_CMD_PASTE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_PASTE)
  172. /** restart braille driver */
  173. #define BRL_CMD_RESTARTBRL (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_RESTARTBRL)
  174. /** restart speech driver */
  175. #define BRL_CMD_RESTARTSPEECH (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_RESTARTSPEECH)
  176. /** braille display temporarily unavailable */
  177. #define BRL_CMD_OFFLINE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_OFFLINE)
  178. /** cycle the Shift sticky input modifier (next, on, off) */
  179. #define BRL_CMD_SHIFT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SHIFT)
  180. /** cycle the Upper sticky input modifier (next, on, off) */
  181. #define BRL_CMD_UPPER (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_UPPER)
  182. /** cycle the Control sticky input modifier (next, on, off) */
  183. #define BRL_CMD_CONTROL (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CONTROL)
  184. /** cycle the Meta (Left Alt) sticky input modifier (next, on, off) */
  185. #define BRL_CMD_META (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_META)
  186. /** show current date and time */
  187. #define BRL_CMD_TIME (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_TIME)
  188. /** go to previous menu level */
  189. #define BRL_CMD_MENU_PREV_LEVEL (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_MENU_PREV_LEVEL)
  190. /** set autospeak selected line on/off */
  191. #define BRL_CMD_ASPK_SEL_LINE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_ASPK_SEL_LINE)
  192. /** set autospeak selected character on/off */
  193. #define BRL_CMD_ASPK_SEL_CHAR (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_ASPK_SEL_CHAR)
  194. /** set autospeak inserted characters on/off */
  195. #define BRL_CMD_ASPK_INS_CHARS (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_ASPK_INS_CHARS)
  196. /** set autospeak deleted characters on/off */
  197. #define BRL_CMD_ASPK_DEL_CHARS (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_ASPK_DEL_CHARS)
  198. /** set autospeak replaced characters on/off */
  199. #define BRL_CMD_ASPK_REP_CHARS (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_ASPK_REP_CHARS)
  200. /** set autospeak completed words on/off */
  201. #define BRL_CMD_ASPK_CMP_WORDS (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_ASPK_CMP_WORDS)
  202. /** speak current character */
  203. #define BRL_CMD_SPEAK_CURR_CHAR (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPEAK_CURR_CHAR)
  204. /** go to and speak previous character */
  205. #define BRL_CMD_SPEAK_PREV_CHAR (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPEAK_PREV_CHAR)
  206. /** go to and speak next character */
  207. #define BRL_CMD_SPEAK_NEXT_CHAR (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPEAK_NEXT_CHAR)
  208. /** speak current word */
  209. #define BRL_CMD_SPEAK_CURR_WORD (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPEAK_CURR_WORD)
  210. /** go to and speak previous word */
  211. #define BRL_CMD_SPEAK_PREV_WORD (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPEAK_PREV_WORD)
  212. /** go to and speak next word */
  213. #define BRL_CMD_SPEAK_NEXT_WORD (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPEAK_NEXT_WORD)
  214. /** speak current line */
  215. #define BRL_CMD_SPEAK_CURR_LINE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPEAK_CURR_LINE)
  216. /** go to and speak previous line */
  217. #define BRL_CMD_SPEAK_PREV_LINE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPEAK_PREV_LINE)
  218. /** go to and speak next line */
  219. #define BRL_CMD_SPEAK_NEXT_LINE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPEAK_NEXT_LINE)
  220. /** go to and speak first non-blank character on line */
  221. #define BRL_CMD_SPEAK_FRST_CHAR (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPEAK_FRST_CHAR)
  222. /** go to and speak last non-blank character on line */
  223. #define BRL_CMD_SPEAK_LAST_CHAR (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPEAK_LAST_CHAR)
  224. /** go to and speak first non-blank line on screen */
  225. #define BRL_CMD_SPEAK_FRST_LINE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPEAK_FRST_LINE)
  226. /** go to and speak last non-blank line on screen */
  227. #define BRL_CMD_SPEAK_LAST_LINE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPEAK_LAST_LINE)
  228. /** describe current character */
  229. #define BRL_CMD_DESC_CURR_CHAR (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_DESC_CURR_CHAR)
  230. /** spell current word */
  231. #define BRL_CMD_SPELL_CURR_WORD (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPELL_CURR_WORD)
  232. /** bring screen cursor to speech cursor */
  233. #define BRL_CMD_ROUTE_CURR_LOCN (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_ROUTE_CURR_LOCN)
  234. /** speak speech cursor location */
  235. #define BRL_CMD_SPEAK_CURR_LOCN (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPEAK_CURR_LOCN)
  236. /** set speech cursor visibility on/off */
  237. #define BRL_CMD_SHOW_CURR_LOCN (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SHOW_CURR_LOCN)
  238. /** save clipboard to disk */
  239. #define BRL_CMD_CLIP_SAVE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CLIP_SAVE)
  240. /** restore clipboard from disk */
  241. #define BRL_CMD_CLIP_RESTORE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CLIP_RESTORE)
  242. /** set braille typing mode dots/text */
  243. #define BRL_CMD_BRLUCDOTS (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_BRLUCDOTS)
  244. /** set braille keyboard enabled/disabled */
  245. #define BRL_CMD_BRLKBD (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_BRLKBD)
  246. /** clear all sticky input modifiers */
  247. #define BRL_CMD_UNSTICK (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_UNSTICK)
  248. /** cycle the AltGr (Right Alt) sticky input modifier (next, on, off) */
  249. #define BRL_CMD_ALTGR (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_ALTGR)
  250. /** cycle the GUI (Windows) sticky input modifier (next, on, off) */
  251. #define BRL_CMD_GUI (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_GUI)
  252. /** stop the braille driver */
  253. #define BRL_CMD_BRL_STOP (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_BRL_STOP)
  254. /** start the braille driver */
  255. #define BRL_CMD_BRL_START (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_BRL_START)
  256. /** stop the speech driver */
  257. #define BRL_CMD_SPK_STOP (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPK_STOP)
  258. /** start the speech driver */
  259. #define BRL_CMD_SPK_START (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPK_START)
  260. /** stop the screen driver */
  261. #define BRL_CMD_SCR_STOP (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SCR_STOP)
  262. /** start the screen driver */
  263. #define BRL_CMD_SCR_START (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SCR_START)
  264. /** bind to the previous virtual terminal */
  265. #define BRL_CMD_SELECTVT_PREV (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SELECTVT_PREV)
  266. /** bind to the next virtual terminal */
  267. #define BRL_CMD_SELECTVT_NEXT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SELECTVT_NEXT)
  268. /** go backward to nearest non-blank braille window */
  269. #define BRL_CMD_PRNBWIN (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_PRNBWIN)
  270. /** go forward to nearest non-blank braille window */
  271. #define BRL_CMD_NXNBWIN (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_NXNBWIN)
  272. /** set touch navigation on/off */
  273. #define BRL_CMD_TOUCH_NAV (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_TOUCH_NAV)
  274. /** speak indent of current line */
  275. #define BRL_CMD_SPEAK_INDENT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SPEAK_INDENT)
  276. /** set autospeak indent of current line on/off */
  277. #define BRL_CMD_ASPK_INDENT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_ASPK_INDENT)
  278. /** refresh braille display */
  279. #define BRL_CMD_REFRESH (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_REFRESH)
  280. /** bring screen cursor to character */
  281. #define BRL_BLK_ROUTE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_ROUTE)
  282. /** start new clipboard at character */
  283. #define BRL_BLK_CLIP_NEW (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CLIP_NEW)
  284. /** deprecated definition of CLIP_NEW - start new clipboard at character */
  285. #define BRL_BLK_CUTBEGIN (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CUTBEGIN)
  286. /** append to clipboard from character */
  287. #define BRL_BLK_CLIP_ADD (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CLIP_ADD)
  288. /** deprecated definition of CLIP_ADD - append to clipboard from character */
  289. #define BRL_BLK_CUTAPPEND (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CUTAPPEND)
  290. /** rectangular copy to character */
  291. #define BRL_BLK_COPY_RECT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_COPY_RECT)
  292. /** deprecated definition of COPY_RECT - rectangular copy to character */
  293. #define BRL_BLK_CUTRECT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CUTRECT)
  294. /** linear copy to character */
  295. #define BRL_BLK_COPY_LINE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_COPY_LINE)
  296. /** deprecated definition of COPY_LINE - linear copy to character */
  297. #define BRL_BLK_CUTLINE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CUTLINE)
  298. /** switch to specific virtual terminal */
  299. #define BRL_BLK_SWITCHVT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SWITCHVT)
  300. /** go up to nearest line with less indent than character */
  301. #define BRL_BLK_PRINDENT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_PRINDENT)
  302. /** go down to nearest line with less indent than character */
  303. #define BRL_BLK_NXINDENT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_NXINDENT)
  304. /** describe character */
  305. #define BRL_BLK_DESCCHAR (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_DESCCHAR)
  306. /** place left end of braille window at character */
  307. #define BRL_BLK_SETLEFT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SETLEFT)
  308. /** remember current braille window position */
  309. #define BRL_BLK_SETMARK (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SETMARK)
  310. /** go to remembered braille window position */
  311. #define BRL_BLK_GOTOMARK (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_GOTOMARK)
  312. /** go to selected line */
  313. #define BRL_BLK_GOTOLINE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_GOTOLINE)
  314. /** go up to nearest line with different character */
  315. #define BRL_BLK_PRDIFCHAR (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_PRDIFCHAR)
  316. /** go down to nearest line with different character */
  317. #define BRL_BLK_NXDIFCHAR (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_NXDIFCHAR)
  318. /** copy characters to clipboard */
  319. #define BRL_BLK_CLIP_COPY (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CLIP_COPY)
  320. /** deprecated definition of CLIP_COPY - copy characters to clipboard */
  321. #define BRL_BLK_COPYCHARS (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_COPYCHARS)
  322. /** append characters to clipboard */
  323. #define BRL_BLK_CLIP_APPEND (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CLIP_APPEND)
  324. /** deprecated definition of CLIP_APPEND - append characters to clipboard */
  325. #define BRL_BLK_APNDCHARS (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_APNDCHARS)
  326. /** insert clipboard history entry after screen cursor */
  327. #define BRL_BLK_PASTE_HISTORY (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_PASTE_HISTORY)
  328. /** set text table */
  329. #define BRL_BLK_SET_TEXT_TABLE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SET_TEXT_TABLE)
  330. /** set attributes table */
  331. #define BRL_BLK_SET_ATTRIBUTES_TABLE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SET_ATTRIBUTES_TABLE)
  332. /** set contraction table */
  333. #define BRL_BLK_SET_CONTRACTION_TABLE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SET_CONTRACTION_TABLE)
  334. /** set keyboard table */
  335. #define BRL_BLK_SET_KEYBOARD_TABLE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SET_KEYBOARD_TABLE)
  336. /** set language profile */
  337. #define BRL_BLK_SET_LANGUAGE_PROFILE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SET_LANGUAGE_PROFILE)
  338. /** bring screen cursor to line */
  339. #define BRL_BLK_ROUTE_LINE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_ROUTE_LINE)
  340. /** refresh braille line */
  341. #define BRL_BLK_REFRESH_LINE (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_REFRESH_LINE)
  342. /** bind to specific virtual terminal */
  343. #define BRL_BLK_SELECTVT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_SELECTVT)
  344. /** render an alert */
  345. #define BRL_BLK_ALERT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_ALERT)
  346. /** type unicode character */
  347. #define BRL_KEY_PASSCHAR (BRLAPI_KEY_TYPE_SYM | 0X0000)
  348. /** type braille dots */
  349. #define BRL_BLK_PASSDOTS (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_PASSDOTS)
  350. /** AT (set 2) keyboard scan code */
  351. #define BRL_BLK_PASSAT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_PASSAT)
  352. /** XT (set 1) keyboard scan code */
  353. #define BRL_BLK_PASSXT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_PASSXT)
  354. /** PS/2 (set 3) keyboard scan code */
  355. #define BRL_BLK_PASSPS2 (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_PASSPS2)
  356. /** switch to command context */
  357. #define BRL_BLK_CONTEXT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_CONTEXT)
  358. /** current reading location */
  359. #define BRL_BLK_TOUCH_AT (BRLAPI_KEY_TYPE_CMD | BRLAPI_KEY_CMD_TOUCH_AT)
  360. /** enter key */
  361. #define BRL_KEY_ENTER (BRLAPI_KEY_SYM_LINEFEED & 0XFF)
  362. /** tab key */
  363. #define BRL_KEY_TAB (BRLAPI_KEY_SYM_TAB & 0XFF)
  364. /** backspace key */
  365. #define BRL_KEY_BACKSPACE (BRLAPI_KEY_SYM_BACKSPACE & 0XFF)
  366. /** escape key */
  367. #define BRL_KEY_ESCAPE (BRLAPI_KEY_SYM_ESCAPE & 0XFF)
  368. /** cursor-left key */
  369. #define BRL_KEY_CURSOR_LEFT (BRLAPI_KEY_SYM_LEFT & 0XFF)
  370. /** cursor-right key */
  371. #define BRL_KEY_CURSOR_RIGHT (BRLAPI_KEY_SYM_RIGHT & 0XFF)
  372. /** cursor-up key */
  373. #define BRL_KEY_CURSOR_UP (BRLAPI_KEY_SYM_UP & 0XFF)
  374. /** cursor-down key */
  375. #define BRL_KEY_CURSOR_DOWN (BRLAPI_KEY_SYM_DOWN & 0XFF)
  376. /** page-up key */
  377. #define BRL_KEY_PAGE_UP (BRLAPI_KEY_SYM_PAGE_UP & 0XFF)
  378. /** page-down key */
  379. #define BRL_KEY_PAGE_DOWN (BRLAPI_KEY_SYM_PAGE_DOWN & 0XFF)
  380. /** home key */
  381. #define BRL_KEY_HOME (BRLAPI_KEY_SYM_HOME & 0XFF)
  382. /** end key */
  383. #define BRL_KEY_END (BRLAPI_KEY_SYM_END & 0XFF)
  384. /** insert key */
  385. #define BRL_KEY_INSERT (BRLAPI_KEY_SYM_INSERT & 0XFF)
  386. /** delete key */
  387. #define BRL_KEY_DELETE (BRLAPI_KEY_SYM_DELETE & 0XFF)
  388. /** function key */
  389. #define BRL_KEY_FUNCTION (BRLAPI_KEY_SYM_FUNCTION & 0XFF)
  390. /** enable feature */
  391. #define BRL_FLG_TOGGLE_ON BRLAPI_KEY_FLG_TOGGLE_ON
  392. /** disable feature */
  393. #define BRL_FLG_TOGGLE_OFF BRLAPI_KEY_FLG_TOGGLE_OFF
  394. /** mask for all toggle flags */
  395. #define BRL_FLG_TOGGLE_MASK BRLAPI_KEY_FLG_TOGGLE_MASK
  396. /** bring screen cursor into braille window after function */
  397. #define BRL_FLG_MOTION_ROUTE BRLAPI_KEY_FLG_MOTION_ROUTE
  398. /** scale arg=0X00-0XFF to screen height */
  399. #define BRL_FLG_MOTION_SCALED BRLAPI_KEY_FLG_MOTION_SCALED
  400. /** go to beginning of line */
  401. #define BRL_FLG_MOTION_TOLEFT BRLAPI_KEY_FLG_MOTION_TOLEFT
  402. /** shift key pressed */
  403. #define BRL_FLG_INPUT_SHIFT BRLAPI_KEY_FLG_INPUT_SHIFT
  404. /** convert to uppercase */
  405. #define BRL_FLG_INPUT_UPPER BRLAPI_KEY_FLG_INPUT_UPPER
  406. /** control key pressed */
  407. #define BRL_FLG_INPUT_CONTROL BRLAPI_KEY_FLG_INPUT_CONTROL
  408. /** meta (left alt) key pressed */
  409. #define BRL_FLG_INPUT_META BRLAPI_KEY_FLG_INPUT_META
  410. /** altgr (right alt) key pressed */
  411. #define BRL_FLG_INPUT_ALTGR BRLAPI_KEY_FLG_INPUT_ALTGR
  412. /** gui (windows) key pressed */
  413. #define BRL_FLG_INPUT_GUI BRLAPI_KEY_FLG_INPUT_GUI
  414. /** it is a release scan code */
  415. #define BRL_FLG_KBD_RELEASE BRLAPI_KEY_FLG_KBD_RELEASE
  416. /** it is an emulation 0 scan code */
  417. #define BRL_FLG_KBD_EMUL0 BRLAPI_KEY_FLG_KBD_EMUL0
  418. /** it is an emulation 1 scan code */
  419. #define BRL_FLG_KBD_EMUL1 BRLAPI_KEY_FLG_KBD_EMUL1
  420. /** upper-left dot of standard braille cell */
  421. #define BRL_DOT1 BRLAPI_DOT1
  422. /** middle-left dot of standard braille cell */
  423. #define BRL_DOT2 BRLAPI_DOT2
  424. /** lower-left dot of standard braille cell */
  425. #define BRL_DOT3 BRLAPI_DOT3
  426. /** upper-right dot of standard braille cell */
  427. #define BRL_DOT4 BRLAPI_DOT4
  428. /** middle-right dot of standard braille cell */
  429. #define BRL_DOT5 BRLAPI_DOT5
  430. /** lower-right dot of standard braille cell */
  431. #define BRL_DOT6 BRLAPI_DOT6
  432. /** lower-left dot of computer braille cell */
  433. #define BRL_DOT7 BRLAPI_DOT7
  434. /** lower-right dot of computer braille cell */
  435. #define BRL_DOT8 BRLAPI_DOT8
  436. /** chord (space bar on braille keyboard) */
  437. #define BRL_DOTC BRLAPI_DOTC
  438. /** mask for command type */
  439. #define BRL_MSK_BLK (BRLAPI_KEY_TYPE_MASK | BRLAPI_KEY_CMD_BLK_MASK)
  440. /** mask for command value/argument */
  441. #define BRL_MSK_ARG BRLAPI_KEY_CMD_ARG_MASK
  442. /** mask for command flags */
  443. #define BRL_MSK_FLG BRLAPI_KEY_FLAGS_MASK
  444. /** mask for command */
  445. #define BRL_MSK_CMD (BRL_MSK_BLK | BRL_MSK_ARG)
  446. #ifdef __cplusplus
  447. }
  448. #endif /* __cplusplus */
  449. #endif /* BRLAPI_INCLUDED_BRLDEFS */