.. 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.topicargspec
.. highlight:: python
.. _wx.lib.pubsub.core.topicargspec.ArgSpecGiven:
==========================================================================================================================================
|phoenix_title| **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| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
ArgSpecGiven:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.pubsub.core.topicargspec.ArgSpecGiven.__init__` Initialize self. See help(type(self)) for accurate signature.
:meth:`~wx.lib.pubsub.core.topicargspec.ArgSpecGiven.getOptional`
:meth:`~wx.lib.pubsub.core.topicargspec.ArgSpecGiven.isComplete` Returns ``True`` if the definition is usable, false otherwise.
:meth:`~wx.lib.pubsub.core.topicargspec.ArgSpecGiven.setAll`
================================================================================ ================================================================================
|
|api| 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.
.. method:: __init__(self, argsDocs=None, reqdArgs=None)
Initialize self. See help(type(self)) for accurate signature.
.. method:: getOptional(self)
.. method:: isComplete(self)
Returns ``True`` if the definition is usable, false otherwise.
.. method:: setAll(self, allArgsDocs, reqdArgs = None)