.. 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
.. currentmodule:: wx.lib.evtmgr
.. highlight:: python
.. _wx.lib.evtmgr.MessageAdapter:
==========================================================================================================================================
|phoenix_title| **wx.lib.evtmgr.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| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
MessageAdapter:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.evtmgr.MessageAdapter.__init__` Instantiate a new MessageAdapter that send wxEvents to the
:meth:`~wx.lib.evtmgr.MessageAdapter.deliverEvent`
:meth:`~wx.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)