asynchronous word-count.

1 files changed, 15 insertions, 2 deletions

diff --git a/sw/inc/IDocumentStatistics.hxx b/sw/inc/IDocumentStatistics.hxx
index 4ec926a15d2c..2c5a05019ccb 100644
--- a/sw/inc/IDocumentStatistics.hxx
+++ b/sw/inc/IDocumentStatistics.hxx
@@ -35,13 +35,26 @@
 
     /** Document - Statistics
     */
+    /// Returns a reference to the existing document statistics
     virtual const SwDocStat &GetDocStat() const = 0;
 
-    virtual const SwDocStat &GetUpdatedDocStat() = 0;
+    /**
+      * Updates the document statistics if the document has been
+      * modified and returns a reference to the result.
+      * \param bCompleteAsync if true will return a partial result,
+      * and potentially trigger a timeout to complete the work.
+      */
+    virtual const SwDocStat &GetUpdatedDocStat(bool bCompleteAsync) = 0;
 
+    /// Set the document statistics
     virtual void SetDocStat(const SwDocStat& rStat) = 0;
 
-    virtual void UpdateDocStat() = 0;
+    /**
+      * Updates the internal document's statistics
+      * \param bCompleteAsync if true it may do part of the
+      * work and trigger a timeout to complete it.
+      */
+    virtual void UpdateDocStat(bool bCompleteAsync) = 0;
 
 protected:
     virtual ~IDocumentStatistics() {};