interface/calctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        calctrl.h
   3 // Purpose:     interface of wxCalendarCtrl
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxCalendarEvent
  11     @wxheader{calctrl.h}
  12
  13     The wxCalendarEvent class is used together with wxCalendarCtrl.
  14
  15     @library{wxadv}
  16     @category{events}
  17
  18     @see wxCalendarCtrl
  19 */
  20 class wxCalendarEvent : public wxDateEvent
  21 {
  22 public:
  23     /**
  24         Returns the week day on which the user clicked in
  25         @c EVT_CALENDAR_WEEKDAY_CLICKED handler. It doesn't make sense to call
  26         this function in other handlers.
  27     */
  28     wxDateTime::WeekDay GetWeekDay() const;
  29
  30     /**
  31         Sets the week day carried by the event, normally only used by the
  32         library internally.
  33     */
  34     void SetWeekDay(wxDateTime::WeekDay day);
  35 };
  36
  37
  38
  39 /**
  40     Possible kinds of borders which may be used to decorate a date using
  41     wxCalendarDateAttr.
  42 */
  43 enum wxCalendarDateBorder
  44 {
  45     wxCAL_BORDER_NONE,      ///< No Border (Default)
  46     wxCAL_BORDER_SQUARE,    ///< Rectangular Border
  47     wxCAL_BORDER_ROUND      ///< Round Border
  48 };
  49
  50 /**
  51     @class wxCalendarDateAttr
  52     @wxheader{calctrl.h}
  53
  54     wxCalendarDateAttr is a custom attributes for a calendar date. The objects
  55     of this class are used with wxCalendarCtrl.
  56
  57     @library{wxadv}
  58     @category{misc}
  59
  60     @see wxCalendarCtrl
  61 */
  62 class wxCalendarDateAttr
  63 {
  64 public:
  65     /**
  66         Default constructor.
  67     */
  68     wxCalendarDateAttr();
  69
  70     /**
  71         Constructor for specifying all wxCalendarDateAttr properties.
  72     */
  73     wxCalendarDateAttr(const wxColour& colText,
  74                        const wxColour& colBack = wxNullColour,
  75                        const wxColour& colBorder = wxNullColour,
  76                        const wxFont& font = wxNullFont,
  77                        wxCalendarDateBorder border = wxCAL_BORDER_NONE);
  78
  79     /**
  80         Constructor using default properties except the given border.
  81     */
  82     wxCalendarDateAttr(wxCalendarDateBorder border,
  83                        const wxColour& colBorder = wxNullColour);
  84
  85     /**
  86         Returns the background colour set for the calendar date.
  87     */
  88     const wxColour GetBackgroundColour() const;
  89
  90     /**
  91         Returns the border set for the calendar date.
  92     */
  93     wxCalendarDateBorder GetBorder() const;
  94
  95     /**
  96         Returns the border colour set for the calendar date.
  97     */
  98     const wxColour GetBorderColour() const;
  99
 100     /**
 101         Returns the font set for the calendar date.
 102     */
 103     const wxFont GetFont() const;
 104
 105     /**
 106         Returns the text colour set for the calendar date.
 107     */
 108     const wxColour GetTextColour() const;
 109
 110     /**
 111         Returns @true if a non-default text background colour is set.
 112     */
 113     bool HasBackgroundColour() const;
 114
 115     /**
 116         Returns @true if a non-default (i.e. any) border is set.
 117     */
 118     bool HasBorder() const;
 119
 120     /**
 121         Returns @true if a non-default border colour is set.
 122     */
 123     bool HasBorderColour() const;
 124
 125     /**
 126         Returns @true if a non-default font is set.
 127     */
 128     bool HasFont() const;
 129
 130     /**
 131         Returns @true if a non-default text foreground colour is set.
 132     */
 133     bool HasTextColour() const;
 134
 135     /**
 136         Returns @true if this calendar day is displayed as a holiday.
 137     */
 138     bool IsHoliday() const;
 139
 140     /**
 141         Sets the text background colour to use.
 142     */
 143     void SetBackgroundColour(const wxColour& colBack);
 144
 145     /**
 146         Sets the border to use.
 147     */
 148     void SetBorder(wxCalendarDateBorder border);
 149
 150     /**
 151         Sets the border colour to use.
 152     */
 153     void SetBorderColour(const wxColour& col);
 154
 155     /**
 156         Sets the font to use.
 157     */
 158     void SetFont(const wxFont& font);
 159
 160     /**
 161         If @a holiday is @true, this calendar day will be displayed as a
 162         holiday.
 163     */
 164     void SetHoliday(bool holiday);
 165
 166     /**
 167         Sets the text (foreground) colour to use.
 168     */
 169     void SetTextColour(const wxColour& colText);
 170
 171     /**
 172         Used (internally) by the generic wxCalendarCtrl::Mark().
 173     */
 174     static const wxCalendarDateAttr& GetMark();
 175
 176     /**
 177         Set the attributes that will be used to Mark() days on the generic
 178         wxCalendarCtrl.
 179     */
 180     static void SetMark(wxCalendarDateAttr const& m);
 181 };
 182
 183
 184
 185 /**
 186     Possible return values from wxCalendarCtrl::HitTest().
 187 */
 188 enum wxCalendarHitTestResult
 189 {
 190     wxCAL_HITTEST_NOWHERE,  ///< Hit outside of anything.
 191     wxCAL_HITTEST_HEADER,   ///< Hit on the header (weekdays).
 192     wxCAL_HITTEST_DAY       ///< Hit on a day in the calendar.
 193 };
 194
 195 /**
 196     @class wxCalendarCtrl
 197     @wxheader{calctrl.h}
 198
 199     The calendar control allows the user to pick a date.  The user can move the
 200     current selection using the keyboard and select the date (generating
 201     @c EVT_CALENDAR event) by pressing @c @<Return@> or double clicking it.
 202
 203     Generic calendar has advanced possibilities for the customization of its
 204     display, described below. If you want to use these possibilities on every
 205     platform, use wxGenericCalendarCtrl instead of wxCalendarCtrl.
 206
 207     All global settings (such as colours and fonts used) can, of course, be
 208     changed. But also, the display style for each day in the month can be set
 209     independently using wxCalendarDateAttr class.
 210
 211     An item without custom attributes is drawn with the default colours and
 212     font and without border, but setting custom attributes with SetAttr()
 213     allows to modify its appearance. Just create a custom attribute object and
 214     set it for the day you want to be displayed specially (note that the
 215     control will take ownership of the pointer, i.e. it will delete it itself).
 216     A day may be marked as being a holiday, even if it is not recognized as
 217     one by wxDateTime using the wxCalendarDateAttr::SetHoliday() method.
 218
 219     As the attributes are specified for each day, they may change when the
 220     month is changed, so you will often want to update them in
 221     @c EVT_CALENDAR_PAGE_CHANGED event handler.
 222
 223     @beginStyleTable
 224     @style{wxCAL_SUNDAY_FIRST}:
 225            Show Sunday as the first day in the week (only generic)
 226     @style{wxCAL_MONDAY_FIRST}:
 227            Show Monday as the first day in the week (only generic)
 228     @style{wxCAL_SHOW_HOLIDAYS}:
 229            Highlight holidays in the calendar (only generic)
 230     @style{wxCAL_NO_YEAR_CHANGE}:
 231            Disable the year changing (deprecated, only generic)
 232     @style{wxCAL_NO_MONTH_CHANGE}:
 233            Disable the month (and, implicitly, the year) changing
 234     @style{wxCAL_SHOW_SURROUNDING_WEEKS}:
 235            Show the neighbouring weeks in the previous and next months
 236            (only generic)
 237     @style{wxCAL_SEQUENTIAL_MONTH_SELECTION}:
 238            Use alternative, more compact, style for the month and year
 239            selection controls. (only generic)
 240     @endStyleTable
 241
 242     @beginEventTable{wxCalendarEvent}
 243     @event{EVT_CALENDAR(id, func)}:
 244            A day was double clicked in the calendar.
 245     @event{EVT_CALENDAR_SEL_CHANGED(id, func)}:
 246            The selected date changed.
 247     @event{EVT_CALENDAR_PAGE_CHANGED(id, func)}:
 248            The selected month (and/or year) changed.
 249     @event{EVT_CALENDAR_WEEKDAY_CLICKED(id, func)}:
 250            User clicked on the week day header (only generic).
 251     @endEventTable
 252
 253     @note Changing the selected date will trigger an EVT_CALENDAR_DAY, MONTH or
 254           YEAR event as well as an EVT_CALENDAR_SEL_CHANGED event.
 255
 256     @library{wxadv}
 257     @category{ctrl}
 258     <!-- @appearance{calendarctrl.png} -->
 259
 260     @nativeimpl{wxgtk}
 261
 262     @see @ref page_samples_calendar, wxCalendarDateAttr, wxCalendarEvent,
 263          wxDatePickerCtrl
 264 */
 265 class wxCalendarCtrl : public wxControl
 266 {
 267 public:
 268     /**
 269         Default constructor.
 270     */
 271     wxCalendarCtrl();
 272
 273     /**
 274         Does the same as Create() method.
 275     */
 276     wxCalendarCtrl(wxWindow* parent, wxWindowID id,
 277                    const wxDateTime& date = wxDefaultDateTime,
 278                    const wxPoint& pos = wxDefaultPosition,
 279                    const wxSize& size = wxDefaultSize,
 280                    long style = wxCAL_SHOW_HOLIDAYS,
 281                    const wxString& name = wxCalendarNameStr);
 282
 283     /**
 284         Destroys the control.
 285     */
 286     ~wxCalendarCtrl();
 287
 288     /**
 289         Creates the control. See wxWindow::wxWindow() for the meaning of the
 290         parameters and the control overview for the possible styles.
 291     */
 292     bool Create(wxWindow* parent, wxWindowID id,
 293                 const wxDateTime& date = wxDefaultDateTime,
 294                 const wxPoint& pos = wxDefaultPosition,
 295                 const wxSize& size = wxDefaultSize,
 296                 long style = wxCAL_SHOW_HOLIDAYS,
 297                 const wxString& name = wxCalendarNameStr);
 298
 299     /**
 300         This function should be used instead of changing @c wxCAL_SHOW_HOLIDAYS
 301         style bit directly. It enables or disables the special highlighting of
 302         the holidays.
 303     */
 304     void EnableHolidayDisplay(bool display = true);
 305
 306     /**
 307         This function should be used instead of changing
 308         @c wxCAL_NO_MONTH_CHANGE style bit. It allows or disallows the user to
 309         change the month interactively. Note that if the month can not be
 310         changed, the year can not be changed neither.
 311
 312         @return @true if the value of this option really changed or @false if
 313                 it was already set to the requested value.
 314     */
 315     bool EnableMonthChange(bool enable = true);
 316
 317     /**
 318         @deprecated
 319
 320         This function should be used instead of changing
 321         @c wxCAL_NO_YEAR_CHANGE style bit directly. It allows or disallows the
 322         user to change the year interactively. Only in generic wxCalendarCtrl.
 323     */
 324     void EnableYearChange(bool enable = true);
 325
 326     /**
 327         Returns the attribute for the given date (should be in the range
 328         1...31). The returned pointer may be @NULL. Only in generic
 329         wxCalendarCtrl.
 330     */
 331     wxCalendarDateAttr* GetAttr(size_t day) const;
 332
 333     /**
 334         Gets the currently selected date.
 335     */
 336     const wxDateTime GetDate() const;
 337
 338     /**
 339         Gets the background colour of the header part of the calendar window.
 340
 341         This method is currently only implemented in generic wxCalendarCtrl and
 342         always returns @c wxNullColour in the native versions.
 343
 344         @see SetHeaderColours()
 345     */
 346     const wxColour GetHeaderColourBg() const;
 347
 348     /**
 349         Gets the foreground colour of the header part of the calendar window.
 350
 351         This method is currently only implemented in generic wxCalendarCtrl and
 352         always returns @c wxNullColour in the native versions.
 353
 354         @see SetHeaderColours()
 355     */
 356     const wxColour GetHeaderColourFg() const;
 357
 358     /**
 359         Gets the background highlight colour. Only in generic wxCalendarCtrl.
 360
 361         This method is currently only implemented in generic wxCalendarCtrl and
 362         always returns @c wxNullColour in the native versions.
 363
 364         @see SetHighlightColours()
 365     */
 366     const wxColour GetHighlightColourBg() const;
 367
 368     /**
 369         Gets the foreground highlight colour. Only in generic wxCalendarCtrl.
 370
 371         This method is currently only implemented in generic wxCalendarCtrl and
 372         always returns @c wxNullColour in the native versions.
 373
 374         @see SetHighlightColours()
 375     */
 376     const wxColour GetHighlightColourFg() const;
 377
 378     /**
 379         Return the background colour currently used for holiday highlighting.
 380
 381         Only useful with generic wxCalendarCtrl as native versions currently
 382         don't support holidays display at all and always return
 383         @c wxNullColour.
 384
 385         @see SetHolidayColours()
 386     */
 387     const wxColour GetHolidayColourBg() const;
 388
 389     /**
 390         Return the foreground colour currently used for holiday highlighting.
 391
 392         Only useful with generic wxCalendarCtrl as native versions currently
 393         don't support holidays display at all and always return
 394         @c wxNullColour.
 395
 396         @see SetHolidayColours()
 397     */
 398     const wxColour GetHolidayColourFg() const;
 399
 400     /**
 401         Returns one of wxCalendarHitTestResult constants and fills either
 402         @a date or @a wd pointer with the corresponding value depending on the
 403         hit test code. Only in generic wxCalendarCtrl.
 404     */
 405     wxCalendarHitTestResult HitTest(const wxPoint& pos,
 406                                     wxDateTime* date = NULL,
 407                                     wxDateTime::WeekDay* wd = NULL);
 408
 409     /**
 410         Clears any attributes associated with the given day (in the range
 411         1...31). Only in generic wxCalendarCtrl.
 412     */
 413     void ResetAttr(size_t day);
 414
 415     /**
 416         Associates the attribute with the specified date (in the range 1...31).
 417         If the pointer is @NULL, the items attribute is cleared. Only in
 418         generic wxCalendarCtrl.
 419     */
 420     void SetAttr(size_t day, wxCalendarDateAttr* attr);
 421
 422     /**
 423         Sets the current date.
 424     */
 425     void SetDate(const wxDateTime& date);
 426
 427     /**
 428         Set the colours used for painting the weekdays at the top of the
 429         control.
 430
 431         This method is currently only implemented in generic wxCalendarCtrl and
 432         does nothing in the native versions.
 433     */
 434     void SetHeaderColours(const wxColour& colFg,
 435                           const wxColour& colBg);
 436
 437     /**
 438         Set the colours to be used for highlighting the currently selected
 439         date.
 440
 441         This method is currently only implemented in generic wxCalendarCtrl and
 442         does nothing in the native versions.
 443     */
 444     void SetHighlightColours(const wxColour& colFg,
 445                              const wxColour& colBg);
 446
 447     /**
 448         Marks the specified day as being a holiday in the current month.
 449
 450         This method is only implemented in the generic version of the control
 451         and does nothing in the native ones.
 452     */
 453     void SetHoliday(size_t day);
 454
 455     /**
 456         Sets the colours to be used for the holidays highlighting.
 457
 458         This method is only implemented in the generic version of the control
 459         and does nothing in the native ones. It should also only be called if
 460         the window style includes @c wxCAL_SHOW_HOLIDAYS flag or
 461         EnableHolidayDisplay() had been called.
 462
 463     */
 464     void SetHolidayColours(const wxColour& colFg,
 465                            const wxColour& colBg);
 466
 467     /**
 468         Mark or unmark the day. This day of month will be marked in every
 469         month. In generic wxCalendarCtrl,
 470     */
 471     void Mark(size_t day, bool mark);
 472
 473     /**
 474         @name Date Range Functions
 475
 476         The functions in this section are currently implemented in the generic
 477         and MSW versions and do nothing in the native GTK implementation.
 478      */
 479     //@{
 480
 481     /**
 482         Restrict the dates shown by the control to the specified range.
 483
 484         If either date is set, the corresponding limit will be enforced and
 485         @true returned. If none are set, the existing restrictions are removed
 486         and @false is returned.
 487
 488         @see GetDateRange()
 489
 490         @param lowerdate
 491             The low limit for the dates shown by the control or
 492             @c wxDefaultDateTime.
 493         @param highlighting
 494             The high limit for the dates shown by the control or
 495             @c wxDefaultDateTime.
 496         @return
 497             @true if either limit is valid, @false otherwise
 498      */
 499     virtual bool SetDateRange(const wxDateTime& lowerdate = wxDefaultDateTime,
 500                                 const wxDateTime& upperdate = wxDefaultDateTime);
 501
 502     /**
 503         Returns the limits currently being used.
 504
 505         @see SetDateRange()
 506
 507         @param lowerdate
 508             If non-@NULL, the value of the low limit for the dates shown by the
 509             control is returned (which may be @c wxDefaultDateTime if no limit
 510             is set).
 511         @param upperdate
 512             If non-@NULL, the value of the upper limit for the dates shown by
 513             the control is returned (which may be @c wxDefaultDateTime if no
 514             limit is set).
 515         @return
 516             @true if either limit is set, @false otherwise
 517      */
 518     virtual bool GetDateRange(wxDateTime *lowerdate,
 519                                 wxDateTime *upperdate) const;
 520
 521     //@}
 522 };
 523