mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
518 lines
39 KiB
HTML
518 lines
39 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: IntField 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> </div>
|
|
<div class="headertitle">
|
|
<div class="title">IntField Class Reference</div> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<!-- doxytag: class="IntField" --><!-- doxytag: inherits="Field" -->
|
|
<p><a class="el" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a> that manages the input of an integer value.
|
|
<a href="classIntField.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="IntField_8h_source.html">IntField.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for IntField:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classIntField.png" usemap="#IntField_map" alt=""/>
|
|
<map id="IntField_map" name="IntField_map">
|
|
<area href="classField.html" title="Manages a single data input/output field within a Form." alt="Field" shape="rect" coords="0,0,53,24"/>
|
|
</map>
|
|
</div></div>
|
|
|
|
<p><a href="classIntField-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="classIntField.html#a9df274c4100ed37d2d78738f09fc53b6">IntField</a> (const String &label)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new integer field with a specific <em>label</em>. <a href="#a9df274c4100ed37d2d78738f09fc53b6"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIntField.html#a10c9c958bcde276698f1f1f9bff949dd">IntField</a> (<a class="el" href="classForm.html">Form</a> &form, const String &label, int minValue, int maxValue, int stepValue, int value)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new integer field with a specific <em>label</em>, <em>minValue</em>, <em>maxValue</em>, <em>stepValue</em>, and <em>value</em>, and attaches it to a <em>form</em>. <a href="#a10c9c958bcde276698f1f1f9bff949dd"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b99fa19be6a0ed01ddc4939352b372e"></a><!-- doxytag: member="IntField::IntField" ref="a2b99fa19be6a0ed01ddc4939352b372e" args="(Form &form, const String &label, int minValue, int maxValue, int stepValue, int value, const String &suffix)" -->
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classIntField.html#a2b99fa19be6a0ed01ddc4939352b372e">IntField</a> (<a class="el" href="classForm.html">Form</a> &form, const String &label, int minValue, int maxValue, int stepValue, int value, const String &suffix)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new integer field with a specific <em>label</em>, <em>minValue</em>, <em>maxValue</em>, <em>stepValue</em>, <em>value</em>, and <em>suffix</em> and attaches it to a <em>form</em>. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classIntField.html#a01a17d5a89c76c42c4f0516984ce653f">dispatch</a> (int event)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dispatches <em>event</em> via this field. <a href="#a01a17d5a89c76c42c4f0516984ce653f"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIntField.html#a51d9127b660e8dd7f87718acd230202a">enterField</a> (bool reverse)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enters the field due to form navigation. <a href="#a51d9127b660e8dd7f87718acd230202a"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classIntField.html#af3dab3f2b46d29136d7a93ce46b0b8fb">minValue</a> () const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the minimum value for the input field. <a href="#af3dab3f2b46d29136d7a93ce46b0b8fb"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIntField.html#afffe7be6721a043cec7a5a85c19e0ada">setMinValue</a> (int value)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the minimum <em>value</em> for the input field. <a href="#afffe7be6721a043cec7a5a85c19e0ada"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classIntField.html#aaa0adcb0d16e822e5f176be5cb9ca8ad">maxValue</a> () const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the maximum value for the input field. <a href="#aaa0adcb0d16e822e5f176be5cb9ca8ad"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIntField.html#a36cbd7c24480cc3fcf0c7634d5e22bf1">setMaxValue</a> (int value)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the maximum <em>value</em> for the input field. <a href="#a36cbd7c24480cc3fcf0c7634d5e22bf1"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classIntField.html#a49025ee3473fe066a6a6c546af98bfbd">stepValue</a> () const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the step value to use when increasing or decreasing the <a class="el" href="classIntField.html#a2fb650827ce8cb4662253bb6c32acb52" title="Returns the current value of this field.">value()</a> due to Up and Down button presses. <a href="#a49025ee3473fe066a6a6c546af98bfbd"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIntField.html#a8fb6e207bd906062bb788e19dbe58bcb">setStepValue</a> (int value)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the step value <em>value</em> to use when increasing or decreasing the <a class="el" href="classIntField.html#a2fb650827ce8cb4662253bb6c32acb52" title="Returns the current value of this field.">value()</a> due to Up and Down button presses. <a href="#a8fb6e207bd906062bb788e19dbe58bcb"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classIntField.html#a2fb650827ce8cb4662253bb6c32acb52">value</a> () const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current value of this field. <a href="#a2fb650827ce8cb4662253bb6c32acb52"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIntField.html#aed421e2c52946f2c7643534b4f6f13f7">setValue</a> (int value)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the current <em>value</em> of this field. <a href="#aed421e2c52946f2c7643534b4f6f13f7"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">const String & </td><td class="memItemRight" valign="bottom"><a class="el" href="classIntField.html#a1a1de6a1836dfdb820c92b7f188a1b05">suffix</a> () const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the suffix string to be displayed after the field's value. <a href="#a1a1de6a1836dfdb820c92b7f188a1b05"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIntField.html#a9324bba994389f3a4563d9c18bd2f1cd">setSuffix</a> (const String &suffix)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the <em>suffix</em> string to be displayed after the field's value. <a href="#a9324bba994389f3a4563d9c18bd2f1cd"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><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 manages the input of an integer value. </p>
|
|
<p><a class="el" href="classIntField.html" title="Field that manages the input of an integer value.">IntField</a> is intended for field values that are modifiable by the user. Pressing Up adds <a class="el" href="classIntField.html#a49025ee3473fe066a6a6c546af98bfbd" title="Returns the step value to use when increasing or decreasing the value() due to Up and Down button pre...">stepValue()</a> to the current value and pressing Down subtracts <a class="el" href="classIntField.html#a49025ee3473fe066a6a6c546af98bfbd" title="Returns the step value to use when increasing or decreasing the value() due to Up and Down button pre...">stepValue()</a> from the current value. The value is clamped to the range <a class="el" href="classIntField.html#af3dab3f2b46d29136d7a93ce46b0b8fb" title="Returns the minimum value for the input field.">minValue()</a> to <a class="el" href="classIntField.html#aaa0adcb0d16e822e5f176be5cb9ca8ad" title="Returns the maximum value for the input field.">maxValue()</a>.</p>
|
|
<p>The following example creates an integer field with the label "Iterations", that ranges between 1 and 5, with a <a class="el" href="classIntField.html#a49025ee3473fe066a6a6c546af98bfbd" title="Returns the step value to use when increasing or decreasing the value() due to Up and Down button pre...">stepValue()</a> of 1, and an initial default <a class="el" href="classIntField.html#a2fb650827ce8cb4662253bb6c32acb52" title="Returns the current value of this field.">value()</a> of 2:</p>
|
|
<div class="fragment"><pre class="fragment"> <a class="code" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a> mainForm(lcd);
|
|
<a class="code" href="classIntField.html" title="Field that manages the input of an integer value.">IntField</a> iterField(mainForm, <span class="stringliteral">"Iterations"</span>, 1, 5, 1, 2);
|
|
</pre></div><p><a class="el" href="classIntField.html" title="Field that manages the input of an integer value.">IntField</a> can be configured to show a <a class="el" href="classIntField.html#a1a1de6a1836dfdb820c92b7f188a1b05" title="Returns the suffix string to be displayed after the field's value.">suffix()</a> on the screen after the integer <a class="el" href="classIntField.html#a2fb650827ce8cb4662253bb6c32acb52" title="Returns the current value of this field.">value()</a>. This is intended for communicating the units in which the value is expressed. For example:</p>
|
|
<div class="fragment"><pre class="fragment"> <a class="code" href="classIntField.html" title="Field that manages the input of an integer value.">IntField</a> volumeField(mainForm, <span class="stringliteral">"Volume"</span>, 0, 100, 5, 85, <span class="stringliteral">"%"</span>);
|
|
<a class="code" href="classIntField.html" title="Field that manages the input of an integer value.">IntField</a> speedField(mainForm, <span class="stringliteral">"Speed"</span>, 0, 2000, 15, 450, <span class="stringliteral">" rpm"</span>);
|
|
</pre></div><div class="image">
|
|
<img src="FormInt.png" alt="FormInt.png"/>
|
|
</div>
|
|
<p>Use <a class="el" href="classTextField.html" title="Field that displays a read-only text value.">TextField</a> for read-only fields that report integer values but which are not modifiable by the user.</p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a>, <a class="el" href="classTextField.html" title="Field that displays a read-only text value.">TextField</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="IntField_8h_source.html#l00028">28</a> of file <a class="el" href="IntField_8h_source.html">IntField.h</a>.</p>
|
|
</div><hr/><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a9df274c4100ed37d2d78738f09fc53b6"></a><!-- doxytag: member="IntField::IntField" ref="a9df274c4100ed37d2d78738f09fc53b6" args="(const String &label)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">IntField::IntField </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 integer 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>Initially, <a class="el" href="classIntField.html#a2fb650827ce8cb4662253bb6c32acb52" title="Returns the current value of this field.">value()</a> is 0, <a class="el" href="classIntField.html#af3dab3f2b46d29136d7a93ce46b0b8fb" title="Returns the minimum value for the input field.">minValue()</a> is 0, <a class="el" href="classIntField.html#aaa0adcb0d16e822e5f176be5cb9ca8ad" title="Returns the maximum value for the input field.">maxValue()</a> is 100, <a class="el" href="classIntField.html#a49025ee3473fe066a6a6c546af98bfbd" title="Returns the step value to use when increasing or decreasing the value() due to Up and Down button pre...">stepValue()</a> is 1, and <a class="el" href="classIntField.html#a1a1de6a1836dfdb820c92b7f188a1b05" title="Returns the suffix string to be displayed after the field's value.">suffix()</a> is an empty string.</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="IntField_8cpp_source.html#l00071">71</a> of file <a class="el" href="IntField_8cpp_source.html">IntField.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a10c9c958bcde276698f1f1f9bff949dd"></a><!-- doxytag: member="IntField::IntField" ref="a10c9c958bcde276698f1f1f9bff949dd" args="(Form &form, const String &label, int minValue, int maxValue, int stepValue, int value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">IntField::IntField </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classForm.html">Form</a> & </td>
|
|
<td class="paramname"><em>form</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const String & </td>
|
|
<td class="paramname"><em>label</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>minValue</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>maxValue</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>stepValue</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Constructs a new integer field with a specific <em>label</em>, <em>minValue</em>, <em>maxValue</em>, <em>stepValue</em>, and <em>value</em>, and attaches it to a <em>form</em>. </p>
|
|
<p>The <a class="el" href="classIntField.html#a1a1de6a1836dfdb820c92b7f188a1b05" title="Returns the suffix string to be displayed after the field's value.">suffix()</a> is initially set to an empty string. </p>
|
|
|
|
<p>Definition at line <a class="el" href="IntField_8cpp_source.html#l00088">88</a> of file <a class="el" href="IntField_8cpp_source.html">IntField.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="a01a17d5a89c76c42c4f0516984ce653f"></a><!-- doxytag: member="IntField::dispatch" ref="a01a17d5a89c76c42c4f0516984ce653f" args="(int event)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int IntField::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 from <a class="el" href="classField.html#a061bd1ed4d8b079df86465df8facd3b3">Field</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="IntField_8cpp_source.html#l00114">114</a> of file <a class="el" href="IntField_8cpp_source.html">IntField.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a51d9127b660e8dd7f87718acd230202a"></a><!-- doxytag: member="IntField::enterField" ref="a51d9127b660e8dd7f87718acd230202a" args="(bool reverse)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void IntField::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 from <a class="el" href="classField.html#aa032bbeacb405c56546cb56fbbee94f5">Field</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="IntField_8cpp_source.html#l00126">126</a> of file <a class="el" href="IntField_8cpp_source.html">IntField.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aaa0adcb0d16e822e5f176be5cb9ca8ad"></a><!-- doxytag: member="IntField::maxValue" ref="aaa0adcb0d16e822e5f176be5cb9ca8ad" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int IntField::maxValue </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns the maximum value for the input field. </p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classIntField.html#a36cbd7c24480cc3fcf0c7634d5e22bf1" title="Sets the maximum value for the input field.">setMaxValue()</a>, <a class="el" href="classIntField.html#af3dab3f2b46d29136d7a93ce46b0b8fb" title="Returns the minimum value for the input field.">minValue()</a>, <a class="el" href="classIntField.html#a49025ee3473fe066a6a6c546af98bfbd" title="Returns the step value to use when increasing or decreasing the value() due to Up and Down button pre...">stepValue()</a>, <a class="el" href="classIntField.html#a2fb650827ce8cb4662253bb6c32acb52" title="Returns the current value of this field.">value()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="IntField_8h_source.html#l00041">41</a> of file <a class="el" href="IntField_8h_source.html">IntField.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af3dab3f2b46d29136d7a93ce46b0b8fb"></a><!-- doxytag: member="IntField::minValue" ref="af3dab3f2b46d29136d7a93ce46b0b8fb" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int IntField::minValue </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns the minimum value for the input field. </p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classIntField.html#afffe7be6721a043cec7a5a85c19e0ada" title="Sets the minimum value for the input field.">setMinValue()</a>, <a class="el" href="classIntField.html#aaa0adcb0d16e822e5f176be5cb9ca8ad" title="Returns the maximum value for the input field.">maxValue()</a>, <a class="el" href="classIntField.html#a49025ee3473fe066a6a6c546af98bfbd" title="Returns the step value to use when increasing or decreasing the value() due to Up and Down button pre...">stepValue()</a>, <a class="el" href="classIntField.html#a2fb650827ce8cb4662253bb6c32acb52" title="Returns the current value of this field.">value()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="IntField_8h_source.html#l00038">38</a> of file <a class="el" href="IntField_8h_source.html">IntField.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a36cbd7c24480cc3fcf0c7634d5e22bf1"></a><!-- doxytag: member="IntField::setMaxValue" ref="a36cbd7c24480cc3fcf0c7634d5e22bf1" args="(int value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void IntField::setMaxValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Sets the maximum <em>value</em> for the input field. </p>
|
|
<p>The new maximum <em>value</em> will be used to clamp the field's value the next time <a class="el" href="classIntField.html#aed421e2c52946f2c7643534b4f6f13f7" title="Sets the current value of this field.">setValue()</a> is called.</p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classIntField.html#aaa0adcb0d16e822e5f176be5cb9ca8ad" title="Returns the maximum value for the input field.">maxValue()</a>, <a class="el" href="classIntField.html#afffe7be6721a043cec7a5a85c19e0ada" title="Sets the minimum value for the input field.">setMinValue()</a>, <a class="el" href="classIntField.html#a8fb6e207bd906062bb788e19dbe58bcb" title="Sets the step value value to use when increasing or decreasing the value() due to Up and Down button ...">setStepValue()</a>, <a class="el" href="classIntField.html#aed421e2c52946f2c7643534b4f6f13f7" title="Sets the current value of this field.">setValue()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="IntField_8h_source.html#l00042">42</a> of file <a class="el" href="IntField_8h_source.html">IntField.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afffe7be6721a043cec7a5a85c19e0ada"></a><!-- doxytag: member="IntField::setMinValue" ref="afffe7be6721a043cec7a5a85c19e0ada" args="(int value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void IntField::setMinValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Sets the minimum <em>value</em> for the input field. </p>
|
|
<p>The new minimum <em>value</em> will be used to clamp the field's value the next time <a class="el" href="classIntField.html#aed421e2c52946f2c7643534b4f6f13f7" title="Sets the current value of this field.">setValue()</a> is called.</p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classIntField.html#af3dab3f2b46d29136d7a93ce46b0b8fb" title="Returns the minimum value for the input field.">minValue()</a>, <a class="el" href="classIntField.html#a36cbd7c24480cc3fcf0c7634d5e22bf1" title="Sets the maximum value for the input field.">setMaxValue()</a>, <a class="el" href="classIntField.html#a8fb6e207bd906062bb788e19dbe58bcb" title="Sets the step value value to use when increasing or decreasing the value() due to Up and Down button ...">setStepValue()</a>, <a class="el" href="classIntField.html#aed421e2c52946f2c7643534b4f6f13f7" title="Sets the current value of this field.">setValue()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="IntField_8h_source.html#l00039">39</a> of file <a class="el" href="IntField_8h_source.html">IntField.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8fb6e207bd906062bb788e19dbe58bcb"></a><!-- doxytag: member="IntField::setStepValue" ref="a8fb6e207bd906062bb788e19dbe58bcb" args="(int value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void IntField::setStepValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Sets the step value <em>value</em> to use when increasing or decreasing the <a class="el" href="classIntField.html#a2fb650827ce8cb4662253bb6c32acb52" title="Returns the current value of this field.">value()</a> due to Up and Down button presses. </p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classIntField.html#a49025ee3473fe066a6a6c546af98bfbd" title="Returns the step value to use when increasing or decreasing the value() due to Up and Down button pre...">stepValue()</a>, <a class="el" href="classIntField.html#afffe7be6721a043cec7a5a85c19e0ada" title="Sets the minimum value for the input field.">setMinValue()</a>, <a class="el" href="classIntField.html#a36cbd7c24480cc3fcf0c7634d5e22bf1" title="Sets the maximum value for the input field.">setMaxValue()</a>, <a class="el" href="classIntField.html#aed421e2c52946f2c7643534b4f6f13f7" title="Sets the current value of this field.">setValue()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="IntField_8h_source.html#l00045">45</a> of file <a class="el" href="IntField_8h_source.html">IntField.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9324bba994389f3a4563d9c18bd2f1cd"></a><!-- doxytag: member="IntField::setSuffix" ref="a9324bba994389f3a4563d9c18bd2f1cd" args="(const String &suffix)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void IntField::setSuffix </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const String & </td>
|
|
<td class="paramname"><em>suffix</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Sets the <em>suffix</em> string to be displayed after the field's value. </p>
|
|
<p>Suffixes are typically used to indicate the units that the <a class="el" href="classIntField.html#a2fb650827ce8cb4662253bb6c32acb52" title="Returns the current value of this field.">value()</a> is expressed in. For example:</p>
|
|
<div class="fragment"><pre class="fragment"> field.setSuffix(<span class="stringliteral">"%"</span>);
|
|
field.setSuffix(<span class="stringliteral">" rpm"</span>);
|
|
</pre></div><dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classIntField.html#a1a1de6a1836dfdb820c92b7f188a1b05" title="Returns the suffix string to be displayed after the field's value.">suffix()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="IntField_8cpp_source.html#l00231">231</a> of file <a class="el" href="IntField_8cpp_source.html">IntField.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aed421e2c52946f2c7643534b4f6f13f7"></a><!-- doxytag: member="IntField::setValue" ref="aed421e2c52946f2c7643534b4f6f13f7" args="(int value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void IntField::setValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Sets the current <em>value</em> of this field. </p>
|
|
<p>The <em>value</em> will be clamped to the range defined by <a class="el" href="classIntField.html#af3dab3f2b46d29136d7a93ce46b0b8fb" title="Returns the minimum value for the input field.">minValue()</a> and <a class="el" href="classIntField.html#aaa0adcb0d16e822e5f176be5cb9ca8ad" title="Returns the maximum value for the input field.">maxValue()</a>.</p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classIntField.html#a2fb650827ce8cb4662253bb6c32acb52" title="Returns the current value of this field.">value()</a>, <a class="el" href="classIntField.html#afffe7be6721a043cec7a5a85c19e0ada" title="Sets the minimum value for the input field.">setMinValue()</a>, <a class="el" href="classIntField.html#a36cbd7c24480cc3fcf0c7634d5e22bf1" title="Sets the maximum value for the input field.">setMaxValue()</a>, <a class="el" href="classIntField.html#a8fb6e207bd906062bb788e19dbe58bcb" title="Sets the step value value to use when increasing or decreasing the value() due to Up and Down button ...">setStepValue()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="IntField_8cpp_source.html#l00198">198</a> of file <a class="el" href="IntField_8cpp_source.html">IntField.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a49025ee3473fe066a6a6c546af98bfbd"></a><!-- doxytag: member="IntField::stepValue" ref="a49025ee3473fe066a6a6c546af98bfbd" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int IntField::stepValue </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns the step value to use when increasing or decreasing the <a class="el" href="classIntField.html#a2fb650827ce8cb4662253bb6c32acb52" title="Returns the current value of this field.">value()</a> due to Up and Down button presses. </p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classIntField.html#a8fb6e207bd906062bb788e19dbe58bcb" title="Sets the step value value to use when increasing or decreasing the value() due to Up and Down button ...">setStepValue()</a>, <a class="el" href="classIntField.html#af3dab3f2b46d29136d7a93ce46b0b8fb" title="Returns the minimum value for the input field.">minValue()</a>, <a class="el" href="classIntField.html#aaa0adcb0d16e822e5f176be5cb9ca8ad" title="Returns the maximum value for the input field.">maxValue()</a>, <a class="el" href="classIntField.html#a2fb650827ce8cb4662253bb6c32acb52" title="Returns the current value of this field.">value()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="IntField_8h_source.html#l00044">44</a> of file <a class="el" href="IntField_8h_source.html">IntField.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1a1de6a1836dfdb820c92b7f188a1b05"></a><!-- doxytag: member="IntField::suffix" ref="a1a1de6a1836dfdb820c92b7f188a1b05" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const String & IntField::suffix </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns the suffix string to be displayed after the field's value. </p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classIntField.html#a9324bba994389f3a4563d9c18bd2f1cd" title="Sets the suffix string to be displayed after the field's value.">setSuffix()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="IntField_8h_source.html#l00050">50</a> of file <a class="el" href="IntField_8h_source.html">IntField.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2fb650827ce8cb4662253bb6c32acb52"></a><!-- doxytag: member="IntField::value" ref="a2fb650827ce8cb4662253bb6c32acb52" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int IntField::value </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns the current value of this field. </p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classIntField.html#aed421e2c52946f2c7643534b4f6f13f7" title="Sets the current value of this field.">setValue()</a>, <a class="el" href="classIntField.html#af3dab3f2b46d29136d7a93ce46b0b8fb" title="Returns the minimum value for the input field.">minValue()</a>, <a class="el" href="classIntField.html#aaa0adcb0d16e822e5f176be5cb9ca8ad" title="Returns the maximum value for the input field.">maxValue()</a>, <a class="el" href="classIntField.html#a49025ee3473fe066a6a6c546af98bfbd" title="Returns the step value to use when increasing or decreasing the value() due to Up and Down button pre...">stepValue()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="IntField_8h_source.html#l00047">47</a> of file <a class="el" href="IntField_8h_source.html">IntField.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="IntField_8h_source.html">IntField.h</a></li>
|
|
<li><a class="el" href="IntField_8cpp_source.html">IntField.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 Tue Jun 12 2012 11:29:26 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>
|