brlapi_writeArguments_t Struct Reference
[Writing on the braille display]

#include <brlapi.h>


Data Fields

int displayNumber
unsigned int regionBegin
unsigned int regionSize
char * text
int textSize
unsigned char * andMask
unsigned char * orMask
int cursor
char * charset


Detailed Description

Structure containing arguments to be given to brlapi_write()

Field Documentation

Display number BRLAPI_DISPLAY_DEFAULT == unspecified

Region of display to update, 1st character of display is 1

Number of characters held in text, andMask and orMask.

Text to display, must hold as many characters as the region fields expresses.

Size of text in bytes. If -1, strlen() is used for computing it.

And attributes; applied first

Or attributes; applied after ANDing

BRLAPI_CURSOR_LEAVE == don't touch, BRLAPI_CURSOR_OFF == turn off, 1 = 1st char of display, ...

Text charset. NULL means it is assumed to be 8bits, and the same as the server's. "" means current locale's charset. If no locale was selected, defaults to NULL's meaning.


The documentation for this struct was generated from the following file:

Generated on Wed Sep 24 14:02:32 2008 for BrlAPI by  doxygen 1.5.6