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

100
classField.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 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>
@@ -92,7 +93,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div><!--header-->
<div class="contents">
<p>Manages a single data input/output field within a <a class="el" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a>.
<p>Manages a single data input/output field within a <a class="el" href="classForm.html" title="Manager for a form containing data input/output fields. ">Form</a>.
<a href="classField.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Field_8h_source.html">Field.h</a>&gt;</code></p>
@@ -102,58 +103,71 @@ Inheritance diagram for Field:</div>
<div class="center">
<img src="classField.png" usemap="#Field_map" alt=""/>
<map id="Field_map" name="Field_map">
<area href="classBoolField.html" title="Field that manages the input of a boolean value." alt="BoolField" shape="rect" coords="0,56,66,80"/>
<area href="classIntField.html" title="Field that manages the input of an integer value." alt="IntField" shape="rect" coords="76,56,142,80"/>
<area href="classListField.html" title="Field that manages selection from a static list of items." alt="ListField" shape="rect" coords="152,56,218,80"/>
<area href="classTextField.html" title="Field that displays a read-only text value." alt="TextField" shape="rect" coords="228,56,294,80"/>
<area href="classTimeField.html" title="Field that manages the display and editing of a time value." alt="TimeField" shape="rect" coords="304,56,370,80"/>
<area href="classBoolField.html" title="Field that manages the input of a boolean value. " alt="BoolField" shape="rect" coords="0,56,66,80"/>
<area href="classIntField.html" title="Field that manages the input of an integer value. " alt="IntField" shape="rect" coords="76,56,142,80"/>
<area href="classListField.html" title="Field that manages selection from a static list of items. " alt="ListField" shape="rect" coords="152,56,218,80"/>
<area href="classTextField.html" title="Field that displays a read-only text value. " alt="TextField" shape="rect" coords="228,56,294,80"/>
<area href="classTimeField.html" title="Field that manages the display and editing of a time value. " alt="TimeField" shape="rect" coords="304,56,370,80"/>
</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:ac4ea0d104376233c3f0bfc080ec8564e"><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"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e2bdb203ddfd9219696f263c1731fe7"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45d6e6d09b8f8e46de62b40119d62c60"><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"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27427319be1cc92db3128637d8884ee5"><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"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a061bd1ed4d8b079df86465df8facd3b3"><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"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa032bbeacb405c56546cb56fbbee94f5"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#aa032bbeacb405c56546cb56fbbee94f5">enterField</a> (bool reverse)</td></tr>
<tr class="memdesc:aa032bbeacb405c56546cb56fbbee94f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enters the field due to form navigation. <a href="#aa032bbeacb405c56546cb56fbbee94f5"></a><br/></td></tr>
<tr class="memdesc:aa032bbeacb405c56546cb56fbbee94f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enters the field due to form navigation. <a href="#aa032bbeacb405c56546cb56fbbee94f5">More...</a><br/></td></tr>
<tr class="separator:aa032bbeacb405c56546cb56fbbee94f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6805c75ee1e62f8cd8bd550c4530c07"><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"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa861ef917130c989a955bc75c683afe"><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"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4ea63599d780c35b296cf2840b69f7b"><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"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25d86a67b321e8c642edf75a10a35f72"><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"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pro-methods"></a>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a5cf21bf958a71e51feac9e1bf9f599d1"><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"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc612378167be0e7f8a6f8395b3537bd"><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"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="friends"></a>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a75f6d4e61f8386b6958279e02d9e38ea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75f6d4e61f8386b6958279e02d9e38ea"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>Form</b></td></tr>
<tr class="separator:a75f6d4e61f8386b6958279e02d9e38ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Manages a single data input/output field within a <a class="el" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a>. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a>, <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>, <a class="el" href="classListField.html" title="Field that manages selection from a static list of items.">ListField</a>, <a class="el" href="classTextField.html" title="Field that displays a read-only text value.">TextField</a>, <a class="el" href="classTimeField.html" title="Field that manages the display and editing of a time value.">TimeField</a> </dd></dl>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Manages a single data input/output field within a <a class="el" href="classForm.html" title="Manager for a form containing data input/output fields. ">Form</a>. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classForm.html" title="Manager for a form containing data input/output fields. ">Form</a>, <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>, <a class="el" href="classListField.html" title="Field that manages selection from a static list of items. ">ListField</a>, <a class="el" href="classTextField.html" title="Field that displays a read-only text value. ">TextField</a>, <a class="el" href="classTimeField.html" title="Field that manages the display and editing of a time value. ">TimeField</a> </dd></dl>
<p>Definition at line <a class="el" href="Field_8h_source.html#l00028">28</a> of file <a class="el" href="Field_8h_source.html">Field.h</a>.</p>
</div><h2>Constructor &amp; Destructor Documentation</h2>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ac4ea0d104376233c3f0bfc080ec8564e"></a>
<div class="memitem">
<div class="memproto">
@@ -177,8 +191,8 @@ class&#160;</td><td class="memItemRight" valign="bottom"><b>Form</b></td></tr>
</div><div class="memdoc">
<p>Constructs a new 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>
<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>
<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="Field_8cpp_source.html#l00040">40</a> of file <a class="el" href="Field_8cpp_source.html">Field.cpp</a>.</p>
@@ -197,14 +211,14 @@ class&#160;</td><td class="memItemRight" valign="bottom"><b>Form</b></td></tr>
</table>
</div><div class="memdoc">
<p>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>. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classForm.html#a7abd717029f9b19ee7318470072cd697" title="Removes field from this form.">Form::removeField()</a> </dd></dl>
<p>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>. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classForm.html#a7abd717029f9b19ee7318470072cd697" title="Removes field from this form. ">Form::removeField()</a> </dd></dl>
<p>Definition at line <a class="el" href="Field_8cpp_source.html#l00066">66</a> of file <a class="el" href="Field_8cpp_source.html">Field.cpp</a>.</p>
</div>
</div>
<h2>Member Function Documentation</h2>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a061bd1ed4d8b079df86465df8facd3b3"></a>
<div class="memitem">
<div class="memproto">
@@ -228,11 +242,11 @@ class&#160;</td><td class="memItemRight" valign="bottom"><b>Form</b></td></tr>
</div><div class="memdoc">
<p>Dispatches <em>event</em> via this field. </p>
<p>The <em>event</em> is usually obtained from <a class="el" href="classLCD.html#ac1e80e2603bd1cf0276c36092c416292" title="Gets the next button press, release, or idle event.">LCD::getButton()</a>.</p>
<p>The <em>event</em> is usually obtained from <a class="el" href="classLCD.html#ac1e80e2603bd1cf0276c36092c416292" title="Gets the next button press, release, or idle event. ">LCD::getButton()</a>.</p>
<p>Returns zero if the <em>event</em> has been handled and no further action is required.</p>
<p>Returns FORM_CHANGED if the <em>event</em> has changed the value of this field in a manner that may require the application to take further action based on the new field value.</p>
<p>Returns -1 if the <em>event</em> is not handled by this field, and should be handled by the <a class="el" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a> itself (particularly for Left and Right buttons). The default implementation returns -1 for all events.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classForm.html#a89bd3850e87caa2ca7b2e946f923d0ee" title="Dispatches event to the currently active field using Field::dispatch().">Form::dispatch()</a>, <a class="el" href="classLCD.html#ac1e80e2603bd1cf0276c36092c416292" title="Gets the next button press, release, or idle event.">LCD::getButton()</a> </dd></dl>
<p>Returns -1 if the <em>event</em> is not handled by this field, and should be handled by the <a class="el" href="classForm.html" title="Manager for a form containing data input/output fields. ">Form</a> itself (particularly for Left and Right buttons). The default implementation returns -1 for all events.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classForm.html#a89bd3850e87caa2ca7b2e946f923d0ee" title="Dispatches event to the currently active field using Field::dispatch(). ">Form::dispatch()</a>, <a class="el" href="classLCD.html#ac1e80e2603bd1cf0276c36092c416292" title="Gets the next button press, release, or idle event. ">LCD::getButton()</a> </dd></dl>
<p>Reimplemented in <a class="el" href="classListField.html#a5d752bd561cde735b175bcdfda55832a">ListField</a>, <a class="el" href="classTimeField.html#a9b953d9abdbe960a3fa34938462832e5">TimeField</a>, <a class="el" href="classIntField.html#a01a17d5a89c76c42c4f0516984ce653f">IntField</a>, and <a class="el" href="classBoolField.html#af793bafc1193d79b495c2ede711bca57">BoolField</a>.</p>
@@ -265,8 +279,8 @@ class&#160;</td><td class="memItemRight" valign="bottom"><b>Form</b></td></tr>
<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 in <a class="el" href="classListField.html#a191b79b460e45cf48e04b04eface2888">ListField</a>, <a class="el" href="classTimeField.html#ae914d6b870283a334d2d669460f7646b">TimeField</a>, <a class="el" href="classIntField.html#a51d9127b660e8dd7f87718acd230202a">IntField</a>, <a class="el" href="classBoolField.html#ab3f1e610b52caed7e41016f6ae3d7d09">BoolField</a>, and <a class="el" href="classTextField.html#aa78f1354f9240b64fabd6f996e312f32">TextField</a>.</p>
@@ -297,7 +311,7 @@ class&#160;</td><td class="memItemRight" valign="bottom"><b>Form</b></td></tr>
<p>Exits the field due to form navigation. </p>
<p>This function is typically called when the user presses Left and Right buttons to navigate from the field.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classField.html#aa032bbeacb405c56546cb56fbbee94f5" title="Enters the field due to form navigation.">enterField()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classField.html#aa032bbeacb405c56546cb56fbbee94f5" title="Enters the field due to form navigation. ">enterField()</a> </dd></dl>
<p>Reimplemented in <a class="el" href="classTimeField.html#a5a6b7db2e3fda7745e0ff9c3d8d9a541">TimeField</a>.</p>
@@ -347,7 +361,7 @@ class&#160;</td><td class="memItemRight" valign="bottom"><b>Form</b></td></tr>
</div><div class="memdoc">
<p>Returns the label to display in the first line of this field. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classField.html#ad4ea63599d780c35b296cf2840b69f7b" title="Sets the label to display in the first line of this field.">setLabel()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classField.html#ad4ea63599d780c35b296cf2840b69f7b" title="Sets the label to display in the first line of this field. ">setLabel()</a> </dd></dl>
<p>Definition at line <a class="el" href="Field_8h_source.html#l00041">41</a> of file <a class="el" href="Field_8h_source.html">Field.h</a>.</p>
@@ -368,7 +382,7 @@ class&#160;</td><td class="memItemRight" valign="bottom"><b>Form</b></td></tr>
</div><div class="memdoc">
<p>Sets the <em>label</em> to display in the first line of this field. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classField.html#aaa861ef917130c989a955bc75c683afe" title="Returns the label to display in the first line of this field.">label()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classField.html#aaa861ef917130c989a955bc75c683afe" title="Returns the label to display in the first line of this field. ">label()</a> </dd></dl>
<p>Definition at line <a class="el" href="Field_8cpp_source.html#l00146">146</a> of file <a class="el" href="Field_8cpp_source.html">Field.cpp</a>.</p>
@@ -395,9 +409,9 @@ class&#160;</td><td class="memItemRight" valign="bottom"><b>Form</b></td></tr>
</table>
</div><div class="memdoc">
<p>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>. </p>
<p>The default implementation does nothing. Subclasses that use an <a class="el" href="classLCD.html" title="Enhanced library for Freetronics 16x2 LCD shields.">LCD</a> cursor may override this to ensure that the cursor position stays valid after the label is modified.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classField.html#ad4ea63599d780c35b296cf2840b69f7b" title="Sets the label to display in the first line of this field.">setLabel()</a> </dd></dl>
<p>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>. </p>
<p>The default implementation does nothing. Subclasses that use an <a class="el" href="classLCD.html" title="Enhanced library for Freetronics 16x2 LCD shields. ">LCD</a> cursor may override this to ensure that the cursor position stays valid after the label is modified.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classField.html#ad4ea63599d780c35b296cf2840b69f7b" title="Sets the label to display in the first line of this field. ">setLabel()</a> </dd></dl>
<p>Definition at line <a class="el" href="Field_8cpp_source.html#l00191">191</a> of file <a class="el" href="Field_8cpp_source.html">Field.cpp</a>.</p>
@@ -410,9 +424,9 @@ class&#160;</td><td class="memItemRight" valign="bottom"><b>Form</b></td></tr>
</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>