ArduinoLibs
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ListField.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 ListField_h
24 #define ListField_h
25 
26 #include "Field.h"
27 #include <avr/pgmspace.h>
28 
29 typedef PGM_P ListItem;
30 typedef const PROGMEM ListItem *ListItems;
31 
32 class ListField : public Field {
33 public:
34  explicit ListField(const String &label);
35  ListField(Form &form, const String &label, ListItems items, int value = 0);
36 
37  int dispatch(int event);
38 
39  void enterField(bool reverse);
40 
41  ListItems items() const { return _items; }
42  void setItems(ListItems items);
43 
44  int value() const { return _value; }
45  void setValue(int value);
46 
47 private:
48  ListItems _items;
49  int _itemCount;
50  int _value;
51  int _printLen;
52 
53  void printValue();
54 };
55 
56 #endif
ListField(const String &label)
Constructs a new list field with a specific label.
Definition: ListField.cpp:64
Manages a single data input/output field within a Form.
Definition: Field.h:28
int value() const
Returns the value of this list; i.e. the index within items() of the selected item.
Definition: ListField.h:44
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 setItems(ListItems items)
Sets the array of items for this list.
Definition: ListField.cpp:141
const String & label() const
Returns the label to display in the first line of this field.
Definition: Field.h:41
ListItems items() const
Returns the array of items in this list.
Definition: ListField.h:41
void enterField(bool reverse)
Enters the field due to form navigation.
Definition: ListField.cpp:105
void setValue(int value)
Sets the value of this list; i.e. the index within items() of the selected item.
Definition: ListField.cpp:178
Field that manages selection from a static list of items.
Definition: ListField.h:32
int dispatch(int event)
Dispatches event via this field.
Definition: ListField.cpp:87