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
137
138
139
140
141
142
143
|
#ifndef KOSECTIONMODEL_H
#define KOSECTIONMODEL_H
#include <QTextDocument>
#include <QAbstractItemModel>
#include <QVector>
#include <QSet>
#include <KoSection.h>
#include <KoSectionEnd.h>
/**
* Used to handle all the sections in the document
*
* Now there actually two levels of section handling:
* 1) Formatting Level: on this level we should be sure, that
* pointers to KoSection and KoSectionEnd in the KoParagraphStyles
* properties SectionEndings and SectionStartings are consistent.
* Handling on this level is provided on the level of text editing
* commands: DeleteCommand, NewSectionCommand
* We can't move it to another place, because we should know the
* semantics of operation to handle it right way.
* 2) Model(Tree) Level: on this level we should update KoSectionModel
* right way, so it in any moment represents the actual tree
* of sections. Tree is built easily:
* One section is son of another, if it is directly nested in it.
* As text editing commands have access to change Formatting Level,
* they are declared as friend classes of KoSectionModel to be able
* affect Model structure without changing something on Formatting
* Level. Also affected by RenameSectionCommand.
*
* Also we need to look at the consistency of some section properties:
*
* 1) Bounds. Those now are handled with QTextCursors that are placed
* on start and end of the section. In default state start cursor
* isn't moving if text inserted in its position, and end cursor
* moves. But in the case of initial document loading, it is necessary
* to make some end cursors stop moving, so we have:
* KoTextLoader -> calling -> KoSection::setKeepEndBound()
* KoTextLoader -> calling -> KoSectionModel::allowMovingEndBound()
* ^-- this needed to restore default behaviour after load
*
* 2) Level. Level means the depth of the section in tree. Root
* sections has 0 (zero) level. Now if you look at the possible
* text editing command affecting sections you may notice that
* level of section doesn't change in any case. Initial level
* is set in KoSection constructor as parent's level plus one.
* TODO: write about drag-n-drop here, when its implemented
*
* 3) Name. Each KoSection has a name that must be unique. We have
* two groups of KoSections in each moment of time: the first group
* consists of the sections that are present in document now,
* the second group consists of the sections that were deleted, but
* we still need them as they may be restored with "undo".
* This groups are stored in m_registeredSections and m_sectionNames.
*
* Sections are created through this newSection() and newSectionEnd()
* functions.
*
* This object is created for QTextDocument on the first query of it.
*/
class KOTEXT_EXPORT KoSectionModel : public QAbstractItemModel
{
Q_OBJECT
public:
static const int PointerRole = Qt::UserRole;
explicit KoSectionModel(QTextDocument *doc);
~KoSectionModel() override;
QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const override;
QModelIndex parent(const QModelIndex &child) const override;
int rowCount(const QModelIndex &parent = QModelIndex()) const override;
int columnCount(const QModelIndex &parent = QModelIndex()) const override;
QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
/// Creates KoSection in position of @p cursor with some allowed name
KoSection *createSection(const QTextCursor &cursor, KoSection *parent);
/// Creates KoSection in position of @p cursor with specified @p name
KoSection *createSection(const QTextCursor &cursor, KoSection *parent, const QString &name);
/// Creates KoSectionEnd in pair for a @p section
KoSectionEnd *createSectionEnd(KoSection *section);
/** Tries to set @p section name to @p name
* @return @c false if there is a section with such name
* and new name isn't accepted and @c true otherwise.
*/
bool setName(KoSection *section, const QString &name);
/**
* Returns pointer to the deepest KoSection that covers @p pos
* or NULL if there is no such section
*/
KoSection *sectionAtPosition(int pos) const;
/// Returns name for the new section.
QString possibleNewName();
/// Returns if this name is possible.
bool isValidNewName(const QString &name) const;
/// Setting all sections end bound cursor to move with text inserting.
void allowMovingEndBound();
/// Finds index of @p child inside his parent.
int findRowOfChild(KoSection *child) const;
private:
Q_DISABLE_COPY(KoSectionModel)
friend class DeleteCommand;
friend class NewSectionCommand;
/**
* Inserts @p section to it's parent (should be
* stored in @p section already) in position childIdx.
* Affects only Model Level(@see KoSectionModel).
*/
void insertToModel(KoSection* section, int childIdx);
/**
* Deletes @p section from it's parent (should be
* stored in @p section already).
* Affects only Model Level
* @see KoSectionModel
*/
void deleteFromModel(KoSection *section);
QTextDocument *m_doc;
QSet<KoSection *> m_registeredSections; ///< stores pointer to sections that sometime was registered
QHash<QString, KoSection *> m_sectionNames; ///< stores name -> pointer reference, for sections that are visible in document now
QHash<KoSection *, QPersistentModelIndex> m_modelIndex;
QVector<KoSection *> m_rootSections;
};
Q_DECLARE_METATYPE(KoSectionModel *)
#endif //KOSECTIONMODEL_H
|
