mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
418 lines
28 KiB
HTML
418 lines
28 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: BoolField 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">BoolField Class Reference</div> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<!-- doxytag: class="BoolField" --><!-- 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 a boolean value.
|
|
<a href="classBoolField.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="BoolField_8h_source.html">BoolField.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for BoolField:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classBoolField.png" usemap="#BoolField_map" alt=""/>
|
|
<map id="BoolField_map" name="BoolField_map">
|
|
<area href="classField.html" title="Manages a single data input/output field within a Form." alt="Field" shape="rect" coords="0,0,65,24"/>
|
|
</map>
|
|
</div></div>
|
|
|
|
<p><a href="classBoolField-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="classBoolField.html#a5d4382cdcdc989de0179d8f3f3a59998">BoolField</a> (const String &label)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new boolean field with a specific <em>label</em>. <a href="#a5d4382cdcdc989de0179d8f3f3a59998"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolField.html#a49aad212ed18f84baa105c24e86281d9">BoolField</a> (<a class="el" href="classForm.html">Form</a> &form, const String &label, const String &trueLabel, const String &falseLabel, bool value)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new boolean field with a specific <em>label</em> and attaches it to a <em>form</em>. <a href="#a49aad212ed18f84baa105c24e86281d9"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolField.html#af793bafc1193d79b495c2ede711bca57">dispatch</a> (int event)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dispatches <em>event</em> via this field. <a href="#af793bafc1193d79b495c2ede711bca57"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolField.html#ab3f1e610b52caed7e41016f6ae3d7d09">enterField</a> (bool reverse)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enters the field due to form navigation. <a href="#ab3f1e610b52caed7e41016f6ae3d7d09"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolField.html#a9147826437fbaf9b29eda9dee9e37b39">value</a> () const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current value of this field, true or false. <a href="#a9147826437fbaf9b29eda9dee9e37b39"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolField.html#a080c575fd4a98e6afc4b9197fbab5577">setValue</a> (bool value)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the current value of this field to <em>value</em>. <a href="#a080c575fd4a98e6afc4b9197fbab5577"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">const String & </td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolField.html#a9972030beec6e007b556c6eb652e163d">trueLabel</a> () const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the string that is displayed when <a class="el" href="classBoolField.html#a9147826437fbaf9b29eda9dee9e37b39" title="Returns the current value of this field, true or false.">value()</a> is true. <a href="#a9972030beec6e007b556c6eb652e163d"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolField.html#a803fc8c39765da4a44af01d925cd4194">setTrueLabel</a> (const String &trueLabel)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the string that is displayed when <a class="el" href="classBoolField.html#a9147826437fbaf9b29eda9dee9e37b39" title="Returns the current value of this field, true or false.">value()</a> is true to <em>trueLabel</em>. <a href="#a803fc8c39765da4a44af01d925cd4194"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">const String & </td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolField.html#a59ad7a8a33290bda0d9fbb3df4f09b01">falseLabel</a> () const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the string that is displayed when <a class="el" href="classBoolField.html#a9147826437fbaf9b29eda9dee9e37b39" title="Returns the current value of this field, true or false.">value()</a> is false. <a href="#a59ad7a8a33290bda0d9fbb3df4f09b01"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolField.html#ae6a29d27139fd78f2ca96152059fb30a">setFalseLabel</a> (const String &falseLabel)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the string that is displayed when <a class="el" href="classBoolField.html#a9147826437fbaf9b29eda9dee9e37b39" title="Returns the current value of this field, true or false.">value()</a> is false to <em>falseLabel</em>. <a href="#ae6a29d27139fd78f2ca96152059fb30a"></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 a boolean value. </p>
|
|
<p><a class="el" href="classBoolField.html" title="Field that manages the input of a boolean value.">BoolField</a> is intended for field values that are modifiable by the user. Pressing one of Up or Down will toggle the field's current value.</p>
|
|
<p>The following example creates a boolean field that shows the state of the status LED on D13. When the LED is on (the default), the string "On" will be displayed on the <a class="el" href="classLCD.html" title="Enhanced library for Freetronics 16x2 LCD shields.">LCD</a> screen. When the LED is off, the string "Off" will be displayed instead.</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="classBoolField.html" title="Field that manages the input of a boolean value.">BoolField</a> ledField(mainForm, <span class="stringliteral">"Status LED"</span>, <span class="stringliteral">"On"</span>, <span class="stringliteral">"Off"</span>, <span class="keyword">true</span>);
|
|
</pre></div><div class="image">
|
|
<img src="FormBool.png" alt="FormBool.png"/>
|
|
</div>
|
|
<p>To actually toggle the LED, the application's main loop() function should contain the following code:</p>
|
|
<div class="fragment"><pre class="fragment"> <span class="keywordtype">int</span> <span class="keyword">event</span> = lcd.<a class="code" href="classLCD.html#ac1e80e2603bd1cf0276c36092c416292" title="Gets the next button press, release, or idle event.">getButton</a>();
|
|
<span class="keywordflow">if</span> (mainForm.dispatch(event) == FORM_CHANGED) {
|
|
<span class="keywordflow">if</span> (mainForm.isCurrent(ledField)) {
|
|
<span class="keywordflow">if</span> (ledField.value())
|
|
digitalWrite(STATUS_LED, HIGH);
|
|
<span class="keywordflow">else</span>
|
|
digitalWrite(STATUS_LED, LOW);
|
|
}
|
|
}
|
|
</pre></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 boolean values but which are not modifiable by the user.</p>
|
|
<p><a class="el" href="classListField.html" title="Field that manages selection from a static list of items.">ListField</a> can be used to select between more than two items.</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="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> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="BoolField_8h_source.html#l00028">28</a> of file <a class="el" href="BoolField_8h_source.html">BoolField.h</a>.</p>
|
|
</div><hr/><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a5d4382cdcdc989de0179d8f3f3a59998"></a><!-- doxytag: member="BoolField::BoolField" ref="a5d4382cdcdc989de0179d8f3f3a59998" args="(const String &label)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">BoolField::BoolField </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 boolean field with a specific <em>label</em>. </p>
|
|
<p>The field is initially not associated with a <a class="el" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a>. The field can be added to a form later using <a class="el" href="classForm.html#a5cb056ace428e75e321610555bfecac7" title="Adds field to this form.">Form::addField()</a>.</p>
|
|
<p>The initial <a class="el" href="classBoolField.html#a9147826437fbaf9b29eda9dee9e37b39" title="Returns the current value of this field, true or false.">value()</a> will be false.</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="BoolField_8cpp_source.html#l00077">77</a> of file <a class="el" href="BoolField_8cpp_source.html">BoolField.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a49aad212ed18f84baa105c24e86281d9"></a><!-- doxytag: member="BoolField::BoolField" ref="a49aad212ed18f84baa105c24e86281d9" args="(Form &form, const String &label, const String &trueLabel, const String &falseLabel, bool value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">BoolField::BoolField </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">const String & </td>
|
|
<td class="paramname"><em>trueLabel</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const String & </td>
|
|
<td class="paramname"><em>falseLabel</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </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 boolean field with a specific <em>label</em> and attaches it to a <em>form</em>. </p>
|
|
<p>The initial <a class="el" href="classBoolField.html#a9147826437fbaf9b29eda9dee9e37b39" title="Returns the current value of this field, true or false.">value()</a> of the field is set to the parameter <em>value</em>. When <a class="el" href="classBoolField.html#a9147826437fbaf9b29eda9dee9e37b39" title="Returns the current value of this field, true or false.">value()</a> is true, <em>trueLabel</em> will be displayed on the screen. When <a class="el" href="classBoolField.html#a9147826437fbaf9b29eda9dee9e37b39" title="Returns the current value of this field, true or false.">value()</a> is false, <em>falseLabel</em> will be displayed on the screen.</p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBoolField.html#a9147826437fbaf9b29eda9dee9e37b39" title="Returns the current value of this field, true or false.">value()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="BoolField_8cpp_source.html#l00094">94</a> of file <a class="el" href="BoolField_8cpp_source.html">BoolField.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="af793bafc1193d79b495c2ede711bca57"></a><!-- doxytag: member="BoolField::dispatch" ref="af793bafc1193d79b495c2ede711bca57" args="(int event)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int BoolField::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="BoolField_8cpp_source.html#l00103">103</a> of file <a class="el" href="BoolField_8cpp_source.html">BoolField.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab3f1e610b52caed7e41016f6ae3d7d09"></a><!-- doxytag: member="BoolField::enterField" ref="ab3f1e610b52caed7e41016f6ae3d7d09" args="(bool reverse)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BoolField::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="BoolField_8cpp_source.html#l00113">113</a> of file <a class="el" href="BoolField_8cpp_source.html">BoolField.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a59ad7a8a33290bda0d9fbb3df4f09b01"></a><!-- doxytag: member="BoolField::falseLabel" ref="a59ad7a8a33290bda0d9fbb3df4f09b01" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const String & BoolField::falseLabel </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns the string that is displayed when <a class="el" href="classBoolField.html#a9147826437fbaf9b29eda9dee9e37b39" title="Returns the current value of this field, true or false.">value()</a> is false. </p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBoolField.html#ae6a29d27139fd78f2ca96152059fb30a" title="Sets the string that is displayed when value() is false to falseLabel.">setFalseLabel()</a>, <a class="el" href="classBoolField.html#a9972030beec6e007b556c6eb652e163d" title="Returns the string that is displayed when value() is true.">trueLabel()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="BoolField_8h_source.html#l00043">43</a> of file <a class="el" href="BoolField_8h_source.html">BoolField.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae6a29d27139fd78f2ca96152059fb30a"></a><!-- doxytag: member="BoolField::setFalseLabel" ref="ae6a29d27139fd78f2ca96152059fb30a" args="(const String &falseLabel)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BoolField::setFalseLabel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const String & </td>
|
|
<td class="paramname"><em>falseLabel</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Sets the string that is displayed when <a class="el" href="classBoolField.html#a9147826437fbaf9b29eda9dee9e37b39" title="Returns the current value of this field, true or false.">value()</a> is false to <em>falseLabel</em>. </p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBoolField.html#a59ad7a8a33290bda0d9fbb3df4f09b01" title="Returns the string that is displayed when value() is false.">falseLabel()</a>, <a class="el" href="classBoolField.html#a803fc8c39765da4a44af01d925cd4194" title="Sets the string that is displayed when value() is true to trueLabel.">setTrueLabel()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="BoolField_8cpp_source.html#l00173">173</a> of file <a class="el" href="BoolField_8cpp_source.html">BoolField.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a803fc8c39765da4a44af01d925cd4194"></a><!-- doxytag: member="BoolField::setTrueLabel" ref="a803fc8c39765da4a44af01d925cd4194" args="(const String &trueLabel)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BoolField::setTrueLabel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const String & </td>
|
|
<td class="paramname"><em>trueLabel</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Sets the string that is displayed when <a class="el" href="classBoolField.html#a9147826437fbaf9b29eda9dee9e37b39" title="Returns the current value of this field, true or false.">value()</a> is true to <em>trueLabel</em>. </p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBoolField.html#a9972030beec6e007b556c6eb652e163d" title="Returns the string that is displayed when value() is true.">trueLabel()</a>, <a class="el" href="classBoolField.html#ae6a29d27139fd78f2ca96152059fb30a" title="Sets the string that is displayed when value() is false to falseLabel.">setFalseLabel()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="BoolField_8cpp_source.html#l00153">153</a> of file <a class="el" href="BoolField_8cpp_source.html">BoolField.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a080c575fd4a98e6afc4b9197fbab5577"></a><!-- doxytag: member="BoolField::setValue" ref="a080c575fd4a98e6afc4b9197fbab5577" args="(bool value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BoolField::setValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Sets the current value of this field to <em>value</em>. </p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBoolField.html#a9147826437fbaf9b29eda9dee9e37b39" title="Returns the current value of this field, true or false.">value()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="BoolField_8cpp_source.html#l00131">131</a> of file <a class="el" href="BoolField_8cpp_source.html">BoolField.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9972030beec6e007b556c6eb652e163d"></a><!-- doxytag: member="BoolField::trueLabel" ref="a9972030beec6e007b556c6eb652e163d" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const String & BoolField::trueLabel </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns the string that is displayed when <a class="el" href="classBoolField.html#a9147826437fbaf9b29eda9dee9e37b39" title="Returns the current value of this field, true or false.">value()</a> is true. </p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBoolField.html#a803fc8c39765da4a44af01d925cd4194" title="Sets the string that is displayed when value() is true to trueLabel.">setTrueLabel()</a>, <a class="el" href="classBoolField.html#a59ad7a8a33290bda0d9fbb3df4f09b01" title="Returns the string that is displayed when value() is false.">falseLabel()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="BoolField_8h_source.html#l00040">40</a> of file <a class="el" href="BoolField_8h_source.html">BoolField.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9147826437fbaf9b29eda9dee9e37b39"></a><!-- doxytag: member="BoolField::value" ref="a9147826437fbaf9b29eda9dee9e37b39" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool BoolField::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, true or false. </p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBoolField.html#a080c575fd4a98e6afc4b9197fbab5577" title="Sets the current value of this field to value.">setValue()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="BoolField_8h_source.html#l00037">37</a> of file <a class="el" href="BoolField_8h_source.html">BoolField.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="BoolField_8h_source.html">BoolField.h</a></li>
|
|
<li><a class="el" href="BoolField_8cpp_source.html">BoolField.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 May 29 2012 15:23:58 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>
|