.. 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

.. module:: wx.lib.pubsub.core

.. currentmodule:: wx.lib.pubsub.core

.. highlight:: python



.. _wx.lib.pubsub.core:

==========================================================================================================================================
|phoenix_title|  **wx.lib.pubsub.core**
==========================================================================================================================================

Core package of pubsub, holding the publisher, listener, and topic
object modules. Functions defined here are used internally by
pubsub so that the right modules can be found later, based on the
selected messaging protocol.

Indeed some of the API depends on the messaging
protocol used. For instance sendMessage(), defined in publisher.py,
has a different signature (and hence implementation) for the kwargs
protocol than for the arg1 protocol.

The most convenient way to
support this is to put the parts of the package that differ based
on protocol in separate folder, and add one of those folders to
the package's __path__ variable (defined automatically by the Python
interpreter when __init__.py is executed). For instance, code
specific to the kwargs protocol goes in the kwargs folder, and code
specific to the arg1 protocol in the arg1 folder. Then when doing
"from pubsub.core import listener", the correct listener.py will be
found for the specified protocol. The default protocol is kwargs.

Only one protocol can be used in an application. The default protocol,
if none is chosen by user, is kwargs, as selected by the call to
_prependModulePath() at end of this file. 

:copyright: Copyright since 2006 by Oliver Schoenborn, all rights reserved.
:license: BSD, see LICENSE_BSD_Simple.txt for details.


|module_summary| Modules Summary
================================

================================================================================ ================================================================================
:mod:`~wx.lib.pubsub.core.callables`                                             Low level functions and classes related to callables.
:mod:`~wx.lib.pubsub.core.datamsg`                                               :copyright: Copyright since 2006 by Oliver Schoenborn, all rights reserved.
:mod:`~wx.lib.pubsub.core.imp2`                                                  The _resolve_name and _import_module were taken from the backport of
:mod:`~wx.lib.pubsub.core.itopicdefnprovider`                                    
:mod:`~wx.lib.pubsub.core.listener`                                              Top-level functionality related to message listeners.
:mod:`~wx.lib.pubsub.core.listenerbase`                                          :copyright: Copyright since 2006 by Oliver Schoenborn, all rights reserved.
:mod:`~wx.lib.pubsub.core.listenerimpl`                                          :copyright: Copyright since 2006 by Oliver Schoenborn, all rights reserved.
:mod:`~wx.lib.pubsub.core.notificationmgr`                                       :copyright: Copyright since 2006 by Oliver Schoenborn, all rights reserved.
:mod:`~wx.lib.pubsub.core.publisher`                                             :copyright: Copyright since 2006 by Oliver Schoenborn, all rights reserved.
:mod:`~wx.lib.pubsub.core.publisherbase`                                         :copyright: Copyright since 2006 by Oliver Schoenborn, all rights reserved.
:mod:`~wx.lib.pubsub.core.publishermixin`                                        :copyright: Copyright since 2006 by Oliver Schoenborn, all rights reserved.
:mod:`~wx.lib.pubsub.core.topicargspec`                                          Definitions related to message data specification.
:mod:`~wx.lib.pubsub.core.topicargspecimpl`                                      :copyright: Copyright since 2006 by Oliver Schoenborn, all rights reserved.
:mod:`~wx.lib.pubsub.core.topicdefnprovider`                                     :copyright: Copyright since 2006 by Oliver Schoenborn, all rights reserved.
:mod:`~wx.lib.pubsub.core.topicexc`                                              :copyright: Copyright since 2006 by Oliver Schoenborn, all rights reserved.
:mod:`~wx.lib.pubsub.core.topicmgr`                                              Code related to the concept of topic tree and its management: creating
:mod:`~wx.lib.pubsub.core.topicmgrimpl`                                          :copyright: Copyright since 2006 by Oliver Schoenborn, all rights reserved.
:mod:`~wx.lib.pubsub.core.topicobj`                                              Provide the Topic class.
:mod:`~wx.lib.pubsub.core.topictreetraverser`                                    :copyright: Copyright since 2006 by Oliver Schoenborn, all rights reserved.
:mod:`~wx.lib.pubsub.core.topicutils`                                            Various utilities used by topic-related modules.
:mod:`~wx.lib.pubsub.core.treeconfig`                                            :copyright: Copyright since 2006 by Oliver Schoenborn, all rights reserved.
:mod:`~wx.lib.pubsub.core.validatedefnargs`                                      Some topic definition validation functions.
:mod:`~wx.lib.pubsub.core.weakmethod`                                            This module provides a basic "weak method" implementation, WeakMethod. It uses
================================================================================ ================================================================================


|


.. toctree::
   :maxdepth: 1
   :hidden:

   wx.lib.pubsub.core.callables
   wx.lib.pubsub.core.datamsg
   wx.lib.pubsub.core.imp2
   wx.lib.pubsub.core.itopicdefnprovider
   wx.lib.pubsub.core.listener
   wx.lib.pubsub.core.listenerbase
   wx.lib.pubsub.core.listenerimpl
   wx.lib.pubsub.core.notificationmgr
   wx.lib.pubsub.core.publisher
   wx.lib.pubsub.core.publisherbase
   wx.lib.pubsub.core.publishermixin
   wx.lib.pubsub.core.topicargspec
   wx.lib.pubsub.core.topicargspecimpl
   wx.lib.pubsub.core.topicdefnprovider
   wx.lib.pubsub.core.topicexc
   wx.lib.pubsub.core.topicmgr
   wx.lib.pubsub.core.topicmgrimpl
   wx.lib.pubsub.core.topicobj
   wx.lib.pubsub.core.topictreetraverser
   wx.lib.pubsub.core.topicutils
   wx.lib.pubsub.core.treeconfig
   wx.lib.pubsub.core.validatedefnargs
   wx.lib.pubsub.core.weakmethod



