.. 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.DateEvent:
==========================================================================================================================================
|phoenix_title| **wx.adv.DateEvent**
==========================================================================================================================================
This event class holds information about a date change and is used together with :ref:`wx.adv.DatePickerCtrl`.
It also serves as a base class for :ref:`wx.adv.CalendarEvent`.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
DateEvent:
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.adv.CalendarEvent`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.adv.DateEvent.__init__`
:meth:`~wx.adv.DateEvent.GetDate` Returns the date.
:meth:`~wx.adv.DateEvent.PyGetDate` Return the date as a Python datetime.date object.
:meth:`~wx.adv.DateEvent.SetDate` Sets the date carried by the event, normally only used by the library internally.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.adv.DateEvent.Date` See :meth:`~wx.adv.DateEvent.GetDate` and :meth:`~wx.adv.DateEvent.SetDate`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.adv.DateEvent(CommandEvent)
**Possible constructors**::
DateEvent() -> None
DateEvent(win : Window, dt : DateTime, type : EventType) -> None
This event class holds information about a date change and is used
together with DatePickerCtrl.
.. 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:: GetDate(self)
Returns the date.
:rtype: `DateTime`
.. method:: PyGetDate(self)
Return the date as a Python datetime.date object.
.. method:: SetDate(self, date : DateTime)
Sets the date carried by the event, normally only used by the library internally.
:param `date`:
:type `date`: wx.DateTime
:rtype: `None`
.. attribute:: Date
See :meth:`~wx.adv.DateEvent.GetDate` and :meth:`~wx.adv.DateEvent.SetDate`