summaryrefslogtreecommitdiff
path: root/sw/inc/IDocumentTimerAccess.hxx
blob: 2cdb33e5ab7d281c0cde4697529fc0aff6a1182b (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
/* -*- 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

/** 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'.
    */
    virtual void StartIdling() = 0;

    /**
    Set mode to 'stopped'.
    */
    virtual void StopIdling() = 0;

    /**
    Increment block count.
    */
    virtual void BlockIdling() = 0;

    /**
    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() {};
};

#endif // INCLUDED_SW_INC_IDOCUMENTTIMERACCESS_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */