ArduinoLibs
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
TimeField.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 TimeField_h
24 #define TimeField_h
25 
26 #include "Field.h"
27 
28 #define TIMEFIELD_READ_ONLY true
29 #define TIMEFIELD_READ_WRITE false
30 
31 class TimeField : public Field {
32 public:
33  explicit TimeField(const String &label);
34  TimeField(Form &form, const String &label, int maxHours, bool readOnly);
35 
36  int dispatch(int event);
37 
38  void enterField(bool reverse);
39  void exitField();
40 
41  unsigned long value() const { return _value; }
42  void setValue(unsigned long value);
43 
44  int maxHours() const { return _maxHours; }
45  void setMaxHours(int maxHours) { _maxHours = maxHours; }
46 
47  bool readOnly() const { return _readOnly; }
48  void setReadOnly(bool value);
49 
50 private:
51  unsigned long _value;
52  int _maxHours;
53  int _printLen;
54  bool _readOnly;
55  uint8_t editField;
56 
57  void printTime();
58  int printField(unsigned long value);
59 };
60 
61 #endif
void setMaxHours(int maxHours)
Sets the maximum number of hours before the field wraps around to maxHours.
Definition: TimeField.h:45
unsigned long value() const
Returns the current value of this time field, in seconds.
Definition: TimeField.h:41
void setReadOnly(bool value)
Sets the read-only state of this field to value.
Definition: TimeField.cpp:268
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
int maxHours() const
Returns the maximum number of hours before the field wraps around.
Definition: TimeField.h:44
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: TimeField.cpp:115
Field that manages the display and editing of a time value.
Definition: TimeField.h:31
bool readOnly() const
Returns TIMEFIELD_READ_ONLY (true) or TIMEFIELD_READ_WRITE (false).
Definition: TimeField.h:47
void enterField(bool reverse)
Enters the field due to form navigation.
Definition: TimeField.cpp:193
TimeField(const String &label)
Constructs a new time field with a specific label.
Definition: TimeField.cpp:82
void exitField()
Exits the field due to form navigation.
Definition: TimeField.cpp:205
void setValue(unsigned long value)
Sets the value of this time field, in seconds.
Definition: TimeField.cpp:227