wx.lib.pubsub.core.topicargspec.ArgSpecGiven

The message data specification (MDS) for a topic. This consists of each argument name that listener should have in its call protocol, plus which ones are required in any sendMessage(), and a documentation string for each argument. This instance will be transformed into an ArgsInfo object which is basically a superset of that information, needed to ensure that the arguments specifications satisfy pubsub policies for chosen API version.

Class Hierarchy

Inheritance diagram for class ArgSpecGiven:

Methods Summary

__init__	Initialize self. See help(type(self)) for accurate signature.
getOptional
isComplete	Returns True if the definition is usable, false otherwise.
setAll

Class API

class ArgSpecGiven

The message data specification (MDS) for a topic. This consists of each argument name that listener should have in its call protocol, plus which ones are required in any sendMessage(), and a documentation string for each argument. This instance will be transformed into an ArgsInfo object which is basically a superset of that information, needed to ensure that the arguments specifications satisfy pubsub policies for chosen API version.

Methods

__init__(self, argsDocs=None, reqdArgs=None)

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

---

getOptional(self)

---

isComplete(self)

Returns True if the definition is usable, false otherwise.

---

setAll(self, allArgsDocs, reqdArgs=None)