summaryrefslogtreecommitdiff
path: root/sw/inc/IDocumentTimerAccess.hxx
diff options
context:
space:
mode:
authorJan-Marek Glogowski <glogow@fbihome.de>2018-08-17 23:10:00 +0200
committerJan-Marek Glogowski <glogow@fbihome.de>2018-08-20 09:35:59 +0200
commit401cba4c20fbc930f034168872642428d7459218 (patch)
tree755ac9d0efcb9cb805a84f594e5cf837c018b987 /sw/inc/IDocumentTimerAccess.hxx
parent35a254750392dcd738481f5d6e8719cee9fb41b3 (diff)
tdf#116370 cleanup Writer idle job handing
This prevents the start of the idle job, while processing itself, so the fixed WinSalInstance::AnyInput of commit 3bf6c97029d2 ("tdf#112975 WIN correctly handle VclInputFlags::OTHER") won't report the timer events of the re-started idle job to process. Fixes the early abort of the background job, which resulted in the busy loop of the reported bug and this strange printing behaviour. P.S. I'm not sure, why this was just broken on Windows. Change-Id: I6503dcd925c9a0ed843e794a31eea32a4a4b2889 Reviewed-on: https://gerrit.libreoffice.org/59279 Tested-by: Jenkins Reviewed-by: Jan-Marek Glogowski <glogow@fbihome.de>
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;