mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
Update docs
This commit is contained in:
Rhys Weatherley
@@ -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: TextField.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,27 +115,36 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "Field.h"</span></div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"><a class="code" href="classTextField.html"> 28</a></span> <span class="keyword">class </span><a class="code" href="classTextField.html" title="Field that displays a read-only text value.">TextField</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="l00028"></a><span class="lineno"><a class="line" href="classTextField.html"> 28</a></span> <span class="keyword">class </span><a class="code" href="classTextField.html">TextField</a> : <span class="keyword">public</span> <a class="code" href="classField.html">Field</a> {</div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">public</span>:</div>
|
||||
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">explicit</span> <a class="code" href="classTextField.html#a5108741ab147b2cd5a399fefbe0a2382" title="Constructs a new text field with a specific label.">TextField</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>);</div>
|
||||
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="classTextField.html#a5108741ab147b2cd5a399fefbe0a2382" title="Constructs a new text field with a specific label.">TextField</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="keyword">const</span> String &<a class="code" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1" title="Returns the text value that is currently displayed by this field.">value</a>);</div>
|
||||
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">explicit</span> <a class="code" href="classTextField.html#a5108741ab147b2cd5a399fefbe0a2382">TextField</a>(<span class="keyword">const</span> String &<a class="code" href="classField.html#aaa861ef917130c989a955bc75c683afe">label</a>);</div>
|
||||
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="classTextField.html#a5108741ab147b2cd5a399fefbe0a2382">TextField</a>(<a class="code" href="classForm.html">Form</a> &<a class="code" href="classField.html#a27427319be1cc92db3128637d8884ee5">form</a>, <span class="keyword">const</span> String &label, <span class="keyword">const</span> String &<a class="code" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1">value</a>);</div>
|
||||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">void</span> <a class="code" href="classTextField.html#aa78f1354f9240b64fabd6f996e312f32" title="Enters the field due to form navigation.">enterField</a>(<span class="keywordtype">bool</span> reverse);</div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">void</span> <a class="code" href="classTextField.html#aa78f1354f9240b64fabd6f996e312f32">enterField</a>(<span class="keywordtype">bool</span> reverse);</div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"><a class="code" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1"> 35</a></span>  <span class="keyword">const</span> String &<a class="code" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1" title="Returns the text value that is currently displayed by this field.">value</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _value; }</div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">void</span> <a class="code" href="classTextField.html#a24b98c5bb744331bf0a5facc8ea9c033" title="Sets the text value that is displayed by this field.">setValue</a>(<span class="keyword">const</span> String &value);</div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1"> 35</a></span>  <span class="keyword">const</span> String &<a class="code" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1">value</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _value; }</div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">void</span> <a class="code" href="classTextField.html#a24b98c5bb744331bf0a5facc8ea9c033">setValue</a>(<span class="keyword">const</span> String &value);</div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">private</span>:</div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  String _value;</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> };</div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="ttc" id="classTextField_html_a24b98c5bb744331bf0a5facc8ea9c033"><div class="ttname"><a href="classTextField.html#a24b98c5bb744331bf0a5facc8ea9c033">TextField::setValue</a></div><div class="ttdeci">void setValue(const String &value)</div><div class="ttdoc">Sets the text value that is displayed by this field. </div><div class="ttdef"><b>Definition:</b> <a href="TextField_8cpp_source.html#l00102">TextField.cpp:102</a></div></div>
|
||||
<div class="ttc" id="classTextField_html_a5108741ab147b2cd5a399fefbe0a2382"><div class="ttname"><a href="classTextField.html#a5108741ab147b2cd5a399fefbe0a2382">TextField::TextField</a></div><div class="ttdeci">TextField(const String &label)</div><div class="ttdoc">Constructs a new text field with a specific label. </div><div class="ttdef"><b>Definition:</b> <a href="TextField_8cpp_source.html#l00066">TextField.cpp:66</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="classField_html_aaa861ef917130c989a955bc75c683afe"><div class="ttname"><a href="classField.html#aaa861ef917130c989a955bc75c683afe">Field::label</a></div><div class="ttdeci">const String & 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="classTextField_html_aa78f1354f9240b64fabd6f996e312f32"><div class="ttname"><a href="classTextField.html#aa78f1354f9240b64fabd6f996e312f32">TextField::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="TextField_8cpp_source.html#l00083">TextField.cpp:83</a></div></div>
|
||||
<div class="ttc" id="classTextField_html_a124764b6fc7c19aaf683f72cd42636b1"><div class="ttname"><a href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1">TextField::value</a></div><div class="ttdeci">const String & value() const </div><div class="ttdoc">Returns the text value that is currently displayed by this field. </div><div class="ttdef"><b>Definition:</b> <a href="TextField_8h_source.html#l00035">TextField.h:35</a></div></div>
|
||||
<div class="ttc" id="classTextField_html"><div class="ttname"><a href="classTextField.html">TextField</a></div><div class="ttdoc">Field that displays a read-only text value. </div><div class="ttdef"><b>Definition:</b> <a href="TextField_8h_source.html#l00028">TextField.h:28</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  <a href="http://www.doxygen.org/index.html">
|
||||
Generated on Thu Mar 12 2015 19:02:05 for ArduinoLibs by  <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>
|
||||
|
||||
Reference in New Issue
Block a user