Qtプログラミング入門:Item.dataでモデルデータを完璧に操る方法

2025-06-06

Qtのモデル/ビュープログラミングにおいて、「Item.data」は、モデル(QAbstractItemModelのサブクラス)がビュー(QTableViewQListViewQTreeViewなど)に表示するデータを提供するための非常に重要な概念です。

具体的には、モデルが提供する各アイテム(セルやノード)に関連付けられたデータを取得するために使用されます。このデータは、表示だけでなく、編集、ソート、フィルタリングなどの操作にも利用されます。

QModelIndexdata() メソッド

「Item.data」は、主に QAbstractItemModel クラスの仮想関数である data() メソッドを介してアクセスされます。

data() メソッドのシグネチャは以下のようになっています。

QVariant QAbstractItemModel::data(const QModelIndex &index, int role = Qt::DisplayRole) const
  • role: これは Qt::ItemDataRole 列挙型で定義された役割(ロール)を表す整数値です。同じアイテムでも、異なる役割を要求された場合には異なるデータを提供できます。
  • index: これは QModelIndex 型のオブジェクトで、モデル内の特定のアイテム(セルやノード)の位置を示します。行、列、そして親インデックス(ツリービューの場合)が含まれます。

role (役割) とは

role は、「どのような種類のデータが必要か」をモデルに伝えるためのキーです。ビューは、表示方法やユーザーインタラクションに応じて、異なるロールのデータを要求します。主な役割をいくつか挙げます。

  • Qt::UserRole: Qt::UserRole から始まる値は、開発者がカスタムデータを保存するために自由に使用できる役割です。これ以降の数値は、アプリケーション固有のデータを格納するために利用できます。
  • Qt::SizeHintRole: アイテムの推奨サイズヒントのデータです。
  • Qt::CheckStateRole: チェックボックスを持つアイテムのチェック状態(チェックされているか、されていないか)のデータです。
  • Qt::ForegroundRole: アイテムの前景色(テキストの色など)データです。
  • Qt::BackgroundRole: アイテムの背景色データです。
  • Qt::TextAlignmentRole: アイテムのテキストの配置(左揃え、中央揃えなど)のデータです。
  • Qt::FontRole: アイテムの表示に使用されるフォントのデータです。
  • Qt::WhatsThisRole: 「これは何?」ヘルプシステムで使用されるデータです。
  • Qt::StatusTipRole: ステータスバーに表示されるヒントのデータです。
  • Qt::ToolTipRole: アイテムにカーソルを合わせたときに表示されるツールチップのデータです。
  • Qt::DecorationRole: アイテムに関連付けられたアイコンやピクセルマップなどの装飾データです。
  • Qt::EditRole: ユーザーがアイテムを編集する際に使用されるデータです。Qt::DisplayRole と同じことが多いですが、異なる形式(例: 内部的な数値データなど)を提供することも可能です。
  • Qt::DisplayRole: アイテムの表示テキストとして使用されるデータです。これが最も一般的に使用されるロールです。例えば、テーブルのセルに表示される文字列などです。

data() メソッドは、指定された indexrole に対応するデータを QVariant 型で返します。QVariant はQtの汎用データ型で、文字列、数値、色、画像など、さまざまな種類のデータを格納できます。データが存在しない場合や、サポートされていないロールが要求された場合は、無効な QVariant を返すべきです。

具体的な使用例(モデルの実装)

以下は、簡単な文字列リストを扱うカスタムモデルの data() メソッドの実装例です。

#include <QAbstractListModel>
#include <QStringList>
#include <QVariant>

class MyStringListModel : public QAbstractListModel
{
    Q_OBJECT

public:
    explicit MyStringListModel(const QStringList &strings, QObject *parent = nullptr)
        : QAbstractListModel(parent), m_strings(strings) {}

    // 必須: 行数を返す
    int rowCount(const QModelIndex &parent = QModelIndex()) const override
    {
        if (parent.isValid())
            return 0; // 子要素は持たないリストモデルの場合

        return m_strings.count();
    }

    // 必須: 指定されたインデックスとロールに対応するデータを返す
    QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override
    {
        if (!index.isValid()) // 無効なインデックスは無視
            return QVariant();

        if (index.row() >= m_strings.size() || index.row() < 0) // 範囲外のインデックス
            return QVariant();

        switch (role) {
            case Qt::DisplayRole: // 表示テキスト
                return m_strings.at(index.row());
            case Qt::EditRole: // 編集テキスト (DisplayRoleと同じとする)
                return m_strings.at(index.row());
            case Qt::ToolTipRole: // ツールチップ
                return QString("これはアイテム %1 です").arg(index.row());
            case Qt::UserRole: // カスタムデータ(例: 文字列の長さ)
                return m_strings.at(index.row()).length();
            default:
                return QVariant(); // その他のロールは未サポート
        }
    }

private:
    QStringList m_strings;
};

この例では、Qt::DisplayRole にはリストの文字列そのものを、Qt::ToolTipRole にはカスタムのツールチップ文字列を、そして Qt::UserRole には文字列の長さを返しています。



QAbstractItemModel::data() は、ビューが表示するデータの提供を担当します。このメソッドの実装が不適切であると、表示の問題、パフォーマンスの問題、クラッシュなど、多岐にわたるエラーにつながる可能性があります。

データが表示されない、または期待通りのデータが表示されない

考えられる原因とトラブルシューティング

  • デリゲート(QStyledItemDelegateなど)のカスタム描画の問題
    • 原因
      カスタムデリゲートを使用している場合、そのpaint()メソッドの実装が誤っていると、データが正しく描画されないことがあります。
    • トラブルシューティング
      デリゲートの描画コードを確認し、QPainter の設定(フォント、色など)やdrawText()drawPixmap()などの呼び出しが適切であることを確認してください。
  • データ型がビューで扱えない形式
    • 原因
      QVariant に格納されたデータ型が、ビューが期待する型と異なる。例えば、Qt::DecorationRole に文字列を返してもアイコンは表示されません。
    • トラブルシューティング
      各ロールに対応する適切なデータ型(QVariant がラップできる型)を返すようにしてください。
      • Qt::DisplayRole, Qt::EditRole, Qt::ToolTipRole など: QString
      • Qt::DecorationRole: QIcon, QPixmap
      • Qt::CheckStateRole: Qt::CheckState (列挙型)
      • Qt::FontRole: QFont
      • Qt::BackgroundRole, Qt::ForegroundRole: QBrush, QColor
  • Qt::DisplayRole にデータが返されていない
    • 原因
      data() メソッド内で Qt::DisplayRole に対応する QVariant が返されていないか、無効な QVariant が返されている。
    • トラブルシューティング
      data() メソッドの switch 文や if-else 文で、Qt::DisplayRole のケースが正しく処理され、表示したいデータを含む QVariant が返されていることを確認してください。
  • data() メソッドが呼び出されていない
    • 原因
      モデルがビューに設定されていない、またはモデルが空である(rowCount()columnCount() が 0 を返す)。
    • トラブルシューティング
      • view->setModel(myModel) が正しく呼び出されていることを確認してください。
      • rowCount()columnCount() (テーブルモデルの場合) または rowCount()hasChildren() (ツリーモデルの場合) が、データに対応する正しい数を返していることを確認してください。特にツリーモデルの場合、hasChildren() が常に false を返すと、子ノードが表示されません。
      • index() メソッドの実装も確認してください。data() は有効な QModelIndex を受け取る必要があります。

パフォーマンスの問題、UIのフリーズ

考えられる原因とトラブルシューティング

  • dataChanged() シグナルの不適切な発行
    • 原因
      データが少し変更されただけでモデル全体をリセットする(beginResetModel()/endResetModel() を呼び出す)と、ビューはすべてのデータを再要求するため、パフォーマンスが低下します。また、dataChanged() シグナルを必要以上に頻繁に発行すると、ビューが過剰に更新され、パフォーマンスに影響します。
    • トラブルシューティング
      • データが部分的に変更された場合は、dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector<int> &roles = QVector<int>()) を使用して、変更された範囲とロールを正確に通知してください。
      • 行の挿入/削除には beginInsertRows()/endInsertRows()beginRemoveRows()/endRemoveRows() を使用し、列の挿入/削除には beginInsertColumns()/endInsertColumns()beginRemoveColumns()/endRemoveColumns() を使用してください。
      • beginResetModel()/endResetModel() は、モデルの構造が大幅に変更された場合(例: 完全に異なるデータセットに切り替わる場合)にのみ使用してください。
  • data() メソッド内の重い処理
    • 原因
      data() メソッドは、ビューが表示を更新するたびに頻繁に呼び出されます。この中でファイルI/O、データベースクエリ、複雑な計算、ネットワークリクエストなどの重い処理を行うと、UIがフリーズしたり、非常に遅くなったりします。
    • トラブルシューティング
      • データのキャッシュ
        data() 内でデータを計算するのではなく、モデルが初期化される際やデータが変更される際に、あらかじめ計算して内部的にキャッシュしておくことを検討してください。
      • 遅延読み込み(Lazy Loading)
        特に画像などの大きなデータの場合、Qt::DecorationRoleなどで必要になったときに初めて読み込むようにします。ただし、これでもdata()が頻繁に呼ばれると問題になるため、別途非同期で読み込み、読み込み完了後に dataChanged() シグナルを発行してビューを更新するなどの工夫が必要です。
      • バックグラウンドスレッドでの処理
        モデルのデータ変更通知はメインスレッドで行う必要がありますが、重いデータ取得や計算は別のスレッドで行い、結果をメインスレッドに通知してモデルを更新するようにします。

クラッシュや未定義動作

  • モデルのメモリ管理の問題
    • 原因
      モデルが管理するデータが、モデルのライフサイクルと一致しない場合(例: モデルが破棄された後もデータへのポインタが残っている)。
    • トラブルシューティング
      モデルが所有するデータは、モデルのデストラクタで適切に解放されるか、スマートポインタ(QSharedPointerなど)を使用してライフサイクルを管理するようにしてください。
  • QVariant の誤用
    • 原因
      QVariant に不正な型の値を格納しようとしたり、QVariant から不正な型で取り出そうとしたりする。
    • トラブルシューティング
      QVariant::canConvert<T>()QVariant::type() を使って型をチェックし、QVariant::value<T>()QVariant::toType() を使う際には正しい型を指定するようにしてください。
  • 無効な QModelIndex の処理
    • 原因
      data() メソッドに渡される index が無効であるにもかかわらず、その index を使って直接データ構造にアクセスしようとする(例: m_dataList.at(index.row()) で範囲外アクセス)。data() は無効なインデックスを受け取ることがあるので、必ずチェックする必要があります。
    • トラブルシューティング
      • if (!index.isValid()) return QVariant(); というチェックを data() メソッドの冒頭に入れてください。
      • さらに、index.row()index.column() がデータ構造の有効な範囲内にあるかを確認するチェックも加えてください。

デバッグのヒント

  • Qt Model Testを使用する
    • Qtには QAbstractItemModelTester というクラスがあり、カスタムモデルの実装がQtのモデル/ビュー規則に準拠しているかをテストするのに非常に役立ちます。これは、モデルの実装が正しいかを確認するための強力なツールです。
  • Qt Creatorのデバッガを使用する
    • data() メソッド内にブレークポイントを設定し、呼び出しスタックや変数の内容をステップ実行しながら確認します。
  • qDebug() を活用する
    • data() メソッドの冒頭で qDebug() << "data() called for index: " << index.row() << "," << index.column() << " role: " << role; のようにログを出力し、いつ、どのようなインデックスとロールでdata()が呼び出されているかを確認します。特に、不必要な呼び出しがないか、正しいロールが要求されているかを確認するのに役立ちます。
    • data() から返される QVariant の内容もログに出力し、期待通りのデータが返されているかを確認します。


ここでは、リストモデルとテーブルモデルの2つの例を通じて説明します。

リストモデルの例 (QAbstractListModel)

この例では、簡単な文字列のリストを表示するカスタムリストモデルを作成します。各アイテムに対して、表示テキスト、ツールチップ、そしてカスタムデータ(文字列の長さ)を提供します。

MyStringListModel.h

#ifndef MYSTRINGLISTMODEL_H
#define MYSTRINGLISTMODEL_H

#include <QAbstractListModel>
#include <QStringList>
#include <QVariant> // QVariant を使用するために必要

class MyStringListModel : public QAbstractListModel
{
    Q_OBJECT

public:
    // コンストラクタ: 初期データとして QStringList を受け取る
    explicit MyStringListModel(const QStringList &strings, QObject *parent = nullptr);

    // 必須: モデルの行数を返す (QAbstractListModel ではこれだけ)
    int rowCount(const QModelIndex &parent = QModelIndex()) const override;

    // 必須: 指定されたインデックスとロールに対応するデータを返す
    QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;

    // (オプション) setData() メソッドを追加して、モデルのデータを変更可能にする
    bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;

    // (オプション) フラグを返す (編集可能にするため)
    Qt::ItemFlags flags(const QModelIndex &index) const override;

private:
    QStringList m_strings; // モデルが保持する文字列データ
};

#endif // MYSTRINGLISTMODEL_H

MyStringListModel.cpp

#include "MyStringListModel.h"
#include <QDebug> // デバッグ出力用

MyStringListModel::MyStringListModel(const QStringList &strings, QObject *parent)
    : QAbstractListModel(parent), m_strings(strings)
{
}

// モデルの行数を返す
int MyStringListModel::rowCount(const QModelIndex &parent) const
{
    // リストモデルでは、親が無効な場合(ルートアイテムの場合)にのみ行数を返す
    // 有効な親インデックスを持つ場合、子要素は持たない(リストなので)
    if (parent.isValid())
        return 0;

    return m_strings.count(); // 保持している文字列の数を行数とする
}

// 指定されたインデックスとロールに対応するデータを返す、これが Item.data の核
QVariant MyStringListModel::data(const QModelIndex &index, int role) const
{
    // 無効なインデックスや範囲外のインデックスの場合は無効な QVariant を返す
    if (!index.isValid() || index.row() < 0 || index.row() >= m_strings.size())
        return QVariant();

    // デバッグ用: どのようなインデックスとロールで呼ばれたかを確認
    qDebug() << "data() called for row:" << index.row() << ", role:" << role;

    // ロールに応じて異なるデータを返す
    switch (role) {
        case Qt::DisplayRole: // アイテムの表示テキスト
            return m_strings.at(index.row());
        case Qt::EditRole: // ユーザーがアイテムを編集する際のテキスト
            return m_strings.at(index.row());
        case Qt::DecorationRole: // アイテムの装飾(アイコンなど)
            // 例: 特定の行にアイコンを表示
            if (index.row() % 2 == 0) {
                return QIcon(":/icons/star.png"); // リソースファイルに star.png があると仮定
            }
            return QVariant(); // アイコンがない場合は無効な QVariant
        case Qt::ToolTipRole: // アイテムにカーソルを合わせたときに表示されるツールチップ
            return QString("これはアイテム %1: %2 です").arg(index.row()).arg(m_strings.at(index.row()));
        case Qt::StatusTipRole: // ステータスバーに表示されるヒント
            return QString("ステータスバーヒント: %1").arg(m_strings.at(index.row()));
        case Qt::FontRole: // アイテムのフォント
            if (index.row() == 0) {
                QFont font;
                font.setBold(true);
                return font;
            }
            return QVariant();
        case Qt::TextAlignmentRole: // アイテムのテキスト配置
            return static_cast<int>(Qt::AlignCenter); // 中央揃え
        case Qt::BackgroundRole: // アイテムの背景色
            if (index.row() == 1) {
                return QBrush(Qt::lightGray);
            }
            return QVariant();
        case Qt::ForegroundRole: // アイテムの前景色(テキスト色)
            if (index.row() == 2) {
                return QBrush(Qt::blue);
            }
            return QVariant();
        case Qt::CheckStateRole: // チェックボックスの表示 (例: 行3にチェックボックス)
            if (index.row() == 3) {
                return Qt::Checked; // または Qt::Unchecked
            }
            return QVariant();
        case Qt::UserRole: // 開発者がカスタムデータに使用できる役割
            // 例: 文字列の長さを返す
            return m_strings.at(index.row()).length();
        default:
            return QVariant(); // その他のロールは未サポート
    }
}

// モデルのデータを変更する
bool MyStringListModel::setData(const QModelIndex &index, const QVariant &value, int role)
{
    if (!index.isValid() || index.row() < 0 || index.row() >= m_strings.size())
        return false;

    if (role == Qt::EditRole) {
        m_strings[index.row()] = value.toString();
        // データが変更されたことをビューに通知
        emit dataChanged(index, index, {role});
        return true;
    }
    // CheckStateRole を変更する例
    else if (role == Qt::CheckStateRole && index.row() == 3) {
        if (value.toInt() == Qt::Checked || value.toInt() == Qt::Unchecked) {
            // ここで内部的にチェック状態を保持するロジックが必要になります
            // 例: QList<Qt::CheckState> m_checkStates;
            // m_checkStates[index.row()] = static_cast<Qt::CheckState>(value.toInt());
            emit dataChanged(index, index, {role});
            return true;
        }
    }
    return false;
}

// アイテムのフラグを返す(編集可能にするためなど)
Qt::ItemFlags MyStringListModel::flags(const QModelIndex &index) const
{
    if (!index.isValid())
        return Qt::NoItemFlags;

    // デフォルトの選択可能、有効なフラグに加えて、編集可能にする
    return QAbstractListModel::flags(index) | Qt::ItemIsEditable | Qt::ItemIsUserCheckable;
}

main.cpp での使用例

#include <QApplication>
#include <QListView>
#include <QStringList>
#include <QDebug>
#include "MyStringListModel.h"

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

    QStringList dataList;
    dataList << "Apple" << "Banana" << "Cherry" << "Date" << "Elderberry";

    // モデルを作成
    MyStringListModel *model = new MyStringListModel(dataList);

    // ビューを作成
    QListView *listView = new QListView();
    listView->setModel(model); // モデルをビューに設定

    // デリゲートをカスタムすることで、UserRole のデータを表示することも可能
    // ただし、この例では表示は標準のDisplayRoleに限定されます。
    // UserRole のデータをプログラムで取得する例:
    QModelIndex indexZero = model->index(0, 0);
    qDebug() << "Length of 'Apple' (UserRole):" << model->data(indexZero, Qt::UserRole).toInt();

    // アイテムを編集する例
    QModelIndex indexToEdit = model->index(1, 0); // "Banana" のインデックス
    model->setData(indexToEdit, "Blueberry", Qt::EditRole);

    listView->setWindowTitle("My Custom List View");
    listView->show();

    return a.exec();
}

テーブルモデルの例 (QAbstractTableModel)

この例では、シンプルな二次元データを表示するカスタムテーブルモデルを作成します。

MyTableModel.h

#ifndef MYTABLEMODEL_H
#define MYTABLEMODEL_H

#include <QAbstractTableModel>
#include <QVector>
#include <QString>
#include <QVariant>

class MyTableModel : public QAbstractTableModel
{
    Q_OBJECT

public:
    explicit MyTableModel(QObject *parent = nullptr);

    // 必須: 行数を返す
    int rowCount(const QModelIndex &parent = QModelIndex()) const override;
    // 必須: 列数を返す
    int columnCount(const QModelIndex &parent = QModelIndex()) const override;

    // 必須: 指定されたインデックスとロールに対応するデータを返す
    QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;

    // (オプション) ヘッダーデータを返す
    QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;

    // (オプション) データを設定する
    bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;

    // (オプション) アイテムフラグを返す
    Qt::ItemFlags flags(const QModelIndex &index) const override;

private:
    QVector<QVector<QString>> m_tableData; // 2次元の文字列データ
};

#endif // MYTABLEMODEL_H

MyTableModel.cpp

#include "MyTableModel.h"
#include <QDebug>

MyTableModel::MyTableModel(QObject *parent)
    : QAbstractTableModel(parent)
{
    // サンプルデータで初期化
    m_tableData.append({"Name", "Age", "City"});
    m_tableData.append({"Alice", "30", "New York"});
    m_tableData.append({"Bob", "24", "London"});
    m_tableData.append({"Charlie", "35", "Paris"});
}

// 行数を返す (ヘッダー行も含む)
int MyTableModel::rowCount(const QModelIndex &parent) const
{
    if (parent.isValid())
        return 0;
    return m_tableData.size();
}

// 列数を返す
int MyTableModel::columnCount(const QModelIndex &parent) const
{
    if (parent.isValid() || m_tableData.isEmpty())
        return 0;
    return m_tableData.first().size();
}

// 指定されたインデックスとロールに対応するデータを返す
QVariant MyTableModel::data(const QModelIndex &index, int role) const
{
    if (!index.isValid() || index.row() < 0 || index.row() >= m_tableData.size() ||
        index.column() < 0 || index.column() >= m_tableData.first().size())
        return QVariant();

    const QString &cellData = m_tableData[index.row()][index.column()];

    switch (role) {
        case Qt::DisplayRole: // 表示テキスト
            return cellData;
        case Qt::EditRole: // 編集テキスト
            return cellData;
        case Qt::ToolTipRole: // ツールチップ
            return QString("Cell (%1, %2): %3").arg(index.row()).arg(index.column()).arg(cellData);
        case Qt::BackgroundRole: // 背景色
            if (index.row() == 0) // ヘッダー行の背景色
                return QBrush(Qt::darkGray);
            else if (index.row() % 2 == 0) // 偶数行の背景色
                return QBrush(QColor("#F0F0F0")); // 薄い灰色
            return QVariant();
        case Qt::ForegroundRole: // 前景色(テキスト色)
            if (index.row() == 0) // ヘッダー行のテキスト色
                return QBrush(Qt::white);
            return QVariant();
        case Qt::TextAlignmentRole: // テキスト配置
            if (index.column() == 1) // 年齢列は中央揃え
                return static_cast<int>(Qt::AlignCenter);
            return QVariant();
        case Qt::UserRole: // カスタムデータ(例: 文字列の長さ)
            return cellData.length();
        default:
            return QVariant();
    }
}

// ヘッダーデータを返す
QVariant MyTableModel::headerData(int section, Qt::Orientation orientation, int role) const
{
    if (role != Qt::DisplayRole)
        return QVariant();

    if (orientation == Qt::Horizontal) { // 列ヘッダー
        if (section >= 0 && section < m_tableData.first().size())
            return m_tableData[0][section]; // 最初の行を列ヘッダーとして使用
    } else { // 行ヘッダー
        if (section >= 0 && section < m_tableData.size())
            return QString::number(section); // 行番号をヘッダーとして使用
    }
    return QVariant();
}

// データの変更
bool MyTableModel::setData(const QModelIndex &index, const QVariant &value, int role)
{
    if (!index.isValid() || index.row() < 0 || index.row() >= m_tableData.size() ||
        index.column() < 0 || index.column() >= m_tableData.first().size())
        return false;

    if (role == Qt::EditRole) {
        m_tableData[index.row()][index.column()] = value.toString();
        emit dataChanged(index, index, {role}); // 変更を通知
        return true;
    }
    return false;
}

// アイテムのフラグ
Qt::ItemFlags MyTableModel::flags(const QModelIndex &index) const
{
    if (!index.isValid())
        return Qt::NoItemFlags;

    // ヘッダー行は編集不可にする
    if (index.row() == 0) {
        return QAbstractTableModel::flags(index); // デフォルトフラグのみ
    }

    return QAbstractTableModel::flags(index) | Qt::ItemIsEditable; // 編集可能
}
#include <QApplication>
#include <QTableView>
#include <QHeaderView> // ヘッダービューの設定用
#include "MyTableModel.h"

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

    // モデルを作成
    MyTableModel *model = new MyTableModel();

    // ビューを作成
    QTableView *tableView = new QTableView();
    tableView->setModel(model); // モデルをビューに設定

    // ヘッダーを調整(例:水平ヘッダーをストレッチ)
    tableView->horizontalHeader()->setSectionResizeMode(QHeaderView::Stretch);

    // セルの内容をプログラムで取得する例 (UserRole)
    QModelIndex indexCityAlice = model->index(1, 2); // AliceのCity
    qDebug() << "Length of 'New York' (UserRole):" << model->data(indexCityAlice, Qt::UserRole).toInt();

    // セルの内容をプログラムで変更する例
    QModelIndex indexBobAge = model->index(2, 1); // BobのAge
    model->setData(indexBobAge, "25", Qt::EditRole);

    tableView->setWindowTitle("My Custom Table View");
    tableView->show();

    return a.exec();
}
  • オプションだが推奨されるメソッド
    • headerData(): ヘッダーに表示するテキストなどを提供します。
    • setData(): モデルのデータを変更可能にする場合に実装します。dataChanged() シグナルを必ず発行する必要があります。
    • flags(): アイテムが選択可能か、編集可能か、チェック可能かなどのプロパティを定義します。
  • 必須メソッド
    QAbstractItemModel のサブクラスでは、最低限 rowCount() (リスト/ツリーの場合) または rowCount()columnCount() (テーブルの場合)、そして data() を実装する必要があります。
  • QVariant
    異なる種類のデータを格納できるQtの汎用データ型です。data() メソッドは常に QVariant を返します。
  • role (役割)
    同じアイテムでも、ビューが「どのような目的」でデータを要求しているかを示します。Qt::DisplayRole は表示用、Qt::EditRole は編集用、Qt::DecorationRole はアイコン用など、様々な標準ロールがあります。
  • QModelIndex
    どのアイテム(セルやノード)のデータが必要かを示すオブジェクトです。index.row()index.column() で位置を取得できます。
  • QAbstractItemModel::data() が核
    Item.data の概念は、この仮想関数をオーバーライドすることによって実現されます。


「代替手法」というのは、必ずしも data() メソッドを全く使わないということではなく、data() メソッドの呼び出しを最適化したり、特定のデータ表示要件に対応するための異なるアプローチや、既存のモデルクラスの活用を指します。

既存の便利なモデルクラスの活用

ゼロから QAbstractItemModel をサブクラス化する代わりに、Qtが提供する高レベルのモデルクラスを利用することで、多くの一般的なユースケースに対応できます。これらのモデルは、内部で効率的に data() メソッドを実装しています。

  • QSqlQueryModel, QSqlTableModel, QSqlRelationalTableModel:

    • 説明
      データベースのテーブルやクエリ結果を直接モデルとして扱うためのクラスです。
    • 「Item.data」との関連
      これらのモデルは、データベースから取得したデータを自動的に data() メソッドを通じてビューに提供します。開発者が明示的に data() を実装する必要はありません。
    • 利点
      データベースアプリケーションを迅速に開発でき、データの同期やソート、フィルタリング機能も提供されます。
  • QStandardItemModel:

    • 説明
      自由なデータ構造(ツリー、リスト、テーブル)を構築できる、汎用性の高いアイテムベースのモデルです。各アイテムは QStandardItem オブジェクトとして表現され、それぞれの QStandardItem が複数のロールのデータを保持できます。
    • 「Item.data」との関連
      QStandardItemModeldata() メソッドは、内部で QStandardItem オブジェクトの data(int role) メソッドを呼び出します。つまり、開発者は QStandardItemModel::data() を直接オーバーライドする代わりに、QStandardItem オブジェクトにデータを設定します。
    • 利点
      • 複雑なツリー構造やテーブル構造を簡単に構築できます。
      • QStandardItem が複数のロールのデータを保持できるため、data() メソッド内で switch 文を書く必要がありません。
      • GUIデザイナーでモデルの構造を視覚的に構築することも可能です。
    • 使用例
      QStandardItemModel *model = new QStandardItemModel(this);
      model->setColumnCount(2);
      model->setHeaderData(0, Qt::Horizontal, "Column A");
      model->setHeaderData(1, Qt::Horizontal, "Column B");
      
      QList<QStandardItem*> row1;
      QStandardItem *item1_1 = new QStandardItem("Data 1A");
      item1_1->setData("Tooltip for 1A", Qt::ToolTipRole); // ToolTipRole のデータを設定
      row1.append(item1_1);
      row1.append(new QStandardItem("Data 1B"));
      model->appendRow(row1);
      
      QList<QStandardItem*> row2;
      row2.append(new QStandardItem("Data 2A"));
      row2.append(new QStandardItem(QIcon(":/icons/folder.png"), "Data 2B")); // DecorationRole 付き
      model->appendRow(row2);
      
      QTableView *tableView = new QTableView(this);
      tableView->setModel(model);
      
  • QStringListModel:

    • 説明
      QStringList をそのままモデルとして扱うためのシンプルなクラスです。文字列のリストを表示するだけであれば、これを活用するのが最も簡単です。
    • 「Item.data」との関連
      内部で QStringList の要素を Qt::DisplayRoleQt::EditRole として data() メソッドから返します。
    • 利点
      最小限のコードでリスト表示を実現でき、カスタムモデルを作成する手間を省けます。
    • 使用例
      QStringList dataList;
      dataList << "Apple" << "Banana" << "Cherry";
      QStringListModel *model = new QStringListModel(dataList, this);
      QListView *listView = new QListView(this);
      listView->setModel(model);
      

カスタムデリゲート (QStyledItemDelegate) を使用した表示のカスタマイズ

data() メソッドはデータ自体を提供しますが、そのデータの「描画方法」を制御するのはビューのデリゲートです。data() で提供される標準の役割では表現しきれない複雑な表示や、データ型に依存しないカスタム描画が必要な場合に、デリゲートは強力な代替手段となります。

  • 使用例
    // MyProgressBarDelegate.h
    class MyProgressBarDelegate : public QStyledItemDelegate {
        Q_OBJECT
    public:
        explicit MyProgressBarDelegate(QObject *parent = nullptr);
        void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override;
    };
    
    // MyProgressBarDelegate.cpp
    void MyProgressBarDelegate::paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const {
        if (index.column() == 2) { // 3列目のアイテムをプログレスバーとして描画
            int progress = index.data(Qt::DisplayRole).toInt(); // モデルから進捗値を取得
            QStyleOptionProgressBar progressBarOption;
            progressBarOption.rect = option.rect;
            progressBarOption.minimum = 0;
            progressBarOption.maximum = 100;
            progressBarOption.progress = progress;
            progressBarOption.text = QString("%1%").arg(progress);
            progressBarOption.textVisible = true;
            QApplication::style()->drawControl(QStyle::CE_ProgressBar, &progressBarOption, painter);
        } else {
            QStyledItemDelegate::paint(painter, option, index); // 他の列はデフォルトの描画
        }
    }
    
    // main.cpp またはウィジェットクラス内で
    MyProgressBarDelegate *delegate = new MyProgressBarDelegate(this);
    tableView->setItemDelegateForColumn(2, delegate); // 3列目にカスタムデリゲートを設定
    
  • 利点
    • モデルはデータに集中でき、ビューの描画方法に依存しない。
    • 同じモデルでも、異なるデリゲートを使用することで、複数の異なる表示方法を実装できる。
    • QProgressBarQPushButton のようなカスタムウィジェットをアイテム内に埋め込むことも可能になります(createEditor(), setEditorData(), setModelData() も実装)。
  • 「Item.data」との関連
    デリゲートの paint() メソッドは、QModelIndex を受け取り、その index を使ってモデルの data() メソッドを呼び出し、必要なデータを取得して描画します。これにより、data() メソッドは純粋にデータ提供に徹し、表示ロジックはデリゲートに分離されます。
  • 説明
    QStyledItemDelegate をサブクラス化し、paint() メソッドをオーバーライドすることで、アイテムの描画ロジックを完全に制御できます。

プロキシモデル (QSortFilterProxyModel など) を使用したデータの加工

data() メソッドで提供されるデータ自体を変更することなく、ビューに表示されるデータを加工したい場合、プロキシモデルが強力な代替手段となります。

  • 使用例
    QStandardItemModel *sourceModel = new QStandardItemModel(this);
    // ... sourceModel にデータを追加 ...
    
    QSortFilterProxyModel *proxyModel = new QSortFilterProxyModel(this);
    proxyModel->setSourceModel(sourceModel);
    proxyModel->setFilterRegExp(QRegExp(".*e.*", Qt::CaseInsensitive)); // 'e' を含むアイテムのみ表示
    proxyModel->setFilterKeyColumn(0); // 1列目でフィルタリング
    
    QListView *listView = new QListView(this);
    listView->setModel(proxyModel); // プロキシモデルをビューに設定
    
    カスタムのデータ変換を行う場合は、QSortFilterProxyModel をサブクラス化し、data() メソッドや mapFromSource() / mapToSource() メソッドをオーバーライドします。
  • 利点
    • ソースモデルは純粋なデータを保持し、加工ロジックはプロキシモデルに分離できる。
    • 異なるビューで同じソースモデルを使用しつつ、それぞれ異なる加工ロジックを適用できる。
    • 特に複雑なソートやフィルタリングロジックを実装する際に有用です。
  • 「Item.data」との関連
    プロキシモデルは、ビューから data() の要求を受け取ると、それをソースモデルの data() に転送し、返されたデータを加工してからビューに返します。開発者はプロキシモデルの data() をオーバーライドして、カスタムの加工ロジックを追加できます。
  • 説明
    ソースモデル(元のデータを持つモデル)とビューの間に挟んで、データのフィルタリング、ソート、マッピング(例えば、特定の列のデータを別の列に表示するなど)を行います。

カスタムデータ型と QVariant の登録

data() メソッドから独自のカスタムデータ型を返したい場合、QVariant がその型を扱えるように登録する必要があります。

  • 使用例
    // mycustomdata.h
    struct MyCustomData {
        QString name;
        int value;
        // ... 他のメンバー
    };
    Q_DECLARE_METATYPE(MyCustomData) // メタタイプとして宣言
    
    // model.cpp の data() メソッド内で
    MyCustomData dataObj = {"Example", 123};
    return QVariant::fromValue(dataObj); // カスタムデータを QVariant に格納
    
    // delegate.cpp の paint() メソッド内で
    MyCustomData dataObj = index.data(Qt::UserRole).value<MyCustomData>(); // QVariant からカスタムデータを取り出す
    // ... dataObj を使って描画 ...
    
  • 利点
    モデルがよりリッチなデータ構造を直接扱うことができ、デリゲートや他のコンポーネントでそのカスタムデータを簡単に取り出して利用できます。
  • 「Item.data」との関連
    data() メソッドが QVariant(myCustomObject) のようにカスタムオブジェクトをラップして返すことができるようになります。これにより、モデルはより複雑なデータを単一の QVariant として提供できます。
  • 説明
    qRegisterMetaType()Q_DECLARE_METATYPE() を使用して、カスタムクラスをメタタイプシステムに登録することで、そのクラスのオブジェクトを QVariant に格納できるようになります。