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

63
Form_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: Form.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>
@@ -114,50 +115,66 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;LCD.h&quot;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">class </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="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">class </span><a class="code" href="classField.html">Field</a>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#define FORM_CHANGED 1</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="classForm.html"> 32</a></span>&#160;<span class="keyword">class </span><a class="code" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a> {</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classForm.html"> 32</a></span>&#160;<span class="keyword">class </span><a class="code" href="classForm.html">Form</a> {</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classForm.html#ad30836b22edde707a52d94090b716996" title="Constructs a new form and associates it with lcd.">Form</a>(LiquidCrystal &amp;lcd);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="classForm.html#a9cda7cce41e81bfaca51e922d4f9b98f" title="Detaches all remaining fields and destroys this form.">~Form</a>();</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classForm.html#ad30836b22edde707a52d94090b716996">Form</a>(LiquidCrystal &amp;lcd);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="classForm.html#a9cda7cce41e81bfaca51e922d4f9b98f">~Form</a>();</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classForm.html#a89bd3850e87caa2ca7b2e946f923d0ee" title="Dispatches event to the currently active field using Field::dispatch().">dispatch</a>(<span class="keywordtype">int</span> event);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classForm.html#a89bd3850e87caa2ca7b2e946f923d0ee">dispatch</a>(<span class="keywordtype">int</span> event);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classForm.html#a788a186ea4a7ebd75283a948ca45f4d1" title="Changes to the next field in the &quot;tab order&quot;.">nextField</a>();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classForm.html#acb080fe4f4631e9060e6efab8eaa0a90" title="Changes to the previous field in the &quot;tab order&quot;.">prevField</a>();</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classForm.html#aba75b59f68b31dd77dbbac9ab5c3124b" title="Changes to default field (i.e., the first field).">defaultField</a>();</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classForm.html#a788a186ea4a7ebd75283a948ca45f4d1">nextField</a>();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classForm.html#acb080fe4f4631e9060e6efab8eaa0a90">prevField</a>();</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classForm.html#aba75b59f68b31dd77dbbac9ab5c3124b">defaultField</a>();</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classForm.html#a5cb056ace428e75e321610555bfecac7" title="Adds field to this form.">addField</a>(<a class="code" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a> *field);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classForm.html#a7abd717029f9b19ee7318470072cd697" title="Removes field from this form.">removeField</a>(<a class="code" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a> *field);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classForm.html#a5cb056ace428e75e321610555bfecac7">addField</a>(<a class="code" href="classField.html">Field</a> *field);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classForm.html#a7abd717029f9b19ee7318470072cd697">removeField</a>(<a class="code" href="classField.html">Field</a> *field);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="code" href="classForm.html#a85a219a73294cef1f89a2182b5c25bf8"> 46</a></span>&#160; <a class="code" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a> *<a class="code" href="classForm.html#a85a219a73294cef1f89a2182b5c25bf8" title="Returns the current field that is displayed on-screen.">currentField</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> current; }</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classForm.html#ae6004fedfa07191ffd47d7b12370b4e5" title="Sets the current field that is displayed on-screen.">setCurrentField</a>(<a class="code" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a> *field);</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classForm.html#a85a219a73294cef1f89a2182b5c25bf8"> 46</a></span>&#160; <a class="code" href="classField.html">Field</a> *<a class="code" href="classForm.html#a85a219a73294cef1f89a2182b5c25bf8">currentField</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> current; }</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classForm.html#ae6004fedfa07191ffd47d7b12370b4e5">setCurrentField</a>(<a class="code" href="classField.html">Field</a> *field);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="code" href="classForm.html#a48fb77f93e77b28b0397b59e1e9bf789"> 49</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classForm.html#a48fb77f93e77b28b0397b59e1e9bf789" title="Returns true if field is currently displayed on-screen, false otherwise.">isCurrent</a>(<a class="code" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a> &amp;field)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> current == &amp;field; }</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classForm.html#a48fb77f93e77b28b0397b59e1e9bf789"> 49</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classForm.html#a48fb77f93e77b28b0397b59e1e9bf789">isCurrent</a>(<a class="code" href="classField.html">Field</a> &amp;field)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> current == &amp;field; }</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classForm.html#a9e8d718ab55a8034c22c606ccfa90d65" title="Shows the form, or does nothing if the form is already on-screen.">show</a>();</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classForm.html#a88b9146a3f68e837c5e831203096f9e9" title="Hides the form, or does nothing if the form is not on-screen.">hide</a>();</div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="code" href="classForm.html#a3101f288e3e5aa8307c57f35861ad587"> 53</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classForm.html#a3101f288e3e5aa8307c57f35861ad587" title="Returns true if the form is shown; false if the form is hidden.">isVisible</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> visible; }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classForm.html#a9e8d718ab55a8034c22c606ccfa90d65">show</a>();</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classForm.html#a88b9146a3f68e837c5e831203096f9e9">hide</a>();</div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classForm.html#a3101f288e3e5aa8307c57f35861ad587"> 53</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classForm.html#a3101f288e3e5aa8307c57f35861ad587">isVisible</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> visible; }</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; LiquidCrystal *_lcd;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a> *first;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a> *last;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="code" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a> *current;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="classField.html">Field</a> *first;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="classField.html">Field</a> *last;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="code" href="classField.html">Field</a> *current;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordtype">bool</span> visible;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </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="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classField.html">Field</a>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;};</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="classForm_html_a3101f288e3e5aa8307c57f35861ad587"><div class="ttname"><a href="classForm.html#a3101f288e3e5aa8307c57f35861ad587">Form::isVisible</a></div><div class="ttdeci">bool isVisible() const </div><div class="ttdoc">Returns true if the form is shown; false if the form is hidden. </div><div class="ttdef"><b>Definition:</b> <a href="Form_8h_source.html#l00053">Form.h:53</a></div></div>
<div class="ttc" id="classForm_html_ad30836b22edde707a52d94090b716996"><div class="ttname"><a href="classForm.html#ad30836b22edde707a52d94090b716996">Form::Form</a></div><div class="ttdeci">Form(LiquidCrystal &amp;lcd)</div><div class="ttdoc">Constructs a new form and associates it with lcd. </div><div class="ttdef"><b>Definition:</b> <a href="Form_8cpp_source.html#l00047">Form.cpp:47</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_a89bd3850e87caa2ca7b2e946f923d0ee"><div class="ttname"><a href="classForm.html#a89bd3850e87caa2ca7b2e946f923d0ee">Form::dispatch</a></div><div class="ttdeci">int dispatch(int event)</div><div class="ttdoc">Dispatches event to the currently active field using Field::dispatch(). </div><div class="ttdef"><b>Definition:</b> <a href="Form_8cpp_source.html#l00099">Form.cpp:99</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="classForm_html_a788a186ea4a7ebd75283a948ca45f4d1"><div class="ttname"><a href="classForm.html#a788a186ea4a7ebd75283a948ca45f4d1">Form::nextField</a></div><div class="ttdeci">void nextField()</div><div class="ttdoc">Changes to the next field in the &quot;tab order&quot;. </div><div class="ttdef"><b>Definition:</b> <a href="Form_8cpp_source.html#l00118">Form.cpp:118</a></div></div>
<div class="ttc" id="classForm_html_a5cb056ace428e75e321610555bfecac7"><div class="ttname"><a href="classForm.html#a5cb056ace428e75e321610555bfecac7">Form::addField</a></div><div class="ttdeci">void addField(Field *field)</div><div class="ttdoc">Adds field to this form. </div><div class="ttdef"><b>Definition:</b> <a href="Form_8cpp_source.html#l00165">Form.cpp:165</a></div></div>
<div class="ttc" id="classForm_html_a88b9146a3f68e837c5e831203096f9e9"><div class="ttname"><a href="classForm.html#a88b9146a3f68e837c5e831203096f9e9">Form::hide</a></div><div class="ttdeci">void hide()</div><div class="ttdoc">Hides the form, or does nothing if the form is not on-screen. </div><div class="ttdef"><b>Definition:</b> <a href="Form_8cpp_source.html#l00293">Form.cpp:293</a></div></div>
<div class="ttc" id="classForm_html_a7abd717029f9b19ee7318470072cd697"><div class="ttname"><a href="classForm.html#a7abd717029f9b19ee7318470072cd697">Form::removeField</a></div><div class="ttdeci">void removeField(Field *field)</div><div class="ttdoc">Removes field from this form. </div><div class="ttdef"><b>Definition:</b> <a href="Form_8cpp_source.html#l00187">Form.cpp:187</a></div></div>
<div class="ttc" id="classForm_html_ae6004fedfa07191ffd47d7b12370b4e5"><div class="ttname"><a href="classForm.html#ae6004fedfa07191ffd47d7b12370b4e5">Form::setCurrentField</a></div><div class="ttdeci">void setCurrentField(Field *field)</div><div class="ttdoc">Sets the current field that is displayed on-screen. </div><div class="ttdef"><b>Definition:</b> <a href="Form_8cpp_source.html#l00230">Form.cpp:230</a></div></div>
<div class="ttc" id="classForm_html_a9cda7cce41e81bfaca51e922d4f9b98f"><div class="ttname"><a href="classForm.html#a9cda7cce41e81bfaca51e922d4f9b98f">Form::~Form</a></div><div class="ttdeci">~Form()</div><div class="ttdoc">Detaches all remaining fields and destroys this form. </div><div class="ttdef"><b>Definition:</b> <a href="Form_8cpp_source.html#l00058">Form.cpp:58</a></div></div>
<div class="ttc" id="classForm_html_a9e8d718ab55a8034c22c606ccfa90d65"><div class="ttname"><a href="classForm.html#a9e8d718ab55a8034c22c606ccfa90d65">Form::show</a></div><div class="ttdeci">void show()</div><div class="ttdoc">Shows the form, or does nothing if the form is already on-screen. </div><div class="ttdef"><b>Definition:</b> <a href="Form_8cpp_source.html#l00274">Form.cpp:274</a></div></div>
<div class="ttc" id="classForm_html_aba75b59f68b31dd77dbbac9ab5c3124b"><div class="ttname"><a href="classForm.html#aba75b59f68b31dd77dbbac9ab5c3124b">Form::defaultField</a></div><div class="ttdeci">void defaultField()</div><div class="ttdoc">Changes to default field (i.e., the first field). </div><div class="ttdef"><b>Definition:</b> <a href="Form_8cpp_source.html#l00152">Form.cpp:152</a></div></div>
<div class="ttc" id="classForm_html_a48fb77f93e77b28b0397b59e1e9bf789"><div class="ttname"><a href="classForm.html#a48fb77f93e77b28b0397b59e1e9bf789">Form::isCurrent</a></div><div class="ttdeci">bool isCurrent(Field &amp;field) const </div><div class="ttdoc">Returns true if field is currently displayed on-screen, false otherwise. </div><div class="ttdef"><b>Definition:</b> <a href="Form_8h_source.html#l00049">Form.h:49</a></div></div>
<div class="ttc" id="classForm_html_acb080fe4f4631e9060e6efab8eaa0a90"><div class="ttname"><a href="classForm.html#acb080fe4f4631e9060e6efab8eaa0a90">Form::prevField</a></div><div class="ttdeci">void prevField()</div><div class="ttdoc">Changes to the previous field in the &quot;tab order&quot;. </div><div class="ttdef"><b>Definition:</b> <a href="Form_8cpp_source.html#l00135">Form.cpp:135</a></div></div>
<div class="ttc" id="classForm_html_a85a219a73294cef1f89a2182b5c25bf8"><div class="ttname"><a href="classForm.html#a85a219a73294cef1f89a2182b5c25bf8">Form::currentField</a></div><div class="ttdeci">Field * currentField() const </div><div class="ttdoc">Returns the current field that is displayed on-screen. </div><div class="ttdef"><b>Definition:</b> <a href="Form_8h_source.html#l00046">Form.h:46</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>