]> git.saurik.com Git - wxWidgets.git/blob - include/wx/generic/calctrl.h
added wxBitmapToHICON/CURSOR helper functions
[wxWidgets.git] / include / wx / generic / calctrl.h
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>
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
11
12 #if defined(__GNUG__) && !defined(__APPLE__)
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
20 #include "wx/dcclient.h" // for wxPaintDC
21
22 class WXDLLEXPORT wxComboBox;
23 class WXDLLEXPORT wxStaticText;
24 class WXDLLEXPORT wxSpinCtrl;
25
26 #define wxCalendarNameStr _T("CalendarCtrl")
27
28 // ----------------------------------------------------------------------------
29 // wxCalendarCtrl: a control allowing the user to pick a date interactively
30 // ----------------------------------------------------------------------------
31
32 class WXDLLEXPORT wxCalendarCtrl : public wxControl
33 {
34 friend class wxMonthComboBox;
35 friend class wxYearSpinCtrl;
36
37 public:
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,
45 long style = wxCAL_SHOW_HOLIDAYS | wxWANTS_CHARS,
46 const wxString& name = wxCalendarNameStr);
47
48 bool Create(wxWindow *parent,
49 wxWindowID id,
50 const wxDateTime& date = wxDefaultDateTime,
51 const wxPoint& pos = wxDefaultPosition,
52 const wxSize& size = wxDefaultSize,
53 long style = wxCAL_SHOW_HOLIDAYS | wxWANTS_CHARS,
54 const wxString& name = wxCalendarNameStr);
55
56 virtual ~wxCalendarCtrl();
57
58 virtual bool Destroy();
59
60 // set/get the current date
61 // ------------------------
62
63 bool SetDate(const wxDateTime& date); // we need to be able to control if the event should be sent in SetDateAndNotify(...)
64 const wxDateTime& GetDate() const { return m_date; }
65
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);
75
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
84 void EnableYearChange(bool enable = TRUE);
85
86 // corresponds to wxCAL_NO_MONTH_CHANGE bit
87 void EnableMonthChange(bool enable = TRUE);
88
89 // corresponds to wxCAL_SHOW_HOLIDAYS bit
90 void EnableHolidayDisplay(bool display = TRUE);
91
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
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
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);
157
158 // implementation only from now on
159 // -------------------------------
160
161 // forward these functions to all subcontrols
162 virtual bool Enable(bool enable = TRUE);
163 virtual bool Show(bool show = TRUE);
164
165 private:
166 // common part of all ctors
167 void Init();
168
169 // event handlers
170 void OnPaint(wxPaintEvent& event);
171 void OnClick(wxMouseEvent& event);
172 void OnDClick(wxMouseEvent& event);
173 void OnChar(wxKeyEvent& event);
174 void OnMonthChange(wxCommandEvent& event);
175 void OnYearChange(wxCommandEvent& event);
176
177 // override some base class virtuals
178 virtual wxSize DoGetBestSize() const;
179 virtual void DoGetPosition(int *x, int *y) const;
180 virtual void DoGetSize(int *width, int *height) const;
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
184 // (re)calc m_widthCol and m_heightRow
185 void RecalcGeometry();
186
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
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
199 // is this date in the given range?
200 bool IsDateInRange(const wxDateTime& date) const;
201
202 // range helpers
203 bool ChangeYear(wxDateTime* target) const;
204 bool ChangeMonth(wxDateTime* target) const;
205
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
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 }
230
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
245 // get the currently shown control for month/year
246 wxControl *GetMonthControl() const;
247 wxControl *GetYearControl() const;
248
249 // OnPaint helper-methods
250
251 // Highlight the [fromdate : todate] range using pen and brush
252 void HighlightRange(wxPaintDC* dc, const wxDateTime& fromdate, const wxDateTime& todate, wxPen* pen, wxBrush* brush);
253
254 // Get the "coordinates" for the date relative to the month currently displayed.
255 // using (day, week): upper left coord is (1, 1), lower right coord is (7, 6)
256 // if the date isn't visible (-1, -1) is put in (day, week) and false is returned
257 bool GetDateCoord(const wxDateTime& date, int *day, int *week) const;
258
259 // the subcontrols
260 wxStaticText *m_staticMonth;
261 wxComboBox *m_comboMonth;
262
263 wxStaticText *m_staticYear;
264 wxSpinCtrl *m_spinYear;
265
266 // the current selection
267 wxDateTime m_date;
268
269 // the date-range
270 wxDateTime m_lowdate;
271 wxDateTime m_highdate;
272
273 // default attributes
274 wxColour m_colHighlightFg,
275 m_colHighlightBg,
276 m_colHolidayFg,
277 m_colHolidayBg,
278 m_colHeaderFg,
279 m_colHeaderBg;
280
281 // the attributes for each of the month days
282 wxCalendarDateAttr *m_attrs[31];
283
284 // the width and height of one column/row in the calendar
285 wxCoord m_widthCol,
286 m_heightRow,
287 m_rowOffset;
288
289 wxRect m_leftArrowRect,
290 m_rightArrowRect;
291
292 // the week day names
293 wxString m_weekdays[7];
294
295 // TRUE if SetDate() is being called as the result of changing the year in
296 // the year control
297 bool m_userChangedYear;
298
299 DECLARE_DYNAMIC_CLASS(wxCalendarCtrl)
300 DECLARE_EVENT_TABLE()
301 DECLARE_NO_COPY_CLASS(wxCalendarCtrl)
302 };
303
304 #endif // _WX_GENERIC_CALCTRL_H