QStyle Class

./myapplication -style windows

void MyWidget::paintEvent(QPaintEvent * /* event */)
{
    QPainter painter(this);

    QStyleOptionFocusRect option;
    option.initFrom(this);
    option.backgroundColor = palette().color(QPalette::Window);

    style()->drawPrimitive(QStyle::PE_FrameFocusRect, &option, &painter, this);
}

    QStylePainter painter(this);
    ...
painter.drawPrimitive(QStyle::PE_FrameFocusRect, option);

QPainter painter(this);
    ...
style()->drawPrimitive(QStyle::PE_FrameFocusRect, &option, &painter, this);

class CustomStyle : public QProxyStyle
{
    Q_OBJECT

public:
    explicit CustomStyle(const QWidget *widget = nullptr);
    ~CustomStyle() {}

    void drawPrimitive(PrimitiveElement element, const QStyleOption *option,
                       QPainter *painter, const QWidget *widget) const override;
};

void CustomStyle::drawPrimitive(PrimitiveElement element, const QStyleOption *option,
                                QPainter *painter, const QWidget *widget) const
{
    if (element == PE_IndicatorSpinUp || element == PE_IndicatorSpinDown) {
        QPolygon points(3);
        int x = option->rect.x();
        int y = option->rect.y();
        int w = option->rect.width() / 2;
        int h = option->rect.height() / 2;
        x += (option->rect.width() - w) / 2;
        y += (option->rect.height() - h) / 2;

        if (element == PE_IndicatorSpinUp) {
            points[0] = QPoint(x, y + h);
            points[1] = QPoint(x + w, y + h);
            points[2] = QPoint(x + w / 2, y);
        } else { // PE_SpinBoxDown
            points[0] = QPoint(x, y);
            points[1] = QPoint(x + w, y);
            points[2] = QPoint(x + w / 2, y + h);
        }

        if (option->state & State_Enabled) {
            painter->setPen(option->palette.mid().color());
            painter->setBrush(option->palette.buttonText());
        } else {
            painter->setPen(option->palette.buttonText().color());
            painter->setBrush(option->palette.mid());
        }
        painter->drawPolygon(points);
    } else {
        QProxyStyle::drawPrimitive(element, option, painter, widget);
    }
}

const QSpinBox *spinBox = qobject_cast<const QSpinBox *>(widget);
if (spinBox) {
    //...
}

#include <QtWidgets>

#include "customstyle.h"

int main(int argc, char *argv[])
{
    QApplication::setStyle(new CustomStyle);
    QApplication app(argc, argv);
    QSpinBox spinBox;
    spinBox.show();
    return app.exec();
}

./myapplication -style custom

switch (element) {
    case (PE_PanelItemViewItem): {
        painter->save();

        QPoint topLeft = option->rect.topLeft();
        QPoint bottomRight = option->rect.topRight();
        QLinearGradient backgroundGradient(topLeft, bottomRight);
        backgroundGradient.setColorAt(0.0, QColor(Qt::yellow).lighter(190));
        backgroundGradient.setColorAt(1.0, Qt::white);
        painter->fillRect(option->rect, QBrush(backgroundGradient));

        painter->restore();
    break;
    }
    default:
        QProxyStyle::drawPrimitive(element, option, painter, widget);
}

メンバ関数のドキュメント

QStyle::QStyle()

スタイルオブジェクトを作成します。

[virtual noexcept] QStyle::~QStyle()

スタイルオブジェクトを破棄します。

[static] QRect QStyle::alignedRect(Qt::LayoutDirection direction, Qt::Alignment alignment, const QSize &size, const QRect &rectangle)

指定されたsize を持つ新しい矩形を返します。この矩形は、指定されたalignment およびdirection に従って、指定されたrectangle に合わせて配置されます。

int QStyle::combinedLayoutSpacing(QSizePolicy::ControlTypes controls1, QSizePolicy::ControlTypes controls2, Qt::Orientation orientation, QStyleOption *option = nullptr, QWidget *widget = nullptr) const

レイアウト内で、controls1 とcontrols2 の間に設定すべき間隔を返します。orientation は、コントロールが横並びに配置されるか、縦に積み重ねられるかを指定します。option パラメータを使用すると、親ウィジェットに関する追加情報を渡すことができます。widget パラメータはオプションであり、option がnullptr の場合にも使用できます。

controls1 また、controls2 は、0個以上のcontrol types の論理和（OR）の組み合わせです。

この関数はレイアウトシステムによって呼び出されます。PM_LayoutHorizontalSpacing またはPM_LayoutVerticalSpacing が負の値を返した場合にのみ使用されます。

layoutSpacing()も参照してください 。

[pure virtual] void QStyle::drawComplexControl(QStyle::ComplexControl control, const QStyleOptionComplex *option, QPainter *painter, const QWidget *widget = nullptr) const

指定された `control ` を、指定された `painter ` を使用し、`option` で指定されたスタイルオプションに基づいて描画します。

widget 引数はオプションであり、コントロールの描画を補助するために使用できます。

option パラメータは、QStyleOptionComplex オブジェクトへのポインタであり、qstyleoption_cast()関数を使用して適切なサブクラスにキャストすることができます。指定されたoption のrect メンバは、論理座標でなければならないことに注意してください。この関数の再実装では、drawPrimitive()またはdrawControl()関数を呼び出す前に、visualRect()を使用して論理座標を画面座標に変換する必要があります。

以下の表は、複合コントロール要素と、それに関連付けられたスタイルオプションのサブクラスを一覧表示しています。スタイルオプションには、コントロールを描画するために必要なすべてのパラメータが含まれており、これには描画時に使用されるstyle flags を保持するQStyleOption::state も含まれます。また、この表では、指定されたoption を適切なサブクラスにキャストする際に、どのフラグが設定されるかも説明しています。

drawPrimitive() およびdrawControl()も参照してください 。

[pure virtual] void QStyle::drawControl(QStyle::ControlElement element, const QStyleOption *option, QPainter *painter, const QWidget *widget = nullptr) const

指定されたelement を、指定されたpainter を使用して、option で指定されたスタイルオプションで描画します。

widget 引数はオプションであり、コントロールの描画補助として使用できます。option パラメータは、QStyleOption オブジェクトへのポインタであり、qstyleoption_cast()関数を使用して適切なサブクラスにキャストすることができます。

以下の表は、コントロール要素とそれに関連付けられたスタイルオプションのサブクラスを一覧表示したものです。スタイルオプションには、コントロールの描画に必要なすべてのパラメータが含まれており、これには描画時に使用されるスタイルフラグを保持する `QStyleOption::state ` も含まれます。また、この表では、指定されたオプションを適切なサブクラスにキャストする際に、どのフラグが設定されるかについても説明しています。

なお、ここにリストされていないコントロール要素がある場合は、その要素が単純な `QStyleOption ` オブジェクトを使用しているためです。

drawPrimitive() およびdrawComplexControl()も参照してください 。

[virtual] void QStyle::drawItemPixmap(QPainter *painter, const QRect &rectangle, int alignment, const QPixmap &pixmap) const

指定されたpixmap を、指定されたrectangle に、指定されたalignment に従って、渡されたpainter を使用して描画します。

drawItemText()も参照してください 。

[virtual] void QStyle::drawItemText(QPainter *painter, const QRect &rectangle, int alignment, const QPalette &palette, bool enabled, const QString &text, QPalette::ColorRole textRole = QPalette::NoRole) const

指定された「text 」を、指定された「rectangle 」に、提供された「painter 」および「palette 」を使用して描画します。

テキストはペインターのペンを使用して描画され、指定されたalignment に従って配置および改行されます。明示的なtextRole が指定されている場合、テキストはpalette の指定された役割に対応する色を使用して描画されます。enabled パラメータは、アイテムが有効かどうかを示します。この関数を再実装する際は、enabled パラメータがアイテムの描画方法に影響を与えるようにする必要があります。

Qt::Alignment およびdrawItemPixmap()も参照してください 。

[pure virtual] void QStyle::drawPrimitive(QStyle::PrimitiveElement element, const QStyleOption *option, QPainter *painter, const QWidget *widget = nullptr) const

指定されたプリミティブ `element ` を、指定された `painter ` を用いて、`option` で指定されたスタイルオプションに従って描画します。

widget 引数はオプションであり、プリミティブ要素の描画に役立つウィジェットを含む場合があります。

以下の表は、プリミティブ要素とそれに関連付けられたスタイルオプションのサブクラスを一覧表示しています。スタイルオプションには、要素を描画するために必要なすべてのパラメータが含まれており、これには描画時に使用されるスタイルフラグを保持するQStyleOption::state も含まれます。また、この表では、指定されたオプションを適切なサブクラスにキャストする際に、どのフラグが設定されるかについても説明しています。

なお、ここにプリミティブ要素が記載されていない場合は、その要素が単純な `QStyleOption ` オブジェクトを使用しているためです。

drawComplexControl() およびdrawControl()も参照してください 。

[pure virtual] QPixmap QStyle::generatedIconPixmap(QIcon::Mode iconMode, const QPixmap &pixmap, const QStyleOption *option) const

指定されたpixmap のコピーを返します。このコピーは、指定されたiconMode に準拠するようにスタイルが設定され、option で指定されたパレットが反映されています。

option パラメータには追加情報を渡すことができますが、パレットを含んでいる必要があります。

すべてのピクマップがこれに準拠するわけではないことに注意してください。その場合、返されるピクマップは単なるコピーとなります。

QIconも参照してください 。

[pure virtual] QStyle::SubControl QStyle::hitTestComplexControl(QStyle::ComplexControl control, const QStyleOptionComplex *option, const QPoint &position, const QWidget *widget = nullptr) const

指定されたposition にあるサブコントロールを、指定された複合control で返します（スタイルオプションはoption で指定されます）。

なお、position は画面座標で表現されることに注意してください。

option 引数は、QStyleOptionComplex オブジェクト（またはそのサブクラスのいずれか）へのポインタです。このオブジェクトは、qstyleoption_cast()関数を使用して適切な型にキャストできます。詳細については、drawComplexControl()を参照してください。widget 引数はオプションであり、この関数に対する追加情報を含めることができます。

drawComplexControl() およびsubControlRect()も参照してください 。

[virtual] QRect QStyle::itemPixmapRect(const QRect &rectangle, int alignment, const QPixmap &pixmap) const

指定されたrectangle 内の領域のうち、定義されたalignment に従って指定されたpixmap を描画する領域を返します。

[virtual] QRect QStyle::itemTextRect(const QFontMetrics &metrics, const QRect &rectangle, int alignment, bool enabled, const QString &text) const

指定されたrectangle 内の領域を返します。この領域内では、指定されたフォントmetrics およびalignment に従って、渡されたtext が描画されます。enabled パラメータは、関連する項目が有効かどうかを示します。

指定されたrectangle がtext の描画に必要な領域よりも大きい場合、返される矩形は、指定されたalignment に従ってrectangle 内でオフセットされます。たとえば、alignment がQt::AlignCenter の場合、返される矩形はrectangle 内で中央に配置されます。指定されたrectangle が必要な領域よりも小さい場合、返される矩形はtext を描画するのに十分な最小の矩形となります。

Qt::Alignmentも参照してください 。

[pure virtual] int QStyle::layoutSpacing(QSizePolicy::ControlType control1, QSizePolicy::ControlType control2, Qt::Orientation orientation, const QStyleOption *option = nullptr, const QWidget *widget = nullptr) const

レイアウト内で、control1 とcontrol2 の間に設定すべき間隔を返します。orientation は、コントロールが横並びに配置されるか、縦に積み重ねられるかを指定します。option パラメータを使用すると、親ウィジェットに関する追加情報を渡すことができます。widget パラメータはオプションであり、option がnullptr の場合にも使用できます。

この関数はレイアウトシステムによって呼び出されます。PM_LayoutHorizontalSpacing またはPM_LayoutVerticalSpacing が負の値を返した場合にのみ使用されます。

combinedLayoutSpacing()も参照してください 。

[since 6.1] QString QStyle::name() const

スタイルの名前を返します。

この値は、QStyleFactory::create() を使用してスタイルを作成する際に利用できます。

この関数は Qt 6.1 で導入されました。

QStyleFactory::create()も参照してください 。

[pure virtual] int QStyle::pixelMetric(QStyle::PixelMetric metric, const QStyleOption *option = nullptr, const QWidget *widget = nullptr) const

指定されたピクセルの値metric を返します。

指定されたoption およびwidget は、メトリックの計算に使用できます。option は、qstyleoption_cast()関数を使用して適切な型にキャストできます。option は、それを利用できるPixelMetricsであってもゼロになる場合があることに注意してください。適切なoption のキャストについては、以下の表を参照してください:

ピクセルメトリックの中には、ウィジェットから呼び出されるものと、スタイル内部でのみ呼び出されるものがあります。メトリックがウィジェットから呼び出されない場合、それを活用するかどうかはスタイル作成者の裁量に委ねられます。スタイルによっては、これが適切でない場合もあります。

[virtual] void QStyle::polish(QWidget *widget)

指定されたwidget の外観を初期化します。

この関数は、ウィジェットが完全に生成された後、初めて表示される直前の時点で、各ウィジェットに対して呼び出されます。

デフォルトの実装では何も行われないことに注意してください。この関数で適切な処理としては、ウィジェットに対して QWidget::setBackgroundMode() 関数を呼び出すことが考えられます。 たとえば、ジオメトリを設定するためにこの関数を使用しないでください。この関数を再実装すると、ウィジェットの外観を変更できる裏口が提供されますが、Qt のスタイルエンジンを使用している場合、この関数を実装する必要はほとんどありません。代わりに、drawItemPixmap()、drawItemText()、drawPrimitive() などを再実装してください。

QWidget::inherits() 関数は、クラス固有のカスタマイズを行うのに十分な情報を提供する場合があります。しかし、新しいQStyle のサブクラスは、現在および将来のすべてのウィジェットと適切に動作することが期待されるため、ハードコーディングによるカスタマイズは限定的に使用することを推奨します。

unpolish()も参照してください 。

[virtual] void QStyle::polish(QApplication *application)

指定されたapplication オブジェクトの初期化が遅延しています。

[virtual] void QStyle::polish(QPalette &palette)

カラーパレットに関するスタイル固有の要件（ある場合）に従って、palette を変更します。

QPalette およびQApplication::setPalette()も参照してください 。

const QStyle *QStyle::proxy() const

この関数は、このスタイルの現在のプロキシを返します。デフォルトでは、ほとんどのスタイルは自分自身を返します。ただし、プロキシスタイルが使用されている場合、そのスタイルはプロキシに対してコールバックを行うことが可能になります。

[pure virtual] QSize QStyle::sizeFromContents(QStyle::ContentsType type, const QStyleOption *option, const QSize &contentsSize, const QWidget *widget = nullptr) const

指定されたoption およびtype で記述される要素のサイズを、渡されたcontentsSize に基づいて返します。

option 引数は、QStyleOption またはそのサブクラスのいずれかへのポインタです。option は、qstyleoption_cast()関数を使用して適切な型にキャストできます。widget はオプションの引数であり、サイズの計算に使用される追加情報を含むことができます。

適切なoption へのキャストについては、以下の表を参照してください：

「 ContentsType 」および「QStyleOption 」も参照してください 。

[static] int QStyle::sliderPositionFromValue(int min, int max, int logicalValue, int span, bool upsideDown = false)

指定されたlogicalValue をピクセル位置に変換します。min パラメータは0に、max はspan にそれぞれ対応し、その他の値はこれらの中間に均等に割り当てられます。

span が4096未満である限り、この関数はオーバーフローすることなく整数の全範囲を処理できます。

デフォルトでは、この関数は、水平方向の項目については最大値が右側に、垂直方向の項目については下側にあると想定しています。この動作を逆にするには、upsideDown パラメータを true に設定してください。

sliderValueFromPosition()も参照してください 。

[static] int QStyle::sliderValueFromPosition(int min, int max, int position, int span, bool upsideDown = false)

指定されたピクセルposition を論理値に変換します。0はmin パラメータに対応し、span はmax に対応し、その他の値はこれらの中間に均等に割り振られます。

この関数は、オーバーフローすることなく整数の全範囲を処理できます。

デフォルトでは、この関数は、水平方向の項目については最大値が右側に、垂直方向の項目については下側にあると想定します。この動作を逆にするには、upsideDown パラメータをtrueに設定してください。

sliderPositionFromValue()も参照してください 。

[pure virtual] QIcon QStyle::standardIcon(QStyle::StandardPixmap standardIcon, const QStyleOption *option = nullptr, const QWidget *widget = nullptr) const

指定されたstandardIcon に対応するアイコンを返します。

standardIcon は、既存のGUIスタイルやガイドラインに準拠できる標準的なピクマップです。option 引数を使用すると、適切なアイコンを定義する際に必要な追加情報を渡すことができます。widget 引数はオプションであり、アイコンの決定を支援するためにも使用できます。

[virtual] QPalette QStyle::standardPalette() const

スタイルの標準パレットを返します。

システムカラーをサポートしているシステムでは、スタイルの標準パレットは使用されないことに注意してください。特に、Windows Vista および Mac スタイルでは、標準パレットは使用されず、ネイティブのテーマエンジンが利用されます。これらのスタイルでは、QApplication::setPalette() を使用してパレットを設定しないでください。

QApplication::setPalette()も参照してください 。

[pure virtual] int QStyle::styleHint(QStyle::StyleHint hint, const QStyleOption *option = nullptr, const QWidget *widget = nullptr, QStyleHintReturn *returnData = nullptr) const

指定されたスタイル `hint ` を表す整数を返します。これは、指定されたスタイル `option` で記述された、指定された `widget ` に対するものです。

returnData これは、クエリを実行するウィジェットが、styleHint() が返す整数よりも詳細なデータを必要とする場合に使用されます。詳細については、QStyleHintReturn クラスの説明を参照してください。

[pure virtual] QRect QStyle::subControlRect(QStyle::ComplexControl control, const QStyleOptionComplex *option, QStyle::SubControl subControl, const QWidget *widget = nullptr) const

指定されたsubControl を含む、与えられた複素数control の矩形を返します（スタイルはoption で指定されます）。この矩形は画面座標で定義されます。

option 引数は、QStyleOptionComplex またはそのサブクラスのいずれかへのポインタであり、qstyleoption_cast()関数を使用して適切な型にキャストすることができます。詳細については、drawComplexControl()を参照してください。widget はオプションであり、この関数に対する追加情報を含めることができます。

drawComplexControl()も参照してください 。

[pure virtual] QRect QStyle::subElementRect(QStyle::SubElement element, const QStyleOption *option, const QWidget *widget = nullptr) const

指定されたelement に対し、提供されたスタイルoption に従ってサブ領域を返します。返される矩形は画面座標で定義されます。

widget 引数はオプションであり、領域の決定を補助するために使用できます。QStyleOption オブジェクトは、qstyleoption_cast()関数を使用して適切な型にキャストできます。適切なoption のキャストについては、以下の表を参照してください：

[virtual] void QStyle::unpolish(QWidget *widget)

指定されたwidget の外観を初期化解除します。

この関数は、polish() の対応関数です。スタイルが動的に変更されるたびに、ポリッシュ処理済みのウィジェットごとに呼び出されます。新しいスタイルが設定を再度ポリッシュ処理する前に、以前のスタイルはその設定のポリッシュ処理を解除する必要があります。

unpolish() は、ウィジェットが破棄された場合にのみ呼び出されることに注意してください。これは、例えば、UI からウィジェットを削除し、キャッシュした後、スタイルが変更された後に再び挿入する場合など、場合によっては問題を引き起こす可能性があります。Qt のクラスの中には、ウィジェットをキャッシュするものがあるからです。

polish()も参照してください 。

[virtual] void QStyle::unpolish(QApplication *application)

指定されたapplication の初期化を解除します。

[static] Qt::Alignment QStyle::visualAlignment(Qt::LayoutDirection direction, Qt::Alignment alignment)

Qt::AlignAbsolute を持たないQt::AlignLeft またはQt::AlignRight の `alignment ` を、レイアウトdirection に基づいて、Qt::AlignAbsolute を持つQt::AlignLeft またはQt::AlignRight に変換します。その他の配置フラグは変更されません。

水平方向の配置が指定されていない場合、この関数は指定されたレイアウトdirection に対するデフォルトの配置を返します。

QWidget::layoutDirection

[static] QPoint QStyle::visualPos(Qt::LayoutDirection direction, const QRect &boundingRectangle, const QPoint &logicalPosition)

logicalPosition 指定されたdirection を、指定された に基づいて画面座標に変換したものを返します。boundingRectangle は、変換を行う際に使用されます。

「QWidget::layoutDirection」も参照してください 。

[static] QRect QStyle::visualRect(Qt::LayoutDirection direction, const QRect &boundingRectangle, const QRect &logicalRectangle)

指定された `direction` に基づいて、指定された `logicalRectangle ` を画面座標に変換して返します。変換を行う際には、`boundingRectangle ` が使用されます。

この関数は、右から左へのデスクトップをサポートするために提供されており、通常はsubControlRect()関数の実装で使用されます。

QWidget::layoutDirectionも参照してください 。