We bake cookies in your browser for a better experience. Using this site means that you consent.Read More
We bake cookies in your browser for a better experience. Using this site means that you consent.Read More
TheQPalette class contains color groups for each widget state.More...
| Header: | #include <QPalette> |
| Inherited By: |
| enum | ColorGroup { Disabled, Active, Inactive, Normal } |
| enum | ColorRole { Window, Background, WindowText, Foreground, ..., NoRole } |
| QPalette() | |
| QPalette(const QColor & button) | |
| QPalette(Qt::GlobalColor button) | |
| QPalette(const QColor & button, const QColor & window) | |
| QPalette(const QBrush & windowText, const QBrush & button, const QBrush & light, const QBrush & dark, const QBrush & mid, const QBrush & text, const QBrush & bright_text, const QBrush & base, const QBrush & window) | |
| QPalette(const QPalette & p) | |
| ~QPalette() | |
| const QBrush & | alternateBase() const |
| const QBrush & | base() const |
| const QBrush & | brightText() const |
| const QBrush & | brush(ColorGroup group, ColorRole role) const |
| const QBrush & | brush(ColorRole role) const |
| const QBrush & | button() const |
| const QBrush & | buttonText() const |
| qint64 | cacheKey() const |
| const QColor & | color(ColorGroup group, ColorRole role) const |
| const QColor & | color(ColorRole role) const |
| ColorGroup | currentColorGroup() const |
| const QBrush & | dark() const |
| const QBrush & | highlight() const |
| const QBrush & | highlightedText() const |
| bool | isBrushSet(ColorGroup cg, ColorRole cr) const |
| bool | isCopyOf(const QPalette & p) const |
| bool | isEqual(ColorGroup cg1, ColorGroup cg2) const |
| const QBrush & | light() const |
| const QBrush & | link() const |
| const QBrush & | linkVisited() const |
| const QBrush & | mid() const |
| const QBrush & | midlight() const |
| QPalette | resolve(const QPalette & other) const |
| void | setBrush(ColorRole role, const QBrush & brush) |
| void | setBrush(ColorGroup group, ColorRole role, const QBrush & brush) |
| void | setColor(ColorGroup group, ColorRole role, const QColor & color) |
| void | setColor(ColorRole role, const QColor & color) |
| void | setColorGroup(ColorGroup cg, const QBrush & windowText, const QBrush & button, const QBrush & light, const QBrush & dark, const QBrush & mid, const QBrush & text, const QBrush & bright_text, const QBrush & base, const QBrush & window) |
| void | setCurrentColorGroup(ColorGroup cg) |
| const QBrush & | shadow() const |
| const QBrush & | text() const |
| const QBrush & | toolTipBase() const |
| const QBrush & | toolTipText() const |
| const QBrush & | window() const |
| const QBrush & | windowText() const |
| operator QVariant() const | |
| bool | operator!=(const QPalette & p) const |
| QPalette & | operator=(const QPalette & p) |
| QPalette & | operator=(QPalette && other) |
| bool | operator==(const QPalette & p) const |
| QDataStream & | operator<<(QDataStream & s, const QPalette & p) |
| QDataStream & | operator>>(QDataStream & s, QPalette & p) |
TheQPalette class contains color groups for each widget state.
A palette consists of three color groups:Active,Disabled, andInactive. All widgets in Qt contain a palette and use their palette to draw themselves. This makes the user interface easily configurable and easier to keep consistent.
If you create a new widget we strongly recommend that you use the colors in the palette rather than hard-coding specific colors.
The color groups:
Both active and inactive windows can contain disabled widgets. (Disabled widgets are often calledinaccessible orgrayed out.)
In most styles, Active and Inactive look the same.
Colors and brushes can be set for particular roles in any of a palette's color groups withsetColor() andsetBrush(). A color group contains a group of colors used by widgets for drawing themselves. We recommend that widgets use color group roles from the palette such as "foreground" and "base" rather than literal colors like "red" or "turquoise". The color roles are enumerated and defined in theColorRole documentation.
We strongly recommend that you use the default palette of the current style (returned byQApplication::palette()) and modify that as necessary. This is done by Qt's widgets when they are drawn.
To modify a color group you call the functionssetColor() andsetBrush(), depending on whether you want a pure color or a pixmap pattern.
There are also correspondingcolor() andbrush() getters, and a commonly used convenience function to get theColorRole for the currentColorGroup:window(),windowText(),base(), etc.
You can copy a palette using the copy constructor and test to see if two palettes areidentical usingisCopyOf().
QPalette is optimized by the use ofimplicit sharing, so it is very efficient to passQPalette objects as arguments.
Warning: Some styles do not use the palette for all drawing, for instance, if they make use of native theme engines. This is the case for both the Windows XP, Windows Vista, and the Mac OS X styles.
See alsoQApplication::setPalette(),QWidget::setPalette(), andQColor.
| Constant | Value | Description |
|---|---|---|
QPalette::Disabled | 1 | |
QPalette::Active | 0 | |
QPalette::Inactive | 2 | |
QPalette::Normal | Active | synonym for Active |
The ColorRole enum defines the different symbolic color roles used in current GUIs.
The central roles are:
| Constant | Value | Description |
|---|---|---|
QPalette::Window | 10 | A general background color. |
QPalette::Background | Window | This value is obsolete. Use Window instead. |
QPalette::WindowText | 0 | A general foreground color. |
QPalette::Foreground | WindowText | This value is obsolete. Use WindowText instead. |
QPalette::Base | 9 | Used mostly as the background color for text entry widgets, but can also be used for other painting - such as the background of combobox drop down lists and toolbar handles. It is usually white or another light color. |
QPalette::AlternateBase | 16 | Used as the alternate background color in views with alternating row colors (seeQAbstractItemView::setAlternatingRowColors()). |
QPalette::ToolTipBase | 18 | Used as the background color forQToolTip andQWhatsThis. Tool tips use the Inactive color group ofQPalette, because tool tips are not active windows. |
QPalette::ToolTipText | 19 | Used as the foreground color forQToolTip andQWhatsThis. Tool tips use the Inactive color group ofQPalette, because tool tips are not active windows. |
QPalette::Text | 6 | The foreground color used withBase. This is usually the same as theWindowText, in which case it must provide good contrast withWindow andBase. |
QPalette::Button | 1 | The general button background color. This background can be different fromWindow as some styles require a different background color for buttons. |
QPalette::ButtonText | 8 | A foreground color used with theButton color. |
QPalette::BrightText | 7 | A text color that is very different fromWindowText, and contrasts well with e.g.Dark. Typically used for text that needs to be drawn whereText orWindowText would give poor contrast, such as on pressed push buttons. Note that text colors can be used for things other than just words; text colors areusually used for text, but it's quite common to use the text color roles for lines, icons, etc. |
There are some color roles used mostly for 3D bevel and shadow effects. All of these are normally derived fromWindow, and used in ways that depend on that relationship. For example, buttons depend on it to make the bevels look attractive, and Motif scroll bars depend onMid to be slightly different fromWindow.
| Constant | Value | Description |
|---|---|---|
QPalette::Light | 2 | Lighter thanButton color. |
QPalette::Midlight | 3 | BetweenButton andLight. |
QPalette::Dark | 4 | Darker thanButton. |
QPalette::Mid | 5 | BetweenButton andDark. |
QPalette::Shadow | 11 | A very dark color. By default, the shadow color isQt::black. |
Selected (marked) items have two roles:
| Constant | Value | Description |
|---|---|---|
QPalette::Highlight | 12 | A color to indicate a selected item or the current item. By default, the highlight color isQt::darkBlue. |
QPalette::HighlightedText | 13 | A text color that contrasts withHighlight. By default, the highlighted text color isQt::white. |
There are two color roles related to hyperlinks:
| Constant | Value | Description |
|---|---|---|
QPalette::Link | 14 | A text color used for unvisited hyperlinks. By default, the link color isQt::blue. |
QPalette::LinkVisited | 15 | A text color used for already visited hyperlinks. By default, the linkvisited color isQt::magenta. |
Note that we do not use theLink andLinkVisited roles when rendering rich text in Qt, and that we recommend that you use CSS and theQTextDocument::setDefaultStyleSheet() function to alter the appearance of links. For example:
QTextBrowser browser;QColor linkColor(Qt::red);QString sheet=QString::fromLatin1("a { text-decoration: underline; color: %1 }").arg(linkColor.name()); browser.document()->setDefaultStyleSheet(sheet);
| Constant | Value | Description |
|---|---|---|
QPalette::NoRole | 17 | No role; this special role is often used to indicate that a role has not been assigned. |
Constructs a palette object that uses the application's default palette.
See alsoQApplication::setPalette() andQApplication::palette().
Constructs a palette from thebutton color. The other colors are automatically calculated, based on this color.Window will be the button color as well.
Constructs a palette from thebutton color. The other colors are automatically calculated, based on this color.Window will be the button color as well.
Constructs a palette from abutton color and awindow. The other colors are automatically calculated, based on these colors.
Constructs a palette. You can pass either brushes, pixmaps or plain colors forwindowText,button,light,dark,mid,text,bright_text,base andwindow.
See alsoQBrush.
Constructs a copy ofp.
This constructor is fast thanks toimplicit sharing.
Destroys the palette.
Returns the alternate base brush of the current color group.
Returns the base brush of the current color group.
Returns the bright text foreground brush of the current color group.
Returns the brush in the specified colorgroup, used for the given colorrole.
See alsocolor(),setBrush(), andColorRole.
This is an overloaded function.
Returns the brush that has been set for the given colorrole in the currentColorGroup.
See alsocolor(),setBrush(), andColorRole.
Returns the button brush of the current color group.
Returns the button text foreground brush of the current color group.
Returns a number that identifies the contents of thisQPalette object. DistinctQPalette objects can have the same key if they refer to the same contents.
The cacheKey() will change when the palette is altered.
Returns the color in the specified colorgroup, used for the given colorrole.
See alsobrush(),setColor(), andColorRole.
This is an overloaded function.
Returns the color that has been set for the given colorrole in the currentColorGroup.
Returns the palette's current color group.
See alsosetCurrentColorGroup().
Returns the dark brush of the current color group.
Returns the highlight brush of the current color group.
Returns the highlighted text brush of the current color group.
Returns true if theColorGroupcg andColorRolecr has been set previously on this palette; otherwise returns false.
This function was introduced in Qt 4.2.
See alsosetBrush().
Returns true if this palette andp are copies of each other, i.e. one of them was created as a copy of the other and neither was subsequently modified; otherwise returns false. This is much stricter than equality.
See alsooperator=() andoperator==().
Returns true (usually quickly) if color groupcg1 is equal tocg2; otherwise returns false.
Returns the light brush of the current color group.
Returns the unvisited link text brush of the current color group.
Returns the visited link text brush of the current color group.
Returns the mid brush of the current color group.
Returns the midlight brush of the current color group.
Returns a newQPalette that has attributes copied fromother.
Sets the brush for the given colorrole to the specifiedbrush for all groups in the palette.
See alsobrush(),setColor(), andColorRole.
This is an overloaded function.
Sets the brush in the specified colorgroup, used for the given colorrole, tobrush.
See alsobrush(),setColor(), andColorRole.
Sets the color in the specified colorgroup, used for the given colorrole, to the specified solidcolor.
See alsosetBrush(),color(), andColorRole.
This is an overloaded function.
Sets the color used for the given colorrole, in all color groups, to the specified solidcolor.
See alsobrush(),setColor(), andColorRole.
Sets a the group atcg. You can pass either brushes, pixmaps or plain colors forwindowText,button,light,dark,mid,text,bright_text,base andwindow.
See alsoQBrush.
Set the palette's current color group tocg.
See alsocurrentColorGroup().
Returns the shadow brush of the current color group.
Returns the text foreground brush of the current color group.
Returns the tool tip base brush of the current color group. This brush is used byQToolTip andQWhatsThis.
Note:Tool tips use the Inactive color group ofQPalette, because tool tips are not active windows.
This function was introduced in Qt 4.4.
Returns the tool tip text brush of the current color group. This brush is used byQToolTip andQWhatsThis.
Note:Tool tips use the Inactive color group ofQPalette, because tool tips are not active windows.
This function was introduced in Qt 4.4.
Returns the window (general background) brush of the current color group.
Returns the window text (general foreground) brush of the current color group.
Returns the palette as aQVariant
Returns true (slowly) if this palette is different fromp; otherwise returns false (usually quickly).
Note:The currentColorGroup is not taken into account when comparing palettes
See alsooperator==().
Assignsp to this palette and returns a reference to this palette.
This operation is fast thanks toimplicit sharing.
Returns true (usually quickly) if this palette is equal top; otherwise returns false (slowly).
Note:The currentColorGroup is not taken into account when comparing palettes
See alsooperator!=().
Writes the palette,p to the streams and returns a reference to the stream.
See alsoFormat of the QDataStream operators.
Reads a palette from the stream,s into the palettep, and returns a reference to the stream.
See alsoFormat of the QDataStream operators.
© 2016 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of theGNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.