summaryrefslogtreecommitdiff
path: root/sw/inc/IDocumentTimerAccess.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'sw/inc/IDocumentTimerAccess.hxx')
-rw-r--r--sw/inc/IDocumentTimerAccess.hxx40
1 files changed, 21 insertions, 19 deletions
diff --git a/sw/inc/IDocumentTimerAccess.hxx b/sw/inc/IDocumentTimerAccess.hxx
index 6efe1a114963..1ed8679c00ac 100644
--- a/sw/inc/IDocumentTimerAccess.hxx
+++ b/sw/inc/IDocumentTimerAccess.hxx
@@ -20,42 +20,44 @@
#ifndef INCLUDED_SW_INC_IDOCUMENTTIMERACCESS_HXX
#define INCLUDED_SW_INC_IDOCUMENTTIMERACCESS_HXX
-/** Manipulate background jobs of the document. It starts with a mode of
- 'started' and a block count of 0.
+/**
+ * Handle the background job of the Writer document.
+ *
+ * Initially it's disabled and unblocked.
+ *
+ * Jobs include:
+ * * grammar checking
+ * * field updating
+ * * document layouting
*/
class IDocumentTimerAccess
{
public:
/**
- Set mode to 'start'.
- */
+ * Start the idle job depending on the block count.
+ */
virtual void StartIdling() = 0;
/**
- Set mode to 'stopped'.
- */
+ * Stop idle processing.
+ */
virtual void StopIdling() = 0;
/**
- Increment block count.
- */
+ * Increment block count.
+ *
+ * Prevents further background idle processing.
+ */
virtual void BlockIdling() = 0;
/**
- Decrement block count.
- */
+ * Decrement block count.
+ *
+ * May start the idle job.
+ */
virtual void UnblockIdling() = 0;
/**
- Do these jobs asynchronously: do grammar checking,
- do layout, and update fields.
- They will be delayed until mode is start AND block count == 0.
- The implementation might delay them further, for example
- it might wait until the application is idle.
- */
- virtual void StartBackgroundJobs() = 0;
-
- /**
* Is the document ready to be processed?
*/
virtual bool IsDocIdle() const = 0;