.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.adv.CalendarEvent:
==========================================================================================================================================
|phoenix_title| **wx.adv.CalendarEvent**
==========================================================================================================================================
The :ref:`wx.adv.CalendarEvent` class is used together with :ref:`wx.adv.CalendarCtrl`.
.. seealso:: :ref:`wx.adv.CalendarCtrl`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
CalendarEvent:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.adv.CalendarEvent.__init__`
:meth:`~wx.adv.CalendarEvent.GetWeekDay` Returns the week day on which the user clicked in ``EVT_CALENDAR_WEEKDAY_CLICKED`` handler.
:meth:`~wx.adv.CalendarEvent.SetWeekDay` Sets the week day carried by the event, normally only used by the library internally.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.adv.CalendarEvent.WeekDay` See :meth:`~wx.adv.CalendarEvent.GetWeekDay` and :meth:`~wx.adv.CalendarEvent.SetWeekDay`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.adv.CalendarEvent(DateEvent)
**Possible constructors**::
CalendarEvent() -> None
CalendarEvent(win : Window, dt : DateTime, type : EventType) -> None
The CalendarEvent class is used together with CalendarCtrl.
.. method:: __init__(self, *args, **kw)
|overload| **Overloaded Implementations:**
:html:`
`
**__init__** `(self)`
:rtype: `None`
:html:`
`
**__init__** `(self, win : Window, dt : DateTime, type : EventType)`
:param `win`:
:type `win`: wx.Window
:param `dt`:
:type `dt`: wx.DateTime
:param `type`:
:type `type`: wx.EventType
:rtype: `None`
:html:`
`
.. 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 : DateTime.WeekDay)
Sets the week day carried by the event, normally only used by the library internally.
:param `day`:
:type `day`: DateTime.WeekDay
:rtype: `None`
.. attribute:: WeekDay
See :meth:`~wx.adv.CalendarEvent.GetWeekDay` and :meth:`~wx.adv.CalendarEvent.SetWeekDay`