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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
.. 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.utils.notification
.. highlight:: python
.. _wx.lib.pubsub.utils.notification.NotifyByWriteFile:
==========================================================================================================================================
|phoenix_title| **wx.lib.pubsub.utils.notification.NotifyByWriteFile**
==========================================================================================================================================
Print a message to stdout when a notification is received.
|
|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>NotifyByWriteFile</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.utils.notification.NotifyByWriteFile_inheritance.png" alt="Inheritance diagram of NotifyByWriteFile" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.pubsub.utils.notification.NotifyByWriteFile.html" title="wx.lib.pubsub.utils.notification.NotifyByWriteFile" alt="" coords="26,83,365,112"/> <area shape="rect" id="node2" href="wx.lib.pubsub.core.notificationmgr.INotificationHandler.html" title="wx.lib.pubsub.core.notificationmgr.INotificationHandler" alt="" coords="5,5,385,35"/> </map>
</p>
</div>
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.pubsub.core.notificationmgr.INotificationHandler`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.pubsub.utils.notification.NotifyByWriteFile.__init__` Will write to stdout unless fileObj given. Will use
:meth:`~wx.lib.pubsub.utils.notification.NotifyByWriteFile.changeFile`
:meth:`~wx.lib.pubsub.utils.notification.NotifyByWriteFile.notifyDeadListener` Called when a listener has been garbage collected.
:meth:`~wx.lib.pubsub.utils.notification.NotifyByWriteFile.notifyDelTopic` Called whenever a topic is removed from topic tree.
:meth:`~wx.lib.pubsub.utils.notification.NotifyByWriteFile.notifyNewTopic` Called whenever a new topic is added to the topic tree.
:meth:`~wx.lib.pubsub.utils.notification.NotifyByWriteFile.notifySend` Called multiple times during a sendMessage: once before message
:meth:`~wx.lib.pubsub.utils.notification.NotifyByWriteFile.notifySubscribe` Called when a listener is subscribed to a topic.
:meth:`~wx.lib.pubsub.utils.notification.NotifyByWriteFile.notifyUnsubscribe` Called when a listener is unsubscribed from given topic.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: NotifyByWriteFile(INotificationHandler)
Print a message to stdout when a notification is received.
.. method:: __init__(self, fileObj = None, prefix = None)
Will write to stdout unless fileObj given. Will use
defaultPrefix as prefix for each line output, unless prefix
specified.
.. method:: changeFile(self, fileObj)
.. method:: notifyDeadListener(self, pubListener, topicObj)
Called when a listener has been garbage collected.
:param pubListener: the pubsub.core.Listener that wraps GC'd listener.
:param topicObj: the pubsub.core.Topic object it was subscribed to.
.. method:: notifyDelTopic(self, topicName)
Called whenever a topic is removed from topic tree.
:param topicName: name of topic removed.
.. method:: notifyNewTopic(self, topicObj, description, required, argsDocs)
Called whenever a new topic is added to the topic tree.
:param topicObj: the Topic object for the message.
:param description: docstring for the topic.
:param required: list of message data names (keys in argsDocs) that are required.
:param argsDocs: dictionary of all message data names, with the
corresponding docstring.
.. method:: notifySend(self, stage, topicObj, pubListener=None)
Called multiple times during a sendMessage: once before message
sending has started (pre), once for each listener about to be sent the
message, and once after all listeners have received the message (post).
:param stage: 'pre', 'post', or 'loop'.
:param topicObj: the Topic object for the message.
:param pubListener: None for pre and post stages; for loop, the listener
that is about to be sent the message.
.. method:: notifySubscribe(self, pubListener, topicObj, newSub)
Called when a listener is subscribed to a topic.
:param pubListener: the pubsub.core.Listener that wraps subscribed listener.
:param topicObj: the pubsub.core.Topic object subscribed to.
:param newSub: false if pubListener was already subscribed.
.. method:: notifyUnsubscribe(self, pubListener, topicObj)
Called when a listener is unsubscribed from given topic.
:param pubListener: the pubsub.core.Listener that wraps unsubscribed listener.
:param topicObj: the pubsub.core.Topic object unsubscribed from.
|
