1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 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
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>ArgSpecGiven</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.lib.pubsub.core.topicargspec.ArgSpecGiven_inheritance.png" alt="Inheritance diagram of ArgSpecGiven" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.pubsub.core.topicargspec.ArgSpecGiven.html" title="wx.lib.pubsub.core.topicargspec.ArgSpecGiven" alt="" coords="5,5,323,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.pubsub.core.topicargspec.ArgSpecGiven.__init__`
: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)
.. method:: getOptional(self)
.. method:: isComplete(self)
Returns ``True`` if the definition is usable, false otherwise.
.. method:: setAll(self, allArgsDocs, reqdArgs = None)
|
