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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
/* This file is part of the KDE project
Copyright 2006-2007 Stefan Nikolaus <stefan.nikolaus@kdemail.net>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef CALLIGRA_SHEETS_RECALC_MANAGER
#define CALLIGRA_SHEETS_RECALC_MANAGER
#include <Region.h>
#include <QObject>
class KoUpdater;
namespace Calligra
{
namespace Sheets
{
class Cell;
class Map;
class Sheet;
/**
* \class RecalcManager
* \brief Manages the recalculations of cells containing a formula.
* \ingroup Value
*
* The recalculations of a cell region, a sheet or the map are based
* on the following principle:
*
* A cell could refer to other cells, which need to be recalculated
* before. The order of recalculation is determined by the depth of
* references, i.e. first the cells, which do not refer to other cells,
* are recalculated. Cells referring to those are next. Then cells, which
* refer to the ones in the last step follow and so on until all cells
* have been updated.
*
* Cell value changes are blocked while doing this, i.e. they do not
* trigger a new recalculation event.
*/
class CALLIGRA_SHEETS_ODF_EXPORT RecalcManager : public QObject
{
Q_OBJECT
public:
/**
* Creates a RecalcManager. It is used for a whole map.
*
* \param map The Map which this RecalcManager belongs to.
*/
explicit RecalcManager(Map *const map);
/**
* Destructor.
*/
~RecalcManager() override;
/**
* Recalculates the cells referring to cells in \p region .
* The cells are recalculated sorted by the reference depth in ascending order.
*
* \see recalc()
*/
void regionChanged(const Region& region);
/**
* Recalculates the sheet \p sheet .
* The cells are recalculated sorted by the reference depth in ascending order.
*
* \see recalc()
*/
void recalcSheet(Sheet* const sheet);
/**
* Recalculates the whole map.
* The cells are recalculated sorted by the reference depth in ascending order.
*
* \see recalc()
*/
void recalcMap(KoUpdater *updater = 0);
/**
* Returns the recalculation state.
* \return \c true, if recalculations are in progress
*/
bool isActive() const;
/**
* Prints out the cell depths in the current recalculation event.
*/
void dump() const;
public Q_SLOTS:
/**
* Called after a sheet was added.
*/
void addSheet(Sheet *sheet);
/**
* Called after a sheet was removed.
*/
void removeSheet(Sheet *sheet);
protected:
/**
* Iterates over the map of cell with their reference depths
* and calls recalcCell().
*
* \see recalcCell()
*/
void recalc(KoUpdater *updater = 0);
private:
Q_DISABLE_COPY(RecalcManager)
class Private;
Private * const d;
};
} // namespace Sheets
} // namespace Calligra
#endif // CALLIGRA_SHEETS_RECALC_MANAGER
|
