Data Structures | |
struct | brlapi_writeArguments_t |
Defines | |
#define | BRLAPI_DISPLAY_DEFAULT -1 |
#define | BRLAPI_CURSOR_LEAVE -1 |
#define | BRLAPI_CURSOR_OFF 0 |
#define | BRLAPI_WRITEARGUMENTS_INITIALIZER { BRLAPI_DISPLAY_DEFAULT, 0, 0, NULL, -1, NULL, NULL, BRLAPI_CURSOR_LEAVE, NULL } |
Functions | |
int BRLAPI_STDCALL | brlapi_writeText (int cursor, const char *text) |
int BRLAPI_STDCALL | brlapi__writeText (brlapi_handle_t *handle, int cursor, const char *text) |
int BRLAPI_STDCALL | brlapi_writeDots (const unsigned char *dots) |
int BRLAPI_STDCALL | brlapi__writeDots (brlapi_handle_t *handle, const unsigned char *dots) |
int BRLAPI_STDCALL | brlapi_write (const brlapi_writeArguments_t *arguments) |
int BRLAPI_STDCALL | brlapi__write (brlapi_handle_t *handle, const brlapi_writeArguments_t *arguments) |
Dots are coded as described in ISO/TR 11548-1: a dot pattern is coded by a byte in which bit 0 is set iff dot 1 is up, bit 1 is set iff dot 2 is up, ... bit 7 is set iff dot 8 is up. This also corresponds to the low-order byte of the coding of unicode's braille row U+2800.
|
Do not change the cursor's state or position.
|
|
Do not display the cursor.
|
|
Write to the default display on the braille device.
|
|
Allows to initialize a structure of type brlapi_writeArguments_t * with default values: displayNumber = BRLAPI_DISPLAY_DEFAULT; (unspecified) regionBegin = regionSize = 0; (update the whole display, DEPRECATED and will be forbidden in next release. You must always express the region you wish to update) text = andMask = orMask = NULL; (no text, no attribute) cursor = BRLAPI_CURSOR_LEAVE; (don't touch cursor) |
|
|
|
|
|
|
|
Update a specific region of the braille display and apply and/or masks
If given, the "text" field holds the text that will be displayed in the region. The char string must hold exactly as many characters as the region fields express. For multibyte text, this is the number of multibyte caracters. Notably, combining and double-width caracters count for 1. The actual length of the text in bytes may be specified thanks to textSize. If -1 is given, it will be computed thanks to strlen(), so "text" must then be a NUL-terminated string. The "andMask" and "orMask" masks, if present, are then applied on top of the text, one byte per character. This hence permits the superimposing of attributes over the text. For instance, setting an andMask mask full of BRLAPI_DOT1|BRLAPI_DOT2|BRLAPI_DOT3|BRLAPI_DOT4|BRLAPI_DOT5|BRLAPI_DOT6 will only keep (logical AND) dots 1-6, hence dropping dots 7 and 8. On the contrary, setting an orMask full of BRLAPI_DOT7|BRLAPI_DOT8 will add (logical OR) dots 7 and 8. The "charset" field, if present, specifies the charset of the "text" field. If it is "", the current locale's charset (if any) is assumed. Else, the 8-bit charset of the server is assumed. A special invocation is with an unmodified initialized structure: this clears the client's whole display, letting the display of other applications on the same tty or of applications "under" the tty appear. See Concurrency management section of the BrlAPI documentation for more details.
|
|
Write the given dots array to the display
|
|
Write the given \0-terminated string to the braille display If the string is too long, it is cut. If it's too short, spaces are appended. The current LC_CTYPE locale is considered, unless it is left as default "C", in which case the charset is assumed to be 8bits, and the same as the server's.
|