xbmc
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
CApplicationPowerHandling Class Reference

Class handling application support for screensavers, dpms and shutdown timers. More...

#include <ApplicationPowerHandling.h>

Inheritance diagram for CApplicationPowerHandling:
Inheritance graph
[legend]
Collaboration diagram for CApplicationPowerHandling:
Collaboration graph
[legend]

Public Member Functions

bool IsInScreenSaver () const
 
bool IsScreenSaverInhibited () const
 
void ResetScreenSaver ()
 
void SetScreenSaverLockFailed ()
 
void SetScreenSaverUnlocked ()
 
void StopScreenSaverTimer ()
 
std::string ScreensaverIdInUse () const
 
bool GetRenderGUI () const
 
void SetRenderGUI (bool renderGUI)
 
int GlobalIdleTime ()
 
void ResetSystemIdleTimer ()
 
bool IsIdleShutdownInhibited () const
 
void ResetShutdownTimers ()
 
void StopShutdownTimer ()
 
void ResetNavigationTimer ()
 
bool IsDPMSActive () const
 
bool ToggleDPMS (bool manual)
 
bool WakeUpScreenSaverAndDPMS (bool bPowerOffKeyPressed=false)
 
bool OnSettingChanged (const CSetting &setting)
 
bool OnSettingAction (const CSetting &setting)
 

Protected Member Functions

void ActivateScreenSaver (bool forceType=false)
 
void CheckOSScreenSaverInhibitionSetting ()
 
void CheckScreenSaverAndDPMS ()
 
void InhibitScreenSaver (bool inhibit)
 
void ResetScreenSaverTimer ()
 
bool WakeUpScreenSaver (bool bPowerOffKeyPressed=false)
 
void InhibitIdleShutdown (bool inhibit)
 
void HandleShutdownMessage ()
 Helper method to determine how to handle TMSG_SHUTDOWN.
 
void CheckShutdown ()
 
float NavigationIdleTime ()
 

Protected Attributes

bool m_renderGUI {false}
 
bool m_bInhibitScreenSaver = false
 
bool m_bResetScreenSaver = false
 
ADDON::AddonPtr m_pythonScreenSaver
 
bool m_screensaverActive = false
 
int m_iScreenSaveLock = 0
 
std::string m_screensaverIdInUse
 
bool m_dpmsIsActive = false
 
bool m_dpmsIsManual = false
 
bool m_bInhibitIdleShutdown = false
 
CStopWatch m_navigationTimer
 
CStopWatch m_shutdownTimer
 
CStopWatch m_idleTimer
 
CStopWatch m_screenSaverTimer
 
KODI::WINDOWING::COSScreenSaverInhibitor m_globalScreensaverInhibitor
 
KODI::WINDOWING::COSScreenSaverInhibitor m_screensaverInhibitor
 

Friends

class CApplication
 

Detailed Description

Class handling application support for screensavers, dpms and shutdown timers.

Member Function Documentation

◆ WakeUpScreenSaverAndDPMS()

bool CApplicationPowerHandling::WakeUpScreenSaverAndDPMS ( bool  bPowerOffKeyPressed = false)
Todo:
if screensaver lock is specified but screensaver is not active (DPMS came first), activate screensaver now.

The documentation for this class was generated from the following files: