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

Update docs

Browse Source
This commit is contained in:
Rhys Weatherley
2015-03-12 19:03:15 +10:00
parent 083448f195
commit c6206e4216
493 changed files with 35310 additions and 3018 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
TimeField_8h_source.html
View File

@@ -3,6 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>ArduinoLibs: TimeField.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
@@ -29,7 +30,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
@@ -117,24 +118,24 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#define TIMEFIELD_READ_ONLY true</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define TIMEFIELD_READ_WRITE false</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="code" href="classTimeField.html"> 31</a></span>&#160;<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> {</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classTimeField.html"> 31</a></span>&#160;<span class="keyword">class </span><a class="code" href="classTimeField.html">TimeField</a> : <span class="keyword">public</span> <a class="code" href="classField.html">Field</a> {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <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 &amp;<a class="code" href="classField.html#aaa861ef917130c989a955bc75c683afe" title="Returns the label to display in the first line of this field.">label</a>);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <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> &amp;<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 &amp;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>);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classTimeField.html#a138e2425379705828a87eb2d8a836431">TimeField</a>(<span class="keyword">const</span> String &amp;<a class="code" href="classField.html#aaa861ef917130c989a955bc75c683afe">label</a>);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <a class="code" href="classTimeField.html#a138e2425379705828a87eb2d8a836431">TimeField</a>(<a class="code" href="classForm.html">Form</a> &amp;<a class="code" href="classField.html#a27427319be1cc92db3128637d8884ee5">form</a>, <span class="keyword">const</span> String &amp;label, <span class="keywordtype">int</span> <a class="code" href="classTimeField.html#aa73f5a62c330ac7d2f647dfe27d026b7">maxHours</a>, <span class="keywordtype">bool</span> <a class="code" href="classTimeField.html#aa0795c873ba9941c8a1a3bf8c06668f1">readOnly</a>);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <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);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classTimeField.html#a9b953d9abdbe960a3fa34938462832e5">dispatch</a>(<span class="keywordtype">int</span> event);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <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);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classTimeField.html#a5a6b7db2e3fda7745e0ff9c3d8d9a541" title="Exits the field due to form navigation.">exitField</a>();</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classTimeField.html#ae914d6b870283a334d2d669460f7646b">enterField</a>(<span class="keywordtype">bool</span> reverse);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classTimeField.html#a5a6b7db2e3fda7745e0ff9c3d8d9a541">exitField</a>();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="code" href="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f"> 41</a></span>&#160; <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; }</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <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>);</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f"> 41</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f">value</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _value; }</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classTimeField.html#a063b6df2bd6fa7970ee445ab4e5d1fc1">setValue</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f">value</a>);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="classTimeField.html#aa73f5a62c330ac7d2f647dfe27d026b7"> 44</a></span>&#160; <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; }</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="classTimeField.html#a7ac124eb9dde01c18c711c421736b5ed"> 45</a></span>&#160; <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>; }</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classTimeField.html#aa73f5a62c330ac7d2f647dfe27d026b7"> 44</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classTimeField.html#aa73f5a62c330ac7d2f647dfe27d026b7">maxHours</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _maxHours; }</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classTimeField.html#a7ac124eb9dde01c18c711c421736b5ed"> 45</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classTimeField.html#a7ac124eb9dde01c18c711c421736b5ed">setMaxHours</a>(<span class="keywordtype">int</span> maxHours) { _maxHours = <a class="code" href="classTimeField.html#aa73f5a62c330ac7d2f647dfe27d026b7">maxHours</a>; }</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="classTimeField.html#aa0795c873ba9941c8a1a3bf8c06668f1"> 47</a></span>&#160; <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; }</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <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>);</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classTimeField.html#aa0795c873ba9941c8a1a3bf8c06668f1"> 47</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classTimeField.html#aa0795c873ba9941c8a1a3bf8c06668f1">readOnly</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _readOnly; }</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classTimeField.html#a3f002a0729e90e88d04025908be102fe">setReadOnly</a>(<span class="keywordtype">bool</span> <a class="code" href="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f">value</a>);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> _value;</div>
@@ -144,16 +145,31 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; uint8_t editField;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">void</span> printTime();</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <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>);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">int</span> printField(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f">value</a>);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;};</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="classTimeField_html_a7ac124eb9dde01c18c711c421736b5ed"><div class="ttname"><a href="classTimeField.html#a7ac124eb9dde01c18c711c421736b5ed">TimeField::setMaxHours</a></div><div class="ttdeci">void setMaxHours(int maxHours)</div><div class="ttdoc">Sets the maximum number of hours before the field wraps around to maxHours. </div><div class="ttdef"><b>Definition:</b> <a href="TimeField_8h_source.html#l00045">TimeField.h:45</a></div></div>
<div class="ttc" id="classTimeField_html_a400aaa72a83b3b872e1de1c3af1a240f"><div class="ttname"><a href="classTimeField.html#a400aaa72a83b3b872e1de1c3af1a240f">TimeField::value</a></div><div class="ttdeci">unsigned long value() const </div><div class="ttdoc">Returns the current value of this time field, in seconds. </div><div class="ttdef"><b>Definition:</b> <a href="TimeField_8h_source.html#l00041">TimeField.h:41</a></div></div>
<div class="ttc" id="classTimeField_html_a3f002a0729e90e88d04025908be102fe"><div class="ttname"><a href="classTimeField.html#a3f002a0729e90e88d04025908be102fe">TimeField::setReadOnly</a></div><div class="ttdeci">void setReadOnly(bool value)</div><div class="ttdoc">Sets the read-only state of this field to value. </div><div class="ttdef"><b>Definition:</b> <a href="TimeField_8cpp_source.html#l00268">TimeField.cpp:268</a></div></div>
<div class="ttc" id="classField_html"><div class="ttname"><a href="classField.html">Field</a></div><div class="ttdoc">Manages a single data input/output field within a Form. </div><div class="ttdef"><b>Definition:</b> <a href="Field_8h_source.html#l00028">Field.h:28</a></div></div>
<div class="ttc" id="classForm_html"><div class="ttname"><a href="classForm.html">Form</a></div><div class="ttdoc">Manager for a form containing data input/output fields. </div><div class="ttdef"><b>Definition:</b> <a href="Form_8h_source.html#l00032">Form.h:32</a></div></div>
<div class="ttc" id="classField_html_a27427319be1cc92db3128637d8884ee5"><div class="ttname"><a href="classField.html#a27427319be1cc92db3128637d8884ee5">Field::form</a></div><div class="ttdeci">Form * form() const </div><div class="ttdoc">Returns the Form that owns this field; null if not associated with a Form. </div><div class="ttdef"><b>Definition:</b> <a href="Field_8h_source.html#l00034">Field.h:34</a></div></div>
<div class="ttc" id="classTimeField_html_aa73f5a62c330ac7d2f647dfe27d026b7"><div class="ttname"><a href="classTimeField.html#aa73f5a62c330ac7d2f647dfe27d026b7">TimeField::maxHours</a></div><div class="ttdeci">int maxHours() const </div><div class="ttdoc">Returns the maximum number of hours before the field wraps around. </div><div class="ttdef"><b>Definition:</b> <a href="TimeField_8h_source.html#l00044">TimeField.h:44</a></div></div>
<div class="ttc" id="classField_html_aaa861ef917130c989a955bc75c683afe"><div class="ttname"><a href="classField.html#aaa861ef917130c989a955bc75c683afe">Field::label</a></div><div class="ttdeci">const String &amp; label() const </div><div class="ttdoc">Returns the label to display in the first line of this field. </div><div class="ttdef"><b>Definition:</b> <a href="Field_8h_source.html#l00041">Field.h:41</a></div></div>
<div class="ttc" id="classTimeField_html_a9b953d9abdbe960a3fa34938462832e5"><div class="ttname"><a href="classTimeField.html#a9b953d9abdbe960a3fa34938462832e5">TimeField::dispatch</a></div><div class="ttdeci">int dispatch(int event)</div><div class="ttdoc">Dispatches event via this field. </div><div class="ttdef"><b>Definition:</b> <a href="TimeField_8cpp_source.html#l00115">TimeField.cpp:115</a></div></div>
<div class="ttc" id="classTimeField_html"><div class="ttname"><a href="classTimeField.html">TimeField</a></div><div class="ttdoc">Field that manages the display and editing of a time value. </div><div class="ttdef"><b>Definition:</b> <a href="TimeField_8h_source.html#l00031">TimeField.h:31</a></div></div>
<div class="ttc" id="classTimeField_html_aa0795c873ba9941c8a1a3bf8c06668f1"><div class="ttname"><a href="classTimeField.html#aa0795c873ba9941c8a1a3bf8c06668f1">TimeField::readOnly</a></div><div class="ttdeci">bool readOnly() const </div><div class="ttdoc">Returns TIMEFIELD_READ_ONLY (true) or TIMEFIELD_READ_WRITE (false). </div><div class="ttdef"><b>Definition:</b> <a href="TimeField_8h_source.html#l00047">TimeField.h:47</a></div></div>
<div class="ttc" id="classTimeField_html_ae914d6b870283a334d2d669460f7646b"><div class="ttname"><a href="classTimeField.html#ae914d6b870283a334d2d669460f7646b">TimeField::enterField</a></div><div class="ttdeci">void enterField(bool reverse)</div><div class="ttdoc">Enters the field due to form navigation. </div><div class="ttdef"><b>Definition:</b> <a href="TimeField_8cpp_source.html#l00193">TimeField.cpp:193</a></div></div>
<div class="ttc" id="classTimeField_html_a138e2425379705828a87eb2d8a836431"><div class="ttname"><a href="classTimeField.html#a138e2425379705828a87eb2d8a836431">TimeField::TimeField</a></div><div class="ttdeci">TimeField(const String &amp;label)</div><div class="ttdoc">Constructs a new time field with a specific label. </div><div class="ttdef"><b>Definition:</b> <a href="TimeField_8cpp_source.html#l00082">TimeField.cpp:82</a></div></div>
<div class="ttc" id="classTimeField_html_a5a6b7db2e3fda7745e0ff9c3d8d9a541"><div class="ttname"><a href="classTimeField.html#a5a6b7db2e3fda7745e0ff9c3d8d9a541">TimeField::exitField</a></div><div class="ttdeci">void exitField()</div><div class="ttdoc">Exits the field due to form navigation. </div><div class="ttdef"><b>Definition:</b> <a href="TimeField_8cpp_source.html#l00205">TimeField.cpp:205</a></div></div>
<div class="ttc" id="classTimeField_html_a063b6df2bd6fa7970ee445ab4e5d1fc1"><div class="ttname"><a href="classTimeField.html#a063b6df2bd6fa7970ee445ab4e5d1fc1">TimeField::setValue</a></div><div class="ttdeci">void setValue(unsigned long value)</div><div class="ttdoc">Sets the value of this time field, in seconds. </div><div class="ttdef"><b>Definition:</b> <a href="TimeField_8cpp_source.html#l00227">TimeField.cpp:227</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 29 2013 09:30:46 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Mar 12 2015 19:02:05 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</a> 1.8.6
</small></address>
</body>
</html>