Solid::PowerManagement

Solid::PowerManagement Namespace Reference

Enumerations

enum  SleepState { StandbyState = 1, SuspendState = 2, HibernateState = 4, HybridSuspendState = 8 }
 

Functions

bool appShouldConserveResources ()
 
int beginSuppressingScreenPowerManagement (const QString &reason=QString())
 
int beginSuppressingSleep (const QString &reason=QString())
 
Notifiernotifier ()
 
void requestSleep (SleepState state, QObject *receiver, const char *member)
 
bool stopSuppressingScreenPowerManagement (int cookie)
 
bool stopSuppressingSleep (int cookie)
 
QSet< SleepStatesupportedSleepStates ()
 

Detailed Description

This namespace allows to query the underlying system to obtain information about the hardware available.

It is the single entry point for power management. Applications should use it to control or query the power management features of the system.

Note that it's implemented as a singleton and encapsulates the backend logic.

Author
Kevin Ottens ervin[email protected]@kde[email protected].org

Enumeration Type Documentation

◆ SleepState

This enum type defines the different suspend methods.

  • StandbyState: Processes are stopped, some hardware is deactivated (ACPI S1)
  • SuspendState: Most devices are deactivated, only RAM is powered (ACPI S3)
  • HibernateState: State of the machine is saved to disk, and the machine is powered down (ACPI S4)
  • HybridSleepState: The contents of RAM are first copied to non-volatile storage like for regular hibernation, but then, instead of powering down, the computer enters sleep mode
Enumerator
HybridSuspendState 
Since
4.11

Definition at line 54 of file powermanagement.h.

Function Documentation

◆ appShouldConserveResources()

bool Solid::PowerManagement::appShouldConserveResources ( )

Retrieves a high level indication of how applications should behave according to the power management subsystem.

For example, when on battery power, this method will return true.

Returns
whether apps should conserve power

Definition at line 76 of file powermanagement.cpp.

◆ beginSuppressingScreenPowerManagement()

int Solid::PowerManagement::beginSuppressingScreenPowerManagement ( const QString reason = QString())

Tell the power management subsystem to suppress automatic screen power management until further notice.

Parameters
reasonGive a reason for not allowing screen power management, to be used in giving user feedback about why a screen power management event was prevented
Returns
a 'cookie' value representing the suppression request. Used by the power manager to track the application's outstanding suppression requests. Returns -1 if the request was denied.
Since
4.6

Definition at line 135 of file powermanagement.cpp.

◆ beginSuppressingSleep()

int Solid::PowerManagement::beginSuppressingSleep ( const QString reason = QString())

Tell the power management subsystem to suppress automatic system sleep until further notice.

Parameters
reasonGive a reason for not allowing sleep, to be used in giving user feedback about why a sleep event was prevented
Returns
a 'cookie' value representing the suppression request. Used by the power manager to track the application's outstanding suppression requests. Returns -1 if the request was denied.

Definition at line 106 of file powermanagement.cpp.

◆ requestSleep()

void Solid::PowerManagement::requestSleep ( SleepState  state,
QObject receiver,
const char *  member 
)

Requests that the system go to sleep.

Parameters
statethe sleep state use
receiverthe object to call a slot on once the operation completes
memberthe slot to call

Definition at line 86 of file powermanagement.cpp.

◆ stopSuppressingScreenPowerManagement()

bool Solid::PowerManagement::stopSuppressingScreenPowerManagement ( int  cookie)

Tell the power management that a particular screen power management suppression is no longer needed.

When no more suppressions are active, the system will be free to handle screen power management automatically

Parameters
cookieThe cookie acquired when requesting screen power management suppression
Returns
true if the suppression was stopped, false if an invalid cookie was given
Note
Since 4.8, this function also inhibits screensaver
Since
4.6

Definition at line 164 of file powermanagement.cpp.

◆ stopSuppressingSleep()

bool Solid::PowerManagement::stopSuppressingSleep ( int  cookie)

Tell the power management that a particular sleep suppression is no longer needed.

When no more suppressions are active, the system will be free to sleep automatically

Parameters
cookieThe cookie acquired when requesting sleep suppression
Returns
true if the suppression was stopped, false if an invalid cookie was given

Definition at line 125 of file powermanagement.cpp.

◆ supportedSleepStates()

QSet< Solid::PowerManagement::SleepState > Solid::PowerManagement::supportedSleepStates ( )

Retrieves the set of suspend methods supported by the system.

Returns
the suspend methods supported by this system
See also
Solid::PowerManagement::SleepState

Definition at line 81 of file powermanagement.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Feb 7 2023 04:02:03 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.