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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.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>
<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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">BrlAPI
 <span id="projectnumber">1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<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 name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ae222cad591b4ae63aeb08e8f28b6e474"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#ae222cad591b4ae63aeb08e8f28b6e474">displayNumber</a></td></tr>
<tr class="separator:ae222cad591b4ae63aeb08e8f28b6e474"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb1b9ca2ff376769a8ae964f58e0f980"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#aeb1b9ca2ff376769a8ae964f58e0f980">regionBegin</a></td></tr>
<tr class="separator:aeb1b9ca2ff376769a8ae964f58e0f980"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b6ff5aa782053a662d0f6cd2e7102ef"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#a4b6ff5aa782053a662d0f6cd2e7102ef">regionSize</a></td></tr>
<tr class="separator:a4b6ff5aa782053a662d0f6cd2e7102ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c937c76e3012d14f36f60dceebd0e77"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#a0c937c76e3012d14f36f60dceebd0e77">text</a></td></tr>
<tr class="separator:a0c937c76e3012d14f36f60dceebd0e77"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7eba82fd6e47f434c2c1278b41f229bd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#a7eba82fd6e47f434c2c1278b41f229bd">textSize</a></td></tr>
<tr class="separator:a7eba82fd6e47f434c2c1278b41f229bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a317cb49eeb843c1fb1623beeec841238"><td class="memItemLeft" align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#a317cb49eeb843c1fb1623beeec841238">andMask</a></td></tr>
<tr class="separator:a317cb49eeb843c1fb1623beeec841238"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0947ad21ed08a8bd5df93b0dae24e8e0"><td class="memItemLeft" align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#a0947ad21ed08a8bd5df93b0dae24e8e0">orMask</a></td></tr>
<tr class="separator:a0947ad21ed08a8bd5df93b0dae24e8e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a851dce39d2fe3b7125f319090285393f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#a851dce39d2fe3b7125f319090285393f">cursor</a></td></tr>
<tr class="separator:a851dce39d2fe3b7125f319090285393f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaccd788710ee4485ab40990d0ce1dd77"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#aaccd788710ee4485ab40990d0ce1dd77">charset</a></td></tr>
<tr class="separator:aaccd788710ee4485ab40990d0ce1dd77"><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 class="anchor" id="a317cb49eeb843c1fb1623beeec841238"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char* brlapi_writeArguments_t::andMask</td>
</tr>
</table>
</div><div class="memdoc">
<p>And attributes; applied first </p>
</div>
</div>
<a class="anchor" id="aaccd788710ee4485ab40990d0ce1dd77"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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 class="anchor" id="a851dce39d2fe3b7125f319090285393f"></a>
<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 class="anchor" id="ae222cad591b4ae63aeb08e8f28b6e474"></a>
<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 class="anchor" id="a0947ad21ed08a8bd5df93b0dae24e8e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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 class="anchor" id="aeb1b9ca2ff376769a8ae964f58e0f980"></a>
<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 </p>
</div>
</div>
<a class="anchor" id="a4b6ff5aa782053a662d0f6cd2e7102ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int brlapi_writeArguments_t::regionSize</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of characters held in text, andMask and orMask. </p>
</div>
</div>
<a class="anchor" id="a0c937c76e3012d14f36f60dceebd0e77"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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 class="anchor" id="a7eba82fd6e47f434c2c1278b41f229bd"></a>
<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="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
|