blob: f3e2738485af8618fc592c0fbc0d487c8e9d3778 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_SW_INC_IDOCUMENTTIMERACCESS_HXX
#define INCLUDED_SW_INC_IDOCUMENTTIMERACCESS_HXX
/**
* Handle the background jobs of a Writer document.
*
* Initially it's disabled and unblocked.
*
* Jobs include:
* * grammar checking
* * field updating
* * document layouting
*/
class IDocumentTimerAccess
{
public:
/**
* Start the idle task.
*
* Depends on the block count and various document states.
*/
virtual void StartIdling() = 0;
/**
* Stop idle processing.
*/
virtual void StopIdling() = 0;
/**
* Increment block count.
*
* Prevents further background idle processing.
* This doesn't guarantee the Idle task is not currently running!
*/
virtual void BlockIdling() = 0;
/**
* Decrement block count.
*
* May re-start the idle task, if active.
*/
virtual void UnblockIdling() = 0;
/**
* Is the document ready to be processed?
*/
virtual bool IsDocIdle() const = 0;
protected:
virtual ~IDocumentTimerAccess() {};
};
#endif // INCLUDED_SW_INC_IDOCUMENTTIMERACCESS_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
