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
|
.. 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.PowerResource:
==========================================================================================================================================
|phoenix_title| **wx.PowerResource**
==========================================================================================================================================
Helper functions for acquiring and releasing the given power resource.
If an application performs a long running task without user interaction it is often necessary to prevent the system from automatically suspending or powering off the screen and :meth:`~wx.PowerResource.Acquire` method can be used to do this.
Notice that currently this functionality is only implemented for MSW and macOS.
If possible, use :ref:`wx.PowerResourceBlocker` class to ensure that :meth:`~wx.PowerResource.Release` is called instead of calling it manually.
:ref:`Base` ^^<>< =''>:</>&;&;< =''>\\ </></>
.. versionadded:: 4.1/wxWidgets-3.1.0
.. seealso:: :ref:`wx.PowerResourceBlocker`
|
|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>PowerResource</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.PowerResource_inheritance.png" alt="Inheritance diagram of PowerResource" 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.PowerResource.html" title="wx.PowerResource" alt="" coords="5,5,149,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.PowerResource.Acquire` Acquire a power resource for the application.
:meth:`~wx.PowerResource.Release` Release a previously acquired power resource.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.PowerResource(object)
Helper functions for acquiring and releasing the given power resource.
.. staticmethod:: Acquire(kind, reason="")
Acquire a power resource for the application.
If successful, the system will not automatically power of the screen or suspend until :meth:`Release` is called.
Every call to Acquire **must** be matched by a corresponding call to :meth:`Release` or the system will not suspend until the application ends, use :ref:`wx.PowerResourceBlocker` to ensure that this happens.
:param `kind`: Power resource required, either ``POWER_RESOURCE_SCREEN`` or ``POWER_RESOURCE_SYSTEM``.
:type `kind`: wx.PowerResourceKind
:param `reason`: Optional reason may be specified which might be used on some platforms to inform the user what is preventing power saving. It should usually describe the operation requiring the resource and specifying it is strongly recommended.
:type `reason`: string
:rtype: `bool`
:returns:
Returns ``True`` if the acquisition was successful.
.. seealso:: :meth:`Release`
.. staticmethod:: Release(kind)
Release a previously acquired power resource.
Release **must** be called for every :meth:`Acquire` call made to restore normal power saving behaviour
:param `kind`: Power resource to be released.
:type `kind`: wx.PowerResourceKind
.. seealso:: :meth:`Acquire`
|
