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
|
.. 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.PowerResourceBlocker:
==========================================================================================================================================
|phoenix_title| **wx.PowerResourceBlocker**
==========================================================================================================================================
Helper ``RAII`` class ensuring that power resources are released.
A :ref:`wx.PowerResourceBlocker` object acquires a power resource in the constructor and releases it in the destructor making it impossible to forget to release the power resource (which would prevent suspending or screen power off until the application ends).
Example: ::
blocker = wx.PowerResourceBlocker(
wx.POWER_RESOURCE_SYSTEM, "Downloading something important")
if not blocker.IsInEffect():
# If the resource could not be acquired, tell the user that he has
# to keep the system alive
wx.LogMessage("Warning: system may suspend while downloading.")
# Run an important download and the system will not suspend while downloading
for i in range(download.size()):
download.read_byte()
del blocker
# wx.POWER_RESOURCE_SYSTEM automatically released here.
:ref:`Base` ^^<>< =''>:</>&;&;< =''>\\ </></>
.. versionadded:: 4.1/wxWidgets-3.1.0
.. seealso:: :ref:`wx.PowerResource`
|
|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>PowerResourceBlocker</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.PowerResourceBlocker_inheritance.png" alt="Inheritance diagram of PowerResourceBlocker" 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.PowerResourceBlocker.html" title="wx.PowerResourceBlocker" alt="" coords="5,5,199,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.PowerResourceBlocker.__init__` Acquires the power resource.
:meth:`~wx.PowerResourceBlocker.IsInEffect` Returns whether the power resource could be acquired.
:meth:`~wx.PowerResourceBlocker.__enter__`
:meth:`~wx.PowerResourceBlocker.__exit__`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.PowerResourceBlocker(object)
**Possible constructors**::
PowerResourceBlocker(kind, reason="")
Helper ``RAII`` class ensuring that power resources are released.
.. method:: __init__(self, kind, reason="")
Acquires the power resource.
Uses the same parameters as :meth:`wx.PowerResource.Acquire` .
:param `kind`:
:type `kind`: wx.PowerResourceKind
:param `reason`:
:type `reason`: string
.. method:: IsInEffect(self)
Returns whether the power resource could be acquired.
This can be used to inform the user that the application will not prevent automatic suspending.
:rtype: `bool`
.. seealso:: :meth:`wx.PowerResource.Acquire`
.. method:: __enter__(self)
.. method:: __exit__(self, exc_type, exc_val, exc_tb)
|
