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.
◆ BRLAPI_DOT1
upper-left dot of standard braille cell
◆ BRLAPI_DOT2
middle-left dot of standard braille cell
◆ BRLAPI_DOT3
lower-left dot of standard braille cell
◆ BRLAPI_DOT4
upper-right dot of standard braille cell
◆ BRLAPI_DOT5
middle-right dot of standard braille cell
◆ BRLAPI_DOT6
lower-right dot of standard braille cell
◆ BRLAPI_DOT7
lower-left dot of computer braille cell
◆ BRLAPI_DOT8
lower-right dot of computer braille cell
◆ BRLAPI_DOT_CHORD
#define BRLAPI_DOT_CHORD 256 |
◆ BRLAPI_DOTC
chord (space bar on braille keyboard)
◆ BRLAPI_DOTS
#define BRLAPI_DOTS |
( |
|
dot1, |
|
|
|
dot2, |
|
|
|
dot3, |
|
|
|
dot4, |
|
|
|
dot5, |
|
|
|
dot6, |
|
|
|
dot7, |
|
|
|
dot8 |
|
) |
| |
Value: (\
)
#define BRLAPI_DOT6
Definition brlapi_constants.h:468
#define BRLAPI_DOT4
Definition brlapi_constants.h:464
#define BRLAPI_DOT2
Definition brlapi_constants.h:460
#define BRLAPI_DOT1
Definition brlapi_constants.h:458
#define BRLAPI_DOT3
Definition brlapi_constants.h:462
#define BRLAPI_DOT8
Definition brlapi_constants.h:472
#define BRLAPI_DOT7
Definition brlapi_constants.h:470
#define BRLAPI_DOT5
Definition brlapi_constants.h:466
Helper macro to easily produce braille patterns
◆ BRLAPI_DRV_KEY_GROUP
Get key group of brlapi_keyCode_t
◆ BRLAPI_DRV_KEY_GROUP_MASK
#define BRLAPI_DRV_KEY_GROUP_MASK 0XFF00 |
Mask for key group of brlapi_keyCode_t
◆ BRLAPI_DRV_KEY_GROUP_SHIFT
#define BRLAPI_DRV_KEY_GROUP_SHIFT 8 |
Shift for key group of brlapi_keyCode_t
◆ BRLAPI_DRV_KEY_NUMBER
Get key number of brlapi_keyCode_t
◆ BRLAPI_DRV_KEY_NUMBER_ANY
#define BRLAPI_DRV_KEY_NUMBER_ANY 0XFF |
Key number representing any key in the group
◆ BRLAPI_DRV_KEY_NUMBER_MASK
#define BRLAPI_DRV_KEY_NUMBER_MASK 0XFF |
Mask for key number of brlapi_keyCode_t
◆ BRLAPI_DRV_KEY_NUMBER_SHIFT
#define BRLAPI_DRV_KEY_NUMBER_SHIFT 0 |
Shift for key number of brlapi_keyCode_t
◆ BRLAPI_DRV_KEY_PRESS
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)
◆ BRLAPI_DRV_KEY_VALUE_MASK
Mask for key value (group and number) of brlapi_keyCode_t
◆ BRLAPI_KEY_CMD
◆ BRLAPI_KEY_CMD_ALERT
◆ BRLAPI_KEY_CMD_ALTGR
cycle the AltGr (Right Alt) sticky input modifier (next, on, off)
◆ BRLAPI_KEY_CMD_APNDCHARS
deprecated definition of CLIP_APPEND - append characters to clipboard
◆ BRLAPI_KEY_CMD_ARG_MASK
#define BRLAPI_KEY_CMD_ARG_MASK UINT64_C(0X0000FFFF) |
Mask for braille command value
◆ BRLAPI_KEY_CMD_ARG_SHIFT
#define BRLAPI_KEY_CMD_ARG_SHIFT 0 |
Shift for braille command value
◆ BRLAPI_KEY_CMD_ASPK_CMP_WORDS
set autospeak completed words on/off
◆ BRLAPI_KEY_CMD_ASPK_DEL_CHARS
set autospeak deleted characters on/off
◆ BRLAPI_KEY_CMD_ASPK_INDENT
set autospeak indent of current line on/off
◆ BRLAPI_KEY_CMD_ASPK_INS_CHARS
set autospeak inserted characters on/off
◆ BRLAPI_KEY_CMD_ASPK_REP_CHARS
set autospeak replaced characters on/off
◆ BRLAPI_KEY_CMD_ASPK_SEL_CHAR
set autospeak selected character on/off
◆ BRLAPI_KEY_CMD_ASPK_SEL_LINE
set autospeak selected line on/off
◆ BRLAPI_KEY_CMD_ATTRBLINK
set attribute blinking on/off
◆ BRLAPI_KEY_CMD_ATTRDN
go down to nearest line with different highlighting
◆ BRLAPI_KEY_CMD_ATTRUP
go up to nearest line with different highlighting
◆ BRLAPI_KEY_CMD_ATTRVIS
set attribute underlining on/off
◆ BRLAPI_KEY_CMD_AUTOREPEAT
◆ BRLAPI_KEY_CMD_AUTOSPEAK
◆ BRLAPI_KEY_CMD_BACK
go back after cursor tracking
◆ BRLAPI_KEY_CMD_BLK_MASK
#define BRLAPI_KEY_CMD_BLK_MASK UINT64_C(0X1FFF0000) |
Mask for braille command type
◆ BRLAPI_KEY_CMD_BLK_SHIFT
#define BRLAPI_KEY_CMD_BLK_SHIFT 16 |
Shift for braille command type
◆ BRLAPI_KEY_CMD_BOT
◆ BRLAPI_KEY_CMD_BOT_LEFT
go to beginning of bottom line
◆ BRLAPI_KEY_CMD_BRL_START
◆ BRLAPI_KEY_CMD_BRL_STOP
◆ BRLAPI_KEY_CMD_BRLKBD
set braille keyboard enabled/disabled
◆ BRLAPI_KEY_CMD_BRLUCDOTS
set braille typing mode dots/text
◆ BRLAPI_KEY_CMD_CAPBLINK
set capital letter blinking on/off
◆ BRLAPI_KEY_CMD_CHRLT
◆ BRLAPI_KEY_CMD_CHRRT
◆ BRLAPI_KEY_CMD_CLIP_ADD
append to clipboard from character
◆ BRLAPI_KEY_CMD_CLIP_APPEND
append characters to clipboard
◆ BRLAPI_KEY_CMD_CLIP_COPY
copy characters to clipboard
◆ BRLAPI_KEY_CMD_CLIP_NEW
start new clipboard at character
◆ BRLAPI_KEY_CMD_CLIP_RESTORE
restore clipboard from disk
◆ BRLAPI_KEY_CMD_CLIP_SAVE
◆ BRLAPI_KEY_CMD_COMPBRL6
set six/eight dot computer braille
◆ BRLAPI_KEY_CMD_CONTEXT
switch to command context
◆ BRLAPI_KEY_CMD_CONTRACTED
set contracted/computer braille
◆ BRLAPI_KEY_CMD_CONTROL
cycle the Control sticky input modifier (next, on, off)
◆ BRLAPI_KEY_CMD_COPY_LINE
◆ BRLAPI_KEY_CMD_COPY_RECT
rectangular copy to character
◆ BRLAPI_KEY_CMD_COPYCHARS
deprecated definition of CLIP_COPY - copy characters to clipboard
◆ BRLAPI_KEY_CMD_CSRBLINK
set screen cursor blinking on/off
◆ BRLAPI_KEY_CMD_CSRHIDE
set hidden screen cursor on/off
◆ BRLAPI_KEY_CMD_CSRJMP_VERT
bring screen cursor to current line
◆ BRLAPI_KEY_CMD_CSRSIZE
set screen cursor style block/underline
◆ BRLAPI_KEY_CMD_CSRTRK
set track screen cursor on/off
◆ BRLAPI_KEY_CMD_CSRVIS
set screen cursor visibility on/off
◆ BRLAPI_KEY_CMD_CUTAPPEND
deprecated definition of CLIP_ADD - append to clipboard from character
◆ BRLAPI_KEY_CMD_CUTBEGIN
deprecated definition of CLIP_NEW - start new clipboard at character
◆ BRLAPI_KEY_CMD_CUTLINE
deprecated definition of COPY_LINE - linear copy to character
◆ BRLAPI_KEY_CMD_CUTRECT
deprecated definition of COPY_RECT - rectangular copy to character
◆ BRLAPI_KEY_CMD_DESC_CURR_CHAR
describe current character
◆ BRLAPI_KEY_CMD_DESCCHAR
◆ BRLAPI_KEY_CMD_DISPMD
set display mode attributes/text
◆ BRLAPI_KEY_CMD_FREEZE
set screen image frozen/unfrozen
◆ BRLAPI_KEY_CMD_FWINLT
go backward one braille window
◆ BRLAPI_KEY_CMD_FWINLTSKIP
go backward skipping blank braille windows
◆ BRLAPI_KEY_CMD_FWINRT
go forward one braille window
◆ BRLAPI_KEY_CMD_FWINRTSKIP
go forward skipping blank braille windows
◆ BRLAPI_KEY_CMD_GOTOLINE
◆ BRLAPI_KEY_CMD_GOTOMARK
go to remembered braille window position
◆ BRLAPI_KEY_CMD_GUI
cycle the GUI (Windows) sticky input modifier (next, on, off)
◆ BRLAPI_KEY_CMD_GUI_APP_ALERTS
open the application alerts window
◆ BRLAPI_KEY_CMD_GUI_APP_LIST
open the application list window
◆ BRLAPI_KEY_CMD_GUI_APP_MENU
open the application-specific menu
◆ BRLAPI_KEY_CMD_GUI_AREA_ACTV
return to the active screen area
◆ BRLAPI_KEY_CMD_GUI_AREA_NEXT
switch to the next screen area
◆ BRLAPI_KEY_CMD_GUI_AREA_PREV
switch to the previous screen area
◆ BRLAPI_KEY_CMD_GUI_BACK
go back to the previous screen
◆ BRLAPI_KEY_CMD_GUI_BRL_ACTIONS
open the braille actions window
◆ BRLAPI_KEY_CMD_GUI_DEV_OPTIONS
open the device options window
◆ BRLAPI_KEY_CMD_GUI_DEV_SETTINGS
open the device settings window
◆ BRLAPI_KEY_CMD_GUI_HOME
◆ BRLAPI_KEY_CMD_GUI_ITEM_FRST
move to the first item in the screen area
◆ BRLAPI_KEY_CMD_GUI_ITEM_LAST
move to the last item in the screen area
◆ BRLAPI_KEY_CMD_GUI_ITEM_NEXT
move to the next item in the screen area
◆ BRLAPI_KEY_CMD_GUI_ITEM_PREV
move to the previous item in the screen area
◆ BRLAPI_KEY_CMD_GUI_TITLE
◆ BRLAPI_KEY_CMD_HELP
◆ BRLAPI_KEY_CMD_HOME
◆ BRLAPI_KEY_CMD_HOST_COPY
copy selected text to host clipboard
◆ BRLAPI_KEY_CMD_HOST_CUT
cut selected text to host clipboard
◆ BRLAPI_KEY_CMD_HOST_PASTE
insert host clipboard text after screen cursor
◆ BRLAPI_KEY_CMD_HWINLT
go left half a braille window
◆ BRLAPI_KEY_CMD_HWINRT
go right half a braille window
◆ BRLAPI_KEY_CMD_INDICATORS
show various device status indicators
◆ BRLAPI_KEY_CMD_INFO
enter/leave status display
◆ BRLAPI_KEY_CMD_LEARN
enter/leave command learn mode
◆ BRLAPI_KEY_CMD_LNBEG
◆ BRLAPI_KEY_CMD_LNDN
◆ BRLAPI_KEY_CMD_LNEND
◆ BRLAPI_KEY_CMD_LNUP
◆ BRLAPI_KEY_CMD_MENU_FIRST_ITEM
◆ BRLAPI_KEY_CMD_MENU_LAST_ITEM
◆ BRLAPI_KEY_CMD_MENU_NEXT_ITEM
◆ BRLAPI_KEY_CMD_MENU_NEXT_SETTING
◆ BRLAPI_KEY_CMD_MENU_PREV_ITEM
◆ BRLAPI_KEY_CMD_MENU_PREV_LEVEL
go to previous menu level
◆ BRLAPI_KEY_CMD_MENU_PREV_SETTING
◆ BRLAPI_KEY_CMD_META
cycle the Meta (Left Alt) sticky input modifier (next, on, off)
◆ BRLAPI_KEY_CMD_MUTE
◆ BRLAPI_KEY_CMD_NOOP
◆ BRLAPI_KEY_CMD_NXDIFCHAR
go down to nearest line with different character
◆ BRLAPI_KEY_CMD_NXDIFLN
go down to nearest line with different content
◆ BRLAPI_KEY_CMD_NXINDENT
go down to nearest line with less indent than character
◆ BRLAPI_KEY_CMD_NXNBWIN
go forward to nearest non-blank braille window
◆ BRLAPI_KEY_CMD_NXPGRPH
go down to first line of next paragraph
◆ BRLAPI_KEY_CMD_NXPROMPT
go down to next command prompt
◆ BRLAPI_KEY_CMD_NXSEARCH
search forward for clipboard text
◆ BRLAPI_KEY_CMD_OFFLINE
braille display temporarily unavailable
◆ BRLAPI_KEY_CMD_PASSAT
AT (set 2) keyboard scan code
◆ BRLAPI_KEY_CMD_PASSDOTS
◆ BRLAPI_KEY_CMD_PASSPS2
PS/2 (set 3) keyboard scan code
◆ BRLAPI_KEY_CMD_PASSXT
XT (set 1) keyboard scan code
◆ BRLAPI_KEY_CMD_PASTE
insert clipboard text after screen cursor
◆ BRLAPI_KEY_CMD_PASTE_HISTORY
insert clipboard history entry after screen cursor
◆ BRLAPI_KEY_CMD_PRDIFCHAR
go up to nearest line with different character
◆ BRLAPI_KEY_CMD_PRDIFLN
go up to nearest line with different content
◆ BRLAPI_KEY_CMD_PREFLOAD
restore preferences from disk
◆ BRLAPI_KEY_CMD_PREFMENU
enter/leave preferences menu
◆ BRLAPI_KEY_CMD_PREFSAVE
◆ BRLAPI_KEY_CMD_PRINDENT
go up to nearest line with less indent than character
◆ BRLAPI_KEY_CMD_PRNBWIN
go backward to nearest non-blank braille window
◆ BRLAPI_KEY_CMD_PRPGRPH
go up to first line of paragraph
◆ BRLAPI_KEY_CMD_PRPROMPT
go up to previous command prompt
◆ BRLAPI_KEY_CMD_PRSEARCH
search backward for clipboard text
◆ BRLAPI_KEY_CMD_REFRESH
◆ BRLAPI_KEY_CMD_REFRESH_LINE
◆ BRLAPI_KEY_CMD_RESTARTBRL
◆ BRLAPI_KEY_CMD_RESTARTSPEECH
◆ BRLAPI_KEY_CMD_RETURN
go to screen cursor or go back after cursor tracking
◆ BRLAPI_KEY_CMD_ROUTE
bring screen cursor to character
◆ BRLAPI_KEY_CMD_ROUTE_CURR_LOCN
bring screen cursor to speech cursor
◆ BRLAPI_KEY_CMD_ROUTE_LINE
bring screen cursor to line
◆ BRLAPI_KEY_CMD_SAY_ABOVE
speak from top of screen through current line
◆ BRLAPI_KEY_CMD_SAY_ALL
speak from top of screen through bottom of screen
◆ BRLAPI_KEY_CMD_SAY_BELOW
speak from current line through bottom of screen
◆ BRLAPI_KEY_CMD_SAY_FASTER
◆ BRLAPI_KEY_CMD_SAY_HIGHER
◆ BRLAPI_KEY_CMD_SAY_LINE
◆ BRLAPI_KEY_CMD_SAY_LOUDER
◆ BRLAPI_KEY_CMD_SAY_LOWER
◆ BRLAPI_KEY_CMD_SAY_SLOWER
◆ BRLAPI_KEY_CMD_SAY_SOFTER
◆ BRLAPI_KEY_CMD_SCR_START
◆ BRLAPI_KEY_CMD_SCR_STOP
◆ BRLAPI_KEY_CMD_SELECTVT
bind to specific virtual terminal
◆ BRLAPI_KEY_CMD_SELECTVT_NEXT
bind to the next virtual terminal
◆ BRLAPI_KEY_CMD_SELECTVT_PREV
bind to the previous virtual terminal
◆ BRLAPI_KEY_CMD_SET_ATTRIBUTES_TABLE
◆ BRLAPI_KEY_CMD_SET_CONTRACTION_TABLE
◆ BRLAPI_KEY_CMD_SET_KEYBOARD_TABLE
◆ BRLAPI_KEY_CMD_SET_LANGUAGE_PROFILE
◆ BRLAPI_KEY_CMD_SET_TEXT_TABLE
◆ BRLAPI_KEY_CMD_SETLEFT
place left end of braille window at character
◆ BRLAPI_KEY_CMD_SETMARK
remember current braille window position
◆ BRLAPI_KEY_CMD_SHIFT
cycle the Shift sticky input modifier (next, on, off)
◆ BRLAPI_KEY_CMD_SHOW_CURR_LOCN
set speech cursor visibility on/off
◆ BRLAPI_KEY_CMD_SIXDOTS
set text style 6-dot/8-dot
◆ BRLAPI_KEY_CMD_SKPBLNKWINS
set skipping of blank braille windows on/off
◆ BRLAPI_KEY_CMD_SKPIDLNS
set skipping of lines with identical content on/off
◆ BRLAPI_KEY_CMD_SLIDEWIN
set sliding braille window on/off
◆ BRLAPI_KEY_CMD_SPEAK_CURR_CHAR
◆ BRLAPI_KEY_CMD_SPEAK_CURR_LINE
◆ BRLAPI_KEY_CMD_SPEAK_CURR_LOCN
speak speech cursor location
◆ BRLAPI_KEY_CMD_SPEAK_CURR_WORD
◆ BRLAPI_KEY_CMD_SPEAK_FRST_CHAR
go to and speak first non-blank character on line
◆ BRLAPI_KEY_CMD_SPEAK_FRST_LINE
go to and speak first non-blank line on screen
◆ BRLAPI_KEY_CMD_SPEAK_INDENT
speak indent of current line
◆ BRLAPI_KEY_CMD_SPEAK_LAST_CHAR
go to and speak last non-blank character on line
◆ BRLAPI_KEY_CMD_SPEAK_LAST_LINE
go to and speak last non-blank line on screen
◆ BRLAPI_KEY_CMD_SPEAK_NEXT_CHAR
go to and speak next character
◆ BRLAPI_KEY_CMD_SPEAK_NEXT_LINE
go to and speak next line
◆ BRLAPI_KEY_CMD_SPEAK_NEXT_WORD
go to and speak next word
◆ BRLAPI_KEY_CMD_SPEAK_PREV_CHAR
go to and speak previous character
◆ BRLAPI_KEY_CMD_SPEAK_PREV_LINE
go to and speak previous line
◆ BRLAPI_KEY_CMD_SPEAK_PREV_WORD
go to and speak previous word
◆ BRLAPI_KEY_CMD_SPELL_CURR_WORD
◆ BRLAPI_KEY_CMD_SPK_START
◆ BRLAPI_KEY_CMD_SPK_STOP
◆ BRLAPI_KEY_CMD_SPKHOME
go to current speaking position
◆ BRLAPI_KEY_CMD_SWITCHVT
switch to specific virtual terminal
◆ BRLAPI_KEY_CMD_SWITCHVT_NEXT
switch to the next virtual terminal
◆ BRLAPI_KEY_CMD_SWITCHVT_PREV
switch to the previous virtual terminal
◆ BRLAPI_KEY_CMD_TIME
show current date and time
◆ BRLAPI_KEY_CMD_TOP
◆ BRLAPI_KEY_CMD_TOP_LEFT
go to beginning of top line
◆ BRLAPI_KEY_CMD_TOUCH_AT
◆ BRLAPI_KEY_CMD_TOUCH_NAV
set touch navigation on/off
◆ BRLAPI_KEY_CMD_TUNES
◆ BRLAPI_KEY_CMD_TXTSEL_ALL
◆ BRLAPI_KEY_CMD_TXTSEL_CLEAR
◆ BRLAPI_KEY_CMD_TXTSEL_SET
◆ BRLAPI_KEY_CMD_TXTSEL_START
◆ BRLAPI_KEY_CMD_UNSTICK
clear all sticky input modifiers
◆ BRLAPI_KEY_CMD_UPPER
cycle the Upper sticky input modifier (next, on, off)
◆ BRLAPI_KEY_CMD_WINDN
◆ BRLAPI_KEY_CMD_WINUP
◆ BRLAPI_KEY_CODE_MASK
#define BRLAPI_KEY_CODE_MASK UINT64_C(0X000000001FFFFFFF) |
Mask for code of brlapi_keyCode_t
◆ BRLAPI_KEY_CODE_SHIFT
#define BRLAPI_KEY_CODE_SHIFT 0 |
Shift for code of brlapi_keyCode_t
◆ BRLAPI_KEY_FLAGS_MASK
#define BRLAPI_KEY_FLAGS_MASK UINT64_C(0XFFFFFFFF00000000) |
Mask for flags of brlapi_keyCode_t
◆ BRLAPI_KEY_FLAGS_SHIFT
#define BRLAPI_KEY_FLAGS_SHIFT 32 |
Shift for flags of brlapi_keyCode_t
◆ BRLAPI_KEY_FLG
◆ BRLAPI_KEY_FLG_ALTGR
altgr (right alt) key pressed
◆ BRLAPI_KEY_FLG_CONTROL
◆ BRLAPI_KEY_FLG_ESCAPED
◆ BRLAPI_KEY_FLG_GUI
gui (windows) key pressed
◆ BRLAPI_KEY_FLG_KBD_EMUL0
it is an emulation 0 scan code
◆ BRLAPI_KEY_FLG_KBD_EMUL1
it is an emulation 1 scan code
◆ BRLAPI_KEY_FLG_KBD_RELEASE
it is a release scan code
◆ BRLAPI_KEY_FLG_META
meta (left alt) key pressed
◆ BRLAPI_KEY_FLG_MOD1
Standard X modifiers Mod1 modifier (AKA meta)
◆ BRLAPI_KEY_FLG_MOD2
Mod2 modifier (usually numlock)
◆ BRLAPI_KEY_FLG_MOD3
◆ BRLAPI_KEY_FLG_MOD4
◆ BRLAPI_KEY_FLG_MOD5
Mod5 modifier (usually Alt-Gr)
◆ BRLAPI_KEY_FLG_MOTION_ROUTE
bring screen cursor into braille window after function
◆ BRLAPI_KEY_FLG_MOTION_SCALED
scale arg=0X00-0XFF to screen height
◆ BRLAPI_KEY_FLG_MOTION_TOLEFT
◆ BRLAPI_KEY_FLG_SHIFT
◆ BRLAPI_KEY_FLG_TOGGLE_MASK
mask for all toggle flags
◆ BRLAPI_KEY_FLG_TOGGLE_OFF
◆ BRLAPI_KEY_FLG_TOGGLE_ON
◆ BRLAPI_KEY_FLG_UPPER
◆ BRLAPI_KEY_MAX
#define BRLAPI_KEY_MAX UINT64_C(0XFFFFFFFFFFFFFFFF) |
Brlapi_keyCode_t's biggest value
As defined in <stdint.h>
◆ BRLAPI_KEY_SYM_BACKSPACE
#define BRLAPI_KEY_SYM_BACKSPACE UINT64_C(0X0000FF08) |
◆ BRLAPI_KEY_SYM_DELETE
#define BRLAPI_KEY_SYM_DELETE UINT64_C(0X0000FFFF) |
◆ BRLAPI_KEY_SYM_DOWN
#define BRLAPI_KEY_SYM_DOWN UINT64_C(0X0000FF54) |
◆ BRLAPI_KEY_SYM_END
#define BRLAPI_KEY_SYM_END UINT64_C(0X0000FF57) |
◆ BRLAPI_KEY_SYM_ESCAPE
#define BRLAPI_KEY_SYM_ESCAPE UINT64_C(0X0000FF1B) |
◆ BRLAPI_KEY_SYM_FUNCTION
#define BRLAPI_KEY_SYM_FUNCTION UINT64_C(0X0000FFBE) |
◆ BRLAPI_KEY_SYM_HOME
#define BRLAPI_KEY_SYM_HOME UINT64_C(0X0000FF50) |
◆ BRLAPI_KEY_SYM_INSERT
#define BRLAPI_KEY_SYM_INSERT UINT64_C(0X0000FF63) |
◆ BRLAPI_KEY_SYM_LEFT
#define BRLAPI_KEY_SYM_LEFT UINT64_C(0X0000FF51) |
◆ BRLAPI_KEY_SYM_LINEFEED
#define BRLAPI_KEY_SYM_LINEFEED UINT64_C(0X0000FF0D) |
◆ BRLAPI_KEY_SYM_PAGE_DOWN
#define BRLAPI_KEY_SYM_PAGE_DOWN UINT64_C(0X0000FF56) |
◆ BRLAPI_KEY_SYM_PAGE_UP
#define BRLAPI_KEY_SYM_PAGE_UP UINT64_C(0X0000FF55) |
◆ BRLAPI_KEY_SYM_RIGHT
#define BRLAPI_KEY_SYM_RIGHT UINT64_C(0X0000FF53) |
◆ BRLAPI_KEY_SYM_TAB
#define BRLAPI_KEY_SYM_TAB UINT64_C(0X0000FF09) |
◆ BRLAPI_KEY_SYM_UNICODE
#define BRLAPI_KEY_SYM_UNICODE UINT64_C(0X01000000) |
◆ BRLAPI_KEY_SYM_UP
#define BRLAPI_KEY_SYM_UP UINT64_C(0X0000FF52) |
◆ BRLAPI_KEY_TYPE_CMD
#define BRLAPI_KEY_TYPE_CMD UINT64_C(0X0000000020000000) |
Braille command brlapi_keyCode_t
◆ BRLAPI_KEY_TYPE_MASK
#define BRLAPI_KEY_TYPE_MASK UINT64_C(0X00000000E0000000) |
Mask for type of brlapi_keyCode_t
◆ BRLAPI_KEY_TYPE_SHIFT
#define BRLAPI_KEY_TYPE_SHIFT 29 |
Shift for type of brlapi_keyCode_t
◆ BRLAPI_KEY_TYPE_SYM
#define BRLAPI_KEY_TYPE_SYM UINT64_C(0X0000000000000000) |
X Keysym brlapi_keyCode_t
◆ BRLAPI_KEYCODE_C
#define BRLAPI_KEYCODE_C |
( |
|
value | ) |
UINT64_C(value) |
Define a brlapi_keyCode_t constant
◆ BRLAPI_PRIuKEYCODE
#define BRLAPI_PRIuKEYCODE PRIu64 |
Unsigned decimal print format for brlapi_keyCode_t
◆ BRLAPI_PRIxKEYCODE
#define BRLAPI_PRIxKEYCODE PRIx64 |
Hexadecimal print format for brlapi_keyCode_t
◆ brlapi_keyCode_t