Класс QPalette

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

• Список всех членов, включая унаследованные
• Устаревшие члены

Публичные типы

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

Связанные свободные функции

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

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

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

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

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

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

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

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

Цвета и кисти могут быть заданы для конкретных ролей в любой группе цветов палитры с помощью setColor() и setBrush(). Группа цветов содержит набор цветов, используемых виджетами для отрисовки. Рекомендуется, чтобы виджеты использовали роли цветов из палитры, такие как «передний» и «основной», а не буквальные цвета, такие как «красный» или «бирюзовый». Роли цветов перечислены и определены в документации 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

enum QPalette::ColorRole

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

Основные роли:

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

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

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

Обратите внимание, что при отрисовке форматированного текста в Qt мы не используем роли Link и LinkVisited, и рекомендуем использовать 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::QPalette()

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

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

QPalette::QPalette(const QColor &button)

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

QPalette::QPalette(Qt::GlobalColor button)

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

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

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

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 QPalette &p)

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

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

QPalette::QPalette(QPalette &&other)

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

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

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

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.

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

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

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

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

См. также 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

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

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

const QBrush &QPalette::midlight() const

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

См. также 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().

void QPalette::swap(QPalette &other)

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

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

const QBrush &QPalette::text() const

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

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

const QBrush &QPalette::toolTipBase() const

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

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

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

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

const QBrush &QPalette::toolTipText() const

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

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

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

См. также 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==().

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

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

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

QPalette &QPalette::operator=(QPalette &&other)

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

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

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

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

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

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