wx.lib.pubsub.utils.xmltopicdefnprovider.XmlTopicDefnProvider

All topic definition providers added via pub.addTopicDefnProvider() must have this interface. Derived classes must override the getDefn(), getTreeDoc() and topicNames() methods.

Class Hierarchy

Inheritance diagram for class XmlTopicDefnProvider:

Known Superclasses

wx.lib.pubsub.core.topicdefnprovider.ITopicDefnProvider

Methods Summary

__init__	Initialize self. See help(type(self)) for accurate signature.
getDefn	Must return a pair (string, ArgSpecGiven) for given topic.
getTreeDoc	Get the docstring for the topic tree.
topicNames	Return an iterator over topic names available from this provider.

Class API

class XmlTopicDefnProvider(ITopicDefnProvider)

All topic definition providers added via pub.addTopicDefnProvider() must have this interface. Derived classes must override the getDefn(), getTreeDoc() and topicNames() methods.

Methods

__init__(self, xml, format=TOPIC_TREE_FROM_STRING)

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

---

getDefn(self, topicNameTuple)

Must return a pair (string, ArgSpecGiven) for given topic. The first item is a description for topic, the second item contains the message data specification (MDS). Note topic name is in tuple format (‘a’, ‘b’, ‘c’) rather than ‘a.b.c’.

---

getTreeDoc(self)

Get the docstring for the topic tree.

---

topicNames(self)

Return an iterator over topic names available from this provider. Note that the topic names should be in tuple rather than dotted-string format so as to be compatible with getDefn().