Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
KODI::WINDOWING::COSScreenSaverInhibitor Class Reference

#include <OSScreenSaver.h>

Public Member Functions

 COSScreenSaverInhibitor () noexcept
 
 COSScreenSaverInhibitor (COSScreenSaverInhibitor &&other) noexcept
 
COSScreenSaverInhibitoroperator= (COSScreenSaverInhibitor &&other) noexcept
 
 ~COSScreenSaverInhibitor () noexcept
 
void Release ()
 
bool IsActive () const
 
 operator bool () const
 

Friends

class COSScreenSaverManager
 

Detailed Description

Inhibit the OS screen saver as long as this object is alive

Destroy or call Release to stop this inhibitor from being active. The OS screen saver may still be inhibited as long as other inhibitors are active though.

Note
Make sure to release or destroy the inhibitor before the COSScreenSaverManager is destroyed

Constructor & Destructor Documentation

◆ COSScreenSaverInhibitor() [1/2]

COSScreenSaverInhibitor::COSScreenSaverInhibitor ( )
noexcept

◆ COSScreenSaverInhibitor() [2/2]

COSScreenSaverInhibitor::COSScreenSaverInhibitor ( COSScreenSaverInhibitor && other)
noexcept

◆ ~COSScreenSaverInhibitor()

COSScreenSaverInhibitor::~COSScreenSaverInhibitor ( )
noexcept

Member Function Documentation

◆ IsActive()

bool COSScreenSaverInhibitor::IsActive ( ) const

◆ operator bool()

COSScreenSaverInhibitor::operator bool ( ) const

◆ operator=()

COSScreenSaverInhibitor & COSScreenSaverInhibitor::operator= ( COSScreenSaverInhibitor && other)
noexcept

◆ Release()

void COSScreenSaverInhibitor::Release ( )

Friends And Related Symbol Documentation

◆ COSScreenSaverManager

friend class COSScreenSaverManager
friend

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