.. include:: headings.inc



.. currentmodule:: adv



.. _adv.CalendarEvent:

==========================================================================================================================================
|phoenix_title|  **CalendarEvent**
==========================================================================================================================================

The :ref:`adv.CalendarEvent`  class is used together with :ref:`adv.CalendarCtrl`.          







         



.. seealso:: :ref:`adv.CalendarCtrl`    







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **CalendarEvent**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/adv.CalendarEvent_inheritance.png" alt="Inheritance diagram of CalendarEvent" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="adv.DateEvent.html" title="This event class holds information about a date change and is used together with adv.DatePickerCtrl." alt="" coords="409,5,489,35"/> <area shape="rect" id="node7" href="adv.CalendarEvent.html" title="The adv.CalendarEvent  class is used together with adv.CalendarCtrl." alt="" coords="540,5,644,35"/> <area shape="rect" id="node2" href="CommandEvent.html" title="This event class contains information about command events, which originate from a variety of simple controls." alt="" coords="247,5,359,35"/> <area shape="rect" id="node4" href="Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="125,5,197,35"/> <area shape="rect" id="node5" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,77,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~CalendarEvent.__init__`                                                  
:meth:`~CalendarEvent.GetWeekDay`                                                Returns the week day on which the user clicked in  ``EVT_CALENDAR_WEEKDAY_CLICKED``   handler.
:meth:`~CalendarEvent.SetWeekDay`                                                Sets the week day carried by the event, normally only used by the library internally.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~CalendarEvent.WeekDay`                                                   See :meth:`~CalendarEvent.GetWeekDay` and :meth:`~CalendarEvent.SetWeekDay`
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: CalendarEvent(DateEvent)

   The CalendarEvent class is used together with CalendarCtrl.
   
   **Possible constructors**::

       CalendarEvent()
       
       CalendarEvent(win, dt, type)
       



   .. method:: __init__(self, *args, **kw)



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **__init__** `(self)`
      
      
      
      
      
      **~~~**

      
      **__init__** `(self, win, dt, type)`
      
      
      
      
      :param `win`: 
      :type `win`: Window
      :param `dt`: 
      :type `dt`: DateTime
      :param `type`: 
      :type `type`: EventType
      
      
      
      
      
      
      **~~~**






   .. method:: GetWeekDay(self)

      Returns the week day on which the user clicked in  ``EVT_CALENDAR_WEEKDAY_CLICKED``   handler.                   

      It doesn't make sense to call this function in other handlers.                  

      :rtype: `DateTime.WeekDay`








   .. method:: SetWeekDay(self, day)

      Sets the week day carried by the event, normally only used by the library internally.                  


      :param `day`: 
      :type `day`: DateTime.WeekDay







   .. attribute:: WeekDay

      See :meth:`~CalendarEvent.GetWeekDay` and :meth:`~CalendarEvent.SetWeekDay`