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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BrlAPI: brlapi_writeArguments_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">BrlAPI<span id="projectnumber"> 0.8</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search',false);
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">brlapi_writeArguments_t Struct Reference<div class="ingroups"><a class="el" href="group__brlapi__write.html">Writing on the braille display</a></div></div></div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="brlapi_8h_source.html">brlapi.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ae222cad591b4ae63aeb08e8f28b6e474" id="r_ae222cad591b4ae63aeb08e8f28b6e474"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae222cad591b4ae63aeb08e8f28b6e474">displayNumber</a></td></tr>
<tr class="separator:ae222cad591b4ae63aeb08e8f28b6e474"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb1b9ca2ff376769a8ae964f58e0f980" id="r_aeb1b9ca2ff376769a8ae964f58e0f980"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="#aeb1b9ca2ff376769a8ae964f58e0f980">regionBegin</a></td></tr>
<tr class="separator:aeb1b9ca2ff376769a8ae964f58e0f980"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a676a7c0166e6d571e05149ef7e63cf4a" id="r_a676a7c0166e6d571e05149ef7e63cf4a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a676a7c0166e6d571e05149ef7e63cf4a">regionSize</a></td></tr>
<tr class="separator:a676a7c0166e6d571e05149ef7e63cf4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a851ac5ee8a574933006a5bd89fb8b2" id="r_a5a851ac5ee8a574933006a5bd89fb8b2"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5a851ac5ee8a574933006a5bd89fb8b2">text</a></td></tr>
<tr class="separator:a5a851ac5ee8a574933006a5bd89fb8b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7eba82fd6e47f434c2c1278b41f229bd" id="r_a7eba82fd6e47f434c2c1278b41f229bd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7eba82fd6e47f434c2c1278b41f229bd">textSize</a></td></tr>
<tr class="separator:a7eba82fd6e47f434c2c1278b41f229bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8860aaf20552d8e81e0467e986b00712" id="r_a8860aaf20552d8e81e0467e986b00712"><td class="memItemLeft" align="right" valign="top">const unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8860aaf20552d8e81e0467e986b00712">andMask</a></td></tr>
<tr class="separator:a8860aaf20552d8e81e0467e986b00712"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4305137036050b4acb2174a873b602a9" id="r_a4305137036050b4acb2174a873b602a9"><td class="memItemLeft" align="right" valign="top">const unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4305137036050b4acb2174a873b602a9">orMask</a></td></tr>
<tr class="separator:a4305137036050b4acb2174a873b602a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a851dce39d2fe3b7125f319090285393f" id="r_a851dce39d2fe3b7125f319090285393f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a851dce39d2fe3b7125f319090285393f">cursor</a></td></tr>
<tr class="separator:a851dce39d2fe3b7125f319090285393f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a326c669b5908c3670dc077b5e99d42a7" id="r_a326c669b5908c3670dc077b5e99d42a7"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a326c669b5908c3670dc077b5e99d42a7">charset</a></td></tr>
<tr class="separator:a326c669b5908c3670dc077b5e99d42a7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Structure containing arguments to be given to <a class="el" href="group__brlapi__write.html#ga287f9a11719e1c350fb0280a38e0e069">brlapi_write()</a> </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a8860aaf20552d8e81e0467e986b00712" name="a8860aaf20552d8e81e0467e986b00712"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8860aaf20552d8e81e0467e986b00712">◆ </a></span>andMask</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const unsigned char* brlapi_writeArguments_t::andMask</td>
</tr>
</table>
</div><div class="memdoc">
<p>And attributes; applied first </p>
</div>
</div>
<a id="a326c669b5908c3670dc077b5e99d42a7" name="a326c669b5908c3670dc077b5e99d42a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a326c669b5908c3670dc077b5e99d42a7">◆ </a></span>charset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* brlapi_writeArguments_t::charset</td>
</tr>
</table>
</div><div class="memdoc">
<p>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. </p>
</div>
</div>
<a id="a851dce39d2fe3b7125f319090285393f" name="a851dce39d2fe3b7125f319090285393f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a851dce39d2fe3b7125f319090285393f">◆ </a></span>cursor</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int brlapi_writeArguments_t::cursor</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="group__brlapi__write.html#gab0f523a333efcd272ac591785747f8ce">BRLAPI_CURSOR_LEAVE</a> == don't touch, <a class="el" href="group__brlapi__write.html#gadf7ed09ca3d6694bcd993fa3c351cebf">BRLAPI_CURSOR_OFF</a> == turn off, 1 = 1st char of display, ... </p>
</div>
</div>
<a id="ae222cad591b4ae63aeb08e8f28b6e474" name="ae222cad591b4ae63aeb08e8f28b6e474"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae222cad591b4ae63aeb08e8f28b6e474">◆ </a></span>displayNumber</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int brlapi_writeArguments_t::displayNumber</td>
</tr>
</table>
</div><div class="memdoc">
<p>Display number <a class="el" href="group__brlapi__write.html#gab1a71f82cac5d0b7ea1170697fe0dfc2">BRLAPI_DISPLAY_DEFAULT</a> == unspecified </p>
</div>
</div>
<a id="a4305137036050b4acb2174a873b602a9" name="a4305137036050b4acb2174a873b602a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4305137036050b4acb2174a873b602a9">◆ </a></span>orMask</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const unsigned char* brlapi_writeArguments_t::orMask</td>
</tr>
</table>
</div><div class="memdoc">
<p>Or attributes; applied <em>after</em> ANDing </p>
</div>
</div>
<a id="aeb1b9ca2ff376769a8ae964f58e0f980" name="aeb1b9ca2ff376769a8ae964f58e0f980"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb1b9ca2ff376769a8ae964f58e0f980">◆ </a></span>regionBegin</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int brlapi_writeArguments_t::regionBegin</td>
</tr>
</table>
</div><div class="memdoc">
<p>Region of display to update, 1st character of display is 1, 1st character of the second line of display is the width of a line plus 1, etc. Regions are always a linear wrap over the different lines. </p>
</div>
</div>
<a id="a676a7c0166e6d571e05149ef7e63cf4a" name="a676a7c0166e6d571e05149ef7e63cf4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a676a7c0166e6d571e05149ef7e63cf4a">◆ </a></span>regionSize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int brlapi_writeArguments_t::regionSize</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of characters held in andMask and orMask. If negative, its absolute value is taken into account, and the output is padded or truncated to fill the rest of the display. </p>
</div>
</div>
<a id="a5a851ac5ee8a574933006a5bd89fb8b2" name="a5a851ac5ee8a574933006a5bd89fb8b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a851ac5ee8a574933006a5bd89fb8b2">◆ </a></span>text</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* brlapi_writeArguments_t::text</td>
</tr>
</table>
</div><div class="memdoc">
<p>Text to display, must hold as many characters as the region fields expresses. </p>
</div>
</div>
<a id="a7eba82fd6e47f434c2c1278b41f229bd" name="a7eba82fd6e47f434c2c1278b41f229bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7eba82fd6e47f434c2c1278b41f229bd">◆ </a></span>textSize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int brlapi_writeArguments_t::textSize</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of text in bytes. If -1, strlen() is used for computing it. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="brlapi_8h_source.html">brlapi.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
|
