X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/232b2162776e08c0b16d5280b90f5c075f38c667..b02dd12239c8a59b9a545d9fcb04974f8ad02c6b:/interface/wx/calctrl.h?ds=inline diff --git a/interface/wx/calctrl.h b/interface/wx/calctrl.h index ccd01dba9e..e4f2cd8702 100644 --- a/interface/wx/calctrl.h +++ b/interface/wx/calctrl.h @@ -3,7 +3,7 @@ // Purpose: interface of wxCalendarCtrl // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -53,7 +53,7 @@ enum wxCalendarDateBorder of this class are used with wxCalendarCtrl. @library{wxadv} - @category{misc} + @category{data} @see wxCalendarCtrl */ @@ -237,7 +237,7 @@ enum wxCalendarHitTestResult 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)} @@ -306,8 +306,8 @@ public: /** 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. @@ -424,7 +424,9 @@ public: /** 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); @@ -476,14 +478,12 @@ public: /** @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 @@ -493,10 +493,10 @@ public: @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 */ @@ -510,11 +510,11 @@ public: @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