ArduinoLibs
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
TextField.h
1 /*
2  * Copyright (C) 2012 Southern Storm Software, Pty Ltd.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included
12  * in all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20  * DEALINGS IN THE SOFTWARE.
21  */
22 
23 #ifndef TextField_h
24 #define TextField_h
25 
26 #include "Field.h"
27 
28 class TextField : public Field {
29 public:
30  explicit TextField(const String &label);
31  TextField(Form &form, const String &label, const String &value);
32 
33  void enterField(bool reverse);
34 
35  const String &value() const { return _value; }
36  void setValue(const String &value);
37 
38 private:
39  String _value;
40 };
41 
42 #endif
void setValue(const String &value)
Sets the text value that is displayed by this field.
Definition: TextField.cpp:102
TextField(const String &label)
Constructs a new text field with a specific label.
Definition: TextField.cpp:66
Manages a single data input/output field within a Form.
Definition: Field.h:28
Manager for a form containing data input/output fields.
Definition: Form.h:32
Form * form() const
Returns the Form that owns this field; null if not associated with a Form.
Definition: Field.h:34
const String & label() const
Returns the label to display in the first line of this field.
Definition: Field.h:41
void enterField(bool reverse)
Enters the field due to form navigation.
Definition: TextField.cpp:83
const String & value() const
Returns the text value that is currently displayed by this field.
Definition: TextField.h:35
Field that displays a read-only text value.
Definition: TextField.h:28