.. include:: headings.inc

.. currentmodule:: lib.evtmgr

.. highlight:: python



.. _lib.evtmgr.EventMacroInfo:

==========================================================================================================================================
|phoenix_title|  **EventMacroInfo**
==========================================================================================================================================

A class that provides information about event macros.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **EventMacroInfo**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.evtmgr.EventMacroInfo_inheritance.png" alt="Inheritance diagram of EventMacroInfo" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.evtmgr.EventMacroInfo.html" title="A class that provides information about event macros." alt="" coords="5,5,195,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~lib.evtmgr.EventMacroInfo.__init__`                                      
:meth:`~lib.evtmgr.EventMacroInfo.eventIsA`                                      Return ``True`` if the event is one of the given
:meth:`~lib.evtmgr.EventMacroInfo.getEventTypes`                                 Return the list of event types that the given
:meth:`~lib.evtmgr.EventMacroInfo.isMultiEvent`                                  Return ``True`` if the given macro actually causes
:meth:`~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.