Defines | |
#define | BRLAPI_TTY_DEFAULT -1 |
Functions | |
int BRLAPI_STDCALL | brlapi_enterTtyMode (int tty, const char *driver) |
int BRLAPI_STDCALL | brlapi__enterTtyMode (brlapi_handle_t *handle, int tty, const char *driver) |
int BRLAPI_STDCALL | brlapi_enterTtyModeWithPath (int *ttys, int count, const char *driver) |
int BRLAPI_STDCALL | brlapi__enterTtyModeWithPath (brlapi_handle_t *handle, int *ttys, int count, const char *driver) |
int BRLAPI_STDCALL | brlapi_leaveTtyMode (void) |
int BRLAPI_STDCALL | brlapi__leaveTtyMode (brlapi_handle_t *handle) |
int BRLAPI_STDCALL | brlapi_setFocus (int tty) |
int BRLAPI_STDCALL | brlapi__setFocus (brlapi_handle_t *handle, int tty) |
The application must also specify how braille keys will be delivered to it. Two ways are possible: key codes and commands:
#define BRLAPI_TTY_DEFAULT -1 |
Select the default tty.
The library takes the following steps:
WINDOWID
environment variable (for the xterm
case).CONTROLVT
environment variable./proc/self/stat
(on Linux
).
int BRLAPI_STDCALL brlapi__enterTtyMode | ( | brlapi_handle_t * | handle, | |
int | tty, | |||
const char * | driver | |||
) |
int BRLAPI_STDCALL brlapi__enterTtyModeWithPath | ( | brlapi_handle_t * | handle, | |
int * | ttys, | |||
int | count, | |||
const char * | driver | |||
) |
int BRLAPI_STDCALL brlapi__leaveTtyMode | ( | brlapi_handle_t * | handle | ) |
int BRLAPI_STDCALL brlapi__setFocus | ( | brlapi_handle_t * | handle, | |
int | tty | |||
) |
int BRLAPI_STDCALL brlapi_enterTtyMode | ( | int | tty, | |
const char * | driver | |||
) |
Ask for some tty, with some key mechanism
tty |
| |
driver | tells how the application wants brlapi_readKey() to return key presses. NULL or "" means BRLTTY commands are required, whereas a driver name means that raw key codes returned by this driver are expected. |
WINDOWPATH="$(grep "using VT number" "/var/log/Xorg.$(echo "$DISPLAY" | sed -e "s/^.*::*\([0-9]*\).*$/\1/").log" | sed -e "s/^.*using VT number \([0-9]*\).*$/\1/")"
WINDOWPATH and WINDOWID should be propagated when running remote applications via ssh, for instance, along with BRLAPI_HOST and the authorization key (see SendEnv in ssh_config(5) and AcceptEnv in sshd_config(5))
int BRLAPI_STDCALL brlapi_enterTtyModeWithPath | ( | int * | ttys, | |
int | count, | |||
const char * | driver | |||
) |
Ask for some tty specified by its path in the tty tree, with some key mechanism
ttys | points on the array of ttys representing the tty path to be got. Can be NULL if nttys is 0. | |
count | gives the number of elements in ttys. | |
driver | has the same meaning as in brlapi_enterTtyMode() |
int BRLAPI_STDCALL brlapi_leaveTtyMode | ( | void | ) |
int BRLAPI_STDCALL brlapi_setFocus | ( | int | tty | ) |
Tell the current tty to brltty
This is intended for focus tellers, such as brltty, xbrlapi, screen, ... brlapi_enterTtyMode() must have been called beforehand to tell where this focus applies in the tty tree.