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_ignoreKeyRange (brl_keycode_t x, brl_keycode_t y) |
int | brlapi_ignoreKeySet (const brl_keycode_t *s, unsigned int n) |
int | brlapi_unignoreKeyRange (brl_keycode_t x, brl_keycode_t y) |
int | brlapi_unignoreKeySet (const brl_keycode_t *s, unsigned int n) |
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_readKey()
|
|
Ignore some key presses from the braille keyboard This function asks the server to give the n keys in set s to brltty, rather than returning them to the application via brlapi_readKey()
|
|
Read a key from the braille keyboard This function returns one key press's code.
If BRLCOMMANDS was given to brlapi_getTty(), a brltty command is returned, as described in 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 either brlapi_ignoreKeySet() or brlapi_ignoreKeyRange() If BRLKEYCODES was given to brlapi_getTty(), a raw keycode is returned, as specified by the terminal driver, usually in <brltty/brldefs-xy> where xy is the driver's code. It generally corresponds to the very code that the terminal tells to the driver. This should only be used by applications 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. 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.
|
|
Unignore some key presses from the braille keyboard This function asks the server to return all n keys in set s to the application, and not give them to brltty.
|