taigrr/arduinolibs
1
0
Fork 0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
Code Issues Projects Releases Wiki Activity
arduinolibs/classTimeField.html
Rhys Weatherley 448ca56a5a Update docs
2012-06-10 10:52:14 +10:00

440 lines
28 KiB
HTML
Raw Blame History

<!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: TimeField 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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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">TimeField Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="TimeField" --><!-- 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 display and editing of a time value.
<a href="classTimeField.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="TimeField_8h_source.html">TimeField.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for TimeField:</div>
<div class="dyncontent">
<div class="center">
<img src="classTimeField.png" usemap="#TimeField_map" alt=""/>
<map id="TimeField_map" name="TimeField_map">
<area href="classField.html" title="Manages a single data input/output field within a Form." alt="Field" shape="rect" coords="0,0,66,24"/>
</map>
</div></div>
<p><a href="classTimeField-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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeField.html#a138e2425379705828a87eb2d8a836431">TimeField</a> (const String &amp;label)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new time field with a specific <em>label</em>. <a href="#a138e2425379705828a87eb2d8a836431"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeField.html#a87f222bc098367963ed21a7edc4624de">TimeField</a> (<a class="el" href="classForm.html">Form</a> &amp;form, const String &amp;label, int maxHours, bool readOnly)</td></tr>
<tr><td class="mdescLeft">&#160;</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="#a87f222bc098367963ed21a7edc4624de"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeField.html#a9b953d9abdbe960a3fa34938462832e5">dispatch</a> (int event)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatches <em>event</em> via this field. <a href="#a9b953d9abdbe960a3fa34938462832e5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeField.html#ae914d6b870283a334d2d669460f7646b">enterField</a> (bool reverse)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Enters the field due to form navigation. <a href="#ae914d6b870283a334d2d669460f7646b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeField.html#a5a6b7db2e3fda7745e0ff9c3d8d9a541">exitField</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Exits the field due to form navigation. <a href="#a5a6b7db2e3fda7745e0ff9c3d8d9a541"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f">value</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current value of this time field, in seconds. <a href="#a400aaa72a83b3b872e1de1c3af1a240f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeField.html#a063b6df2bd6fa7970ee445ab4e5d1fc1">setValue</a> (unsigned long value)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the <em>value</em> of this time field, in seconds. <a href="#a063b6df2bd6fa7970ee445ab4e5d1fc1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeField.html#aa73f5a62c330ac7d2f647dfe27d026b7">maxHours</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the maximum number of hours before the field wraps around. <a href="#aa73f5a62c330ac7d2f647dfe27d026b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeField.html#a7ac124eb9dde01c18c711c421736b5ed">setMaxHours</a> (int maxHours)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the maximum number of hours before the field wraps around to <em>maxHours</em>. <a href="#a7ac124eb9dde01c18c711c421736b5ed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeField.html#aa0795c873ba9941c8a1a3bf8c06668f1">readOnly</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns TIMEFIELD_READ_ONLY (true) or TIMEFIELD_READ_WRITE (false). <a href="#aa0795c873ba9941c8a1a3bf8c06668f1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeField.html#a3f002a0729e90e88d04025908be102fe">setReadOnly</a> (bool value)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the read-only state of this field to <em>value</em>. <a href="#a3f002a0729e90e88d04025908be102fe"></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 display and editing of a time value. </p>
<p><a class="el" href="classTimeField.html" title="Field that manages the display and editing of a time value.">TimeField</a> is suitable for displaying wall clock time in 24-hour format, or for displaying timeouts and durations in seconds. Times are specified in seconds as an <code>unsigned long</code> value. They are displayed as <code>HH:MM:SS</code>, for hours, minutes, and seconds.</p>
<p>The time field can be either read-only or read-write. When read-write, the Up, Down, Left, and Right buttons can be used to modify the hour, minute, and second components of the time value.</p>
<p>The following example displays the number of hours, minutes, and seconds since the device was reset, wrapping around after 24 hours:</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="classTimeField.html" title="Field that manages the display and editing of a time value.">TimeField</a> timeField(mainForm, <span class="stringliteral">&quot;Time since reset&quot;</span>, 24, TIMEFIELD_READ_ONLY);
<span class="keywordtype">void</span> loop() {
timeField.setValue(millis() / 1000);
mainForm.dispatch(lcd.<a class="code" href="classLCD.html#ac1e80e2603bd1cf0276c36092c416292" title="Gets the next button press, release, or idle event.">getButton</a>());
}
</pre></div><div class="image">
<img src="FormTimeRO.png" alt="FormTimeRO.png"/>
</div>
<p>A read-write field can be used to ask the user for the duration of an application count-down timer:</p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classTimeField.html" title="Field that manages the display and editing of a time value.">TimeField</a> durationField(mainForm, <span class="stringliteral">&quot;Timer duration&quot;</span>, 24, TIMEFIELD_READ_WRITE);
</pre></div><div class="image">
<img src="FormTimeRW.png" alt="FormTimeRW.png"/>
</div>
<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> </dd></dl>
<p>Definition at line <a class="el" href="TimeField_8h_source.html#l00031">31</a> of file <a class="el" href="TimeField_8h_source.html">TimeField.h</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a138e2425379705828a87eb2d8a836431"></a><!-- doxytag: member="TimeField::TimeField" ref="a138e2425379705828a87eb2d8a836431" args="(const String &amp;label)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TimeField::TimeField </td>
<td>(</td>
<td class="paramtype">const String &amp;&#160;</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 time 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="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f" title="Returns the current value of this time field, in seconds.">value()</a> is 0, <a class="el" href="classTimeField.html#aa73f5a62c330ac7d2f647dfe27d026b7" title="Returns the maximum number of hours before the field wraps around.">maxHours()</a> is 24, and isReadOnly() is TIMEFIELD_READ_WRITE.</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="TimeField_8cpp_source.html#l00082">82</a> of file <a class="el" href="TimeField_8cpp_source.html">TimeField.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a87f222bc098367963ed21a7edc4624de"></a><!-- doxytag: member="TimeField::TimeField" ref="a87f222bc098367963ed21a7edc4624de" args="(Form &amp;form, const String &amp;label, int maxHours, bool readOnly)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TimeField::TimeField </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classForm.html">Form</a> &amp;&#160;</td>
<td class="paramname"><em>form</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const String &amp;&#160;</td>
<td class="paramname"><em>label</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>maxHours</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>readOnly</em>&#160;</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="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f" title="Returns the current value of this time field, in seconds.">value()</a> of the field will be 0. The <a class="el" href="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f" title="Returns the current value of this time field, in seconds.">value()</a> will be limited to be less than <em>maxHours</em> * 60 * 60 seconds.</p>
<p>If <em>readOnly</em> is TIMEFIELD_READ_ONLY, then the field will display times but not allow them to be modified by the user. If <em>readOnly</em> is TIMEFIELD_READ_WRITE, then the field will modifiable by the user.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f" title="Returns the current value of this time field, in seconds.">value()</a> </dd></dl>
<p>Definition at line <a class="el" href="TimeField_8cpp_source.html#l00105">105</a> of file <a class="el" href="TimeField_8cpp_source.html">TimeField.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9b953d9abdbe960a3fa34938462832e5"></a><!-- doxytag: member="TimeField::dispatch" ref="a9b953d9abdbe960a3fa34938462832e5" args="(int event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int TimeField::dispatch </td>
<td>(</td>
<td class="paramtype">int&#160;</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="TimeField_8cpp_source.html#l00115">115</a> of file <a class="el" href="TimeField_8cpp_source.html">TimeField.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae914d6b870283a334d2d669460f7646b"></a><!-- doxytag: member="TimeField::enterField" ref="ae914d6b870283a334d2d669460f7646b" args="(bool reverse)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TimeField::enterField </td>
<td>(</td>
<td class="paramtype">bool&#160;</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="classTimeField.html#a5a6b7db2e3fda7745e0ff9c3d8d9a541" 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="TimeField_8cpp_source.html#l00193">193</a> of file <a class="el" href="TimeField_8cpp_source.html">TimeField.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5a6b7db2e3fda7745e0ff9c3d8d9a541"></a><!-- doxytag: member="TimeField::exitField" ref="a5a6b7db2e3fda7745e0ff9c3d8d9a541" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TimeField::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="classTimeField.html#ae914d6b870283a334d2d669460f7646b" title="Enters the field due to form navigation.">enterField()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classField.html#ad6805c75ee1e62f8cd8bd550c4530c07">Field</a>.</p>
<p>Definition at line <a class="el" href="TimeField_8cpp_source.html#l00205">205</a> of file <a class="el" href="TimeField_8cpp_source.html">TimeField.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa73f5a62c330ac7d2f647dfe27d026b7"></a><!-- doxytag: member="TimeField::maxHours" ref="aa73f5a62c330ac7d2f647dfe27d026b7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int TimeField::maxHours </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 number of hours before the field wraps around. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTimeField.html#a7ac124eb9dde01c18c711c421736b5ed" title="Sets the maximum number of hours before the field wraps around to maxHours.">setMaxHours()</a>, <a class="el" href="classTimeField.html#a063b6df2bd6fa7970ee445ab4e5d1fc1" title="Sets the value of this time field, in seconds.">setValue()</a> </dd></dl>
<p>Definition at line <a class="el" href="TimeField_8h_source.html#l00044">44</a> of file <a class="el" href="TimeField_8h_source.html">TimeField.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa0795c873ba9941c8a1a3bf8c06668f1"></a><!-- doxytag: member="TimeField::readOnly" ref="aa0795c873ba9941c8a1a3bf8c06668f1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool TimeField::readOnly </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns TIMEFIELD_READ_ONLY (true) or TIMEFIELD_READ_WRITE (false). </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTimeField.html#a3f002a0729e90e88d04025908be102fe" title="Sets the read-only state of this field to value.">setReadOnly()</a> </dd></dl>
<p>Definition at line <a class="el" href="TimeField_8h_source.html#l00047">47</a> of file <a class="el" href="TimeField_8h_source.html">TimeField.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7ac124eb9dde01c18c711c421736b5ed"></a><!-- doxytag: member="TimeField::setMaxHours" ref="a7ac124eb9dde01c18c711c421736b5ed" args="(int maxHours)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TimeField::setMaxHours </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>maxHours</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the maximum number of hours before the field wraps around to <em>maxHours</em>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTimeField.html#aa73f5a62c330ac7d2f647dfe27d026b7" title="Returns the maximum number of hours before the field wraps around.">maxHours()</a>, <a class="el" href="classTimeField.html#a063b6df2bd6fa7970ee445ab4e5d1fc1" title="Sets the value of this time field, in seconds.">setValue()</a> </dd></dl>
<p>Definition at line <a class="el" href="TimeField_8h_source.html#l00045">45</a> of file <a class="el" href="TimeField_8h_source.html">TimeField.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3f002a0729e90e88d04025908be102fe"></a><!-- doxytag: member="TimeField::setReadOnly" ref="a3f002a0729e90e88d04025908be102fe" args="(bool value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TimeField::setReadOnly </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the read-only state of this field to <em>value</em>. </p>
<p>The <em>value</em> should be one of TIMEFIELD_READ_ONLY (true) or TIMEFIELD_READ_WRITE (false). Use of the named constants is recommended.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTimeField.html#aa0795c873ba9941c8a1a3bf8c06668f1" title="Returns TIMEFIELD_READ_ONLY (true) or TIMEFIELD_READ_WRITE (false).">readOnly()</a> </dd></dl>
<p>Definition at line <a class="el" href="TimeField_8cpp_source.html#l00268">268</a> of file <a class="el" href="TimeField_8cpp_source.html">TimeField.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a063b6df2bd6fa7970ee445ab4e5d1fc1"></a><!-- doxytag: member="TimeField::setValue" ref="a063b6df2bd6fa7970ee445ab4e5d1fc1" args="(unsigned long value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TimeField::setValue </td>
<td>(</td>
<td class="paramtype">unsigned long&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the <em>value</em> of this time field, in seconds. </p>
<p>If <em>value</em> is greater than or equal to <a class="el" href="classTimeField.html#aa73f5a62c330ac7d2f647dfe27d026b7" title="Returns the maximum number of hours before the field wraps around.">maxHours()</a> * 60 * 60, then it will be wrapped around to fall within the valid range.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f" title="Returns the current value of this time field, in seconds.">value()</a>, <a class="el" href="classTimeField.html#aa73f5a62c330ac7d2f647dfe27d026b7" title="Returns the maximum number of hours before the field wraps around.">maxHours()</a> </dd></dl>
<p>Definition at line <a class="el" href="TimeField_8cpp_source.html#l00227">227</a> of file <a class="el" href="TimeField_8cpp_source.html">TimeField.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a400aaa72a83b3b872e1de1c3af1a240f"></a><!-- doxytag: member="TimeField::value" ref="a400aaa72a83b3b872e1de1c3af1a240f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long TimeField::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 time field, in seconds. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTimeField.html#a063b6df2bd6fa7970ee445ab4e5d1fc1" title="Sets the value of this time field, in seconds.">setValue()</a> </dd></dl>
<p>Definition at line <a class="el" href="TimeField_8h_source.html#l00041">41</a> of file <a class="el" href="TimeField_8h_source.html">TimeField.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="TimeField_8h_source.html">TimeField.h</a></li>
<li><a class="el" href="TimeField_8cpp_source.html">TimeField.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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</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 Sun Jun 10 2012 10:51:58 for ArduinoLibs by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink