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

#include <ApplicationPowerHandling.h>

Inheritance diagram for CApplicationPowerHandling:

Public Member Functions
bool	IsInScreenSaver () const

bool	IsScreenSaverInhibited () const

void	ResetScreenSaver ()

void	SetScreenSaverLockFailed ()

void	SetScreenSaverUnlocked ()

void	StopScreenSaverTimer ()

const 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)

void	OnSettingChanged (const std::shared_ptr< const CSetting > &setting) override
	The value of the given setting has changed.

void	OnSettingAction (const std::shared_ptr< const CSetting > &setting) override
	The given setting has been activated.

Public Member Functions inherited from IApplicationComponent
virtual	~IApplicationComponent ()=default

Public Member Functions inherited from ISettingCallback
virtual	~ISettingCallback ()=default

virtual bool	OnSettingChanging (const std::shared_ptr< const CSetting > &setting)
	The value of the given setting is being changed.

virtual bool	OnSettingUpdate (const std::shared_ptr< CSetting > &setting, const char oldSettingId, const TiXmlNode oldSettingNode)
	The given setting needs to be updated.

virtual void	OnSettingPropertyChanged (const std::shared_ptr< const CSetting > &setting, const char *propertyName)
	The given property of the given setting has changed.

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

class	CApplicationMessageHandling

Detailed Description

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

Member Function Documentation

◆ ActivateScreenSaver()

void CApplicationPowerHandling::ActivateScreenSaver ( bool forceType = false )

protected

◆ CheckOSScreenSaverInhibitionSetting()

void CApplicationPowerHandling::CheckOSScreenSaverInhibitionSetting ( )

protected

◆ CheckScreenSaverAndDPMS()

void CApplicationPowerHandling::CheckScreenSaverAndDPMS ( )

protected

◆ CheckShutdown()

void CApplicationPowerHandling::CheckShutdown ( )

protected

◆ GetRenderGUI()

bool CApplicationPowerHandling::GetRenderGUI ( ) const

inline

◆ GlobalIdleTime()

int CApplicationPowerHandling::GlobalIdleTime ( )

◆ HandleShutdownMessage()

void CApplicationPowerHandling::HandleShutdownMessage ( )

protected

Helper method to determine how to handle TMSG_SHUTDOWN.

◆ InhibitIdleShutdown()

void CApplicationPowerHandling::InhibitIdleShutdown ( bool inhibit )

protected

◆ InhibitScreenSaver()

void CApplicationPowerHandling::InhibitScreenSaver ( bool inhibit )

protected

◆ IsDPMSActive()

bool CApplicationPowerHandling::IsDPMSActive ( ) const

inline

◆ IsIdleShutdownInhibited()

bool CApplicationPowerHandling::IsIdleShutdownInhibited ( ) const

◆ IsInScreenSaver()

bool CApplicationPowerHandling::IsInScreenSaver ( ) const

inline

◆ IsScreenSaverInhibited()

bool CApplicationPowerHandling::IsScreenSaverInhibited ( ) const

◆ NavigationIdleTime()

float CApplicationPowerHandling::NavigationIdleTime ( )

protected

◆ OnSettingAction()

void CApplicationPowerHandling::OnSettingAction ( const std::shared_ptr< const CSetting > & setting )

overridevirtual

The given setting has been activated.

This callback is triggered whenever the given setting has been activated. This callback is only fired for CSettingAction settings.

Parameters

setting The setting which has been activated.

Reimplemented from ISettingCallback.

◆ OnSettingChanged()

void CApplicationPowerHandling::OnSettingChanged ( const std::shared_ptr< const CSetting > & setting )

overridevirtual

The value of the given setting has changed.

This callback is triggered whenever the value of a setting has been successfully changed (i.e. none of the OnSettingChanging() handlers) has reverted the change.

Parameters

setting The setting whose value has been changed

Reimplemented from ISettingCallback.

◆ ResetNavigationTimer()

void CApplicationPowerHandling::ResetNavigationTimer ( )

◆ ResetScreenSaver()

void CApplicationPowerHandling::ResetScreenSaver ( )

◆ ResetScreenSaverTimer()

void CApplicationPowerHandling::ResetScreenSaverTimer ( )

protected

◆ ResetShutdownTimers()

void CApplicationPowerHandling::ResetShutdownTimers ( )

◆ ResetSystemIdleTimer()

void CApplicationPowerHandling::ResetSystemIdleTimer ( )

◆ ScreensaverIdInUse()

const std::string & CApplicationPowerHandling::ScreensaverIdInUse ( ) const

inline

◆ SetRenderGUI()

void CApplicationPowerHandling::SetRenderGUI ( bool renderGUI )

◆ SetScreenSaverLockFailed()

void CApplicationPowerHandling::SetScreenSaverLockFailed ( )

inline

◆ SetScreenSaverUnlocked()

void CApplicationPowerHandling::SetScreenSaverUnlocked ( )

inline

◆ StopScreenSaverTimer()

void CApplicationPowerHandling::StopScreenSaverTimer ( )

◆ StopShutdownTimer()

void CApplicationPowerHandling::StopShutdownTimer ( )

◆ ToggleDPMS()

bool CApplicationPowerHandling::ToggleDPMS ( bool manual )

◆ WakeUpScreenSaver()

bool CApplicationPowerHandling::WakeUpScreenSaver ( bool bPowerOffKeyPressed = false )

protected

◆ WakeUpScreenSaverAndDPMS()

bool CApplicationPowerHandling::WakeUpScreenSaverAndDPMS ( bool bPowerOffKeyPressed = false )

Todo: if screensaver lock is specified but screensaver is not active (DPMS came first), activate screensaver now.

Friends And Related Symbol Documentation

◆ CApplication

friend class CApplication

friend

◆ CApplicationMessageHandling

friend class CApplicationMessageHandling

friend

Member Data Documentation

◆ m_bInhibitIdleShutdown

bool CApplicationPowerHandling::m_bInhibitIdleShutdown = false

protected

◆ m_bInhibitScreenSaver

bool CApplicationPowerHandling::m_bInhibitScreenSaver = false

protected

◆ m_bResetScreenSaver

bool CApplicationPowerHandling::m_bResetScreenSaver = false

protected

◆ m_dpmsIsActive

bool CApplicationPowerHandling::m_dpmsIsActive = false

protected

◆ m_dpmsIsManual

bool CApplicationPowerHandling::m_dpmsIsManual = false

protected

◆ m_globalScreensaverInhibitor

KODI::WINDOWING::COSScreenSaverInhibitor CApplicationPowerHandling::m_globalScreensaverInhibitor

protected

◆ m_idleTimer

CStopWatch CApplicationPowerHandling::m_idleTimer

protected

◆ m_iScreenSaveLock

int CApplicationPowerHandling::m_iScreenSaveLock = 0

protected

◆ m_navigationTimer

CStopWatch CApplicationPowerHandling::m_navigationTimer

protected

◆ m_pythonScreenSaver

ADDON::AddonPtr CApplicationPowerHandling::m_pythonScreenSaver

protected

◆ m_renderGUI

bool CApplicationPowerHandling::m_renderGUI {false}

protected

◆ m_screensaverActive

bool CApplicationPowerHandling::m_screensaverActive = false

protected

◆ m_screensaverIdInUse

std::string CApplicationPowerHandling::m_screensaverIdInUse

protected

◆ m_screensaverInhibitor

KODI::WINDOWING::COSScreenSaverInhibitor CApplicationPowerHandling::m_screensaverInhibitor

protected

◆ m_screenSaverTimer

CStopWatch CApplicationPowerHandling::m_screenSaverTimer

protected

◆ m_shutdownTimer

CStopWatch CApplicationPowerHandling::m_shutdownTimer

protected

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Function Documentation

◆ ActivateScreenSaver()

◆ CheckOSScreenSaverInhibitionSetting()

◆ CheckScreenSaverAndDPMS()

◆ CheckShutdown()

◆ GetRenderGUI()

◆ GlobalIdleTime()

◆ HandleShutdownMessage()

◆ InhibitIdleShutdown()

◆ InhibitScreenSaver()

◆ IsDPMSActive()

◆ IsIdleShutdownInhibited()

◆ IsInScreenSaver()

◆ IsScreenSaverInhibited()

◆ NavigationIdleTime()

◆ OnSettingAction()

◆ OnSettingChanged()

◆ ResetNavigationTimer()

◆ ResetScreenSaver()

◆ ResetScreenSaverTimer()

◆ ResetShutdownTimers()

◆ ResetSystemIdleTimer()

◆ ScreensaverIdInUse()

◆ SetRenderGUI()

◆ SetScreenSaverLockFailed()

◆ SetScreenSaverUnlocked()

◆ StopScreenSaverTimer()

◆ StopShutdownTimer()

◆ ToggleDPMS()

◆ WakeUpScreenSaver()

◆ WakeUpScreenSaverAndDPMS()

Friends And Related Symbol Documentation

◆ CApplication

◆ CApplicationMessageHandling

Member Data Documentation

◆ m_bInhibitIdleShutdown

◆ m_bInhibitScreenSaver

◆ m_bResetScreenSaver

◆ m_dpmsIsActive

◆ m_dpmsIsManual

◆ m_globalScreensaverInhibitor

◆ m_idleTimer

◆ m_iScreenSaveLock

◆ m_navigationTimer

◆ m_pythonScreenSaver

◆ m_renderGUI

◆ m_screensaverActive

◆ m_screensaverIdInUse

◆ m_screensaverInhibitor

◆ m_screenSaverTimer

◆ m_shutdownTimer