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

Inheritance diagram for class _MasterTopicDefnProvider:

method_summary Methods Summary

__init__

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

addProvider

Add given provider IF not already added.

clear

Remove all providers added.

getDefn

Returns a pair (docstring, MDS) for the topic. The first item is

getNumProviders

Return how many providers added.

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.


Methods

__init__(self, treeConfig)

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



addProvider(self, provider)

Add given provider IF not already added.



clear(self)

Remove all providers added.



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.



getNumProviders(self)

Return how many providers added.



isDefined(self, topicNameTuple)

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