mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
368 lines
25 KiB
HTML
368 lines
25 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<title>ArduinoLibs: Field Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body onload='searchBox.OnSelectItem(0);'>
|
|
<!-- Generated by Doxygen 1.7.4 -->
|
|
<script type="text/javascript"><!--
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
--></script>
|
|
<div id="top">
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">ArduinoLibs</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li id="searchli">
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#friends">Friends</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Field Class Reference</div> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<!-- doxytag: class="Field" -->
|
|
<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 <<a class="el" href="Field_8h_source.html">Field.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for Field:</div>
|
|
<div class="dyncontent">
|
|
<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"/>
|
|
</map>
|
|
</div></div>
|
|
|
|
<p><a href="classField-members.html">List of all members.</a></p>
|
|
<table class="memberdecls">
|
|
<tr><td colspan="2"><h2><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#ac4ea0d104376233c3f0bfc080ec8564e">Field</a> (const String &label)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new field with a specific <em>label</em>. <a href="#ac4ea0d104376233c3f0bfc080ec8564e"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e2bdb203ddfd9219696f263c1731fe7"></a><!-- doxytag: member="Field::Field" ref="a7e2bdb203ddfd9219696f263c1731fe7" args="(Form &form, const String &label)" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#a7e2bdb203ddfd9219696f263c1731fe7">Field</a> (<a class="el" href="classForm.html">Form</a> &form, const String &label)</td></tr>
|
|
<tr><td class="mdescLeft"> </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><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#a45d6e6d09b8f8e46de62b40119d62c60">~Field</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </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><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27427319be1cc92db3128637d8884ee5"></a><!-- doxytag: member="Field::form" ref="a27427319be1cc92db3128637d8884ee5" args="() const " -->
|
|
<a class="el" href="classForm.html">Form</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#a27427319be1cc92db3128637d8884ee5">form</a> () const </td></tr>
|
|
<tr><td class="mdescLeft"> </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><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#a061bd1ed4d8b079df86465df8facd3b3">dispatch</a> (int event)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dispatches <em>event</em> via this field. <a href="#a061bd1ed4d8b079df86465df8facd3b3"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#aa032bbeacb405c56546cb56fbbee94f5">enterField</a> (bool reverse)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enters the field due to form navigation. <a href="#aa032bbeacb405c56546cb56fbbee94f5"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#ad6805c75ee1e62f8cd8bd550c4530c07">exitField</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Exits the field due to form navigation. <a href="#ad6805c75ee1e62f8cd8bd550c4530c07"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">const String & </td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#aaa861ef917130c989a955bc75c683afe">label</a> () const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the label to display in the first line of this field. <a href="#aaa861ef917130c989a955bc75c683afe"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#ad4ea63599d780c35b296cf2840b69f7b">setLabel</a> (const String &label)</td></tr>
|
|
<tr><td class="mdescLeft"> </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><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#a25d86a67b321e8c642edf75a10a35f72">isCurrent</a> () const </td></tr>
|
|
<tr><td class="mdescLeft"> </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><td colspan="2"><h2><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5cf21bf958a71e51feac9e1bf9f599d1"></a><!-- doxytag: member="Field::lcd" ref="a5cf21bf958a71e51feac9e1bf9f599d1" args="() const " -->
|
|
LiquidCrystal * </td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1">lcd</a> () const </td></tr>
|
|
<tr><td class="mdescLeft"> </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><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#afc612378167be0e7f8a6f8395b3537bd">updateCursor</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </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><td colspan="2"><h2><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75f6d4e61f8386b6958279e02d9e38ea"></a><!-- doxytag: member="Field::Form" ref="a75f6d4e61f8386b6958279e02d9e38ea" args="" -->
|
|
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classField.html#a75f6d4e61f8386b6958279e02d9e38ea">Form</a></td></tr>
|
|
</table>
|
|
<hr/><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="see"><dt><b>See also:</b></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><hr/><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="ac4ea0d104376233c3f0bfc080ec8564e"></a><!-- doxytag: member="Field::Field" ref="ac4ea0d104376233c3f0bfc080ec8564e" args="(const String &label)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Field::Field </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const String & </td>
|
|
<td class="paramname"><em>label</em></td><td>)</td>
|
|
<td><code> [explicit]</code></td>
|
|
</tr>
|
|
</table>
|
|
</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="see"><dt><b>See also:</b></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>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a45d6e6d09b8f8e46de62b40119d62c60"></a><!-- doxytag: member="Field::~Field" ref="a45d6e6d09b8f8e46de62b40119d62c60" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Field::~Field </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></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="see"><dt><b>See also:</b></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>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="a061bd1ed4d8b079df86465df8facd3b3"></a><!-- doxytag: member="Field::dispatch" ref="a061bd1ed4d8b079df86465df8facd3b3" args="(int event)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int Field::dispatch </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>event</em></td><td>)</td>
|
|
<td><code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</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>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="see"><dt><b>See also:</b></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="classBoolField.html#af793bafc1193d79b495c2ede711bca57">BoolField</a>, <a class="el" href="classIntField.html#a01a17d5a89c76c42c4f0516984ce653f">IntField</a>, <a class="el" href="classListField.html#a5d752bd561cde735b175bcdfda55832a">ListField</a>, and <a class="el" href="classTimeField.html#a9b953d9abdbe960a3fa34938462832e5">TimeField</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="Field_8cpp_source.html#l00096">96</a> of file <a class="el" href="Field_8cpp_source.html">Field.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa032bbeacb405c56546cb56fbbee94f5"></a><!-- doxytag: member="Field::enterField" ref="aa032bbeacb405c56546cb56fbbee94f5" args="(bool reverse)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Field::enterField </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>reverse</em></td><td>)</td>
|
|
<td><code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<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="see"><dt><b>See also:</b></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="classBoolField.html#ab3f1e610b52caed7e41016f6ae3d7d09">BoolField</a>, <a class="el" href="classIntField.html#a51d9127b660e8dd7f87718acd230202a">IntField</a>, <a class="el" href="classListField.html#a191b79b460e45cf48e04b04eface2888">ListField</a>, <a class="el" href="classTextField.html#aa78f1354f9240b64fabd6f996e312f32">TextField</a>, and <a class="el" href="classTimeField.html#ae914d6b870283a334d2d669460f7646b">TimeField</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="Field_8cpp_source.html#l00116">116</a> of file <a class="el" href="Field_8cpp_source.html">Field.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad6805c75ee1e62f8cd8bd550c4530c07"></a><!-- doxytag: member="Field::exitField" ref="ad6805c75ee1e62f8cd8bd550c4530c07" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Field::exitField </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td><code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<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="see"><dt><b>See also:</b></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>
|
|
|
|
<p>Definition at line <a class="el" href="Field_8cpp_source.html#l00129">129</a> of file <a class="el" href="Field_8cpp_source.html">Field.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a25d86a67b321e8c642edf75a10a35f72"></a><!-- doxytag: member="Field::isCurrent" ref="a25d86a67b321e8c642edf75a10a35f72" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Field::isCurrent </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns true if this field is the currently-displayed field in its owning form; false otherwise. </p>
|
|
<p>This function should be called from property setters in subclasses to determine if the screen should be updated when a property is modified. </p>
|
|
|
|
<p>Definition at line <a class="el" href="Field_8cpp_source.html#l00169">169</a> of file <a class="el" href="Field_8cpp_source.html">Field.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aaa861ef917130c989a955bc75c683afe"></a><!-- doxytag: member="Field::label" ref="aaa861ef917130c989a955bc75c683afe" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const String & Field::label </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns the label to display in the first line of this field. </p>
|
|
<dl class="see"><dt><b>See also:</b></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>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad4ea63599d780c35b296cf2840b69f7b"></a><!-- doxytag: member="Field::setLabel" ref="ad4ea63599d780c35b296cf2840b69f7b" args="(const String &label)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Field::setLabel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const String & </td>
|
|
<td class="paramname"><em>label</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Sets the <em>label</em> to display in the first line of this field. </p>
|
|
<dl class="see"><dt><b>See also:</b></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>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afc612378167be0e7f8a6f8395b3537bd"></a><!-- doxytag: member="Field::updateCursor" ref="afc612378167be0e7f8a6f8395b3537bd" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Field::updateCursor </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td><code> [protected, virtual]</code></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="see"><dt><b>See also:</b></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>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="Field_8h_source.html">Field.h</a></li>
|
|
<li><a class="el" href="Field_8cpp_source.html">Field.cpp</a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<hr class="footer"/><address class="footer"><small>Generated on Fri Jun 1 2012 14:29:17 for ArduinoLibs by 
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
|
|
</body>
|
|
</html>
|