File: brlapi_writeArguments_t.3

package info (click to toggle)
brltty 5.2~20141018-5
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, jessie-kfreebsd-proposed-updates
  • size: 22,640 kB
  • sloc: ansic: 108,275; sh: 6,339; java: 4,473; xml: 2,650; makefile: 1,841; tcl: 1,478; awk: 599; ml: 293; python: 250
file content (68 lines) | stat: -rw-r--r-- 1,965 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
.TH "brlapi_writeArguments_t" 3 "Sat Oct 25 2014" "Version 1.0" "BrlAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
brlapi_writeArguments_t \- 
.SH SYNOPSIS
.br
.PP
.PP
\fC#include <brlapi\&.h>\fP
.SS "Data Fields"

.in +1c
.ti -1c
.RI "int \fBdisplayNumber\fP"
.br
.ti -1c
.RI "unsigned int \fBregionBegin\fP"
.br
.ti -1c
.RI "unsigned int \fBregionSize\fP"
.br
.ti -1c
.RI "char * \fBtext\fP"
.br
.ti -1c
.RI "int \fBtextSize\fP"
.br
.ti -1c
.RI "unsigned char * \fBandMask\fP"
.br
.ti -1c
.RI "unsigned char * \fBorMask\fP"
.br
.ti -1c
.RI "int \fBcursor\fP"
.br
.ti -1c
.RI "char * \fBcharset\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Structure containing arguments to be given to \fBbrlapi_write()\fP 
.SH "Field Documentation"
.PP 
.SS "unsigned char* brlapi_writeArguments_t::andMask"
And attributes; applied first 
.SS "char* brlapi_writeArguments_t::charset"
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\&. 
.SS "int brlapi_writeArguments_t::cursor"
\fBBRLAPI_CURSOR_LEAVE\fP == don't touch, \fBBRLAPI_CURSOR_OFF\fP == turn off, 1 = 1st char of display, \&.\&.\&. 
.SS "int brlapi_writeArguments_t::displayNumber"
Display number \fBBRLAPI_DISPLAY_DEFAULT\fP == unspecified 
.SS "unsigned char* brlapi_writeArguments_t::orMask"
Or attributes; applied \fIafter\fP ANDing 
.SS "unsigned int brlapi_writeArguments_t::regionBegin"
Region of display to update, 1st character of display is 1 
.SS "unsigned int brlapi_writeArguments_t::regionSize"
Number of characters held in text, andMask and orMask\&. 
.SS "char* brlapi_writeArguments_t::text"
Text to display, must hold as many characters as the region fields expresses\&. 
.SS "int brlapi_writeArguments_t::textSize"
Size of text in bytes\&. If -1, strlen() is used for computing it\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for BrlAPI from the source code\&.