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

Document statistics information. More...

#include <IDocumentStatistics.hxx>

Inheritance diagram for IDocumentStatistics:
[legend]

Public Member Functions

virtual void DocInfoChgd (bool isEnableSetModified)=0
 DocInfo has changed (notify via DocShell): make required fields update. More...
 
virtual const SwDocStatGetDocStat () const =0
 Document - Statistics. More...
 
virtual const SwDocStatGetUpdatedDocStat (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 27 of file IDocumentStatistics.hxx.

Constructor & Destructor Documentation

virtual IDocumentStatistics::~IDocumentStatistics ( )
inlineprotectedvirtual

Definition at line 62 of file IDocumentStatistics.hxx.

Member Function Documentation

virtual void IDocumentStatistics::DocInfoChgd ( bool  isEnableSetModified)
pure virtual

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

Implemented in sw::DocumentStatisticsManager.

virtual const SwDocStat& IDocumentStatistics::GetDocStat ( ) const
pure virtual
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
bCompleteAsyncif true will return a partial result, and potentially trigger a timeout to complete the work.
bFieldsif stat. fields should be updated

Implemented in sw::DocumentStatisticsManager.

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

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

Set the document statistics.

Implemented in sw::DocumentStatisticsManager.

Referenced by SwXMLImport::SetStatistics().

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

Updates the internal document's statistics.

Parameters
bCompleteAsyncif true it may do part of the work and trigger a timeout to complete it.
bFieldsif stat. fields should be updated

Implemented in sw::DocumentStatisticsManager.

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


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