IDocumentStatistics Class Reference

Document statistics information. More...

#include <IDocumentStatistics.hxx>

Inheritance diagram for IDocumentStatistics:

Public Member Functions
virtual void	DocInfoChgd (bool isEnableSetModified)=0
	DocInfo has changed (notify via DocShell): make required fields update. More...
virtual const SwDocStat &	GetDocStat () const =0
	Document - Statistics. More...
virtual const SwDocStat &	GetUpdatedDocStat (bool bCompleteAsync, bool bFields)=0
	Updates the document statistics if the document has been modified and returns a reference to the result. More...
virtual void	SetDocStat (const SwDocStat &rStat)=0
	Set the document statistics. More...
virtual void	UpdateDocStat (bool bCompleteAsync, bool bFields)=0
	Updates the internal document's statistics. More...

Protected Member Functions
virtual	~IDocumentStatistics ()

Detailed Description

Document statistics information.

Definition at line 26 of file IDocumentStatistics.hxx.

Constructor & Destructor Documentation

~IDocumentStatistics()

virtual IDocumentStatistics::~IDocumentStatistics ( )

inlineprotectedvirtual

Definition at line 60 of file IDocumentStatistics.hxx.

Member Function Documentation

DocInfoChgd()

virtual void IDocumentStatistics::DocInfoChgd ( bool  isEnableSetModified )

pure virtual

DocInfo has changed (notify via DocShell): make required fields update.

Implemented in sw::DocumentStatisticsManager.

GetDocStat()

virtual const SwDocStat & IDocumentStatistics::GetDocStat ( ) const

pure virtual

Document - Statistics.

Returns a reference to the existing document statistics

Implemented in sw::DocumentStatisticsManager.

Referenced by SwLayHelper::CalcPageCount(), SwDocStatFieldType::Expand(), SwLayIdle::isJobEnabled(), SwXMLImport::SetStatistics(), SwCalc::SwCalc(), SwLayIdle::SwLayIdle(), SwXMLWriter::Write_(), and WriteDop().

GetUpdatedDocStat()

virtual const SwDocStat & IDocumentStatistics::GetUpdatedDocStat ( bool  bCompleteAsync, bool  bFields  )

pure virtual

Updates the document statistics if the document has been modified and returns a reference to the result.

Parameters

bCompleteAsync	if true will return a partial result, and potentially trigger a timeout to complete the work.
bFields	if stat. fields should be updated

Implemented in sw::DocumentStatisticsManager.

Referenced by SwXMLExport::exportDoc(), SwXTextDocument::getPropertyValue(), SwEditShell::GetUpdatedDocStat(), SwView::StateStatusLine(), and SwDocStatPage::Update().

SetDocStat()

virtual void IDocumentStatistics::SetDocStat ( const SwDocStat &  rStat )

pure virtual

Set the document statistics.

Implemented in sw::DocumentStatisticsManager.

Referenced by SwXMLImport::SetStatistics().

UpdateDocStat()

virtual void IDocumentStatistics::UpdateDocStat ( bool  bCompleteAsync, bool  bFields  )

pure virtual

Updates the internal document's statistics.

Parameters

bCompleteAsync	if true it may do part of the work and trigger a timeout to complete it.
bFields	if stat. fields should be updated

Implemented in sw::DocumentStatisticsManager.

Referenced by SwXMLExport::exportDoc(), SwXTextFieldTypes::refresh(), and SwEditShell::UpdateDocStat().

---

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

• IDocumentStatistics.hxx