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
|
.. 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.EventMacroInfo:
==========================================================================================================================================
|phoenix_title| **wx.lib.evtmgr.EventMacroInfo**
==========================================================================================================================================
A class that provides information about event macros.
|
|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>EventMacroInfo</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.EventMacroInfo_inheritance.png" alt="Inheritance diagram of EventMacroInfo" 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.EventMacroInfo.html" title="wx.lib.evtmgr.EventMacroInfo" alt="" coords="5,5,211,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.evtmgr.EventMacroInfo.__init__`
:meth:`~wx.lib.evtmgr.EventMacroInfo.eventIsA` Return ``True`` if the event is one of the given
:meth:`~wx.lib.evtmgr.EventMacroInfo.getEventTypes` Return the list of event types that the given
:meth:`~wx.lib.evtmgr.EventMacroInfo.isMultiEvent` Return ``True`` if the given macro actually causes
:meth:`~wx.lib.evtmgr.EventMacroInfo.macroIsA` Return ``True`` if the macro is in the macroList.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: EventMacroInfo
A class that provides information about event macros.
.. method:: __init__(self)
.. method:: eventIsA(self, event, macroList)
Return ``True`` if the event is one of the given
macros.
.. method:: getEventTypes(self, eventMacro)
Return the list of event types that the given
macro corresponds to.
.. method:: isMultiEvent(self, macro)
Return ``True`` if the given macro actually causes
multiple events to be registered.
.. method:: macroIsA(self, macro, macroList)
Return ``True`` if the macro is in the macroList.
The added value of this method is that it takes
multi-events into account. The macroList parameter
will be coerced into a sequence if needed.
|