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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Writing on the braille display</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center>
<hr><h1>Writing on the braille display</h1>write text to the braille display
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__write.html#a0">brlapi_writeBrl</a> (uint32_t cursor, const char *str)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__write.html#a1">brlapi_writeBrlDots</a> (const char *dots)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Once <a class="el" href="group__brlapi__tty.html#a0">brlapi_getTty()</a> was called, the application can call <a class="el" href="group__brlapi__write.html#a0">brlapi_writeBrl()</a> to write things on the braille display.
<p>
<dl compact><dt><b>Note: </b></dt><dd>
Be sure to call <a class="el" href="group__brlapi__tty.html#a0">brlapi_getTty()</a> <em>before</em> calling brlapi_write*(), or else you'll get an error. This is particularly not always trivial when writing multithreaded applications. </dl><hr><h2>Function Documentation</h2>
<a name="a0" doxytag="brlapi.h::brlapi_writeBrl"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int brlapi_writeBrl </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">uint32_t </td>
<td class="mdname" nowrap> <em>cursor</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>str</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Write the given \0-terminated string to the braille display
<p>
If the string is too long, it is cut. If it's too short, spaces are appended.<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>cursor</em> </td><td>
gives the cursor position; if less than or equal to 0 or greater than the display width, no cursor is shown at all; </td></tr>
<tr><td valign=top><em>str</em> </td><td>
points on the string to be displayed.</td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
0 on success, -1 on error. </dl> </td>
</tr>
</table>
<a name="a1" doxytag="brlapi.h::brlapi_writeBrlDots"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int brlapi_writeBrlDots </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>dots</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Write the given dots array to the display<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>dots</em> </td><td>
points on an array of dot information, one per character. Its size must hence be the same as what <a class="el" href="group__brlapi__info.html#a2">brlapi_getDisplaySize()</a> returns.</td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
0 on success, -1 on error. </dl> </td>
</tr>
</table>
<hr><address style="align: right;"><small>Generated on Thu Jan 15 13:21:27 2004 for BrlAPI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.18 </small></address>
</body>
</html>
|
