brlapi_constants.h 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437
  1. /*
  2. * libbrlapi - A library providing access to braille terminals for applications.
  3. *
  4. * Copyright (C) 2002-2020 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.app/
  16. *
  17. * This software is maintained by Dave Mielke <dave@mielke.cc>.
  18. */
  19. #ifndef BRLAPI_INCLUDED_CONSTANTS
  20. #define BRLAPI_INCLUDED_CONSTANTS
  21. #ifdef __cplusplus
  22. extern "C" {
  23. #endif /* __cplusplus */
  24. /** \file
  25. */
  26. /** \ingroup brlapi_keycodes
  27. * @{ */
  28. /** do nothing */
  29. #define BRLAPI_KEY_CMD_NOOP (BRLAPI_KEY_CMD(0) + 0)
  30. /** go up one line */
  31. #define BRLAPI_KEY_CMD_LNUP (BRLAPI_KEY_CMD(0) + 1)
  32. /** go down one line */
  33. #define BRLAPI_KEY_CMD_LNDN (BRLAPI_KEY_CMD(0) + 2)
  34. /** go up several lines */
  35. #define BRLAPI_KEY_CMD_WINUP (BRLAPI_KEY_CMD(0) + 3)
  36. /** go down several lines */
  37. #define BRLAPI_KEY_CMD_WINDN (BRLAPI_KEY_CMD(0) + 4)
  38. /** go up to nearest line with different content */
  39. #define BRLAPI_KEY_CMD_PRDIFLN (BRLAPI_KEY_CMD(0) + 5)
  40. /** go down to nearest line with different content */
  41. #define BRLAPI_KEY_CMD_NXDIFLN (BRLAPI_KEY_CMD(0) + 6)
  42. /** go up to nearest line with different highlighting */
  43. #define BRLAPI_KEY_CMD_ATTRUP (BRLAPI_KEY_CMD(0) + 7)
  44. /** go down to nearest line with different highlighting */
  45. #define BRLAPI_KEY_CMD_ATTRDN (BRLAPI_KEY_CMD(0) + 8)
  46. /** go to top line */
  47. #define BRLAPI_KEY_CMD_TOP (BRLAPI_KEY_CMD(0) + 9)
  48. /** go to bottom line */
  49. #define BRLAPI_KEY_CMD_BOT (BRLAPI_KEY_CMD(0) + 10)
  50. /** go to beginning of top line */
  51. #define BRLAPI_KEY_CMD_TOP_LEFT (BRLAPI_KEY_CMD(0) + 11)
  52. /** go to beginning of bottom line */
  53. #define BRLAPI_KEY_CMD_BOT_LEFT (BRLAPI_KEY_CMD(0) + 12)
  54. /** go up to first line of paragraph */
  55. #define BRLAPI_KEY_CMD_PRPGRPH (BRLAPI_KEY_CMD(0) + 13)
  56. /** go down to first line of next paragraph */
  57. #define BRLAPI_KEY_CMD_NXPGRPH (BRLAPI_KEY_CMD(0) + 14)
  58. /** go up to previous command prompt */
  59. #define BRLAPI_KEY_CMD_PRPROMPT (BRLAPI_KEY_CMD(0) + 15)
  60. /** go down to next command prompt */
  61. #define BRLAPI_KEY_CMD_NXPROMPT (BRLAPI_KEY_CMD(0) + 16)
  62. /** search backward for clipboard text */
  63. #define BRLAPI_KEY_CMD_PRSEARCH (BRLAPI_KEY_CMD(0) + 17)
  64. /** search forward for clipboard text */
  65. #define BRLAPI_KEY_CMD_NXSEARCH (BRLAPI_KEY_CMD(0) + 18)
  66. /** go left one character */
  67. #define BRLAPI_KEY_CMD_CHRLT (BRLAPI_KEY_CMD(0) + 19)
  68. /** go right one character */
  69. #define BRLAPI_KEY_CMD_CHRRT (BRLAPI_KEY_CMD(0) + 20)
  70. /** go left half a braille window */
  71. #define BRLAPI_KEY_CMD_HWINLT (BRLAPI_KEY_CMD(0) + 21)
  72. /** go right half a braille window */
  73. #define BRLAPI_KEY_CMD_HWINRT (BRLAPI_KEY_CMD(0) + 22)
  74. /** go backward one braille window */
  75. #define BRLAPI_KEY_CMD_FWINLT (BRLAPI_KEY_CMD(0) + 23)
  76. /** go forward one braille window */
  77. #define BRLAPI_KEY_CMD_FWINRT (BRLAPI_KEY_CMD(0) + 24)
  78. /** go backward skipping blank braille windows */
  79. #define BRLAPI_KEY_CMD_FWINLTSKIP (BRLAPI_KEY_CMD(0) + 25)
  80. /** go forward skipping blank braille windows */
  81. #define BRLAPI_KEY_CMD_FWINRTSKIP (BRLAPI_KEY_CMD(0) + 26)
  82. /** go to beginning of line */
  83. #define BRLAPI_KEY_CMD_LNBEG (BRLAPI_KEY_CMD(0) + 27)
  84. /** go to end of line */
  85. #define BRLAPI_KEY_CMD_LNEND (BRLAPI_KEY_CMD(0) + 28)
  86. /** go to screen cursor */
  87. #define BRLAPI_KEY_CMD_HOME (BRLAPI_KEY_CMD(0) + 29)
  88. /** go back after cursor tracking */
  89. #define BRLAPI_KEY_CMD_BACK (BRLAPI_KEY_CMD(0) + 30)
  90. /** go to screen cursor or go back after cursor tracking */
  91. #define BRLAPI_KEY_CMD_RETURN (BRLAPI_KEY_CMD(0) + 31)
  92. /** set screen image frozen/unfrozen */
  93. #define BRLAPI_KEY_CMD_FREEZE (BRLAPI_KEY_CMD(0) + 32)
  94. /** set display mode attributes/text */
  95. #define BRLAPI_KEY_CMD_DISPMD (BRLAPI_KEY_CMD(0) + 33)
  96. /** set text style 6-dot/8-dot */
  97. #define BRLAPI_KEY_CMD_SIXDOTS (BRLAPI_KEY_CMD(0) + 34)
  98. /** set sliding braille window on/off */
  99. #define BRLAPI_KEY_CMD_SLIDEWIN (BRLAPI_KEY_CMD(0) + 35)
  100. /** set skipping of lines with identical content on/off */
  101. #define BRLAPI_KEY_CMD_SKPIDLNS (BRLAPI_KEY_CMD(0) + 36)
  102. /** set skipping of blank braille windows on/off */
  103. #define BRLAPI_KEY_CMD_SKPBLNKWINS (BRLAPI_KEY_CMD(0) + 37)
  104. /** set screen cursor visibility on/off */
  105. #define BRLAPI_KEY_CMD_CSRVIS (BRLAPI_KEY_CMD(0) + 38)
  106. /** set hidden screen cursor on/off */
  107. #define BRLAPI_KEY_CMD_CSRHIDE (BRLAPI_KEY_CMD(0) + 39)
  108. /** set track screen cursor on/off */
  109. #define BRLAPI_KEY_CMD_CSRTRK (BRLAPI_KEY_CMD(0) + 40)
  110. /** set screen cursor style block/underline */
  111. #define BRLAPI_KEY_CMD_CSRSIZE (BRLAPI_KEY_CMD(0) + 41)
  112. /** set screen cursor blinking on/off */
  113. #define BRLAPI_KEY_CMD_CSRBLINK (BRLAPI_KEY_CMD(0) + 42)
  114. /** set attribute underlining on/off */
  115. #define BRLAPI_KEY_CMD_ATTRVIS (BRLAPI_KEY_CMD(0) + 43)
  116. /** set attribute blinking on/off */
  117. #define BRLAPI_KEY_CMD_ATTRBLINK (BRLAPI_KEY_CMD(0) + 44)
  118. /** set capital letter blinking on/off */
  119. #define BRLAPI_KEY_CMD_CAPBLINK (BRLAPI_KEY_CMD(0) + 45)
  120. /** set alert tunes on/off */
  121. #define BRLAPI_KEY_CMD_TUNES (BRLAPI_KEY_CMD(0) + 46)
  122. /** set autorepeat on/off */
  123. #define BRLAPI_KEY_CMD_AUTOREPEAT (BRLAPI_KEY_CMD(0) + 47)
  124. /** set autospeak on/off */
  125. #define BRLAPI_KEY_CMD_AUTOSPEAK (BRLAPI_KEY_CMD(0) + 48)
  126. /** enter/leave help display */
  127. #define BRLAPI_KEY_CMD_HELP (BRLAPI_KEY_CMD(0) + 49)
  128. /** enter/leave status display */
  129. #define BRLAPI_KEY_CMD_INFO (BRLAPI_KEY_CMD(0) + 50)
  130. /** enter/leave command learn mode */
  131. #define BRLAPI_KEY_CMD_LEARN (BRLAPI_KEY_CMD(0) + 51)
  132. /** enter/leave preferences menu */
  133. #define BRLAPI_KEY_CMD_PREFMENU (BRLAPI_KEY_CMD(0) + 52)
  134. /** save preferences to disk */
  135. #define BRLAPI_KEY_CMD_PREFSAVE (BRLAPI_KEY_CMD(0) + 53)
  136. /** restore preferences from disk */
  137. #define BRLAPI_KEY_CMD_PREFLOAD (BRLAPI_KEY_CMD(0) + 54)
  138. /** go up to first item */
  139. #define BRLAPI_KEY_CMD_MENU_FIRST_ITEM (BRLAPI_KEY_CMD(0) + 55)
  140. /** go down to last item */
  141. #define BRLAPI_KEY_CMD_MENU_LAST_ITEM (BRLAPI_KEY_CMD(0) + 56)
  142. /** go up to previous item */
  143. #define BRLAPI_KEY_CMD_MENU_PREV_ITEM (BRLAPI_KEY_CMD(0) + 57)
  144. /** go down to next item */
  145. #define BRLAPI_KEY_CMD_MENU_NEXT_ITEM (BRLAPI_KEY_CMD(0) + 58)
  146. /** select previous choice */
  147. #define BRLAPI_KEY_CMD_MENU_PREV_SETTING (BRLAPI_KEY_CMD(0) + 59)
  148. /** select next choice */
  149. #define BRLAPI_KEY_CMD_MENU_NEXT_SETTING (BRLAPI_KEY_CMD(0) + 60)
  150. /** stop speaking */
  151. #define BRLAPI_KEY_CMD_MUTE (BRLAPI_KEY_CMD(0) + 61)
  152. /** go to current speaking position */
  153. #define BRLAPI_KEY_CMD_SPKHOME (BRLAPI_KEY_CMD(0) + 62)
  154. /** speak current line */
  155. #define BRLAPI_KEY_CMD_SAY_LINE (BRLAPI_KEY_CMD(0) + 63)
  156. /** speak from top of screen through current line */
  157. #define BRLAPI_KEY_CMD_SAY_ABOVE (BRLAPI_KEY_CMD(0) + 64)
  158. /** speak from current line through bottom of screen */
  159. #define BRLAPI_KEY_CMD_SAY_BELOW (BRLAPI_KEY_CMD(0) + 65)
  160. /** decrease speaking rate */
  161. #define BRLAPI_KEY_CMD_SAY_SLOWER (BRLAPI_KEY_CMD(0) + 66)
  162. /** increase speaking rate */
  163. #define BRLAPI_KEY_CMD_SAY_FASTER (BRLAPI_KEY_CMD(0) + 67)
  164. /** decrease speaking volume */
  165. #define BRLAPI_KEY_CMD_SAY_SOFTER (BRLAPI_KEY_CMD(0) + 68)
  166. /** increase speaking volume */
  167. #define BRLAPI_KEY_CMD_SAY_LOUDER (BRLAPI_KEY_CMD(0) + 69)
  168. /** switch to the previous virtual terminal */
  169. #define BRLAPI_KEY_CMD_SWITCHVT_PREV (BRLAPI_KEY_CMD(0) + 70)
  170. /** switch to the next virtual terminal */
  171. #define BRLAPI_KEY_CMD_SWITCHVT_NEXT (BRLAPI_KEY_CMD(0) + 71)
  172. /** bring screen cursor to current line */
  173. #define BRLAPI_KEY_CMD_CSRJMP_VERT (BRLAPI_KEY_CMD(0) + 72)
  174. /** insert clipboard text after screen cursor */
  175. #define BRLAPI_KEY_CMD_PASTE (BRLAPI_KEY_CMD(0) + 73)
  176. /** restart braille driver */
  177. #define BRLAPI_KEY_CMD_RESTARTBRL (BRLAPI_KEY_CMD(0) + 74)
  178. /** restart speech driver */
  179. #define BRLAPI_KEY_CMD_RESTARTSPEECH (BRLAPI_KEY_CMD(0) + 75)
  180. /** braille display temporarily unavailable */
  181. #define BRLAPI_KEY_CMD_OFFLINE (BRLAPI_KEY_CMD(0) + 76)
  182. /** cycle the Shift sticky input modifier (next, on, off) */
  183. #define BRLAPI_KEY_CMD_SHIFT (BRLAPI_KEY_CMD(0) + 77)
  184. /** cycle the Upper sticky input modifier (next, on, off) */
  185. #define BRLAPI_KEY_CMD_UPPER (BRLAPI_KEY_CMD(0) + 78)
  186. /** cycle the Control sticky input modifier (next, on, off) */
  187. #define BRLAPI_KEY_CMD_CONTROL (BRLAPI_KEY_CMD(0) + 79)
  188. /** cycle the Meta (Left Alt) sticky input modifier (next, on, off) */
  189. #define BRLAPI_KEY_CMD_META (BRLAPI_KEY_CMD(0) + 80)
  190. /** show current date and time */
  191. #define BRLAPI_KEY_CMD_TIME (BRLAPI_KEY_CMD(0) + 81)
  192. /** go to previous menu level */
  193. #define BRLAPI_KEY_CMD_MENU_PREV_LEVEL (BRLAPI_KEY_CMD(0) + 82)
  194. /** set autospeak selected line on/off */
  195. #define BRLAPI_KEY_CMD_ASPK_SEL_LINE (BRLAPI_KEY_CMD(0) + 83)
  196. /** set autospeak selected character on/off */
  197. #define BRLAPI_KEY_CMD_ASPK_SEL_CHAR (BRLAPI_KEY_CMD(0) + 84)
  198. /** set autospeak inserted characters on/off */
  199. #define BRLAPI_KEY_CMD_ASPK_INS_CHARS (BRLAPI_KEY_CMD(0) + 85)
  200. /** set autospeak deleted characters on/off */
  201. #define BRLAPI_KEY_CMD_ASPK_DEL_CHARS (BRLAPI_KEY_CMD(0) + 86)
  202. /** set autospeak replaced characters on/off */
  203. #define BRLAPI_KEY_CMD_ASPK_REP_CHARS (BRLAPI_KEY_CMD(0) + 87)
  204. /** set autospeak completed words on/off */
  205. #define BRLAPI_KEY_CMD_ASPK_CMP_WORDS (BRLAPI_KEY_CMD(0) + 88)
  206. /** speak current character */
  207. #define BRLAPI_KEY_CMD_SPEAK_CURR_CHAR (BRLAPI_KEY_CMD(0) + 89)
  208. /** go to and speak previous character */
  209. #define BRLAPI_KEY_CMD_SPEAK_PREV_CHAR (BRLAPI_KEY_CMD(0) + 90)
  210. /** go to and speak next character */
  211. #define BRLAPI_KEY_CMD_SPEAK_NEXT_CHAR (BRLAPI_KEY_CMD(0) + 91)
  212. /** speak current word */
  213. #define BRLAPI_KEY_CMD_SPEAK_CURR_WORD (BRLAPI_KEY_CMD(0) + 92)
  214. /** go to and speak previous word */
  215. #define BRLAPI_KEY_CMD_SPEAK_PREV_WORD (BRLAPI_KEY_CMD(0) + 93)
  216. /** go to and speak next word */
  217. #define BRLAPI_KEY_CMD_SPEAK_NEXT_WORD (BRLAPI_KEY_CMD(0) + 94)
  218. /** speak current line */
  219. #define BRLAPI_KEY_CMD_SPEAK_CURR_LINE (BRLAPI_KEY_CMD(0) + 95)
  220. /** go to and speak previous line */
  221. #define BRLAPI_KEY_CMD_SPEAK_PREV_LINE (BRLAPI_KEY_CMD(0) + 96)
  222. /** go to and speak next line */
  223. #define BRLAPI_KEY_CMD_SPEAK_NEXT_LINE (BRLAPI_KEY_CMD(0) + 97)
  224. /** go to and speak first non-blank character on line */
  225. #define BRLAPI_KEY_CMD_SPEAK_FRST_CHAR (BRLAPI_KEY_CMD(0) + 98)
  226. /** go to and speak last non-blank character on line */
  227. #define BRLAPI_KEY_CMD_SPEAK_LAST_CHAR (BRLAPI_KEY_CMD(0) + 99)
  228. /** go to and speak first non-blank line on screen */
  229. #define BRLAPI_KEY_CMD_SPEAK_FRST_LINE (BRLAPI_KEY_CMD(0) + 100)
  230. /** go to and speak last non-blank line on screen */
  231. #define BRLAPI_KEY_CMD_SPEAK_LAST_LINE (BRLAPI_KEY_CMD(0) + 101)
  232. /** describe current character */
  233. #define BRLAPI_KEY_CMD_DESC_CURR_CHAR (BRLAPI_KEY_CMD(0) + 102)
  234. /** spell current word */
  235. #define BRLAPI_KEY_CMD_SPELL_CURR_WORD (BRLAPI_KEY_CMD(0) + 103)
  236. /** bring screen cursor to speech cursor */
  237. #define BRLAPI_KEY_CMD_ROUTE_CURR_LOCN (BRLAPI_KEY_CMD(0) + 104)
  238. /** speak speech cursor location */
  239. #define BRLAPI_KEY_CMD_SPEAK_CURR_LOCN (BRLAPI_KEY_CMD(0) + 105)
  240. /** set speech cursor visibility on/off */
  241. #define BRLAPI_KEY_CMD_SHOW_CURR_LOCN (BRLAPI_KEY_CMD(0) + 106)
  242. /** save clipboard to disk */
  243. #define BRLAPI_KEY_CMD_CLIP_SAVE (BRLAPI_KEY_CMD(0) + 107)
  244. /** restore clipboard from disk */
  245. #define BRLAPI_KEY_CMD_CLIP_RESTORE (BRLAPI_KEY_CMD(0) + 108)
  246. /** set braille typing mode dots/text */
  247. #define BRLAPI_KEY_CMD_BRLUCDOTS (BRLAPI_KEY_CMD(0) + 109)
  248. /** set braille keyboard enabled/disabled */
  249. #define BRLAPI_KEY_CMD_BRLKBD (BRLAPI_KEY_CMD(0) + 110)
  250. /** clear all sticky input modifiers */
  251. #define BRLAPI_KEY_CMD_UNSTICK (BRLAPI_KEY_CMD(0) + 111)
  252. /** cycle the AltGr (Right Alt) sticky input modifier (next, on, off) */
  253. #define BRLAPI_KEY_CMD_ALTGR (BRLAPI_KEY_CMD(0) + 112)
  254. /** cycle the GUI (Windows) sticky input modifier (next, on, off) */
  255. #define BRLAPI_KEY_CMD_GUI (BRLAPI_KEY_CMD(0) + 113)
  256. /** stop the braille driver */
  257. #define BRLAPI_KEY_CMD_BRL_STOP (BRLAPI_KEY_CMD(0) + 114)
  258. /** start the braille driver */
  259. #define BRLAPI_KEY_CMD_BRL_START (BRLAPI_KEY_CMD(0) + 115)
  260. /** stop the speech driver */
  261. #define BRLAPI_KEY_CMD_SPK_STOP (BRLAPI_KEY_CMD(0) + 116)
  262. /** start the speech driver */
  263. #define BRLAPI_KEY_CMD_SPK_START (BRLAPI_KEY_CMD(0) + 117)
  264. /** stop the screen driver */
  265. #define BRLAPI_KEY_CMD_SCR_STOP (BRLAPI_KEY_CMD(0) + 118)
  266. /** start the screen driver */
  267. #define BRLAPI_KEY_CMD_SCR_START (BRLAPI_KEY_CMD(0) + 119)
  268. /** bind to the previous virtual terminal */
  269. #define BRLAPI_KEY_CMD_SELECTVT_PREV (BRLAPI_KEY_CMD(0) + 120)
  270. /** bind to the next virtual terminal */
  271. #define BRLAPI_KEY_CMD_SELECTVT_NEXT (BRLAPI_KEY_CMD(0) + 121)
  272. /** go backward to nearest non-blank braille window */
  273. #define BRLAPI_KEY_CMD_PRNBWIN (BRLAPI_KEY_CMD(0) + 122)
  274. /** go forward to nearest non-blank braille window */
  275. #define BRLAPI_KEY_CMD_NXNBWIN (BRLAPI_KEY_CMD(0) + 123)
  276. /** set touch navigation on/off */
  277. #define BRLAPI_KEY_CMD_TOUCH_NAV (BRLAPI_KEY_CMD(0) + 124)
  278. /** speak indent of current line */
  279. #define BRLAPI_KEY_CMD_SPEAK_INDENT (BRLAPI_KEY_CMD(0) + 125)
  280. /** set autospeak indent of current line on/off */
  281. #define BRLAPI_KEY_CMD_ASPK_INDENT (BRLAPI_KEY_CMD(0) + 126)
  282. /** refresh braille display */
  283. #define BRLAPI_KEY_CMD_REFRESH (BRLAPI_KEY_CMD(0) + 127)
  284. /** bring screen cursor to character */
  285. #define BRLAPI_KEY_CMD_ROUTE BRLAPI_KEY_CMD(1)
  286. /** start new clipboard at character */
  287. #define BRLAPI_KEY_CMD_CLIP_NEW BRLAPI_KEY_CMD(2)
  288. /** deprecated definition of CLIP_NEW - start new clipboard at character */
  289. #define BRLAPI_KEY_CMD_CUTBEGIN BRLAPI_KEY_CMD(2)
  290. /** append to clipboard from character */
  291. #define BRLAPI_KEY_CMD_CLIP_ADD BRLAPI_KEY_CMD(3)
  292. /** deprecated definition of CLIP_ADD - append to clipboard from character */
  293. #define BRLAPI_KEY_CMD_CUTAPPEND BRLAPI_KEY_CMD(3)
  294. /** rectangular copy to character */
  295. #define BRLAPI_KEY_CMD_COPY_RECT BRLAPI_KEY_CMD(4)
  296. /** deprecated definition of COPY_RECT - rectangular copy to character */
  297. #define BRLAPI_KEY_CMD_CUTRECT BRLAPI_KEY_CMD(4)
  298. /** linear copy to character */
  299. #define BRLAPI_KEY_CMD_COPY_LINE BRLAPI_KEY_CMD(5)
  300. /** deprecated definition of COPY_LINE - linear copy to character */
  301. #define BRLAPI_KEY_CMD_CUTLINE BRLAPI_KEY_CMD(5)
  302. /** switch to specific virtual terminal */
  303. #define BRLAPI_KEY_CMD_SWITCHVT BRLAPI_KEY_CMD(6)
  304. /** go up to nearest line with less indent than character */
  305. #define BRLAPI_KEY_CMD_PRINDENT BRLAPI_KEY_CMD(7)
  306. /** go down to nearest line with less indent than character */
  307. #define BRLAPI_KEY_CMD_NXINDENT BRLAPI_KEY_CMD(8)
  308. /** describe character */
  309. #define BRLAPI_KEY_CMD_DESCCHAR BRLAPI_KEY_CMD(9)
  310. /** place left end of braille window at character */
  311. #define BRLAPI_KEY_CMD_SETLEFT BRLAPI_KEY_CMD(10)
  312. /** remember current braille window position */
  313. #define BRLAPI_KEY_CMD_SETMARK BRLAPI_KEY_CMD(11)
  314. /** go to remembered braille window position */
  315. #define BRLAPI_KEY_CMD_GOTOMARK BRLAPI_KEY_CMD(12)
  316. /** go to selected line */
  317. #define BRLAPI_KEY_CMD_GOTOLINE BRLAPI_KEY_CMD(13)
  318. /** go up to nearest line with different character */
  319. #define BRLAPI_KEY_CMD_PRDIFCHAR BRLAPI_KEY_CMD(14)
  320. /** go down to nearest line with different character */
  321. #define BRLAPI_KEY_CMD_NXDIFCHAR BRLAPI_KEY_CMD(15)
  322. /** copy characters to clipboard */
  323. #define BRLAPI_KEY_CMD_CLIP_COPY BRLAPI_KEY_CMD(16)
  324. /** deprecated definition of CLIP_COPY - copy characters to clipboard */
  325. #define BRLAPI_KEY_CMD_COPYCHARS BRLAPI_KEY_CMD(16)
  326. /** append characters to clipboard */
  327. #define BRLAPI_KEY_CMD_CLIP_APPEND BRLAPI_KEY_CMD(17)
  328. /** deprecated definition of CLIP_APPEND - append characters to clipboard */
  329. #define BRLAPI_KEY_CMD_APNDCHARS BRLAPI_KEY_CMD(17)
  330. /** insert clipboard history entry after screen cursor */
  331. #define BRLAPI_KEY_CMD_PASTE_HISTORY BRLAPI_KEY_CMD(18)
  332. /** set text table */
  333. #define BRLAPI_KEY_CMD_SET_TEXT_TABLE BRLAPI_KEY_CMD(19)
  334. /** set attributes table */
  335. #define BRLAPI_KEY_CMD_SET_ATTRIBUTES_TABLE BRLAPI_KEY_CMD(20)
  336. /** set contraction table */
  337. #define BRLAPI_KEY_CMD_SET_CONTRACTION_TABLE BRLAPI_KEY_CMD(21)
  338. /** set keyboard table */
  339. #define BRLAPI_KEY_CMD_SET_KEYBOARD_TABLE BRLAPI_KEY_CMD(22)
  340. /** set language profile */
  341. #define BRLAPI_KEY_CMD_SET_LANGUAGE_PROFILE BRLAPI_KEY_CMD(23)
  342. /** bring screen cursor to line */
  343. #define BRLAPI_KEY_CMD_ROUTE_LINE BRLAPI_KEY_CMD(24)
  344. /** refresh braille line */
  345. #define BRLAPI_KEY_CMD_REFRESH_LINE BRLAPI_KEY_CMD(25)
  346. /** bind to specific virtual terminal */
  347. #define BRLAPI_KEY_CMD_SELECTVT BRLAPI_KEY_CMD(30)
  348. /** render an alert */
  349. #define BRLAPI_KEY_CMD_ALERT BRLAPI_KEY_CMD(31)
  350. /** type braille dots */
  351. #define BRLAPI_KEY_CMD_PASSDOTS BRLAPI_KEY_CMD(34)
  352. /** AT (set 2) keyboard scan code */
  353. #define BRLAPI_KEY_CMD_PASSAT BRLAPI_KEY_CMD(35)
  354. /** XT (set 1) keyboard scan code */
  355. #define BRLAPI_KEY_CMD_PASSXT BRLAPI_KEY_CMD(36)
  356. /** PS/2 (set 3) keyboard scan code */
  357. #define BRLAPI_KEY_CMD_PASSPS2 BRLAPI_KEY_CMD(37)
  358. /** switch to command context */
  359. #define BRLAPI_KEY_CMD_CONTEXT BRLAPI_KEY_CMD(38)
  360. /** current reading location */
  361. #define BRLAPI_KEY_CMD_TOUCH_AT BRLAPI_KEY_CMD(39)
  362. /** enable feature */
  363. #define BRLAPI_KEY_FLG_TOGGLE_ON BRLAPI_KEY_FLG(0X0100)
  364. /** disable feature */
  365. #define BRLAPI_KEY_FLG_TOGGLE_OFF BRLAPI_KEY_FLG(0X0200)
  366. /** mask for all toggle flags */
  367. #define BRLAPI_KEY_FLG_TOGGLE_MASK (BRLAPI_KEY_FLG_TOGGLE_ON | BRLAPI_KEY_FLG_TOGGLE_OFF)
  368. /** bring screen cursor into braille window after function */
  369. #define BRLAPI_KEY_FLG_MOTION_ROUTE BRLAPI_KEY_FLG(0X0400)
  370. /** scale arg=0X00-0XFF to screen height */
  371. #define BRLAPI_KEY_FLG_MOTION_SCALED BRLAPI_KEY_FLG(0X0800)
  372. /** go to beginning of line */
  373. #define BRLAPI_KEY_FLG_MOTION_TOLEFT BRLAPI_KEY_FLG(0X1000)
  374. /** shift key pressed */
  375. #define BRLAPI_KEY_FLG_SHIFT BRLAPI_KEY_FLG(0X01)
  376. /** convert to uppercase */
  377. #define BRLAPI_KEY_FLG_UPPER BRLAPI_KEY_FLG(0X02)
  378. /** control key pressed */
  379. #define BRLAPI_KEY_FLG_CONTROL BRLAPI_KEY_FLG(0X04)
  380. /** meta (left alt) key pressed */
  381. #define BRLAPI_KEY_FLG_META BRLAPI_KEY_FLG(0X08)
  382. /** altgr (right alt) key pressed */
  383. #define BRLAPI_KEY_FLG_ALTGR BRLAPI_KEY_FLG(0X10)
  384. /** gui (windows) key pressed */
  385. #define BRLAPI_KEY_FLG_GUI BRLAPI_KEY_FLG(0X20)
  386. /** it is a release scan code */
  387. #define BRLAPI_KEY_FLG_KBD_RELEASE BRLAPI_KEY_FLG(0X0100)
  388. /** it is an emulation 0 scan code */
  389. #define BRLAPI_KEY_FLG_KBD_EMUL0 BRLAPI_KEY_FLG(0X0200)
  390. /** it is an emulation 1 scan code */
  391. #define BRLAPI_KEY_FLG_KBD_EMUL1 BRLAPI_KEY_FLG(0X0400)
  392. /** upper-left dot of standard braille cell */
  393. #define BRLAPI_DOT1 1
  394. /** middle-left dot of standard braille cell */
  395. #define BRLAPI_DOT2 2
  396. /** lower-left dot of standard braille cell */
  397. #define BRLAPI_DOT3 4
  398. /** upper-right dot of standard braille cell */
  399. #define BRLAPI_DOT4 8
  400. /** middle-right dot of standard braille cell */
  401. #define BRLAPI_DOT5 16
  402. /** lower-right dot of standard braille cell */
  403. #define BRLAPI_DOT6 32
  404. /** lower-left dot of computer braille cell */
  405. #define BRLAPI_DOT7 64
  406. /** lower-right dot of computer braille cell */
  407. #define BRLAPI_DOT8 128
  408. /** chord (space bar on braille keyboard) */
  409. #define BRLAPI_DOTC 256
  410. /** Helper macro to easily produce braille patterns */
  411. #define BRLAPI_DOTS(dot1, dot2, dot3, dot4, dot5, dot6, dot7, dot8) (\
  412. ((dot1)? BRLAPI_DOT1: 0) | \
  413. ((dot2)? BRLAPI_DOT2: 0) | \
  414. ((dot3)? BRLAPI_DOT3: 0) | \
  415. ((dot4)? BRLAPI_DOT4: 0) | \
  416. ((dot5)? BRLAPI_DOT5: 0) | \
  417. ((dot6)? BRLAPI_DOT6: 0) | \
  418. ((dot7)? BRLAPI_DOT7: 0) | \
  419. ((dot8)? BRLAPI_DOT8: 0) \
  420. )
  421. /** space key */
  422. #define BRLAPI_DOT_CHORD 256
  423. /** @} */
  424. #ifdef __cplusplus
  425. }
  426. #endif /* __cplusplus */
  427. #endif /* BRLAPI_INCLUDED_CONSTANTS */