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
|
.. 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.BusyInfo:
==========================================================================================================================================
|phoenix_title| **wx.BusyInfo**
==========================================================================================================================================
This class makes it easy to tell your user that the program is temporarily busy.
Just create a :ref:`wx.BusyInfo` object on the stack, and within the current scope, a message window will be shown.
For example:
::
wait = wx.BusyInfo("Please wait, working...")
for i in xrange(10000):
DoACalculation()
del wait
It works by creating a window in the constructor, and deleting it in the destructor.
You may also want to call TheApp.Yield() to refresh the window periodically (in case it had been obscured by other windows, for example) like this:
::
disableAll = wx.WindowDisabler()
wait = wx.BusyInfo("Please wait, working...")
for i in xrange(10000):
DoACalculation()
if i % 1000 == 0:
wx.GetApp().Yield()
del wait
but take care to not cause undesirable reentrancies when doing it (see :meth:`wx.App.Yield` for more details). The simplest way to do it is to use :ref:`wx.WindowDisabler` class as illustrated in the above example.
Note that a :ref:`wx.BusyInfo` is always built with the ``STAY_ON_TOP`` window style (see :ref:`wx.Frame` window styles for more info).
|
|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>BusyInfo</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.BusyInfo_inheritance.png" alt="Inheritance diagram of BusyInfo" 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.BusyInfo.html" title="wx.BusyInfo" alt="" coords="5,5,101,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.BusyInfo.__init__` Constructs a busy info window as child of `parent` and displays `msg` in it.
:meth:`~wx.BusyInfo.__enter__`
:meth:`~wx.BusyInfo.__exit__`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.BusyInfo(object)
**Possible constructors**::
BusyInfo(msg, parent=None)
This class makes it easy to tell your user that the program is
temporarily busy.
.. method:: __init__(self, msg, parent=None)
Constructs a busy info window as child of `parent` and displays `msg` in it.
:param `msg`:
:type `msg`: string
:param `parent`:
:type `parent`: wx.Window
.. note::
If `parent` is not ``None`` you must ensure that it is not closed while the busy info is shown.
.. method:: __enter__(self)
.. method:: __exit__(self, exc_type, exc_val, exc_tb)
|
