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
|
/**************************************************************************
* *
* Regina - A Normal Surface Theory Calculator *
* Qt User Interface *
* *
* Copyright (c) 1999-2025, Ben Burton *
* For further details contact Ben Burton (bab@debian.org). *
* *
* This file is modified from the KDE syntax-highlighting framework, *
* which is copyright (C) 2016 Volker Krause <vkrause@kde.org> *
* and is distributed under 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 program is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License as *
* published by the Free Software Foundation; either version 2 of the *
* License, or (at your option) any later version. *
* *
* As an exception, when this program is distributed through (i) the *
* App Store by Apple Inc.; (ii) the Mac App Store by Apple Inc.; or *
* (iii) Google Play by Google Inc., then that store may impose any *
* digital rights management, device limits and/or redistribution *
* restrictions that are required by its terms of service. *
* *
* This program 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 *
* General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <https://www.gnu.org/licenses/>. *
* *
**************************************************************************/
/**
* \file syntax/format.h
* \brief Part of the private syntax highlighting framework that is shared
* between Regina's different graphical user interfaces.
*
* The syntax highlighting headers are private in the following sense: they are
* not installed along with Regina's other headers, they do not appear in the
* API documentation, and the syntax highlighting API is subject to change
* without notice between different versions of Regina.
*/
#ifndef __SYNTAX_FORMAT_H
#ifndef __DOXYGEN
#define __SYNTAX_FORMAT_H
#endif
#include "regina-core.h"
#include <cstdint>
#include <memory>
namespace regina::syntax {
class DefinitionRef;
class FormatPrivate;
class Theme;
/** 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
*/
class 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. */
const std::string& 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).
*/
uint16_t id() 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.
* The color will be returned as an integer of the form #AARRGGBB.
*/
unsigned textColor(const Theme &theme) const;
/** Returns the foreground color for selected text of the combination of
* this format and the given theme.
* The color will be returned as an integer of the form #AARRGGBB.
*/
unsigned 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.
* The color will be returned as an integer of the form #AARRGGBB.
*/
unsigned backgroundColor(const Theme &theme) const;
/** Returns the background color of selected text of the combination of
* this format and the given theme.
* The color will be returned as an integer of the form #AARRGGBB.
*/
unsigned 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;
private:
friend class FormatPrivate;
std::shared_ptr<FormatPrivate> d;
};
} // namespace regina::syntax
#endif
|
