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

105
classTextField.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: TextField Class Reference</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>
@@ -90,7 +91,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div><!--header-->
<div class="contents">
<p><a class="el" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a> that displays a read-only text value.
<p><a class="el" href="classField.html" title="Manages a single data input/output field within a Form. ">Field</a> that displays a read-only text value.
<a href="classTextField.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="TextField_8h_source.html">TextField.h</a>&gt;</code></p>
@@ -100,73 +101,89 @@ Inheritance diagram for TextField:</div>
<div class="center">
<img src="classTextField.png" usemap="#TextField_map" alt=""/>
<map id="TextField_map" name="TextField_map">
<area href="classField.html" title="Manages a single data input/output field within a Form." alt="Field" shape="rect" coords="0,0,63,24"/>
<area href="classField.html" title="Manages a single data input/output field within a Form. " alt="Field" shape="rect" coords="0,0,63,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5108741ab147b2cd5a399fefbe0a2382"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTextField.html#a5108741ab147b2cd5a399fefbe0a2382">TextField</a> (const String &amp;<a class="el" href="classField.html#aaa861ef917130c989a955bc75c683afe">label</a>)</td></tr>
<tr class="memdesc:a5108741ab147b2cd5a399fefbe0a2382"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new text field with a specific <em>label</em>. <a href="#a5108741ab147b2cd5a399fefbe0a2382"></a><br/></td></tr>
<tr class="memdesc:a5108741ab147b2cd5a399fefbe0a2382"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new text field with a specific <em>label</em>. <a href="#a5108741ab147b2cd5a399fefbe0a2382">More...</a><br/></td></tr>
<tr class="separator:a5108741ab147b2cd5a399fefbe0a2382"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24096a344d9161b2c99ce724ec2ee93c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTextField.html#a24096a344d9161b2c99ce724ec2ee93c">TextField</a> (<a class="el" href="classForm.html">Form</a> &amp;<a class="el" href="classField.html#a27427319be1cc92db3128637d8884ee5">form</a>, const String &amp;<a class="el" href="classField.html#aaa861ef917130c989a955bc75c683afe">label</a>, const String &amp;<a class="el" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1">value</a>)</td></tr>
<tr class="memdesc:a24096a344d9161b2c99ce724ec2ee93c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new text field with a specific <em>label</em> and <em>value</em> attaches it to a <em>form</em>. <a href="#a24096a344d9161b2c99ce724ec2ee93c"></a><br/></td></tr>
<tr class="memdesc:a24096a344d9161b2c99ce724ec2ee93c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new text field with a specific <em>label</em> and <em>value</em> attaches it to a <em>form</em>. <a href="#a24096a344d9161b2c99ce724ec2ee93c">More...</a><br/></td></tr>
<tr class="separator:a24096a344d9161b2c99ce724ec2ee93c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa78f1354f9240b64fabd6f996e312f32"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTextField.html#aa78f1354f9240b64fabd6f996e312f32">enterField</a> (bool reverse)</td></tr>
<tr class="memdesc:aa78f1354f9240b64fabd6f996e312f32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enters the field due to form navigation. <a href="#aa78f1354f9240b64fabd6f996e312f32"></a><br/></td></tr>
<tr class="memdesc:aa78f1354f9240b64fabd6f996e312f32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enters the field due to form navigation. <a href="#aa78f1354f9240b64fabd6f996e312f32">More...</a><br/></td></tr>
<tr class="separator:aa78f1354f9240b64fabd6f996e312f32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a124764b6fc7c19aaf683f72cd42636b1"><td class="memItemLeft" align="right" valign="top">const String &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1">value</a> () const </td></tr>
<tr class="memdesc:a124764b6fc7c19aaf683f72cd42636b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the text value that is currently displayed by this field. <a href="#a124764b6fc7c19aaf683f72cd42636b1"></a><br/></td></tr>
<tr class="memdesc:a124764b6fc7c19aaf683f72cd42636b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the text value that is currently displayed by this field. <a href="#a124764b6fc7c19aaf683f72cd42636b1">More...</a><br/></td></tr>
<tr class="separator:a124764b6fc7c19aaf683f72cd42636b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24b98c5bb744331bf0a5facc8ea9c033"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTextField.html#a24b98c5bb744331bf0a5facc8ea9c033">setValue</a> (const String &amp;<a class="el" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1">value</a>)</td></tr>
<tr class="memdesc:a24b98c5bb744331bf0a5facc8ea9c033"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the text <em>value</em> that is displayed by this field. <a href="#a24b98c5bb744331bf0a5facc8ea9c033"></a><br/></td></tr>
<tr class="inherit_header pub_methods_classField"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classField')"><img src="closed.png" alt="-"/>&nbsp;Public Member Functions inherited from <a class="el" href="classField.html">Field</a></td></tr>
<tr class="memdesc:a24b98c5bb744331bf0a5facc8ea9c033"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the text <em>value</em> that is displayed by this field. <a href="#a24b98c5bb744331bf0a5facc8ea9c033">More...</a><br/></td></tr>
<tr class="separator:a24b98c5bb744331bf0a5facc8ea9c033"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classField"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classField')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classField.html">Field</a></td></tr>
<tr class="memitem:ac4ea0d104376233c3f0bfc080ec8564e inherit pub_methods_classField"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#ac4ea0d104376233c3f0bfc080ec8564e">Field</a> (const String &amp;<a class="el" href="classField.html#aaa861ef917130c989a955bc75c683afe">label</a>)</td></tr>
<tr class="memdesc:ac4ea0d104376233c3f0bfc080ec8564e inherit pub_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new field with a specific <em>label</em>. <a href="#ac4ea0d104376233c3f0bfc080ec8564e"></a><br/></td></tr>
<tr class="memdesc:ac4ea0d104376233c3f0bfc080ec8564e inherit pub_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new field with a specific <em>label</em>. <a href="#ac4ea0d104376233c3f0bfc080ec8564e">More...</a><br/></td></tr>
<tr class="separator:ac4ea0d104376233c3f0bfc080ec8564e inherit pub_methods_classField"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e2bdb203ddfd9219696f263c1731fe7 inherit pub_methods_classField"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e2bdb203ddfd9219696f263c1731fe7"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#a7e2bdb203ddfd9219696f263c1731fe7">Field</a> (<a class="el" href="classForm.html">Form</a> &amp;<a class="el" href="classField.html#a27427319be1cc92db3128637d8884ee5">form</a>, const String &amp;<a class="el" href="classField.html#aaa861ef917130c989a955bc75c683afe">label</a>)</td></tr>
<tr class="memdesc:a7e2bdb203ddfd9219696f263c1731fe7 inherit pub_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new field with a specific <em>label</em> and attaches it to a <em>form</em>. <br/></td></tr>
<tr class="separator:a7e2bdb203ddfd9219696f263c1731fe7 inherit pub_methods_classField"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45d6e6d09b8f8e46de62b40119d62c60 inherit pub_methods_classField"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#a45d6e6d09b8f8e46de62b40119d62c60">~Field</a> ()</td></tr>
<tr class="memdesc:a45d6e6d09b8f8e46de62b40119d62c60 inherit pub_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys this field and removes it from its owning <a class="el" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a>. <a href="#a45d6e6d09b8f8e46de62b40119d62c60"></a><br/></td></tr>
<tr class="memdesc:a45d6e6d09b8f8e46de62b40119d62c60 inherit pub_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys this field and removes it from its owning <a class="el" href="classForm.html" title="Manager for a form containing data input/output fields. ">Form</a>. <a href="#a45d6e6d09b8f8e46de62b40119d62c60">More...</a><br/></td></tr>
<tr class="separator:a45d6e6d09b8f8e46de62b40119d62c60 inherit pub_methods_classField"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27427319be1cc92db3128637d8884ee5 inherit pub_methods_classField"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27427319be1cc92db3128637d8884ee5"></a>
<a class="el" href="classForm.html">Form</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#a27427319be1cc92db3128637d8884ee5">form</a> () const </td></tr>
<tr class="memdesc:a27427319be1cc92db3128637d8884ee5 inherit pub_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <a class="el" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a> that owns this field; null if not associated with a <a class="el" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a>. <br/></td></tr>
<tr class="memdesc:a27427319be1cc92db3128637d8884ee5 inherit pub_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <a class="el" href="classForm.html" title="Manager for a form containing data input/output fields. ">Form</a> that owns this field; null if not associated with a <a class="el" href="classForm.html" title="Manager for a form containing data input/output fields. ">Form</a>. <br/></td></tr>
<tr class="separator:a27427319be1cc92db3128637d8884ee5 inherit pub_methods_classField"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a061bd1ed4d8b079df86465df8facd3b3 inherit pub_methods_classField"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#a061bd1ed4d8b079df86465df8facd3b3">dispatch</a> (int event)</td></tr>
<tr class="memdesc:a061bd1ed4d8b079df86465df8facd3b3 inherit pub_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatches <em>event</em> via this field. <a href="#a061bd1ed4d8b079df86465df8facd3b3"></a><br/></td></tr>
<tr class="memdesc:a061bd1ed4d8b079df86465df8facd3b3 inherit pub_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatches <em>event</em> via this field. <a href="#a061bd1ed4d8b079df86465df8facd3b3">More...</a><br/></td></tr>
<tr class="separator:a061bd1ed4d8b079df86465df8facd3b3 inherit pub_methods_classField"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6805c75ee1e62f8cd8bd550c4530c07 inherit pub_methods_classField"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#ad6805c75ee1e62f8cd8bd550c4530c07">exitField</a> ()</td></tr>
<tr class="memdesc:ad6805c75ee1e62f8cd8bd550c4530c07 inherit pub_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exits the field due to form navigation. <a href="#ad6805c75ee1e62f8cd8bd550c4530c07"></a><br/></td></tr>
<tr class="memdesc:ad6805c75ee1e62f8cd8bd550c4530c07 inherit pub_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exits the field due to form navigation. <a href="#ad6805c75ee1e62f8cd8bd550c4530c07">More...</a><br/></td></tr>
<tr class="separator:ad6805c75ee1e62f8cd8bd550c4530c07 inherit pub_methods_classField"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa861ef917130c989a955bc75c683afe inherit pub_methods_classField"><td class="memItemLeft" align="right" valign="top">const String &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#aaa861ef917130c989a955bc75c683afe">label</a> () const </td></tr>
<tr class="memdesc:aaa861ef917130c989a955bc75c683afe inherit pub_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the label to display in the first line of this field. <a href="#aaa861ef917130c989a955bc75c683afe"></a><br/></td></tr>
<tr class="memdesc:aaa861ef917130c989a955bc75c683afe inherit pub_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the label to display in the first line of this field. <a href="#aaa861ef917130c989a955bc75c683afe">More...</a><br/></td></tr>
<tr class="separator:aaa861ef917130c989a955bc75c683afe inherit pub_methods_classField"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4ea63599d780c35b296cf2840b69f7b inherit pub_methods_classField"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#ad4ea63599d780c35b296cf2840b69f7b">setLabel</a> (const String &amp;<a class="el" href="classField.html#aaa861ef917130c989a955bc75c683afe">label</a>)</td></tr>
<tr class="memdesc:ad4ea63599d780c35b296cf2840b69f7b inherit pub_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the <em>label</em> to display in the first line of this field. <a href="#ad4ea63599d780c35b296cf2840b69f7b"></a><br/></td></tr>
<tr class="memdesc:ad4ea63599d780c35b296cf2840b69f7b inherit pub_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the <em>label</em> to display in the first line of this field. <a href="#ad4ea63599d780c35b296cf2840b69f7b">More...</a><br/></td></tr>
<tr class="separator:ad4ea63599d780c35b296cf2840b69f7b inherit pub_methods_classField"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25d86a67b321e8c642edf75a10a35f72 inherit pub_methods_classField"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#a25d86a67b321e8c642edf75a10a35f72">isCurrent</a> () const </td></tr>
<tr class="memdesc:a25d86a67b321e8c642edf75a10a35f72 inherit pub_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if this field is the currently-displayed field in its owning form; false otherwise. <a href="#a25d86a67b321e8c642edf75a10a35f72"></a><br/></td></tr>
<tr class="memdesc:a25d86a67b321e8c642edf75a10a35f72 inherit pub_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if this field is the currently-displayed field in its owning form; false otherwise. <a href="#a25d86a67b321e8c642edf75a10a35f72">More...</a><br/></td></tr>
<tr class="separator:a25d86a67b321e8c642edf75a10a35f72 inherit pub_methods_classField"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="inherited"></a>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classField"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classField')"><img src="closed.png" alt="-"/>&nbsp;Protected Member Functions inherited from <a class="el" href="classField.html">Field</a></td></tr>
<tr class="inherit_header pro_methods_classField"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classField')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classField.html">Field</a></td></tr>
<tr class="memitem:a5cf21bf958a71e51feac9e1bf9f599d1 inherit pro_methods_classField"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5cf21bf958a71e51feac9e1bf9f599d1"></a>
LiquidCrystal *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1">lcd</a> () const </td></tr>
<tr class="memdesc:a5cf21bf958a71e51feac9e1bf9f599d1 inherit pro_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <a class="el" href="classLCD.html" title="Enhanced library for Freetronics 16x2 LCD shields.">LCD</a> that this field is being drawn on. <br/></td></tr>
<tr class="memdesc:a5cf21bf958a71e51feac9e1bf9f599d1 inherit pro_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <a class="el" href="classLCD.html" title="Enhanced library for Freetronics 16x2 LCD shields. ">LCD</a> that this field is being drawn on. <br/></td></tr>
<tr class="separator:a5cf21bf958a71e51feac9e1bf9f599d1 inherit pro_methods_classField"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc612378167be0e7f8a6f8395b3537bd inherit pro_methods_classField"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#afc612378167be0e7f8a6f8395b3537bd">updateCursor</a> ()</td></tr>
<tr class="memdesc:afc612378167be0e7f8a6f8395b3537bd inherit pro_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the cursor position after the label has been drawn by <a class="el" href="classField.html#ad4ea63599d780c35b296cf2840b69f7b" title="Sets the label to display in the first line of this field.">setLabel()</a>. <a href="#afc612378167be0e7f8a6f8395b3537bd"></a><br/></td></tr>
<tr class="memdesc:afc612378167be0e7f8a6f8395b3537bd inherit pro_methods_classField"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the cursor position after the label has been drawn by <a class="el" href="classField.html#ad4ea63599d780c35b296cf2840b69f7b" title="Sets the label to display in the first line of this field. ">setLabel()</a>. <a href="#afc612378167be0e7f8a6f8395b3537bd">More...</a><br/></td></tr>
<tr class="separator:afc612378167be0e7f8a6f8395b3537bd inherit pro_methods_classField"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a> that displays a read-only text value. </p>
<p>This following example displays a text field with the label "Form example" and a <a class="el" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1" title="Returns the text value that is currently displayed by this field.">value()</a> of "v1.0".</p>
<div class="fragment"><div class="line"><a class="code" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a> mainForm(lcd);</div>
<div class="line"><a class="code" href="classTextField.html" title="Field that displays a read-only text value.">TextField</a> welcomeField(mainForm, <span class="stringliteral">&quot;Form example&quot;</span>, <span class="stringliteral">&quot;v1.0&quot;</span>);</div>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classField.html" title="Manages a single data input/output field within a Form. ">Field</a> that displays a read-only text value. </p>
<p>This following example displays a text field with the label "Form example" and a <a class="el" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1" title="Returns the text value that is currently displayed by this field. ">value()</a> of "v1.0".</p>
<div class="fragment"><div class="line"><a class="code" href="classForm.html">Form</a> mainForm(lcd);</div>
<div class="line"><a class="code" href="classTextField.html">TextField</a> welcomeField(mainForm, <span class="stringliteral">&quot;Form example&quot;</span>, <span class="stringliteral">&quot;v1.0&quot;</span>);</div>
</div><!-- fragment --><div class="image">
<img src="FormText.png" alt="FormText.png"/>
</div>
<p>As well as static messages, <a class="el" href="classTextField.html" title="Field that displays a read-only text value.">TextField</a> can be used to display read-only information that is computed at runtime:</p>
<div class="fragment"><div class="line"><a class="code" href="classTextField.html" title="Field that displays a read-only text value.">TextField</a> timeField(mainForm, <span class="stringliteral">&quot;Time since reset&quot;</span>, <span class="stringliteral">&quot;0&quot;</span>);</div>
<p>As well as static messages, <a class="el" href="classTextField.html" title="Field that displays a read-only text value. ">TextField</a> can be used to display read-only information that is computed at runtime:</p>
<div class="fragment"><div class="line"><a class="code" href="classTextField.html">TextField</a> timeField(mainForm, <span class="stringliteral">&quot;Time since reset&quot;</span>, <span class="stringliteral">&quot;0&quot;</span>);</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> loop() {</div>
<div class="line"> timeField.setValue(millis() / 1000);</div>
<div class="line"> mainForm.dispatch(lcd.<a class="code" href="classLCD.html#ac1e80e2603bd1cf0276c36092c416292" title="Gets the next button press, release, or idle event.">getButton</a>());</div>
<div class="line"> mainForm.dispatch(lcd.<a class="code" href="classLCD.html#ac1e80e2603bd1cf0276c36092c416292">getButton</a>());</div>
<div class="line">}</div>
</div><!-- fragment --><p>For writable fields, use <a class="el" href="classBoolField.html" title="Field that manages the input of a boolean value.">BoolField</a>, <a class="el" href="classIntField.html" title="Field that manages the input of an integer value.">IntField</a>, or <a class="el" href="classTimeField.html" title="Field that manages the display and editing of a time value.">TimeField</a>.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a> </dd></dl>
</div><!-- fragment --><p>For writable fields, use <a class="el" href="classBoolField.html" title="Field that manages the input of a boolean value. ">BoolField</a>, <a class="el" href="classIntField.html" title="Field that manages the input of an integer value. ">IntField</a>, or <a class="el" href="classTimeField.html" title="Field that manages the display and editing of a time value. ">TimeField</a>.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classField.html" title="Manages a single data input/output field within a Form. ">Field</a> </dd></dl>
<p>Definition at line <a class="el" href="TextField_8h_source.html#l00028">28</a> of file <a class="el" href="TextField_8h_source.html">TextField.h</a>.</p>
</div><h2>Constructor &amp; Destructor Documentation</h2>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5108741ab147b2cd5a399fefbe0a2382"></a>
<div class="memitem">
<div class="memproto">
@@ -190,9 +207,9 @@ LiquidCrystal *&#160;</td><td class="memItemRight" valign="bottom"><a class="el"
</div><div class="memdoc">
<p>Constructs a new text field with a specific <em>label</em>. </p>
<p>The field is initially not associated with a <a class="el" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a>. The field can be added to a form later using <a class="el" href="classForm.html#a5cb056ace428e75e321610555bfecac7" title="Adds field to this form.">Form::addField()</a>.</p>
<p>The initial <a class="el" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1" title="Returns the text value that is currently displayed by this field.">value()</a> will be the empty string.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classForm.html#a5cb056ace428e75e321610555bfecac7" title="Adds field to this form.">Form::addField()</a> </dd></dl>
<p>The field is initially not associated with a <a class="el" href="classForm.html" title="Manager for a form containing data input/output fields. ">Form</a>. The field can be added to a form later using <a class="el" href="classForm.html#a5cb056ace428e75e321610555bfecac7" title="Adds field to this form. ">Form::addField()</a>.</p>
<p>The initial <a class="el" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1" title="Returns the text value that is currently displayed by this field. ">value()</a> will be the empty string.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classForm.html#a5cb056ace428e75e321610555bfecac7" title="Adds field to this form. ">Form::addField()</a> </dd></dl>
<p>Definition at line <a class="el" href="TextField_8cpp_source.html#l00066">66</a> of file <a class="el" href="TextField_8cpp_source.html">TextField.cpp</a>.</p>
@@ -229,13 +246,13 @@ LiquidCrystal *&#160;</td><td class="memItemRight" valign="bottom"><a class="el"
</div><div class="memdoc">
<p>Constructs a new text field with a specific <em>label</em> and <em>value</em> attaches it to a <em>form</em>. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1" title="Returns the text value that is currently displayed by this field.">value()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1" title="Returns the text value that is currently displayed by this field. ">value()</a> </dd></dl>
<p>Definition at line <a class="el" href="TextField_8cpp_source.html#l00077">77</a> of file <a class="el" href="TextField_8cpp_source.html">TextField.cpp</a>.</p>
</div>
</div>
<h2>Member Function Documentation</h2>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa78f1354f9240b64fabd6f996e312f32"></a>
<div class="memitem">
<div class="memproto">
@@ -261,8 +278,8 @@ LiquidCrystal *&#160;</td><td class="memItemRight" valign="bottom"><a class="el"
<p>Enters the field due to form navigation. </p>
<p>This function is typically called when the user presses Left and Right buttons to navigate to the field. If <em>reverse</em> is true, then navigation was due to the Left button being pressed.</p>
<p>This function can assume that the display has been cleared and the cursor is positioned at (0, 0).</p>
<p>The default implementation prints the <a class="el" href="classField.html#aaa861ef917130c989a955bc75c683afe" title="Returns the label to display in the first line of this field.">label()</a>.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classField.html#ad6805c75ee1e62f8cd8bd550c4530c07" title="Exits the field due to form navigation.">exitField()</a> </dd></dl>
<p>The default implementation prints the <a class="el" href="classField.html#aaa861ef917130c989a955bc75c683afe" title="Returns the label to display in the first line of this field. ">label()</a>.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classField.html#ad6805c75ee1e62f8cd8bd550c4530c07" title="Exits the field due to form navigation. ">exitField()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classField.html#aa032bbeacb405c56546cb56fbbee94f5">Field</a>.</p>
@@ -285,7 +302,7 @@ LiquidCrystal *&#160;</td><td class="memItemRight" valign="bottom"><a class="el"
</div><div class="memdoc">
<p>Sets the text <em>value</em> that is displayed by this field. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1" title="Returns the text value that is currently displayed by this field.">value()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1" title="Returns the text value that is currently displayed by this field. ">value()</a> </dd></dl>
<p>Definition at line <a class="el" href="TextField_8cpp_source.html#l00102">102</a> of file <a class="el" href="TextField_8cpp_source.html">TextField.cpp</a>.</p>
@@ -313,7 +330,7 @@ LiquidCrystal *&#160;</td><td class="memItemRight" valign="bottom"><a class="el"
</div><div class="memdoc">
<p>Returns the text value that is currently displayed by this field. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classTextField.html#a24b98c5bb744331bf0a5facc8ea9c033" title="Sets the text value that is displayed by this field.">setValue()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classTextField.html#a24b98c5bb744331bf0a5facc8ea9c033" title="Sets the text value that is displayed by this field. ">setValue()</a> </dd></dl>
<p>Definition at line <a class="el" href="TextField_8h_source.html#l00035">35</a> of file <a class="el" href="TextField_8h_source.html">TextField.h</a>.</p>
@@ -326,9 +343,9 @@ LiquidCrystal *&#160;</td><td class="memItemRight" valign="bottom"><a class="el"
</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>