// Purpose: interface of wxCalendarCtrl
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
Sets the week day carried by the event, normally only used by the
library internally.
*/
- void SetWeekDay(wxDateTime::WeekDay day);
+ void SetWeekDay(const wxDateTime::WeekDay day);
};
of this class are used with wxCalendarCtrl.
@library{wxadv}
- @category{misc}
+ @category{data}
@see wxCalendarCtrl
*/
class wxCalendarDateAttr
{
public:
- /**
- Default constructor.
- */
- wxCalendarDateAttr();
-
/**
Constructor for specifying all wxCalendarDateAttr properties.
*/
- wxCalendarDateAttr(const wxColour& colText,
+ wxCalendarDateAttr(const wxColour& colText = wxNullColour,
const wxColour& colBack = wxNullColour,
const wxColour& colBorder = wxNullColour,
const wxFont& font = wxNullFont,
/**
Returns the background colour set for the calendar date.
*/
- const wxColour GetBackgroundColour() const;
+ const wxColour& GetBackgroundColour() const;
/**
Returns the border set for the calendar date.
/**
Returns the border colour set for the calendar date.
*/
- const wxColour GetBorderColour() const;
+ const wxColour& GetBorderColour() const;
/**
Returns the font set for the calendar date.
*/
- const wxFont GetFont() const;
+ const wxFont& GetFont() const;
/**
Returns the text colour set for the calendar date.
*/
- const wxColour GetTextColour() const;
+ const wxColour& GetTextColour() const;
/**
Returns @true if a non-default text background colour is set.
{
wxCAL_HITTEST_NOWHERE, ///< Hit outside of anything.
wxCAL_HITTEST_HEADER, ///< Hit on the header (weekdays).
- wxCAL_HITTEST_DAY ///< Hit on a day in the calendar.
+ wxCAL_HITTEST_DAY, ///< Hit on a day in the calendar.
+ wxCAL_HITTEST_INCMONTH, ///< Hit on next month arrow (in alternate month selector mode).
+ wxCAL_HITTEST_DECMONTH, ///< Hit on previous month arrow (in alternate month selector mode).
+ wxCAL_HITTEST_SURROUNDING_WEEK, ///< Hit on surrounding week of previous/next month (if shown).
+ wxCAL_HITTEST_WEEK ///< Hit on week of the year number (if shown).
};
/**
Show week numbers on the left side of the calendar. (not in generic)
@endStyleTable
- @beginEventTable{wxCalendarEvent}
+ @beginEventEmissionTable{wxCalendarEvent}
@event{EVT_CALENDAR(id, func)}
A day was double clicked in the calendar.
@event{EVT_CALENDAR_SEL_CHANGED(id, func)}
The selected month (and/or year) changed.
@event{EVT_CALENDAR_WEEKDAY_CLICKED(id, func)}
User clicked on the week day header (only generic).
+ @event{EVT_CALENDAR_WEEK_CLICKED(id, func)}
+ User clicked on the week of the year number (only generic).
@endEventTable
@note Changing the selected date will trigger an EVT_CALENDAR_DAY, MONTH or
@library{wxadv}
@category{ctrl}
- <!-- @appearance{calendarctrl.png} -->
+ @appearance{calendarctrl.png}
@nativeimpl{wxgtk,wxmsw}
/**
This function should be used instead of changing
@c wxCAL_NO_MONTH_CHANGE style bit. It allows or disallows the user to
- change the month interactively. Note that if the month can not be
- changed, the year can not be changed neither.
+ change the month interactively. Note that if the month cannot be
+ changed, the year cannot be changed neither.
@return @true if the value of this option really changed or @false if
it was already set to the requested value.
The @a date parameter must be valid.
*/
- virtual void SetDate(const wxDateTime& date);
+ virtual bool SetDate(const wxDateTime& date);
/**
Set the colours used for painting the weekdays at the top of the
@param lowerdate
The low limit for the dates shown by the control or
- @c wxDefaultDateTime.
+ ::wxDefaultDateTime.
@param upperdate
The high limit for the dates shown by the control or
- @c wxDefaultDateTime.
+ ::wxDefaultDateTime.
@return
@true if either limit is valid, @false otherwise
*/
@param lowerdate
If non-@NULL, the value of the low limit for the dates shown by the
- control is returned (which may be @c wxDefaultDateTime if no limit
+ control is returned (which may be ::wxDefaultDateTime if no limit
is set).
@param upperdate
If non-@NULL, the value of the upper limit for the dates shown by
- the control is returned (which may be @c wxDefaultDateTime if no
+ the control is returned (which may be ::wxDefaultDateTime if no
limit is set).
@return
@true if either limit is set, @false otherwise