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
|
.. 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
.. currentmodule:: wx.lib.evtmgr
.. highlight:: python
.. _wx.lib.evtmgr.EventManager:
==========================================================================================================================================
|phoenix_title| **wx.lib.evtmgr.EventManager**
==========================================================================================================================================
This is the main class in the module, and is the only class that
the application programmer needs to use. There is a pre-created
instance of this class called 'eventManager'. It should not be
necessary to create other instances.
|
|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>EventManager</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.lib.evtmgr.EventManager_inheritance.png" alt="Inheritance diagram of EventManager" 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.lib.evtmgr.EventManager.html" title="wx.lib.evtmgr.EventManager" alt="" coords="5,5,205,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.evtmgr.EventManager.__init__`
:meth:`~wx.lib.evtmgr.EventManager.DeregisterDeadTopics` Deregister any entries relating to dead
:meth:`~wx.lib.evtmgr.EventManager.DeregisterListener` Deregister all event notifications for the given listener.
:meth:`~wx.lib.evtmgr.EventManager.DeregisterWindow` Deregister all events coming from the given window.
:meth:`~wx.lib.evtmgr.EventManager.GetDeadTopics` Return a list of topics relating to dead wxPython
:meth:`~wx.lib.evtmgr.EventManager.GetStats` Return a dictionary with data about my state.
:meth:`~wx.lib.evtmgr.EventManager.Register` Registers a listener function (or any callable object) to
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: EventManager
This is the main class in the module, and is the only class that
the application programmer needs to use. There is a pre-created
instance of this class called 'eventManager'. It should not be
necessary to create other instances.
.. method:: __init__(self)
.. method:: DeregisterDeadTopics(self)
Deregister any entries relating to dead
wxPython objects. Not sure if this is an
important issue; 1) My app code always de-registers
listeners it doesn't need. 2) I don't think
that lingering references to these dead objects
is a problem.
.. method:: DeregisterListener(self, listener)
Deregister all event notifications for the given listener.
.. method:: DeregisterWindow(self, win)
Deregister all events coming from the given window.
.. method:: GetDeadTopics(self)
Return a list of topics relating to dead wxPython
objects.
.. method:: GetStats(self)
Return a dictionary with data about my state.
.. method:: Register(self, listener, event, source=None, win=None, id=None)
Registers a listener function (or any callable object) to
receive events of type event coming from the source window.
For example::
eventManager.Register(self.OnButton, EVT_BUTTON, theButton)
Alternatively, the specific window where the event is
delivered, and/or the ID of the event source can be specified.
For example::
eventManager.Register(self.OnButton, EVT_BUTTON, win=self, id=ID_BUTTON)
or::
eventManager.Register(self.OnButton, EVT_BUTTON, theButton, self)
|