taigrr/arduinolibs
1
0
Fork 0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Rhys Weatherley
2015-03-12 19:03:15 +10:00
parent 083448f195
commit c6206e4216
493 changed files with 35310 additions and 3018 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
Field_8h_source.html
View File

@@ -3,6 +3,7 @@
<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.6"/>
<title>ArduinoLibs: Field.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
@@ -29,7 +30,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
@@ -114,45 +115,58 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;Form.h&quot;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="code" href="classField.html"> 28</a></span>&#160;<span class="keyword">class </span><a class="code" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a> {</div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classField.html"> 28</a></span>&#160;<span class="keyword">class </span><a class="code" href="classField.html">Field</a> {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classField.html#ac4ea0d104376233c3f0bfc080ec8564e" title="Constructs a new field with a specific label.">Field</a>(<span class="keyword">const</span> String &amp;<a class="code" href="classField.html#aaa861ef917130c989a955bc75c683afe" title="Returns the label to display in the first line of this field.">label</a>);</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <a class="code" href="classField.html#ac4ea0d104376233c3f0bfc080ec8564e" title="Constructs a new field with a specific label.">Field</a>(<a class="code" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a> &amp;<a class="code" href="classField.html#a27427319be1cc92db3128637d8884ee5" title="Returns the Form that owns this field; null if not associated with a Form.">form</a>, <span class="keyword">const</span> String &amp;label);</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="classField.html#a45d6e6d09b8f8e46de62b40119d62c60" title="Destroys this field and removes it from its owning Form.">~Field</a>();</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classField.html#ac4ea0d104376233c3f0bfc080ec8564e">Field</a>(<span class="keyword">const</span> String &amp;<a class="code" href="classField.html#aaa861ef917130c989a955bc75c683afe">label</a>);</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <a class="code" href="classField.html#ac4ea0d104376233c3f0bfc080ec8564e">Field</a>(<a class="code" href="classForm.html">Form</a> &amp;<a class="code" href="classField.html#a27427319be1cc92db3128637d8884ee5">form</a>, <span class="keyword">const</span> String &amp;label);</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="classField.html#a45d6e6d09b8f8e46de62b40119d62c60">~Field</a>();</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="code" href="classField.html#a27427319be1cc92db3128637d8884ee5"> 34</a></span>&#160; <a class="code" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a> *<a class="code" href="classField.html#a27427319be1cc92db3128637d8884ee5" title="Returns the Form that owns this field; null if not associated with a Form.">form</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _form; }</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classField.html#a27427319be1cc92db3128637d8884ee5"> 34</a></span>&#160; <a class="code" href="classForm.html">Form</a> *<a class="code" href="classField.html#a27427319be1cc92db3128637d8884ee5">form</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _form; }</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classField.html#a061bd1ed4d8b079df86465df8facd3b3" title="Dispatches event via this field.">dispatch</a>(<span class="keywordtype">int</span> event);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classField.html#a061bd1ed4d8b079df86465df8facd3b3">dispatch</a>(<span class="keywordtype">int</span> event);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classField.html#aa032bbeacb405c56546cb56fbbee94f5" title="Enters the field due to form navigation.">enterField</a>(<span class="keywordtype">bool</span> reverse);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classField.html#ad6805c75ee1e62f8cd8bd550c4530c07" title="Exits the field due to form navigation.">exitField</a>();</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classField.html#aa032bbeacb405c56546cb56fbbee94f5">enterField</a>(<span class="keywordtype">bool</span> reverse);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classField.html#ad6805c75ee1e62f8cd8bd550c4530c07">exitField</a>();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="code" href="classField.html#aaa861ef917130c989a955bc75c683afe"> 41</a></span>&#160; <span class="keyword">const</span> String &amp;<a class="code" href="classField.html#aaa861ef917130c989a955bc75c683afe" title="Returns the label to display in the first line of this field.">label</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _label; }</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classField.html#ad4ea63599d780c35b296cf2840b69f7b" title="Sets the label to display in the first line of this field.">setLabel</a>(<span class="keyword">const</span> String &amp;label);</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classField.html#aaa861ef917130c989a955bc75c683afe"> 41</a></span>&#160; <span class="keyword">const</span> String &amp;<a class="code" href="classField.html#aaa861ef917130c989a955bc75c683afe">label</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _label; }</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classField.html#ad4ea63599d780c35b296cf2840b69f7b">setLabel</a>(<span class="keyword">const</span> String &amp;label);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classField.html#a25d86a67b321e8c642edf75a10a35f72" title="Returns true if this field is the currently-displayed field in its owning form; false otherwise...">isCurrent</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classField.html#a25d86a67b321e8c642edf75a10a35f72">isCurrent</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1"> 47</a></span>&#160; LiquidCrystal *<a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1" title="Returns the LCD that this field is being drawn on.">lcd</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _form-&gt;_lcd; }</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1"> 47</a></span>&#160; LiquidCrystal *<a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1">lcd</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _form-&gt;_lcd; }</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classField.html#afc612378167be0e7f8a6f8395b3537bd" title="Updates the cursor position after the label has been drawn by setLabel().">updateCursor</a>();</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classField.html#afc612378167be0e7f8a6f8395b3537bd">updateCursor</a>();</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; String _label;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a> *_form;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a> *next;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a> *prev;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="classForm.html">Form</a> *_form;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="classField.html">Field</a> *next;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="classField.html">Field</a> *prev;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classForm.html">Form</a>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;};</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="classField_html"><div class="ttname"><a href="classField.html">Field</a></div><div class="ttdoc">Manages a single data input/output field within a Form. </div><div class="ttdef"><b>Definition:</b> <a href="Field_8h_source.html#l00028">Field.h:28</a></div></div>
<div class="ttc" id="classForm_html"><div class="ttname"><a href="classForm.html">Form</a></div><div class="ttdoc">Manager for a form containing data input/output fields. </div><div class="ttdef"><b>Definition:</b> <a href="Form_8h_source.html#l00032">Form.h:32</a></div></div>
<div class="ttc" id="classField_html_aa032bbeacb405c56546cb56fbbee94f5"><div class="ttname"><a href="classField.html#aa032bbeacb405c56546cb56fbbee94f5">Field::enterField</a></div><div class="ttdeci">virtual void enterField(bool reverse)</div><div class="ttdoc">Enters the field due to form navigation. </div><div class="ttdef"><b>Definition:</b> <a href="Field_8cpp_source.html#l00116">Field.cpp:116</a></div></div>
<div class="ttc" id="classField_html_a27427319be1cc92db3128637d8884ee5"><div class="ttname"><a href="classField.html#a27427319be1cc92db3128637d8884ee5">Field::form</a></div><div class="ttdeci">Form * form() const </div><div class="ttdoc">Returns the Form that owns this field; null if not associated with a Form. </div><div class="ttdef"><b>Definition:</b> <a href="Field_8h_source.html#l00034">Field.h:34</a></div></div>
<div class="ttc" id="classField_html_a061bd1ed4d8b079df86465df8facd3b3"><div class="ttname"><a href="classField.html#a061bd1ed4d8b079df86465df8facd3b3">Field::dispatch</a></div><div class="ttdeci">virtual int dispatch(int event)</div><div class="ttdoc">Dispatches event via this field. </div><div class="ttdef"><b>Definition:</b> <a href="Field_8cpp_source.html#l00096">Field.cpp:96</a></div></div>
<div class="ttc" id="classField_html_aaa861ef917130c989a955bc75c683afe"><div class="ttname"><a href="classField.html#aaa861ef917130c989a955bc75c683afe">Field::label</a></div><div class="ttdeci">const String &amp; label() const </div><div class="ttdoc">Returns the label to display in the first line of this field. </div><div class="ttdef"><b>Definition:</b> <a href="Field_8h_source.html#l00041">Field.h:41</a></div></div>
<div class="ttc" id="classField_html_a5cf21bf958a71e51feac9e1bf9f599d1"><div class="ttname"><a href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1">Field::lcd</a></div><div class="ttdeci">LiquidCrystal * lcd() const </div><div class="ttdoc">Returns the LCD that this field is being drawn on. </div><div class="ttdef"><b>Definition:</b> <a href="Field_8h_source.html#l00047">Field.h:47</a></div></div>
<div class="ttc" id="classField_html_ac4ea0d104376233c3f0bfc080ec8564e"><div class="ttname"><a href="classField.html#ac4ea0d104376233c3f0bfc080ec8564e">Field::Field</a></div><div class="ttdeci">Field(const String &amp;label)</div><div class="ttdoc">Constructs a new field with a specific label. </div><div class="ttdef"><b>Definition:</b> <a href="Field_8cpp_source.html#l00040">Field.cpp:40</a></div></div>
<div class="ttc" id="classField_html_ad6805c75ee1e62f8cd8bd550c4530c07"><div class="ttname"><a href="classField.html#ad6805c75ee1e62f8cd8bd550c4530c07">Field::exitField</a></div><div class="ttdeci">virtual void exitField()</div><div class="ttdoc">Exits the field due to form navigation. </div><div class="ttdef"><b>Definition:</b> <a href="Field_8cpp_source.html#l00129">Field.cpp:129</a></div></div>
<div class="ttc" id="classField_html_afc612378167be0e7f8a6f8395b3537bd"><div class="ttname"><a href="classField.html#afc612378167be0e7f8a6f8395b3537bd">Field::updateCursor</a></div><div class="ttdeci">virtual void updateCursor()</div><div class="ttdoc">Updates the cursor position after the label has been drawn by setLabel(). </div><div class="ttdef"><b>Definition:</b> <a href="Field_8cpp_source.html#l00191">Field.cpp:191</a></div></div>
<div class="ttc" id="classField_html_ad4ea63599d780c35b296cf2840b69f7b"><div class="ttname"><a href="classField.html#ad4ea63599d780c35b296cf2840b69f7b">Field::setLabel</a></div><div class="ttdeci">void setLabel(const String &amp;label)</div><div class="ttdoc">Sets the label to display in the first line of this field. </div><div class="ttdef"><b>Definition:</b> <a href="Field_8cpp_source.html#l00146">Field.cpp:146</a></div></div>
<div class="ttc" id="classField_html_a45d6e6d09b8f8e46de62b40119d62c60"><div class="ttname"><a href="classField.html#a45d6e6d09b8f8e46de62b40119d62c60">Field::~Field</a></div><div class="ttdeci">~Field()</div><div class="ttdoc">Destroys this field and removes it from its owning Form. </div><div class="ttdef"><b>Definition:</b> <a href="Field_8cpp_source.html#l00066">Field.cpp:66</a></div></div>
<div class="ttc" id="classField_html_a25d86a67b321e8c642edf75a10a35f72"><div class="ttname"><a href="classField.html#a25d86a67b321e8c642edf75a10a35f72">Field::isCurrent</a></div><div class="ttdeci">bool isCurrent() const </div><div class="ttdoc">Returns true if this field is the currently-displayed field in its owning form; false otherwise...</div><div class="ttdef"><b>Definition:</b> <a href="Field_8cpp_source.html#l00169">Field.cpp:169</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 29 2013 09:30:46 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Mar 12 2015 19:02:05 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</a> 1.8.6
</small></address>
</body>
</html>