mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
145 lines
14 KiB
HTML
145 lines
14 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: TimeField.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><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="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">TimeField.h</div> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
|
|
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2012 Southern Storm Software, Pty Ltd.</span>
|
|
<a name="l00003"></a>00003 <span class="comment"> *</span>
|
|
<a name="l00004"></a>00004 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span>
|
|
<a name="l00005"></a>00005 <span class="comment"> * copy of this software and associated documentation files (the "Software"),</span>
|
|
<a name="l00006"></a>00006 <span class="comment"> * to deal in the Software without restriction, including without limitation</span>
|
|
<a name="l00007"></a>00007 <span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span>
|
|
<a name="l00008"></a>00008 <span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span>
|
|
<a name="l00009"></a>00009 <span class="comment"> * Software is furnished to do so, subject to the following conditions:</span>
|
|
<a name="l00010"></a>00010 <span class="comment"> *</span>
|
|
<a name="l00011"></a>00011 <span class="comment"> * The above copyright notice and this permission notice shall be included</span>
|
|
<a name="l00012"></a>00012 <span class="comment"> * in all copies or substantial portions of the Software.</span>
|
|
<a name="l00013"></a>00013 <span class="comment"> *</span>
|
|
<a name="l00014"></a>00014 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS</span>
|
|
<a name="l00015"></a>00015 <span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
|
|
<a name="l00016"></a>00016 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
|
|
<a name="l00017"></a>00017 <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
|
|
<a name="l00018"></a>00018 <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span>
|
|
<a name="l00019"></a>00019 <span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span>
|
|
<a name="l00020"></a>00020 <span class="comment"> * DEALINGS IN THE SOFTWARE.</span>
|
|
<a name="l00021"></a>00021 <span class="comment"> */</span>
|
|
<a name="l00022"></a>00022
|
|
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef TimeField_h</span>
|
|
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define TimeField_h</span>
|
|
<a name="l00025"></a>00025 <span class="preprocessor"></span>
|
|
<a name="l00026"></a>00026 <span class="preprocessor">#include "Field.h"</span>
|
|
<a name="l00027"></a>00027
|
|
<a name="l00028"></a>00028 <span class="preprocessor">#define TIMEFIELD_READ_ONLY true</span>
|
|
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define TIMEFIELD_READ_WRITE false</span>
|
|
<a name="l00030"></a>00030 <span class="preprocessor"></span>
|
|
<a name="l00031"></a><a class="code" href="classTimeField.html">00031</a> <span class="keyword">class </span><a class="code" href="classTimeField.html" title="Field that manages the display and editing of a time value.">TimeField</a> : <span class="keyword">public</span> <a class="code" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a> {
|
|
<a name="l00032"></a>00032 <span class="keyword">public</span>:
|
|
<a name="l00033"></a>00033 <span class="keyword">explicit</span> <a class="code" href="classTimeField.html#a138e2425379705828a87eb2d8a836431" title="Constructs a new time field with a specific label.">TimeField</a>(<span class="keyword">const</span> String &<a class="code" href="classField.html#aaa861ef917130c989a955bc75c683afe" title="Returns the label to display in the first line of this field.">label</a>);
|
|
<a name="l00034"></a>00034 <a class="code" href="classTimeField.html#a138e2425379705828a87eb2d8a836431" title="Constructs a new time field with a specific label.">TimeField</a>(<a class="code" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a> &<a class="code" href="classField.html#a27427319be1cc92db3128637d8884ee5" title="Returns the Form that owns this field; null if not associated with a Form.">form</a>, <span class="keyword">const</span> String &label, <span class="keywordtype">int</span> <a class="code" href="classTimeField.html#aa73f5a62c330ac7d2f647dfe27d026b7" title="Returns the maximum number of hours before the field wraps around.">maxHours</a>, <span class="keywordtype">bool</span> <a class="code" href="classTimeField.html#aa0795c873ba9941c8a1a3bf8c06668f1" title="Returns TIMEFIELD_READ_ONLY (true) or TIMEFIELD_READ_WRITE (false).">readOnly</a>);
|
|
<a name="l00035"></a>00035
|
|
<a name="l00036"></a>00036 <span class="keywordtype">int</span> <a class="code" href="classTimeField.html#a9b953d9abdbe960a3fa34938462832e5" title="Dispatches event via this field.">dispatch</a>(<span class="keywordtype">int</span> event);
|
|
<a name="l00037"></a>00037
|
|
<a name="l00038"></a>00038 <span class="keywordtype">void</span> <a class="code" href="classTimeField.html#ae914d6b870283a334d2d669460f7646b" title="Enters the field due to form navigation.">enterField</a>(<span class="keywordtype">bool</span> reverse);
|
|
<a name="l00039"></a>00039 <span class="keywordtype">void</span> <a class="code" href="classTimeField.html#a5a6b7db2e3fda7745e0ff9c3d8d9a541" title="Exits the field due to form navigation.">exitField</a>();
|
|
<a name="l00040"></a>00040
|
|
<a name="l00041"></a><a class="code" href="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f">00041</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f" title="Returns the current value of this time field, in seconds.">value</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _value; }
|
|
<a name="l00042"></a>00042 <span class="keywordtype">void</span> <a class="code" href="classTimeField.html#a063b6df2bd6fa7970ee445ab4e5d1fc1" title="Sets the value of this time field, in seconds.">setValue</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f" title="Returns the current value of this time field, in seconds.">value</a>);
|
|
<a name="l00043"></a>00043
|
|
<a name="l00044"></a><a class="code" href="classTimeField.html#aa73f5a62c330ac7d2f647dfe27d026b7">00044</a> <span class="keywordtype">int</span> <a class="code" href="classTimeField.html#aa73f5a62c330ac7d2f647dfe27d026b7" title="Returns the maximum number of hours before the field wraps around.">maxHours</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _maxHours; }
|
|
<a name="l00045"></a><a class="code" href="classTimeField.html#a7ac124eb9dde01c18c711c421736b5ed">00045</a> <span class="keywordtype">void</span> <a class="code" href="classTimeField.html#a7ac124eb9dde01c18c711c421736b5ed" title="Sets the maximum number of hours before the field wraps around to maxHours.">setMaxHours</a>(<span class="keywordtype">int</span> maxHours) { _maxHours = <a class="code" href="classTimeField.html#aa73f5a62c330ac7d2f647dfe27d026b7" title="Returns the maximum number of hours before the field wraps around.">maxHours</a>; }
|
|
<a name="l00046"></a>00046
|
|
<a name="l00047"></a><a class="code" href="classTimeField.html#aa0795c873ba9941c8a1a3bf8c06668f1">00047</a> <span class="keywordtype">bool</span> <a class="code" href="classTimeField.html#aa0795c873ba9941c8a1a3bf8c06668f1" title="Returns TIMEFIELD_READ_ONLY (true) or TIMEFIELD_READ_WRITE (false).">readOnly</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _readOnly; }
|
|
<a name="l00048"></a>00048 <span class="keywordtype">void</span> <a class="code" href="classTimeField.html#a3f002a0729e90e88d04025908be102fe" title="Sets the read-only state of this field to value.">setReadOnly</a>(<span class="keywordtype">bool</span> <a class="code" href="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f" title="Returns the current value of this time field, in seconds.">value</a>);
|
|
<a name="l00049"></a>00049
|
|
<a name="l00050"></a>00050 <span class="keyword">private</span>:
|
|
<a name="l00051"></a>00051 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> _value;
|
|
<a name="l00052"></a>00052 <span class="keywordtype">int</span> _maxHours;
|
|
<a name="l00053"></a>00053 <span class="keywordtype">int</span> _printLen;
|
|
<a name="l00054"></a>00054 <span class="keywordtype">bool</span> _readOnly;
|
|
<a name="l00055"></a>00055 uint8_t editField;
|
|
<a name="l00056"></a>00056
|
|
<a name="l00057"></a>00057 <span class="keywordtype">void</span> printTime();
|
|
<a name="l00058"></a>00058 <span class="keywordtype">int</span> printField(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f" title="Returns the current value of this time field, in seconds.">value</a>);
|
|
<a name="l00059"></a>00059 };
|
|
<a name="l00060"></a>00060
|
|
<a name="l00061"></a>00061 <span class="preprocessor">#endif</span>
|
|
</pre></div></div>
|
|
</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:25 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>
|