.. module:: calendar

====================
Module `wx.calendar`
====================

This module has classes for an interactive Calendar control.


Usage
=====

The following example shows a simple implementation that utilizes `wx.calendar.CalendarCtrl <wx.calendar.CalendarCtrl.html>`_::

    import  wx
    import  wx.calendar

    class TestPanel(wx.Panel):
        def __init__(self, parent, ID):

            wx.Panel.__init__(self, parent, ID)

            cal = wx.calendar.CalendarCtrl(self, -1, wx.DateTime_Now(), pos = (25, 50), 
                                           style=wx.calendar.CAL_SHOW_HOLIDAYS | wx.calendar.CAL_SUNDAY_FIRST | 
                                           wx.calendar.CAL_SEQUENTIAL_MONTH_SELECTION)

            self.cal = cal
            self.Bind(wx.calendar.EVT_CALENDAR, self.OnCalSelected, id=cal.GetId())

            # Set up control to display a set of holidays:
            self.Bind(wx.calendar.EVT_CALENDAR_MONTH, self.OnChangeMonth, cal)
            self.holidays = [(1,1), (10,31), (12,25)]    # (these don't move around)
            self.OnChangeMonth()

            cal2 = wx.calendar.CalendarCtrl(self, -1, wx.DateTime_Now(), pos = (325,50))
            self.Bind(wx.calendar.EVT_CALENDAR_SEL_CHANGED, self.OnCalSelChanged, cal2)


        def OnCalSelected(self, evt):

            print 'OnCalSelected: %s' % evt.GetDate()


        def OnChangeMonth(self, evt=None):

            cur_month = self.cal.GetDate().GetMonth() + 1   # convert wxDateTime 0-11 => 1-12
            for month, day in self.holidays:
                if month == cur_month:
                    self.cal.SetHoliday(day)

            if cur_month == 8:
                attr = wx.calendar.CalendarDateAttr(border=wx.calendar.CAL_BORDER_SQUARE, colBorder="blue")
                self.cal.SetAttr(14, attr)
            else:
                self.cal.ResetAttr(14)


        def OnCalSelChanged(self, evt):

            cal = evt.GetEventObject()
            print "OnCalSelChanged:\n\t%s: %s\n\t%s: %s\n\t%s: %s\n\t" % ("EventObject", cal, "Date       ", cal.GetDate(), 
                                                                          "Ticks      ", cal.GetDate().GetTicks())


    app = wx.App()
    frame = wx.Frame(None)
    panel = TestPanel(frame)
    frame.Show()
    app.MainLoop()


|


Module API
==========

Widgets
^^^^^^^

.. toctree::
   :maxdepth: 1
   :glob:
 
   wx.calendar.*

|

Events
^^^^^^

.. toctree::
   :maxdepth: 1
   :glob:
 
   ../Events/wx.calendar.*