summaryrefslogtreecommitdiff
path: root/support/dktools/DkClockView.h
blob: 4f503e0ca0b715c4377226f24afc959044dee81b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
/*
	WARNING: This file was generated by dkct.
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: DkClockView.cpt
*/

/*
Copyright (C) 2013-2017, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

/**	@file DkClockView.h Header file for the DkClockView module.
*/

#ifndef DKCLOCKVIEW_H_INCLUDED
/** Avoid multiple inclusions. */
#define DKCLOCKVIEW_H_INCLUDED 1


#line 10 "DkClockView.cpt"

class DkClockView : public DkWxBufferedControl
{
  private:

    DECLARE_DYNAMIC_CLASS(DkClockView)

    /**	Event table.
    */
    DECLARE_EVENT_TABLE()

  protected:

    /**	Black colour for normal mode.
    */
    wxColour		 cBlack;

    /**	Red colour for alert mode.
    */
    wxColour		 cRed;

    /**	Clock data to show.
    */
    DkClockData		*cld;

    /**	Widget type name.
    */
    static wxChar const	 windowtypename[];

    /**	Flag: Use red colour instead of black.
    */
    bool		 bUseRed;

  public:

    /**	Default constructor.
    */
    DkClockView();

    /**	Constructor.
    	@param		wParent		Parent window.
	@param		wid		Window ID.
	@param		clockData	Clock data to show.
	@param		pos		Window position.
	@param		size		Window size.
	@param		style		Window style.
    */
    DkClockView(
      wxWindow		*wParent,
      wxWindowID	 wid,
      DkClockData	*clockData,
      const wxPoint &	 pos = wxDefaultPosition,
      const wxSize  &	 size = wxDefaultSize,
      long		 style = 0L
    );

    /**	Create window after using the default constructor.
    	@param		wParent		Parent window.
	@param		wid		Window ID.
	@param		clockData	Clock data to show.
	@param		pos		Window position.
	@param		size		Window size.
	@param		style		Window style.
	@return		true on success, false on error.
    */
    bool
    Create(
      wxWindow		*wParent,
      wxWindowID	 wid,
      DkClockData	*clockData,
      const wxPoint &	 pos = wxDefaultPosition,
      const wxSize  &	 size = wxDefaultSize,
      long		 style = 0L
    );

    /**	Draw operation.
    	@param	pdc		Device context to draw to.
	@param	event		Event to process.
	@param	buffered	Flag: Drawing into bitmap buffer.
	@param	clWidth		Client area width.
	@param	clHeight	Client area height.
    */
    void
    PaintOperation(
      wxDC &		pdc,
      wxPaintEvent &	event,
      bool		buffered,
      int		clWidth,
      int		clHeight
    );

    /**	Handler for mouse click.
    	@param	event	Event to process.
    */
    void
    OnLeftDown(wxMouseEvent & event);

    /**	Get red component of normal clock colour.
    	@return	Red value.
    */
    int
    getNormalRed(void) const;

    /**	Get green component of normal clock colour.
    	@return	Green value.
    */
    int
    getNormalGreen(void) const;

    /**	Get blue component of normal clock colour.
    	@return	Blue value.
    */
    int
    getNormalBlue(void) const;

    /**	Get red component of alert clock colour.
    	@return	Red value.
    */
    int
    getAlertRed(void) const;

    /**	Get green component of alert clock colour.
    	@return	Green value.
    */
    int
    getAlertGreen(void) const;

    /**	Get blue component of alert clock colour.
    	@return	Blue value.
    */
    int
    getAlertBlue(void) const;

    /**	Set normal colour.
    	@param	r	Red value.
	@param	g	Green value.
	@param	b	Blue value.
    */
    void
    setNormal(int r, int g, int b);

    /**	Set alert colour.
    	@param	r	Red value.
	@param	g	Green value.
	@param	b	Blue value.
    */
    void
    setAlert(int r, int g, int b);
};


#endif