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(NO_GCC_PRAGMA)
  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 WXDLLIMPEXP_ADV 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     virtual wxVisualAttributes GetDefaultAttributes() const
 166         { return GetClassDefaultAttributes(GetWindowVariant()); }
 167
 168     static wxVisualAttributes
 169     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 170
 171 private:
 172     // common part of all ctors
 173     void Init();
 174
 175     // event handlers
 176     void OnPaint(wxPaintEvent& event);
 177     void OnClick(wxMouseEvent& event);
 178     void OnDClick(wxMouseEvent& event);
 179     void OnChar(wxKeyEvent& event);
 180     void OnMonthChange(wxCommandEvent& event);
 181     void OnYearChange(wxCommandEvent& event);
 182
 183     // override some base class virtuals
 184     virtual wxSize DoGetBestSize() const;
 185     virtual void DoGetPosition(int *x, int *y) const;
 186     virtual void DoGetSize(int *width, int *height) const;
 187     virtual void DoSetSize(int x, int y, int width, int height, int sizeFlags);
 188     virtual void DoMoveWindow(int x, int y, int width, int height);
 189
 190     // (re)calc m_widthCol and m_heightRow
 191     void RecalcGeometry();
 192
 193     // set the date and send the notification
 194     void SetDateAndNotify(const wxDateTime& date);
 195
 196     // get the week (row, in range 1..6) for the given date
 197     size_t GetWeek(const wxDateTime& date) const;
 198
 199     // get the date from which we start drawing days
 200     wxDateTime GetStartDate() const;
 201
 202     // is this date shown?
 203     bool IsDateShown(const wxDateTime& date) const;
 204
 205     // is this date in the given range?
 206     bool IsDateInRange(const wxDateTime& date) const;
 207
 208     // range helpers
 209     bool ChangeYear(wxDateTime* target) const;
 210     bool ChangeMonth(wxDateTime* target) const;
 211
 212     // redraw the given date
 213     void RefreshDate(const wxDateTime& date);
 214
 215     // change the date inside the same month/year
 216     void ChangeDay(const wxDateTime& date);
 217
 218     // set the attributes for the holidays if needed
 219     void SetHolidayAttrs();
 220
 221     // reset all holidays
 222     void ResetHolidayAttrs();
 223
 224     // generate the given calendar event(s)
 225     void GenerateEvent(wxEventType type)
 226     {
 227         wxCalendarEvent event(this, type);
 228         (void)GetEventHandler()->ProcessEvent(event);
 229     }
 230
 231     void GenerateEvents(wxEventType type1, wxEventType type2)
 232     {
 233         GenerateEvent(type1);
 234         GenerateEvent(type2);
 235     }
 236
 237     // do we allow changing the month/year?
 238     bool AllowMonthChange() const
 239     {
 240         return (GetWindowStyle() & wxCAL_NO_MONTH_CHANGE)
 241                 != wxCAL_NO_MONTH_CHANGE;
 242     }
 243     bool AllowYearChange() const
 244     {
 245         return !(GetWindowStyle() & wxCAL_NO_YEAR_CHANGE);
 246     }
 247
 248     // show the correct controls
 249     void ShowCurrentControls();
 250
 251 public:
 252     // get the currently shown control for month/year
 253     wxControl *GetMonthControl() const;
 254     wxControl *GetYearControl() const;
 255
 256 private:
 257     // OnPaint helper-methods
 258
 259     // Highlight the [fromdate : todate] range using pen and brush
 260     void HighlightRange(wxPaintDC* dc, const wxDateTime& fromdate, const wxDateTime& todate, wxPen* pen, wxBrush* brush);
 261
 262     // Get the "coordinates" for the date relative to the month currently displayed.
 263     // using (day, week): upper left coord is (1, 1), lower right coord is (7, 6)
 264     // if the date isn't visible (-1, -1) is put in (day, week) and false is returned
 265     bool GetDateCoord(const wxDateTime& date, int *day, int *week) const;
 266
 267     // Set the flag for SetDate(): otherwise it would overwrite the year
 268     // typed in by the user
 269     void SetUserChangedYear() { m_userChangedYear = true; }
 270
 271     // the subcontrols
 272     wxStaticText *m_staticMonth;
 273     wxComboBox *m_comboMonth;
 274
 275     wxStaticText *m_staticYear;
 276     wxSpinCtrl *m_spinYear;
 277
 278     // the current selection
 279     wxDateTime m_date;
 280
 281     // the date-range
 282     wxDateTime m_lowdate;
 283     wxDateTime m_highdate;
 284
 285     // default attributes
 286     wxColour m_colHighlightFg,
 287              m_colHighlightBg,
 288              m_colHolidayFg,
 289              m_colHolidayBg,
 290              m_colHeaderFg,
 291              m_colHeaderBg;
 292
 293     // the attributes for each of the month days
 294     wxCalendarDateAttr *m_attrs[31];
 295
 296     // the width and height of one column/row in the calendar
 297     wxCoord m_widthCol,
 298             m_heightRow,
 299             m_rowOffset;
 300
 301     wxRect m_leftArrowRect,
 302            m_rightArrowRect;
 303
 304     // the week day names
 305     wxString m_weekdays[7];
 306
 307     // true if SetDate() is being called as the result of changing the year in
 308     // the year control
 309     bool m_userChangedYear;
 310
 311     DECLARE_DYNAMIC_CLASS(wxCalendarCtrl)
 312     DECLARE_EVENT_TABLE()
 313     DECLARE_NO_COPY_CLASS(wxCalendarCtrl)
 314 };
 315
 316 #endif // _WX_GENERIC_CALCTRL_H