// Purpose: interface of wxCalendarCtrl
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
of this class are used with wxCalendarCtrl.
@library{wxadv}
- @category{misc}
+ @category{data}
@see wxCalendarCtrl
*/
/**
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.
/**
Sets the current date.
- The @a date parameter must be valid.
+ The @a date parameter must be valid and in the currently valid range as
+ set by SetDateRange(), otherwise the current date is not changed and
+ the function returns @false.
*/
virtual bool SetDate(const wxDateTime& date);
/**
@name Date Range Functions
-
- The functions in this section are currently implemented in the generic
- and MSW versions and do nothing in the native GTK implementation.
*/
//@{
/**
- Restrict the dates shown by the control to the specified range.
+ Restrict the dates that can be selected in the control to the specified
+ range.
If either date is set, the corresponding limit will be enforced and
@true returned. If none are set, the existing restrictions are removed
@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