This repository has been archived by the owner on Jan 3, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 44
/
Copy path_text_8h_source.html
174 lines (172 loc) · 20 KB
/
_text_8h_source.html
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
<!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.9.1"/>
<title>Windows Virtual Shields for Arduino: C:/Users/jgord/Documents/ms-iot/virtual-shields-arduino/VirtualShield/Text.h Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 id="projectlogo"><img alt="Logo" src="Shields300x300.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Windows Virtual Shields for Arduino
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_4666358c41473c1386da241fadc3b0ce.html">ms-iot</a></li><li class="navelem"><a class="el" href="dir_90e9ec72575291a23efc59ef9134d457.html">virtual-shields-arduino</a></li><li class="navelem"><a class="el" href="dir_91cad1f2850053704733302cba72643f.html">VirtualShield</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Text.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_text_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Copyright(c) Microsoft Open Technologies, Inc. All rights reserved.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> The MIT License(MIT)</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Permission is hereby granted, free of charge, to any person obtaining a copy</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> of this software and associated documentation files(the "Software"), to deal</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> in the Software without restriction, including without limitation the rights</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> to use, copy, modify, merge, publish, distribute, sublicense, and / or sell</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> copies of the Software, and to permit persons to whom the Software is</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> furnished to do so, subject to the following conditions :</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> The above copyright notice and this permission notice shall be included in</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> all copies or substantial portions of the Software.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> THE SOFTWARE.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef Text_h</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define Text_h</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="_sensor_8h.html">Sensor.h</a>"</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="_text_8h.html#aebcd8a5f6375fa726fcd52f6f4f9d59c"> 30</a></span> <span class="keyword">const</span> PROGMEM <span class="keywordtype">char</span> <a class="code" href="_text_8h.html#aebcd8a5f6375fa726fcd52f6f4f9d59c">Y</a>[] = <span class="stringliteral">"Y"</span>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="_text_8h.html#ac22a93c4e7c172b0cc8b4095c32b57fd"> 31</a></span> <span class="keyword">const</span> PROGMEM <span class="keywordtype">char</span> <a class="code" href="_text_8h.html#ac22a93c4e7c172b0cc8b4095c32b57fd">CLEAR</a>[] = <span class="stringliteral">"CLEAR"</span>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="_text_8h.html#a8c522d2fdcfdf8f2a2352a61f83e03e2"> 32</a></span> <span class="keyword">const</span> PROGMEM <span class="keywordtype">char</span> <a class="code" href="_text_8h.html#a8c522d2fdcfdf8f2a2352a61f83e03e2">RGBAKEY</a>[] = <span class="stringliteral">"ARGB"</span>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="_text_8h.html#a6979d4358d8c8fea65117ee3702647ee"> 33</a></span> <span class="keyword">const</span> PROGMEM <span class="keywordtype">char</span> <a class="code" href="_text_8h.html#a6979d4358d8c8fea65117ee3702647ee">PID</a>[] = <span class="stringliteral">"Pid"</span>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="class_text.html"> 35</a></span> <span class="keyword">class </span><a class="code" href="class_text.html">Text</a> : <span class="keyword">public</span> <a class="code" href="class_sensor.html">Sensor</a></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="class_text.html#ad093d52f237f76fd150812577025b147">Text</a>(<span class="keyword">const</span> <a class="code" href="class_virtual_shield.html">VirtualShield</a> &<a class="code" href="class_sensor.html#a984723758f808506fe9030a9b270a859">shield</a>);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">int</span> <a class="code" href="class_text.html#a6213de0d5788b65ab32a5bfad05d1aae">clear</a>(<a class="code" href="union_a_r_g_b.html">ARGB</a> argb = 0);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">int</span> <a class="code" href="class_text.html#ae7d34abfb61a197e4bb496ea2b3b1792">clearLine</a>(<a class="code" href="_sensor_models_8h.html#a36cb3b01d81ffd844bbbfb54003e06ec">UINT</a> line);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">int</span> <a class="code" href="class_text.html#a5880eb48635943798a3b0ad5698f4a73">clearId</a>(<a class="code" href="_sensor_models_8h.html#a36cb3b01d81ffd844bbbfb54003e06ec">UINT</a> <span class="keywordtype">id</span>);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">int</span> <a class="code" href="class_text.html#a3155b86b3d662ee525ddf769093fd58b">print</a>(String text, <a class="code" href="union_a_r_g_b.html">ARGB</a> argb = 0);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">int</span> <a class="code" href="class_text.html#a513d3c42d192222234dba85d2fa4e509">printAt</a>(<a class="code" href="_sensor_models_8h.html#a36cb3b01d81ffd844bbbfb54003e06ec">UINT</a> line, String text, <a class="code" href="struct_attr.html">Attr</a> extraAttributes[] = 0, <span class="keywordtype">int</span> extraAttributeCount = 0);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">int</span> <a class="code" href="class_text.html#a513d3c42d192222234dba85d2fa4e509">printAt</a>(<a class="code" href="_sensor_models_8h.html#a36cb3b01d81ffd844bbbfb54003e06ec">UINT</a> line, <a class="code" href="struct_e_ptr.html">EPtr</a> text, <a class="code" href="struct_attr.html">Attr</a> extraAttributes[] = 0, <span class="keywordtype">int</span> extraAttributeCount = 0);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">int</span> <a class="code" href="class_text.html#a513d3c42d192222234dba85d2fa4e509">printAt</a>(<a class="code" href="_sensor_models_8h.html#a36cb3b01d81ffd844bbbfb54003e06ec">UINT</a> line, <span class="keywordtype">double</span> value, <a class="code" href="union_a_r_g_b.html">ARGB</a> argb = 0);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">void</span> <a class="code" href="class_text.html#a6e58f309b341c8708193486498bb8ac5">onJsonReceived</a>(JsonObject& root, <a class="code" href="struct_shield_event.html">ShieldEvent</a>* shieldEvent) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> };</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="class_text_html"><div class="ttname"><a href="class_text.html">Text</a></div><div class="ttdef"><b>Definition:</b> Text.h:35</div></div>
<div class="ttc" id="class_sensor_html"><div class="ttname"><a href="class_sensor.html">Sensor</a></div><div class="ttdef"><b>Definition:</b> Sensor.h:51</div></div>
<div class="ttc" id="class_virtual_shield_html"><div class="ttname"><a href="class_virtual_shield.html">VirtualShield</a></div><div class="ttdef"><b>Definition:</b> VirtualShield.h:50</div></div>
<div class="ttc" id="_text_8h_html_a8c522d2fdcfdf8f2a2352a61f83e03e2"><div class="ttname"><a href="_text_8h.html#a8c522d2fdcfdf8f2a2352a61f83e03e2">RGBAKEY</a></div><div class="ttdeci">const PROGMEM char RGBAKEY[]</div><div class="ttdef"><b>Definition:</b> Text.h:32</div></div>
<div class="ttc" id="_text_8h_html_ac22a93c4e7c172b0cc8b4095c32b57fd"><div class="ttname"><a href="_text_8h.html#ac22a93c4e7c172b0cc8b4095c32b57fd">CLEAR</a></div><div class="ttdeci">const PROGMEM char CLEAR[]</div><div class="ttdef"><b>Definition:</b> Text.h:31</div></div>
<div class="ttc" id="class_sensor_html_a984723758f808506fe9030a9b270a859"><div class="ttname"><a href="class_sensor.html#a984723758f808506fe9030a9b270a859">Sensor::shield</a></div><div class="ttdeci">VirtualShield & shield</div><div class="ttdef"><b>Definition:</b> Sensor.h:55</div></div>
<div class="ttc" id="class_text_html_ad093d52f237f76fd150812577025b147"><div class="ttname"><a href="class_text.html#ad093d52f237f76fd150812577025b147">Text::Text</a></div><div class="ttdeci">Text(const VirtualShield &shield)</div><div class="ttdoc">Initializes a new instance of the Screen class. </div><div class="ttdef"><b>Definition:</b> Text.cpp:40</div></div>
<div class="ttc" id="_sensor_models_8h_html_a36cb3b01d81ffd844bbbfb54003e06ec"><div class="ttname"><a href="_sensor_models_8h.html#a36cb3b01d81ffd844bbbfb54003e06ec">UINT</a></div><div class="ttdeci">unsigned int UINT</div><div class="ttdef"><b>Definition:</b> SensorModels.h:28</div></div>
<div class="ttc" id="class_text_html_ae7d34abfb61a197e4bb496ea2b3b1792"><div class="ttname"><a href="class_text.html#ae7d34abfb61a197e4bb496ea2b3b1792">Text::clearLine</a></div><div class="ttdeci">int clearLine(UINT line)</div><div class="ttdoc">Clears the line. </div><div class="ttdef"><b>Definition:</b> Text.cpp:58</div></div>
<div class="ttc" id="class_text_html_a6213de0d5788b65ab32a5bfad05d1aae"><div class="ttname"><a href="class_text.html#a6213de0d5788b65ab32a5bfad05d1aae">Text::clear</a></div><div class="ttdeci">int clear(ARGB argb=0)</div><div class="ttdoc">Clears the screen of all elements. </div><div class="ttdef"><b>Definition:</b> Text.cpp:47</div></div>
<div class="ttc" id="union_a_r_g_b_html"><div class="ttname"><a href="union_a_r_g_b.html">ARGB</a></div><div class="ttdef"><b>Definition:</b> SensorModels.h:56</div></div>
<div class="ttc" id="class_text_html_a5880eb48635943798a3b0ad5698f4a73"><div class="ttname"><a href="class_text.html#a5880eb48635943798a3b0ad5698f4a73">Text::clearId</a></div><div class="ttdeci">int clearId(UINT id)</div><div class="ttdoc">Clears the element associated with the id. </div><div class="ttdef"><b>Definition:</b> Text.cpp:69</div></div>
<div class="ttc" id="class_text_html_a6e58f309b341c8708193486498bb8ac5"><div class="ttname"><a href="class_text.html#a6e58f309b341c8708193486498bb8ac5">Text::onJsonReceived</a></div><div class="ttdeci">void onJsonReceived(JsonObject &root, ShieldEvent *shieldEvent) override</div><div class="ttdoc">Event called when a valid json message was received. Consumes the proper values for this sensor...</div><div class="ttdef"><b>Definition:</b> Text.cpp:125</div></div>
<div class="ttc" id="struct_e_ptr_html"><div class="ttname"><a href="struct_e_ptr.html">EPtr</a></div><div class="ttdef"><b>Definition:</b> SensorModels.h:101</div></div>
<div class="ttc" id="class_text_html_a3155b86b3d662ee525ddf769093fd58b"><div class="ttname"><a href="class_text.html#a3155b86b3d662ee525ddf769093fd58b">Text::print</a></div><div class="ttdeci">int print(String text, ARGB argb=0)</div><div class="ttdoc">Prints the specified text. </div><div class="ttdef"><b>Definition:</b> Text.cpp:80</div></div>
<div class="ttc" id="struct_attr_html"><div class="ttname"><a href="struct_attr.html">Attr</a></div><div class="ttdef"><b>Definition:</b> Attr.h:30</div></div>
<div class="ttc" id="struct_shield_event_html"><div class="ttname"><a href="struct_shield_event.html">ShieldEvent</a></div><div class="ttdef"><b>Definition:</b> ShieldEvent.h:35</div></div>
<div class="ttc" id="_sensor_8h_html"><div class="ttname"><a href="_sensor_8h.html">Sensor.h</a></div></div>
<div class="ttc" id="_text_8h_html_a6979d4358d8c8fea65117ee3702647ee"><div class="ttname"><a href="_text_8h.html#a6979d4358d8c8fea65117ee3702647ee">PID</a></div><div class="ttdeci">const PROGMEM char PID[]</div><div class="ttdef"><b>Definition:</b> Text.h:33</div></div>
<div class="ttc" id="_text_8h_html_aebcd8a5f6375fa726fcd52f6f4f9d59c"><div class="ttname"><a href="_text_8h.html#aebcd8a5f6375fa726fcd52f6f4f9d59c">Y</a></div><div class="ttdeci">const PROGMEM char Y[]</div><div class="ttdef"><b>Definition:</b> Text.h:30</div></div>
<div class="ttc" id="class_text_html_a513d3c42d192222234dba85d2fa4e509"><div class="ttname"><a href="class_text.html#a513d3c42d192222234dba85d2fa4e509">Text::printAt</a></div><div class="ttdeci">int printAt(UINT line, String text, Attr extraAttributes[]=0, int extraAttributeCount=0)</div><div class="ttdoc">Prints the specified text at the specified line. </div><div class="ttdef"><b>Definition:</b> Text.cpp:104</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Apr 29 2015 17:37:05 for Windows Virtual Shields for Arduino by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>