.. include:: headings.inc

.. currentmodule:: lib.evtmgr

.. highlight:: python



.. _lib.evtmgr.MessageAdapter:

==========================================================================================================================================
|phoenix_title|  **MessageAdapter**
==========================================================================================================================================

A class that adapts incoming Publish/Subscribe messages
to wxWindows event calls.

This class works opposite the EventAdapter, and
retrieves the information an EventAdapter has sent in a message.
Strictly speaking, this class is not required: Event listeners
could pull the original wxEvent object out of the PS Message
themselves.

However, by pairing an instance of this class with each wxEvent
handler, the handlers can use the standard API: they receive an
event as a parameter.



|

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

Inheritance diagram for class **MessageAdapter**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.evtmgr.MessageAdapter_inheritance.png" alt="Inheritance diagram of MessageAdapter" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.evtmgr.MessageAdapter.html" title="A class that adapts incoming Publish/Subscribe messages" alt="" coords="5,5,203,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~lib.evtmgr.MessageAdapter.__init__`                                      Instantiate a new MessageAdapter that send wxEvents to the
:meth:`~lib.evtmgr.MessageAdapter.deliverEvent`                                  
:meth:`~lib.evtmgr.MessageAdapter.Destroy`                                       
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: MessageAdapter

   A class that adapts incoming Publish/Subscribe messages
   to wxWindows event calls.
   
   This class works opposite the EventAdapter, and
   retrieves the information an EventAdapter has sent in a message.
   Strictly speaking, this class is not required: Event listeners
   could pull the original wxEvent object out of the PS Message
   themselves.
   
   However, by pairing an instance of this class with each wxEvent
   handler, the handlers can use the standard API: they receive an
   event as a parameter.

   .. method:: __init__(self, eventHandler, topicPattern)

      Instantiate a new MessageAdapter that send wxEvents to the
      given eventHandler.


   .. method:: deliverEvent(self, message)


   .. method:: Destroy(self)