LibreOffice Module sd (master) 1
Static Public Member Functions | Static Private Member Functions | List of all members
sd::tools::IdleDetection Class Reference

Detect whether the system is idle and some time consuming operation may be carried out. More...

#include <IdleDetection.hxx>

Static Public Member Functions

static IdleState GetIdleState (const vcl::Window *pWindow)
 Determine whether the system is idle. More...
 

Static Private Member Functions

static IdleState CheckInputPending ()
 Check whether there are input events pending. More...
 
static IdleState CheckSlideShowRunning ()
 Check whether a slide show is running full screen or in a window. More...
 
static IdleState CheckWindowPainting (const vcl::Window &rWindow)
 

Detailed Description

Detect whether the system is idle and some time consuming operation may be carried out.

This class distinguishes between different states of idle-ness.

Definition at line 61 of file IdleDetection.hxx.

Member Function Documentation

◆ CheckInputPending()

IdleState sd::tools::IdleDetection::CheckInputPending ( )
staticprivate

Check whether there are input events pending.

Definition at line 43 of file IdleDetection.cxx.

References Application::AnyInput(), sd::tools::Idle, and sd::tools::SystemEventPending.

Referenced by GetIdleState().

◆ CheckSlideShowRunning()

IdleState sd::tools::IdleDetection::CheckSlideShowRunning ( )
staticprivate

◆ CheckWindowPainting()

IdleState sd::tools::IdleDetection::CheckWindowPainting ( const vcl::Window rWindow)
staticprivate

Definition at line 93 of file IdleDetection.cxx.

References sd::tools::Idle, vcl::Window::IsInPaint(), and sd::tools::WindowPainting.

Referenced by GetIdleState().

◆ GetIdleState()

IdleState sd::tools::IdleDetection::GetIdleState ( const vcl::Window pWindow)
static

Determine whether the system is idle.

Parameters
pWindowWhen a valid Window pointer is given then it is checked whether the window is currently being painting.
Returns
This method either returns IdleState::Idle or a combination of IdleStates values or-ed together that describe what the system is currently doing so that the caller can decide what to do.

Definition at line 35 of file IdleDetection.cxx.

References CheckInputPending(), CheckSlideShowRunning(), and CheckWindowPainting().

Referenced by sd::sidebar::IMPL_LINK(), and sd::slidesorter::view::ViewCacheContext::IsIdle().


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