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 184
|
.. 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.PyCommandEvent:
==========================================================================================================================================
|phoenix_title| **wx.PyCommandEvent**
==========================================================================================================================================
:class:`PyCommandEvent` can be used as a base class for implementing
custom event types in Python. You should derive from this class
instead of :class:`CommandEvent` because this class is Python-aware
and is able to transport its Python bits safely through the
wxWidgets event system and have them still be there when the
event handler is invoked. Note that since :class:`PyCommandEvent` is
taking care of preserving the extra attributes that have been set
then you do not need to override the Clone method in your
derived classes.
.. seealso:: :class:`PyEvent`
|
|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>PyCommandEvent</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.PyCommandEvent_inheritance.png" alt="Inheritance diagram of PyCommandEvent" 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.PyCommandEvent.html" title="wx.PyCommandEvent" alt="" coords="4,5,163,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.PyCommandEvent.__init__`
:meth:`~wx.PyCommandEvent.Clone` Make a new instance of the event that is a copy of self.
:meth:`~wx.PyCommandEvent.__delattr__`
:meth:`~wx.PyCommandEvent.__getattr__`
:meth:`~wx.PyCommandEvent.__setattr__`
:meth:`~wx.PyCommandEvent._getAttrDict` Gives access to the internal object that is tracking the event's python attributes.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.PyCommandEvent(CommandEvent)
**Possible constructors**::
PyCommandEvent(eventType=wxEVT_NULL, id=0)
:class:`PyCommandEvent` can be used as a base class for implementing
custom event types in Python. You should derive from this class
instead of :class:`CommandEvent` because this class is Python-aware
and is able to transport its Python bits safely through the
wxWidgets event system and have them still be there when the
event handler is invoked. Note that since :class:`PyCommandEvent` is
taking care of preserving the extra attributes that have been set
then you do not need to override the Clone method in your
derived classes.
.. seealso:: :class:`PyEvent`
.. method:: __init__(self, eventType=wxEVT_NULL, id=0)
:param `eventType`:
:type `eventType`: wx.EventType
:param `id`:
:type `id`: int
.. method:: Clone(self)
Make a new instance of the event that is a copy of self.
Through the magic of Python this implementation should work for
this and all derived classes.
.. method:: __delattr__(self, name)
:param `name`:
:type `name`: PyObject
.. method:: __getattr__(self, name)
:param `name`:
:type `name`: PyObject
:rtype: :ref:`PyObject`
.. method:: __setattr__(self, name, value)
:param `name`:
:type `name`: PyObject
:param `value`:
:type `value`: PyObject
.. method:: _getAttrDict(self)
Gives access to the internal object that is tracking the event's python attributes.
:rtype: :ref:`PyObject`
|