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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
|
.. 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
.. _wx.BusyInfoFlags:
==========================================================================================================================================
|phoenix_title| **wx.BusyInfoFlags**
==========================================================================================================================================
Parameters for :ref:`wx.BusyInfo`.
This class exists only in order to make passing attributes to :ref:`wx.BusyInfo` constructor easier and the code doing it more readable.
All methods of this class return the reference to the object on which they are called, making it possible to chain them together, e.g. typically you would just create a temporary :ref:`wx.BusyInfoFlags` object and then call the methods corresponding to the attributes you want to set, before finally passing the result to :ref:`wx.BusyInfo` constructor, e.g.: ::
info = wx.BusyInfo(
wx.BusyInfoFlags()
.Parent(window)
.Icon(icon)
.Title("Some text")
.Text("Some more text")
.Foreground(wx.Colour(...))
.Background(wx.Colour(...))
)
.. versionadded:: 4.1/wxWidgets-3.1.0
|
|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>BusyInfoFlags</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.BusyInfoFlags_inheritance.png" alt="Inheritance diagram of BusyInfoFlags" 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.BusyInfoFlags.html" title="wx.BusyInfoFlags" alt="" coords="5,5,141,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.BusyInfoFlags.__init__` Default constructor initializes all attributes to default values.
:meth:`~wx.BusyInfoFlags.Background` Sets the background colour of :ref:`wx.BusyInfo` window.
:meth:`~wx.BusyInfoFlags.Foreground` Sets the foreground colour of the title and text strings.
:meth:`~wx.BusyInfoFlags.Icon` Sets the icon to show in :ref:`wx.BusyInfo`.
:meth:`~wx.BusyInfoFlags.Label` Same as :meth:`~BusyInfoFlags.Text` but doesn't interpret the string as containing markup.
:meth:`~wx.BusyInfoFlags.Parent` Sets the parent for :ref:`wx.BusyInfo`.
:meth:`~wx.BusyInfoFlags.Text` Sets the more detailed text, shown under the title, if any.
:meth:`~wx.BusyInfoFlags.Title` Sets the title, shown prominently in :ref:`wx.BusyInfo` window.
:meth:`~wx.BusyInfoFlags.Transparency` Sets the transparency of :ref:`wx.BusyInfo` window.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.BusyInfoFlags(object)
**Possible constructors**::
BusyInfoFlags()
Parameters for BusyInfo.
.. method:: __init__(self)
Default constructor initializes all attributes to default values.
Call the other methods to really fill in the object.
.. method:: Background(self, background)
Sets the background colour of :ref:`wx.BusyInfo` window.
:param `background`:
:type `background`: wx.Colour
:rtype: :ref:`wx.BusyInfoFlags`
.. method:: Foreground(self, foreground)
Sets the foreground colour of the title and text strings.
:param `foreground`:
:type `foreground`: wx.Colour
:rtype: :ref:`wx.BusyInfoFlags`
.. method:: Icon(self, icon)
Sets the icon to show in :ref:`wx.BusyInfo`.
:param `icon`:
:type `icon`: wx.Icon
:rtype: :ref:`wx.BusyInfoFlags`
.. method:: Label(self, label)
Same as :meth:`Text` but doesn't interpret the string as containing markup.
This method should be used if the text shown in :ref:`wx.BusyInfo` comes from external source and so may contain characters having special meaning in simple markup, e.g. '<'.
:param `label`:
:type `label`: string
:rtype: :ref:`wx.BusyInfoFlags`
.. method:: Parent(self, parent)
Sets the parent for :ref:`wx.BusyInfo`.
:param `parent`:
:type `parent`: wx.Window
:rtype: :ref:`wx.BusyInfoFlags`
.. method:: Text(self, text)
Sets the more detailed text, shown under the title, if any.
The `text` string may contain markup as described in :meth:`wx.Control.SetLabelMarkup` .
:param `text`:
:type `text`: string
:rtype: :ref:`wx.BusyInfoFlags`
.. method:: Title(self, title)
Sets the title, shown prominently in :ref:`wx.BusyInfo` window.
The `title` string may contain markup as described in :meth:`wx.Control.SetLabelMarkup` .
:param `title`:
:type `title`: string
:rtype: :ref:`wx.BusyInfoFlags`
.. method:: Transparency(self, alpha)
Sets the transparency of :ref:`wx.BusyInfo` window.
:param `alpha`: Value in ``wx.ALPHA_TRANSPARENT`` (0) to ``wx.ALPHA_OPAQUE`` (255) range.
:type `alpha`: wx.Byte
:rtype: :ref:`wx.BusyInfoFlags`
.. seealso:: :meth:`wx.TopLevelWindow.SetTransparent`
|
