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 Acquire method can be used to do this.

Notice that currently this functionality is only implemented for MSW and macOS.

If possible, use wx.PowerResourceBlocker class to ensure that Release is called instead of calling it manually.

Base

Added in version 4.1/wxWidgets-3.1.0.

See also

wx.PowerResourceBlocker

Class Hierarchy

Inheritance diagram for class PowerResource:

Methods Summary

Acquire	Acquire a power resource for the application.
Release	Release a previously acquired power resource.

Class API

class wx.PowerResource(object)

Helper functions for acquiring and releasing the given power resource.

Methods

static Acquire(kind, reason='')

Acquire a power resource for the application.

If successful, the system will not automatically power of the screen or suspend until Release is called.

Every call to Acquire must be matched by a corresponding call to Release or the system will not suspend until the application ends, use wx.PowerResourceBlocker to ensure that this happens.

Parameters:

• kind (PowerResourceKind) – Power resource required, either POWER_RESOURCE_SCREEN or POWER_RESOURCE_SYSTEM.

• reason (string) – 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.

Return type:

bool

Returns:

Returns True if the acquisition was successful.

See also

Release

---

static Release(kind)

Release a previously acquired power resource.

Release must be called for every Acquire call made to restore normal power saving behaviour

Parameters:

kind (PowerResourceKind) – Power resource to be released.

Return type:

None

See also

Acquire