include/wx/generic/calctrlg.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        generic/calctrlg.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 #ifndef _WX_GENERIC_CALCTRLG_H
  13 #define _WX_GENERIC_CALCTRLG_H
  14
  15 #include "wx/control.h"         // the base class
  16 #include "wx/dcclient.h"        // for wxPaintDC
  17
  18 class WXDLLIMPEXP_FWD_CORE wxComboBox;
  19 class WXDLLIMPEXP_FWD_CORE wxStaticText;
  20 class WXDLLIMPEXP_FWD_CORE wxSpinCtrl;
  21
  22 // ----------------------------------------------------------------------------
  23 // wxGenericCalendarCtrl
  24 // ----------------------------------------------------------------------------
  25
  26 class WXDLLIMPEXP_ADV wxGenericCalendarCtrl : public wxCalendarCtrlBase
  27 {
  28 public:
  29     // construction
  30     wxGenericCalendarCtrl() { Init(); }
  31     wxGenericCalendarCtrl(wxWindow *parent,
  32                           wxWindowID id,
  33                           const wxDateTime& date = wxDefaultDateTime,
  34                           const wxPoint& pos = wxDefaultPosition,
  35                           const wxSize& size = wxDefaultSize,
  36                           long style = wxCAL_SHOW_HOLIDAYS,
  37                           const wxString& name = wxCalendarNameStr);
  38
  39     bool Create(wxWindow *parent,
  40                 wxWindowID id,
  41                 const wxDateTime& date = wxDefaultDateTime,
  42                 const wxPoint& pos = wxDefaultPosition,
  43                 const wxSize& size = wxDefaultSize,
  44                 long style = wxCAL_SHOW_HOLIDAYS,
  45                 const wxString& name = wxCalendarNameStr);
  46
  47     virtual ~wxGenericCalendarCtrl();
  48
  49     virtual bool Destroy();
  50
  51     // set/get the current date
  52     // ------------------------
  53
  54     virtual bool SetDate(const wxDateTime& date);
  55     virtual wxDateTime GetDate() const { return m_date; }
  56
  57
  58     // set/get the range in which selection can occur
  59     // ---------------------------------------------
  60
  61     virtual bool SetDateRange(const wxDateTime& lowerdate = wxDefaultDateTime,
  62                               const wxDateTime& upperdate = wxDefaultDateTime);
  63
  64     virtual bool GetDateRange(wxDateTime *lowerdate, wxDateTime *upperdate) const;
  65
  66     // these functions are for generic version only, don't use them but use the
  67     // Set/GetDateRange() above instead
  68     bool SetLowerDateLimit(const wxDateTime& date = wxDefaultDateTime);
  69     const wxDateTime& GetLowerDateLimit() const { return m_lowdate; }
  70     bool SetUpperDateLimit(const wxDateTime& date = wxDefaultDateTime);
  71     const wxDateTime& GetUpperDateLimit() const { return m_highdate; }
  72
  73
  74     // calendar mode
  75     // -------------
  76
  77     // some calendar styles can't be changed after the control creation by
  78     // just using SetWindowStyle() and Refresh() and the functions below
  79     // should be used instead for them
  80
  81     // corresponds to wxCAL_NO_MONTH_CHANGE bit
  82     virtual bool EnableMonthChange(bool enable = true);
  83
  84     // corresponds to wxCAL_NO_YEAR_CHANGE bit, deprecated, generic only
  85     void EnableYearChange(bool enable = true);
  86
  87     // corresponds to wxCAL_SHOW_HOLIDAYS bit, generic only
  88     virtual void EnableHolidayDisplay(bool display = true);
  89
  90
  91     // customization
  92     // -------------
  93
  94     virtual void Mark(size_t day, bool mark);
  95
  96     // all other functions in this section are for generic version only
  97
  98     // header colours are used for painting the weekdays at the top
  99     virtual void SetHeaderColours(const wxColour& colFg, const wxColour& colBg)
 100     {
 101         m_colHeaderFg = colFg;
 102         m_colHeaderBg = colBg;
 103     }
 104
 105     virtual const wxColour& GetHeaderColourFg() const { return m_colHeaderFg; }
 106     virtual const wxColour& GetHeaderColourBg() const { return m_colHeaderBg; }
 107
 108     // highlight colour is used for the currently selected date
 109     virtual void SetHighlightColours(const wxColour& colFg, const wxColour& colBg)
 110     {
 111         m_colHighlightFg = colFg;
 112         m_colHighlightBg = colBg;
 113     }
 114
 115     virtual const wxColour& GetHighlightColourFg() const { return m_colHighlightFg; }
 116     virtual const wxColour& GetHighlightColourBg() const { return m_colHighlightBg; }
 117
 118     // holiday colour is used for the holidays (if style & wxCAL_SHOW_HOLIDAYS)
 119     virtual void SetHolidayColours(const wxColour& colFg, const wxColour& colBg)
 120     {
 121         m_colHolidayFg = colFg;
 122         m_colHolidayBg = colBg;
 123     }
 124
 125     virtual const wxColour& GetHolidayColourFg() const { return m_colHolidayFg; }
 126     virtual const wxColour& GetHolidayColourBg() const { return m_colHolidayBg; }
 127
 128     virtual wxCalendarDateAttr *GetAttr(size_t day) const
 129     {
 130         wxCHECK_MSG( day > 0 && day < 32, NULL, _T("invalid day") );
 131
 132         return m_attrs[day - 1];
 133     }
 134
 135     virtual void SetAttr(size_t day, wxCalendarDateAttr *attr)
 136     {
 137         wxCHECK_RET( day > 0 && day < 32, _T("invalid day") );
 138
 139         delete m_attrs[day - 1];
 140         m_attrs[day - 1] = attr;
 141     }
 142
 143     virtual void ResetAttr(size_t day) { SetAttr(day, NULL); }
 144
 145     virtual void SetHoliday(size_t day);
 146
 147     virtual wxCalendarHitTestResult HitTest(const wxPoint& pos,
 148                                             wxDateTime *date = NULL,
 149                                             wxDateTime::WeekDay *wd = NULL);
 150
 151     // implementation only from now on
 152     // -------------------------------
 153
 154     // forward these functions to all subcontrols
 155     virtual bool Enable(bool enable = true);
 156     virtual bool Show(bool show = true);
 157
 158     virtual void SetWindowStyleFlag(long style);
 159
 160     virtual wxVisualAttributes GetDefaultAttributes() const
 161         { return GetClassDefaultAttributes(GetWindowVariant()); }
 162
 163     static wxVisualAttributes
 164     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 165
 166     void OnSysColourChanged(wxSysColourChangedEvent& event);
 167
 168 protected:
 169     // override some base class virtuals
 170     virtual wxSize DoGetBestSize() const;
 171     virtual void DoMoveWindow(int x, int y, int width, int height);
 172     virtual void DoGetSize(int *width, int *height) const;
 173
 174 private:
 175     // common part of all ctors
 176     void Init();
 177
 178     // startup colours and reinitialization after colour changes in system
 179     void InitColours();
 180
 181     // event handlers
 182     void OnPaint(wxPaintEvent& event);
 183     void OnClick(wxMouseEvent& event);
 184     void OnDClick(wxMouseEvent& event);
 185     void OnChar(wxKeyEvent& event);
 186     void OnMonthChange(wxCommandEvent& event);
 187     void OnYearChange(wxCommandEvent& event);
 188     void OnYearTextChange(wxCommandEvent& event);
 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     // deprecated
 225     bool AllowYearChange() const
 226     {
 227         return !(GetWindowStyle() & wxCAL_NO_YEAR_CHANGE);
 228     }
 229
 230     // show the correct controls
 231     void ShowCurrentControls();
 232
 233     // create the month combo and year spin controls
 234     void CreateMonthComboBox();
 235     void CreateYearSpinCtrl();
 236
 237 public:
 238     // get the currently shown control for month/year
 239     wxControl *GetMonthControl() const;
 240     wxControl *GetYearControl() const;
 241
 242 private:
 243     // OnPaint helper-methods
 244
 245     // Highlight the [fromdate : todate] range using pen and brush
 246     void HighlightRange(wxPaintDC* dc, const wxDateTime& fromdate, const wxDateTime& todate, const wxPen* pen, const wxBrush* brush);
 247
 248     // Get the "coordinates" for the date relative to the month currently displayed.
 249     // using (day, week): upper left coord is (1, 1), lower right coord is (7, 6)
 250     // if the date isn't visible (-1, -1) is put in (day, week) and false is returned
 251     bool GetDateCoord(const wxDateTime& date, int *day, int *week) const;
 252
 253     // Set the flag for SetDate(): otherwise it would overwrite the year
 254     // typed in by the user
 255     void SetUserChangedYear() { m_userChangedYear = true; }
 256
 257
 258     // the subcontrols
 259     wxStaticText *m_staticMonth;
 260     wxComboBox *m_comboMonth;
 261
 262     wxStaticText *m_staticYear;
 263     wxSpinCtrl *m_spinYear;
 264
 265     // the current selection
 266     wxDateTime m_date;
 267
 268     // the date-range
 269     wxDateTime m_lowdate;
 270     wxDateTime m_highdate;
 271
 272     // default attributes
 273     wxColour m_colHighlightFg,
 274              m_colHighlightBg,
 275              m_colHolidayFg,
 276              m_colHolidayBg,
 277              m_colHeaderFg,
 278              m_colHeaderBg,
 279              m_colBackground,
 280              m_colSurrounding;
 281
 282     // the attributes for each of the month days
 283     wxCalendarDateAttr *m_attrs[31];
 284
 285     // the width and height of one column/row in the calendar
 286     wxCoord m_widthCol,
 287             m_heightRow,
 288             m_rowOffset;
 289
 290     wxRect m_leftArrowRect,
 291            m_rightArrowRect;
 292
 293     // the week day names
 294     wxString m_weekdays[7];
 295
 296     // true if SetDate() is being called as the result of changing the year in
 297     // the year control
 298     bool m_userChangedYear;
 299
 300     DECLARE_DYNAMIC_CLASS(wxGenericCalendarCtrl)
 301     DECLARE_EVENT_TABLE()
 302     DECLARE_NO_COPY_CLASS(wxGenericCalendarCtrl)
 303 };
 304
 305 #endif // _WX_GENERIC_CALCTRLG_H