---
name: "brlapi_keycodes"
section: "3"
platform: "linux"
package: "libbrlapi-dev"
version: "6.7-3.1+deb13u3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/brlapi_keycodes"
---

# brlapi\_keycodes(3)

Types and Defines for\\e BrlAPI Key Codes

## NAME

brlapi\_keycodes - Types and Defines for\\e BrlAPI Key Codes

## SYNOPSIS

### Macros

\#define **BRLAPI\_KEYCODE\_C**(value)   UINT64\_C(value)\
 \#define **BRLAPI\_PRIxKEYCODE**   PRIx64\
 \#define **BRLAPI\_PRIuKEYCODE**   PRIu64\
 \#define **BRLAPI\_KEY\_MAX**   UINT64\_C(0XFFFFFFFFFFFFFFFF)\
 \#define **BRLAPI\_KEY\_FLAGS\_MASK**   UINT64\_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\_MOD1**   **BRLAPI\_KEY\_FLG**(0x00000008)\
 \#define **BRLAPI\_KEY\_FLG\_MOD2**   **BRLAPI\_KEY\_FLG**(0x00000010)\
 \#define **BRLAPI\_KEY\_FLG\_MOD3**   **BRLAPI\_KEY\_FLG**(0x00000020)\
 \#define **BRLAPI\_KEY\_FLG\_MOD4**   **BRLAPI\_KEY\_FLG**(0x00000040)\
 \#define **BRLAPI\_KEY\_FLG\_MOD5**   **BRLAPI\_KEY\_FLG**(0x00000080)\
 \#define **BRLAPI\_KEY\_TYPE\_MASK**   UINT64\_C(0X00000000E0000000)\
 \#define **BRLAPI\_KEY\_TYPE\_SHIFT**   29\
 \#define **BRLAPI\_KEY\_TYPE\_CMD**   UINT64\_C(0X0000000020000000)\
 \#define **BRLAPI\_KEY\_TYPE\_SYM**   UINT64\_C(0X0000000000000000)\
 \#define **BRLAPI\_KEY\_CODE\_MASK**   UINT64\_C(0X000000001FFFFFFF)\
 \#define **BRLAPI\_KEY\_CODE\_SHIFT**   0\
 \#define **BRLAPI\_KEY\_CMD\_BLK\_MASK**   UINT64\_C(0X1FFF0000)\
 \#define **BRLAPI\_KEY\_CMD\_BLK\_SHIFT**   16\
 \#define **BRLAPI\_KEY\_CMD\_ARG\_MASK**   UINT64\_C(0X0000FFFF)\
 \#define **BRLAPI\_KEY\_CMD\_ARG\_SHIFT**   0\
 \#define **BRLAPI\_KEY\_CMD**(v)   ((v) \<\< **BRLAPI\_KEY\_CMD\_BLK\_SHIFT**)\
 \#define **BRLAPI\_KEY\_SYM\_BACKSPACE**   UINT64\_C(0X0000FF08)\
 \#define **BRLAPI\_KEY\_SYM\_TAB**   UINT64\_C(0X0000FF09)\
 \#define **BRLAPI\_KEY\_SYM\_LINEFEED**   UINT64\_C(0X0000FF0D)\
 \#define **BRLAPI\_KEY\_SYM\_ESCAPE**   UINT64\_C(0X0000FF1B)\
 \#define **BRLAPI\_KEY\_SYM\_HOME**   UINT64\_C(0X0000FF50)\
 \#define **BRLAPI\_KEY\_SYM\_LEFT**   UINT64\_C(0X0000FF51)\
 \#define **BRLAPI\_KEY\_SYM\_UP**   UINT64\_C(0X0000FF52)\
 \#define **BRLAPI\_KEY\_SYM\_RIGHT**   UINT64\_C(0X0000FF53)\
 \#define **BRLAPI\_KEY\_SYM\_DOWN**   UINT64\_C(0X0000FF54)\
 \#define **BRLAPI\_KEY\_SYM\_PAGE\_UP**   UINT64\_C(0X0000FF55)\
 \#define **BRLAPI\_KEY\_SYM\_PAGE\_DOWN**   UINT64\_C(0X0000FF56)\
 \#define **BRLAPI\_KEY\_SYM\_END**   UINT64\_C(0X0000FF57)\
 \#define **BRLAPI\_KEY\_SYM\_INSERT**   UINT64\_C(0X0000FF63)\
 \#define **BRLAPI\_KEY\_SYM\_FUNCTION**   UINT64\_C(0X0000FFBE)\
 \#define **BRLAPI\_KEY\_SYM\_DELETE**   UINT64\_C(0X0000FFFF)\
 \#define **BRLAPI\_KEY\_SYM\_UNICODE**   UINT64\_C(0X01000000)\
 \#define **BRLAPI\_DRV\_KEY\_PRESS**   **BRLAPI\_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**\

## Detailed Description

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.

## Macro Definition Documentation

### #define BRLAPI\_DOT1 1

upper-left dot of standard braille cell

### #define BRLAPI\_DOT2 2

middle-left dot of standard braille cell

### #define BRLAPI\_DOT3 4

lower-left dot of standard braille cell

### #define BRLAPI\_DOT4 8

upper-right dot of standard braille cell

### #define BRLAPI\_DOT5 16

middle-right dot of standard braille cell

### #define BRLAPI\_DOT6 32

lower-right dot of standard braille cell

### #define BRLAPI\_DOT7 64

lower-left dot of computer braille cell

### #define BRLAPI\_DOT8 128

lower-right dot of computer braille cell

### #define BRLAPI\_DOT\_CHORD 256

space key

### #define BRLAPI\_DOTC 256

chord (space bar on braille keyboard)

### #define BRLAPI\_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

### #define BRLAPI\_DRV\_KEY\_GROUP(code) (((code) & BRLAPI\_DRV\_KEY\_GROUP\_MASK) \>\> BRLAPI\_DRV\_KEY\_GROUP\_SHIFT)

Get key group of brlapi\_keyCode\_t

### #define BRLAPI\_DRV\_KEY\_GROUP\_MASK 0XFF00

Mask for key group of brlapi\_keyCode\_t

### #define BRLAPI\_DRV\_KEY\_GROUP\_SHIFT 8

Shift for key group of brlapi\_keyCode\_t

### #define BRLAPI\_DRV\_KEY\_NUMBER(code) (((code) & BRLAPI\_DRV\_KEY\_NUMBER\_MASK) \>\> BRLAPI\_DRV\_KEY\_NUMBER\_SHIFT)

Get key number of brlapi\_keyCode\_t

### #define BRLAPI\_DRV\_KEY\_NUMBER\_ANY 0XFF

Key number representing any key in the group

### #define BRLAPI\_DRV\_KEY\_NUMBER\_MASK 0XFF

Mask for key number of brlapi\_keyCode\_t

### #define BRLAPI\_DRV\_KEY\_NUMBER\_SHIFT 0

Shift for key number of brlapi\_keyCode\_t

### #define BRLAPI\_DRV\_KEY\_PRESS BRLAPI\_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)

### #define BRLAPI\_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

### #define BRLAPI\_KEY\_CMD(v) ((v) \<\< BRLAPI\_KEY\_CMD\_BLK\_SHIFT)

### #define BRLAPI\_KEY\_CMD\_ALERT BRLAPI\_KEY\_CMD(31)

render an alert

### #define BRLAPI\_KEY\_CMD\_ALTGR (BRLAPI\_KEY\_CMD(0) + 112)

cycle the AltGr (Right Alt) sticky input modifier (next, on, off)

### #define BRLAPI\_KEY\_CMD\_APNDCHARS BRLAPI\_KEY\_CMD(17)

deprecated definition of CLIP\_APPEND - append characters to clipboard

### #define BRLAPI\_KEY\_CMD\_ARG\_MASK UINT64\_C(0X0000FFFF)

Mask for braille command value

### #define BRLAPI\_KEY\_CMD\_ARG\_SHIFT 0

Shift for braille command value

### #define BRLAPI\_KEY\_CMD\_ASPK\_CMP\_WORDS (BRLAPI\_KEY\_CMD(0) + 88)

set autospeak completed words on/off

### #define BRLAPI\_KEY\_CMD\_ASPK\_DEL\_CHARS (BRLAPI\_KEY\_CMD(0) + 86)

set autospeak deleted characters on/off

### #define BRLAPI\_KEY\_CMD\_ASPK\_EMP\_LINE (BRLAPI\_KEY\_CMD(0) + 156)

set autospeak empty line on/off

### #define BRLAPI\_KEY\_CMD\_ASPK\_INDENT (BRLAPI\_KEY\_CMD(0) + 126)

set autospeak indent of current line on/off

### #define BRLAPI\_KEY\_CMD\_ASPK\_INS\_CHARS (BRLAPI\_KEY\_CMD(0) + 85)

set autospeak inserted characters on/off

### #define BRLAPI\_KEY\_CMD\_ASPK\_REP\_CHARS (BRLAPI\_KEY\_CMD(0) + 87)

set autospeak replaced characters on/off

### #define BRLAPI\_KEY\_CMD\_ASPK\_SEL\_CHAR (BRLAPI\_KEY\_CMD(0) + 84)

set autospeak selected character on/off

### #define BRLAPI\_KEY\_CMD\_ASPK\_SEL\_LINE (BRLAPI\_KEY\_CMD(0) + 83)

set autospeak selected line on/off

### #define BRLAPI\_KEY\_CMD\_ATTRBLINK (BRLAPI\_KEY\_CMD(0) + 44)

set attribute blinking on/off

### #define BRLAPI\_KEY\_CMD\_ATTRDN (BRLAPI\_KEY\_CMD(0) + 8)

go down to nearest line with different highlighting

### #define BRLAPI\_KEY\_CMD\_ATTRUP (BRLAPI\_KEY\_CMD(0) + 7)

go up to nearest line with different highlighting

### #define BRLAPI\_KEY\_CMD\_ATTRVIS (BRLAPI\_KEY\_CMD(0) + 43)

set attribute underlining on/off

### #define BRLAPI\_KEY\_CMD\_AUTOREPEAT (BRLAPI\_KEY\_CMD(0) + 47)

set autorepeat on/off

### #define BRLAPI\_KEY\_CMD\_AUTOSPEAK (BRLAPI\_KEY\_CMD(0) + 48)

set autospeak on/off

### #define BRLAPI\_KEY\_CMD\_BACK (BRLAPI\_KEY\_CMD(0) + 30)

go back after cursor tracking

### #define BRLAPI\_KEY\_CMD\_BLK\_MASK UINT64\_C(0X1FFF0000)

Mask for braille command type

### #define BRLAPI\_KEY\_CMD\_BLK\_SHIFT 16

Shift for braille command type

### #define BRLAPI\_KEY\_CMD\_BOT (BRLAPI\_KEY\_CMD(0) + 10)

go to bottom line

### #define BRLAPI\_KEY\_CMD\_BOT\_LEFT (BRLAPI\_KEY\_CMD(0) + 12)

go to beginning of bottom line

### #define BRLAPI\_KEY\_CMD\_BRL\_START (BRLAPI\_KEY\_CMD(0) + 115)

start the braille driver

### #define BRLAPI\_KEY\_CMD\_BRL\_STOP (BRLAPI\_KEY\_CMD(0) + 114)

stop the braille driver

### #define BRLAPI\_KEY\_CMD\_BRLKBD (BRLAPI\_KEY\_CMD(0) + 110)

set braille keyboard enabled/disabled

### #define BRLAPI\_KEY\_CMD\_BRLUCDOTS (BRLAPI\_KEY\_CMD(0) + 109)

set braille typing mode dots/text

### #define BRLAPI\_KEY\_CMD\_CAPBLINK (BRLAPI\_KEY\_CMD(0) + 45)

set capital letter blinking on/off

### #define BRLAPI\_KEY\_CMD\_CHRLT (BRLAPI\_KEY\_CMD(0) + 19)

go left one character

### #define BRLAPI\_KEY\_CMD\_CHRRT (BRLAPI\_KEY\_CMD(0) + 20)

go right one character

### #define BRLAPI\_KEY\_CMD\_CLIP\_ADD BRLAPI\_KEY\_CMD(3)

append to clipboard from character

### #define BRLAPI\_KEY\_CMD\_CLIP\_APPEND BRLAPI\_KEY\_CMD(17)

append characters to clipboard

### #define BRLAPI\_KEY\_CMD\_CLIP\_COPY BRLAPI\_KEY\_CMD(16)

copy characters to clipboard

### #define BRLAPI\_KEY\_CMD\_CLIP\_NEW BRLAPI\_KEY\_CMD(2)

start new clipboard at character

### #define BRLAPI\_KEY\_CMD\_CLIP\_RESTORE (BRLAPI\_KEY\_CMD(0) + 108)

restore clipboard from disk

### #define BRLAPI\_KEY\_CMD\_CLIP\_SAVE (BRLAPI\_KEY\_CMD(0) + 107)

save clipboard to disk

### #define BRLAPI\_KEY\_CMD\_COMPBRL6 (BRLAPI\_KEY\_CMD(0) + 154)

set six/eight dot computer braille

### #define BRLAPI\_KEY\_CMD\_CONTEXT BRLAPI\_KEY\_CMD(38)

switch to command context

### #define BRLAPI\_KEY\_CMD\_CONTRACTED (BRLAPI\_KEY\_CMD(0) + 153)

set contracted/computer braille

### #define BRLAPI\_KEY\_CMD\_CONTROL (BRLAPI\_KEY\_CMD(0) + 79)

cycle the Control sticky input modifier (next, on, off)

### #define BRLAPI\_KEY\_CMD\_COPY\_LINE BRLAPI\_KEY\_CMD(5)

linear copy to character

### #define BRLAPI\_KEY\_CMD\_COPY\_RECT BRLAPI\_KEY\_CMD(4)

rectangular copy to character

### #define BRLAPI\_KEY\_CMD\_COPYCHARS BRLAPI\_KEY\_CMD(16)

deprecated definition of CLIP\_COPY - copy characters to clipboard

### #define BRLAPI\_KEY\_CMD\_CSRBLINK (BRLAPI\_KEY\_CMD(0) + 42)

set screen cursor blinking on/off

### #define BRLAPI\_KEY\_CMD\_CSRHIDE (BRLAPI\_KEY\_CMD(0) + 39)

set hidden screen cursor on/off

### #define BRLAPI\_KEY\_CMD\_CSRJMP\_VERT (BRLAPI\_KEY\_CMD(0) + 72)

bring screen cursor to current line

### #define BRLAPI\_KEY\_CMD\_CSRSIZE (BRLAPI\_KEY\_CMD(0) + 41)

set screen cursor style block/underline

### #define BRLAPI\_KEY\_CMD\_CSRTRK (BRLAPI\_KEY\_CMD(0) + 40)

set track screen cursor on/off

### #define BRLAPI\_KEY\_CMD\_CSRVIS (BRLAPI\_KEY\_CMD(0) + 38)

set screen cursor visibility on/off

### #define BRLAPI\_KEY\_CMD\_CUTAPPEND BRLAPI\_KEY\_CMD(3)

deprecated definition of CLIP\_ADD - append to clipboard from character

### #define BRLAPI\_KEY\_CMD\_CUTBEGIN BRLAPI\_KEY\_CMD(2)

deprecated definition of CLIP\_NEW - start new clipboard at character

### #define BRLAPI\_KEY\_CMD\_CUTLINE BRLAPI\_KEY\_CMD(5)

deprecated definition of COPY\_LINE - linear copy to character

### #define BRLAPI\_KEY\_CMD\_CUTRECT BRLAPI\_KEY\_CMD(4)

deprecated definition of COPY\_RECT - rectangular copy to character

### #define BRLAPI\_KEY\_CMD\_DESC\_CURR\_CHAR (BRLAPI\_KEY\_CMD(0) + 102)

describe current character

### #define BRLAPI\_KEY\_CMD\_DESCCHAR BRLAPI\_KEY\_CMD(9)

describe character

### #define BRLAPI\_KEY\_CMD\_DISPMD (BRLAPI\_KEY\_CMD(0) + 33)

set display mode attributes/text

### #define BRLAPI\_KEY\_CMD\_FREEZE (BRLAPI\_KEY\_CMD(0) + 32)

set screen image frozen/unfrozen

### #define BRLAPI\_KEY\_CMD\_FWINLT (BRLAPI\_KEY\_CMD(0) + 23)

go backward one braille window

### #define BRLAPI\_KEY\_CMD\_FWINLTSKIP (BRLAPI\_KEY\_CMD(0) + 25)

go backward skipping blank braille windows

### #define BRLAPI\_KEY\_CMD\_FWINRT (BRLAPI\_KEY\_CMD(0) + 24)

go forward one braille window

### #define BRLAPI\_KEY\_CMD\_FWINRTSKIP (BRLAPI\_KEY\_CMD(0) + 26)

go forward skipping blank braille windows

### #define BRLAPI\_KEY\_CMD\_GOTOLINE BRLAPI\_KEY\_CMD(13)

go to selected line

### #define BRLAPI\_KEY\_CMD\_GOTOMARK BRLAPI\_KEY\_CMD(12)

go to remembered braille window position

### #define BRLAPI\_KEY\_CMD\_GUI (BRLAPI\_KEY\_CMD(0) + 113)

cycle the GUI (Windows) sticky input modifier (next, on, off)

### #define BRLAPI\_KEY\_CMD\_GUI\_APP\_ALERTS (BRLAPI\_KEY\_CMD(0) + 142)

open the application alerts window

### #define BRLAPI\_KEY\_CMD\_GUI\_APP\_LIST (BRLAPI\_KEY\_CMD(0) + 140)

open the application list window

### #define BRLAPI\_KEY\_CMD\_GUI\_APP\_MENU (BRLAPI\_KEY\_CMD(0) + 141)

open the application-specific menu

### #define BRLAPI\_KEY\_CMD\_GUI\_AREA\_ACTV (BRLAPI\_KEY\_CMD(0) + 143)

return to the active screen area

### #define BRLAPI\_KEY\_CMD\_GUI\_AREA\_NEXT (BRLAPI\_KEY\_CMD(0) + 145)

switch to the next screen area

### #define BRLAPI\_KEY\_CMD\_GUI\_AREA\_PREV (BRLAPI\_KEY\_CMD(0) + 144)

switch to the previous screen area

### #define BRLAPI\_KEY\_CMD\_GUI\_BACK (BRLAPI\_KEY\_CMD(0) + 137)

go back to the previous screen

### #define BRLAPI\_KEY\_CMD\_GUI\_BRL\_ACTIONS (BRLAPI\_KEY\_CMD(0) + 135)

open the braille actions window

### #define BRLAPI\_KEY\_CMD\_GUI\_DEV\_OPTIONS (BRLAPI\_KEY\_CMD(0) + 139)

open the device options window

### #define BRLAPI\_KEY\_CMD\_GUI\_DEV\_SETTINGS (BRLAPI\_KEY\_CMD(0) + 138)

open the device settings window

### #define BRLAPI\_KEY\_CMD\_GUI\_HOME (BRLAPI\_KEY\_CMD(0) + 136)

go to the home screen

### #define BRLAPI\_KEY\_CMD\_GUI\_ITEM\_FRST (BRLAPI\_KEY\_CMD(0) + 146)

move to the first item in the screen area

### #define BRLAPI\_KEY\_CMD\_GUI\_ITEM\_LAST (BRLAPI\_KEY\_CMD(0) + 149)

move to the last item in the screen area

### #define BRLAPI\_KEY\_CMD\_GUI\_ITEM\_NEXT (BRLAPI\_KEY\_CMD(0) + 148)

move to the next item in the screen area

### #define BRLAPI\_KEY\_CMD\_GUI\_ITEM\_PREV (BRLAPI\_KEY\_CMD(0) + 147)

move to the previous item in the screen area

### #define BRLAPI\_KEY\_CMD\_GUI\_TITLE (BRLAPI\_KEY\_CMD(0) + 134)

show the window title

### #define BRLAPI\_KEY\_CMD\_HELP (BRLAPI\_KEY\_CMD(0) + 49)

enter/leave help display

### #define BRLAPI\_KEY\_CMD\_HOME (BRLAPI\_KEY\_CMD(0) + 29)

go to screen cursor

### #define BRLAPI\_KEY\_CMD\_HOST\_COPY (BRLAPI\_KEY\_CMD(0) + 131)

copy selected text to host clipboard

### #define BRLAPI\_KEY\_CMD\_HOST\_CUT (BRLAPI\_KEY\_CMD(0) + 132)

cut selected text to host clipboard

### #define BRLAPI\_KEY\_CMD\_HOST\_PASTE (BRLAPI\_KEY\_CMD(0) + 133)

insert host clipboard text after screen cursor

### #define BRLAPI\_KEY\_CMD\_HOSTCMD BRLAPI\_KEY\_CMD(41)

run host command

### #define BRLAPI\_KEY\_CMD\_HWINLT (BRLAPI\_KEY\_CMD(0) + 21)

go left half a braille window

### #define BRLAPI\_KEY\_CMD\_HWINRT (BRLAPI\_KEY\_CMD(0) + 22)

go right half a braille window

### #define BRLAPI\_KEY\_CMD\_INDICATORS (BRLAPI\_KEY\_CMD(0) + 128)

show various device status indicators

### #define BRLAPI\_KEY\_CMD\_INFO (BRLAPI\_KEY\_CMD(0) + 50)

enter/leave status display

### #define BRLAPI\_KEY\_CMD\_LEARN (BRLAPI\_KEY\_CMD(0) + 51)

enter/leave command learn mode

### #define BRLAPI\_KEY\_CMD\_LNBEG (BRLAPI\_KEY\_CMD(0) + 27)

go to beginning of line

### #define BRLAPI\_KEY\_CMD\_LNDN (BRLAPI\_KEY\_CMD(0) + 2)

go down one line

### #define BRLAPI\_KEY\_CMD\_LNEND (BRLAPI\_KEY\_CMD(0) + 28)

go to end of line

### #define BRLAPI\_KEY\_CMD\_LNUP (BRLAPI\_KEY\_CMD(0) + 1)

go up one line

### #define BRLAPI\_KEY\_CMD\_MACRO BRLAPI\_KEY\_CMD(40)

execute command macro

### #define BRLAPI\_KEY\_CMD\_MENU\_FIRST\_ITEM (BRLAPI\_KEY\_CMD(0) + 55)

go up to first item

### #define BRLAPI\_KEY\_CMD\_MENU\_LAST\_ITEM (BRLAPI\_KEY\_CMD(0) + 56)

go down to last item

### #define BRLAPI\_KEY\_CMD\_MENU\_NEXT\_ITEM (BRLAPI\_KEY\_CMD(0) + 58)

go down to next item

### #define BRLAPI\_KEY\_CMD\_MENU\_NEXT\_SETTING (BRLAPI\_KEY\_CMD(0) + 60)

select next choice

### #define BRLAPI\_KEY\_CMD\_MENU\_PREV\_ITEM (BRLAPI\_KEY\_CMD(0) + 57)

go up to previous item

### #define BRLAPI\_KEY\_CMD\_MENU\_PREV\_LEVEL (BRLAPI\_KEY\_CMD(0) + 82)

go to previous menu level

### #define BRLAPI\_KEY\_CMD\_MENU\_PREV\_SETTING (BRLAPI\_KEY\_CMD(0) + 59)

select previous choice

### #define BRLAPI\_KEY\_CMD\_META (BRLAPI\_KEY\_CMD(0) + 80)

cycle the Meta (Left Alt) sticky input modifier (next, on, off)

### #define BRLAPI\_KEY\_CMD\_MUTE (BRLAPI\_KEY\_CMD(0) + 61)

stop speaking

### #define BRLAPI\_KEY\_CMD\_NOOP (BRLAPI\_KEY\_CMD(0) + 0)

do nothing

### #define BRLAPI\_KEY\_CMD\_NXDIFCHAR BRLAPI\_KEY\_CMD(15)

go down to nearest line with different character

### #define BRLAPI\_KEY\_CMD\_NXDIFLN (BRLAPI\_KEY\_CMD(0) + 6)

go down to nearest line with different content

### #define BRLAPI\_KEY\_CMD\_NXINDENT BRLAPI\_KEY\_CMD(8)

go down to nearest line with less indent than character

### #define BRLAPI\_KEY\_CMD\_NXNBWIN (BRLAPI\_KEY\_CMD(0) + 123)

go forward to nearest non-blank braille window

### #define BRLAPI\_KEY\_CMD\_NXPGRPH (BRLAPI\_KEY\_CMD(0) + 14)

go down to first line of next paragraph

### #define BRLAPI\_KEY\_CMD\_NXPROMPT (BRLAPI\_KEY\_CMD(0) + 16)

go down to next command prompt

### #define BRLAPI\_KEY\_CMD\_NXSEARCH (BRLAPI\_KEY\_CMD(0) + 18)

search forward for clipboard text

### #define BRLAPI\_KEY\_CMD\_OFFLINE (BRLAPI\_KEY\_CMD(0) + 76)

braille display temporarily unavailable

### #define BRLAPI\_KEY\_CMD\_PASSAT BRLAPI\_KEY\_CMD(35)

AT (set 2) keyboard scan code

### #define BRLAPI\_KEY\_CMD\_PASSDOTS BRLAPI\_KEY\_CMD(34)

type braille dots

### #define BRLAPI\_KEY\_CMD\_PASSPS2 BRLAPI\_KEY\_CMD(37)

PS/2 (set 3) keyboard scan code

### #define BRLAPI\_KEY\_CMD\_PASSXT BRLAPI\_KEY\_CMD(36)

XT (set 1) keyboard scan code

### #define BRLAPI\_KEY\_CMD\_PASTE (BRLAPI\_KEY\_CMD(0) + 73)

insert clipboard text after screen cursor

### #define BRLAPI\_KEY\_CMD\_PASTE\_HISTORY BRLAPI\_KEY\_CMD(18)

insert clipboard history entry after screen cursor

### #define BRLAPI\_KEY\_CMD\_PRDIFCHAR BRLAPI\_KEY\_CMD(14)

go up to nearest line with different character

### #define BRLAPI\_KEY\_CMD\_PRDIFLN (BRLAPI\_KEY\_CMD(0) + 5)

go up to nearest line with different content

### #define BRLAPI\_KEY\_CMD\_PREFLOAD (BRLAPI\_KEY\_CMD(0) + 54)

restore preferences from disk

### #define BRLAPI\_KEY\_CMD\_PREFMENU (BRLAPI\_KEY\_CMD(0) + 52)

enter/leave preferences menu

### #define BRLAPI\_KEY\_CMD\_PREFRESET (BRLAPI\_KEY\_CMD(0) + 155)

reset preferences to defaults

### #define BRLAPI\_KEY\_CMD\_PREFSAVE (BRLAPI\_KEY\_CMD(0) + 53)

save preferences to disk

### #define BRLAPI\_KEY\_CMD\_PRINDENT BRLAPI\_KEY\_CMD(7)

go up to nearest line with less indent than character

### #define BRLAPI\_KEY\_CMD\_PRNBWIN (BRLAPI\_KEY\_CMD(0) + 122)

go backward to nearest non-blank braille window

### #define BRLAPI\_KEY\_CMD\_PRPGRPH (BRLAPI\_KEY\_CMD(0) + 13)

go up to first line of paragraph

### #define BRLAPI\_KEY\_CMD\_PRPROMPT (BRLAPI\_KEY\_CMD(0) + 15)

go up to previous command prompt

### #define BRLAPI\_KEY\_CMD\_PRSEARCH (BRLAPI\_KEY\_CMD(0) + 17)

search backward for clipboard text

### #define BRLAPI\_KEY\_CMD\_REFRESH (BRLAPI\_KEY\_CMD(0) + 127)

refresh braille display

### #define BRLAPI\_KEY\_CMD\_REFRESH\_LINE BRLAPI\_KEY\_CMD(25)

refresh braille line

### #define BRLAPI\_KEY\_CMD\_RESTARTBRL (BRLAPI\_KEY\_CMD(0) + 74)

restart braille driver

### #define BRLAPI\_KEY\_CMD\_RESTARTSPEECH (BRLAPI\_KEY\_CMD(0) + 75)

restart speech driver

### #define BRLAPI\_KEY\_CMD\_RETURN (BRLAPI\_KEY\_CMD(0) + 31)

go to screen cursor or go back after cursor tracking

### #define BRLAPI\_KEY\_CMD\_ROUTE BRLAPI\_KEY\_CMD(1)

bring screen cursor to character

### #define BRLAPI\_KEY\_CMD\_ROUTE\_CURR\_LOCN (BRLAPI\_KEY\_CMD(0) + 104)

bring screen cursor to speech cursor

### #define BRLAPI\_KEY\_CMD\_ROUTE\_LINE BRLAPI\_KEY\_CMD(24)

bring screen cursor to line

### #define BRLAPI\_KEY\_CMD\_ROUTE\_SPEECH BRLAPI\_KEY\_CMD(28)

bring speech cursor to character

### #define BRLAPI\_KEY\_CMD\_SAY\_ABOVE (BRLAPI\_KEY\_CMD(0) + 64)

speak from top of screen through current line

### #define BRLAPI\_KEY\_CMD\_SAY\_ALL (BRLAPI\_KEY\_CMD(0) + 152)

speak from top of screen through bottom of screen

### #define BRLAPI\_KEY\_CMD\_SAY\_BELOW (BRLAPI\_KEY\_CMD(0) + 65)

speak from current line through bottom of screen

### #define BRLAPI\_KEY\_CMD\_SAY\_FASTER (BRLAPI\_KEY\_CMD(0) + 67)

increase speaking rate

### #define BRLAPI\_KEY\_CMD\_SAY\_HIGHER (BRLAPI\_KEY\_CMD(0) + 151)

increase speaking pitch

### #define BRLAPI\_KEY\_CMD\_SAY\_LINE (BRLAPI\_KEY\_CMD(0) + 63)

speak current line

### #define BRLAPI\_KEY\_CMD\_SAY\_LOUDER (BRLAPI\_KEY\_CMD(0) + 69)

increase speaking volume

### #define BRLAPI\_KEY\_CMD\_SAY\_LOWER (BRLAPI\_KEY\_CMD(0) + 150)

decrease speaking pitch

### #define BRLAPI\_KEY\_CMD\_SAY\_SLOWER (BRLAPI\_KEY\_CMD(0) + 66)

decrease speaking rate

### #define BRLAPI\_KEY\_CMD\_SAY\_SOFTER (BRLAPI\_KEY\_CMD(0) + 68)

decrease speaking volume

### #define BRLAPI\_KEY\_CMD\_SCR\_START (BRLAPI\_KEY\_CMD(0) + 119)

start the screen driver

### #define BRLAPI\_KEY\_CMD\_SCR\_STOP (BRLAPI\_KEY\_CMD(0) + 118)

stop the screen driver

### #define BRLAPI\_KEY\_CMD\_SELECTVT BRLAPI\_KEY\_CMD(30)

bind to specific virtual terminal

### #define BRLAPI\_KEY\_CMD\_SELECTVT\_NEXT (BRLAPI\_KEY\_CMD(0) + 121)

bind to the next virtual terminal

### #define BRLAPI\_KEY\_CMD\_SELECTVT\_PREV (BRLAPI\_KEY\_CMD(0) + 120)

bind to the previous virtual terminal

### #define BRLAPI\_KEY\_CMD\_SET\_ATTRIBUTES\_TABLE BRLAPI\_KEY\_CMD(20)

set attributes table

### #define BRLAPI\_KEY\_CMD\_SET\_CONTRACTION\_TABLE BRLAPI\_KEY\_CMD(21)

set contraction table

### #define BRLAPI\_KEY\_CMD\_SET\_KEYBOARD\_TABLE BRLAPI\_KEY\_CMD(22)

set keyboard table

### #define BRLAPI\_KEY\_CMD\_SET\_LANGUAGE\_PROFILE BRLAPI\_KEY\_CMD(23)

set language profile

### #define BRLAPI\_KEY\_CMD\_SET\_TEXT\_TABLE BRLAPI\_KEY\_CMD(19)

set text table

### #define BRLAPI\_KEY\_CMD\_SETLEFT BRLAPI\_KEY\_CMD(10)

place left end of braille window at character

### #define BRLAPI\_KEY\_CMD\_SETMARK BRLAPI\_KEY\_CMD(11)

remember current braille window position

### #define BRLAPI\_KEY\_CMD\_SHIFT (BRLAPI\_KEY\_CMD(0) + 77)

cycle the Shift sticky input modifier (next, on, off)

### #define BRLAPI\_KEY\_CMD\_SHOW\_CURR\_LOCN (BRLAPI\_KEY\_CMD(0) + 106)

set speech cursor visibility on/off

### #define BRLAPI\_KEY\_CMD\_SIXDOTS (BRLAPI\_KEY\_CMD(0) + 34)

set text style 6-dot/8-dot

### #define BRLAPI\_KEY\_CMD\_SKPBLNKWINS (BRLAPI\_KEY\_CMD(0) + 37)

set skipping of blank braille windows on/off

### #define BRLAPI\_KEY\_CMD\_SKPIDLNS (BRLAPI\_KEY\_CMD(0) + 36)

set skipping of lines with identical content on/off

### #define BRLAPI\_KEY\_CMD\_SLIDEWIN (BRLAPI\_KEY\_CMD(0) + 35)

set sliding braille window on/off

### #define BRLAPI\_KEY\_CMD\_SPEAK\_CURR\_CHAR (BRLAPI\_KEY\_CMD(0) + 89)

speak current character

### #define BRLAPI\_KEY\_CMD\_SPEAK\_CURR\_LINE (BRLAPI\_KEY\_CMD(0) + 95)

speak current line

### #define BRLAPI\_KEY\_CMD\_SPEAK\_CURR\_LOCN (BRLAPI\_KEY\_CMD(0) + 105)

speak speech cursor location

### #define BRLAPI\_KEY\_CMD\_SPEAK\_CURR\_WORD (BRLAPI\_KEY\_CMD(0) + 92)

speak current word

### #define BRLAPI\_KEY\_CMD\_SPEAK\_FRST\_CHAR (BRLAPI\_KEY\_CMD(0) + 98)

go to and speak first non-blank character on line

### #define BRLAPI\_KEY\_CMD\_SPEAK\_FRST\_LINE (BRLAPI\_KEY\_CMD(0) + 100)

go to and speak first non-blank line on screen

### #define BRLAPI\_KEY\_CMD\_SPEAK\_INDENT (BRLAPI\_KEY\_CMD(0) + 125)

speak indent of current line

### #define BRLAPI\_KEY\_CMD\_SPEAK\_LAST\_CHAR (BRLAPI\_KEY\_CMD(0) + 99)

go to and speak last non-blank character on line

### #define BRLAPI\_KEY\_CMD\_SPEAK\_LAST\_LINE (BRLAPI\_KEY\_CMD(0) + 101)

go to and speak last non-blank line on screen

### #define BRLAPI\_KEY\_CMD\_SPEAK\_NEXT\_CHAR (BRLAPI\_KEY\_CMD(0) + 91)

go to and speak next character

### #define BRLAPI\_KEY\_CMD\_SPEAK\_NEXT\_LINE (BRLAPI\_KEY\_CMD(0) + 97)

go to and speak next line

### #define BRLAPI\_KEY\_CMD\_SPEAK\_NEXT\_WORD (BRLAPI\_KEY\_CMD(0) + 94)

go to and speak next word

### #define BRLAPI\_KEY\_CMD\_SPEAK\_PREV\_CHAR (BRLAPI\_KEY\_CMD(0) + 90)

go to and speak previous character

### #define BRLAPI\_KEY\_CMD\_SPEAK\_PREV\_LINE (BRLAPI\_KEY\_CMD(0) + 96)

go to and speak previous line

### #define BRLAPI\_KEY\_CMD\_SPEAK\_PREV\_WORD (BRLAPI\_KEY\_CMD(0) + 93)

go to and speak previous word

### #define BRLAPI\_KEY\_CMD\_SPELL\_CURR\_WORD (BRLAPI\_KEY\_CMD(0) + 103)

spell current word

### #define BRLAPI\_KEY\_CMD\_SPK\_START (BRLAPI\_KEY\_CMD(0) + 117)

start the speech driver

### #define BRLAPI\_KEY\_CMD\_SPK\_STOP (BRLAPI\_KEY\_CMD(0) + 116)

stop the speech driver

### #define BRLAPI\_KEY\_CMD\_SPKHOME (BRLAPI\_KEY\_CMD(0) + 62)

go to current speaking position

### #define BRLAPI\_KEY\_CMD\_SWITCHVT BRLAPI\_KEY\_CMD(6)

switch to specific virtual terminal

### #define BRLAPI\_KEY\_CMD\_SWITCHVT\_NEXT (BRLAPI\_KEY\_CMD(0) + 71)

switch to the next virtual terminal

### #define BRLAPI\_KEY\_CMD\_SWITCHVT\_PREV (BRLAPI\_KEY\_CMD(0) + 70)

switch to the previous virtual terminal

### #define BRLAPI\_KEY\_CMD\_TIME (BRLAPI\_KEY\_CMD(0) + 81)

show current date and time

### #define BRLAPI\_KEY\_CMD\_TOP (BRLAPI\_KEY\_CMD(0) + 9)

go to top line

### #define BRLAPI\_KEY\_CMD\_TOP\_LEFT (BRLAPI\_KEY\_CMD(0) + 11)

go to beginning of top line

### #define BRLAPI\_KEY\_CMD\_TOUCH\_AT BRLAPI\_KEY\_CMD(39)

current reading location

### #define BRLAPI\_KEY\_CMD\_TOUCH\_NAV (BRLAPI\_KEY\_CMD(0) + 124)

set touch navigation on/off

### #define BRLAPI\_KEY\_CMD\_TUNES (BRLAPI\_KEY\_CMD(0) + 46)

set alert tunes on/off

### #define BRLAPI\_KEY\_CMD\_TXTSEL\_ALL (BRLAPI\_KEY\_CMD(0) + 130)

select all of the text

### #define BRLAPI\_KEY\_CMD\_TXTSEL\_CLEAR (BRLAPI\_KEY\_CMD(0) + 129)

clear the text selection

### #define BRLAPI\_KEY\_CMD\_TXTSEL\_SET BRLAPI\_KEY\_CMD(27)

set text selection

### #define BRLAPI\_KEY\_CMD\_TXTSEL\_START BRLAPI\_KEY\_CMD(26)

start text selection

### #define BRLAPI\_KEY\_CMD\_UNSTICK (BRLAPI\_KEY\_CMD(0) + 111)

clear all sticky input modifiers

### #define BRLAPI\_KEY\_CMD\_UPPER (BRLAPI\_KEY\_CMD(0) + 78)

cycle the Upper sticky input modifier (next, on, off)

### #define BRLAPI\_KEY\_CMD\_WINDN (BRLAPI\_KEY\_CMD(0) + 4)

go down several lines

### #define BRLAPI\_KEY\_CMD\_WINUP (BRLAPI\_KEY\_CMD(0) + 3)

go up several lines

### #define BRLAPI\_KEY\_CODE\_MASK UINT64\_C(0X000000001FFFFFFF)

Mask for code of brlapi\_keyCode\_t

### #define BRLAPI\_KEY\_CODE\_SHIFT 0

Shift for code of brlapi\_keyCode\_t

### #define BRLAPI\_KEY\_FLAGS\_MASK UINT64\_C(0XFFFFFFFF00000000)

Mask for flags of brlapi\_keyCode\_t

### #define BRLAPI\_KEY\_FLAGS\_SHIFT 32

Shift for flags of brlapi\_keyCode\_t

### #define BRLAPI\_KEY\_FLG(v) ((brlapi\_keyCode\_t)(v) \<\< BRLAPI\_KEY\_FLAGS\_SHIFT)

### #define BRLAPI\_KEY\_FLG\_ALTGR BRLAPI\_KEY\_FLG(0X10)

altgr (right alt) key pressed

### #define BRLAPI\_KEY\_FLG\_CAPSLOCK BRLAPI\_KEY\_FLG(0X80)

capslock key pressed

### #define BRLAPI\_KEY\_FLG\_CONTROL BRLAPI\_KEY\_FLG(0X04)

control key pressed

### #define BRLAPI\_KEY\_FLG\_ESCAPED BRLAPI\_KEY\_FLG(0X40)

prefix with escape

### #define BRLAPI\_KEY\_FLG\_GUI BRLAPI\_KEY\_FLG(0X20)

gui (windows) key pressed

### #define BRLAPI\_KEY\_FLG\_KBD\_EMUL0 BRLAPI\_KEY\_FLG(0X0200)

it is an emulation 0 scan code

### #define BRLAPI\_KEY\_FLG\_KBD\_EMUL1 BRLAPI\_KEY\_FLG(0X0400)

it is an emulation 1 scan code

### #define BRLAPI\_KEY\_FLG\_KBD\_RELEASE BRLAPI\_KEY\_FLG(0X0100)

it is a release scan code

### #define BRLAPI\_KEY\_FLG\_META BRLAPI\_KEY\_FLG(0X08)

meta (left alt) key pressed

### #define BRLAPI\_KEY\_FLG\_MOD1 BRLAPI\_KEY\_FLG(0x00000008)

Standard X modifiers Mod1 modifier (AKA meta)

### #define BRLAPI\_KEY\_FLG\_MOD2 BRLAPI\_KEY\_FLG(0x00000010)

Mod2 modifier (usually numlock)

### #define BRLAPI\_KEY\_FLG\_MOD3 BRLAPI\_KEY\_FLG(0x00000020)

Mod3 modifier

### #define BRLAPI\_KEY\_FLG\_MOD4 BRLAPI\_KEY\_FLG(0x00000040)

Mod4 modifier

### #define BRLAPI\_KEY\_FLG\_MOD5 BRLAPI\_KEY\_FLG(0x00000080)

Mod5 modifier (usually Alt-Gr)

### #define BRLAPI\_KEY\_FLG\_MOTION\_ROUTE BRLAPI\_KEY\_FLG(0X0400)

bring screen cursor into braille window after function

### #define BRLAPI\_KEY\_FLG\_MOTION\_SCALED BRLAPI\_KEY\_FLG(0X0800)

scale arg=0X00-0XFF to screen height

### #define BRLAPI\_KEY\_FLG\_MOTION\_TOLEFT BRLAPI\_KEY\_FLG(0X1000)

go to beginning of line

### #define BRLAPI\_KEY\_FLG\_SHIFT BRLAPI\_KEY\_FLG(0X01)

shift key pressed

### #define BRLAPI\_KEY\_FLG\_TOGGLE\_MASK (BRLAPI\_KEY\_FLG\_TOGGLE\_ON \| BRLAPI\_KEY\_FLG\_TOGGLE\_OFF)

mask for all toggle flags

### #define BRLAPI\_KEY\_FLG\_TOGGLE\_OFF BRLAPI\_KEY\_FLG(0X0200)

disable feature

### #define BRLAPI\_KEY\_FLG\_TOGGLE\_ON BRLAPI\_KEY\_FLG(0X0100)

enable feature

### #define BRLAPI\_KEY\_FLG\_UPPER BRLAPI\_KEY\_FLG(0X02)

convert to uppercase

### #define BRLAPI\_KEY\_MAX UINT64\_C(0XFFFFFFFFFFFFFFFF)

Brlapi\_keyCode\_t's biggest value

As defined in `<stdint.h>`

### #define BRLAPI\_KEY\_SYM\_BACKSPACE UINT64\_C(0X0000FF08)

Standard X keysyms

### #define BRLAPI\_KEY\_SYM\_DELETE UINT64\_C(0X0000FFFF)

### #define BRLAPI\_KEY\_SYM\_DOWN UINT64\_C(0X0000FF54)

### #define BRLAPI\_KEY\_SYM\_END UINT64\_C(0X0000FF57)

### #define BRLAPI\_KEY\_SYM\_ESCAPE UINT64\_C(0X0000FF1B)

### #define BRLAPI\_KEY\_SYM\_FUNCTION UINT64\_C(0X0000FFBE)

### #define BRLAPI\_KEY\_SYM\_HOME UINT64\_C(0X0000FF50)

### #define BRLAPI\_KEY\_SYM\_INSERT UINT64\_C(0X0000FF63)

### #define BRLAPI\_KEY\_SYM\_LEFT UINT64\_C(0X0000FF51)

### #define BRLAPI\_KEY\_SYM\_LINEFEED UINT64\_C(0X0000FF0D)

### #define BRLAPI\_KEY\_SYM\_PAGE\_DOWN UINT64\_C(0X0000FF56)

### #define BRLAPI\_KEY\_SYM\_PAGE\_UP UINT64\_C(0X0000FF55)

### #define BRLAPI\_KEY\_SYM\_RIGHT UINT64\_C(0X0000FF53)

### #define BRLAPI\_KEY\_SYM\_TAB UINT64\_C(0X0000FF09)

### #define BRLAPI\_KEY\_SYM\_UNICODE UINT64\_C(0X01000000)

### #define BRLAPI\_KEY\_SYM\_UP UINT64\_C(0X0000FF52)

### #define BRLAPI\_KEY\_TYPE\_CMD UINT64\_C(0X0000000020000000)

Braille command brlapi\_keyCode\_t

### #define BRLAPI\_KEY\_TYPE\_MASK UINT64\_C(0X00000000E0000000)

Mask for type of brlapi\_keyCode\_t

### #define BRLAPI\_KEY\_TYPE\_SHIFT 29

Shift for type of brlapi\_keyCode\_t

### #define BRLAPI\_KEY\_TYPE\_SYM UINT64\_C(0X0000000000000000)

X Keysym brlapi\_keyCode\_t

### #define BRLAPI\_KEYCODE\_C(value) UINT64\_C(value)

Define a brlapi\_keyCode\_t constant

### #define BRLAPI\_PRIuKEYCODE PRIu64

Unsigned decimal print format for brlapi\_keyCode\_t

### #define BRLAPI\_PRIxKEYCODE PRIx64

Hexadecimal print format for brlapi\_keyCode\_t

## Typedef Documentation

### typedef uint64\_t brlapi\_keyCode\_t

## Author

Generated automatically by Doxygen for BrlAPI from the source code.