X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d14a1e28567de23c586bc80017073d0c39f8d18f..9472490a672d3d8cc178852279f27664037b0bf1:/wxPython/src/gtk/calendar.py

diff --git a/wxPython/src/gtk/calendar.py b/wxPython/src/gtk/calendar.py
index 412bd12d80..d9b21268e9 100644
--- a/wxPython/src/gtk/calendar.py
+++ b/wxPython/src/gtk/calendar.py
@@ -23,30 +23,92 @@ CAL_BORDER_NONE = _calendar.CAL_BORDER_NONE
 CAL_BORDER_SQUARE = _calendar.CAL_BORDER_SQUARE
 CAL_BORDER_ROUND = _calendar.CAL_BORDER_ROUND
 class CalendarDateAttr(object):
+    """
+    A set of customization attributes for a calendar date, which can be used to
+    control the look of the Calendar object.
+    """
+    def __repr__(self):
+        return "<%s.%s; proxy of C++ wxCalendarDateAttr instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
+        """
+        __init__(Colour colText=wxNullColour, Colour colBack=wxNullColour, 
+            Colour colBorder=wxNullColour, Font font=wxNullFont, 
+            int border=CAL_BORDER_NONE) -> CalendarDateAttr
+
+        Create a CalendarDateAttr.
+        """
         newobj = _calendar.new_CalendarDateAttr(*args, **kwargs)
         self.this = newobj.this
         self.thisown = 1
         del newobj.thisown
-    def SetTextColour(*args, **kwargs): return _calendar.CalendarDateAttr_SetTextColour(*args, **kwargs)
-    def SetBackgroundColour(*args, **kwargs): return _calendar.CalendarDateAttr_SetBackgroundColour(*args, **kwargs)
-    def SetBorderColour(*args, **kwargs): return _calendar.CalendarDateAttr_SetBorderColour(*args, **kwargs)
-    def SetFont(*args, **kwargs): return _calendar.CalendarDateAttr_SetFont(*args, **kwargs)
-    def SetBorder(*args, **kwargs): return _calendar.CalendarDateAttr_SetBorder(*args, **kwargs)
-    def SetHoliday(*args, **kwargs): return _calendar.CalendarDateAttr_SetHoliday(*args, **kwargs)
-    def HasTextColour(*args, **kwargs): return _calendar.CalendarDateAttr_HasTextColour(*args, **kwargs)
-    def HasBackgroundColour(*args, **kwargs): return _calendar.CalendarDateAttr_HasBackgroundColour(*args, **kwargs)
-    def HasBorderColour(*args, **kwargs): return _calendar.CalendarDateAttr_HasBorderColour(*args, **kwargs)
-    def HasFont(*args, **kwargs): return _calendar.CalendarDateAttr_HasFont(*args, **kwargs)
-    def HasBorder(*args, **kwargs): return _calendar.CalendarDateAttr_HasBorder(*args, **kwargs)
-    def IsHoliday(*args, **kwargs): return _calendar.CalendarDateAttr_IsHoliday(*args, **kwargs)
-    def GetTextColour(*args, **kwargs): return _calendar.CalendarDateAttr_GetTextColour(*args, **kwargs)
-    def GetBackgroundColour(*args, **kwargs): return _calendar.CalendarDateAttr_GetBackgroundColour(*args, **kwargs)
-    def GetBorderColour(*args, **kwargs): return _calendar.CalendarDateAttr_GetBorderColour(*args, **kwargs)
-    def GetFont(*args, **kwargs): return _calendar.CalendarDateAttr_GetFont(*args, **kwargs)
-    def GetBorder(*args, **kwargs): return _calendar.CalendarDateAttr_GetBorder(*args, **kwargs)
-    def __repr__(self):
-        return "<%s.%s; proxy of C++ wxCalendarDateAttr instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+    def SetTextColour(*args, **kwargs):
+        """SetTextColour(Colour colText)"""
+        return _calendar.CalendarDateAttr_SetTextColour(*args, **kwargs)
+
+    def SetBackgroundColour(*args, **kwargs):
+        """SetBackgroundColour(Colour colBack)"""
+        return _calendar.CalendarDateAttr_SetBackgroundColour(*args, **kwargs)
+
+    def SetBorderColour(*args, **kwargs):
+        """SetBorderColour(Colour col)"""
+        return _calendar.CalendarDateAttr_SetBorderColour(*args, **kwargs)
+
+    def SetFont(*args, **kwargs):
+        """SetFont(Font font)"""
+        return _calendar.CalendarDateAttr_SetFont(*args, **kwargs)
+
+    def SetBorder(*args, **kwargs):
+        """SetBorder(int border)"""
+        return _calendar.CalendarDateAttr_SetBorder(*args, **kwargs)
+
+    def SetHoliday(*args, **kwargs):
+        """SetHoliday(bool holiday)"""
+        return _calendar.CalendarDateAttr_SetHoliday(*args, **kwargs)
+
+    def HasTextColour(*args, **kwargs):
+        """HasTextColour() -> bool"""
+        return _calendar.CalendarDateAttr_HasTextColour(*args, **kwargs)
+
+    def HasBackgroundColour(*args, **kwargs):
+        """HasBackgroundColour() -> bool"""
+        return _calendar.CalendarDateAttr_HasBackgroundColour(*args, **kwargs)
+
+    def HasBorderColour(*args, **kwargs):
+        """HasBorderColour() -> bool"""
+        return _calendar.CalendarDateAttr_HasBorderColour(*args, **kwargs)
+
+    def HasFont(*args, **kwargs):
+        """HasFont() -> bool"""
+        return _calendar.CalendarDateAttr_HasFont(*args, **kwargs)
+
+    def HasBorder(*args, **kwargs):
+        """HasBorder() -> bool"""
+        return _calendar.CalendarDateAttr_HasBorder(*args, **kwargs)
+
+    def IsHoliday(*args, **kwargs):
+        """IsHoliday() -> bool"""
+        return _calendar.CalendarDateAttr_IsHoliday(*args, **kwargs)
+
+    def GetTextColour(*args, **kwargs):
+        """GetTextColour() -> Colour"""
+        return _calendar.CalendarDateAttr_GetTextColour(*args, **kwargs)
+
+    def GetBackgroundColour(*args, **kwargs):
+        """GetBackgroundColour() -> Colour"""
+        return _calendar.CalendarDateAttr_GetBackgroundColour(*args, **kwargs)
+
+    def GetBorderColour(*args, **kwargs):
+        """GetBorderColour() -> Colour"""
+        return _calendar.CalendarDateAttr_GetBorderColour(*args, **kwargs)
+
+    def GetFont(*args, **kwargs):
+        """GetFont() -> Font"""
+        return _calendar.CalendarDateAttr_GetFont(*args, **kwargs)
+
+    def GetBorder(*args, **kwargs):
+        """GetBorder() -> int"""
+        return _calendar.CalendarDateAttr_GetBorder(*args, **kwargs)
+
 
 class CalendarDateAttrPtr(CalendarDateAttr):
     def __init__(self, this):
@@ -55,21 +117,31 @@ class CalendarDateAttrPtr(CalendarDateAttr):
         self.__class__ = CalendarDateAttr
 _calendar.CalendarDateAttr_swigregister(CalendarDateAttrPtr)
 
-def CalendarDateAttrBorder(*args, **kwargs):
-    val = _calendar.new_CalendarDateAttrBorder(*args, **kwargs)
-    val.thisown = 1
-    return val
-
 class CalendarEvent(core.CommandEvent):
+    def __repr__(self):
+        return "<%s.%s; proxy of C++ wxCalendarEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
+        """__init__(CalendarCtrl cal, wxEventType type) -> CalendarEvent"""
         newobj = _calendar.new_CalendarEvent(*args, **kwargs)
         self.this = newobj.this
         self.thisown = 1
         del newobj.thisown
-    def GetDate(*args, **kwargs): return _calendar.CalendarEvent_GetDate(*args, **kwargs)
-    def GetWeekDay(*args, **kwargs): return _calendar.CalendarEvent_GetWeekDay(*args, **kwargs)
-    def __repr__(self):
-        return "<%s.%s; proxy of C++ wxCalendarEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+    def GetDate(*args, **kwargs):
+        """GetDate() -> DateTime"""
+        return _calendar.CalendarEvent_GetDate(*args, **kwargs)
+
+    def SetDate(*args, **kwargs):
+        """SetDate(DateTime date)"""
+        return _calendar.CalendarEvent_SetDate(*args, **kwargs)
+
+    def SetWeekDay(*args, **kwargs):
+        """SetWeekDay(int wd)"""
+        return _calendar.CalendarEvent_SetWeekDay(*args, **kwargs)
+
+    def GetWeekDay(*args, **kwargs):
+        """GetWeekDay() -> int"""
+        return _calendar.CalendarEvent_GetWeekDay(*args, **kwargs)
+
 
 class CalendarEventPtr(CalendarEvent):
     def __init__(self, this):
@@ -92,41 +164,257 @@ EVT_CALENDAR_YEAR =            wx.PyEventBinder( wxEVT_CALENDAR_YEAR_CHANGED, 1)
 EVT_CALENDAR_WEEKDAY_CLICKED = wx.PyEventBinder( wxEVT_CALENDAR_WEEKDAY_CLICKED, 1)
 
 class CalendarCtrl(core.Control):
+    """The calendar control allows the user to pick a date interactively."""
+    def __repr__(self):
+        return "<%s.%s; proxy of C++ wxCalendarCtrl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
+        """
+        __init__(Window parent, int id, DateTime date=DefaultDateTime, 
+            Point pos=DefaultPosition, Size size=DefaultSize, 
+            long style=wxCAL_SHOW_HOLIDAYS|wxWANTS_CHARS, 
+            String name=CalendarNameStr) -> CalendarCtrl
+
+        Create and show a calendar control.
+        """
         newobj = _calendar.new_CalendarCtrl(*args, **kwargs)
         self.this = newobj.this
         self.thisown = 1
         del newobj.thisown
         self._setOORInfo(self)
-    def Create(*args, **kwargs): return _calendar.CalendarCtrl_Create(*args, **kwargs)
-    def SetDate(*args, **kwargs): return _calendar.CalendarCtrl_SetDate(*args, **kwargs)
-    def GetDate(*args, **kwargs): return _calendar.CalendarCtrl_GetDate(*args, **kwargs)
-    def SetLowerDateLimit(*args, **kwargs): return _calendar.CalendarCtrl_SetLowerDateLimit(*args, **kwargs)
-    def GetLowerDateLimit(*args, **kwargs): return _calendar.CalendarCtrl_GetLowerDateLimit(*args, **kwargs)
-    def SetUpperDateLimit(*args, **kwargs): return _calendar.CalendarCtrl_SetUpperDateLimit(*args, **kwargs)
-    def GetUpperDateLimit(*args, **kwargs): return _calendar.CalendarCtrl_GetUpperDateLimit(*args, **kwargs)
-    def SetDateRange(*args, **kwargs): return _calendar.CalendarCtrl_SetDateRange(*args, **kwargs)
-    def EnableYearChange(*args, **kwargs): return _calendar.CalendarCtrl_EnableYearChange(*args, **kwargs)
-    def EnableMonthChange(*args, **kwargs): return _calendar.CalendarCtrl_EnableMonthChange(*args, **kwargs)
-    def EnableHolidayDisplay(*args, **kwargs): return _calendar.CalendarCtrl_EnableHolidayDisplay(*args, **kwargs)
-    def SetHeaderColours(*args, **kwargs): return _calendar.CalendarCtrl_SetHeaderColours(*args, **kwargs)
-    def GetHeaderColourFg(*args, **kwargs): return _calendar.CalendarCtrl_GetHeaderColourFg(*args, **kwargs)
-    def GetHeaderColourBg(*args, **kwargs): return _calendar.CalendarCtrl_GetHeaderColourBg(*args, **kwargs)
-    def SetHighlightColours(*args, **kwargs): return _calendar.CalendarCtrl_SetHighlightColours(*args, **kwargs)
-    def GetHighlightColourFg(*args, **kwargs): return _calendar.CalendarCtrl_GetHighlightColourFg(*args, **kwargs)
-    def GetHighlightColourBg(*args, **kwargs): return _calendar.CalendarCtrl_GetHighlightColourBg(*args, **kwargs)
-    def SetHolidayColours(*args, **kwargs): return _calendar.CalendarCtrl_SetHolidayColours(*args, **kwargs)
-    def GetHolidayColourFg(*args, **kwargs): return _calendar.CalendarCtrl_GetHolidayColourFg(*args, **kwargs)
-    def GetHolidayColourBg(*args, **kwargs): return _calendar.CalendarCtrl_GetHolidayColourBg(*args, **kwargs)
-    def GetAttr(*args, **kwargs): return _calendar.CalendarCtrl_GetAttr(*args, **kwargs)
-    def SetAttr(*args, **kwargs): return _calendar.CalendarCtrl_SetAttr(*args, **kwargs)
-    def SetHoliday(*args, **kwargs): return _calendar.CalendarCtrl_SetHoliday(*args, **kwargs)
-    def ResetAttr(*args, **kwargs): return _calendar.CalendarCtrl_ResetAttr(*args, **kwargs)
-    def HitTest(*args, **kwargs): return _calendar.CalendarCtrl_HitTest(*args, **kwargs)
-    def Enable(*args, **kwargs): return _calendar.CalendarCtrl_Enable(*args, **kwargs)
-    def Show(*args, **kwargs): return _calendar.CalendarCtrl_Show(*args, **kwargs)
-    def __repr__(self):
-        return "<%s.%s; proxy of C++ wxCalendarCtrl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+
+    def Create(*args, **kwargs):
+        """
+        Create(Window parent, int id, DateTime date=DefaultDateTime, 
+            Point pos=DefaultPosition, Size size=DefaultSize, 
+            long style=wxCAL_SHOW_HOLIDAYS|wxWANTS_CHARS, 
+            String name=CalendarNameStr) -> bool
+
+        Acutally create the GUI portion of the CalendarCtrl for 2-phase creation.
+        """
+        return _calendar.CalendarCtrl_Create(*args, **kwargs)
+
+    def SetDate(*args, **kwargs):
+        """
+        SetDate(DateTime date)
+
+        Sets the current date.
+        """
+        return _calendar.CalendarCtrl_SetDate(*args, **kwargs)
+
+    def GetDate(*args, **kwargs):
+        """
+        GetDate() -> DateTime
+
+        Gets the currently selected date.
+        """
+        return _calendar.CalendarCtrl_GetDate(*args, **kwargs)
+
+    def SetLowerDateLimit(*args, **kwargs):
+        """
+        SetLowerDateLimit(DateTime date=DefaultDateTime) -> bool
+
+        set the range in which selection can occur
+        """
+        return _calendar.CalendarCtrl_SetLowerDateLimit(*args, **kwargs)
+
+    def SetUpperDateLimit(*args, **kwargs):
+        """
+        SetUpperDateLimit(DateTime date=DefaultDateTime) -> bool
+
+        set the range in which selection can occur
+        """
+        return _calendar.CalendarCtrl_SetUpperDateLimit(*args, **kwargs)
+
+    def GetLowerDateLimit(*args, **kwargs):
+        """
+        GetLowerDateLimit() -> DateTime
+
+        get the range in which selection can occur
+        """
+        return _calendar.CalendarCtrl_GetLowerDateLimit(*args, **kwargs)
+
+    def GetUpperDateLimit(*args, **kwargs):
+        """
+        GetUpperDateLimit() -> DateTime
+
+        get the range in which selection can occur
+        """
+        return _calendar.CalendarCtrl_GetUpperDateLimit(*args, **kwargs)
+
+    def SetDateRange(*args, **kwargs):
+        """
+        SetDateRange(DateTime lowerdate=DefaultDateTime, DateTime upperdate=DefaultDateTime) -> bool
+
+        set the range in which selection can occur
+        """
+        return _calendar.CalendarCtrl_SetDateRange(*args, **kwargs)
+
+    def EnableYearChange(*args, **kwargs):
+        """
+        EnableYearChange(bool enable=True)
+
+        This function should be used instead of changing CAL_NO_YEAR_CHANGE
+        style bit directly. It allows or disallows the user to change the year
+        interactively.
+        """
+        return _calendar.CalendarCtrl_EnableYearChange(*args, **kwargs)
+
+    def EnableMonthChange(*args, **kwargs):
+        """
+        EnableMonthChange(bool enable=True)
+
+        This function should be used instead of changing CAL_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 either.
+        """
+        return _calendar.CalendarCtrl_EnableMonthChange(*args, **kwargs)
+
+    def EnableHolidayDisplay(*args, **kwargs):
+        """
+        EnableHolidayDisplay(bool display=True)
+
+        This function should be used instead of changing CAL_SHOW_HOLIDAYS style
+        bit directly. It enables or disables the special highlighting of the holidays.
+        """
+        return _calendar.CalendarCtrl_EnableHolidayDisplay(*args, **kwargs)
+
+    def SetHeaderColours(*args, **kwargs):
+        """
+        SetHeaderColours(Colour colFg, Colour colBg)
+
+        header colours are used for painting the weekdays at the top
+        """
+        return _calendar.CalendarCtrl_SetHeaderColours(*args, **kwargs)
+
+    def GetHeaderColourFg(*args, **kwargs):
+        """
+        GetHeaderColourFg() -> Colour
+
+        header colours are used for painting the weekdays at the top
+        """
+        return _calendar.CalendarCtrl_GetHeaderColourFg(*args, **kwargs)
+
+    def GetHeaderColourBg(*args, **kwargs):
+        """
+        GetHeaderColourBg() -> Colour
+
+        header colours are used for painting the weekdays at the top
+        """
+        return _calendar.CalendarCtrl_GetHeaderColourBg(*args, **kwargs)
+
+    def SetHighlightColours(*args, **kwargs):
+        """
+        SetHighlightColours(Colour colFg, Colour colBg)
+
+        highlight colour is used for the currently selected date
+        """
+        return _calendar.CalendarCtrl_SetHighlightColours(*args, **kwargs)
+
+    def GetHighlightColourFg(*args, **kwargs):
+        """
+        GetHighlightColourFg() -> Colour
+
+        highlight colour is used for the currently selected date
+        """
+        return _calendar.CalendarCtrl_GetHighlightColourFg(*args, **kwargs)
+
+    def GetHighlightColourBg(*args, **kwargs):
+        """
+        GetHighlightColourBg() -> Colour
+
+        highlight colour is used for the currently selected date
+        """
+        return _calendar.CalendarCtrl_GetHighlightColourBg(*args, **kwargs)
+
+    def SetHolidayColours(*args, **kwargs):
+        """
+        SetHolidayColours(Colour colFg, Colour colBg)
+
+        holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is used)
+        """
+        return _calendar.CalendarCtrl_SetHolidayColours(*args, **kwargs)
+
+    def GetHolidayColourFg(*args, **kwargs):
+        """
+        GetHolidayColourFg() -> Colour
+
+        holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is used)
+        """
+        return _calendar.CalendarCtrl_GetHolidayColourFg(*args, **kwargs)
+
+    def GetHolidayColourBg(*args, **kwargs):
+        """
+        GetHolidayColourBg() -> Colour
+
+        holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is used)
+        """
+        return _calendar.CalendarCtrl_GetHolidayColourBg(*args, **kwargs)
+
+    def GetAttr(*args, **kwargs):
+        """
+        GetAttr(size_t day) -> CalendarDateAttr
+
+        Returns the attribute for the given date (should be in the range 1...31).
+        The returned value may be None
+        """
+        return _calendar.CalendarCtrl_GetAttr(*args, **kwargs)
+
+    def SetAttr(*args, **kwargs):
+        """
+        SetAttr(size_t day, CalendarDateAttr attr)
+
+        Associates the attribute with the specified date (in the range 1...31).
+        If the attribute passed is None, the items attribute is cleared.
+        """
+        return _calendar.CalendarCtrl_SetAttr(*args, **kwargs)
+
+    def SetHoliday(*args, **kwargs):
+        """
+        SetHoliday(size_t day)
+
+        Marks the specified day as being a holiday in the current month.
+        """
+        return _calendar.CalendarCtrl_SetHoliday(*args, **kwargs)
+
+    def ResetAttr(*args, **kwargs):
+        """
+        ResetAttr(size_t day)
+
+        Clears any attributes associated with the given day (in the range 1...31).
+        """
+        return _calendar.CalendarCtrl_ResetAttr(*args, **kwargs)
+
+    def HitTest(*args, **kwargs):
+        """
+        HitTest(Point pos) -> (result, date, weekday)
+
+        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)
+
+    def GetMonthControl(*args, **kwargs):
+        """
+        GetMonthControl() -> Control
+
+        get the currently shown control for month
+        """
+        return _calendar.CalendarCtrl_GetMonthControl(*args, **kwargs)
+
+    def GetYearControl(*args, **kwargs):
+        """
+        GetYearControl() -> Control
+
+        get the currently shown control for year
+        """
+        return _calendar.CalendarCtrl_GetYearControl(*args, **kwargs)
+
 
 class CalendarCtrlPtr(CalendarCtrl):
     def __init__(self, this):
@@ -134,8 +422,15 @@ class CalendarCtrlPtr(CalendarCtrl):
         if not hasattr(self,"thisown"): self.thisown = 0
         self.__class__ = CalendarCtrl
 _calendar.CalendarCtrl_swigregister(CalendarCtrlPtr)
+cvar = _calendar.cvar
+CalendarNameStr = cvar.CalendarNameStr
 
 def PreCalendarCtrl(*args, **kwargs):
+    """
+    PreCalendarCtrl() -> CalendarCtrl
+
+    Precreate a CalendarCtrl for 2-phase creation.
+    """
     val = _calendar.new_PreCalendarCtrl(*args, **kwargs)
     val.thisown = 1
     return val