wxPython/src/gtk/calendar.py

   1 # This file was created automatically by SWIG.
   2 # Don't modify this file, modify the SWIG interface instead.
   3
   4 import _calendar
   5
   6 import _misc
   7 import _core
   8 wx = _core
   9 __docfilter__ = wx.__docfilter__
  10 CAL_SUNDAY_FIRST = _calendar.CAL_SUNDAY_FIRST
  11 CAL_MONDAY_FIRST = _calendar.CAL_MONDAY_FIRST
  12 CAL_SHOW_HOLIDAYS = _calendar.CAL_SHOW_HOLIDAYS
  13 CAL_NO_YEAR_CHANGE = _calendar.CAL_NO_YEAR_CHANGE
  14 CAL_NO_MONTH_CHANGE = _calendar.CAL_NO_MONTH_CHANGE
  15 CAL_SEQUENTIAL_MONTH_SELECTION = _calendar.CAL_SEQUENTIAL_MONTH_SELECTION
  16 CAL_SHOW_SURROUNDING_WEEKS = _calendar.CAL_SHOW_SURROUNDING_WEEKS
  17 CAL_HITTEST_NOWHERE = _calendar.CAL_HITTEST_NOWHERE
  18 CAL_HITTEST_HEADER = _calendar.CAL_HITTEST_HEADER
  19 CAL_HITTEST_DAY = _calendar.CAL_HITTEST_DAY
  20 CAL_HITTEST_INCMONTH = _calendar.CAL_HITTEST_INCMONTH
  21 CAL_HITTEST_DECMONTH = _calendar.CAL_HITTEST_DECMONTH
  22 CAL_HITTEST_SURROUNDING_WEEK = _calendar.CAL_HITTEST_SURROUNDING_WEEK
  23 CAL_BORDER_NONE = _calendar.CAL_BORDER_NONE
  24 CAL_BORDER_SQUARE = _calendar.CAL_BORDER_SQUARE
  25 CAL_BORDER_ROUND = _calendar.CAL_BORDER_ROUND
  26 class CalendarDateAttr(object):
  27     """
  28     A set of customization attributes for a calendar date, which can be used to
  29     control the look of the Calendar object.
  30     """
  31     def __repr__(self):
  32         return "<%s.%s; proxy of C++ wxCalendarDateAttr instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
  33     def __init__(self, *args, **kwargs):
  34         """
  35         __init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour,
  36             Colour colBorder=wxNullColour, Font font=wxNullFont,
  37             int border=CAL_BORDER_NONE) -> CalendarDateAttr
  38
  39         Create a CalendarDateAttr.
  40         """
  41         newobj = _calendar.new_CalendarDateAttr(*args, **kwargs)
  42         self.this = newobj.this
  43         self.thisown = 1
  44         del newobj.thisown
  45     def SetTextColour(*args, **kwargs):
  46         """SetTextColour(self, Colour colText)"""
  47         return _calendar.CalendarDateAttr_SetTextColour(*args, **kwargs)
  48
  49     def SetBackgroundColour(*args, **kwargs):
  50         """SetBackgroundColour(self, Colour colBack)"""
  51         return _calendar.CalendarDateAttr_SetBackgroundColour(*args, **kwargs)
  52
  53     def SetBorderColour(*args, **kwargs):
  54         """SetBorderColour(self, Colour col)"""
  55         return _calendar.CalendarDateAttr_SetBorderColour(*args, **kwargs)
  56
  57     def SetFont(*args, **kwargs):
  58         """SetFont(self, Font font)"""
  59         return _calendar.CalendarDateAttr_SetFont(*args, **kwargs)
  60
  61     def SetBorder(*args, **kwargs):
  62         """SetBorder(self, int border)"""
  63         return _calendar.CalendarDateAttr_SetBorder(*args, **kwargs)
  64
  65     def SetHoliday(*args, **kwargs):
  66         """SetHoliday(self, bool holiday)"""
  67         return _calendar.CalendarDateAttr_SetHoliday(*args, **kwargs)
  68
  69     def HasTextColour(*args, **kwargs):
  70         """HasTextColour(self) -> bool"""
  71         return _calendar.CalendarDateAttr_HasTextColour(*args, **kwargs)
  72
  73     def HasBackgroundColour(*args, **kwargs):
  74         """HasBackgroundColour(self) -> bool"""
  75         return _calendar.CalendarDateAttr_HasBackgroundColour(*args, **kwargs)
  76
  77     def HasBorderColour(*args, **kwargs):
  78         """HasBorderColour(self) -> bool"""
  79         return _calendar.CalendarDateAttr_HasBorderColour(*args, **kwargs)
  80
  81     def HasFont(*args, **kwargs):
  82         """HasFont(self) -> bool"""
  83         return _calendar.CalendarDateAttr_HasFont(*args, **kwargs)
  84
  85     def HasBorder(*args, **kwargs):
  86         """HasBorder(self) -> bool"""
  87         return _calendar.CalendarDateAttr_HasBorder(*args, **kwargs)
  88
  89     def IsHoliday(*args, **kwargs):
  90         """IsHoliday(self) -> bool"""
  91         return _calendar.CalendarDateAttr_IsHoliday(*args, **kwargs)
  92
  93     def GetTextColour(*args, **kwargs):
  94         """GetTextColour(self) -> Colour"""
  95         return _calendar.CalendarDateAttr_GetTextColour(*args, **kwargs)
  96
  97     def GetBackgroundColour(*args, **kwargs):
  98         """GetBackgroundColour(self) -> Colour"""
  99         return _calendar.CalendarDateAttr_GetBackgroundColour(*args, **kwargs)
 100
 101     def GetBorderColour(*args, **kwargs):
 102         """GetBorderColour(self) -> Colour"""
 103         return _calendar.CalendarDateAttr_GetBorderColour(*args, **kwargs)
 104
 105     def GetFont(*args, **kwargs):
 106         """GetFont(self) -> Font"""
 107         return _calendar.CalendarDateAttr_GetFont(*args, **kwargs)
 108
 109     def GetBorder(*args, **kwargs):
 110         """GetBorder(self) -> int"""
 111         return _calendar.CalendarDateAttr_GetBorder(*args, **kwargs)
 112
 113
 114 class CalendarDateAttrPtr(CalendarDateAttr):
 115     def __init__(self, this):
 116         self.this = this
 117         if not hasattr(self,"thisown"): self.thisown = 0
 118         self.__class__ = CalendarDateAttr
 119 _calendar.CalendarDateAttr_swigregister(CalendarDateAttrPtr)
 120
 121 class CalendarEvent(_core.CommandEvent):
 122     def __repr__(self):
 123         return "<%s.%s; proxy of C++ wxCalendarEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
 124     def __init__(self, *args, **kwargs):
 125         """__init__(self, CalendarCtrl cal, wxEventType type) -> CalendarEvent"""
 126         newobj = _calendar.new_CalendarEvent(*args, **kwargs)
 127         self.this = newobj.this
 128         self.thisown = 1
 129         del newobj.thisown
 130     def GetDate(*args, **kwargs):
 131         """GetDate(self) -> DateTime"""
 132         return _calendar.CalendarEvent_GetDate(*args, **kwargs)
 133
 134     def SetDate(*args, **kwargs):
 135         """SetDate(self, DateTime date)"""
 136         return _calendar.CalendarEvent_SetDate(*args, **kwargs)
 137
 138     def SetWeekDay(*args, **kwargs):
 139         """SetWeekDay(self, int wd)"""
 140         return _calendar.CalendarEvent_SetWeekDay(*args, **kwargs)
 141
 142     def GetWeekDay(*args, **kwargs):
 143         """GetWeekDay(self) -> int"""
 144         return _calendar.CalendarEvent_GetWeekDay(*args, **kwargs)
 145
 146
 147 class CalendarEventPtr(CalendarEvent):
 148     def __init__(self, this):
 149         self.this = this
 150         if not hasattr(self,"thisown"): self.thisown = 0
 151         self.__class__ = CalendarEvent
 152 _calendar.CalendarEvent_swigregister(CalendarEventPtr)
 153
 154 wxEVT_CALENDAR_DOUBLECLICKED = _calendar.wxEVT_CALENDAR_DOUBLECLICKED
 155 wxEVT_CALENDAR_SEL_CHANGED = _calendar.wxEVT_CALENDAR_SEL_CHANGED
 156 wxEVT_CALENDAR_DAY_CHANGED = _calendar.wxEVT_CALENDAR_DAY_CHANGED
 157 wxEVT_CALENDAR_MONTH_CHANGED = _calendar.wxEVT_CALENDAR_MONTH_CHANGED
 158 wxEVT_CALENDAR_YEAR_CHANGED = _calendar.wxEVT_CALENDAR_YEAR_CHANGED
 159 wxEVT_CALENDAR_WEEKDAY_CLICKED = _calendar.wxEVT_CALENDAR_WEEKDAY_CLICKED
 160 EVT_CALENDAR =                 wx.PyEventBinder( wxEVT_CALENDAR_DOUBLECLICKED, 1)
 161 EVT_CALENDAR_SEL_CHANGED =     wx.PyEventBinder( wxEVT_CALENDAR_SEL_CHANGED, 1)
 162 EVT_CALENDAR_DAY =             wx.PyEventBinder( wxEVT_CALENDAR_DAY_CHANGED, 1)
 163 EVT_CALENDAR_MONTH =           wx.PyEventBinder( wxEVT_CALENDAR_MONTH_CHANGED, 1)
 164 EVT_CALENDAR_YEAR =            wx.PyEventBinder( wxEVT_CALENDAR_YEAR_CHANGED, 1)
 165 EVT_CALENDAR_WEEKDAY_CLICKED = wx.PyEventBinder( wxEVT_CALENDAR_WEEKDAY_CLICKED, 1)
 166
 167 class CalendarCtrl(_core.Control):
 168     """The calendar control allows the user to pick a date interactively."""
 169     def __repr__(self):
 170         return "<%s.%s; proxy of C++ wxCalendarCtrl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
 171     def __init__(self, *args, **kwargs):
 172         """
 173         __init__(self, Window parent, int id=-1, DateTime date=DefaultDateTime,
 174             Point pos=DefaultPosition, Size size=DefaultSize,
 175             long style=wxCAL_SHOW_HOLIDAYS|wxWANTS_CHARS,
 176             String name=CalendarNameStr) -> CalendarCtrl
 177
 178         Create and show a calendar control.
 179         """
 180         newobj = _calendar.new_CalendarCtrl(*args, **kwargs)
 181         self.this = newobj.this
 182         self.thisown = 1
 183         del newobj.thisown
 184         self._setOORInfo(self)
 185
 186     def Create(*args, **kwargs):
 187         """
 188         Create(self, Window parent, int id, DateTime date=DefaultDateTime,
 189             Point pos=DefaultPosition, Size size=DefaultSize,
 190             long style=wxCAL_SHOW_HOLIDAYS|wxWANTS_CHARS,
 191             String name=CalendarNameStr) -> bool
 192
 193         Acutally create the GUI portion of the CalendarCtrl for 2-phase creation.
 194         """
 195         return _calendar.CalendarCtrl_Create(*args, **kwargs)
 196
 197     def SetDate(*args, **kwargs):
 198         """
 199         SetDate(self, DateTime date)
 200
 201         Sets the current date.
 202         """
 203         return _calendar.CalendarCtrl_SetDate(*args, **kwargs)
 204
 205     def GetDate(*args, **kwargs):
 206         """
 207         GetDate(self) -> DateTime
 208
 209         Gets the currently selected date.
 210         """
 211         return _calendar.CalendarCtrl_GetDate(*args, **kwargs)
 212
 213     def SetLowerDateLimit(*args, **kwargs):
 214         """
 215         SetLowerDateLimit(self, DateTime date=DefaultDateTime) -> bool
 216
 217         set the range in which selection can occur
 218         """
 219         return _calendar.CalendarCtrl_SetLowerDateLimit(*args, **kwargs)
 220
 221     def SetUpperDateLimit(*args, **kwargs):
 222         """
 223         SetUpperDateLimit(self, DateTime date=DefaultDateTime) -> bool
 224
 225         set the range in which selection can occur
 226         """
 227         return _calendar.CalendarCtrl_SetUpperDateLimit(*args, **kwargs)
 228
 229     def GetLowerDateLimit(*args, **kwargs):
 230         """
 231         GetLowerDateLimit(self) -> DateTime
 232
 233         get the range in which selection can occur
 234         """
 235         return _calendar.CalendarCtrl_GetLowerDateLimit(*args, **kwargs)
 236
 237     def GetUpperDateLimit(*args, **kwargs):
 238         """
 239         GetUpperDateLimit(self) -> DateTime
 240
 241         get the range in which selection can occur
 242         """
 243         return _calendar.CalendarCtrl_GetUpperDateLimit(*args, **kwargs)
 244
 245     def SetDateRange(*args, **kwargs):
 246         """
 247         SetDateRange(self, DateTime lowerdate=DefaultDateTime, DateTime upperdate=DefaultDateTime) -> bool
 248
 249         set the range in which selection can occur
 250         """
 251         return _calendar.CalendarCtrl_SetDateRange(*args, **kwargs)
 252
 253     def EnableYearChange(*args, **kwargs):
 254         """
 255         EnableYearChange(self, bool enable=True)
 256
 257         This function should be used instead of changing CAL_NO_YEAR_CHANGE
 258         style bit directly. It allows or disallows the user to change the year
 259         interactively.
 260         """
 261         return _calendar.CalendarCtrl_EnableYearChange(*args, **kwargs)
 262
 263     def EnableMonthChange(*args, **kwargs):
 264         """
 265         EnableMonthChange(self, bool enable=True)
 266
 267         This function should be used instead of changing CAL_NO_MONTH_CHANGE style
 268         bit. It allows or disallows the user to change the month interactively. Note
 269         that if the month can not be changed, the year can not be changed either.
 270         """
 271         return _calendar.CalendarCtrl_EnableMonthChange(*args, **kwargs)
 272
 273     def EnableHolidayDisplay(*args, **kwargs):
 274         """
 275         EnableHolidayDisplay(self, bool display=True)
 276
 277         This function should be used instead of changing CAL_SHOW_HOLIDAYS style
 278         bit directly. It enables or disables the special highlighting of the holidays.
 279         """
 280         return _calendar.CalendarCtrl_EnableHolidayDisplay(*args, **kwargs)
 281
 282     def SetHeaderColours(*args, **kwargs):
 283         """
 284         SetHeaderColours(self, Colour colFg, Colour colBg)
 285
 286         header colours are used for painting the weekdays at the top
 287         """
 288         return _calendar.CalendarCtrl_SetHeaderColours(*args, **kwargs)
 289
 290     def GetHeaderColourFg(*args, **kwargs):
 291         """
 292         GetHeaderColourFg(self) -> Colour
 293
 294         header colours are used for painting the weekdays at the top
 295         """
 296         return _calendar.CalendarCtrl_GetHeaderColourFg(*args, **kwargs)
 297
 298     def GetHeaderColourBg(*args, **kwargs):
 299         """
 300         GetHeaderColourBg(self) -> Colour
 301
 302         header colours are used for painting the weekdays at the top
 303         """
 304         return _calendar.CalendarCtrl_GetHeaderColourBg(*args, **kwargs)
 305
 306     def SetHighlightColours(*args, **kwargs):
 307         """
 308         SetHighlightColours(self, Colour colFg, Colour colBg)
 309
 310         highlight colour is used for the currently selected date
 311         """
 312         return _calendar.CalendarCtrl_SetHighlightColours(*args, **kwargs)
 313
 314     def GetHighlightColourFg(*args, **kwargs):
 315         """
 316         GetHighlightColourFg(self) -> Colour
 317
 318         highlight colour is used for the currently selected date
 319         """
 320         return _calendar.CalendarCtrl_GetHighlightColourFg(*args, **kwargs)
 321
 322     def GetHighlightColourBg(*args, **kwargs):
 323         """
 324         GetHighlightColourBg(self) -> Colour
 325
 326         highlight colour is used for the currently selected date
 327         """
 328         return _calendar.CalendarCtrl_GetHighlightColourBg(*args, **kwargs)
 329
 330     def SetHolidayColours(*args, **kwargs):
 331         """
 332         SetHolidayColours(self, Colour colFg, Colour colBg)
 333
 334         holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is used)
 335         """
 336         return _calendar.CalendarCtrl_SetHolidayColours(*args, **kwargs)
 337
 338     def GetHolidayColourFg(*args, **kwargs):
 339         """
 340         GetHolidayColourFg(self) -> Colour
 341
 342         holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is used)
 343         """
 344         return _calendar.CalendarCtrl_GetHolidayColourFg(*args, **kwargs)
 345
 346     def GetHolidayColourBg(*args, **kwargs):
 347         """
 348         GetHolidayColourBg(self) -> Colour
 349
 350         holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is used)
 351         """
 352         return _calendar.CalendarCtrl_GetHolidayColourBg(*args, **kwargs)
 353
 354     def GetAttr(*args, **kwargs):
 355         """
 356         GetAttr(self, size_t day) -> CalendarDateAttr
 357
 358         Returns the attribute for the given date (should be in the range 1...31).
 359         The returned value may be None
 360         """
 361         return _calendar.CalendarCtrl_GetAttr(*args, **kwargs)
 362
 363     def SetAttr(*args, **kwargs):
 364         """
 365         SetAttr(self, size_t day, CalendarDateAttr attr)
 366
 367         Associates the attribute with the specified date (in the range 1...31).
 368         If the attribute passed is None, the items attribute is cleared.
 369         """
 370         return _calendar.CalendarCtrl_SetAttr(*args, **kwargs)
 371
 372     def SetHoliday(*args, **kwargs):
 373         """
 374         SetHoliday(self, size_t day)
 375
 376         Marks the specified day as being a holiday in the current month.
 377         """
 378         return _calendar.CalendarCtrl_SetHoliday(*args, **kwargs)
 379
 380     def ResetAttr(*args, **kwargs):
 381         """
 382         ResetAttr(self, size_t day)
 383
 384         Clears any attributes associated with the given day (in the range 1...31).
 385         """
 386         return _calendar.CalendarCtrl_ResetAttr(*args, **kwargs)
 387
 388     def HitTest(*args, **kwargs):
 389         """
 390         HitTest(Point pos) -> (result, date, weekday)
 391
 392         Returns 3-tuple with information about the given position on the calendar
 393         control.  The first value of the tuple is a result code and determines the
 394         validity of the remaining two values.  The result codes are:
 395
 396             CAL_HITTEST_NOWHERE:    hit outside of anything
 397             CAL_HITTEST_HEADER:     hit on the header, weekday is valid
 398             CAL_HITTEST_DAY:        hit on a day in the calendar, date is set.
 399
 400         """
 401         return _calendar.CalendarCtrl_HitTest(*args, **kwargs)
 402
 403     def GetMonthControl(*args, **kwargs):
 404         """
 405         GetMonthControl(self) -> Control
 406
 407         get the currently shown control for month
 408         """
 409         return _calendar.CalendarCtrl_GetMonthControl(*args, **kwargs)
 410
 411     def GetYearControl(*args, **kwargs):
 412         """
 413         GetYearControl(self) -> Control
 414
 415         get the currently shown control for year
 416         """
 417         return _calendar.CalendarCtrl_GetYearControl(*args, **kwargs)
 418
 419
 420 class CalendarCtrlPtr(CalendarCtrl):
 421     def __init__(self, this):
 422         self.this = this
 423         if not hasattr(self,"thisown"): self.thisown = 0
 424         self.__class__ = CalendarCtrl
 425 _calendar.CalendarCtrl_swigregister(CalendarCtrlPtr)
 426 cvar = _calendar.cvar
 427 CalendarNameStr = cvar.CalendarNameStr
 428
 429 def PreCalendarCtrl(*args, **kwargs):
 430     """
 431     PreCalendarCtrl() -> CalendarCtrl
 432
 433     Precreate a CalendarCtrl for 2-phase creation.
 434     """
 435     val = _calendar.new_PreCalendarCtrl(*args, **kwargs)
 436     val.thisown = 1
 437     return val
 438
 439