]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/src/msw/calendar.py
2.7 --> 2.8
[wxWidgets.git] / wxPython / src / msw / calendar.py
index 6496686b8e19950654b16a9e71e796a2bdede3ad..8b66d7f2bfa45c0b01ec61c8806e5333e444fe3e 100644 (file)
@@ -1,12 +1,64 @@
-# This file was created automatically by SWIG.
+# This file was created automatically by SWIG 1.3.29.
 # Don't modify this file, modify the SWIG interface instead.
 
-import _calendar
+"""
+Classes for an interactive Calendar control.
+"""
 
-import misc
-import core
-wx = core 
-__docfilter__ = wx.__docfilter__ 
+import _calendar
+import new
+new_instancemethod = new.instancemethod
+def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
+    if (name == "thisown"): return self.this.own(value)
+    if (name == "this"):
+        if type(value).__name__ == 'PySwigObject':
+            self.__dict__[name] = value
+            return
+    method = class_type.__swig_setmethods__.get(name,None)
+    if method: return method(self,value)
+    if (not static) or hasattr(self,name):
+        self.__dict__[name] = value
+    else:
+        raise AttributeError("You cannot add attributes to %s" % self)
+
+def _swig_setattr(self,class_type,name,value):
+    return _swig_setattr_nondynamic(self,class_type,name,value,0)
+
+def _swig_getattr(self,class_type,name):
+    if (name == "thisown"): return self.this.own()
+    method = class_type.__swig_getmethods__.get(name,None)
+    if method: return method(self)
+    raise AttributeError,name
+
+def _swig_repr(self):
+    try: strthis = "proxy of " + self.this.__repr__()
+    except: strthis = ""
+    return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
+
+import types
+try:
+    _object = types.ObjectType
+    _newclass = 1
+except AttributeError:
+    class _object : pass
+    _newclass = 0
+del types
+
+
+def _swig_setattr_nondynamic_method(set):
+    def set_attr(self,name,value):
+        if (name == "thisown"): return self.this.own(value)
+        if hasattr(self,name) or (name == "this"):
+            set(self,name,value)
+        else:
+            raise AttributeError("You cannot add attributes to %s" % self)
+    return set_attr
+
+
+import _misc
+import _core
+wx = _core 
+__docfilter__ = wx.__DocFilter(globals()) 
 CAL_SUNDAY_FIRST = _calendar.CAL_SUNDAY_FIRST
 CAL_MONDAY_FIRST = _calendar.CAL_MONDAY_FIRST
 CAL_SHOW_HOLIDAYS = _calendar.CAL_SHOW_HOLIDAYS
@@ -25,12 +77,12 @@ 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.
+    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):
+    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+    __repr__ = _swig_repr
+    def __init__(self, *args, **kwargs): 
         """
         __init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour, 
             Colour colBorder=wxNullColour, Font font=wxNullFont, 
@@ -38,10 +90,9 @@ class CalendarDateAttr(object):
 
         Create a CalendarDateAttr.
         """
-        newobj = _calendar.new_CalendarDateAttr(*args, **kwargs)
-        self.this = newobj.this
-        self.thisown = 1
-        del newobj.thisown
+        _calendar.CalendarDateAttr_swiginit(self,_calendar.new_CalendarDateAttr(*args, **kwargs))
+    __swig_destroy__ = _calendar.delete_CalendarDateAttr
+    __del__ = lambda self : None;
     def SetTextColour(*args, **kwargs):
         """SetTextColour(self, Colour colText)"""
         return _calendar.CalendarDateAttr_SetTextColour(*args, **kwargs)
@@ -110,31 +161,20 @@ class CalendarDateAttr(object):
         """GetBorder(self) -> int"""
         return _calendar.CalendarDateAttr_GetBorder(*args, **kwargs)
 
-
-class CalendarDateAttrPtr(CalendarDateAttr):
-    def __init__(self, this):
-        self.this = this
-        if not hasattr(self,"thisown"): self.thisown = 0
-        self.__class__ = CalendarDateAttr
-_calendar.CalendarDateAttr_swigregister(CalendarDateAttrPtr)
-
-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__(self, 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):
-        """GetDate(self) -> DateTime"""
-        return _calendar.CalendarEvent_GetDate(*args, **kwargs)
-
-    def SetDate(*args, **kwargs):
-        """SetDate(self, DateTime date)"""
-        return _calendar.CalendarEvent_SetDate(*args, **kwargs)
-
+    BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`") 
+    Border = property(GetBorder,SetBorder,doc="See `GetBorder` and `SetBorder`") 
+    BorderColour = property(GetBorderColour,SetBorderColour,doc="See `GetBorderColour` and `SetBorderColour`") 
+    Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`") 
+    TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`") 
+_calendar.CalendarDateAttr_swigregister(CalendarDateAttr)
+
+class CalendarEvent(_core.DateEvent):
+    """Proxy of C++ CalendarEvent class"""
+    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+    __repr__ = _swig_repr
+    def __init__(self, *args, **kwargs): 
+        """__init__(self, CalendarCtrl cal, EventType type) -> CalendarEvent"""
+        _calendar.CalendarEvent_swiginit(self,_calendar.new_CalendarEvent(*args, **kwargs))
     def SetWeekDay(*args, **kwargs):
         """SetWeekDay(self, int wd)"""
         return _calendar.CalendarEvent_SetWeekDay(*args, **kwargs)
@@ -143,13 +183,16 @@ class CalendarEvent(core.CommandEvent):
         """GetWeekDay(self) -> int"""
         return _calendar.CalendarEvent_GetWeekDay(*args, **kwargs)
 
+    def PySetDate(self, date):
+        """takes datetime.datetime or datetime.date object"""
+        self.SetDate(_pydate2wxdate(date))
 
-class CalendarEventPtr(CalendarEvent):
-    def __init__(self, this):
-        self.this = this
-        if not hasattr(self,"thisown"): self.thisown = 0
-        self.__class__ = CalendarEvent
-_calendar.CalendarEvent_swigregister(CalendarEventPtr)
+    def PyGetDate(self):
+        """returns datetime.date object"""
+        return _wxdate2pydate(self.GetDate())
+
+    WeekDay = property(GetWeekDay,SetWeekDay,doc="See `GetWeekDay` and `SetWeekDay`") 
+_calendar.CalendarEvent_swigregister(CalendarEvent)
 
 wxEVT_CALENDAR_DOUBLECLICKED = _calendar.wxEVT_CALENDAR_DOUBLECLICKED
 wxEVT_CALENDAR_SEL_CHANGED = _calendar.wxEVT_CALENDAR_SEL_CHANGED
@@ -164,11 +207,36 @@ EVT_CALENDAR_MONTH =           wx.PyEventBinder( wxEVT_CALENDAR_MONTH_CHANGED, 1
 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):
+class CalendarCtrl(_core.Control):
+    """
+    The calendar control allows the user to pick a date interactively.
+
+    The CalendarCtrl displays a window containing several parts: the
+    control to pick the month and the year at the top (either or both of
+    them may be disabled) and a month area below them which shows all the
+    days in the month. The user can move the current selection using the
+    keyboard and select the date (generating EVT_CALENDAR event) by
+    pressing <Return> or double clicking it.
+
+    It has advanced possibilities for the customization of its
+    display. All global settings (such as colours and fonts used) can, of
+    course, be changed. But also, the display style for each day in the
+    month can be set independently using CalendarDateAttr class.
+
+    An item without custom attributes is drawn with the default colours
+    and font and without border, but setting custom attributes with
+    `SetAttr` allows to modify its appearance. Just create a custom
+    attribute object and set it for the day you want to be displayed
+    specially A day may be marked as being a holiday, (even if it is not
+    recognized as one by `wx.DateTime`) by using the SetHoliday method.
+
+    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.
+    """
+    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+    __repr__ = _swig_repr
+    def __init__(self, *args, **kwargs): 
         """
         __init__(self, Window parent, int id=-1, DateTime date=DefaultDateTime, 
             Point pos=DefaultPosition, Size size=DefaultSize, 
@@ -177,10 +245,7 @@ class CalendarCtrl(core.Control):
 
         Create and show a calendar control.
         """
-        newobj = _calendar.new_CalendarCtrl(*args, **kwargs)
-        self.this = newobj.this
-        self.thisown = 1
-        del newobj.thisown
+        _calendar.CalendarCtrl_swiginit(self,_calendar.new_CalendarCtrl(*args, **kwargs))
         self._setOORInfo(self)
 
     def Create(*args, **kwargs):
@@ -190,7 +255,8 @@ class CalendarCtrl(core.Control):
             long style=wxCAL_SHOW_HOLIDAYS|wxWANTS_CHARS, 
             String name=CalendarNameStr) -> bool
 
-        Acutally create the GUI portion of the CalendarCtrl for 2-phase creation.
+        Acutally create the GUI portion of the CalendarCtrl for 2-phase
+        creation.
         """
         return _calendar.CalendarCtrl_Create(*args, **kwargs)
 
@@ -264,9 +330,10 @@ class CalendarCtrl(core.Control):
         """
         EnableMonthChange(self, 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.
+        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)
 
@@ -274,8 +341,9 @@ class CalendarCtrl(core.Control):
         """
         EnableHolidayDisplay(self, 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.
+        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)
 
@@ -283,7 +351,7 @@ class CalendarCtrl(core.Control):
         """
         SetHeaderColours(self, Colour colFg, Colour colBg)
 
-        header colours are used for painting the weekdays at the top
+        Header colours are used for painting the weekdays at the top.
         """
         return _calendar.CalendarCtrl_SetHeaderColours(*args, **kwargs)
 
@@ -291,7 +359,7 @@ class CalendarCtrl(core.Control):
         """
         GetHeaderColourFg(self) -> Colour
 
-        header colours are used for painting the weekdays at the top
+        Header colours are used for painting the weekdays at the top.
         """
         return _calendar.CalendarCtrl_GetHeaderColourFg(*args, **kwargs)
 
@@ -299,7 +367,7 @@ class CalendarCtrl(core.Control):
         """
         GetHeaderColourBg(self) -> Colour
 
-        header colours are used for painting the weekdays at the top
+        Header colours are used for painting the weekdays at the top.
         """
         return _calendar.CalendarCtrl_GetHeaderColourBg(*args, **kwargs)
 
@@ -307,7 +375,7 @@ class CalendarCtrl(core.Control):
         """
         SetHighlightColours(self, Colour colFg, Colour colBg)
 
-        highlight colour is used for the currently selected date
+        Highlight colour is used for the currently selected date.
         """
         return _calendar.CalendarCtrl_SetHighlightColours(*args, **kwargs)
 
@@ -315,7 +383,7 @@ class CalendarCtrl(core.Control):
         """
         GetHighlightColourFg(self) -> Colour
 
-        highlight colour is used for the currently selected date
+        Highlight colour is used for the currently selected date.
         """
         return _calendar.CalendarCtrl_GetHighlightColourFg(*args, **kwargs)
 
@@ -323,7 +391,7 @@ class CalendarCtrl(core.Control):
         """
         GetHighlightColourBg(self) -> Colour
 
-        highlight colour is used for the currently selected date
+        Highlight colour is used for the currently selected date.
         """
         return _calendar.CalendarCtrl_GetHighlightColourBg(*args, **kwargs)
 
@@ -331,7 +399,8 @@ class CalendarCtrl(core.Control):
         """
         SetHolidayColours(self, Colour colFg, Colour colBg)
 
-        holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is used)
+        Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is
+        used).
         """
         return _calendar.CalendarCtrl_SetHolidayColours(*args, **kwargs)
 
@@ -339,7 +408,8 @@ class CalendarCtrl(core.Control):
         """
         GetHolidayColourFg(self) -> Colour
 
-        holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is used)
+        Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is
+        used).
         """
         return _calendar.CalendarCtrl_GetHolidayColourFg(*args, **kwargs)
 
@@ -347,7 +417,8 @@ class CalendarCtrl(core.Control):
         """
         GetHolidayColourBg(self) -> Colour
 
-        holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is used)
+        Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is
+        used).
         """
         return _calendar.CalendarCtrl_GetHolidayColourBg(*args, **kwargs)
 
@@ -355,8 +426,8 @@ class CalendarCtrl(core.Control):
         """
         GetAttr(self, size_t day) -> CalendarDateAttr
 
-        Returns the attribute for the given date (should be in the range 1...31).
-        The returned value may be None
+        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)
 
@@ -364,8 +435,9 @@ class CalendarCtrl(core.Control):
         """
         SetAttr(self, 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.
+        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)
 
@@ -381,7 +453,8 @@ class CalendarCtrl(core.Control):
         """
         ResetAttr(self, size_t day)
 
-        Clears any attributes associated with the given day (in the range 1...31).
+        Clears any attributes associated with the given day (in the range
+        1...31).
         """
         return _calendar.CalendarCtrl_ResetAttr(*args, **kwargs)
 
@@ -389,14 +462,9 @@ class CalendarCtrl(core.Control):
         """
         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.
-
+        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.
         """
         return _calendar.CalendarCtrl_HitTest(*args, **kwargs)
 
@@ -404,7 +472,7 @@ class CalendarCtrl(core.Control):
         """
         GetMonthControl(self) -> Control
 
-        get the currently shown control for month
+        Get the currently shown control for month.
         """
         return _calendar.CalendarCtrl_GetMonthControl(*args, **kwargs)
 
@@ -412,17 +480,69 @@ class CalendarCtrl(core.Control):
         """
         GetYearControl(self) -> Control
 
-        get the currently shown control for year
+        Get the currently shown control for year.
         """
         return _calendar.CalendarCtrl_GetYearControl(*args, **kwargs)
 
-
-class CalendarCtrlPtr(CalendarCtrl):
-    def __init__(self, this):
-        self.this = this
-        if not hasattr(self,"thisown"): self.thisown = 0
-        self.__class__ = CalendarCtrl
-_calendar.CalendarCtrl_swigregister(CalendarCtrlPtr)
+    def GetClassDefaultAttributes(*args, **kwargs):
+        """
+        GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+        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
+        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 `wx.Window.SetWindowVariant` for more about
+        this.
+        """
+        return _calendar.CalendarCtrl_GetClassDefaultAttributes(*args, **kwargs)
+
+    GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
+    def PySetDate(self, date):
+        """takes datetime.datetime or datetime.date object"""
+        self.SetDate(_pydate2wxdate(date))
+
+    def PyGetDate(self):
+        """returns datetime.date object"""
+        return _wxdate2pydate(self.GetDate())
+
+    def PySetLowerDateLimit(self, date):
+        """takes datetime.datetime or datetime.date object"""
+        self.SetLowerDateLimit(_pydate2wxdate(date))
+
+    def PySetUpperDateLimit(self, date):
+        """takes datetime.datetime or datetime.date object"""
+        self.SetUpperDateLimit(_pydate2wxdate(date))
+
+    def PySetDateRange(self, lowerdate, upperdate):
+        """takes datetime.datetime or datetime.date objects"""
+        self.PySetLowerDateLimit(lowerdate)
+        self.PySetUpperDateLimit(upperdate)
+
+    def PyGetLowerDateLimit(self):
+        """returns datetime.date object"""
+        return _wxdate2pydate(self.GetLowerDateLimit())
+
+    def PyGetUpperDateLimit(self):
+        """returns datetime.date object"""
+        return _wxdate2pydate(self.GetUpperDateLimit())
+
+    Date = property(GetDate,SetDate,doc="See `GetDate` and `SetDate`") 
+    HeaderColourBg = property(GetHeaderColourBg,doc="See `GetHeaderColourBg`") 
+    HeaderColourFg = property(GetHeaderColourFg,doc="See `GetHeaderColourFg`") 
+    HighlightColourBg = property(GetHighlightColourBg,doc="See `GetHighlightColourBg`") 
+    HighlightColourFg = property(GetHighlightColourFg,doc="See `GetHighlightColourFg`") 
+    HolidayColourBg = property(GetHolidayColourBg,doc="See `GetHolidayColourBg`") 
+    HolidayColourFg = property(GetHolidayColourFg,doc="See `GetHolidayColourFg`") 
+    LowerDateLimit = property(GetLowerDateLimit,SetLowerDateLimit,doc="See `GetLowerDateLimit` and `SetLowerDateLimit`") 
+    MonthControl = property(GetMonthControl,doc="See `GetMonthControl`") 
+    UpperDateLimit = property(GetUpperDateLimit,SetUpperDateLimit,doc="See `GetUpperDateLimit` and `SetUpperDateLimit`") 
+    YearControl = property(GetYearControl,doc="See `GetYearControl`") 
+_calendar.CalendarCtrl_swigregister(CalendarCtrl)
 cvar = _calendar.cvar
 CalendarNameStr = cvar.CalendarNameStr
 
@@ -433,7 +553,40 @@ def PreCalendarCtrl(*args, **kwargs):
     Precreate a CalendarCtrl for 2-phase creation.
     """
     val = _calendar.new_PreCalendarCtrl(*args, **kwargs)
-    val.thisown = 1
     return val
 
+def CalendarCtrl_GetClassDefaultAttributes(*args, **kwargs):
+  """
+    CalendarCtrl_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+    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
+    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 `wx.Window.SetWindowVariant` for more about
+    this.
+    """
+  return _calendar.CalendarCtrl_GetClassDefaultAttributes(*args, **kwargs)
+
+def _pydate2wxdate(date):
+    import datetime
+    assert isinstance(date, (datetime.datetime, datetime.date))
+    tt = date.timetuple()
+    dmy = (tt[2], tt[1]-1, tt[0])
+    return wx.DateTimeFromDMY(*dmy)
+
+def _wxdate2pydate(date):
+    import datetime
+    assert isinstance(date, wx.DateTime)
+    if date.IsValid():
+        ymd = map(int, date.FormatISODate().split('-'))
+        return datetime.date(*ymd)
+    else:
+        return None
+
+