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
|
/*
SPDX-FileCopyrightText: 2016 Volker Krause <vkrause@kde.org>
SPDX-FileCopyrightText: 2020 Jonathan Poelen <jonathan.poelen@gmail.com>
SPDX-License-Identifier: MIT
*/
#ifndef KSYNTAXHIGHLIGHTING_FORMAT_H
#define KSYNTAXHIGHLIGHTING_FORMAT_H
#include "ksyntaxhighlighting_export.h"
#include "theme.h"
#include <QExplicitlySharedDataPointer>
QT_BEGIN_NAMESPACE
class QColor;
class QString;
class QXmlStreamReader;
QT_END_NAMESPACE
namespace KSyntaxHighlighting
{
class FormatPrivate;
/** Describes the format to be used for a specific text fragment.
* The actual format used for displaying is merged from the format information
* in the syntax definition file, and a theme.
*
* @see Theme
* @since 5.28
*/
class KSYNTAXHIGHLIGHTING_EXPORT Format
{
public:
/** Creates an empty/invalid format. */
Format();
Format(const Format &other);
~Format();
Format &operator=(const Format &other);
/** Returns @c true if this is a valid format, ie. one that
* was read from a syntax definition file.
*/
bool isValid() const;
/** The name of this format as used in the syntax definition file. */
QString name() const;
/** Returns a unique identifier of this format.
* This is useful for efficient storing of formats in a text line. The
* identifier is unique per Repository instance, but will change when
* the repository is reloaded (which also invalidatess the corresponding
* Definition anyway).
*/
quint16 id() const;
/** Returns the underlying TextStyle of this Format.
* Every Theme::TextStyle is visually defined by a Theme. A Format uses one
* of the Theme::TextStyle%s and on top allows modifications such as setting
* a different foreground color etc.
* @see Theme::TextStyle
* @since 5.49
*/
Theme::TextStyle textStyle() const;
/** Returns @c true if the combination of this format and the theme @p theme
* do not change the default text format in any way.
* This is useful for output formats where changing formatting implies cost,
* and thus benefit from optimizing the default case of not having any format
* applied. If you make use of this, make sure to set the default text style
* to what the corresponding theme sets for Theme::Normal.
*/
bool isDefaultTextStyle(const Theme &theme) const;
/** Returns @c true if the combination of this format and the theme @p theme
* change the foreground color compared to the default format.
*/
bool hasTextColor(const Theme &theme) const;
/** Returns the foreground color of the combination of this format and the
* given theme.
*/
QColor textColor(const Theme &theme) const;
/** Returns the foreground color for selected text of the combination of
* this format and the given theme.
*/
QColor selectedTextColor(const Theme &theme) const;
/** Returns @c true if the combination of this format and the theme @p theme
* change the background color compared to the default format.
*/
bool hasBackgroundColor(const Theme &theme) const;
/** Returns the background color of the combination of this format and the
* given theme.
*/
QColor backgroundColor(const Theme &theme) const;
/** Returns the background color of selected text of the combination of
* this format and the given theme.
*/
QColor selectedBackgroundColor(const Theme &theme) const;
/** Returns @c true if the combination of this format and the given theme
* results in bold text formatting.
*/
bool isBold(const Theme &theme) const;
/** Returns @c true if the combination of this format and the given theme
* results in italic text formatting.
*/
bool isItalic(const Theme &theme) const;
/** Returns @c true if the combination of this format and the given theme
* results in underlined text.
*/
bool isUnderline(const Theme &theme) const;
/** Returns @c true if the combination of this format and the given theme
* results in struck through text.
*/
bool isStrikeThrough(const Theme &theme) const;
/**
* Returns whether characters with this format should be spell checked.
*/
bool spellCheck() const;
/** Returns @c true if the syntax definition file sets a value for the bold text
* attribute and, therefore, overrides the theme and the default formatting
* style. If the return is @p true, this value is obtained by isBold().
* @see isBold()
* @since 5.62
*/
bool hasBoldOverride() const;
/** Returns @c true if the syntax definition file sets a value for the italic text
* attribute and, therefore, overrides the theme and the default formatting style.
* If the return is @p true, this value is obtained by isItalic().
* @see isItalic()
* @since 5.62
*/
bool hasItalicOverride() const;
/** Returns @c true if the syntax definition file sets a value for the underlined
* text attribute and, therefore, overrides the theme and the default formatting
* style. If the return is @p true, this value is obtained by isUnderline().
* @see isUnderline()
* @since 5.62
*/
bool hasUnderlineOverride() const;
/** Returns @c true if the syntax definition file specifies a value for the
* struck through text attribute. If the return is @p true, this value
* is obtained by isStrikeThrough().
* @see isStrikeThrough()
* @since 5.62
*/
bool hasStrikeThroughOverride() const;
/** Returns @c true if the syntax definition file sets a value for the foreground
* text color attribute and, therefore, overrides the theme and the default formatting
* style. If the return is @p true, this value is obtained by textColor().
* @see textColor(), hasTextColor()
* @since 5.62
*/
bool hasTextColorOverride() const;
/** Returns @c true if the syntax definition file sets a value for the background
* color attribute and, therefore, overrides the theme and the default formatting
* style. If the return is @p true, this value is obtained by backgroundColor().
* @see backgroundColor(), hasBackgroundColor()
* @since 5.62
*/
bool hasBackgroundColorOverride() const;
/** Returns @c true if the syntax definition file specifies a value for the
* selected text color attribute. If the return is @p true, this value is
* obtained by selectedTextColor().
* @see selectedTextColor()
* @since 5.62
*/
bool hasSelectedTextColorOverride() const;
/** Returns @c true if the syntax definition file specifies a value for the
* selected background color attribute. If the return is @p true, this
* value is obtained by selectedBackgroundColor().
* @see selectedBackgroundColor()
* @since 5.62
*/
bool hasSelectedBackgroundColorOverride() const;
private:
friend class FormatPrivate;
QExplicitlySharedDataPointer<FormatPrivate> d;
};
}
QT_BEGIN_NAMESPACE
Q_DECLARE_TYPEINFO(KSyntaxHighlighting::Format, Q_MOVABLE_TYPE);
QT_END_NAMESPACE
#endif // KSYNTAXHIGHLIGHTING_FORMAT_H
|
