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 for POWER_RESOURCE_SCREEN and these platforms and Linux for POWER_RESOURCE_SYSTEM, however the system must be using systemd 183 or later for this to work there.

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

Core

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='', blockKind=POWER_PREVENT)

Acquire a power resource for the application.

The default behaviour, chosen by setting blockKind to POWER_PREVENT, is to ensure that the resource of the corresponding kind remains accessible, i.e. prevent the system from turning off the screen or suspending.

Specifying POWER_DELAY for blockKind doesn’t actually prevent the system from suspending but does delay it to allow the application to handle the corresponding notifications. Note that under Linux systems will not receive wx.wxEVT_POWER_SUSPENDED without acquiring the system resource using POWER_DELAY.

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.

• blockKind (PowerBlockKind) – The default value corresponds to the blocking behaviour, the POWER_DELAY value can be used to avoid blocking the resource but just delay it to allow the application to handle the corresponding notifications. This parameter is available in wxWidgets 3.3.0 and later.

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