.. 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.pubsub.core.topicmgr

.. highlight:: python



.. _wx.lib.pubsub.core.topicmgr._MasterTopicDefnProvider:

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

Stores a list of topic definition providers. When queried for a topic
definition, queries each provider (registered via addProvider()) and
returns the first complete definition provided, or (None,None).

The providers must follow the ITopicDefnProvider protocol.



|

|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>_MasterTopicDefnProvider</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.pubsub.core.topicmgr._MasterTopicDefnProvider_inheritance.svg" alt="Inheritance diagram of _MasterTopicDefnProvider" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.pubsub.core.topicmgr._MasterTopicDefnProvider.html" title="Stores a list of topic definition providers. When queried for a topic" alt="" coords="5,5,424,34"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.pubsub.core.topicmgr._MasterTopicDefnProvider.__init__`           Initialize self.  See help(type(self)) for accurate signature.
:meth:`~wx.lib.pubsub.core.topicmgr._MasterTopicDefnProvider.addProvider`        Add given provider IF not already added.
:meth:`~wx.lib.pubsub.core.topicmgr._MasterTopicDefnProvider.clear`              Remove all providers added.
:meth:`~wx.lib.pubsub.core.topicmgr._MasterTopicDefnProvider.getDefn`            Returns a pair (docstring, MDS) for the topic. The first item is
:meth:`~wx.lib.pubsub.core.topicmgr._MasterTopicDefnProvider.getNumProviders`    Return how many providers added.
:meth:`~wx.lib.pubsub.core.topicmgr._MasterTopicDefnProvider.isDefined`          Returns ``True`` only if a complete definition exists, ie topic
================================================================================ ================================================================================


|


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


.. class:: _MasterTopicDefnProvider

   Stores a list of topic definition providers. When queried for a topic
   definition, queries each provider (registered via addProvider()) and
   returns the first complete definition provided, or (None,None).
   
   The providers must follow the ITopicDefnProvider protocol.

   .. method:: __init__(self, treeConfig)

      Initialize self.  See help(type(self)) for accurate signature.


   .. method:: addProvider(self, provider)

      Add given provider IF not already added. 


   .. method:: clear(self)

      Remove all providers added.


   .. method:: getDefn(self, topicNameTuple)

      Returns a pair (docstring, MDS) for the topic. The first item is
      a string containing the topic's "docstring", i.e. a description string 
      for the topic, or None if no docstring available for the topic. The 
      second item is None or an instance of ArgSpecGiven specifying the
      required and optional message data for listeners of this topic. 


   .. method:: getNumProviders(self)

      Return how many providers added.


   .. method:: isDefined(self, topicNameTuple)

      Returns ``True`` only if a complete definition exists, ie topic
      has a description and a complete message data specification (MDS).