/elec/propeller-clock

To get this branch, use:
bzr branch http://bzr.ed.am/elec/propeller-clock

« back to all changes in this revision

Viewing changes to src/modes/settings_major_mode.h

  • Committer: Tim Marston
  • Date: 2012-03-10 13:04:29 UTC
  • Revision ID: tim@ed.am-20120310130429-310w5ejo968mc6mo
cleaned-up notes

Show diffs side-by-side

added added

removed removed

src/modes/settings_major_mode.h
1
 
/*
2
 
 * settings_major_mode.h
3
 
 *
4
 
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
5
 
 *
6
 
 * This file is part of propeller-clock (hereafter referred to as "this
7
 
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
8
 
 * information.
9
 
 *
10
 
 * This program is free software: you can redistribute it and/or modify
11
 
 * it under the terms of the GNU Lesser General Public License as published
12
 
 * by the Free Software Foundation, either version 3 of the License, or
13
 
 * (at your option) any later version.
14
 
 *
15
 
 * This program is distributed in the hope that it will be useful,
16
 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17
 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
 
 * GNU Lesser General Public License for more details.
19
 
 *
20
 
 * You should have received a copy of the GNU Lesser General Public License
21
 
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
 
 */
23
 
#ifndef _SETTINGS_MAJOR_MODE_H_
24
 
#define _SETTINGS_MAJOR_MODE_H_
25
 
 
26
 
 
27
 
#include "major_mode.h"
28
 
#include "button.h"
29
 
 
30
 
 
31
 
class SettingsMajorMode : public MajorMode
32
 
{
33
 
public:
34
 
 
35
 
        /**
36
 
         * Constructor which provides the button.
37
 
         */
38
 
        SettingsMajorMode( Button &button );
39
 
 
40
 
        /**
41
 
         * Called once per segment to draw a column of LEDs.
42
 
         *
43
 
         * @param segment the segment number to draw
44
 
         */
45
 
        void draw( int segment );
46
 
 
47
 
        /**
48
 
         * Called at the start of a "frame", before any segments are drawn.
49
 
         */
50
 
        void draw_reset();
51
 
 
52
 
        /**
53
 
         * Called when the mode is becoming active.
54
 
         */
55
 
        void activate();
56
 
 
57
 
        /**
58
 
         * Called when the mode is becoming inactive.
59
 
         */
60
 
        void deactivate();
61
 
 
62
 
        /**
63
 
         * Called when the button has been pressed.
64
 
         */
65
 
        void press();
66
 
 
67
 
        /**
68
 
         * Called when the button has been long-pressed.
69
 
         */
70
 
        void long_press();
71
 
 
72
 
private:
73
 
 
74
 
        /**
75
 
         * Set up message buffers.
76
 
         */
77
 
        void reset_messages();
78
 
 
79
 
        /** item we're setting */
80
 
        int _item;
81
 
        
82
 
        /** part of item that we're setting */
83
 
        int _part;
84
 
 
85
 
        /** is there an interim press and does it need actioning? */
86
 
        char _press_state;
87
 
 
88
 
        /** the button */
89
 
        Button &_button;
90
 
};
91
 
 
92
 
 
93
 
#endif //_SETTINGS_MAJOR_MODE_H_