brlapi_keycodes - Types and Defines for\e BrlAPI Key Codes

Generated automatically by Doxygen for BrlAPI from the source code. BrlAPI Version 0.8 brlapi_keycodes(3)

Key codes are unsigned 64 bit integers. This 64-bit space is split into 3 parts: • bits 63-32 (BRLAPI_KEY_FLAGS_MASK), flags: bits 39-32 are standard X modifiers (shift, control, meta, ...). Other flags are used for some commands, see documentation of BRLAPI_KEY_FLG_* for their respective uses. • bits 31-29 (BRLAPI_KEY_TYPE_MASK), key type: either BRLAPI_KEY_TYPE_CMD for braille commands, or BRLAPI_KEY_TYPE_SYM for standard X keysyms. • bits 28-0 (BRLAPI_KEY_CODE_MASK), key code: for braille commands, see BRLAPI_KEY_CMD_* ; for standard X keysyms, this is the keysym value, see X11 documentation, a complete list is probably available on your system in /usr/include/X11/keysymdef.h The second and third part are thus mandatory to tell the type of keycode and the value of the keycode, and the first part contains optional flags. The third part is itself split into two parts: a command number and a command value. The relative sizes of these parts vary according to the key type. For a braille command, bits 28-16 (BRLAPI_KEY_CMD_BLK_MASK) hold the braille command number, while bits 15-0 (BRLAPI_KEY_CMD_ARG_MASK) hold the command value. The brlapi_expandKeyCode() function may be used for splitting key codes into these parts. For a X keysym, if it is a unicode keysym (0x1uvwxyz), then the command number part is 0x1000000 and the value part is 0xuvwxyz. Else, the command part is held by bits 28-8 and the value part is held by bits 7-0. This permits to easily handle usual cases like 0x00xy (latin1), 0x01xy (latin2), XK_Backspace (0xff08, backspace), XK_Tab (0xff09, tab), ... For instance, if key == 0x0000000020010008, • (key & BRLAPI_KEY_TYPE_MASK) == BRLAPI_KEY_TYPE_CMD, so it's a braille command • (key & BRLAPI_KEY_CMD_BLK_MASK) == BRLAPI_KEY_CMD_ROUTE, so it's the braille route command. • (key & BRLAPI_KEY_CMD_ARG_MASK) == 8, so the highlighted cell is the 9th one (cells are numbered from 0) • (key & BRLAPI_KEY_FLAGS_MASK) == 0, so no modifier key was pressed during the command, and no particular flag applies to the command. if key == 0x000000010000FF09, • (key & BRLAPI_KEY_TYPE_MASK) == BRLAPI_KEY_TYPE_SYM, so it's a keysym • (key & BRLAPI_KEY_CODE_MASK) == XK_Tab, so it's the tab key. BRLAPI_KEY_SYM_TAB can also be used here, as well as a few other BRLAPI_KEY_SYM_* constants which are provided to avoid having to include X11/keysymdef.h • (key & BRLAPI_KEY_FLAGS_MASK) == BRLAPI_KEY_FLG_SHIFT, so the shift modifier was pressed during the command. in the X11 standard some keysyms are directly unicode, for instance if key == 0x0000000001001EA0, • (key & BRLAPI_KEY_TYPE_MASK) == BRLAPI_KEY_TYPE_SYM, so it's a keysym • (key & BRLAPI_KEY_SYM_UNICODE) != 0 so it's a unicode keysym, whose value is key & (BRLAPI_KEY_SYM_UNICODE-1). Of course, one can also consider (key & BRLAPI_KEY_CODE_MASK) == XK_Abelowdot • (key & BRLAPI_KEY_FLAGS_MASK) == 0, so no modifier key was pressed during the command, and no particular flag applies to the command. brlapi_ignoreKeyRanges() and brlapi_acceptKeyRanges() manipulate keycode ranges. They are composed of 2 keycodes: the 'first' and the 'last' boundaries. The range expressed by these two keycodes is the set of keycodes whose lower part (bits 31-0) is between the lower part of the 'first' keycode and the 'last' keycode (inclusive), and whose high part (bits 63-32), the flags, contains at least the flags of the 'first' keycode, and at most the flags of the 'last' keycode. Setting the 'first' and 'last' keycode to the same value express only one keycode, for instance. Setting the first and last keycode to the same command code but setting no flags in the 'first' keycode and setting one flag in the 'last' keycode expresses only two keycode, with the same lower part and no flags set except possibly the flag that is set in the 'last' keycode. Setting one flag i in the 'first' keycode and setting the same flag plus another flag j in the 'last' keycode expresses that the keycodes in the range have flag i set and possibly flag j set, but no other flag.

#defineBRLAPI_DOT11 upper-left dot of standard braille cell #defineBRLAPI_DOT22 middle-left dot of standard braille cell #defineBRLAPI_DOT34 lower-left dot of standard braille cell #defineBRLAPI_DOT48 upper-right dot of standard braille cell #defineBRLAPI_DOT516 middle-right dot of standard braille cell #defineBRLAPI_DOT632 lower-right dot of standard braille cell #defineBRLAPI_DOT764 lower-left dot of computer braille cell #defineBRLAPI_DOT8128 lower-right dot of computer braille cell #defineBRLAPI_DOT_CHORD256 space key #defineBRLAPI_DOTC256 chord (space bar on braille keyboard) #defineBRLAPI_DOTS(dot1,dot2,dot3,dot4,dot5,dot6,dot7,dot8)Value:.PP (\ ((dot1)? BRLAPI_DOT1: 0) | \ ((dot2)? BRLAPI_DOT2: 0) | \ ((dot3)? BRLAPI_DOT3: 0) | \ ((dot4)? BRLAPI_DOT4: 0) | \ ((dot5)? BRLAPI_DOT5: 0) | \ ((dot6)? BRLAPI_DOT6: 0) | \ ((dot7)? BRLAPI_DOT7: 0) | \ ((dot8)? BRLAPI_DOT8: 0) \ ) Helper macro to easily produce braille patterns #defineBRLAPI_DRV_KEY_GROUP(code)(((code)&BRLAPI_DRV_KEY_GROUP_MASK)>>BRLAPI_DRV_KEY_GROUP_SHIFT) Get key group of brlapi_keyCode_t #defineBRLAPI_DRV_KEY_GROUP_MASK0XFF00 Mask for key group of brlapi_keyCode_t #defineBRLAPI_DRV_KEY_GROUP_SHIFT8 Shift for key group of brlapi_keyCode_t #defineBRLAPI_DRV_KEY_NUMBER(code)(((code)&BRLAPI_DRV_KEY_NUMBER_MASK)>>BRLAPI_DRV_KEY_NUMBER_SHIFT) Get key number of brlapi_keyCode_t #defineBRLAPI_DRV_KEY_NUMBER_ANY0XFF Key number representing any key in the group #defineBRLAPI_DRV_KEY_NUMBER_MASK0XFF Mask for key number of brlapi_keyCode_t #defineBRLAPI_DRV_KEY_NUMBER_SHIFT0 Shift for key number of brlapi_keyCode_t #defineBRLAPI_DRV_KEY_PRESSBRLAPI_KEYCODE_C(0X8000000000000000) When brlapi_enterTtyMode() or brlapi_entg$erTtyModeWithPath() is called with a driver name, brlapi_readKey() and brlapi_readKeyWithTimeout() will return driver-specific key codes. From most- to least-significant, their eight bytes are: F 0 0 0 0 0 G N. F is a byte that contains flag bits which are common for all drivers. BRLAPI_DRV_KEY_PRESS, which indicates that it's a key press (as opposed to a release) event, is the only currently defined flag. The other flag bits are always 0. G is the key's group, and N is the key's number within that group. Flag for a driver-specific keycode press (not set means a release) #defineBRLAPI_DRV_KEY_VALUE_MASK(BRLAPI_DRV_KEY_GROUP_MASK|BRLAPI_DRV_KEY_NUMBER_MASK) Mask for key value (group and number) of brlapi_keyCode_t #defineBRLAPI_KEY_CMD(v)((v)<<BRLAPI_KEY_CMD_BLK_SHIFT)#defineBRLAPI_KEY_CMD_ALERTBRLAPI_KEY_CMD(31) render an alert #defineBRLAPI_KEY_CMD_ALTGR(BRLAPI_KEY_CMD(0)+112) cycle the AltGr (Right Alt) sticky input modifier (next, on, off) #defineBRLAPI_KEY_CMD_APNDCHARSBRLAPI_KEY_CMD(17) deprecated definition of CLIP_APPEND - append characters to clipboard #defineBRLAPI_KEY_CMD_ARG_MASKUINT64_C(0X0000FFFF) Mask for braille command value #defineBRLAPI_KEY_CMD_ARG_SHIFT0 Shift for braille command value #defineBRLAPI_KEY_CMD_ASPK_CMP_WORDS(BRLAPI_KEY_CMD(0)+88) set autospeak completed words on/off #defineBRLAPI_KEY_CMD_ASPK_DEL_CHARS(BRLAPI_KEY_CMD(0)+86) set autospeak deleted characters on/off #defineBRLAPI_KEY_CMD_ASPK_EMP_LINE(BRLAPI_KEY_CMD(0)+156) set autospeak empty line on/off #defineBRLAPI_KEY_CMD_ASPK_INDENT(BRLAPI_KEY_CMD(0)+126) set autospeak indent of current line on/off #defineBRLAPI_KEY_CMD_ASPK_INS_CHARS(BRLAPI_KEY_CMD(0)+85) set autospeak inserted characters on/off #defineBRLAPI_KEY_CMD_ASPK_REP_CHARS(BRLAPI_KEY_CMD(0)+87) set autospeak replaced characters on/off #defineBRLAPI_KEY_CMD_ASPK_SEL_CHAR(BRLAPI_KEY_CMD(0)+84) set autospeak selected character on/off #defineBRLAPI_KEY_CMD_ASPK_SEL_LINE(BRLAPI_KEY_CMD(0)+83) set autospeak selected line on/off #defineBRLAPI_KEY_CMD_ATTRBLINK(BRLAPI_KEY_CMD(0)+44) set attribute blinking on/off #defineBRLAPI_KEY_CMD_ATTRDN(BRLAPI_KEY_CMD(0)+8) go down to nearest line with different highlighting #defineBRLAPI_KEY_CMD_ATTRUP(BRLAPI_KEY_CMD(0)+7) go up to nearest line with different highlighting #defineBRLAPI_KEY_CMD_ATTRVIS(BRLAPI_KEY_CMD(0)+43) set attribute underlining on/off #defineBRLAPI_KEY_CMD_AUTOREPEAT(BRLAPI_KEY_CMD(0)+47) set autorepeat on/off #defineBRLAPI_KEY_CMD_AUTOSPEAK(BRLAPI_KEY_CMD(0)+48) set autospeak on/off #defineBRLAPI_KEY_CMD_BACK(BRLAPI_KEY_CMD(0)+30) go back after cursor tracking #defineBRLAPI_KEY_CMD_BLK_MASKUINT64_C(0X1FFF0000) Mask for braille command type #defineBRLAPI_KEY_CMD_BLK_SHIFT16 Shift for braille command type #defineBRLAPI_KEY_CMD_BOT(BRLAPI_KEY_CMD(0)+10) go to bottom line #defineBRLAPI_KEY_CMD_BOT_LEFT(BRLAPI_KEY_CMD(0)+12) go to beginning of bottom line #defineBRLAPI_KEY_CMD_BRL_START(BRLAPI_KEY_CMD(0)+115) start the braille driver #defineBRLAPI_KEY_CMD_BRL_STOP(BRLAPI_KEY_CMD(0)+114) stop the braille driver #defineBRLAPI_KEY_CMD_BRLKBD(BRLAPI_KEY_CMD(0)+110) set braille keyboard enabled/disabled #defineBRLAPI_KEY_CMD_BRLUCDOTS(BRLAPI_KEY_CMD(0)+109) set braille typing mode dots/text #defineBRLAPI_KEY_CMD_CAPBLINK(BRLAPI_KEY_CMD(0)+45) set capital letter blinking on/off #defineBRLAPI_KEY_CMD_CHRLT(BRLAPI_KEY_CMD(0)+19) go left one character #defineBRLAPI_KEY_CMD_CHRRT(BRLAPI_KEY_CMD(0)+20) go right one character #defineBRLAPI_KEY_CMD_CLIP_ADDBRLAPI_KEY_CMD(3) append to clipboard from character #defineBRLAPI_KEY_CMD_CLIP_APPENDBRLAPI_KEY_CMD(17) append characters to clipboard #defineBRLAPI_KEY_CMD_CLIP_COPYBRLAPI_KEY_CMD(16) copy characters to clipboard #defineBRLAPI_KEY_CMD_CLIP_NEWBRLAPI_KEY_CMD(2) start new clipboard at character #defineBRLAPI_KEY_CMD_CLIP_RESTORE(BRLAPI_KEY_CMD(0)+108) restore clipboard from disk #defineBRLAPI_KEY_CMD_CLIP_SAVE(BRLAPI_KEY_CMD(0)+107) save clipboard to disk #defineBRLAPI_KEY_CMD_COMPBRL6(BRLAPI_KEY_CMD(0)+154) set six/eight dot computer braille #defineBRLAPI_KEY_CMD_CONTEXTBRLAPI_KEY_CMD(38) switch to command context #defineBRLAPI_KEY_CMD_CONTRACTED(BRLAPI_KEY_CMD(0)+153) set contracted/computer braille #defineBRLAPI_KEY_CMD_CONTROL(BRLAPI_KEY_CMD(0)+79) cycle the Control sticky input modifier (next, on, off) #defineBRLAPI_KEY_CMD_COPY_LINEBRLAPI_KEY_CMD(5) linear copy to character #defineBRLAPI_KEY_CMD_COPY_RECTBRLAPI_KEY_CMD(4) rectangular copy to character #defineBRLAPI_KEY_CMD_COPYCHARSBRLAPI_KEY_CMD(16) deprecated definition of CLIP_COPY - copy characters to clipboard #defineBRLAPI_KEY_CMD_CSRBLINK(BRLAPI_KEY_CMD(0)+42) set screen cursor blinking on/off #defineBRLAPI_KEY_CMD_CSRHIDE(BRLAPI_KEY_CMD(0)+39) set hidden screen cursor on/off #defineBRLAPI_KEY_CMD_CSRJMP_VERT(BRLAPI_KEY_CMD(0)+72) bring screen cursor to current line #defineBRLAPI_KEY_CMD_CSRSIZE(BRLAPI_KEY_CMD(0)+41) set screen cursor style block/underline #defineBRLAPI_KEY_CMD_CSRTRK(BRLAPI_KEY_CMD(0)+40) set track screen cursor on/off #defineBRLAPI_KEY_CMD_CSRVIS(BRLAPI_KEY_CMD(0)+38) set screen cursor visibility on/off #defineBRLAPI_KEY_CMD_CUTAPPENDBRLAPI_KEY_CMD(3) deprecated definition of CLIP_ADD - append to clipboard from character #defineBRLAPI_KEY_CMD_CUTBEGINBRLAPI_KEY_CMD(2) deprecated definition of CLIP_NEW - start new clipboard at character #defineBRLAPI_KEY_CMD_CUTLINEBRLAPI_KEY_CMD(5) deprecated definition of COPY_LINE - linear copy to character #defineBRLAPI_KEY_CMD_CUTRECTBRLAPI_KEY_CMD(4) deprecated definition of COPY_RECT - rectangular copy to character #defineBRLAPI_KEY_CMD_DESC_CURR_CHAR(BRLAPI_KEY_CMD(0)+102) describe current character #defineBRLAPI_KEY_CMD_DESCCHARBRLAPI_KEY_CMD(9) describe character #defineBRLAPI_KEY_CMD_DISPMD(BRLAPI_KEY_CMD(0)+33) set display mode attributes/text #defineBRLAPI_KEY_CMD_FREEZE(BRLAPI_KEY_CMD(0)+32) set screen image frozen/unfrozen #defineBRLAPI_KEY_CMD_FWINLT(BRLAPI_KEY_CMD(0)+23) go backward one braille window #defineBRLAPI_KEY_CMD_FWINLTSKIP(BRLAPI_KEY_CMD(0)+25) go backward skipping blank braille windows #defineBRLAPI_KEY_CMD_FWINRT(BRLAPI_KEY_CMD(0)+24) go forward one braille window #defineBRLAPI_KEY_CMD_FWINRTSKIP(BRLAPI_KEY_CMD(0)+26) go forward skipping blank braille windows #defineBRLAPI_KEY_CMD_GOTOLINEBRLAPI_KEY_CMD(13) go to selected line #defineBRLAPI_KEY_CMD_GOTOMARKBRLAPI_KEY_CMD(12) go to remembered braille window position #defineBRLAPI_KEY_CMD_GUI(BRLAPI_KEY_CMD(0)+113) cycle the GUI (Windows) sticky input modifier (next, on, off) #defineBRLAPI_KEY_CMD_GUI_APP_ALERTS(BRLAPI_KEY_CMD(0)+142) open the application alerts window #defineBRLAPI_KEY_CMD_GUI_APP_LIST(BRLAPI_KEY_CMD(0)+140) open the application list window #defineBRLAPI_KEY_CMD_GUI_APP_MENU(BRLAPI_KEY_CMD(0)+141) open the application-specific menu #defineBRLAPI_KEY_CMD_GUI_AREA_ACTV(BRLAPI_KEY_CMD(0)+143) return to the active screen area #defineBRLAPI_KEY_CMD_GUI_AREA_NEXT(BRLAPI_KEY_CMD(0)+145) switch to the next screen area #defineBRLAPI_KEY_CMD_GUI_AREA_PREV(BRLAPI_KEY_CMD(0)+144) switch to the previous screen area #defineBRLAPI_KEY_CMD_GUI_BACK(BRLAPI_KEY_CMD(0)+137) go back to the previous screen #defineBRLAPI_KEY_CMD_GUI_BRL_ACTIONS(BRLAPI_KEY_CMD(0)+135) open the braille actions window #defineBRLAPI_KEY_CMD_GUI_DEV_OPTIONS(BRLAPI_KEY_CMD(0)+139) open the device options window #defineBRLAPI_KEY_CMD_GUI_DEV_SETTINGS(BRLAPI_KEY_CMD(0)+138) open the device settings window #defineBRLAPI_KEY_CMD_GUI_HOME(BRLAPI_KEY_CMD(0)+136) go to the home screen #defineBRLAPI_KEY_CMD_GUI_ITEM_FRST(BRLAPI_KEY_CMD(0)+146) move to the first item in the screen area #defineBRLAPI_KEY_CMD_GUI_ITEM_LAST(BRLAPI_KEY_CMD(0)+149) move to the last item in the screen area #defineBRLAPI_KEY_CMD_GUI_ITEM_NEXT(BRLAPI_KEY_CMD(0)+148) move to the next item in the screen area #defineBRLAPI_KEY_CMD_GUI_ITEM_PREV(BRLAPI_KEY_CMD(0)+147) move to the previous item in the screen area #defineBRLAPI_KEY_CMD_GUI_TITLE(BRLAPI_KEY_CMD(0)+134) show the window title #defineBRLAPI_KEY_CMD_HELP(BRLAPI_KEY_CMD(0)+49) enter/leave help display #defineBRLAPI_KEY_CMD_HOME(BRLAPI_KEY_CMD(0)+29) go to screen cursor #defineBRLAPI_KEY_CMD_HOST_COPY(BRLAPI_KEY_CMD(0)+131) copy selected text to host clipboard #defineBRLAPI_KEY_CMD_HOST_CUT(BRLAPI_KEY_CMD(0)+132) cut selected text to host clipboard #defineBRLAPI_KEY_CMD_HOST_PASTE(BRLAPI_KEY_CMD(0)+133) insert host clipboard text after screen cursor #defineBRLAPI_KEY_CMD_HOSTCMDBRLAPI_KEY_CMD(41) run host command #defineBRLAPI_KEY_CMD_HWINLT(BRLAPI_KEY_CMD(0)+21) go left half a braille window #defineBRLAPI_KEY_CMD_HWINRT(BRLAPI_KEY_CMD(0)+22) go right half a braille window #defineBRLAPI_KEY_CMD_INDICATORS(BRLAPI_KEY_CMD(0)+128) show various device status indicators #defineBRLAPI_KEY_CMD_INFO(BRLAPI_KEY_CMD(0)+50) enter/leave status display #defineBRLAPI_KEY_CMD_LEARN(BRLAPI_KEY_CMD(0)+51) enter/leave command learn mode #defineBRLAPI_KEY_CMD_LNBEG(BRLAPI_KEY_CMD(0)+27) go to beginning of line #defineBRLAPI_KEY_CMD_LNDN(BRLAPI_KEY_CMD(0)+2) go down one line #defineBRLAPI_KEY_CMD_LNEND(BRLAPI_KEY_CMD(0)+28) go to end of line #defineBRLAPI_KEY_CMD_LNUP(BRLAPI_KEY_CMD(0)+1) go up one line #defineBRLAPI_KEY_CMD_MACROBRLAPI_KEY_CMD(40) execute command macro #defineBRLAPI_KEY_CMD_MENU_FIRST_ITEM(BRLAPI_KEY_CMD(0)+55) go up to first item #defineBRLAPI_KEY_CMD_MENU_LAST_ITEM(BRLAPI_KEY_CMD(0)+56) go down to last item #defineBRLAPI_KEY_CMD_MENU_NEXT_ITEM(BRLAPI_KEY_CMD(0)+58) go down to next item #defineBRLAPI_KEY_CMD_MENU_NEXT_SETTING(BRLAPI_KEY_CMD(0)+60) select next choice #defineBRLAPI_KEY_CMD_MENU_PREV_ITEM(BRLAPI_KEY_CMD(0)+57) go up to previous item #defineBRLAPI_KEY_CMD_MENU_PREV_LEVEL(BRLAPI_KEY_CMD(0)+82) go to previous menu level #defineBRLAPI_KEY_CMD_MENU_PREV_SETTING(BRLAPI_KEY_CMD(0)+59) select previous choice #defineBRLAPI_KEY_CMD_META(BRLAPI_KEY_CMD(0)+80) cycle the Meta (Left Alt) sticky input modifier (next, on, off) #defineBRLAPI_KEY_CMD_MUTE(BRLAPI_KEY_CMD(0)+61) stop speaking #defineBRLAPI_KEY_CMD_NOOP(BRLAPI_KEY_CMD(0)+0) do nothing #defineBRLAPI_KEY_CMD_NXDIFCHARBRLAPI_KEY_CMD(15) go down to nearest line with different character #defineBRLAPI_KEY_CMD_NXDIFLN(BRLAPI_KEY_CMD(0)+6) go down to nearest line with different content #defineBRLAPI_KEY_CMD_NXINDENTBRLAPI_KEY_CMD(8) go down to nearest line with less indent than character #defineBRLAPI_KEY_CMD_NXNBWIN(BRLAPI_KEY_CMD(0)+123) go forward to nearest non-blank braille window #defineBRLAPI_KEY_CMD_NXPGRPH(BRLAPI_KEY_CMD(0)+14) go down to first line of next paragraph #defineBRLAPI_KEY_CMD_NXPROMPT(BRLAPI_KEY_CMD(0)+16) go down to next command prompt #defineBRLAPI_KEY_CMD_NXSEARCH(BRLAPI_KEY_CMD(0)+18) search forward for clipboard text #defineBRLAPI_KEY_CMD_OFFLINE(BRLAPI_KEY_CMD(0)+76) braille display temporarily unavailable #defineBRLAPI_KEY_CMD_PASSATBRLAPI_KEY_CMD(35) AT (set 2) keyboard scan code #defineBRLAPI_KEY_CMD_PASSDOTSBRLAPI_KEY_CMD(34) type braille dots #defineBRLAPI_KEY_CMD_PASSPS2BRLAPI_KEY_CMD(37) PS/2 (set 3) keyboard scan code #defineBRLAPI_KEY_CMD_PASSXTBRLAPI_KEY_CMD(36) XT (set 1) keyboard scan code #defineBRLAPI_KEY_CMD_PASTE(BRLAPI_KEY_CMD(0)+73) insert clipboard text after screen cursor #defineBRLAPI_KEY_CMD_PASTE_HISTORYBRLAPI_KEY_CMD(18) insert clipboard history entry after screen cursor #defineBRLAPI_KEY_CMD_PRDIFCHARBRLAPI_KEY_CMD(14) go up to nearest line with different character #defineBRLAPI_KEY_CMD_PRDIFLN(BRLAPI_KEY_CMD(0)+5) go up to nearest line with different content #defineBRLAPI_KEY_CMD_PREFLOAD(BRLAPI_KEY_CMD(0)+54) restore preferences from disk #defineBRLAPI_KEY_CMD_PREFMENU(BRLAPI_KEY_CMD(0)+52) enter/leave preferences menu #defineBRLAPI_KEY_CMD_PREFRESET(BRLAPI_KEY_CMD(0)+155) reset preferences to defaults #defineBRLAPI_KEY_CMD_PREFSAVE(BRLAPI_KEY_CMD(0)+53) save preferences to disk #defineBRLAPI_KEY_CMD_PRINDENTBRLAPI_KEY_CMD(7) go up to nearest line with less indent than character #defineBRLAPI_KEY_CMD_PRNBWIN(BRLAPI_KEY_CMD(0)+122) go backward to nearest non-blank braille window #defineBRLAPI_KEY_CMD_PRPGRPH(BRLAPI_KEY_CMD(0)+13) go up to first line of paragraph #defineBRLAPI_KEY_CMD_PRPROMPT(BRLAPI_KEY_CMD(0)+15) go up to previous command prompt #defineBRLAPI_KEY_CMD_PRSEARCH(BRLAPI_KEY_CMD(0)+17) search backward for clipboard text #defineBRLAPI_KEY_CMD_REFRESH(BRLAPI_KEY_CMD(0)+127) refresh braille display #defineBRLAPI_KEY_CMD_REFRESH_LINEBRLAPI_KEY_CMD(25) refresh braille line #defineBRLAPI_KEY_CMD_RESTARTBRL(BRLAPI_KEY_CMD(0)+74) restart braille driver #defineBRLAPI_KEY_CMD_RESTARTSPEECH(BRLAPI_KEY_CMD(0)+75) restart speech driver #defineBRLAPI_KEY_CMD_RETURN(BRLAPI_KEY_CMD(0)+31) go to screen cursor or go back after cursor tracking #defineBRLAPI_KEY_CMD_ROUTEBRLAPI_KEY_CMD(1) bring screen cursor to character #defineBRLAPI_KEY_CMD_ROUTE_CURR_LOCN(BRLAPI_KEY_CMD(0)+104) bring screen cursor to speech cursor #defineBRLAPI_KEY_CMD_ROUTE_LINEBRLAPI_KEY_CMD(24) bring screen cursor to line #defineBRLAPI_KEY_CMD_ROUTE_SPEECHBRLAPI_KEY_CMD(28) bring speech cursor to character #defineBRLAPI_KEY_CMD_SAY_ABOVE(BRLAPI_KEY_CMD(0)+64) speak from top of screen through current line #defineBRLAPI_KEY_CMD_SAY_ALL(BRLAPI_KEY_CMD(0)+152) speak from top of screen through bottom of screen #defineBRLAPI_KEY_CMD_SAY_BELOW(BRLAPI_KEY_CMD(0)+65) speak from current line through bottom of screen #defineBRLAPI_KEY_CMD_SAY_FASTER(BRLAPI_KEY_CMD(0)+67) increase speaking rate #defineBRLAPI_KEY_CMD_SAY_HIGHER(BRLAPI_KEY_CMD(0)+151) increase speaking pitch #defineBRLAPI_KEY_CMD_SAY_LINE(BRLAPI_KEY_CMD(0)+63) speak current line #defineBRLAPI_KEY_CMD_SAY_LOUDER(BRLAPI_KEY_CMD(0)+69) increase speaking volume #defineBRLAPI_KEY_CMD_SAY_LOWER(BRLAPI_KEY_CMD(0)+150) decrease speaking pitch #defineBRLAPI_KEY_CMD_SAY_SLOWER(BRLAPI_KEY_CMD(0)+66) decrease speaking rate #defineBRLAPI_KEY_CMD_SAY_SOFTER(BRLAPI_KEY_CMD(0)+68) decrease speaking volume #defineBRLAPI_KEY_CMD_SCR_START(BRLAPI_KEY_CMD(0)+119) start the screen driver #defineBRLAPI_KEY_CMD_SCR_STOP(BRLAPI_KEY_CMD(0)+118) stop the screen driver #defineBRLAPI_KEY_CMD_SELECTVTBRLAPI_KEY_CMD(30) bind to specific virtual terminal #defineBRLAPI_KEY_CMD_SELECTVT_NEXT(BRLAPI_KEY_CMD(0)+121) bind to the next virtual terminal #defineBRLAPI_KEY_CMD_SELECTVT_PREV(BRLAPI_KEY_CMD(0)+120) bind to the previous virtual terminal #defineBRLAPI_KEY_CMD_SET_ATTRIBUTES_TABLEBRLAPI_KEY_CMD(20) set attributes table #defineBRLAPI_KEY_CMD_SET_CONTRACTION_TABLEBRLAPI_KEY_CMD(21) set contraction table #defineBRLAPI_KEY_CMD_SET_KEYBOARD_TABLEBRLAPI_KEY_CMD(22) set keyboard table #defineBRLAPI_KEY_CMD_SET_LANGUAGE_PROFILEBRLAPI_KEY_CMD(23) set language profile #defineBRLAPI_KEY_CMD_SET_TEXT_TABLEBRLAPI_KEY_CMD(19) set text table #defineBRLAPI_KEY_CMD_SETLEFTBRLAPI_KEY_CMD(10) place left end of braille window at character #defineBRLAPI_KEY_CMD_SETMARKBRLAPI_KEY_CMD(11) remember current braille window position #defineBRLAPI_KEY_CMD_SHIFT(BRLAPI_KEY_CMD(0)+77) cycle the Shift sticky input modifier (next, on, off) #defineBRLAPI_KEY_CMD_SHOW_CURR_LOCN(BRLAPI_KEY_CMD(0)+106) set speech cursor visibility on/off #defineBRLAPI_KEY_CMD_SIXDOTS(BRLAPI_KEY_CMD(0)+34) set text style 6-dot/8-dot #defineBRLAPI_KEY_CMD_SKPBLNKWINS(BRLAPI_KEY_CMD(0)+37) set skipping of blank braille windows on/off #defineBRLAPI_KEY_CMD_SKPIDLNS(BRLAPI_KEY_CMD(0)+36) set skipping of lines with identical content on/off #defineBRLAPI_KEY_CMD_SLIDEWIN(BRLAPI_KEY_CMD(0)+35) set sliding braille window on/off #defineBRLAPI_KEY_CMD_SPEAK_CURR_CHAR(BRLAPI_KEY_CMD(0)+89) speak current character #defineBRLAPI_KEY_CMD_SPEAK_CURR_LINE(BRLAPI_KEY_CMD(0)+95) speak current line #defineBRLAPI_KEY_CMD_SPEAK_CURR_LOCN(BRLAPI_KEY_CMD(0)+105) speak speech cursor location #defineBRLAPI_KEY_CMD_SPEAK_CURR_WORD(BRLAPI_KEY_CMD(0)+92) speak current word #defineBRLAPI_KEY_CMD_SPEAK_FRST_CHAR(BRLAPI_KEY_CMD(0)+98) go to and speak first non-blank character on line #defineBRLAPI_KEY_CMD_SPEAK_FRST_LINE(BRLAPI_KEY_CMD(0)+100) go to and speak first non-blank line on screen #defineBRLAPI_KEY_CMD_SPEAK_INDENT(BRLAPI_KEY_CMD(0)+125) speak indent of current line #defineBRLAPI_KEY_CMD_SPEAK_LAST_CHAR(BRLAPI_KEY_CMD(0)+99) go to and speak last non-blank character on line #defineBRLAPI_KEY_CMD_SPEAK_LAST_LINE(BRLAPI_KEY_CMD(0)+101) go to and speak last non-blank line on screen #defineBRLAPI_KEY_CMD_SPEAK_NEXT_CHAR(BRLAPI_KEY_CMD(0)+91) go to and speak next character #defineBRLAPI_KEY_CMD_SPEAK_NEXT_LINE(BRLAPI_KEY_CMD(0)+97) go to and speak next line #defineBRLAPI_KEY_CMD_SPEAK_NEXT_WORD(BRLAPI_KEY_CMD(0)+94) go to and speak next word #defineBRLAPI_KEY_CMD_SPEAK_PREV_CHAR(BRLAPI_KEY_CMD(0)+90) go to and speak previous character #defineBRLAPI_KEY_CMD_SPEAK_PREV_LINE(BRLAPI_KEY_CMD(0)+96) go to and speak previous line #defineBRLAPI_KEY_CMD_SPEAK_PREV_WORD(BRLAPI_KEY_CMD(0)+93) go to and speak previous word #defineBRLAPI_KEY_CMD_SPELL_CURR_WORD(BRLAPI_KEY_CMD(0)+103) spell current word #defineBRLAPI_KEY_CMD_SPK_START(BRLAPI_KEY_CMD(0)+117) start the speech driver #defineBRLAPI_KEY_CMD_SPK_STOP(BRLAPI_KEY_CMD(0)+116) stop the speech driver #defineBRLAPI_KEY_CMD_SPKHOME(BRLAPI_KEY_CMD(0)+62) go to current speaking position #defineBRLAPI_KEY_CMD_SWITCHVTBRLAPI_KEY_CMD(6) switch to specific virtual terminal #defineBRLAPI_KEY_CMD_SWITCHVT_NEXT(BRLAPI_KEY_CMD(0)+71) switch to the next virtual terminal #defineBRLAPI_KEY_CMD_SWITCHVT_PREV(BRLAPI_KEY_CMD(0)+70) switch to the previous virtual terminal #defineBRLAPI_KEY_CMD_TIME(BRLAPI_KEY_CMD(0)+81) show current date and time #defineBRLAPI_KEY_CMD_TOP(BRLAPI_KEY_CMD(0)+9) go to top line #defineBRLAPI_KEY_CMD_TOP_LEFT(BRLAPI_KEY_CMD(0)+11) go to beginning of top line #defineBRLAPI_KEY_CMD_TOUCH_ATBRLAPI_KEY_CMD(39) current reading location #defineBRLAPI_KEY_CMD_TOUCH_NAV(BRLAPI_KEY_CMD(0)+124) set touch navigation on/off #defineBRLAPI_KEY_CMD_TUNES(BRLAPI_KEY_CMD(0)+46) set alert tunes on/off #defineBRLAPI_KEY_CMD_TXTSEL_ALL(BRLAPI_KEY_CMD(0)+130) select all of the text #defineBRLAPI_KEY_CMD_TXTSEL_CLEAR(BRLAPI_KEY_CMD(0)+129) clear the text selection #defineBRLAPI_KEY_CMD_TXTSEL_SETBRLAPI_KEY_CMD(27) set text selection #defineBRLAPI_KEY_CMD_TXTSEL_STARTBRLAPI_KEY_CMD(26) start text selection #defineBRLAPI_KEY_CMD_UNSTICK(BRLAPI_KEY_CMD(0)+111) clear all sticky input modifiers #defineBRLAPI_KEY_CMD_UPPER(BRLAPI_KEY_CMD(0)+78) cycle the Upper sticky input modifier (next, on, off) #defineBRLAPI_KEY_CMD_WINDN(BRLAPI_KEY_CMD(0)+4) go down several lines #defineBRLAPI_KEY_CMD_WINUP(BRLAPI_KEY_CMD(0)+3) go up several lines #defineBRLAPI_KEY_CODE_MASKUINT64_C(0X000000001FFFFFFF) Mask for code of brlapi_keyCode_t #defineBRLAPI_KEY_CODE_SHIFT0 Shift for code of brlapi_keyCode_t #defineBRLAPI_KEY_FLAGS_MASKUINT64_C(0XFFFFFFFF00000000) Mask for flags of brlapi_keyCode_t #defineBRLAPI_KEY_FLAGS_SHIFT32 Shift for flags of brlapi_keyCode_t #defineBRLAPI_KEY_FLG(v)((brlapi_keyCode_t)(v)<<BRLAPI_KEY_FLAGS_SHIFT)#defineBRLAPI_KEY_FLG_ALTGRBRLAPI_KEY_FLG(0X10) altgr (right alt) key pressed #defineBRLAPI_KEY_FLG_CAPSLOCKBRLAPI_KEY_FLG(0X80) capslock key pressed #defineBRLAPI_KEY_FLG_CONTROLBRLAPI_KEY_FLG(0X04) control key pressed #defineBRLAPI_KEY_FLG_ESCAPEDBRLAPI_KEY_FLG(0X40) prefix with escape #defineBRLAPI_KEY_FLG_GUIBRLAPI_KEY_FLG(0X20) gui (windows) key pressed #defineBRLAPI_KEY_FLG_KBD_EMUL0BRLAPI_KEY_FLG(0X0200) it is an emulation 0 scan code #defineBRLAPI_KEY_FLG_KBD_EMUL1BRLAPI_KEY_FLG(0X0400) it is an emulation 1 scan code #defineBRLAPI_KEY_FLG_KBD_RELEASEBRLAPI_KEY_FLG(0X0100) it is a release scan code #defineBRLAPI_KEY_FLG_METABRLAPI_KEY_FLG(0X08) meta (left alt) key pressed #defineBRLAPI_KEY_FLG_MOD1BRLAPI_KEY_FLG(0x00000008) Standard X modifiers Mod1 modifier (AKA meta) #defineBRLAPI_KEY_FLG_MOD2BRLAPI_KEY_FLG(0x00000010) Mod2 modifier (usually numlock) #defineBRLAPI_KEY_FLG_MOD3BRLAPI_KEY_FLG(0x00000020) Mod3 modifier #defineBRLAPI_KEY_FLG_MOD4BRLAPI_KEY_FLG(0x00000040) Mod4 modifier #defineBRLAPI_KEY_FLG_MOD5BRLAPI_KEY_FLG(0x00000080) Mod5 modifier (usually Alt-Gr) #defineBRLAPI_KEY_FLG_MOTION_ROUTEBRLAPI_KEY_FLG(0X0400) bring screen cursor into braille window after function #defineBRLAPI_KEY_FLG_MOTION_SCALEDBRLAPI_KEY_FLG(0X0800) scale arg=0X00-0XFF to screen height #defineBRLAPI_KEY_FLG_MOTION_TOLEFTBRLAPI_KEY_FLG(0X1000) go to beginning of line #defineBRLAPI_KEY_FLG_SHIFTBRLAPI_KEY_FLG(0X01) shift key pressed #defineBRLAPI_KEY_FLG_TOGGLE_MASK(BRLAPI_KEY_FLG_TOGGLE_ON|BRLAPI_KEY_FLG_TOGGLE_OFF) mask for all toggle flags #defineBRLAPI_KEY_FLG_TOGGLE_OFFBRLAPI_KEY_FLG(0X0200) disable feature #defineBRLAPI_KEY_FLG_TOGGLE_ONBRLAPI_KEY_FLG(0X0100) enable feature #defineBRLAPI_KEY_FLG_UPPERBRLAPI_KEY_FLG(0X02) convert to uppercase #defineBRLAPI_KEY_MAXUINT64_C(0XFFFFFFFFFFFFFFFF) Brlapi_keyCode_t's biggest value As defined in <stdint.h> #defineBRLAPI_KEY_SYM_BACKSPACEUINT64_C(0X0000FF08) Standard X keysyms #defineBRLAPI_KEY_SYM_DELETEUINT64_C(0X0000FFFF)#defineBRLAPI_KEY_SYM_DOWNUINT64_C(0X0000FF54)#defineBRLAPI_KEY_SYM_ENDUINT64_C(0X0000FF57)#defineBRLAPI_KEY_SYM_ESCAPEUINT64_C(0X0000FF1B)#defineBRLAPI_KEY_SYM_FUNCTIONUINT64_C(0X0000FFBE)#defineBRLAPI_KEY_SYM_HOMEUINT64_C(0X0000FF50)#defineBRLAPI_KEY_SYM_INSERTUINT64_C(0X0000FF63)#defineBRLAPI_KEY_SYM_LEFTUINT64_C(0X0000FF51)#defineBRLAPI_KEY_SYM_LINEFEEDUINT64_C(0X0000FF0D)#defineBRLAPI_KEY_SYM_PAGE_DOWNUINT64_C(0X0000FF56)#defineBRLAPI_KEY_SYM_PAGE_UPUINT64_C(0X0000FF55)#defineBRLAPI_KEY_SYM_RIGHTUINT64_C(0X0000FF53)#defineBRLAPI_KEY_SYM_TABUINT64_C(0X0000FF09)#defineBRLAPI_KEY_SYM_UNICODEUINT64_C(0X01000000)#defineBRLAPI_KEY_SYM_UPUINT64_C(0X0000FF52)#defineBRLAPI_KEY_TYPE_CMDUINT64_C(0X0000000020000000) Braille command brlapi_keyCode_t #defineBRLAPI_KEY_TYPE_MASKUINT64_C(0X00000000E0000000) Mask for type of brlapi_keyCode_t #defineBRLAPI_KEY_TYPE_SHIFT29 Shift for type of brlapi_keyCode_t #defineBRLAPI_KEY_TYPE_SYMUINT64_C(0X0000000000000000) X Keysym brlapi_keyCode_t #defineBRLAPI_KEYCODE_C(value)UINT64_C(value) Define a brlapi_keyCode_t constant #defineBRLAPI_PRIuKEYCODEPRIu64 Unsigned decimal print format for brlapi_keyCode_t #defineBRLAPI_PRIxKEYCODEPRIx64 Hexadecimal print format for brlapi_keyCode_t

brlapi_keycodes - Types and Defines for\e BrlAPI Key Codes

Macros #define BRLAPI_KEYCODE_C(value) UINT64_C(value) #define BRLAPI_PRIxKEYCODE PRIx64 #define BRLAPI_PRIuKEYCODE PRIu64 #define BRLAPI_KEY_MAXUINT64_C(0XFFFFFFFFFFFFFFFF) #define BRLAPI_KEY_FLAGS_MASKUINT64_C(0XFFFFFFFF00000000) #define BRLAPI_KEY_FLAGS_SHIFT 32 #define BRLAPI_KEY_FLG(v) ((brlapi_keyCode_t)(v) << BRLAPI_KEY_FLAGS_SHIFT) #define BRLAPI_KEY_FLG_MOD1BRLAPI_KEY_FLG(0x00000008) #define BRLAPI_KEY_FLG_MOD2BRLAPI_KEY_FLG(0x00000010) #define BRLAPI_KEY_FLG_MOD3BRLAPI_KEY_FLG(0x00000020) #define BRLAPI_KEY_FLG_MOD4BRLAPI_KEY_FLG(0x00000040) #define BRLAPI_KEY_FLG_MOD5BRLAPI_KEY_FLG(0x00000080) #define BRLAPI_KEY_TYPE_MASKUINT64_C(0X00000000E0000000) #define BRLAPI_KEY_TYPE_SHIFT 29 #define BRLAPI_KEY_TYPE_CMDUINT64_C(0X0000000020000000) #define BRLAPI_KEY_TYPE_SYMUINT64_C(0X0000000000000000) #define BRLAPI_KEY_CODE_MASKUINT64_C(0X000000001FFFFFFF) #define BRLAPI_KEY_CODE_SHIFT 0 #define BRLAPI_KEY_CMD_BLK_MASKUINT64_C(0X1FFF0000) #define BRLAPI_KEY_CMD_BLK_SHIFT 16 #define BRLAPI_KEY_CMD_ARG_MASKUINT64_C(0X0000FFFF) #define BRLAPI_KEY_CMD_ARG_SHIFT 0 #define BRLAPI_KEY_CMD(v) ((v) << BRLAPI_KEY_CMD_BLK_SHIFT) #define BRLAPI_KEY_SYM_BACKSPACEUINT64_C(0X0000FF08) #define BRLAPI_KEY_SYM_TABUINT64_C(0X0000FF09) #define BRLAPI_KEY_SYM_LINEFEEDUINT64_C(0X0000FF0D) #define BRLAPI_KEY_SYM_ESCAPEUINT64_C(0X0000FF1B) #define BRLAPI_KEY_SYM_HOMEUINT64_C(0X0000FF50) #define BRLAPI_KEY_SYM_LEFTUINT64_C(0X0000FF51) #define BRLAPI_KEY_SYM_UPUINT64_C(0X0000FF52) #define BRLAPI_KEY_SYM_RIGHTUINT64_C(0X0000FF53) #define BRLAPI_KEY_SYM_DOWNUINT64_C(0X0000FF54) #define BRLAPI_KEY_SYM_PAGE_UPUINT64_C(0X0000FF55) #define BRLAPI_KEY_SYM_PAGE_DOWNUINT64_C(0X0000FF56) #define BRLAPI_KEY_SYM_ENDUINT64_C(0X0000FF57) #define BRLAPI_KEY_SYM_INSERTUINT64_C(0X0000FF63) #define BRLAPI_KEY_SYM_FUNCTIONUINT64_C(0X0000FFBE) #define BRLAPI_KEY_SYM_DELETEUINT64_C(0X0000FFFF) #define BRLAPI_KEY_SYM_UNICODEUINT64_C(0X01000000) #define BRLAPI_DRV_KEY_PRESSBRLAPI_KEYCODE_C(0X8000000000000000) #define BRLAPI_DRV_KEY_NUMBER_SHIFT 0 #define BRLAPI_DRV_KEY_NUMBER_MASK 0XFF #define BRLAPI_DRV_KEY_NUMBER(code) (((code) & BRLAPI_DRV_KEY_NUMBER_MASK) >> BRLAPI_DRV_KEY_NUMBER_SHIFT) #define BRLAPI_DRV_KEY_GROUP_SHIFT 8 #define BRLAPI_DRV_KEY_GROUP_MASK 0XFF00 #define BRLAPI_DRV_KEY_GROUP(code) (((code) & BRLAPI_DRV_KEY_GROUP_MASK) >> BRLAPI_DRV_KEY_GROUP_SHIFT) #define BRLAPI_DRV_KEY_VALUE_MASK (BRLAPI_DRV_KEY_GROUP_MASK | BRLAPI_DRV_KEY_NUMBER_MASK) #define BRLAPI_DRV_KEY_NUMBER_ANY 0XFF Typedefs typedef uint64_t brlapi_keyCode_t