summaryrefslogtreecommitdiff
path: root/sw/source/core/inc/DocumentTimerManager.hxx
blob: c2e923dc6543df46fb935315b77c9ed69936bfac (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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/* -*- 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_SOURCE_CORE_INC_DOCUMENTTIMERMANAGER_HXX
#define INCLUDED_SW_SOURCE_CORE_INC_DOCUMENTTIMERMANAGER_HXX

#include <IDocumentTimerAccess.hxx>
#include <SwDocIdle.hxx>

#include <vcl/idle.hxx>
#include <sal/types.h>
#include <tools/link.hxx>

class SwDoc;

namespace sw
{

class DocumentTimerManager : public IDocumentTimerAccess
{
public:
    enum class IdleJob
    {
        None, ///< document has no idle jobs to do
        Busy, ///< document is busy and idle jobs are postponed
        Grammar,
        Layout,
        Fields,
    };

    DocumentTimerManager( SwDoc& i_rSwdoc );
    virtual ~DocumentTimerManager() override;

    void StartIdling() override;

    void StopIdling() override;

    void BlockIdling() override;

    void UnblockIdling() override;

    void StartBackgroundJobs() override;

    /// Delay starting idle jobs to allow for post-load activity.
    /// Used by LOK only.
    DECL_LINK( FireIdleJobsTimeout, Timer *, void );

    bool IsDocIdle() const override;

private:
    DocumentTimerManager(DocumentTimerManager const&) = delete;
    DocumentTimerManager& operator=(DocumentTimerManager const&) = delete;

    DECL_LINK( DoIdleJobs, Timer *, void );

    IdleJob GetNextIdleJob() const;

    SwDoc& m_rDoc;

    bool mbStartIdleTimer; //< idle timer mode start/stop
    sal_Int32 mIdleBlockCount;
    SwDocIdle maDocIdle;
    Timer maFireIdleJobsTimer;
};

inline bool DocumentTimerManager::IsDocIdle() const
{
    return( GetNextIdleJob() != IdleJob::Busy );
}

}

#endif

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