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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
.. 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
.. _wx.CallLater:
==========================================================================================================================================
|phoenix_title| **wx.CallLater**
==========================================================================================================================================
A convenience class for :class:`wx.Timer`, that calls the given callable
object once after the given amount of milliseconds, passing any
positional or keyword args. The return value of the callable is
available after it has been run with the :meth:`~wx.CallLater.GetResult`
method.
If you don't need to get the return value or restart the timer
then there is no need to hold a reference to this object. CallLater
maintains references to its instances while they are running. When they
finish, the internal reference is deleted and the GC is free to collect
naturally.
.. seealso::
:func:`wx.CallAfter`
|
|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>CallLater</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.CallLater_inheritance.png" alt="Inheritance diagram of CallLater" 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.CallLater.html" title="wx.CallLater" alt="" coords="5,5,104,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.CallLater.__init__` Constructs a new :class:`wx.CallLater` object.
:meth:`~wx.CallLater.GetInterval`
:meth:`~wx.CallLater.GetResult` Returns the value of the callable.
:meth:`~wx.CallLater.HasRun` Returns whether or not the callable has run.
:meth:`~wx.CallLater.IsRunning`
:meth:`~wx.CallLater.Notify` The timer has expired so call the callable.
:meth:`~wx.CallLater.SetArgs` (Re)set the args passed to the callable object. This is
:meth:`~wx.CallLater.Start` (Re)start the timer
:meth:`~wx.CallLater.Stop` Stop and destroy the timer.
:meth:`~wx.CallLater.__del__`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.CallLater.Interval` See :meth:`~wx.CallLater.GetInterval`
:attr:`~wx.CallLater.Result` See :meth:`~wx.CallLater.GetResult`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.CallLater(object)
A convenience class for :class:`wx.Timer`, that calls the given callable
object once after the given amount of milliseconds, passing any
positional or keyword args. The return value of the callable is
available after it has been run with the :meth:`~wx.CallLater.GetResult`
method.
If you don't need to get the return value or restart the timer
then there is no need to hold a reference to this object. CallLater
maintains references to its instances while they are running. When they
finish, the internal reference is deleted and the GC is free to collect
naturally.
.. seealso::
:func:`wx.CallAfter`
.. method:: __init__(self, millis, callableObj, *args, **kwargs)
Constructs a new :class:`wx.CallLater` object.
:param int millis: number of milliseconds to delay until calling the callable object
:param PyObject callableObj: the callable object
:param args: arguments to be passed to the callable object
:param kw: keywords to be passed to the callable object
.. method:: GetInterval(self)
.. method:: GetResult(self)
Returns the value of the callable.
:rtype: a Python object
:return: result from callable
.. method:: HasRun(self)
Returns whether or not the callable has run.
:rtype: bool
.. method:: IsRunning(self)
.. method:: Notify(self)
The timer has expired so call the callable.
.. method:: SetArgs(self, *args, **kwargs)
(Re)set the args passed to the callable object. This is
useful in conjunction with :meth:`Start` if
you want to schedule a new call to the same callable
object but with different parameters.
:param args: arguments to be passed to the callable object
:param kw: keywords to be passed to the callable object
.. method:: Start(self, millis=None, *args, **kwargs)
(Re)start the timer
:param int millis: number of milli seconds
:param args: arguments to be passed to the callable object
:param kw: keywords to be passed to the callable object
.. method:: Stop(self)
Stop and destroy the timer.
.. method:: __del__(self)
.. attribute:: Interval
See :meth:`~wx.CallLater.GetInterval`
.. attribute:: Result
See :meth:`~wx.CallLater.GetResult`
|
