1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 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
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>DateEvent</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.adv.DateEvent_inheritance.png" alt="Inheritance diagram of DateEvent" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.adv.DateEvent.html" title="wx.adv.DateEvent" alt="" coords="10,237,144,267"/> <area shape="rect" id="node2" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="5,160,149,189"/> <area shape="rect" id="node3" href="wx.Event.html" title="wx.Event" alt="" coords="38,83,116,112"/> <area shape="rect" id="node4" href="wx.Object.html" title="wx.Object" alt="" coords="36,5,117,35"/> </map>
</p>
|
|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()
DateEvent(win, dt, type)
This event class holds information about a date change and is used
together with DatePickerCtrl.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
**~~~**
**__init__** `(self, win, dt, type)`
:param `win`:
:type `win`: wx.Window
:param `dt`:
:type `dt`: wx.DateTime
:param `type`:
:type `type`: wx.EventType
**~~~**
.. method:: GetDate(self)
Returns the date.
:rtype: :ref:`DateTime`
.. method:: PyGetDate(self)
Return the date as a Python datetime.date object.
.. method:: SetDate(self, date)
Sets the date carried by the event, normally only used by the library internally.
:param `date`:
:type `date`: wx.DateTime
.. attribute:: Date
See :meth:`~wx.adv.DateEvent.GetDate` and :meth:`~wx.adv.DateEvent.SetDate`
|