xbmc
Public Member Functions | List of all members
KODI::WINDOWING::IOSScreenSaver Class Referenceabstract

Interface for OS screen saver control implementations. More...

#include <OSScreenSaver.h>

Inheritance diagram for KODI::WINDOWING::IOSScreenSaver:
Inheritance graph
[legend]

Public Member Functions

virtual void Inhibit ()=0
 Do not allow the OS screen saver to become active. More...
 
virtual void Uninhibit ()=0
 Allow the OS screen saver to become active again. More...
 

Detailed Description

Interface for OS screen saver control implementations.

Member Function Documentation

◆ Inhibit()

virtual void KODI::WINDOWING::IOSScreenSaver::Inhibit ( )
pure virtual

Do not allow the OS screen saver to become active.

Calling this function multiple times without calling Unhibit MUST NOT produce any side-effects.

Implemented in KODI::WINDOWING::CDummyOSScreenSaver, KODI::WINDOWING::LINUX::COSScreenSaverFreedesktop, KODI::WINDOWING::WAYLAND::COSScreenSaverIdleInhibitUnstableV1, COSScreenSaverX11, COSScreenSaverOSX, COSScreenSaverAndroid, and COSScreenSaverTVOS.

◆ Uninhibit()

virtual void KODI::WINDOWING::IOSScreenSaver::Uninhibit ( )
pure virtual

Allow the OS screen saver to become active again.

Calling this function multiple times or at all without calling Inhibit MUST NOT produce any side-effects.

Implemented in KODI::WINDOWING::CDummyOSScreenSaver, KODI::WINDOWING::LINUX::COSScreenSaverFreedesktop, KODI::WINDOWING::WAYLAND::COSScreenSaverIdleInhibitUnstableV1, COSScreenSaverX11, COSScreenSaverOSX, COSScreenSaverAndroid, and COSScreenSaverTVOS.


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