.. 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.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

Inheritance diagram for class
PyCommandEvent:
|
|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: EventType=wxEVT_NULL, id: int=0) -> None
: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: EventType=wxEVT_NULL, id: int=0)
:param `eventType`:
:type `eventType`: wx.EventType
:param `id`:
:type `id`: int
:rtype: `None`
.. 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 : Any)
:param `name`:
:type `name`: PyObject
:rtype: `None`
.. method:: __getattr__(self, name : Any)
:param `name`:
:type `name`: PyObject
:rtype: `Any`
.. method:: __setattr__(self, name : Any, value : Any)
:param `name`:
:type `name`: PyObject
:param `value`:
:type `value`: PyObject
:rtype: `None`
.. method:: _getAttrDict(self)
Gives access to the internal object that is tracking the event's python attributes.
:rtype: `Any`