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

37
ListField_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: ListField.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>
@@ -118,20 +119,20 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">typedef</span> PGM_P ListItem;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">typedef</span> <span class="keyword">const</span> PROGMEM ListItem *ListItems;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="classListField.html"> 32</a></span>&#160;<span class="keyword">class </span><a class="code" href="classListField.html" title="Field that manages selection from a static list of items.">ListField</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="l00032"></a><span class="lineno"><a class="line" href="classListField.html"> 32</a></span>&#160;<span class="keyword">class </span><a class="code" href="classListField.html">ListField</a> : <span class="keyword">public</span> <a class="code" href="classField.html">Field</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="classListField.html#a118501da7edb0b0bc6b493734975b4e9" title="Constructs a new list field with a specific label.">ListField</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="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="classListField.html#a118501da7edb0b0bc6b493734975b4e9" title="Constructs a new list field with a specific label.">ListField</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, ListItems <a class="code" href="classListField.html#a4dbbdeebd386551eb8f245b42b45ccf0" title="Returns the array of items in this list.">items</a>, <span class="keywordtype">int</span> <a class="code" href="classListField.html#aab8477757cd89bacd242c85bac2dccb1" title="Returns the value of this list; i.e. the index within items() of the selected item.">value</a> = 0);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classListField.html#a118501da7edb0b0bc6b493734975b4e9">ListField</a>(<span class="keyword">const</span> String &amp;<a class="code" href="classField.html#aaa861ef917130c989a955bc75c683afe">label</a>);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="classListField.html#a118501da7edb0b0bc6b493734975b4e9">ListField</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, ListItems <a class="code" href="classListField.html#a4dbbdeebd386551eb8f245b42b45ccf0">items</a>, <span class="keywordtype">int</span> <a class="code" href="classListField.html#aab8477757cd89bacd242c85bac2dccb1">value</a> = 0);</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="classListField.html#a5d752bd561cde735b175bcdfda55832a" title="Dispatches event via this field.">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="classListField.html#a5d752bd561cde735b175bcdfda55832a">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="classListField.html#a191b79b460e45cf48e04b04eface2888" 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="classListField.html#a191b79b460e45cf48e04b04eface2888">enterField</a>(<span class="keywordtype">bool</span> reverse);</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="classListField.html#a4dbbdeebd386551eb8f245b42b45ccf0"> 41</a></span>&#160; ListItems <a class="code" href="classListField.html#a4dbbdeebd386551eb8f245b42b45ccf0" title="Returns the array of items in this list.">items</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _items; }</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classListField.html#ae6709bce9355451b651893691456704e" title="Sets the array of items for this list.">setItems</a>(ListItems items);</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classListField.html#a4dbbdeebd386551eb8f245b42b45ccf0"> 41</a></span>&#160; ListItems <a class="code" href="classListField.html#a4dbbdeebd386551eb8f245b42b45ccf0">items</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _items; }</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classListField.html#ae6709bce9355451b651893691456704e">setItems</a>(ListItems items);</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="classListField.html#aab8477757cd89bacd242c85bac2dccb1"> 44</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classListField.html#aab8477757cd89bacd242c85bac2dccb1" title="Returns the value of this list; i.e. the index within items() of the selected item.">value</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _value; }</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classListField.html#a266193631e897fb0b46e1270b1d0eb24" title="Sets the value of this list; i.e. the index within items() of the selected item.">setValue</a>(<span class="keywordtype">int</span> <a class="code" href="classListField.html#aab8477757cd89bacd242c85bac2dccb1" title="Returns the value of this list; i.e. the index within items() of the selected item.">value</a>);</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classListField.html#aab8477757cd89bacd242c85bac2dccb1"> 44</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classListField.html#aab8477757cd89bacd242c85bac2dccb1">value</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _value; }</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classListField.html#a266193631e897fb0b46e1270b1d0eb24">setValue</a>(<span class="keywordtype">int</span> <a class="code" href="classListField.html#aab8477757cd89bacd242c85bac2dccb1">value</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"> 47</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; ListItems _items;</div>
@@ -143,12 +144,24 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<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;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="classListField_html_a118501da7edb0b0bc6b493734975b4e9"><div class="ttname"><a href="classListField.html#a118501da7edb0b0bc6b493734975b4e9">ListField::ListField</a></div><div class="ttdeci">ListField(const String &amp;label)</div><div class="ttdoc">Constructs a new list field with a specific label. </div><div class="ttdef"><b>Definition:</b> <a href="ListField_8cpp_source.html#l00064">ListField.cpp:64</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="classListField_html_aab8477757cd89bacd242c85bac2dccb1"><div class="ttname"><a href="classListField.html#aab8477757cd89bacd242c85bac2dccb1">ListField::value</a></div><div class="ttdeci">int value() const </div><div class="ttdoc">Returns the value of this list; i.e. the index within items() of the selected item. </div><div class="ttdef"><b>Definition:</b> <a href="ListField_8h_source.html#l00044">ListField.h:44</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="classListField_html_ae6709bce9355451b651893691456704e"><div class="ttname"><a href="classListField.html#ae6709bce9355451b651893691456704e">ListField::setItems</a></div><div class="ttdeci">void setItems(ListItems items)</div><div class="ttdoc">Sets the array of items for this list. </div><div class="ttdef"><b>Definition:</b> <a href="ListField_8cpp_source.html#l00141">ListField.cpp:141</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="classListField_html_a4dbbdeebd386551eb8f245b42b45ccf0"><div class="ttname"><a href="classListField.html#a4dbbdeebd386551eb8f245b42b45ccf0">ListField::items</a></div><div class="ttdeci">ListItems items() const </div><div class="ttdoc">Returns the array of items in this list. </div><div class="ttdef"><b>Definition:</b> <a href="ListField_8h_source.html#l00041">ListField.h:41</a></div></div>
<div class="ttc" id="classListField_html_a191b79b460e45cf48e04b04eface2888"><div class="ttname"><a href="classListField.html#a191b79b460e45cf48e04b04eface2888">ListField::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="ListField_8cpp_source.html#l00105">ListField.cpp:105</a></div></div>
<div class="ttc" id="classListField_html_a266193631e897fb0b46e1270b1d0eb24"><div class="ttname"><a href="classListField.html#a266193631e897fb0b46e1270b1d0eb24">ListField::setValue</a></div><div class="ttdeci">void setValue(int value)</div><div class="ttdoc">Sets the value of this list; i.e. the index within items() of the selected item. </div><div class="ttdef"><b>Definition:</b> <a href="ListField_8cpp_source.html#l00178">ListField.cpp:178</a></div></div>
<div class="ttc" id="classListField_html"><div class="ttname"><a href="classListField.html">ListField</a></div><div class="ttdoc">Field that manages selection from a static list of items. </div><div class="ttdef"><b>Definition:</b> <a href="ListField_8h_source.html#l00032">ListField.h:32</a></div></div>
<div class="ttc" id="classListField_html_a5d752bd561cde735b175bcdfda55832a"><div class="ttname"><a href="classListField.html#a5d752bd561cde735b175bcdfda55832a">ListField::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="ListField_8cpp_source.html#l00087">ListField.cpp:87</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>