mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
165 lines
18 KiB
HTML
165 lines
18 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"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.6"/>
|
|
<title>ArduinoLibs: TextField.cpp Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<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>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<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>
|
|
<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>
|
|
<!-- 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><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</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>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_bc0718b08fb2015b8e59c47b2805f60c.html">libraries</a></li><li class="navelem"><a class="el" href="dir_48f64e79f12bd77ba047e9e436ec978c.html">LCD</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">TextField.cpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 2012 Southern Storm Software, Pty Ltd.</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * copy of this software and associated documentation files (the "Software"),</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * to deal in the Software without restriction, including without limitation</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * The above copyright notice and this permission notice shall be included</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * in all copies or substantial portions of the Software.</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * DEALINGS IN THE SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "TextField.h"</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classTextField.html#a5108741ab147b2cd5a399fefbe0a2382"> 66</a></span> <a class="code" href="classTextField.html#a5108741ab147b2cd5a399fefbe0a2382">TextField::TextField</a>(<span class="keyword">const</span> String &label)</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  : <a class="code" href="classField.html">Field</a>(label)</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> {</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> }</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classTextField.html#a24096a344d9161b2c99ce724ec2ee93c"> 77</a></span> <a class="code" href="classTextField.html#a5108741ab147b2cd5a399fefbe0a2382">TextField::TextField</a>(<a class="code" href="classForm.html">Form</a> &form, <span class="keyword">const</span> String &label, <span class="keyword">const</span> String &value)</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  : <a class="code" href="classField.html">Field</a>(form, label)</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  , _value(value)</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> {</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> }</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="classTextField.html#aa78f1354f9240b64fabd6f996e312f32"> 83</a></span> <span class="keywordtype">void</span> <a class="code" href="classTextField.html#aa78f1354f9240b64fabd6f996e312f32">TextField::enterField</a>(<span class="keywordtype">bool</span> reverse)</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> {</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="classField.html#aa032bbeacb405c56546cb56fbbee94f5">Field::enterField</a>(reverse);</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1">lcd</a>()->setCursor(0, 1);</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1">lcd</a>()->print(_value);</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> }</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="classTextField.html#a24b98c5bb744331bf0a5facc8ea9c033"> 102</a></span> <span class="keywordtype">void</span> <a class="code" href="classTextField.html#a24b98c5bb744331bf0a5facc8ea9c033">TextField::setValue</a>(<span class="keyword">const</span> String &value)</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> {</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordflow">if</span> (<a class="code" href="classField.html#a25d86a67b321e8c642edf75a10a35f72">isCurrent</a>()) {</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> prevLen = _value.length();</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> newLen = value.length();</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  _value = <a class="code" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1">value</a>;</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1">lcd</a>()->setCursor(0, 1);</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1">lcd</a>()->print(value);</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordflow">while</span> (newLen++ < prevLen)</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1">lcd</a>()->write(<span class="charliteral">' '</span>);</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  } <span class="keywordflow">else</span> {</div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  _value = <a class="code" href="classTextField.html#a124764b6fc7c19aaf683f72cd42636b1">value</a>;</div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  }</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</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_aa032bbeacb405c56546cb56fbbee94f5"><div class="ttname"><a href="classField.html#aa032bbeacb405c56546cb56fbbee94f5">Field::enterField</a></div><div class="ttdeci">virtual void enterField(bool reverse)</div><div class="ttdoc">Enters the field due to form navigation. </div><div class="ttdef"><b>Definition:</b> <a href="Field_8cpp_source.html#l00116">Field.cpp:116</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="classField_html_a5cf21bf958a71e51feac9e1bf9f599d1"><div class="ttname"><a href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1">Field::lcd</a></div><div class="ttdeci">LiquidCrystal * lcd() const </div><div class="ttdoc">Returns the LCD that this field is being drawn on. </div><div class="ttdef"><b>Definition:</b> <a href="Field_8h_source.html#l00047">Field.h:47</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="classField_html_a25d86a67b321e8c642edf75a10a35f72"><div class="ttname"><a href="classField.html#a25d86a67b321e8c642edf75a10a35f72">Field::isCurrent</a></div><div class="ttdeci">bool isCurrent() const </div><div class="ttdoc">Returns true if this field is the currently-displayed field in its owning form; false otherwise...</div><div class="ttdef"><b>Definition:</b> <a href="Field_8cpp_source.html#l00169">Field.cpp:169</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sun Mar 22 2015 15:54:26 for ArduinoLibs by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|