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
|
.. 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.WindowDisabler:
==========================================================================================================================================
|phoenix_title| **wx.WindowDisabler**
==========================================================================================================================================
This class disables all windows of the application (may be with the exception of one of them) in its constructor and enables them back in its destructor.
This is useful when you want to indicate to the user that the application is currently busy and cannot respond to user input.
.. seealso:: :ref:`wx.BusyCursor`
|
|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>WindowDisabler</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.WindowDisabler_inheritance.png" alt="Inheritance diagram of WindowDisabler" 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.WindowDisabler.html" title="wx.WindowDisabler" alt="" coords="4,5,144,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.WindowDisabler.__init__` Disables all top level windows of the applications.
:meth:`~wx.WindowDisabler.__enter__`
:meth:`~wx.WindowDisabler.__exit__`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.WindowDisabler(object)
**Possible constructors**::
WindowDisabler(disable=True)
WindowDisabler(winToSkip)
This class disables all windows of the application (may be with the
exception of one of them) in its constructor and enables them back in
its destructor.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self, disable=True)`
Disables all top level windows of the applications.
If `disable` is ``false`` nothing is done. This can be convenient if the windows should be disabled depending on some condition.
:param `disable`:
:type `disable`: bool
.. versionadded:: 2.9.0
**~~~**
**__init__** `(self, winToSkip)`
Disables all top level windows of the applications with the exception of `winToSkip` if it is not ``None``.
Notice that under MSW if `winToSkip` appears in the taskbar, the user will be able to close the entire application (even though its main window is disabled) by right clicking on the taskbar icon and selecting the appropriate "Close" command from the context menu. To prevent this from happening you may want to use ``wx.FRAME_TOOL_WINDOW``, if applicable, or ``wx.FRAME_NO_TASKBAR`` style when creating the window that will remain enabled.
:param `winToSkip`:
:type `winToSkip`: wx.Window
**~~~**
.. method:: __enter__(self)
.. method:: __exit__(self, exc_type, exc_val, exc_tb)
|
