#include <DocumentTimerManager.hxx>

Inheritance diagram for sw::DocumentTimerManager:

Collaboration diagram for sw::DocumentTimerManager:

Public Types
enum class	IdleJob { None , Busy , Grammar , Layout , Fields }

Public Member Functions
	DocumentTimerManager (SwDoc &i_rSwdoc)

virtual	~DocumentTimerManager () override

void	StartIdling () override
	Start the idle task. More...

void	StopIdling () override
	Stop idle processing. More...

void	BlockIdling () override
	Increment block count. More...

void	UnblockIdling () override
	Decrement block count. More...

bool	IsDocIdle () const override
	Is the document ready to be processed? More...

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...

Private Member Functions
	DocumentTimerManager (DocumentTimerManager const &)=delete

DocumentTimerManager &	operator= (DocumentTimerManager const &)=delete

	DECL_LINK (FireIdleJobsTimeout, Timer *, void)
	Delay starting idle jobs to allow for post-load activity. More...

	DECL_LINK (DoIdleJobs, Timer *, void)

IdleJob	GetNextIdleJob () const

Private Attributes
SwDoc &	m_rDoc

sal_uInt32	m_nIdleBlockCount
	Don't run the Idle, if > 0. More...

bool	m_bStartOnUnblock
	true, if the last unblock should start the timer More...

SwDocIdle	m_aDocIdle

Timer	m_aFireIdleJobsTimer

bool	m_bWaitForLokInit
	true if we waited for LOK to initialize already. More...

Additional Inherited Members
Protected Member Functions inherited from IDocumentTimerAccess
virtual	~IDocumentTimerAccess ()

Detailed Description

Definition at line 33 of file DocumentTimerManager.hxx.

Member Enumeration Documentation

◆ IdleJob

enum class sw::DocumentTimerManager::IdleJob

strong

Enumerator
None	document has no idle jobs to do
Busy	document is busy and idle jobs are postponed
Grammar
Layout
Fields

Definition at line 36 of file DocumentTimerManager.hxx.

Constructor & Destructor Documentation

◆ DocumentTimerManager() [1/2]

sw::DocumentTimerManager::DocumentTimerManager ( SwDoc & i_rSwdoc )

Definition at line 41 of file DocumentTimerManager.cxx.

References LINK, m_aDocIdle, m_aFireIdleJobsTimer, Timer::SetInvokeHandler(), Task::SetPriority(), and Timer::SetTimeout().

◆ ~DocumentTimerManager()

sw::DocumentTimerManager::~DocumentTimerManager ( )

overridevirtual

Definition at line 230 of file DocumentTimerManager.cxx.

◆ DocumentTimerManager() [2/2]

sw::DocumentTimerManager::DocumentTimerManager ( DocumentTimerManager const & )

privatedelete

Member Function Documentation

◆ BlockIdling()

void sw::DocumentTimerManager::BlockIdling ( )

overridevirtual

Increment block count.

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

Implements IDocumentTimerAccess.

Definition at line 84 of file DocumentTimerManager.cxx.

References m_nIdleBlockCount, and SAL_MAX_UINT32.

◆ DECL_LINK() [1/2]

sw::DocumentTimerManager::DECL_LINK	(	DoIdleJobs	,
		Timer *	,
		void
	)

private

◆ DECL_LINK() [2/2]

sw::DocumentTimerManager::DECL_LINK	(	FireIdleJobsTimeout	,
		Timer *	,
		void
	)

private

Delay starting idle jobs to allow for post-load activity.

Used by LOK only.

◆ GetNextIdleJob()

DocumentTimerManager::IdleJob sw::DocumentTimerManager::GetNextIdleJob ( ) const

private

Definition at line 110 of file DocumentTimerManager.cxx.

References AUTOUPD_FIELD_AND_CHARTS, AUTOUPD_FIELD_ONLY, Busy, Fields, SfxProgress::GetActiveProgress(), SwDoc::GetAllLayouts(), IDocumentLayoutAccess::GetCurrentLayout(), IDocumentLayoutAccess::GetCurrentViewShell(), SwDoc::GetDocShell(), SwDoc::GetDocumentSettingManager(), sw::DocumentSettingManager::getFieldUpdateFlags(), SwDoc::getIDocumentFieldsAccess(), SwDoc::getIDocumentLayoutAccess(), SvtLinguConfig::GetProperty(), sw::Ring< value_type >::GetRingContainer(), IDocumentFieldsAccess::GetUpdateFields(), SwViewShell::GetViewOptions(), Grammar, SwViewShell::HasDrawViewDrag(), IDocumentFieldsAccess::IsExpFieldsLocked(), SwDocUpdateField::IsFieldsDirty(), SwDocUpdateField::IsInUpdateFields(), SwRootFrame::IsNeedGrammarCheck(), SwViewOption::IsOnlineSpell(), Layout, m_rDoc, None, SwDoc::StartGrammarChecking(), and UPN_IS_GRAMMAR_AUTO.

Referenced by IsDocIdle().

◆ IsDocIdle()

bool sw::DocumentTimerManager::IsDocIdle ( ) const

inlineoverridevirtual

Is the document ready to be processed?

Implements IDocumentTimerAccess.

Definition at line 79 of file DocumentTimerManager.hxx.

References Busy, GetNextIdleJob(), and m_nIdleBlockCount.

◆ operator=()

DocumentTimerManager & sw::DocumentTimerManager::operator= ( DocumentTimerManager const & )

privatedelete

◆ StartIdling()

void sw::DocumentTimerManager::StartIdling ( )

overridevirtual

Start the idle task.

Depends on the block count and various document states.

Implements IDocumentTimerAccess.

Definition at line 56 of file DocumentTimerManager.cxx.

References comphelper::LibreOfficeKit::isActive(), Task::IsActive(), m_aDocIdle, m_aFireIdleJobsTimer, m_bStartOnUnblock, m_bWaitForLokInit, m_nIdleBlockCount, Idle::Start(), Timer::Start(), StopIdling(), and Scheduler::Wakeup().

◆ StopIdling()

void sw::DocumentTimerManager::StopIdling ( )

overridevirtual

Stop idle processing.

Implements IDocumentTimerAccess.

Definition at line 78 of file DocumentTimerManager.cxx.

References m_aDocIdle, m_bStartOnUnblock, and Task::Stop().

Referenced by StartIdling().

◆ UnblockIdling()

void sw::DocumentTimerManager::UnblockIdling ( )

overridevirtual

Decrement block count.

May re-start the idle task, if active.

Implements IDocumentTimerAccess.

Definition at line 90 of file DocumentTimerManager.cxx.

References Task::IsActive(), m_aDocIdle, m_bStartOnUnblock, m_nIdleBlockCount, Idle::Start(), and Scheduler::Wakeup().

Member Data Documentation

◆ m_aDocIdle

SwDocIdle sw::DocumentTimerManager::m_aDocIdle

private

Definition at line 74 of file DocumentTimerManager.hxx.

Referenced by DocumentTimerManager(), StartIdling(), StopIdling(), and UnblockIdling().

◆ m_aFireIdleJobsTimer

Timer sw::DocumentTimerManager::m_aFireIdleJobsTimer

private

Definition at line 75 of file DocumentTimerManager.hxx.

Referenced by DocumentTimerManager(), and StartIdling().

◆ m_bStartOnUnblock

bool sw::DocumentTimerManager::m_bStartOnUnblock

private

true, if the last unblock should start the timer

Definition at line 73 of file DocumentTimerManager.hxx.

Referenced by StartIdling(), StopIdling(), and UnblockIdling().

◆ m_bWaitForLokInit

bool sw::DocumentTimerManager::m_bWaitForLokInit

private

true if we waited for LOK to initialize already.

Definition at line 76 of file DocumentTimerManager.hxx.

Referenced by StartIdling().

◆ m_nIdleBlockCount

sal_uInt32 sw::DocumentTimerManager::m_nIdleBlockCount

private

Don't run the Idle, if > 0.

Definition at line 72 of file DocumentTimerManager.hxx.

Referenced by BlockIdling(), IsDocIdle(), StartIdling(), and UnblockIdling().

◆ m_rDoc

SwDoc& sw::DocumentTimerManager::m_rDoc

private

Definition at line 70 of file DocumentTimerManager.hxx.

Referenced by GetNextIdleJob().

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ IdleJob

Constructor & Destructor Documentation

◆ DocumentTimerManager() [1/2]

◆ ~DocumentTimerManager()

◆ DocumentTimerManager() [2/2]

Member Function Documentation

◆ BlockIdling()

◆ DECL_LINK() [1/2]

◆ DECL_LINK() [2/2]

◆ GetNextIdleJob()

◆ IsDocIdle()

◆ operator=()

◆ StartIdling()

◆ StopIdling()

◆ UnblockIdling()

Member Data Documentation

◆ m_aDocIdle

◆ m_aFireIdleJobsTimer

◆ m_bStartOnUnblock

◆ m_bWaitForLokInit

◆ m_nIdleBlockCount

◆ m_rDoc