/usr/include/KF5/KConfigWidgets/kcolorscheme.h is in libkf5configwidgets-dev 5.28.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 | /* This file is part of the KDE project
* Copyright (C) 2007 Matthew Woehlke <mw_triad@users.sourceforge.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of 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 library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef KCOLORSCHEME_H
#define KCOLORSCHEME_H
#include <kconfigwidgets_export.h>
#include <ksharedconfig.h>
#include <QtCore/QExplicitlySharedDataPointer>
#include <QPalette>
class QColor;
class QBrush;
class KColorSchemePrivate;
/**
* A set of methods used to work with colors.
*
* KColorScheme currently provides access to the system color palette that the
* user has selected (in the future, it is expected to do more). It greatly
* expands on QPalette by providing five distinct "sets" with several color
* choices each, covering background, foreground, and decoration colors.
*
* A KColorScheme instance represents colors corresponding to a "set", where a
* set consists of those colors used to draw a particular type of element, such
* as a menu, button, view, selected text, or tooltip. Each set has a distinct
* set of colors, so you should always use the correct set for drawing and
* never assume that a particular foreground for one set is the same as the
* foreground for any other set. Individual colors may be quickly referenced by
* creating an anonymous instance and invoking a lookup member.
*
* @note
* The color palettes for the various states of a widget (active, inactive,
* disabled) may be wildly different. Therefore, it is important to take the
* state into account. This is why the KColorScheme constructor requires a
* QPalette::ColorGroup as an argument.
*
* To facilitate working with potentially-varying states, two convenience API's
* are provided. These are KColorScheme::adjustBackground and its sister
* KColorScheme::adjustForeground, and the helper class ::KStatefulBrush.
*
* @see KColorScheme::ColorSet, KColorScheme::ForegroundRole,
* KColorScheme::BackgroundRole, KColorScheme::DecorationRole,
* KColorScheme::ShadeRole
*/
class KCONFIGWIDGETS_EXPORT KColorScheme
{
public:
/**
* This enumeration describes the color set for which a color is being
* selected.
*
* Color sets define a color "environment", suitable for drawing all parts
* of a given region. Colors from different sets should not be combined.
*/
enum ColorSet {
/**
* Views; for example, frames, input fields, etc.
*
* If it contains things that can be selected, it is probably a View.
*/
View,
/**
* Non-editable window elements; for example, menus.
*
* If it isn't a Button, View, or Tooltip, it is probably a Window.
*/
Window,
/**
* Buttons and button-like controls.
*
* In addition to buttons, "button-like" controls such as non-editable
* dropdowns, scrollbar sliders, slider handles, etc. should also use
* this role.
*/
Button,
/**
* Selected items in views.
*
* Note that unfocused or disabled selections should use the Window
* role. This makes it more obvious to the user that the view
* containing the selection does not have input focus.
*/
Selection,
/**
* Tooltips.
*
* The tooltip set can often be substituted for the view
* set when editing is not possible, but the Window set is deemed
* inappropriate. "What's This" help is an excellent example, another
* might be pop-up notifications (depending on taste).
*/
Tooltip,
/**
* Complementary areas.
*
* Some applications want some areas to have a different color scheme.
* Ususally dark areas over a light theme. For instance the fullscreen UI
* of a picture viewer, or the logout/lock screen of the plasma workspace
* ask for a dark color scheme even on light themes.
* @since 5.19
*/
Complementary
};
/**
* This enumeration describes the background color being selected from the
* given set.
*
* Background colors are suitable for drawing under text, and should never
* be used to draw text. In combination with one of the overloads of
* KColorScheme::shade, they may be used to generate colors for drawing
* frames, bevels, and similar decorations.
*/
enum BackgroundRole {
/**
* Normal background.
*/
NormalBackground = 0,
/**
* Alternate background; for example, for use in lists.
*
* This color may be the same as BackgroundNormal, especially in sets
* other than View and Window.
*/
AlternateBackground = 1,
/**
* Third color; for example, items which are new, active, requesting
* attention, etc.
*
* Alerting the user that a certain field must be filled out would be a
* good usage (although NegativeBackground could be used to the same
* effect, depending on what you are trying to achieve). Unlike
* ActiveText, this should not be used for mouseover effects.
*/
ActiveBackground = 2,
/**
* Fourth color; corresponds to (unvisited) links.
*
* Exactly what this might be used for is somewhat harder to qualify;
* it might be used for bookmarks, as a 'you can click here' indicator,
* or to highlight recent content (i.e. in a most-recently-accessed
* list).
*/
LinkBackground = 3,
/**
* Fifth color; corresponds to visited links.
*
* This can also be used to indicate "not recent" content, especially
* when a color is needed to denote content which is "old" or
* "archival".
*/
VisitedBackground = 4,
/**
* Sixth color; for example, errors, untrusted content, etc.
*/
NegativeBackground = 5,
/**
* Seventh color; for example, warnings, secure/encrypted content.
*/
NeutralBackground = 6,
/**
* Eigth color; for example, success messages, trusted content.
*/
PositiveBackground = 7
};
/**
* This enumeration describes the foreground color being selected from the
* given set.
*
* Foreground colors are suitable for drawing text or glyphs (such as the
* symbols on window decoration buttons, assuming a suitable background
* brush is used), and should never be used to draw backgrounds.
*
* For window decorations, the following is suggested, but not set in
* stone:
* @li Maximize - PositiveText
* @li Minimize - NeutralText
* @li Close - NegativeText
* @li WhatsThis - LinkText
* @li Sticky - ActiveText
*/
enum ForegroundRole {
/**
* Normal foreground.
*/
NormalText = 0,
/**
* Second color; for example, comments, items which are old, inactive
* or disabled. Generally used for things that are meant to be "less
* important". InactiveText is not the same role as NormalText in the
* inactive state.
*/
InactiveText = 1,
/**
* Third color; for example items which are new, active, requesting
* attention, etc. May be used as a hover color for clickable items.
*/
ActiveText = 2,
/**
* Fourth color; use for (unvisited) links. May also be used for other
* clickable items or content that indicates relationships, items that
* indicate somewhere the user can visit, etc.
*/
LinkText = 3,
/**
* Fifth color; used for (visited) links. As with LinkText, may be used
* for items that have already been "visited" or accessed. May also be
* used to indicate "historical" (i.e. "old") items or information,
* especially if InactiveText is being used in the same context to
* express something different.
*/
VisitedText = 4,
/**
* Sixth color; for example, errors, untrusted content, deletions,
* etc.
*/
NegativeText = 5,
/**
* Seventh color; for example, warnings, secure/encrypted content.
*/
NeutralText = 6,
/**
* Eigth color; for example, additions, success messages, trusted
* content.
*/
PositiveText = 7
};
/**
* This enumeration describes the decoration color being selected from the
* given set.
*
* Decoration colors are used to draw decorations (such as frames) for
* special purposes. Like color shades, they are neither foreground nor
* background colors. Text should not be painted over a decoration color,
* and decoration colors should not be used to draw text.
*/
enum DecorationRole {
/**
* Color used to draw decorations for items which have input focus.
*/
FocusColor,
/**
* Color used to draw decorations for items which will be activated by
* clicking.
*/
HoverColor
};
/**
* This enumeration describes the color shade being selected from the given
* set.
*
* Color shades are used to draw "3d" elements, such as frames and bevels.
* They are neither foreground nor background colors. Text should not be
* painted over a shade, and shades should not be used to draw text.
*/
enum ShadeRole {
/**
* The light color is lighter than dark() or shadow() and contrasts
* with the base color.
*/
LightShade,
/**
* The midlight color is in between base() and light().
*/
MidlightShade,
/**
* The mid color is in between base() and dark().
*/
MidShade,
/**
* The dark color is in between mid() and shadow().
*/
DarkShade,
/**
* The shadow color is darker than light() or midlight() and contrasts
* the base color.
*/
ShadowShade
};
/** Construct a copy of another KColorScheme. */
KColorScheme(const KColorScheme &);
/** Destructor */
virtual ~KColorScheme();
/** Standard assignment operator */
KColorScheme &operator=(const KColorScheme &);
/**
* Construct a palette from given color set and state. Colors are taken
* from the given KConfig. If null, the application's color scheme is used
* (either the system default or one set by KColorSchemeManager).
*
* @note KColorScheme provides direct access to the color scheme for users
* that deal directly with widget states. Unless you are a low-level user
* or have a legitimate reason to only care about a fixed, limited number
* of states (e.g. windows that cannot be inactive), consider using a
* ::KStatefulBrush instead.
*/
explicit KColorScheme(QPalette::ColorGroup, ColorSet = View, KSharedConfigPtr = KSharedConfigPtr());
/**
* Retrieve the requested background brush.
*/
QBrush background(BackgroundRole = NormalBackground) const;
/**
* Retrieve the requested foreground brush.
*/
QBrush foreground(ForegroundRole = NormalText) const;
/**
* Retrieve the requested decoration brush.
*/
QBrush decoration(DecorationRole) const;
/**
* Retrieve the requested shade color, using
* KColorScheme::background(KColorScheme::NormalBackground)
* as the base color and the contrast setting from the KConfig used to
* create this KColorScheme instance.
*
* @note Shades are chosen such that all shades would contrast with the
* base color. This means that if base is very dark, the 'dark' shades will
* be lighter than the base color, with midlight() == shadow().
* Conversely, if the base color is very light, the 'light' shades will be
* darker than the base color, with light() == mid().
*/
QColor shade(ShadeRole) const;
/**
* Returns the contrast for borders.
* @return the contrast (between 0 for minimum and 10 for maximum
* contrast)
*/
static int contrast();
/**
* Returns the contrast for borders as a floating point value.
* @param config pointer to the config from which to read the contrast
* setting. If null, the application's color scheme will be used
* (either the system default or one set by KColorSchemeManager).
* @return the contrast (between 0.0 for minimum and 1.0 for maximum
* contrast)
*/
static qreal contrastF(const KSharedConfigPtr &config = KSharedConfigPtr());
/**
* Retrieve the requested shade color, using the specified color as the
* base color and the application's contrast setting.
*
* @note Shades are chosen such that all shades would contrast with the
* base color. This means that if base is very dark, the 'dark' shades will
* be lighter than the base color, with midlight() == shadow().
* Conversely, if the base color is very light, the 'light' shades will be
* darker than the base color, with light() == mid().
*/
static QColor shade(const QColor &, ShadeRole);
/**
* Retrieve the requested shade color, using the specified color as the
* base color and the specified contrast.
*
* @param contrast Amount roughly specifying the contrast by which to
* adjust the base color, between -1.0 and 1.0 (values between 0.0 and 1.0
* correspond to the value from KColorScheme::contrastF)
* @param chromaAdjust (optional) Amount by which to adjust the chroma of
* the shade (1.0 means no adjustment)
*
* @note Shades are chosen such that all shades would contrast with the
* base color. This means that if base is very dark, the 'dark' shades will
* be lighter than the base color, with midlight() == shadow().
* Conversely, if the base color is very light, the 'light' shades will be
* darker than the base color, with light() == mid().
*
* @see KColorUtils::shade
*/
static QColor shade(const QColor &, ShadeRole,
qreal contrast, qreal chromaAdjust = 0.0);
/**
* Adjust a QPalette by replacing the specified QPalette::ColorRole with
* the requested background color for all states. Using this method is
* safer than replacing individual states, as it insulates you against
* changes in QPalette::ColorGroup.
*
* @note Although it is possible to replace a foreground color using this
* method, it's bad usability to do so. Just say "no".
*/
static void adjustBackground(QPalette &,
BackgroundRole newRole = NormalBackground,
QPalette::ColorRole color = QPalette::Base,
ColorSet set = View,
KSharedConfigPtr = KSharedConfigPtr());
/**
* Adjust a QPalette by replacing the specified QPalette::ColorRole with
* the requested foreground color for all states. Using this method is
* safer than replacing individual states, as it insulates you against
* changes in QPalette::ColorGroup.
*
* @note Although it is possible to replace a background color using this
* method, it's bad usability to do so. Just say "no".
*/
static void adjustForeground(QPalette &,
ForegroundRole newRole = NormalText,
QPalette::ColorRole color = QPalette::Text,
ColorSet set = View,
KSharedConfigPtr = KSharedConfigPtr());
/**
* Used to obtain the QPalette that will be used to set the application
* palette from KDE Platform theme.
*
* @param config KConfig from which to load the colors
*
* @returns the QPalette
*
* @since 5.0
*/
static QPalette createApplicationPalette(const KSharedConfigPtr &config);
private:
QExplicitlySharedDataPointer<KColorSchemePrivate> d;
};
/**
* A container for a "state-aware" brush.
*
* KStatefulBrush provides an easy and safe way to store a color for use in a
* user interface. It is "safe" both in that it will make it easy to deal with
* widget states in a correct manner, and that it insulates you against changes
* in QPalette::ColorGroup.
*
* Basically, a stateful brush is used to cache a particular "color" from the
* KDE system palette (usually, one which does not live in QPalette). When you
* are ready to draw using the brush, you use the current state to retrieve the
* appropriate brush.
*
* Stateful brushes can also be used to apply state effects to arbitrary
* brushes, for example when working with a application specific user-defined
* color palette.
*
* @note As of Qt 4.3, QPalette::ColorGroup is missing a state for disabled
* widgets in an inactive window. Hopefully Trolltech will fix this bug, at
* which point KColorScheme and KStatefulBrush will be updated to recognize the
* new state. Using KStatefulBrush will allow your application to inherit these
* changes "for free", without even recompiling.
*/
class KCONFIGWIDGETS_EXPORT KStatefulBrush
{
public:
/**
* Construct a "default" stateful brush. For such an instance, all
* overloads of KStatefulBrush::brush will return a default brush (i.e.
* <tt>QBrush()</tt>).
*/
explicit KStatefulBrush();
/**
* Construct a stateful brush from given color set and foreground role,
* using the colors from the given KConfig.
* If null, the application's color scheme is used (either the system
* default, or one set by KColorSchemeManager).
*/
explicit KStatefulBrush(KColorScheme::ColorSet,
KColorScheme::ForegroundRole,
KSharedConfigPtr = KSharedConfigPtr());
/**
* Construct a stateful brush from given color set and background role,
* using the colors from the given KConfig (if null, the application's
* colors are used).
*/
explicit KStatefulBrush(KColorScheme::ColorSet,
KColorScheme::BackgroundRole,
KSharedConfigPtr = KSharedConfigPtr());
/**
* Construct a stateful brush from given color set and decoration role,
* using the colors from the given KConfig (if null, the application's
* colors are used).
*/
explicit KStatefulBrush(KColorScheme::ColorSet,
KColorScheme::DecorationRole,
KSharedConfigPtr = KSharedConfigPtr());
/**
* Construct a stateful background brush from a specified QBrush (or
* QColor, via QBrush's implicit constructor). The various states are
* determined from the base QBrush (which fills in the Active state)
* according to the same rules used to build stateful color schemes from
* the system color scheme. The state effects from the given KConfig are
* used (if null, the application's state effects are used).
*/
explicit KStatefulBrush(const QBrush &, KSharedConfigPtr = KSharedConfigPtr());
/**
* Construct a stateful foreground/decoration brush from a specified
* QBrush (or QColor, via QBrush's implicit constructor). The various
* states are determined from the base QBrush (which fills in the Active
* state) according to the same rules used to build stateful color schemes
* from the system color scheme. The state effects from the given KConfig
* are used (if null, the application's state effects are used).
*
* @param background The background brush (or color) corresponding to the
* KColorScheme::NormalBackground role and QPalette::Active state for this
* foreground/decoration color.
*/
explicit KStatefulBrush(const QBrush &, const QBrush &background,
KSharedConfigPtr = KSharedConfigPtr());
/** Construct a copy of another KStatefulBrush. */
KStatefulBrush(const KStatefulBrush &);
/** Destructor */
~KStatefulBrush();
/** Standard assignment operator */
KStatefulBrush &operator=(const KStatefulBrush &);
/**
* Retrieve the brush for the specified widget state. This is used when you
* know explicitly what state is wanted. Otherwise one of overloads is
* often more convenient.
*/
QBrush brush(QPalette::ColorGroup) const;
/**
* Retrieve the brush, using a QPalette reference to determine the correct
* state. Use when your painting code has easy access to the QPalette that
* it is supposed to be using. The state used in this instance is the
* currentColorGroup of the palette.
*/
QBrush brush(const QPalette &) const;
/**
* Retrieve the brush, using a QWidget pointer to determine the correct
* state. Use when you have a pointer to the widget that you are painting.
* The state used is the current state of the widget.
*
* @note If you pass an invalid widget, you will get a default brush (i.e.
* <tt>QBrush()</tt>).
*/
QBrush brush(const QWidget *) const;
private:
class KStatefulBrushPrivate *d;
};
Q_DECLARE_METATYPE(KStatefulBrush) /* so we can pass it in QVariant's */
#endif // KCOLORSCHEME_H
|