1
0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00

Update docs

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

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: TextField.cpp 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>
@@ -111,44 +112,53 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;TextField.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="code" href="classTextField.html#a5108741ab147b2cd5a399fefbe0a2382"> 66</a></span>&#160;<a class="code" href="classTextField.html#a5108741ab147b2cd5a399fefbe0a2382" title="Constructs a new text field with a specific label.">TextField::TextField</a>(<span class="keyword">const</span> String &amp;label)</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; : <a class="code" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a>(label)</div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classTextField.html#a5108741ab147b2cd5a399fefbe0a2382"> 66</a></span>&#160;<a class="code" href="classTextField.html#a5108741ab147b2cd5a399fefbe0a2382">TextField::TextField</a>(<span class="keyword">const</span> String &amp;label)</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; : <a class="code" href="classField.html">Field</a>(label)</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;{</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;}</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="code" href="classTextField.html#a24096a344d9161b2c99ce724ec2ee93c"> 77</a></span>&#160;<a class="code" href="classTextField.html#a5108741ab147b2cd5a399fefbe0a2382" title="Constructs a new text field with a specific label.">TextField::TextField</a>(<a class="code" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a> &amp;form, <span class="keyword">const</span> String &amp;label, <span class="keyword">const</span> String &amp;value)</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; : <a class="code" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a>(form, label)</div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classTextField.html#a24096a344d9161b2c99ce724ec2ee93c"> 77</a></span>&#160;<a class="code" href="classTextField.html#a5108741ab147b2cd5a399fefbe0a2382">TextField::TextField</a>(<a class="code" href="classForm.html">Form</a> &amp;form, <span class="keyword">const</span> String &amp;label, <span class="keyword">const</span> String &amp;value)</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; : <a class="code" href="classField.html">Field</a>(form, label)</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; , _value(value)</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;{</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;}</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div>
<div class="line"><a name="l00083"></a><span class="lineno"><a class="code" href="classTextField.html#aa78f1354f9240b64fabd6f996e312f32"> 83</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classTextField.html#aa78f1354f9240b64fabd6f996e312f32" title="Enters the field due to form navigation.">TextField::enterField</a>(<span class="keywordtype">bool</span> reverse)</div>
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="classTextField.html#aa78f1354f9240b64fabd6f996e312f32"> 83</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classTextField.html#aa78f1354f9240b64fabd6f996e312f32">TextField::enterField</a>(<span class="keywordtype">bool</span> reverse)</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;{</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <a class="code" href="classTextField.html#aa78f1354f9240b64fabd6f996e312f32" title="Enters the field due to form navigation.">Field::enterField</a>(reverse);</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1" title="Returns the LCD that this field is being drawn on.">lcd</a>()-&gt;setCursor(0, 1);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1" title="Returns the LCD that this field is being drawn on.">lcd</a>()-&gt;print(_value);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <a class="code" href="classField.html#aa032bbeacb405c56546cb56fbbee94f5">Field::enterField</a>(reverse);</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1">lcd</a>()-&gt;setCursor(0, 1);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1">lcd</a>()-&gt;print(_value);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;}</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div>
<div class="line"><a name="l00102"></a><span class="lineno"><a class="code" href="classTextField.html#a24b98c5bb744331bf0a5facc8ea9c033"> 102</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classTextField.html#a24b98c5bb744331bf0a5facc8ea9c033" title="Sets the text value that is displayed by this field.">TextField::setValue</a>(<span class="keyword">const</span> String &amp;value)</div>
<div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="classTextField.html#a24b98c5bb744331bf0a5facc8ea9c033"> 102</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classTextField.html#a24b98c5bb744331bf0a5facc8ea9c033">TextField::setValue</a>(<span class="keyword">const</span> String &amp;value)</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;{</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordflow">if</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>()) {</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="classField.html#a25d86a67b321e8c642edf75a10a35f72">isCurrent</a>()) {</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> prevLen = _value.length();</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> newLen = value.length();</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; _value = <a class="code" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1" title="Returns the text value that is currently displayed by this field.">value</a>;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1" title="Returns the LCD that this field is being drawn on.">lcd</a>()-&gt;setCursor(0, 1);</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1" title="Returns the LCD that this field is being drawn on.">lcd</a>()-&gt;print(value);</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; _value = <a class="code" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1">value</a>;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1">lcd</a>()-&gt;setCursor(0, 1);</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1">lcd</a>()-&gt;print(value);</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordflow">while</span> (newLen++ &lt; prevLen)</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1" title="Returns the LCD that this field is being drawn on.">lcd</a>()-&gt;write(<span class="charliteral">&#39; &#39;</span>);</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1">lcd</a>()-&gt;write(<span class="charliteral">&#39; &#39;</span>);</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; _value = <a class="code" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1" title="Returns the text value that is currently displayed by this field.">value</a>;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; _value = <a class="code" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1">value</a>;</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; }</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;}</div>
<div class="ttc" id="classTextField_html_a24b98c5bb744331bf0a5facc8ea9c033"><div class="ttname"><a href="classTextField.html#a24b98c5bb744331bf0a5facc8ea9c033">TextField::setValue</a></div><div class="ttdeci">void setValue(const String &amp;value)</div><div class="ttdoc">Sets the text value that is displayed by this field. </div><div class="ttdef"><b>Definition:</b> <a href="TextField_8cpp_source.html#l00102">TextField.cpp:102</a></div></div>
<div class="ttc" id="classTextField_html_a5108741ab147b2cd5a399fefbe0a2382"><div class="ttname"><a href="classTextField.html#a5108741ab147b2cd5a399fefbe0a2382">TextField::TextField</a></div><div class="ttdeci">TextField(const String &amp;label)</div><div class="ttdoc">Constructs a new text field with a specific label. </div><div class="ttdef"><b>Definition:</b> <a href="TextField_8cpp_source.html#l00066">TextField.cpp:66</a></div></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="classTextField_html_aa78f1354f9240b64fabd6f996e312f32"><div class="ttname"><a href="classTextField.html#aa78f1354f9240b64fabd6f996e312f32">TextField::enterField</a></div><div class="ttdeci">void enterField(bool reverse)</div><div class="ttdoc">Enters the field due to form navigation. </div><div class="ttdef"><b>Definition:</b> <a href="TextField_8cpp_source.html#l00083">TextField.cpp:83</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="classTextField_html_a124764b6fc7c19aaf683f72cd42636b1"><div class="ttname"><a href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1">TextField::value</a></div><div class="ttdeci">const String &amp; value() const </div><div class="ttdoc">Returns the text value that is currently displayed by this field. </div><div class="ttdef"><b>Definition:</b> <a href="TextField_8h_source.html#l00035">TextField.h:35</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>