Класс QStyleOption

Класс QStyleOption хранит параметры, используемые функциями QStyle. Подробнее...

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

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

Открытые функции

Открытые переменные

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

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

Класс QStyleOption хранит параметры, используемые функциями QStyle.

QStyleOption и его подклассы содержат всю информацию, необходимую функциям QStyle для отрисовки графического элемента.

Из соображений производительности в нем мало функций-членов, и доступ к переменным-членам осуществляется напрямую (т. е. с помощью оператора . или ->). Этот низкоуровневый подход делает структуры простыми в использовании и подчеркивает, что это просто параметры, используемые функциями стиля.

Вызывающий функцию QStyle обычно создает объекты QStyleOption в стеке. Это, в сочетании с обширным использованием Qt неявного совместного использования для типов, таких как QString, QPalette и QColor, гарантирует, что ненужное выделение памяти не происходит.

Следующий фрагмент кода демонстрирует, как использовать конкретный подкласс QStyleOption для рисования кнопки:

void MyPushButton::paintEvent(QPaintEvent *)
{
    QStyleOptionButton option;
    option.initFrom(this);
    option.state = isDown() ? QStyle::State_Sunken : QStyle::State_Raised;
    if (isDefault())
        option.features |= QStyleOptionButton::DefaultButton;
    option.text = text();
    option.icon = icon();

    QPainter painter(this);
    style()->drawControl(QStyle::CE_PushButton, &option, &painter, this);
}

В нашем примере элемент управления — это QStyle::CE_PushButton, и согласно документации к QStyle::drawControl() соответствующий класс — QStyleOptionButton.

При реализации функций QStyle, принимающих параметр QStyleOption, часто требуется привести QStyleOption к подклассу. Для безопасности можно использовать qstyleoption_cast() для проверки правильности типа указателя. Например:

void MyStyle::drawPrimitive(PrimitiveElement element,
                            const QStyleOption *option,
                            QPainter *painter,
                            const QWidget *widget)
{
    if (element == PE_FrameFocusRect) {
        const QStyleOptionFocusRect *focusRectOption =
                qstyleoption_cast<const QStyleOptionFocusRect *>(option);
        if (focusRectOption) {
            // ...
        }
    }
    // ...
}

Функция qstyleoption_cast() вернет 0, если объект, на который option указывает, не является нужного типа.

Пример использования параметров стиля см. в примере Styles.

См. также QStyle и QStylePainter.

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

перечисление QStyleOption::OptionType

Это перечисление используется внутри QStyleOption, его подклассами и функцией qstyleoption_cast() для определения типа параметра стиля. Как правило, вам не нужно об этом беспокоиться, если вы не хотите создать собственный подкласс QStyleOption и собственные стили.

Следующие значения используются для пользовательских элементов управления:

См. также тип.

перечисление QStyleOption::StyleOptionType

Это перечисление используется для хранения информации о типе стиля, и оно определено для каждого подкласса QStyleOption.

Тип используется внутри QStyleOption, его подклассами и qstyleoption_cast() для определения типа стиля. В общем случае вам не нужно беспокоиться об этом, если вы не хотите создать свой собственный подкласс QStyleOption и свой собственный стиль.

См. также StyleOptionVersion.

перечисление QStyleOption::StyleOptionVersion

Это перечисление используется для хранения информации о версии стиля, и оно определено для каждого подкласса QStyleOption.

Версия используется подклассами QStyleOption для реализации расширений без нарушения совместимости. Если вы используете qstyleoption_cast(), вам обычно не нужно проверять ее.

См. также StyleOptionType.

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

QStyleOption::QStyleOption(int version = QStyleOption::Version, int type = SO_Default)

Создаёт QStyleOption со специфицированными version и type.

Версия не имеет особого значения для QStyleOption; она может использоваться подклассами для различения различных версий одного и того же типа опции.

Переменная-член state инициализируется значением QStyle::State_None.

См. также version и type.

QStyleOption::QStyleOption(const QStyleOption &other)

Создает копию other.

QStyleOption::~QStyleOption()

Удаляет этот объект опции стиля.

void QStyleOption::initFrom(const QWidget *widget)

Инициализирует члены state, direction, rect, palette, fontMetrics и styleObject на основе указанного widget.

Это удобная функция; члены также могут быть инициализированы вручную.

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

См. также QWidget::layoutDirection(), QWidget::rect(), QWidget::palette(), и QWidget::fontMetrics().

QStyleOption &QStyleOption::operator=(const QStyleOption &other)

Присваивает other этому QStyleOption.

void MyStyle::drawPrimitive(PrimitiveElement element,
                            const QStyleOption *option,
                            QPainter *painter,
                            const QWidget *widget)
{
    if (element == PE_FrameFocusRect) {
        const QStyleOptionFocusRect *focusRectOption =
                qstyleoption_cast<const QStyleOptionFocusRect *>(option);
        if (focusRectOption) {
            // ...
        }
    }
    // ...
}