LibreOffice Module sw (master) 1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
sw::SwDocIdle Class Referencefinal

An Idle, which is just ready to be scheduled for idle documents. More...

#include <SwDocIdle.hxx>

Inheritance diagram for sw::SwDocIdle:
[legend]
Collaboration diagram for sw::SwDocIdle:
[legend]

Public Member Functions

 SwDocIdle (SwDoc &doc, const char *pDebugIdleName)
 
virtual ~SwDocIdle () override
 
- Public Member Functions inherited from Idle
 Idle (const char *pDebugName)
 
virtual void Start (bool bStartTimer=true) override
 
- Public Member Functions inherited from Timer
 Timer (const char *pDebugName)
 
 Timer (const Timer &rTimer)
 
virtual ~Timer () override
 
Timeroperator= (const Timer &rTimer)
 
virtual void Invoke () override
 
void Invoke (Timer *arg)
 
void SetInvokeHandler (const Link< Timer *, void > &rLink)
 
void ClearInvokeHandler ()
 
void SetTimeout (sal_uInt64 nTimeoutMs)
 
sal_uInt64 GetTimeout () const
 
virtual void Start (bool bStartTimer=true) override
 
- Public Member Functions inherited from Task
 Task (const char *pDebugName)
 
 Task (const Task &rTask)
 
virtual ~Task () COVERITY_NOEXCEPT_FALSE
 
Taskoperator= (const Task &rTask)
 
void SetPriority (TaskPriority ePriority)
 
TaskPriority GetPriority () const
 
const char * GetDebugName () const
 
virtual void Invoke ()=0
 
virtual void Start (bool bStartTimer=true)
 
void Stop ()
 
bool IsActive () const
 
void SetStatic ()
 
bool IsStatic () const
 

Private Member Functions

virtual sal_uInt64 UpdateMinPeriod (sal_uInt64 nTimeNow) const override
 

Private Attributes

SwDocm_rDoc
 

Additional Inherited Members

- Protected Member Functions inherited from Idle
virtual sal_uInt64 UpdateMinPeriod (sal_uInt64 nTimeNow) const override
 
 Idle (bool bAuto, const char *pDebugName)
 
- Protected Member Functions inherited from Timer
virtual void SetDeletionFlags () override
 
virtual sal_uInt64 UpdateMinPeriod (sal_uInt64 nTimeNow) const override
 
 Timer (bool bAuto, const char *pDebugName)
 
- Protected Member Functions inherited from Task
const ImplSchedulerDataGetSchedulerData () const
 
virtual void SetDeletionFlags ()
 
virtual sal_uInt64 UpdateMinPeriod (sal_uInt64 nTimeNow) const=0
 
- Static Protected Member Functions inherited from Task
static void StartTimer (sal_uInt64 nMS)
 

Detailed Description

An Idle, which is just ready to be scheduled for idle documents.

Currently it's missing the notification, when busy documents become idle again, so it relies on any task being triggered to recheck, which is quite probably not a problem, as busy documents have a high chance to have generated idle tasks.

Definition at line 36 of file SwDocIdle.hxx.

Constructor & Destructor Documentation

◆ SwDocIdle()

sw::SwDocIdle::SwDocIdle ( SwDoc doc,
const char *  pDebugIdleName 
)

Definition at line 51 of file SwDocIdle.cxx.

◆ ~SwDocIdle()

sw::SwDocIdle::~SwDocIdle ( )
overridevirtual

Definition at line 56 of file SwDocIdle.cxx.

Member Function Documentation

◆ UpdateMinPeriod()

sal_uInt64 sw::SwDocIdle::UpdateMinPeriod ( sal_uInt64  nTimeNow) const
overrideprivatevirtual

Member Data Documentation

◆ m_rDoc

SwDoc& sw::SwDocIdle::m_rDoc
private

Definition at line 39 of file SwDocIdle.hxx.

Referenced by UpdateMinPeriod().


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