Spec-Zone.ru › Qt 6.0

Класс QPalette

Класс QPalette содержит группы цветов для каждого состояния виджета. Подробнее...

Заголовок: #include <QPalette>
CMake: find_package(Qt6 COMPONENTS Gui REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake: QT += gui
  • Список всех членов, включая унаследованные
  • Устаревшие члены

Открытые типы

перечисление ColorGroup { Disabled, Active, Inactive, Normal }
перечисление ColorRole { Window, WindowText, Base, AlternateBase, ToolTipBase, …, NoRole }

Общедоступные функции

QPalette(QPalette &&other)
QPalette(const QPalette &p)
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 QColor &button, const QColor &window)
QPalette(Qt::GlobalColor button)
QPalette(const QColor &button)
QPalette()
QPalette & operator=(QPalette &&other)
QPalette & operator=(const QPalette &p)
~QPalette()
const QBrush & alternateBase() const
const QBrush & base() const
const QBrush & brightText() const
const QBrush & brush(QPalette::ColorGroup group, QPalette::ColorRole role) const
const QBrush & brush(QPalette::ColorRole role) const
const QBrush & button() const
const QBrush & buttonText() const
qint64 cacheKey() const
const QColor & color(QPalette::ColorGroup group, QPalette::ColorRole role) const
const QColor & color(QPalette::ColorRole role) const
QPalette::ColorGroup currentColorGroup() const
const QBrush & dark() const
const QBrush & highlight() const
const QBrush & highlightedText() const
bool isBrushSet(QPalette::ColorGroup cg, QPalette::ColorRole cr) const
bool isCopyOf(const QPalette &p) const
bool isEqual(QPalette::ColorGroup cg1, QPalette::ColorGroup cg2) const
const QBrush & light() const
const QBrush & link() const
const QBrush & linkVisited() const
const QBrush & mid() const
const QBrush & midlight() const
const QBrush & placeholderText() const
QPalette resolve(const QPalette &other) const
void setBrush(QPalette::ColorRole role, const QBrush &brush)
void setBrush(QPalette::ColorGroup group, QPalette::ColorRole role, const QBrush &brush)
void setColor(QPalette::ColorGroup group, QPalette::ColorRole role, const QColor &color)
void setColor(QPalette::ColorRole role, const QColor &color)
void setColorGroup(QPalette::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(QPalette::ColorGroup cg)
const QBrush & shadow() const
void swap(QPalette &other)
const QBrush & text() const
const QBrush & toolTipBase() const
const QBrush & toolTipText() const
const QBrush & window() const
const QBrush & windowText() const
QVariant operator QVariant() const
bool operator!=(const QPalette &p) const
bool operator==(const QPalette &p) const

Связанные нечленные функции

QDataStream & operator<<(QDataStream &s, const QPalette &p)
QDataStream & operator>>(QDataStream &s, QPalette &p)

Подробное описание

Палитра состоит из трёх групп цветов: Активная, Отключенная и Неактивная. Все виджеты в Qt содержат палитру и используют её для собственного отображения. Это делает пользовательский интерфейс легко настраиваемым и более простым в поддержании согласованности.

Если вы создаёте новый виджет, мы настоятельно рекомендуем использовать цвета из палитры, а не жёстко задавать конкретные цвета.

Группы цветов:

  • Активная группа используется для окна, имеющего фокус клавиатуры.
  • Неактивная группа используется для других окон.
  • Отключенная группа используется для виджетов (не окон), которые по какой-либо причине отключены.

Как активные, так и неактивные окна могут содержать отключенные виджеты. (Отключенные виджеты часто называются недоступными или затенёнными.)

В большинстве стилей Active и Inactive выглядят одинаково.

Цвета и кисти могут быть установлены для определённых ролей в любой из цветовых групп палитры с помощью setColor() и setBrush(). Цветовая группа содержит набор цветов, используемых виджетами для собственного рисования. Мы рекомендуем виджетам использовать роли цветовых групп из палитры, такие как "foreground" и "base", а не литеральные цвета, такие как "red" или "turquoise". Роли цвета перечислены и определены в документации ColorRole.

Мы настоятельно рекомендуем использовать палитру по умолчанию текущего стиля (возвращается функцией QGuiApplication::palette()) и изменять её по мере необходимости. Это делается виджетами Qt при их рисовании.

Чтобы изменить цветовую группу, вызываются функции setColor() и setBrush(), в зависимости от того, нужен ли вам чистый цвет или шаблон растрового изображения.

Существуют также соответствующие функции получения color() и brush(), и часто используемая вспомогательная функция для получения ColorRole для текущей ColorGroup: window(), windowText(), base() и т.д.

Вы можете скопировать палитру, используя конструктор копирования, и проверить, являются ли две палитры идентичными, используя isCopyOf().

QPalette оптимизирован за счёт использования неявного разделения, поэтому передача объектов QPalette в качестве аргументов очень эффективна.

Предупреждение: Некоторые стили не используют палитру для всего рисования, например, если они используют собственные механизмы тем. Это относится как к стилям Windows Vista, так и к стилям macOS.

См. также QApplication::setPalette(), QWidget::setPalette() и QColor.

Документация по типам членов

enum QPalette::ColorGroup

Константа Значение Описание
QPalette::Disabled 1
QPalette::Active 0
QPalette::Inactive 2
QPalette::Normal Active синоним для Active

enum QPalette::ColorRole

Color Roles

Перечисление ColorRole определяет различные символические цветовые роли, используемые в современных графических интерфейсах.

Центральные роли:

Константа Значение Описание
QPalette::Window 10 Общий цвет фона.
QPalette::WindowText 0 Общий цвет переднего плана.
QPalette::Base 9 В основном используется как цвет фона для виджетов ввода текста, но также может использоваться для другой отрисовки — например, фона раскрывающихся списков в combobox и ручек панелей инструментов. Обычно это белый или другой светлый цвет.
QPalette::AlternateBase 16 Используется как альтернативный цвет фона в представлениях со строками, чередующими цвета (см. QAbstractItemView::setAlternatingRowColors()).
QPalette::ToolTipBase 18 Используется как цвет фона для QToolTip и QWhatsThis. Подсказки используют цветовую группу Inactive из QPalette, поскольку подсказки не являются активными окнами.
QPalette::ToolTipText 19 Используется как цвет переднего плана для QToolTip и QWhatsThis. Подсказки используют цветовую группу Inactive из QPalette, поскольку подсказки не являются активными окнами.
QPalette::PlaceholderText 20 Используется как цвет заполнителя для различных виджетов ввода текста. Это значение перечисления было введено в Qt 5.12
QPalette::Text 6 Цвет переднего плана, используемый с Base. Обычно это то же самое, что и WindowText, в этом случае он должен обеспечивать хороший контраст с Window и Base.
QPalette::Button 1 Общий цвет фона кнопки. Этот фон может отличаться от Window, поскольку некоторые стили требуют другого цвета фона для кнопок.
QPalette::ButtonText 8 Цвет переднего плана, используемый с цветом Button.
QPalette::BrightText 7 Цвет текста, который сильно отличается от WindowText и хорошо контрастирует, например, с Dark. Обычно используется для текста, который необходимо нарисовать там, где Text или WindowText дадут плохой контраст, например, на нажатых кнопках. Обратите внимание, что цвета текста могут использоваться не только для слов; цвета текста обычно используются для текста, но довольно часто роли цвета текста используются для линий, значков и т. д.

Существуют некоторые цветовые роли, используемые в основном для эффектов 3D-скоса и тени. Все они обычно выводятся из Window, и используются способами, которые зависят от этой связи. Например, кнопки зависят от него, чтобы сделать скосы привлекательными, а полосы прокрутки Motif зависят от того, что Mid немного отличается от Window.

Константа Значение Описание
QPalette::Light 2 Светлее, чем цвет Button.
QPalette::Midlight 3 Между Button и Light.
QPalette::Dark 4 Темнее, чем Button.
QPalette::Mid 5 Между Button и Dark.
QPalette::Shadow 11 Очень тёмный цвет. По умолчанию цвет тени — Qt::black.

Выбранные (отмеченные) элементы имеют две роли:

Константа Значение Описание
QPalette::Highlight 12 Цвет, указывающий на выбранный элемент или текущий элемент. По умолчанию цвет выделения — Qt::darkBlue.
QPalette::HighlightedText 13 Цвет текста, контрастирующий с Highlight. По умолчанию цвет выделенного текста — Qt::white.

Существует две цветовые роли, связанные с гиперссылками:

Константа Значение Описание
QPalette::Link 14 Цвет текста, используемый для непосещённых гиперссылок. По умолчанию цвет ссылки — Qt::blue.
QPalette::LinkVisited 15 Цвет текста, используемый для уже посещённых гиперссылок. По умолчанию цвет посещённой ссылки — Qt::magenta.

Обратите внимание, что мы не используем роли Link и LinkVisited при отрисовке форматированного текста в Qt, и рекомендуем использовать CSS и функцию QTextDocument::setDefaultStyleSheet() для изменения внешнего вида ссылок. Например:

    QTextBrowser browser;
    QColor linkColor(Qt::red);
    QString sheet = QString::fromLatin1("a { text-decoration: underline; color: %1 }").arg(linkColor.name());
    browser.document()->setDefaultStyleSheet(sheet);
Постоянная Значение Описание
QPalette::NoRole 17 Нет роли; эта специальная роль часто используется для обозначения того, что роль не назначена.

Документация по членам-функциям

[since 5.4] QPalette::QPalette(QPalette &&other)

Перемещающее создание экземпляра QPalette, делая его указывающим на тот же объект, что и other.

После перемещения вы можете только присвоить или уничтожить other. Любая другая операция приведёт к неопределённому поведению.

Эта функция была представлена в Qt 5.4.

QPalette::QPalette(const QPalette &p)

Создаёт копию p.

Этот конструктор быстрый благодаря неявной совместной работе.

QPalette::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)

Создаёт палитру. Вы можете передать кисти, растровые изображения или обычные цвета для windowText, button, light, dark, mid, text, bright_text, base и window.

См. также QBrush.

QPalette::QPalette(const QColor &button, const QColor &window)

Создаёт палитру из цвета button и цвета window. Другие цвета автоматически вычисляются на основе этих цветов.

QPalette::QPalette(Qt::GlobalColor button)

Создаёт палитру из цвета button. Другие цвета автоматически вычисляются на основе этого цвета. Window будет также цветом кнопки.

QPalette::QPalette(const QColor &button)

Создаёт палитру из цвета button. Другие цвета автоматически вычисляются на основе этого цвета. Window будет также цветом кнопки.

QPalette::QPalette()

Создаёт объект палитры, который использует стандартную палитру приложения.

См. также QApplication::setPalette() и QApplication::palette().

[since 5.2] QPalette &QPalette::operator=(QPalette &&other)

Присваивает other этому экземпляру QPalette.

Эта функция была представлена в Qt 5.2.

QPalette &QPalette::operator=(const QPalette &p)

Присваивает p этой палитре и возвращает ссылку на эту палитру.

Эта операция быстрая благодаря неявной совместной работе.

QPalette::~QPalette()

Удаляет палитру.

const QBrush &QPalette::alternateBase() const

Возвращает альтернативную кисть основания текущей группы цветов.

См. также ColorRole и brush().

const QBrush &QPalette::base() const

Возвращает кисть основания текущей группы цветов.

См. также ColorRole и brush().

const QBrush &QPalette::brightText() const

Возвращает кисть яркого текста переднего плана текущей группы цветов.

См. также ColorRole и brush().

const QBrush &QPalette::brush(QPalette::ColorGroup group, QPalette::ColorRole role) const

Возвращает кисть в указанной группе цветов group, используемую для данной роли цвета role.

См. также color(), setBrush() и ColorRole.

const QBrush &QPalette::brush(QPalette::ColorRole role) const

Это перегруженная функция.

Возвращает кисть, установленную для данной роли цвета role в текущей ColorGroup.

См. также color(), setBrush() и ColorRole.

const QBrush &QPalette::button() const

Возвращает кисть кнопки текущей группы цветов.

См. также ColorRole и brush().

const QBrush &QPalette::buttonText() const

Возвращает кисть текста кнопки переднего плана текущей группы цветов.

См. также ColorRole и brush().

qint64 QPalette::cacheKey() const

Возвращает число, которое идентифицирует содержимое этого объекта QPalette. Различные объекты QPalette могут иметь одинаковый ключ, если они ссылаются на одно и то же содержимое.

cacheKey() изменится при изменении палитры.

const QColor &QPalette::color(QPalette::ColorGroup group, QPalette::ColorRole role) const

Возвращает цвет в указанной группе цветов group, используемый для данной роли цвета role.

См. также brush(), setColor() и ColorRole.

const QColor &QPalette::color(QPalette::ColorRole role) const

Это перегруженная функция.

Возвращает цвет, установленный для данной роли цвета role в текущей ColorGroup.

См. также brush() и ColorRole.

QPalette::ColorGroup QPalette::currentColorGroup() const

Возвращает текущую группу цветов палитры.

См. также setCurrentColorGroup().

const QBrush &QPalette::dark() const

Возвращает тёмную кисть текущей группы цветов.

См. также ColorRole и brush().

const QBrush &QPalette::highlight() const

Возвращает кисть выделения текущей группы цветов.

См. также ColorRole и brush().

const QBrush &QPalette::highlightedText() const

Возвращает кисть выделенного текста текущей группы цветов.

См. также ColorRole и brush().

bool QPalette::isBrushSet(QPalette::ColorGroup cg, QPalette::ColorRole cr) const

Возвращает true если ColorGroup cg и ColorRole cr были установлены ранее в этой палитре; в противном случае возвращает false.

ColorGroup cg должен быть меньше QPalette::NColorGroups, но вы можете использовать QPalette::Current. В этом случае будет использоваться ранее установленная текущая группа цветов.

Роль цвета ColorRole cr должна быть меньше QPalette::NColorRoles.

См. также setBrush() и currentColorGroup().

bool QPalette::isCopyOf(const QPalette &p) const

Возвращает true если эта палитра и p являются копиями друг друга, то есть одна из них была создана как копия другой и ни одна из них не была впоследствии изменена; в противном случае возвращает false. Это значительно строже, чем равенство.

END_OF_DOCUMENT_MARKER

См. также operator=() и operator==().

bool QPalette::isEqual(QPalette::ColorGroup cg1, QPalette::ColorGroup cg2) const

Возвращает true (обычно быстро), если цветовая группа cg1 равна cg2; в противном случае возвращает false.

const QBrush &QPalette::light() const

Возвращает кисть светлого цвета текущей цветовой группы.

См. также ColorRole и brush().

const QBrush &QPalette::link() const

Возвращает кисть текста необработанной ссылки текущей цветовой группы.

См. также ColorRole и brush().

const QBrush &QPalette::linkVisited() const

Возвращает кисть текста посещенной ссылки текущей цветовой группы.

См. также ColorRole и brush().

const QBrush &QPalette::mid() const

Возвращает кисть среднего цвета текущей цветовой группы.

См. также ColorRole и brush().

const QBrush &QPalette::midlight() const

Возвращает кисть цвета средней яркости текущей цветовой группы.

См. также ColorRole и brush().

[since 5.12] const QBrush &QPalette::placeholderText() const

Возвращает кисть цвета текста-заполнителя текущей цветовой группы.

Примечание: До Qt 5.12 цвет текста-заполнителя был жестко задан как QPalette::text().color() с альфа-каналом 128. В Qt 6 это независимый цвет.

Эта функция была добавлена в Qt 5.12.

См. также ColorRole и brush().

QPalette QPalette::resolve(const QPalette &other) const

Возвращает новый QPalette, который является объединением этого экземпляра и other. Цветовые роли, заданные в этом экземпляре, имеют приоритет.

void QPalette::setBrush(QPalette::ColorRole role, const QBrush &brush)

Устанавливает кисть для заданной цветовой роли role на указанную кисть brush для всех групп в палитре.

См. также brush(), setColor() и ColorRole.

void QPalette::setBrush(QPalette::ColorGroup group, QPalette::ColorRole role, const QBrush &brush)

Это перегруженная функция.

Устанавливает кисть в указанной цветовой группе group, используемую для заданной цветовой роли role, на brush.

См. также brush(), setColor() и ColorRole.

void QPalette::setColor(QPalette::ColorGroup group, QPalette::ColorRole role, const QColor &color)

Устанавливает цвет в указанной цветовой группе group, используемый для заданной цветовой роли role, на указанный сплошной цвет color.

См. также setBrush(), color() и ColorRole.

void QPalette::setColor(QPalette::ColorRole role, const QColor &color)

Это перегруженная функция.

Устанавливает цвет, используемый для заданной цветовой роли role во всех цветовых группах, на указанный сплошной цвет color.

См. также brush(), setColor() и ColorRole.

void QPalette::setColorGroup(QPalette::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)

Устанавливает группу в cg. Вы можете передать кисти, растровые изображения или обычные цвета для windowText, button, light, dark, mid, text, bright_text, base и window.

См. также QBrush.

void QPalette::setCurrentColorGroup(QPalette::ColorGroup cg)

Устанавливает текущую цветовую группу палитры в cg.

См. также currentColorGroup().

const QBrush &QPalette::shadow() const

Возвращает кисть тени текущей цветовой группы.

См. также ColorRole и brush().

[since 5.0] void QPalette::swap(QPalette &other)

Меняет местами этот экземпляр палитры с other. Эта функция очень быстрая и никогда не терпит неудач.

Эта функция была добавлена в Qt 5.0.

const QBrush &QPalette::text() const

Возвращает кисть цвета текста переднего плана текущей цветовой группы.

См. также ColorRole и brush().

const QBrush &QPalette::toolTipBase() const

Возвращает кисть базового цвета всплывающей подсказки текущей цветовой группы. Эта кисть используется QToolTip и QWhatsThis.

Примечание: Всплывающие подсказки используют неактивную цветовую группу QPalette, так как всплывающие подсказки не являются активными окнами.

См. также ColorRole и brush().

const QBrush &QPalette::toolTipText() const

Возвращает кисть цвета текста всплывающей подсказки текущей цветовой группы. Эта кисть используется QToolTip и QWhatsThis.

Примечание: Всплывающие подсказки используют неактивную цветовую группу QPalette, так как всплывающие подсказки не являются активными окнами.

См. также ColorRole и brush().

const QBrush &QPalette::window() const

Возвращает кисть окна (общего фона) текущей цветовой группы.

См. также ColorRole и brush().

const QBrush &QPalette::windowText() const

Возвращает кисть цвета текста окна (общего переднего плана) текущей цветовой группы.

См. также ColorRole и brush().

QVariant QPalette::operator QVariant() const

Возвращает палитру как QVariant

bool QPalette::operator!=(const QPalette &p) const

Возвращает true (медленно), если эта палитра отличается от p; в противном случае возвращает false (обычно быстро).

Примечание: Текущая ColorGroup не учитывается при сравнении палитр

См. также operator==().

bool QPalette::operator==(const QPalette &p) const

Возвращает true (обычно быстро), если эта палитра равна p; в противном случае возвращает false (медленно).

Примечание: Текущая ColorGroup не учитывается при сравнении палитр

См. также operator!=().

Связанные нечлены

QDataStream &operator<<(QDataStream &s, const QPalette &p)

Записывает палитру, p в поток s и возвращает ссылку на поток.

См. также Формат операторов QDataStream.

QDataStream &operator>>(QDataStream &s, QPalette &p)

Читает палитру из потока, s в палитру p, и возвращает ссылку на поток.

См. также Формат операторов QDataStream.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.0/qpalette.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API