ArduinoLibs
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IntField.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 IntField_h
24 #define IntField_h
25 
26 #include "Field.h"
27 
28 class IntField : public Field {
29 public:
30  explicit IntField(const String &label);
31  IntField(Form &form, const String &label, int minValue, int maxValue, int stepValue, int value);
32  IntField(Form &form, const String &label, int minValue, int maxValue, int stepValue, int value, const String &suffix);
33 
34  int dispatch(int event);
35 
36  void enterField(bool reverse);
37 
38  int minValue() const { return _minValue; }
39  void setMinValue(int value) { _minValue = value; }
40 
41  int maxValue() const { return _maxValue; }
42  void setMaxValue(int value) { _maxValue = value; }
43 
44  int stepValue() const { return _stepValue; }
45  void setStepValue(int value) { _stepValue = value; }
46 
47  int value() const { return _value; }
48  void setValue(int value);
49 
50  const String &suffix() const { return _suffix; }
51  void setSuffix(const String &suffix);
52 
53 private:
54  int _minValue;
55  int _maxValue;
56  int _stepValue;
57  int _value;
58  int _printLen;
59  String _suffix;
60 
61  void printValue();
62 };
63 
64 #endif
Field that manages the input of an integer value.
Definition: IntField.h:28
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 setValue(int value)
Sets the current value of this field.
Definition: IntField.cpp:198
int minValue() const
Returns the minimum value for the input field.
Definition: IntField.h:38
const String & label() const
Returns the label to display in the first line of this field.
Definition: Field.h:41
int dispatch(int event)
Dispatches event via this field.
Definition: IntField.cpp:114
void setMinValue(int value)
Sets the minimum value for the input field.
Definition: IntField.h:39
const String & suffix() const
Returns the suffix string to be displayed after the field's value.
Definition: IntField.h:50
int stepValue() const
Returns the step value to use when increasing or decreasing the value() due to Up and Down button pre...
Definition: IntField.h:44
int value() const
Returns the current value of this field.
Definition: IntField.h:47
void setMaxValue(int value)
Sets the maximum value for the input field.
Definition: IntField.h:42
IntField(const String &label)
Constructs a new integer field with a specific label.
Definition: IntField.cpp:71
int maxValue() const
Returns the maximum value for the input field.
Definition: IntField.h:41
void setStepValue(int value)
Sets the step value value to use when increasing or decreasing the value() due to Up and Down button ...
Definition: IntField.h:45
void setSuffix(const String &suffix)
Sets the suffix string to be displayed after the field's value.
Definition: IntField.cpp:231
void enterField(bool reverse)
Enters the field due to form navigation.
Definition: IntField.cpp:126