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.hxx20
1 files changed, 15 insertions, 5 deletions
diff --git a/sw/inc/IDocumentTimerAccess.hxx b/sw/inc/IDocumentTimerAccess.hxx
index 84e3cd4e1a86..b2229f9a90e3 100644
--- a/sw/inc/IDocumentTimerAccess.hxx
+++ b/sw/inc/IDocumentTimerAccess.hxx
@@ -20,31 +20,41 @@
#ifndef IDOCUMENTTIMERACCESS_HXX_INCLUDED
#define IDOCUMENTTIMERACCESS_HXX_INCLUDED
- /** Get information about the current document state
+ /** Manipulate background jobs of the document. It starts with a mode of
+ 'started' and a block count of 0.
*/
class IDocumentTimerAccess
{
public:
/**
- Set modus to start, i.e. start timer if block count == 0
+ Set modus to 'start'.
*/
virtual void StartIdling() = 0;
/**
- Set modus to stopped, i.e. stop timer if running
+ Set mode to 'stopped'.
*/
virtual void StopIdling() = 0;
/**
- Increment block count, stop timer if running
+ Increment block count.
*/
virtual void BlockIdling() = 0;
/**
- Decrement block count, start timer if block count == 0 AND modus == start
+ Decrement block count.
*/
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;
+
protected:
virtual ~IDocumentTimerAccess() {};
};