wx.lib.pubsub.core.topicdefnprovider.ITopicDefnDeserializer

Interface class for all topic definition de-serializers that can be accepted by TopicDefnProvider. A deserializer creates a topic tree from something such as file, module, or string.

Class Hierarchy

Inheritance diagram for class ITopicDefnDeserializer:

Known Subclasses

wx.lib.pubsub.core.topicdefnprovider.TopicDefnDeserialClass, wx.lib.pubsub.core.topicdefnprovider.TopicDefnDeserialModule, wx.lib.pubsub.core.topicdefnprovider.TopicDefnDeserialString

Methods Summary

doneIter	Called automatically by TopicDefnProvider once
getNextTopic	Get the next topic definition available from the data. The return
getTreeDoc	Get the docstring for the topic tree.
resetIter	Called by the TopicDefnProvider if it needs to

Class API

class ITopicDefnDeserializer

Interface class for all topic definition de-serializers that can be accepted by TopicDefnProvider. A deserializer creates a topic tree from something such as file, module, or string.

Methods

doneIter(self)

Called automatically by TopicDefnProvider once it considers the iteration completed. Override this only if deserializer needs to take action, such as closing a file.

---

getNextTopic(self)

Get the next topic definition available from the data. The return must be an instance of TopicDefn. Must return None when no topics are left.

---

getTreeDoc(self)

Get the docstring for the topic tree.

---

resetIter(self)

Called by the TopicDefnProvider if it needs to restart the topic iteration. Override this only if special action needed, such as resetting a file pointer to beginning of file.