mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
174 lines
14 KiB
HTML
174 lines
14 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"/>
|
|
<title>ArduinoLibs: Field.cpp Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body onload='searchBox.OnSelectItem(0);'>
|
|
<!-- Generated by Doxygen 1.7.4 -->
|
|
<script type="text/javascript"><!--
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
--></script>
|
|
<div id="top">
|
|
<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>
|
|
<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 id="searchli">
|
|
<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>
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Field.cpp</div> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
|
|
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2012 Southern Storm Software, Pty Ltd.</span>
|
|
<a name="l00003"></a>00003 <span class="comment"> *</span>
|
|
<a name="l00004"></a>00004 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span>
|
|
<a name="l00005"></a>00005 <span class="comment"> * copy of this software and associated documentation files (the "Software"),</span>
|
|
<a name="l00006"></a>00006 <span class="comment"> * to deal in the Software without restriction, including without limitation</span>
|
|
<a name="l00007"></a>00007 <span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span>
|
|
<a name="l00008"></a>00008 <span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span>
|
|
<a name="l00009"></a>00009 <span class="comment"> * Software is furnished to do so, subject to the following conditions:</span>
|
|
<a name="l00010"></a>00010 <span class="comment"> *</span>
|
|
<a name="l00011"></a>00011 <span class="comment"> * The above copyright notice and this permission notice shall be included</span>
|
|
<a name="l00012"></a>00012 <span class="comment"> * in all copies or substantial portions of the Software.</span>
|
|
<a name="l00013"></a>00013 <span class="comment"> *</span>
|
|
<a name="l00014"></a>00014 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS</span>
|
|
<a name="l00015"></a>00015 <span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
|
|
<a name="l00016"></a>00016 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
|
|
<a name="l00017"></a>00017 <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
|
|
<a name="l00018"></a>00018 <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span>
|
|
<a name="l00019"></a>00019 <span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span>
|
|
<a name="l00020"></a>00020 <span class="comment"> * DEALINGS IN THE SOFTWARE.</span>
|
|
<a name="l00021"></a>00021 <span class="comment"> */</span>
|
|
<a name="l00022"></a>00022
|
|
<a name="l00023"></a>00023 <span class="preprocessor">#include "Field.h"</span>
|
|
<a name="l00024"></a>00024
|
|
<a name="l00040"></a><a class="code" href="classField.html#ac4ea0d104376233c3f0bfc080ec8564e">00040</a> <a class="code" href="classField.html#ac4ea0d104376233c3f0bfc080ec8564e" title="Constructs a new field with a specific label.">Field::Field</a>(<span class="keyword">const</span> String &label)
|
|
<a name="l00041"></a>00041 : _label(label)
|
|
<a name="l00042"></a>00042 , _form(0)
|
|
<a name="l00043"></a>00043 , next(0)
|
|
<a name="l00044"></a>00044 , prev(0)
|
|
<a name="l00045"></a>00045 {
|
|
<a name="l00046"></a>00046 }
|
|
<a name="l00047"></a>00047
|
|
<a name="l00052"></a><a class="code" href="classField.html#a7e2bdb203ddfd9219696f263c1731fe7">00052</a> <a class="code" href="classField.html#ac4ea0d104376233c3f0bfc080ec8564e" title="Constructs a new field with a specific label.">Field::Field</a>(<a class="code" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a> &form, <span class="keyword">const</span> String &label)
|
|
<a name="l00053"></a>00053 : _label(label)
|
|
<a name="l00054"></a>00054 , _form(0)
|
|
<a name="l00055"></a>00055 , next(0)
|
|
<a name="l00056"></a>00056 , prev(0)
|
|
<a name="l00057"></a>00057 {
|
|
<a name="l00058"></a>00058 form.<a class="code" href="classForm.html#a5cb056ace428e75e321610555bfecac7" title="Adds field to this form.">addField</a>(<span class="keyword">this</span>);
|
|
<a name="l00059"></a>00059 }
|
|
<a name="l00060"></a>00060
|
|
<a name="l00066"></a><a class="code" href="classField.html#a45d6e6d09b8f8e46de62b40119d62c60">00066</a> <a class="code" href="classField.html#a45d6e6d09b8f8e46de62b40119d62c60" title="Destroys this field and removes it from its owning Form.">Field::~Field</a>()
|
|
<a name="l00067"></a>00067 {
|
|
<a name="l00068"></a>00068 <span class="keywordflow">if</span> (_form)
|
|
<a name="l00069"></a>00069 _form-><a class="code" href="classForm.html#a7abd717029f9b19ee7318470072cd697" title="Removes field from this form.">removeField</a>(<span class="keyword">this</span>);
|
|
<a name="l00070"></a>00070 }
|
|
<a name="l00071"></a>00071
|
|
<a name="l00096"></a><a class="code" href="classField.html#a061bd1ed4d8b079df86465df8facd3b3">00096</a> <span class="keywordtype">int</span> <a class="code" href="classField.html#a061bd1ed4d8b079df86465df8facd3b3" title="Dispatches event via this field.">Field::dispatch</a>(<span class="keywordtype">int</span> event)
|
|
<a name="l00097"></a>00097 {
|
|
<a name="l00098"></a>00098 <span class="comment">// Nothing to do here.</span>
|
|
<a name="l00099"></a>00099 <span class="keywordflow">return</span> -1;
|
|
<a name="l00100"></a>00100 }
|
|
<a name="l00101"></a>00101
|
|
<a name="l00116"></a><a class="code" href="classField.html#aa032bbeacb405c56546cb56fbbee94f5">00116</a> <span class="keywordtype">void</span> <a class="code" href="classField.html#aa032bbeacb405c56546cb56fbbee94f5" title="Enters the field due to form navigation.">Field::enterField</a>(<span class="keywordtype">bool</span> reverse)
|
|
<a name="l00117"></a>00117 {
|
|
<a name="l00118"></a>00118 <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1" title="Returns the LCD that this field is being drawn on.">lcd</a>()->print(_label);
|
|
<a name="l00119"></a>00119 }
|
|
<a name="l00120"></a>00120
|
|
<a name="l00129"></a><a class="code" href="classField.html#ad6805c75ee1e62f8cd8bd550c4530c07">00129</a> <span class="keywordtype">void</span> <a class="code" href="classField.html#ad6805c75ee1e62f8cd8bd550c4530c07" title="Exits the field due to form navigation.">Field::exitField</a>()
|
|
<a name="l00130"></a>00130 {
|
|
<a name="l00131"></a>00131 <span class="comment">// Nothing to do here.</span>
|
|
<a name="l00132"></a>00132 }
|
|
<a name="l00133"></a>00133
|
|
<a name="l00146"></a><a class="code" href="classField.html#ad4ea63599d780c35b296cf2840b69f7b">00146</a> <span class="keywordtype">void</span> <a class="code" href="classField.html#ad4ea63599d780c35b296cf2840b69f7b" title="Sets the label to display in the first line of this field.">Field::setLabel</a>(<span class="keyword">const</span> String &label)
|
|
<a name="l00147"></a>00147 {
|
|
<a name="l00148"></a>00148 <span class="keywordflow">if</span> (<a class="code" href="classField.html#a25d86a67b321e8c642edf75a10a35f72" title="Returns true if this field is the currently-displayed field in its owning form; false otherwise...">isCurrent</a>()) {
|
|
<a name="l00149"></a>00149 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> prevLen = _label.length();
|
|
<a name="l00150"></a>00150 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> newLen = label.length();
|
|
<a name="l00151"></a>00151 _label = <a class="code" href="classField.html#aaa861ef917130c989a955bc75c683afe" title="Returns the label to display in the first line of this field.">label</a>;
|
|
<a name="l00152"></a>00152 <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1" title="Returns the LCD that this field is being drawn on.">lcd</a>()->setCursor(0, 0);
|
|
<a name="l00153"></a>00153 <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1" title="Returns the LCD that this field is being drawn on.">lcd</a>()->print(label);
|
|
<a name="l00154"></a>00154 <span class="keywordflow">while</span> (newLen++ < prevLen)
|
|
<a name="l00155"></a>00155 <a class="code" href="classField.html#a5cf21bf958a71e51feac9e1bf9f599d1" title="Returns the LCD that this field is being drawn on.">lcd</a>()->write(<span class="charliteral">' '</span>);
|
|
<a name="l00156"></a>00156 <a class="code" href="classField.html#afc612378167be0e7f8a6f8395b3537bd" title="Updates the cursor position after the label has been drawn by setLabel().">updateCursor</a>();
|
|
<a name="l00157"></a>00157 } <span class="keywordflow">else</span> {
|
|
<a name="l00158"></a>00158 _label = <a class="code" href="classField.html#aaa861ef917130c989a955bc75c683afe" title="Returns the label to display in the first line of this field.">label</a>;
|
|
<a name="l00159"></a>00159 }
|
|
<a name="l00160"></a>00160 }
|
|
<a name="l00161"></a>00161
|
|
<a name="l00169"></a><a class="code" href="classField.html#a25d86a67b321e8c642edf75a10a35f72">00169</a> <span class="keywordtype">bool</span> <a class="code" href="classField.html#a25d86a67b321e8c642edf75a10a35f72" title="Returns true if this field is the currently-displayed field in its owning form; false otherwise...">Field::isCurrent</a>()<span class="keyword"> const</span>
|
|
<a name="l00170"></a>00170 <span class="keyword"></span>{
|
|
<a name="l00171"></a>00171 <span class="keywordflow">if</span> (!_form-><a class="code" href="classForm.html#a3101f288e3e5aa8307c57f35861ad587" title="Returns true if the form is shown; false if the form is hidden.">isVisible</a>())
|
|
<a name="l00172"></a>00172 <span class="keywordflow">return</span> <span class="keyword">false</span>;
|
|
<a name="l00173"></a>00173 <span class="keywordflow">return</span> _form-><a class="code" href="classForm.html#a85a219a73294cef1f89a2182b5c25bf8" title="Returns the current field that is displayed on-screen.">currentField</a>() == <span class="keyword">this</span>;
|
|
<a name="l00174"></a>00174 }
|
|
<a name="l00175"></a>00175
|
|
<a name="l00191"></a><a class="code" href="classField.html#afc612378167be0e7f8a6f8395b3537bd">00191</a> <span class="keywordtype">void</span> <a class="code" href="classField.html#afc612378167be0e7f8a6f8395b3537bd" title="Updates the cursor position after the label has been drawn by setLabel().">Field::updateCursor</a>()
|
|
<a name="l00192"></a>00192 {
|
|
<a name="l00193"></a>00193 <span class="comment">// Nothing to do here.</span>
|
|
<a name="l00194"></a>00194 }
|
|
</pre></div></div>
|
|
</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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</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>
|
|
|
|
<hr class="footer"/><address class="footer"><small>Generated on Mon May 28 2012 20:55:50 for ArduinoLibs by 
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
|
|
</body>
|
|
</html>
|