reSWIGged

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@27285 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

wxPython/src/gtk/calendar.py

@@ -1,6 +1,10 @@
 # This file was created automatically by SWIG.
 # Don't modify this file, modify the SWIG interface instead.
 
+"""
+Classes for an interactive Calendar control.
+"""
+
 import _calendar
 
 import _misc
@@ -190,6 +194,46 @@ class CalendarCtrl(_core.Control):
     As the attributes are specified for each day, they may change when the
     month is changed, so you will often want to update them in an
     EVT_CALENDAR_MONTH event handler.
+
+    Window Styles
+    -------------
+        ==============================   ============================
+        CAL_SUNDAY_FIRST                 Show Sunday as the first day
+                                         in the week
+        CAL_MONDAY_FIRST                 Show Monday as the first day
+                                         in the week
+        CAL_SHOW_HOLIDAYS                Highlight holidays in the
+                                         calendar
+        CAL_NO_YEAR_CHANGE               Disable the year changing
+        CAL_NO_MONTH_CHANGE              Disable the month (and,
+                                         implicitly, the year) changing
+        CAL_SHOW_SURROUNDING_WEEKS       Show the neighbouring weeks in
+                                         the previous and next months
+        CAL_SEQUENTIAL_MONTH_SELECTION   Use alternative, more compact,
+                                         style for the month and year
+                                         selection controls.
+        ==============================   ============================
+
+    The default calendar style is CAL_SHOW_HOLIDAYS.
+
+    Events
+    -------
+        =============================  ==============================
+        EVT_CALENDAR                   A day was double clicked in the
+                                       calendar.
+        EVT_CALENDAR_SEL_CHANGED       The selected date changed.
+        EVT_CALENDAR_DAY               The selected day changed.
+        EVT_CALENDAR_MONTH             The selected month changed.
+        EVT_CALENDAR_YEAR              The selected year changed.
+        EVT_CALENDAR_WEEKDAY_CLICKED   User clicked on the week day
+                                       header
+        =============================  ==============================
+
+    Note that changing the selected date will result in one of
+    EVT_CALENDAR_DAY, MONTH or YEAR events and an EVT_CALENDAR_SEL_CHANGED
+    event.
+        
+
     """
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxCalendarCtrl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
@@ -425,6 +469,14 @@ class CalendarCtrl(_core.Control):
         Returns 3-tuple with information about the given position on the
         calendar control.  The first value of the tuple is a result code and
         determines the validity of the remaining two values.
+        The result codes are:
+
+            ===================    ============================================
+            CAL_HITTEST_NOWHERE    hit outside of anything
+            CAL_HITTEST_HEADER     hit on the header, weekday is valid
+            CAL_HITTEST_DAY        hit on a day in the calendar, date is set.
+            ===================    ============================================
+
         """
         return _calendar.CalendarCtrl_HitTest(*args, **kwargs)
 
@@ -451,12 +503,13 @@ class CalendarCtrl(_core.Control):
         Get the default attributes for this class.  This is useful if you want
         to use the same font or colour in your own control as in a standard
         control -- which is a much better idea than hard coding specific
-        colours or fonts which might look completely out of place on the users
-        system, especially if it uses themes.
+        colours or fonts which might look completely out of place on the
+        user's system, especially if it uses themes.
 
         The variant parameter is only relevant under Mac currently and is
         ignore under other platforms. Under Mac, it will change the size of
-        the returned font. See SetWindowVariant for more about this.
+        the returned font. See `wx.Window.SetWindowVariant` for more about
+        this.
         """
         return _calendar.CalendarCtrl_GetClassDefaultAttributes(*args, **kwargs)
 
@@ -488,12 +541,13 @@ def CalendarCtrl_GetClassDefaultAttributes(*args, **kwargs):
     Get the default attributes for this class.  This is useful if you want
     to use the same font or colour in your own control as in a standard
     control -- which is a much better idea than hard coding specific
-    colours or fonts which might look completely out of place on the users
-    system, especially if it uses themes.
+    colours or fonts which might look completely out of place on the
+    user's system, especially if it uses themes.
 
     The variant parameter is only relevant under Mac currently and is
     ignore under other platforms. Under Mac, it will change the size of
-    the returned font. See SetWindowVariant for more about this.
+    the returned font. See `wx.Window.SetWindowVariant` for more about
+    this.
     """
     return _calendar.CalendarCtrl_GetClassDefaultAttributes(*args, **kwargs)