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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
/* This file is part of the KDE project
* SPDX-FileCopyrightText: 2006 Thomas Zander <zander@kde.org>
* SPDX-FileCopyrightText: 2011 Boudewijn Rempt <boud@kogmbh.com>
*
* SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KOTEXTBLOCKDATA_H
#define KOTEXTBLOCKDATA_H
#include <QTextBlockUserData>
#include "kotext_export.h"
class KoTextBlockBorderData;
class KoTextBlockPaintStrategyBase;
/**
* This class is used to store properties for KoText layouting inside Qt QTextBlock
* instances.
*/
class KOTEXT_EXPORT KoTextBlockData
{
public:
/**
* Supplemental data to allow advanced tabs to be used for layout and painting.
* Qt-Scribe knows only left-tabs and it also only knows tab-positions per paragraph
* which is not enough for our needs.
* Using the tabs list we calculated in the layout step, we can emulate
* all tabs by setting these as left-tabs on scribe prior to the re-layout of the text in the
* line which is redone at painting time.
* The tabLength list holds a length for each tab in the line and thus corresponds to the tab
* positions in the tabs list. We can then calculate the tab to have started the position
* minus the length and use that to paint special tab attributes.
*/
struct TabLineData {
/// the tab positions as set on the QTextOption.setTabArray()
QList<qreal> tabs;
/// the length of each tab so we know which area to paint when we want to decorate it.
QList<qreal> tabLength;
};
/**
* Datastructure to define a range of characters assigned a temporary meaning.
* Common use cases are spellchecking and grammar.
*/
struct MarkupRange {
int firstChar;
int lastChar;
qreal startX;
qreal endX;
int firstRebased;
int lastRebased;
};
/**
* The different types of markups.
*/
enum MarkupType {
Misspell,
Grammar
};
explicit KoTextBlockData(QTextBlock &block);
explicit KoTextBlockData(QTextBlockUserData *userData);
virtual ~KoTextBlockData();
/**
* Add a range to the _end_ of the list of markups. It's important that firstChar is after
* lastChar of the previous range for that type of markup.
*/
void appendMarkup(MarkupType type, int firstChar, int lastChar);
/**
* Clear all ranges for a specific type of markup.
*/
void clearMarkups(MarkupType type);
/**
* Move all ranges following fromPosition delta number of characters to the right.
* Applies to a specific type of markup.
*/
void rebaseMarkups(MarkupType type, int fromPosition, int delta);
/**
* Find a range that contains positionWithin.
* If none is found a default Markuprange firstChar = lastChar = 0 is returned
*/
MarkupRange findMarkup(MarkupType type, int positionWithin) const;
void setMarkupsLayoutValidity(MarkupType type, bool valid);
bool isMarkupsLayoutValid(MarkupType type) const;
QVector<MarkupRange>::Iterator markupsBegin(MarkupType type);
QVector<MarkupRange>::Iterator markupsEnd(MarkupType type);
/**
* Clear the counter and set everything to default values.
*/
void clearCounter();
/// return if this block has up-to-date counter data
bool hasCounterData() const;
/// return the width (in pt) of the counter.
qreal counterWidth() const;
/// set the width of the counter in pt.
void setCounterWidth(qreal width);
/// return the spacing (in pt) between the counter and the text
qreal counterSpacing() const;
/// set the spacing (in pt) between the counter and the text
void setCounterSpacing(qreal spacing);
/** sets the index that is used at this level.
* If this represents a paragraph with counter 3.1, then the text is the 1.
* If this represents a paragraph with counter IV.V, then the index is 5.
*/
void setCounterIndex(int index);
/// returns the index for the counter at this level
int counterIndex() const;
/// return the exact text that will be painted as the counter
QString counterText() const;
/**
* set the text that is used for the counter at this level. the text is formatted
* depending on the language/style.
* If this represents a parag with counter 3.1 then the text is the '1'..
* If this represents a paragraph with counter IV.V, then the text is V.
* since the rest is not dependent on this parag, but only its location in the text
*
*/
void setPartialCounterText(const QString &text);
/// return the partial text for this paragraphs counter
QString partialCounterText() const;
/// set the plain counter text which equals the counterText minus prefix and suffix
void setCounterPlainText(const QString &text);
/// return the plain counter text which equals the counterText minus prefix and suffix
QString counterPlainText() const;
void setCounterPrefix(const QString &text);
QString counterPrefix() const;
void setCounterSuffix(const QString &text);
QString counterSuffix() const;
/// Set if the counter is a image or not
void setCounterIsImage(bool isImage);
/// return if the counter is a image or not
bool counterIsImage() const;
/**
* The actual position of the counter can be set, in actual (text) document coordinates.
* @param position the location of the top/left of the counter text line.
*/
void setCounterPosition(const QPointF &position);
/**
* Return the counter position.
* @see setCounterPosition
*/
QPointF counterPosition() const;
/**
* Sets a textformat to be used for the counter/bullet
* @param font the format
*/
void setLabelFormat(const QTextCharFormat &format);
/**
* Return the format to be used for the counter/bullet
*/
QTextCharFormat labelFormat() const;
/**
* When a paragraph has a border, it will have a KoTextBlockBorderData instance.
* Adding the border will increase the refcount.
* @param border the border used for this paragraph, or 0 if no border is needed (anymore).
*/
void setBorder(KoTextBlockBorderData *border);
/**
* Return the border associated with this paragraph, or 0 if there is no border set.
*/
KoTextBlockBorderData *border() const;
/**
* sets a paintStrategy of this paragraph
* @param paintStrategy the paintStrategy to be used for this paragraph
*/
void setPaintStrategy(KoTextBlockPaintStrategyBase *paintStrategy);
/**
* Return the paintStrategy of this paragraph
*/
KoTextBlockPaintStrategyBase *paintStrategy() const;
/**
* @brief saveXmlID can be used to determine whether we need to save the xml:id
* for this text block data object. This is true if the text block data describes
* animations.
* @return true of we need to save the xml id, false if not.
*/
bool saveXmlID() const;
private:
class Private;
Private *const d;
};
Q_DECLARE_TYPEINFO(KoTextBlockData::MarkupRange, Q_MOVABLE_TYPE);
Q_DECLARE_METATYPE(QTextBlockUserData *)
#endif
|
