Solid
Classes | |
class | Notifier |
Enumerations | |
enum | SleepState { StandbyState = 1, SuspendState = 2, HibernateState = 4 } |
Functions | |
SOLID_EXPORT bool | appShouldConserveResources () |
SOLID_EXPORT int | beginSuppressingScreenPowerManagement (const QString &reason=QString()) |
SOLID_EXPORT int | beginSuppressingSleep (const QString &reason=QString()) |
SOLID_EXPORT Notifier * | notifier () |
SOLID_EXPORT void | requestSleep (SleepState state, QObject *receiver, const char *member) |
SOLID_EXPORT bool | stopSuppressingScreenPowerManagement (int cookie) |
SOLID_EXPORT bool | stopSuppressingSleep (int cookie) |
SOLID_EXPORT QSet< SleepState > | supportedSleepStates () |
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.
Enumeration Type Documentation
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)
Enumerator | |
---|---|
StandbyState | |
SuspendState | |
HibernateState |
Definition at line 51 of file powermanagement.h.
Function Documentation
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 75 of file powermanagement.cpp.
int Solid::PowerManagement::beginSuppressingScreenPowerManagement | ( | const QString & | reason = QString() | ) |
Tell the power management subsystem to suppress automatic screen power management until further notice.
- Parameters
-
reason Give 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.
int Solid::PowerManagement::beginSuppressingSleep | ( | const QString & | reason = QString() | ) |
Tell the power management subsystem to suppress automatic system sleep until further notice.
- Parameters
-
reason Give 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 107 of file powermanagement.cpp.
Solid::PowerManagement::Notifier * Solid::PowerManagement::notifier | ( | ) |
Definition at line 187 of file powermanagement.cpp.
void Solid::PowerManagement::requestSleep | ( | SleepState | state, |
QObject * | receiver, | ||
const char * | member | ||
) |
Requests that the system goes to sleep.
- Parameters
-
state the sleep state use receiver the object to call a slot on once the operation completes member the slot to call
Definition at line 85 of file powermanagement.cpp.
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
-
cookie The 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 inhibites screensaver
- Since
- 4.6
Definition at line 166 of file powermanagement.cpp.
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
-
cookie The 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.
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::PowerManager::SuspendMethod
- Solid::PowerManager::SuspendMethods
Definition at line 80 of file powermanagement.cpp.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Wed Mar 20 2013 07:16:29 by doxygen 1.8.3.1 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.