Defines | |
#define | BRL_KEYBUF_SIZE 256 |
#define | BRL_KEYCODE_MAX ((brl_keycode_t) (UINT32_MAX)) |
Typedefs | |
typedef uint32_t | brl_keycode_t |
Functions | |
int | brlapi_readKey (int block, brl_keycode_t *code) |
int | brlapi_readCommand (int block, brl_keycode_t *code) |
int | brlapi_ignoreKeys (brl_keycode_t x, brl_keycode_t y) |
int | brlapi_unignoreKeys (brl_keycode_t x, brl_keycode_t y) |
key presses are buffered, so that calling brlapi_readKey() in non-blocking mode from times to times should suffice.
|
buffer size key presses won't be lost provided no more than BRL_KEYBUF_SIZE key presses are done between two calls to brlapi_read* if a call to another function is done in the meanwhile (which needs somewhere to put them before being able to get responses from the server) |
|
brl_keycode_t's biggest value
As defined in |
|
type for key codes Its size is 32 bits, so driver implementors have to restrict themselves to a 32 bit space. |
|
Ignore some key presses from the braille keyboard This function asks the server to give keys between x and y to brltty, rather than returning them to the application via brlapi_read(Key|Command)()
|
|
Read a command from the braille keyboard
This function returns brltty commands, as described in It can be called only if BRLCOMMANDS was given to brlapi_getTty() By default, all commands but those which restart drivers and switch virtual terminals are returned to the application and not to brltty. If the application doesn't want to see some command events, it should call brlapi_ignoreKeys()
|
|
Read a key from the braille keyboard This function returns raw keycodes, as specified by the terminal driver. It generally corresponds to the code the terminal tells to the driver. This should only be used to application which are dedicated to a particular braille terminal. Hence, checking the terminal type thanks to a call to brlapi_getDriverId() or even brlapi_getDriverName() before getting tty control is a pretty good idea. It can be called only if BRLKEYCODES was given to brlapi_getTty() By default, all the keypresses will be passed to the client, none will go through brltty, so the application will have to handle console switching itself.
|
|
Unignore some key presses from the braille keyboard This function asks the server to return keys between x and y to the application, and not give them to brltty.
|