Add new sample project files.

[wxWidgets.git] / interface / wx / calctrl.h

diff --git a/interface/wx/calctrl.h b/interface/wx/calctrl.h
index 8adf3848dca991958fe55faab654f26d556f2094..e4f2cd8702be53be8d5f2b889409fd2fdf474a9d 100644 (file)
--- 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
 */
@@ -182,7 +182,11 @@ enum wxCalendarHitTestResult
 {
     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).
 };
 
 /**
@@ -233,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)}
@@ -242,6 +246,8 @@ enum wxCalendarHitTestResult
            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
@@ -249,7 +255,7 @@ enum wxCalendarHitTestResult
 
     @library{wxadv}
     @category{ctrl}
-    <!-- @appearance{calendarctrl.png} -->
+    @appearance{calendarctrl.png}
 
     @nativeimpl{wxgtk,wxmsw}
 
@@ -300,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.
@@ -418,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);
 
@@ -470,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
@@ -487,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
      */
@@ -504,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