ArduinoLibs
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
BoolField.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 BoolField_h
24 #define BoolField_h
25 
26 #include "Field.h"
27 
28 class BoolField : public Field {
29 public:
30  explicit BoolField(const String &label);
31  BoolField(Form &form, const String &label, const String &trueLabel, const String &falseLabel, bool value);
32 
33  int dispatch(int event);
34 
35  void enterField(bool reverse);
36 
37  bool value() const { return _value; }
38  void setValue(bool value);
39 
40  const String &trueLabel() const { return _trueLabel; }
41  void setTrueLabel(const String &trueLabel);
42 
43  const String &falseLabel() const { return _falseLabel; }
44  void setFalseLabel(const String &falseLabel);
45 
46 private:
47  String _trueLabel;
48  String _falseLabel;
49  int _printLen;
50  bool _value;
51 
52  void printValue();
53 };
54 
55 #endif
BoolField(const String &label)
Constructs a new boolean field with a specific label.
Definition: BoolField.cpp:77
void setValue(bool value)
Sets the current value of this field to value.
Definition: BoolField.cpp:131
const String & trueLabel() const
Returns the string that is displayed when value() is true.
Definition: BoolField.h:40
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
void setTrueLabel(const String &trueLabel)
Sets the string that is displayed when value() is true to trueLabel.
Definition: BoolField.cpp:153
const String & label() const
Returns the label to display in the first line of this field.
Definition: Field.h:41
void setFalseLabel(const String &falseLabel)
Sets the string that is displayed when value() is false to falseLabel.
Definition: BoolField.cpp:173
int dispatch(int event)
Dispatches event via this field.
Definition: BoolField.cpp:103
void enterField(bool reverse)
Enters the field due to form navigation.
Definition: BoolField.cpp:113
const String & falseLabel() const
Returns the string that is displayed when value() is false.
Definition: BoolField.h:43
bool value() const
Returns the current value of this field, true or false.
Definition: BoolField.h:37
Field that manages the input of a boolean value.
Definition: BoolField.h:28