LibreOffice Module sw (master)  1
Public Member Functions | Protected Member Functions | List of all members
IDocumentTimerAccess Class Referenceabstract

Handle the background jobs of a Writer document. More...

#include <IDocumentTimerAccess.hxx>

Inheritance diagram for IDocumentTimerAccess:
[legend]

Public Member Functions

virtual void StartIdling ()=0
 Start the idle task. More...
 
virtual void StopIdling ()=0
 Stop idle processing. More...
 
virtual void BlockIdling ()=0
 Increment block count. More...
 
virtual void UnblockIdling ()=0
 Decrement block count. More...
 
virtual bool IsDocIdle () const =0
 Is the document ready to be processed? More...
 

Protected Member Functions

virtual ~IDocumentTimerAccess ()
 

Detailed Description

Handle the background jobs of a Writer document.

Initially it's disabled and unblocked.

Jobs include:

Definition at line 33 of file IDocumentTimerAccess.hxx.

Constructor & Destructor Documentation

virtual IDocumentTimerAccess::~IDocumentTimerAccess ( )
inlineprotectedvirtual

Definition at line 69 of file IDocumentTimerAccess.hxx.

Member Function Documentation

virtual void IDocumentTimerAccess::BlockIdling ( )
pure virtual

Increment block count.

Prevents further background idle processing. This doesn't guarantee the Idle task is not currently running!

Implemented in sw::DocumentTimerManager.

Referenced by SwLayAction::FormatLayoutTab(), and InsertCnt_().

virtual bool IDocumentTimerAccess::IsDocIdle ( ) const
pure virtual

Is the document ready to be processed?

Implemented in sw::DocumentTimerManager.

Referenced by sw::SwDocIdle::UpdateMinPeriod().

virtual void IDocumentTimerAccess::StartIdling ( )
pure virtual

Start the idle task.

Depends on the block count and various document states.

Implemented in sw::DocumentTimerManager.

Referenced by SwRootFrame::Init(), SwDocUpdateField::SetFieldsDirty(), SwRootFrame::SetIdleFlags(), and SwRootFrame::SetNeedGrammarCheck().

virtual void IDocumentTimerAccess::StopIdling ( )
pure virtual

Stop idle processing.

Implemented in sw::DocumentTimerManager.

Referenced by SwRootFrame::Init(), and SwDoc::~SwDoc().

virtual void IDocumentTimerAccess::UnblockIdling ( )
pure virtual

Decrement block count.

May re-start the idle task, if active.

Implemented in sw::DocumentTimerManager.

Referenced by SwLayAction::FormatLayoutTab(), and InsertCnt_().


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