Класс QPalette

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

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

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

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

Статические общедоступные члены

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

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

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

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

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

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

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

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

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

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

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

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

Обратите внимание, что роли 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::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

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

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

const QBrush &QPalette::midlight() const

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

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

const QBrush &QPalette::placeholderText() const

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

Примечание: Перед Qt 5.12 цвет текста-заполнителя был жёстко закодирован в коде как QPalette::text().color() с альфа-каналом 128. Мы продолжаем поддерживать это поведение по умолчанию, если вы не установите свою собственную кисть. Можно вернуть исходное значение цвета-заполнителя, установив специальный конструктор по умолчанию для QBrush в качестве кисти-заполнителя.

Эта функция была введена в 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)

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

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

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

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

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

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

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

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

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

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