QStyleOptionViewItem::iconのプログラミング解説

QStyleOptionViewItem::icon は、Qt Widgetsにおけるビューアイテムのアイコンを設定するためのプロパティです。このプロパティを使用して、アイテムに表示されるアイコンを指定することができます。

使用方法

QStyleOptionViewItem::icon を使用するには、以下の手順に従います。

QModelIndex オブジェクトを取得します。これは、アイコンを設定したいアイテムに対応するインデックスです。
QStyleOptionViewItem オブジェクトを作成します。
QStyleOptionViewItem::initStyleOption() メソッドを使用して、QStyleOptionViewItem オブジェクトを初期化します。
QStyleOptionViewItem::icon プロパティに、設定したいアイコンを QIcon オブジェクトとして設定します。
QStyle::drawPrimitive() メソッドを使用して、アイテムを描画します。

例

以下のコードは、QTreeView アイテムにアイコンを設定する方法を示しています。

void MyDelegate::paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const
{
    if (option.state & QStyle::State_Selected) {
        painter->setPen(option.palette.brush(QPalette::HighlightedText).color());
    } else {
        painter->setPen(option.palette.brush(QPalette::Text).color());
    }

    QIcon icon = index.data(Qt::DecorationRole).value<QIcon>();
    if (!icon.isNull()) {
        QRect iconRect = option.decorationRect;
        painter->drawPixmap(iconRect, icon.pixmap(option.decorationSize));
    }

    QRect textRect = option.textRect();
    painter->drawText(textRect, Qt::AlignLeft | Qt::AlignVCenter, index.data(Qt::DisplayRole).toString());
}

このコードでは、QModelIndex::data() メソッドを使用して、アイテムに関連付けられたアイコンを取得しています。アイコンが存在する場合、QStyleOptionViewItem::decorationRect プロパティを使用してアイコンを描画する領域を決定し、QPainter::drawPixmap() メソッドを使用してアイコンを描画します。

アイコンのサイズは、QStyleOptionViewItem::decorationSize プロパティによって決定されます。このプロパティは、スタイルによって設定されます。
アイテムにアイコンが表示されるかどうかは、モデルによって決定されます。モデルは、Qt::DecorationRole ロールを使用して、各アイテムにアイコンを関連付けることができます。
QStyleOptionViewItem::icon プロパティは、アイテムに表示されるメインアイコンを設定するために使用されます。サブアイコンを設定するには、QStyleOptionViewItem::subIcon プロパティを使用する必要があります。

例 1: カスタムデリゲートを使用したアイコンの設定

この例では、QTreeView アイテムにアイコンを設定するためにカスタムデリゲートを使用します。

#include <QApplication>
#include <QTreeView>
#include <QStandardItemModel>
#include <QIcon>
#include <QPainter>

class MyDelegate : public QItemDelegate
{
public:
    void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override
    {
        if (option.state & QStyle::State_Selected) {
            painter->setPen(option.palette.brush(QPalette::HighlightedText).color());
        } else {
            painter->setPen(option.palette.brush(QPalette::Text).color());
        }

        QIcon icon = index.data(Qt::DecorationRole).value<QIcon>();
        if (!icon.isNull()) {
            QRect iconRect = option.decorationRect;
            painter->drawPixmap(iconRect, icon.pixmap(option.decorationSize));
        }

        QRect textRect = option.textRect();
        painter->drawText(textRect, Qt::AlignLeft | Qt::AlignVCenter, index.data(Qt::DisplayRole).toString());
    }
};

int main(int argc, char *argv[])
{
    QApplication app(argc, argv);

    QStandardItemModel model;
    model.setColumnCount(1);

    for (int i = 0; i < 10; ++i) {
        QStandardItem *item = new QStandardItem(QString("Item %1").arg(i));
        item->setData(QIcon(QString(":/images/icon%1.png").arg(i)), Qt::DecorationRole);
        model.appendRow(item);
    }

    QTreeView treeView;
    treeView.setModel(&model);
    treeView.setItemDelegate(new MyDelegate);
    treeView.show();

    return app.exec();
}

この例では、MyDelegate という名前のカスタムデリゲートクラスを作成しています。このクラスの paint() メソッドは、アイテムを描画するために使用されます。paint() メソッド内で、QStyleOptionViewItem::icon プロパティを使用して、アイテムに関連付けられたアイコンを取得します。アイコンが存在する場合、QStyleOptionViewItem::decorationRect プロパティを使用してアイコンを描画する領域を決定し、QPainter::drawPixmap() メソッドを使用してアイコンを描画します。

例 2: サブアイコンの設定

この例では、QTreeView アイテムにサブアイコンを設定する方法を示します。

#include <QApplication>
#include <QTreeView>
#include <QStandardItemModel>
#include <QIcon>
#include <QPainter>

int main(int argc, char *argv[])
{
    QApplication app(argc, argv);

    QStandardItemModel model;
    model.setColumnCount(1);

    for (int i = 0; i < 10; ++i) {
        QStandardItem *item = new QStandardItem(QString("Item %1").arg(i));
        item->setData(QIcon(QString(":/images/icon%1.png").arg(i)), Qt::DecorationRole);
        item->setData(QIcon(QString(":/images/subicon%1.png").arg(i)), Qt::SubDecorationRole);
        model.appendRow(item);
    }

    QTreeView treeView;
    treeView.setModel(&model);
    treeView.show();

    return app.exec();
}

この例では、QStandardItem::setData() メソッドを使用して、アイテムにメインアイコンとサブアイコンを設定しています。サブアイコンは、Qt::SubDecorationRole ロールを使用して設定されます。

例 3: モデルデータからのアイコン設定

この例では、モデルデータからアイコンを動的に設定する方法を示します。

#include <QApplication>
#include <QTreeView>
#include <QStandardItemModel>
#include <QIcon>
#include <QPainter>

class MyModel : public QStandardItemModel
{
public:
    QVariant data(const QModelIndex &index, int role) const override
    {
        if (role == Qt::DecorationRole

代替方法

以下に、QStyleOptionViewItem::icon の代替方法をいくつか紹介します。

カスタムデリゲートを使用する

カスタムデリゲートを使用して、アイテムを描画するコードを完全に制御することができます。この方法を使用すると、QStyleOptionViewItem::icon プロパティに頼らずに、アイコンを自由に描画することができます。

例

class MyDelegate : public QItemDelegate
{
public:
    void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override
    {
        // ...

        // アイコンを描画するコード

        // ...
    }
};

モデルデータからアイコンを取得する

モデルデータからアイコンを取得し、QPainter::drawPixmap() メソッドを使用して直接描画することができます。

例

void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const
{
    // ...

    QIcon icon = index.data(Qt::DecorationRole).value<QIcon>();
    if (!icon.isNull()) {
        QRect iconRect = option.decorationRect;
        painter->drawPixmap(iconRect, icon.pixmap(option.decorationSize));
    }

    // ...
}

スタイルシートを使用する

スタイルシートを使用して、アイテムのアイコンを指定することができます。

例

QTreeView QTreeViewItem {
    decoration-image: url(":/images/icon.png");
}

ウィジェットを使用する

アイテムの横にウィジェットを配置し、そのウィジェットにアイコンを表示することができます。

例

QHBoxLayout *layout = new QHBoxLayout;
layout->addWidget(new QLabel(icon));
layout->addWidget(new QLabel(text));
item->setLayout(layout);

選択

どの代替方法を使用するかは、状況によって異なります。カスタムデリゲートを使用すると、最も柔軟な制御が可能になりますが、コード量も増えます。モデルデータからアイコンを取得する方法は、シンプルですが、すべての状況に適しているわけではありません。スタイルシートを使用する方法は、比較的簡単ですが、カスタマイズ性は低くなります。ウィジェットを使用する方法は、最も単純な方法ですが、アイテムのレイアウトが複雑になる可能性があります。

スタイルシートを使用する場合は、アイコンのサイズと位置を適切に設定する必要があります。
QStyleOptionViewItem::icon プロパティを使用せずにアイコンを設定する場合、アイテムの選択状態や編集状態を考慮する必要があります。

QStyleOptionViewItem::iconのプログラミング解説

例 1: カスタム デリゲートを使用したアイコンの設定

代替方法

例 1: カスタムデリゲートを使用したアイコンの設定