]> git.saurik.com Git - wxWidgets.git/blame - include/wx/generic/calctrl.h
Fixed to work with the new wxMacControl system.
[wxWidgets.git] / include / wx / generic / calctrl.h
CommitLineData
2ef31e80
VZ
1///////////////////////////////////////////////////////////////////////////////
2// Name: generic/calctrl.h
3// Purpose: generic implementation of date-picker control
4// Author: Vadim Zeitlin
5// Modified by:
6// Created: 29.12.99
7// RCS-ID: $Id$
8// Copyright: (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
65571936 9// Licence: wxWindows licence
2ef31e80
VZ
10///////////////////////////////////////////////////////////////////////////////
11
12028905 12#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
2ef31e80
VZ
13 #pragma interface "calctrl.h"
14#endif
15
16#ifndef _WX_GENERIC_CALCTRL_H
17#define _WX_GENERIC_CALCTRL_H
18
19#include "wx/control.h" // the base class
49a47c50 20#include "wx/dcclient.h" // for wxPaintDC
4f6aed9c
VZ
21
22class WXDLLEXPORT wxComboBox;
bc385ba9 23class WXDLLEXPORT wxStaticText;
f0d5e7a2 24class WXDLLEXPORT wxSpinCtrl;
2ef31e80
VZ
25
26#define wxCalendarNameStr _T("CalendarCtrl")
27
28// ----------------------------------------------------------------------------
29// wxCalendarCtrl: a control allowing the user to pick a date interactively
30// ----------------------------------------------------------------------------
31
12f190b0 32class WXDLLIMPEXP_ADV wxCalendarCtrl : public wxControl
2ef31e80 33{
0185cd09
VZ
34friend class wxMonthComboBox;
35friend class wxYearSpinCtrl;
36
2ef31e80
VZ
37public:
38 // construction
39 wxCalendarCtrl() { Init(); }
40 wxCalendarCtrl(wxWindow *parent,
41 wxWindowID id,
42 const wxDateTime& date = wxDefaultDateTime,
43 const wxPoint& pos = wxDefaultPosition,
44 const wxSize& size = wxDefaultSize,
4965c3d7 45 long style = wxCAL_SHOW_HOLIDAYS | wxWANTS_CHARS,
2b5f62a0 46 const wxString& name = wxCalendarNameStr);
2ef31e80
VZ
47
48 bool Create(wxWindow *parent,
49 wxWindowID id,
50 const wxDateTime& date = wxDefaultDateTime,
51 const wxPoint& pos = wxDefaultPosition,
52 const wxSize& size = wxDefaultSize,
4965c3d7 53 long style = wxCAL_SHOW_HOLIDAYS | wxWANTS_CHARS,
2ef31e80
VZ
54 const wxString& name = wxCalendarNameStr);
55
882a8f40
VZ
56 virtual ~wxCalendarCtrl();
57
b70462f4
MB
58 virtual bool Destroy();
59
2ef31e80 60 // set/get the current date
4f6aed9c
VZ
61 // ------------------------
62
37df1f33 63 bool SetDate(const wxDateTime& date); // we need to be able to control if the event should be sent in SetDateAndNotify(...)
2ef31e80
VZ
64 const wxDateTime& GetDate() const { return m_date; }
65
37df1f33
VZ
66 // set/get the range in which selection can occur
67 // ---------------------------------------------
68
69 bool SetLowerDateLimit(const wxDateTime& date = wxDefaultDateTime);
70 const wxDateTime& GetLowerDateLimit() const { return m_lowdate; }
71 bool SetUpperDateLimit(const wxDateTime& date = wxDefaultDateTime);
72 const wxDateTime& GetUpperDateLimit() const { return m_highdate; }
73
74 bool SetDateRange(const wxDateTime& lowerdate = wxDefaultDateTime, const wxDateTime& upperdate = wxDefaultDateTime);
f0d5e7a2 75
bc385ba9
VZ
76 // calendar mode
77 // -------------
78
79 // some calendar styles can't be changed after the control creation by
80 // just using SetWindowStyle() and Refresh() and the functions below
81 // should be used instead for them
82
83 // corresponds to wxCAL_NO_YEAR_CHANGE bit
ca65c044 84 void EnableYearChange(bool enable = true);
bc385ba9
VZ
85
86 // corresponds to wxCAL_NO_MONTH_CHANGE bit
ca65c044 87 void EnableMonthChange(bool enable = true);
bc385ba9
VZ
88
89 // corresponds to wxCAL_SHOW_HOLIDAYS bit
ca65c044 90 void EnableHolidayDisplay(bool display = true);
bc385ba9 91
4f6aed9c
VZ
92 // customization
93 // -------------
94
95 // header colours are used for painting the weekdays at the top
96 void SetHeaderColours(const wxColour& colFg, const wxColour& colBg)
97 {
98 m_colHeaderFg = colFg;
99 m_colHeaderBg = colBg;
100 }
101
102 const wxColour& GetHeaderColourFg() const { return m_colHeaderFg; }
103 const wxColour& GetHeaderColourBg() const { return m_colHeaderBg; }
104
105 // highlight colour is used for the currently selected date
106 void SetHighlightColours(const wxColour& colFg, const wxColour& colBg)
107 {
108 m_colHighlightFg = colFg;
109 m_colHighlightBg = colBg;
110 }
111
112 const wxColour& GetHighlightColourFg() const { return m_colHighlightFg; }
113 const wxColour& GetHighlightColourBg() const { return m_colHighlightBg; }
114
115 // holiday colour is used for the holidays (if style & wxCAL_SHOW_HOLIDAYS)
116 void SetHolidayColours(const wxColour& colFg, const wxColour& colBg)
117 {
118 m_colHolidayFg = colFg;
119 m_colHolidayBg = colBg;
120 }
121
122 const wxColour& GetHolidayColourFg() const { return m_colHolidayFg; }
123 const wxColour& GetHolidayColourBg() const { return m_colHolidayBg; }
124
4f6aed9c
VZ
125 // an item without custom attributes is drawn with the default colours and
126 // font and without border, setting custom attributes allows to modify this
127 //
128 // the day parameter should be in 1..31 range, for days 29, 30, 31 the
129 // corresponding attribute is just unused if there is no such day in the
130 // current month
131
132 wxCalendarDateAttr *GetAttr(size_t day) const
133 {
134 wxCHECK_MSG( day > 0 && day < 32, NULL, _T("invalid day") );
135
136 return m_attrs[day - 1];
137 }
138
139 void SetAttr(size_t day, wxCalendarDateAttr *attr)
140 {
141 wxCHECK_RET( day > 0 && day < 32, _T("invalid day") );
142
143 delete m_attrs[day - 1];
144 m_attrs[day - 1] = attr;
145 }
146
147 void SetHoliday(size_t day);
148
149 void ResetAttr(size_t day) { SetAttr(day, (wxCalendarDateAttr *)NULL); }
150
0185cd09
VZ
151 // returns one of wxCAL_HITTEST_XXX constants and fills either date or wd
152 // with the corresponding value (none for NOWHERE, the date for DAY and wd
153 // for HEADER)
154 wxCalendarHitTestResult HitTest(const wxPoint& pos,
155 wxDateTime *date = NULL,
156 wxDateTime::WeekDay *wd = NULL);
2ef31e80 157
882a8f40
VZ
158 // implementation only from now on
159 // -------------------------------
160
161 // forward these functions to all subcontrols
ca65c044
WS
162 virtual bool Enable(bool enable = true);
163 virtual bool Show(bool show = true);
882a8f40 164
0185cd09
VZ
165private:
166 // common part of all ctors
167 void Init();
168
882a8f40
VZ
169 // event handlers
170 void OnPaint(wxPaintEvent& event);
171 void OnClick(wxMouseEvent& event);
0185cd09 172 void OnDClick(wxMouseEvent& event);
882a8f40
VZ
173 void OnChar(wxKeyEvent& event);
174 void OnMonthChange(wxCommandEvent& event);
f0d5e7a2 175 void OnYearChange(wxCommandEvent& event);
882a8f40 176
2ef31e80
VZ
177 // override some base class virtuals
178 virtual wxSize DoGetBestSize() const;
882a8f40
VZ
179 virtual void DoGetPosition(int *x, int *y) const;
180 virtual void DoGetSize(int *width, int *height) const;
2ef31e80
VZ
181 virtual void DoSetSize(int x, int y, int width, int height, int sizeFlags);
182 virtual void DoMoveWindow(int x, int y, int width, int height);
183
9d9b7755
VZ
184 // (re)calc m_widthCol and m_heightRow
185 void RecalcGeometry();
186
9d9b7755
VZ
187 // set the date and send the notification
188 void SetDateAndNotify(const wxDateTime& date);
189
190 // get the week (row, in range 1..6) for the given date
191 size_t GetWeek(const wxDateTime& date) const;
192
2ef31e80
VZ
193 // get the date from which we start drawing days
194 wxDateTime GetStartDate() const;
195
196 // is this date shown?
197 bool IsDateShown(const wxDateTime& date) const;
198
37df1f33
VZ
199 // is this date in the given range?
200 bool IsDateInRange(const wxDateTime& date) const;
f0d5e7a2 201
37df1f33
VZ
202 // range helpers
203 bool ChangeYear(wxDateTime* target) const;
204 bool ChangeMonth(wxDateTime* target) const;
205
9d9b7755
VZ
206 // redraw the given date
207 void RefreshDate(const wxDateTime& date);
208
209 // change the date inside the same month/year
210 void ChangeDay(const wxDateTime& date);
211
4f6aed9c
VZ
212 // set the attributes for the holidays if needed
213 void SetHolidayAttrs();
214
215 // reset all holidays
216 void ResetHolidayAttrs();
217
218 // generate the given calendar event(s)
219 void GenerateEvent(wxEventType type)
220 {
221 wxCalendarEvent event(this, type);
222 (void)GetEventHandler()->ProcessEvent(event);
223 }
224
225 void GenerateEvents(wxEventType type1, wxEventType type2)
226 {
227 GenerateEvent(type1);
228 GenerateEvent(type2);
229 }
9d9b7755 230
bc385ba9
VZ
231 // do we allow changing the month/year?
232 bool AllowMonthChange() const
233 {
234 return (GetWindowStyle() & wxCAL_NO_MONTH_CHANGE)
235 != wxCAL_NO_MONTH_CHANGE;
236 }
237 bool AllowYearChange() const
238 {
239 return !(GetWindowStyle() & wxCAL_NO_YEAR_CHANGE);
240 }
241
242 // show the correct controls
243 void ShowCurrentControls();
244
b6fa290b 245public:
bc385ba9
VZ
246 // get the currently shown control for month/year
247 wxControl *GetMonthControl() const;
248 wxControl *GetYearControl() const;
249
b6fa290b 250private:
37df1f33 251 // OnPaint helper-methods
f0d5e7a2 252
37df1f33
VZ
253 // Highlight the [fromdate : todate] range using pen and brush
254 void HighlightRange(wxPaintDC* dc, const wxDateTime& fromdate, const wxDateTime& todate, wxPen* pen, wxBrush* brush);
f0d5e7a2 255
37df1f33
VZ
256 // Get the "coordinates" for the date relative to the month currently displayed.
257 // using (day, week): upper left coord is (1, 1), lower right coord is (7, 6)
258 // if the date isn't visible (-1, -1) is put in (day, week) and false is returned
259 bool GetDateCoord(const wxDateTime& date, int *day, int *week) const;
260
605dfd91
JS
261 // Set the flag for SetDate(): otherwise it would overwrite the year
262 // typed in by the user
ca65c044 263 void SetUserChangedYear() { m_userChangedYear = true; }
605dfd91 264
2ef31e80 265 // the subcontrols
bc385ba9 266 wxStaticText *m_staticMonth;
2ef31e80 267 wxComboBox *m_comboMonth;
bc385ba9
VZ
268
269 wxStaticText *m_staticYear;
2ef31e80
VZ
270 wxSpinCtrl *m_spinYear;
271
4f6aed9c 272 // the current selection
2ef31e80
VZ
273 wxDateTime m_date;
274
37df1f33
VZ
275 // the date-range
276 wxDateTime m_lowdate;
277 wxDateTime m_highdate;
278
4f6aed9c
VZ
279 // default attributes
280 wxColour m_colHighlightFg,
281 m_colHighlightBg,
282 m_colHolidayFg,
283 m_colHolidayBg,
284 m_colHeaderFg,
285 m_colHeaderBg;
286
287 // the attributes for each of the month days
288 wxCalendarDateAttr *m_attrs[31];
289
2ef31e80
VZ
290 // the width and height of one column/row in the calendar
291 wxCoord m_widthCol,
37df1f33
VZ
292 m_heightRow,
293 m_rowOffset;
294
295 wxRect m_leftArrowRect,
f0d5e7a2 296 m_rightArrowRect;
2ef31e80 297
9d9b7755
VZ
298 // the week day names
299 wxString m_weekdays[7];
300
ca65c044 301 // true if SetDate() is being called as the result of changing the year in
f0d5e7a2
VZ
302 // the year control
303 bool m_userChangedYear;
304
2ef31e80
VZ
305 DECLARE_DYNAMIC_CLASS(wxCalendarCtrl)
306 DECLARE_EVENT_TABLE()
22f3361e 307 DECLARE_NO_COPY_CLASS(wxCalendarCtrl)
2ef31e80
VZ
308};
309
310#endif // _WX_GENERIC_CALCTRL_H