Plasma-framework

quicktheme.h
1/*
2 SPDX-FileCopyrightText: 2006-2007 Aaron Seigo <aseigo@kde.org>
3 SPDX-FileCopyrightText: 2013 Marco Martin <mart@kde.org>
4
5 SPDX-License-Identifier: LGPL-2.0-or-later
6*/
7
8#ifndef PLASMA_QUICKTHEME_H
9#define PLASMA_QUICKTHEME_H
10
11#include <plasma/theme.h>
12
13#include <QColor>
14
15namespace Plasma
16{
17/**
18 * @short Interface to the Plasma theme
19 *
20 *
21 * Plasma::Theme provides access to a common and standardized set of graphic
22 * elements stored in SVG format. This allows artists to create single packages
23 * of SVGs that will affect the look and feel of all workspace components.
24 *
25 * Plasma::Svg uses Plasma::Theme internally to locate and load the appropriate
26 * SVG data. Alternatively, Plasma::Theme can be used directly to retrieve
27 * file system paths to SVGs by name.
28 *
29 * <b>Import Statement</b>
30 * @code import org.kde.plasma.core @endcode
31 * @version 2.0
32 */
33class QuickTheme : public Plasma::Theme
34{
35 Q_OBJECT
36
37 // colors
38 Q_PROPERTY(QColor textColor READ textColor NOTIFY themeChangedProxy)
39 Q_PROPERTY(QColor highlightColor READ highlightColor NOTIFY themeChangedProxy)
40 Q_PROPERTY(QColor highlightedTextColor READ highlightedTextColor NOTIFY themeChangedProxy)
41 Q_PROPERTY(QColor backgroundColor READ backgroundColor NOTIFY themeChangedProxy)
42 Q_PROPERTY(QColor linkColor READ linkColor NOTIFY themeChangedProxy)
43 Q_PROPERTY(QColor visitedLinkColor READ visitedLinkColor NOTIFY themeChangedProxy)
44 Q_PROPERTY(QColor positiveTextColor READ positiveTextColor NOTIFY themeChangedProxy)
45 Q_PROPERTY(QColor neutralTextColor READ neutralTextColor NOTIFY themeChangedProxy)
46 Q_PROPERTY(QColor negativeTextColor READ negativeTextColor NOTIFY themeChangedProxy)
47 Q_PROPERTY(QColor disabledTextColor READ disabledTextColor NOTIFY themeChangedProxy)
48
49 Q_PROPERTY(QColor buttonTextColor READ buttonTextColor NOTIFY themeChangedProxy)
50 Q_PROPERTY(QColor buttonBackgroundColor READ buttonBackgroundColor NOTIFY themeChangedProxy)
51 Q_PROPERTY(QColor buttonHoverColor READ buttonHoverColor NOTIFY themeChangedProxy)
52 Q_PROPERTY(QColor buttonFocusColor READ buttonFocusColor NOTIFY themeChangedProxy)
53 Q_PROPERTY(QColor buttonHighlightedTextColor READ buttonHighlightedTextColor NOTIFY themeChangedProxy)
54 Q_PROPERTY(QColor buttonPositiveTextColor READ buttonPositiveTextColor NOTIFY themeChangedProxy)
55 Q_PROPERTY(QColor buttonNeutralTextColor READ buttonNeutralTextColor NOTIFY themeChangedProxy)
56 Q_PROPERTY(QColor buttonNegativeTextColor READ buttonNegativeTextColor NOTIFY themeChangedProxy)
57
58 Q_PROPERTY(QColor viewTextColor READ viewTextColor NOTIFY themeChangedProxy)
59 Q_PROPERTY(QColor viewBackgroundColor READ viewBackgroundColor NOTIFY themeChangedProxy)
60 Q_PROPERTY(QColor viewHoverColor READ viewHoverColor NOTIFY themeChangedProxy)
61 Q_PROPERTY(QColor viewFocusColor READ viewFocusColor NOTIFY themeChangedProxy)
62 Q_PROPERTY(QColor viewHighlightedTextColor READ viewHighlightedTextColor NOTIFY themeChangedProxy)
63 Q_PROPERTY(QColor viewPositiveTextColor READ viewPositiveTextColor NOTIFY themeChangedProxy)
64 Q_PROPERTY(QColor viewNeutralTextColor READ viewNeutralTextColor NOTIFY themeChangedProxy)
65 Q_PROPERTY(QColor viewNegativeTextColor READ viewNegativeTextColor NOTIFY themeChangedProxy)
66
67 Q_PROPERTY(QColor complementaryTextColor READ complementaryTextColor NOTIFY themeChangedProxy)
68 Q_PROPERTY(QColor complementaryBackgroundColor READ complementaryBackgroundColor NOTIFY themeChangedProxy)
69 Q_PROPERTY(QColor complementaryHoverColor READ complementaryHoverColor NOTIFY themeChangedProxy)
70 Q_PROPERTY(QColor complementaryFocusColor READ complementaryFocusColor NOTIFY themeChangedProxy)
71 Q_PROPERTY(QColor complementaryHighlightedTextColor READ complementaryHighlightedTextColor NOTIFY themeChangedProxy)
72 Q_PROPERTY(QColor complementaryPositiveTextColor READ complementaryPositiveTextColor NOTIFY themeChangedProxy)
73 Q_PROPERTY(QColor complementaryNeutralTextColor READ complementaryNeutralTextColor NOTIFY themeChangedProxy)
74 Q_PROPERTY(QColor complementaryNegativeTextColor READ complementaryNegativeTextColor NOTIFY themeChangedProxy)
75
76 Q_PROPERTY(QColor headerTextColor READ headerTextColor NOTIFY themeChangedProxy)
77 Q_PROPERTY(QColor headerBackgroundColor READ headerBackgroundColor NOTIFY themeChangedProxy)
78 Q_PROPERTY(QColor headerHoverColor READ headerHoverColor NOTIFY themeChangedProxy)
79 Q_PROPERTY(QColor headerFocusColor READ headerFocusColor NOTIFY themeChangedProxy)
80 Q_PROPERTY(QColor headerHighlightedTextColor READ headerHighlightedTextColor NOTIFY themeChangedProxy)
81 Q_PROPERTY(QColor headerPositiveTextColor READ headerPositiveTextColor NOTIFY themeChangedProxy)
82 Q_PROPERTY(QColor headerNeutralTextColor READ headerNeutralTextColor NOTIFY themeChangedProxy)
83 Q_PROPERTY(QColor headerNegativeTextColor READ headerNegativeTextColor NOTIFY themeChangedProxy)
84
85public:
86 explicit QuickTheme(QObject *parent = nullptr);
87 ~QuickTheme() override;
88
89 /**
90 * @return The theme's colorscheme's text color
91 * @since 5.0
92 */
93 QColor textColor() const;
94
95 /**
96 * @return The theme's colorscheme's highlight color
97 * @since 5.0
98 */
99 QColor highlightColor() const;
100
101 /**
102 * @return The theme's colorscheme's highlighted text color
103 * @since 5.22
104 */
105 QColor highlightedTextColor() const;
106
107 /**
108 * @return The theme's colorscheme's positive text color
109 * @since 5.22
110 */
111 QColor positiveTextColor() const;
112
113 /**
114 * @return The theme's colorscheme's neutral text color
115 * @since 5.22
116 */
117 QColor neutralTextColor() const;
118
119 /**
120 * @return The theme's colorscheme's negative text color
121 * @since 5.22
122 */
123 QColor negativeTextColor() const;
124
125 /**
126 * @return The theme's colorscheme's disabled text color
127 * @since 5.64
128 */
129 QColor disabledTextColor() const;
130
131 /**
132 * @return The theme's colorscheme's background color
133 * @since 5.0
134 */
135 QColor backgroundColor() const;
136
137 /**
138 * @return The theme's colorscheme's color for text on buttons
139 * @since 5.0
140 */
141 QColor buttonTextColor() const;
142
143 /**
144 * @return The theme's colorscheme's background color color of buttons
145 * @since 5.0
146 */
147 QColor buttonBackgroundColor() const;
148
149 /**
150 * @return The theme's colorscheme's positive text color of buttons
151 * @since 5.22
152 */
153 QColor buttonPositiveTextColor() const;
154
155 /**
156 * @return The theme's colorscheme's neutral text color of buttons
157 * @since 5.22
158 */
159 QColor buttonNeutralTextColor() const;
160
161 /**
162 * @return The theme's colorscheme's negative text color of buttons
163 * @since 5.22
164 */
165 QColor buttonNegativeTextColor() const;
166
167 /**
168 * @return The theme's colorscheme's link color
169 * @since 5.0
170 */
171 QColor linkColor() const;
172
173 /**
174 * @return The theme's colorscheme's text color for visited links
175 * @since 5.0
176 */
177 QColor visitedLinkColor() const;
178
179 /**
180 * @return The theme's colorscheme's color of hovered buttons
181 * @since 5.0
182 */
183 QColor buttonHoverColor() const;
184
185 /**
186 * @return The theme's colorscheme's color of focused buttons
187 * @since 5.0
188 */
189 QColor buttonFocusColor() const;
190
191 /**
192 * @return The theme's colorscheme's highlighted text color for buttons
193 * @since 5.22
194 */
195 QColor buttonHighlightedTextColor() const;
196
197 /**
198 * @return The theme's colorscheme's text color in views
199 * @since 5.0
200 */
201 QColor viewTextColor() const;
202
203 /**
204 * @return The theme's colorscheme's background color of views
205 * @since 5.0
206 */
207 QColor viewBackgroundColor() const;
208
209 /**
210 * @return The theme's colorscheme's color of hovered views
211 * @since 5.0
212 */
213 QColor viewHoverColor() const;
214
215 /**
216 * @return The theme's colorscheme's color of focused views
217 * @since 5.0
218 */
219 QColor viewFocusColor() const;
220
221 /**
222 * @return The theme's colorscheme's highlighted text color for views
223 * @since 5.22
224 */
225 QColor viewHighlightedTextColor() const;
226
227 /**
228 * @return The theme's colorscheme's positive text color of view
229 * @since 5.22
230 */
231 QColor viewPositiveTextColor() const;
232
233 /**
234 * @return The theme's colorscheme's neutral text color of view
235 * @since 5.22
236 */
237 QColor viewNeutralTextColor() const;
238
239 /**
240 * @return The theme's colorscheme's negative text color of view
241 * @since 5.22
242 */
243 QColor viewNegativeTextColor() const;
244
245 /**
246 * @return The theme's colorscheme's text color of "complementary" areas
247 * @since 5.0
248 */
249 QColor complementaryTextColor() const;
250
251 /**
252 * @return The theme's colorscheme's background color of "complementary" areas
253 * @since 5.0
254 */
255 QColor complementaryBackgroundColor() const;
256
257 /**
258 * @return The theme's colorscheme's color of hovered "complementary" areas
259 * @since 5.0
260 */
261 QColor complementaryHoverColor() const;
262
263 /**
264 * @return The theme's colorscheme's color of focused "complementary" areas
265 * @since 5.0
266 */
267 QColor complementaryFocusColor() const;
268
269 /**
270 * @return The theme's colorscheme's highlighted text color for "complementary" areas
271 * @since 5.22
272 */
273 QColor complementaryHighlightedTextColor() const;
274
275 /**
276 * @return The theme's colorscheme's positive text color of complementary
277 * @since 5.22
278 */
279 QColor complementaryPositiveTextColor() const;
280
281 /**
282 * @return The theme's colorscheme's neutral text color of complementary
283 * @since 5.22
284 */
285 QColor complementaryNeutralTextColor() const;
286
287 /**
288 * @return The theme's colorscheme's negative text color of complementary
289 * @since 5.22
290 */
291 QColor complementaryNegativeTextColor() const;
292
293 /**
294 * @return The theme's colorscheme's text color of "header" areas
295 * @since 5.0
296 */
297 QColor headerTextColor() const;
298
299 /**
300 * @return The theme's colorscheme's background color of "header" areas
301 * @since 5.0
302 */
303 QColor headerBackgroundColor() const;
304
305 /**
306 * @return The theme's colorscheme's color of hovered "header" areas
307 * @since 5.0
308 */
309 QColor headerHoverColor() const;
310
311 /**
312 * @return The theme's colorscheme's color of focused "header" areas
313 * @since 5.0
314 */
315 QColor headerFocusColor() const;
316
317 /**
318 * @return The theme's colorscheme's highlighted text color for "header" areas
319 * @since 5.22
320 */
321 QColor headerHighlightedTextColor() const;
322
323 /**
324 * @return The theme's colorscheme's positive text color of header
325 * @since 5.22
326 */
327 QColor headerPositiveTextColor() const;
328
329 /**
330 * @return The theme's colorscheme's neutral text color of header
331 * @since 5.22
332 */
333 QColor headerNeutralTextColor() const;
334
335 /**
336 * @return The theme's colorscheme's negative text color of header
337 * @since 5.22
338 */
339 QColor headerNegativeTextColor() const;
340
341Q_SIGNALS:
342 void themeChangedProxy();
343};
344
345} // Plasma namespace
346
347#endif // multiple inclusion guard
Plasma::QuickTheme
Interface to the Plasma theme.
Definition quicktheme.h:34
Plasma::Theme
Interface to the Plasma theme.
Definition theme.h:40
Plasma
Namespace for everything in libplasma.
Definition quicktheme.cpp:10
QObject::Q_OBJECT
Q_OBJECTQ_OBJECT
QObject::Q_PROPERTY
Q_PROPERTY(...)
QObject::Q_SIGNALS
Q_SIGNALSQ_SIGNALS
QObject::parent
QObject * parent() const const
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 17 2024 11:54:11 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.