QAbstractItemModel Class

メンバ関数ドキュメント

[explicit] QAbstractItemModel::QAbstractItemModel(QObject *parent = nullptr)

与えられたparent で抽象アイテムモデルを構築します。

[virtual noexcept] QAbstractItemModel::~QAbstractItemModel()

抽象アイテムモデルを破棄します。

[protected] void QAbstractItemModel::beginInsertColumns(const QModelIndex &parent, int first, int last)

列の挿入操作を開始します。

サブクラスでinsertColumns() を再実装する場合、モデルの基礎となるデータストアにデータを挿入する前にこの関数を呼び出す必要があります。

parent インデックスは、新しいカラムが挿入される親カラムに対応します。first とlast は、新しいカラムが挿入された後のカラム番号です。

カラムの挿入	モデル内の項目に挿入したい列のスパンの最初と最後の列番号を指定します。 例えば、図のように、4列目の前に3列挿入するので、first は4、last は6となります： beginInsertColumns(parent, 4, 6); これにより、3つの新しいカラムがカラム4、5、6として挿入されます。
列の追加	カラムを追加するには、最後のカラムの後に挿入する。 例えば、図に示すように、既存の6列のコレクション（5列で終わる）に3列を追加するので、first は6、last は8となる： beginInsertColumns(parent, 6, 8); これにより、2つの新しい列が列6、7、8として追加されます。

endInsertColumns()も参照 。

[protected] void QAbstractItemModel::beginInsertRows(const QModelIndex &parent, int first, int last)

行挿入操作を開始します。

サブクラスでinsertRows() を再実装する場合、モデルの基礎となるデータストアにデータを挿入する前にこの関数を呼び出す必要があります。

parent インデックスは、新しい行が挿入される親に対応します。first とlast は、新しい行が挿入された後の行番号です。

行の挿入	モデル内の項目に挿入したい行のスパンの最初と最後の行番号を指定します。 たとえば、図のように、2行目の前に3行挿入するので、first は 2、last は 4 となります： beginInsertRows(parent, 2, 4); これにより、3つの新しい行が2行目、3行目、4行目として挿入されます。
行の追加	行を追加するには、最後の行の後に行を挿入する。 例えば、図のように、既存の4行のコレクション（3行目で終了）に2行を追加するので、first は4、last は5となる： beginInsertRows(parent, 4, 5); これにより、2つの新しい行が4行目と5行目として追加される。

endInsertRows()も参照 。

[protected] bool QAbstractItemModel::beginMoveColumns(const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

列の移動操作を開始します。

サブクラスを再実装する場合、このメソッドは、モデル内のエンティティの移動を単純化します。このメソッドは、モデル内の永続インデックスの移動を担当します。beginMoveColumns とendMoveColumns を使用すると、layoutAboutToBeChanged とlayoutChanged をchangePersistentIndex と共に直接発行する代わりになります。

sourceParent インデックスは、列の移動元の親に対応します。sourceFirst とsourceLast は、移動する列の最初と最後の列番号です。destinationParent インデックスは、それらの列が移動される親に対応する。destinationChild はカラムの移動先のカラムである。すなわち、sourceParent のカラムsourceFirst のインデックスは、destinationParent のカラムdestinationChild となり、それに続いてsourceLast までのすべてのカラムが移動する。

しかし、同じ親（sourceParent とdestinationParent が等しい）のカラムを下に移動させる場合、カラムはdestinationChild インデックスの前に配置されます。つまり、カラム0と1を移動してカラム1と2にしたい場合、destinationChild は3でなければなりません。この場合、ソース・カラムの新しいインデックスi （sourceFirst とsourceLast の間にある）は(destinationChild-sourceLast-1+i) に等しくなります。

sourceParent とdestinationParent が同じ場合、destinationChild がsourceFirst とsourceLast + 1 の範囲内にないことを確認する必要があることに注意してください。また、列を自分の子や先祖のいずれかに移動させようとしないようにしなければなりません。このメソッドは、いずれかの条件が真の場合にfalse を返します。

endMoveColumns()も参照 。

[protected] bool QAbstractItemModel::beginMoveRows(const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

行の移動操作を開始します。

サブクラスを再実装する場合、このメソッドは、モデル内のエンティティの移動を単純化します。このメソッドは、モデル内の永続インデックスの移動を担当します。beginMoveRows とendMoveRows を使用すると、layoutAboutToBeChanged とlayoutChanged をchangePersistentIndex と共に直接発行する代わりに使用できます。

sourceParent インデックスは、行の移動元の親に対応します。sourceFirst とsourceLast は、移動する行の最初と最後の行番号です。destinationParent インデックスは、それらの行が移動される親に対応する。destinationChild は、行の移動先の行である。つまり、sourceParent の行sourceFirst のインデックスは、destinationParent の行destinationChild となり、sourceLast までの行がそれに続く。

しかし、同じ親（sourceParent とdestinationParent が等しい）の中で行を下に移動する場合、行はdestinationChild インデックスの前に置かれる。つまり、0行目と1行目を移動して1行目と2行目にしたい場合、destinationChild は3でなければならない。この場合、ソース行i （sourceFirst とsourceLast の間にある）の新しいインデックスは、(destinationChild-sourceLast-1+i) に等しくなります。

sourceParent とdestinationParent が同じ場合、destinationChild がsourceFirst とsourceLast + 1 の範囲内にないことを確認する必要があります。また、行を自分の子や先祖のいずれかに移動させようとしないようにしなければなりません。このメソッドは、いずれかの条件が真の場合にfalse を返します。

行を別の親に移動する	モデル内で移動させたい移動元の親の行のスパンの最初と最後の行番号を指定します。また、スパンを移動する移動先の親の行も指定します。 たとえば、図のように、移動元で 2 行目から 4 行目までの 3 行を移動するので、sourceFirst は 2、sourceLast は 4 となります。移動先でこれらの項目を 2 行目より上に移動するので、destinationChild は 2 となります。 beginMoveRows(sourceParent, 2, 4, destinationParent, 2); これにより、移動元では2行目、3行目、4行目の3行が移動先では2行目、3行目、4行目となる。影響を受ける他の兄弟は、それに応じて移動される。
別の親に追加する行の移動	行を別の親に追加するには、最後の行の後に移動させます。 例えば、図に示すように、3行を6行の既存の行の集合(5行目で終わる)に移動させるので、destinationChild は6となる： beginMoveRows(sourceParent, 2, 4, destinationParent, 6); これにより、対象の行は6、7、8として対象の親の最後に移動します。
同じ親内の行を上に移動	同じ親内の行を移動するには、移動先の行を指定します。 例えば図のように、2行目から0行目へ1つ移動させるので、sourceFirst とsourceLast は2となり、destinationChild は0となる。 beginMoveRows(parent, 2, 2, parent, 0); それに応じて他の行も移動する可能性があることに注意。また、同じ親の中で項目を移動する場合、無効な移動やノーオペの移動を試みてはならないことに注意。上の例では、アイテム2は移動前は2行目にあるため、2行目（すでにある行）や3行目（3行目はすでにある3行目の上という意味で無効）には移動できない。
同じ親内の行を下に移動する	同じ親の中にある行を移動するには、移動先の行を指定します。 例えば、図のように、2行目から4行目へ1つ移動させるので、sourceFirst とsourceLast は2、destinationChild は4となる。 beginMoveRows(parent, 2, 2, parent, 4); それに応じて他の行も移動する可能性があることに注意してください。

endMoveRows()も参照のこと 。

[protected] void QAbstractItemModel::beginRemoveColumns(const QModelIndex &parent, int first, int last)

列の削除処理を開始します。

サブクラスでremoveColumns() を再実装する場合、モデルの基礎となるデータストアからデータを削除する前にこの関数を呼び出す必要があります。

parent インデックスは、新しいカラムが削除される親カラムに対応します。first とlast は、削除される最初と最後のカラムのカラム番号です。

カラムの削除

モデル内の項目から削除したい列のスパンの最初と最後の列番号を指定します。 たとえば、図のように、4列目から6列目までの3列を削除するので、first は 4、last は 6 となります： beginRemoveColumns(parent, 4, 6);

endRemoveColumns()も参照 。

[protected] void QAbstractItemModel::beginRemoveRows(const QModelIndex &parent, int first, int last)

行削除処理を開始します。

サブクラスでremoveRows() を再実装する場合、モデルの基礎となるデータストアからデータを削除する前にこの関数を呼び出す必要があります。

parent インデックスは、新しい行が削除される親に対応します。first とlast は、削除される行の行番号です。

行の削除	モデル内の項目から削除したい行のスパンの最初と最後の行番号を指定します。 たとえば、図のように、2行目から3行目までの2行を削除するので、first は 2、last は 3 となります： beginRemoveRows(parent, 2, 3);

endRemoveRows()も参照 。

[protected] void QAbstractItemModel::beginResetModel()

モデルのリセット操作を開始します。

リセット操作は、接続されているビューのモデルを現在の状態にリセットします。

モデルがリセットされるということは、モデルから報告された以前のデータは無効となり、再度問い合わせを行う必要があるということです。これは、現在の項目と選択された項目が無効になることも意味します。

モデルがそのデータを根本的に変更するとき、基礎となるデータソースやその構造が変更されたときに他のコンポーネントに通知するためにdataChanged() を呼び出すよりも、この関数を呼び出す方が簡単な場合があります。

モデルやプロキシモデルの内部データ構造をリセットする前に、この関数を呼び出す必要があります。

この関数は、シグナルmodelAboutToBeReset() を発行します。

modelAboutToBeReset()、modelReset()、endResetModel()も参照して ください。

[virtual] QModelIndex QAbstractItemModel::buddy(const QModelIndex &index) const

index で表されるアイテムのバディのモデルインデックスを返します。ユーザがアイテムを編集したい場合、ビューはこの関数を呼び出して、モデル内の別のアイテムを代わりに編集すべきかどうかをチェックします。そして、ビューは、バディアイテムによって返されたモデルインデックスを使用してデリゲートを構築します。

この関数のデフォルトの実装では、各項目はそれ自身のバディとなります。

[virtual] bool QAbstractItemModel::canDropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const

モデルがdata のドロップを受け入れることができる場合、true を返します。 このデフォルトの実装では、data がmimeTypes() のリストに少なくとも1つの書式があるかどうか、そしてaction がモデルのsupportedDropActions() の中にあるかどうかだけをチェックします。

row 、column 、parent 、action でdata を削除できるかどうかをテストしたい場合は、カスタムモデルでこの関数を再実装してください。 このテストが必要ない場合は、この関数を再実装する必要はありません。

dropMimeData() およびUsing drag and drop with item viewsも参照して ください。

[virtual invokable] bool QAbstractItemModel::canFetchMore(const QModelIndex &parent) const

利用可能なデータがparent より多い場合はtrue を返し、そうでない場合はfalse を返す。

デフォルトの実装では、常にfalse を返す。

canFetchMore() がtrue を返す場合、fetchMore() 関数を呼び出す必要があります。これは、例えばQAbstractItemView の動作です。

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

[protected] void QAbstractItemModel::changePersistentIndex(const QModelIndex &from, const QModelIndex &to)

与えられたfrom モデルインデックスに等しいQPersistentModelIndex を、与えられたto モデルインデックスに変更します。

与えられたfrom モデルインデックスに等しい永続的なモデルインデックスが見つからなかった場合、何も変更されません。

persistentIndexList() およびchangePersistentIndexList()も参照してください 。

[protected] void QAbstractItemModel::changePersistentIndexList(const QModelIndexList &from, const QModelIndexList &to)

与えられたfrom モデル・インデックス・リストのインデックスと等しい {QPersistentModelIndex} を、与えられたto モデル・インデックス・リストに変更する。

与えられたfrom モデル・インデックス・リストのインデックスに等しい永続モデル・インデックスが見つからない場合、何も変更されません。

persistentIndexList() およびchangePersistentIndex()も参照のこと 。

bool QAbstractItemModel::checkIndex(const QModelIndex &index, QAbstractItemModel::CheckIndexOptions options = CheckIndexOption::NoOption) const

この関数は、index がこのモデルにとって正当なモデルインデックスであるかどうかをチェックします。正当なモデルインデックスとは、無効なモデルインデックスか、以下の全てが成り立つ有効なモデルインデックスのことです：

• インデックスのモデルがthis である；
• index'の行が0以上である；
• インデックスの行がインデックスの親の行数より小さい；
• インデックスの列がゼロより大きいか等しい；
• index'の列がindex'の親の列数より小さい。

options 引数は、これらのチェックの一部を変更する可能性がある。options にIndexIsValid が含まれている場合、index は有効なインデックスでなければならない。これは、有効なインデックスを期待するdata() やsetData() などの関数を再実装するときに便利である。

options にDoNotUseParent が含まれている場合、parent()を呼び出すためのチェックは省略される。これにより、parent()の再実装からこの関数を呼び出すことができる(そうでない場合、無限の再帰とクラッシュが発生する)。

options がDoNotUseParent を含まず、ParentIsInvalid を含む場合、追加のチェックが行われる： 親インデックスが有効でないかどうかがチェックされる。これは、リストやテーブルのような平坦なモデルを実装するときに便利です。

この関数は、すべてのチェックが成功した場合は真を返し、そうでない場合は偽を返します。これにより、この関数をQ_ASSERT や他の類似のデバッグメカニズムで使用することができます。チェックに失敗した場合、qt.core.qabstractitemmodel.checkindex のロギングカテゴリに、失敗のデバッグに役立つ情報を含む警告メッセージが出力されます。

QModelIndexも参照して ください。

[virtual, since 6.0] bool QAbstractItemModel::clearItemData(const QModelIndex &index)

与えられたindex のすべてのロールに格納されているデータを削除する。成功した場合はtrue を返し、失敗した場合はfalse を返します。データの削除に成功した場合、dataChanged() シグナルが発行されます。基底クラスの実装はfalse

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

data(),itemData(),setData(),setItemData()も参照してください 。

[pure virtual invokable] int QAbstractItemModel::columnCount(const QModelIndex &parent = QModelIndex()) const

与えられたparent の子の列数を返す。

ほとんどのサブクラスでは、列の数はparent に依存しません。

例えば

int MyModel::columnCount(const QModelIndex &parent) const
{
    Q_UNUSED(parent);
    return 3;
}

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

[private signal] void QAbstractItemModel::columnsAboutToBeInserted(const QModelIndex &parent, int first, int last)

このシグナルはカラムがモデルに挿入される直前に発せられます。新しい項目は、first とlast の間に、指定されたparent 項目の下に配置されます。

insertColumns() およびbeginInsertColumns()も参照してください 。

[private signal] void QAbstractItemModel::columnsAboutToBeMoved(const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

このシグナルはモデル内で列が移動される直前に発せられます。移動される項目は、与えられたsourceParent 項目の下にある、sourceStart からsourceEnd までの項目です。それらは、destinationColumn の列から始まるdestinationParent に移動されます。

注意:このシグナルに接続されたコンポーネントは、モデルの寸法の変更に適応するためにこのシグナルを使用します。このシグナルはQAbstractItemModel の実装によってのみ発することができ、サブクラスのコードで明示的に発することはできません。

beginMoveRows()も参照 。

[private signal] void QAbstractItemModel::columnsAboutToBeRemoved(const QModelIndex &parent, int first, int last)

このシグナルはモデルからカラムが削除される直前に発せられる。削除される項目は、指定されたparent 項目の下にある、first からlast までの項目です。

removeColumns() およびbeginRemoveColumns()も参照してください 。

[private signal] void QAbstractItemModel::columnsInserted(const QModelIndex &parent, int first, int last)

このシグナルはカラムがモデルに挿入された後に発行されます。新しい項目とは、first からlast までの項目で、指定されたparent 項目の下にあるものです。

insertColumns() およびbeginInsertColumns()も参照してください 。

[private signal] void QAbstractItemModel::columnsMoved(const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

このシグナルは、モデル内で列が移動された後に発行される。指定されたsourceParent 項目の下にある、sourceStart からsourceEnd までの項目が、destinationColumn 列から始まるdestinationParent に移動されました。

注意:このシグナルに接続されたコンポーネントは、モデルの寸法の変更に適応するためにこのシグナルを使用します。このシグナルはQAbstractItemModel 実装によってのみ発することができ、サブクラスのコードで明示的に発することはできません。

beginMoveRows()も参照 。

[private signal] void QAbstractItemModel::columnsRemoved(const QModelIndex &parent, int first, int last)

このシグナルはモデルからカラムが削除された後に発行されます。削除される項目は、first からlast までの項目で、指定されたparent 項目の下にあるものです。

removeColumns() およびbeginRemoveColumns()も参照してください 。

[protected] QModelIndex QAbstractItemModel::createIndex(int row, int column, const void *ptr = nullptr) const

内部ポインタptr で、与えられたrow とcolumn のモデルインデックスを作成します。

QSortFilterProxyModel を使用する場合、そのインデックスはそれ自身の内部ポインタを持ちます。モデルの外部でこの内部ポインタにアクセスすることはお勧めしません。代わりにdata() 関数を使用してください。

この関数は、モデルのサブクラスがモデルのインデックスを作成するために使用しなければならない一貫したインタフェースを提供します。

[protected] QModelIndex QAbstractItemModel::createIndex(int row, int column, quintptr id) const

与えられたrow とcolumn に対して、内部識別子id を持つモデルインデックスを作成します。

この関数は、モデルのサブクラスがモデルインデックスを作成するために使用しなければならない一貫したインタフェースを提供します。

QModelIndex::internalId()も参照してください 。

[pure virtual invokable] QVariant QAbstractItemModel::data(const QModelIndex &index, int role = Qt::DisplayRole) const

index で参照されている項目について、与えられたrole の下に格納されているデータを返す。

Qt::ItemDataRole 、setData()、headerData()も参照してください 。

[signal] void QAbstractItemModel::dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList<int> &roles = QList<int>())

このシグナルは、既存のアイテムのデータが変更されるたびに発行される。

アイテムが同じ親の場合、影響を受けるのはtopLeft からbottomRight までのアイテムである。アイテムが同じ親を持たない場合、動作は未定義です。

setData() 関数を再実装する場合、このシグナルを明示的に発する必要がある。

オプションの引数roles を使用すると、実際に変更されたデータ・ロールを指定できます。roles引数に空のベクトルを指定すると、すべてのロールが変更されたと見なされます。roles引数の要素の順番は関係ありません。

headerDataChanged （）、setData （）、layoutChanged （）も参照して ください。

[virtual] bool QAbstractItemModel::dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)

与えられたaction で終了したドラッグ＆ドロップ操作によって与えられたdata を処理する。

データとアクションがモデルによって処理された場合はtrue を返し、そうでない場合はfalse を返します。

指定されたrow 、column 、parent は、操作が終了したモデル内のアイテムの位置を示します。正しい場所でアクションを完了させるのはモデルの責任です。

例えば、QTreeView のアイテムにドロップ・アクションを実行すると、row 、column 、parent で指定されたアイテムの子として、またはアイテムの兄弟として、新しいアイテムが挿入される。

row とcolumn が -1 の場合、ドロップされたデータはparent に直接ドロップされたものとみなされます。通常、これはデータをparent の子アイテムとして追加することを意味します。row とcolumn が 0 以上の場合、ドロップは指定されたparent の指定されたrow とcolumn の直前に発生したことを意味します。

mimeTypes() メンバは、許容可能な MIME タイプのリストを取得するために呼び出される。このデフォルトの実装では、デフォルトの MIME タイプを 1 つ返すmimeTypes() を想定している。カスタムモデルでmimeTypes() を再実装して複数の MIME タイプを返すようにする場合は、 この関数を再実装してそれらを利用する必要があります。

supportedDropActions(),canDropMimeData(), およびUsing drag and drop with item viewsも参照してください 。

[protected] void QAbstractItemModel::endInsertColumns()

列の挿入操作を終了します。

サブクラスでinsertColumns() を再実装する場合は、モデルの基礎となるデータストアにデータを挿入した後に、この関数を呼び出す必要があります。

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

[protected] void QAbstractItemModel::endInsertRows()

行挿入操作を終了します。

サブクラスでinsertRows() を再実装する場合は、モデルの基礎となるデータストアにデータを挿入した後に、この関数を呼び出す必要があります。

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

[protected] void QAbstractItemModel::endMoveColumns()

列の移動操作を終了します。

サブクラスを実装する場合、モデルの基礎となるデータストア内でデータを移動した後にこの関数を呼び出す必要があります。

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

[protected] void QAbstractItemModel::endMoveRows()

行の移動操作を終了します。

サブクラスを実装する場合は、モデルの基礎となるデータストア内でデータを移動した後に、この関数を呼び出す必要があります。

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

[protected] void QAbstractItemModel::endRemoveColumns()

列削除処理を終了します。

サブクラスでremoveColumns() を再実装する場合は、モデルの基礎となるデータストアからデータを削除した後にこの関数を呼び出す必要があります。

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

[protected] void QAbstractItemModel::endRemoveRows()

行削除処理を終了します。

サブクラスでremoveRows() を再実装する場合は、モデルの基礎となるデータストアからデータを削除した後に、この関数を呼び出す必要があります。

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

[protected] void QAbstractItemModel::endResetModel()

モデルのリセット操作を完了します。

モデルまたはプロキシモデルの内部データ構造をリセットした後に、この関数を呼び出す必要があります。

この関数はシグナルmodelReset() を発します。

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

[virtual invokable] void QAbstractItemModel::fetchMore(const QModelIndex &parent)

parent インデックスで指定された親を持つアイテムの利用可能なデータを取得します。

モデルにインクリメンタルにデータを入力する場合は、これを再実装してください。

デフォルトの実装は何もしません。

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

[virtual invokable] Qt::ItemFlags QAbstractItemModel::flags(const QModelIndex &index) const

与えられたindex のアイテム・フラグを返す。

基本クラスの実装では、アイテムを有効にするフラグ(ItemIsEnabled)と、アイテムを選択できるようにするフラグ(ItemIsSelectable)の組み合わせを返します。

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

[virtual invokable] bool QAbstractItemModel::hasChildren(const QModelIndex &parent = QModelIndex()) const

parent に子がいればtrue を返し、いなければfalse を返す。

子の数を調べるには、親でrowCount() を使用します。

同じインデックスにフラグQt::ItemNeverHasChildren が設定されている場合に、このメソッドで特定のインデックスが hasChildren を持つことを報告するのは未定義の動作であることに注意してください。

parent() およびindex()も参照して ください。

[invokable] bool QAbstractItemModel::hasIndex(int row, int column, const QModelIndex &parent = QModelIndex()) const

モデルがrow とcolumn に対して有効なQModelIndex を返した場合はtrue を、parent を返した場合はfalse を返します。

[virtual invokable] QVariant QAbstractItemModel::headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const

指定されたorientation のヘッダー内の、指定されたrole とsection のデータを返す。

水平ヘッダーの場合、セクション番号は列番号に対応する。同様に、縦書きヘッダーの場合、セクション番号は行番号に対応する。

Qt::ItemDataRole 、setHeaderData()、QHeaderViewも参照 。

[signal] void QAbstractItemModel::headerDataChanged(Qt::Orientation orientation, int first, int last)

このシグナルは、ヘッダーが変更されるたびに発せられる。orientation 、水平または垂直のヘッダーが変更されたかを示す。ヘッダー内のfirst からlast までのセクションを更新する必要がある。

setHeaderData()関数を再実装する場合は、このシグナルを明示的に発する必要がある。

列や行の数を変更する場合は、このシグナルを発する必要はなく、begin/end関数を使用します（詳細については、QAbstractItemModel クラス説明のサブクラス化のセクションを参照してください）。

headerData()、setHeaderData()、dataChanged()も参照の こと。

[pure virtual invokable] QModelIndex QAbstractItemModel::index(int row, int column, const QModelIndex &parent = QModelIndex()) const

指定されたrow,column,parent インデックスによって指定されたモデル内のアイテムのインデックスを返します。

サブクラスでこの関数を再実装する場合、他のコンポーネントがモデル内の項目を参照するために使用できるモデルインデックスを生成するために、createIndex （）を呼び出します。

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

[invokable] bool QAbstractItemModel::insertColumn(int column, const QModelIndex &parent = QModelIndex())

指定されたparent の子項目で、指定されたcolumn の前に 1 つの列を挿入する。

カラムが挿入された場合はtrue を返し、そうでない場合はfalse を返します。

insertColumns()、insertRow()、removeColumn()も参照してください 。

[virtual invokable] bool QAbstractItemModel::insertColumns(int column, int count, const QModelIndex &parent = QModelIndex())

これをサポートするモデルでは、与えられたcolumn の前にcount 新しい列をモデルに挿入します。それぞれの新しい列の項目は、parent のモデルインデックスで表される項目の子になります。

column が 0 の場合、列は既存の列の前に追加されます。

column がcolumnCount() の場合、列は既存の列に追加されます。

parent に子がない場合、count の列を持つ単一の行が挿入される。

列が正常に挿入された場合はtrue を返し、そうでない場合はfalse を返す。

基底クラスの実装は何もせず、false を返します。

独自のモデルを実装する場合、挿入をサポートしたいのであれば、この関数を再実装することができます。あるいは、データを変更するための独自のAPIを提供することもできます。

insertRows()、removeColumns()、beginInsertColumns()、endInsertColumns()も参照して ください。

[invokable] bool QAbstractItemModel::insertRow(int row, const QModelIndex &parent = QModelIndex())

指定されたparent の子項目で、指定されたrow の前に 1 行挿入する。

行が挿入された場合はtrue を返し、そうでない場合はfalse を返します。

insertRows()、insertColumn()、removeRow()も参照してください 。

[virtual invokable] bool QAbstractItemModel::insertRows(int row, int count, const QModelIndex &parent = QModelIndex())

これをサポートするモデルでは、与えられたrow の前にcount の行をモデルに挿入します。新しい行の項目は、parent のモデルインデックスで表される項目の子になります。

row が 0 の場合、行は親の既存の行の前に追加されます。

row がrowCount() の場合、行は親の既存の行に追加されます。

parent に子がない場合、count の行を持つ単一の列が挿入される。

行の挿入に成功した場合はtrue を返し、失敗した場合はfalse を返す。

独自のモデルを実装する場合、挿入をサポートしたいのであればこの関数を再実装することができます。あるいは、データを変更するための独自のAPIを提供することもできます。いずれの場合も、モデルが変更されたことを他のコンポーネントに通知するために、beginInsertRows() とendInsertRows() を呼び出す必要があります。

insertColumns()、removeRows()、beginInsertRows()、endInsertRows()も参照して ください。

[virtual] QMap<int, QVariant> QAbstractItemModel::itemData(const QModelIndex &index) const

指定されたindex にあるアイテムのモデル内のすべての定義済みのロールの値を持つマップを返します。

この関数のデフォルトの振る舞いを拡張して、カスタム・ロールをマップに含めたい場合は、この関数を再実装してください。

setItemData()、Qt::ItemDataRole 、およびdata()も参照してください 。

[signal] void QAbstractItemModel::layoutAboutToBeChanged(const QList<QPersistentModelIndex> &parents = QList<QPersistentModelIndex>(), QAbstractItemModel::LayoutChangeHint hint = QAbstractItemModel::NoLayoutChangeHint)

このシグナルは、モデルのレイアウトが変更される直前に発せられます。このシグナルに接続されたコンポーネントは、モデルのレイアウトの変更に適応するためにこのシグナルを使用します。

サブクラスは、layoutAboutToBeChanged()を発行した後、永続的なモデルのインデックスを更新する必要があります。

オプションのparents パラメータは、モデルのレイアウトのどの部分が変更されたかをより具体的に通知するために使用されます。空のリストは、モデル全体のレイアウトの変更を示します。parents リストの要素の順番は重要ではありません。オプションのhint パラメータは、モデルのリレーアウト中に何が起こっているかについてのヒントを与えるために使用されます。

layoutChanged() およびchangePersistentIndex()も参照の こと。

[signal] void QAbstractItemModel::layoutChanged(const QList<QPersistentModelIndex> &parents = QList<QPersistentModelIndex>(), QAbstractItemModel::LayoutChangeHint hint = QAbstractItemModel::NoLayoutChangeHint)

このシグナルは、モデルによって公開されたアイテムのレイアウトが変更されるたびに発行されます。このシグナルがビューによって受信されると、ビューはこの変更を反映するためにアイテムのレイアウトを更新する必要があります。

QAbstractItemModel またはQAbstractProxyModel をサブクラス化する場合は、アイテムの順序を変更したり、ビューに公開するデータの構造を変更したりする前にlayoutAboutToBeChanged() を発行し、レイアウトを変更した後に layoutChanged() を発行するようにしてください。

オプションのparents パラメータは、モデルのレイアウトのどの部分が変更されるのかをより具体的に通知するために使用されます。空のリストは、モデル全体のレイアウトの変更を示します。parents リストの要素の順序は重要ではありません。オプションのhint パラメータは、モデルのリレーアウト中に何が起こっているかについてのヒントを与えるために使用されます。

サブクラスは、layoutChanged() を発行する前に、永続的なモデルのインデックスを更新する必要があります。言い換えれば、構造が変更されたときに

• emitlayoutAboutToBeChanged
• 変更されるQModelIndex を覚えておく
• 内部データを更新する
• changePersistentIndex() を呼び出します。
• レイアウト変更

layoutAboutToBeChanged(),dataChanged(),headerDataChanged(),modelReset(),changePersistentIndex()も参照 。

[virtual invokable] QModelIndexList QAbstractItemModel::match(const QModelIndex &start, int role, const QVariant &value, int hits = 1, Qt::MatchFlags flags = Qt::MatchFlags(Qt::MatchStartsWith|Qt::MatchWrap)) const

与えられたrole の下に格納されているデータが、指定されたvalue と一致するstart インデックスの列の項目のインデックスのリストを返す。検索の実行方法は、指定されたflags で定義されます。返されるリストは空でもかまいません。また、例えばプロキシモデルが使用されている場合、リスト内の結果の順序はモデル内の順序と一致しない可能性があることに注意してください。結果の順序は当てになりません。

検索はstart インデックスから開始され、一致するデータ項目の数がhits に等しくなるまで、あるいは検索が最後の行に達するまで、あるいは検索が再びstart に達するまで続けられます -MatchWrap がflags で指定されているかどうかによって異なります。 一致するすべての項目を検索したい場合は、hits = -1 を使用します。

デフォルトでは、この関数はすべての項目に対して、value で指定された検索語で始まる項目を検索する、文字列ベースの折り返し比較を実行します。

[virtual] QMimeData *QAbstractItemModel::mimeData(const QModelIndexList &indexes) const

指定されたindexes のリストに対応するデータの直列化された項目を含むオブジェクトを返す。エンコードされたデータを記述するために使用されるフォーマットは、mimeTypes() 関数から取得されます。このデフォルトの実装では、mimeTypes() のデフォルトの実装が返すデフォルトの MIME タイプを使用します。カスタム・モデルでmimeTypes() を再実装してより多くの MIME タイプを返すようにする場合は、 この関数を再実装してそれらを使用するようにしてください。

indexes のリストが空である場合、またはサポートされる MIME タイプが存在しない場合は、シリアライズされた空のリストではなくnullptr が返されます。

mimeTypes() およびdropMimeData()も参照 。

[virtual] QStringList QAbstractItemModel::mimeTypes() const

許可される MIME タイプのリストを返します。デフォルトでは、組み込みのモデルとビューは内部 MIME タイプを使用します:application/x-qabstractitemmodeldatalist 。

カスタムモデルでドラッグ＆ドロップのサポートを実装する場合、デフォルトの内部MIMEタイプ以外の形式でデータを返すのであれば、MIMEタイプのリストを返すようにこの関数を再実装してください。

カスタムモデルでこの関数を再実装する場合、この関数を呼び出すメンバ関数mimeData() およびdropMimeData() も再実装する必要があります。

mimeData() およびdropMimeData()も参照して ください。

[private signal] void QAbstractItemModel::modelAboutToBeReset()

このシグナルは、モデルの内部状態（永続的なモデルのインデックスなど）が無効化される前にbeginResetModel() が呼び出されたときに発行されます。

beginResetModel() およびmodelReset()も参照してください 。

[private signal] void QAbstractItemModel::modelReset()

このシグナルは、モデルの内部状態（永続的なモデルのインデックスなど）が無効にされた後、endResetModel （）が呼び出されたときに発行されます。

モデルがリセットされた場合、そのモデルから以前に取得された情報はすべて無効であると考えるべきであることに注意してください。これには、rowCount （）、columnCount （）、flags （）、data （）、roleNames （）で取得されたデータが含まれますが、これらに限定されません。

endResetModel() およびmodelAboutToBeReset()も参照の こと。

[invokable] bool QAbstractItemModel::moveColumn(const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild)

これをサポートするモデルでは、sourceColumn をsourceParent からdestinationParent の下にあるdestinationChild に移動する。

カラムの移動に成功した場合はtrue を返し、失敗した場合はfalse を返します。

moveColumns() およびmoveRow()も参照してください 。

[virtual invokable] bool QAbstractItemModel::moveColumns(const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)

これをサポートするモデルでは、与えられたsourceColumn で始まる親sourceParent の下のcount 列を、親destinationParent の下のdestinationChild 列に移動する。

カラムの移動に成功した場合はtrue を返し、失敗した場合はfalse を返します。

基底クラスの実装は何もせず、false を返します。

独自のモデルを実装する場合、移動をサポートしたいのであれば、この関数を再実装することができます。あるいは、データを変更するための独自のAPIを提供することもできます。

beginMoveColumns() およびendMoveColumns()も参照して ください。

[invokable] bool QAbstractItemModel::moveRow(const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)

これをサポートするモデルでは、sourceRow をsourceParent からdestinationParent の下にあるdestinationChild に移動する。

行の移動に成功した場合はtrue を返し、失敗した場合はfalse を返します。

moveRows() およびmoveColumn()も参照して ください。

[virtual invokable] bool QAbstractItemModel::moveRows(const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)

これをサポートするモデルでは、与えられたsourceRow で始まる行を、親sourceParent の下にあるcount 行を、親destinationParent の下にあるdestinationChild 行に移動する。

行の移動に成功した場合はtrue を返し、失敗した場合はfalse を返します。

基底クラスの実装は何もせず、false を返します。

独自のモデルを実装する場合、移動をサポートしたいのであれば、この関数を再実装することができます。あるいは、データを変更するための独自のAPIを提供することもできます。

beginMoveRows() およびendMoveRows()も参照して ください。

[virtual, since 6.0] void QAbstractItemModel::multiData(const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const

与えられたindex に対して要求されたデータでroleDataSpan を埋める。

デフォルトの実装では、スパン内の各ロールに対して単にdata() を呼び出します。サブクラスは、より効率的にビューにデータを提供するために、この関数を再実装することができます：

void MyModel::multiData(const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const
{
    for (QModelRoleData &roleData : roleDataSpan) {
        int role = roleData.role();

        // ... obtain the data for index and role ...

        roleData.setData(result);
    }
}

上のスニペットでは、index は呼び出し全体で同じです。これは、index の情報を取得するために必要なデータ構造へのアクセスが一度だけで済むことを意味します（関連するコードをループの外に出す）。

QModelRoleData::setData （）、または同様にQVariant::setValue （）の使用は、QVariant を個別に構築したり、単純な代入演算子を使用するよりも推奨されます。これは、前者がQModelRoleData 内に格納されたQVariant オブジェクトのために既に割り当てられたメモリを再利用できるのに対し、後者は常に新しいバリアントを割り当て、古いバリアントを破棄するためです。

ビューは、以前の呼び出しで使用されたスパンでmultiData()を呼び出す可能性があり、したがって、すでにいくつかのデータを含んでいる可能性があることに注意してください。したがって、モデルが与えられたロールのデータを返すことができない場合、対応するQModelRoleData オブジェクトのデータをクリアする必要があります。これは、QModelRoleData::clearData()を呼び出すことによって行うことができます。また、同様に、QVariant などで構築されたデフォルトを設定することによって行うこともできます。データのクリアに失敗すると、ビューは "古い "データが対応するロールに使用されるものだと思い込むことになります。

最後に、コードの重複を避けるために、サブクラスはmultiData()の観点からdata()を再実装することもできます：

QVariant MyModel::data(const QModelIndex &index, int role) const
{
    QModelRoleData roleData(role);
    multiData(index, roleData);
    return roleData.data();
}

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

QModelRoleDataSpan およびdata()も参照してください 。

[pure virtual invokable] QModelIndex QAbstractItemModel::parent(const QModelIndex &index) const

与えられたindex を持つモデルアイテムの親を返します。項目に親がない場合は、無効なQModelIndex が返されます。

ツリーデータ構造を公開するモデルで使われる一般的な規約は、最初のカラムのアイテムだけが子を持つというものです。この場合、サブクラスでこの関数を再実装すると、返されるQModelIndex の列は 0 になります。

サブクラスでこの関数を再実装する場合、QModelIndex::parent() のようなQModelIndex メンバ関数を呼び出さないように注意してください。あなたのモデルに属するインデックスがあなたの実装を呼び出すだけで、無限再帰につながるからです。

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

[protected] QModelIndexList QAbstractItemModel::persistentIndexList() const

モデルに永続インデックスとして格納されているインデックスのリストを返します。

[invokable] bool QAbstractItemModel::removeColumn(int column, const QModelIndex &parent = QModelIndex())

指定されたparent の子項目から、指定されたcolumn を削除する。

カラムが削除された場合はtrue を返し、そうでない場合はfalse を返します。

removeColumns()、removeRow()、insertColumn()も参照してください 。

[virtual invokable] bool QAbstractItemModel::removeColumns(int column, int count, const QModelIndex &parent = QModelIndex())

これをサポートするモデル上で、モデルから親parent の下にある、与えられたcolumn で始まるcount 列を削除します。

カラムが正常に削除された場合はtrue を返し、そうでない場合はfalse を返します。

基底クラスの実装は何もせず、false を返します。

独自のモデルを実装する場合、削除をサポートしたいのであれば、この関数を再実装することができます。あるいは、データを変更するための独自のAPIを提供することもできます。

removeColumn(),removeRows(),insertColumns(),beginRemoveColumns(),endRemoveColumns()も参照して ください。

[invokable] bool QAbstractItemModel::removeRow(int row, const QModelIndex &parent = QModelIndex())

指定されたparent の子項目から、指定されたrow を削除する。

行が削除された場合はtrue を返し、そうでない場合はfalse を返す。

これはremoveRows() を呼び出す便利な関数である。removeRows() のQAbstractItemModel 実装は何もしません。

removeRows()、removeColumn()、insertRow()も参照して ください。

[virtual invokable] bool QAbstractItemModel::removeRows(int row, int count, const QModelIndex &parent = QModelIndex())

これをサポートするモデルでは、親であるparent の下にある、与えられたrow で始まるcount 行をモデルから削除します。

行の削除に成功した場合はtrue を返し、失敗した場合はfalse を返します。

基底クラスの実装は何もせず、false を返します。

独自のモデルを実装する場合、削除をサポートしたいのであれば、この関数を再実装することができます。あるいは、データを変更するための独自のAPIを提供することもできます。

removeRow(),removeColumns(),insertColumns(),beginRemoveRows(),endRemoveRows()も参照して ください。

[virtual protected slot] void QAbstractItemModel::resetInternalData()

このスロットは、モデルの内部データがリセット中にクリアされた直後に呼び出されます。

このスロットは、余分なデータを保持するQSortFilterProxyModel のサブクラスのような、具体的なプロキシモデルのサブクラスの便宜のために提供されています。

class CustomDataProxy : public QSortFilterProxyModel
{
    Q_OBJECT
public:
    CustomDataProxy(QObject *parent)
      : QSortFilterProxyModel(parent)
    {
    }

    ...

    QVariant data(const QModelIndex &index, int role) override
    {
        if (role != Qt::BackgroundRole)
            return QSortFilterProxyModel::data(index, role);

        if (m_customData.contains(index.row()))
            return m_customData.value(index.row());
        return QSortFilterProxyModel::data(index, role);
    }

private slots:
    void resetInternalData()
    {
        m_customData.clear();
    }

private:
  QHash<int, QVariant> m_customData;
};

modelAboutToBeReset() およびmodelReset()も参照してください 。

[virtual slot] void QAbstractItemModel::revert()

キャッシュされた情報を破棄することをモデルに知らせます。この関数は通常、行の編集に使用されます。

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

[virtual] QHash<int, QByteArray> QAbstractItemModel::roleNames() const

モデルのロール名を返します。

Qtが設定するデフォルトのロール名は以下の通りです：

[pure virtual invokable] int QAbstractItemModel::rowCount(const QModelIndex &parent = QModelIndex()) const

与えられたparent の下にある行の数を返します。親が有効な場合、rowCount は親の子の数を返します。

columnCount()も参照 。

[private signal] void QAbstractItemModel::rowsAboutToBeInserted(const QModelIndex &parent, int start, int end)

このシグナルは、行がモデルに挿入される直前に発せられます。新しい項目は、start とend の間、指定されたparent 項目の下に配置されます。

insertRows() およびbeginInsertRows()も参照してください 。

[private signal] void QAbstractItemModel::rowsAboutToBeMoved(const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

このシグナルは、モデル内で行が移動される直前に発せられる。移動される項目は、与えられたsourceParent 項目の下にある、sourceStart からsourceEnd までの項目です。これらは、destinationRow の行からdestinationParent に移動されます。

注意:このシグナルに接続されたコンポーネントは、モデルの寸法の変更に適応するためにこのシグナルを使用します。このシグナルはQAbstractItemModel の実装によってのみ発することができ、サブクラスのコードで明示的に発することはできません。

beginMoveRows()も参照 。

[private signal] void QAbstractItemModel::rowsAboutToBeRemoved(const QModelIndex &parent, int first, int last)

このシグナルは、モデルから行が削除される直前に発せられます。削除される項目は、指定されたparent 項目の下にある、first からlast までの項目です。

removeRows() およびbeginRemoveRows()も参照してください 。

[private signal] void QAbstractItemModel::rowsInserted(const QModelIndex &parent, int first, int last)

このシグナルは、行がモデルに挿入された後に発行される。新しい項目とは、first からlast までの項目で、指定されたparent 項目の下にあるものです。

insertRows() およびbeginInsertRows()も参照してください 。

[private signal] void QAbstractItemModel::rowsMoved(const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

このシグナルは、モデル内で行が移動された後に発行される。指定されたsourceParent 項目の下にある、sourceStart からsourceEnd までの項目が、destinationRow 行から始まるdestinationParent に移動されました。

注意:このシグナルに接続されたコンポーネントは、モデルの寸法の変更に適応するためにこのシグナルを使用します。このシグナルはQAbstractItemModel 実装によってのみ発することができ、サブクラスのコードで明示的に発することはできません。

beginMoveRows()も参照 。

[private signal] void QAbstractItemModel::rowsRemoved(const QModelIndex &parent, int first, int last)

このシグナルは、モデルから行が削除された後に発行される。削除される項目は、first からlast までの項目で、指定されたparent 項目の下にあるものです。

removeRows() およびbeginRemoveRows()も参照してください 。

[virtual invokable] bool QAbstractItemModel::setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole)

index にある項目のrole データをvalue に設定する。

成功すればtrue を返し、そうでなければfalse を返す。

データが正常に設定された場合は、dataChanged() シグナルが発行されます。

ベース・クラスの実装はfalse を返します。編集可能なモデルの場合は、この関数とdata() を再実装する必要があります。

Qt::ItemDataRole 、data()、itemData()も参照してください 。

[virtual] bool QAbstractItemModel::setHeaderData(int section, Qt::Orientation orientation, const QVariant &value, int role = Qt::EditRole)

指定されたorientation を持つヘッダー内の、指定されたrole とsection のデータを、指定されたvalue に設定する。

ヘッダーのデータが更新された場合はtrue を返し、そうでない場合はfalse を返す。

この関数を再実装する場合、headerDataChanged() シグナルを明示的に発する必要がある。

Qt::ItemDataRole およびheaderData()も参照のこと 。

[virtual] bool QAbstractItemModel::setItemData(const QModelIndex &index, const QMap<int, QVariant> &roles)

Qt::ItemDataRole 毎に、index の項目のロールデータをroles の関連値に設定する。

成功した場合はtrue を返し、失敗した場合はfalse を返します。

roles にないロールは変更されません。

setData()、data()、およびitemData()も参照してください 。

[virtual invokable] QModelIndex QAbstractItemModel::sibling(int row, int column, const QModelIndex &index) const

index にあるアイテムのrow とcolumn にある兄弟、またはその位置に兄弟がない場合は無効なQModelIndex を返します。

sibling() は単に便利な関数で、アイテムの親を見つけ、それを使って指定されたrow とcolumn にある子アイテムのインデックスを取得します。

このメソッドは、実装固有の最適化のためにオーバーライドすることもできます。

index()、QModelIndex::row()、QModelIndex::column()も参照して ください。

[virtual invokable] void QAbstractItemModel::sort(int column, Qt::SortOrder order = Qt::AscendingOrder)

与えられたorder のcolumn でモデルをソートする。

基底クラスの実装は何もしません。

[virtual] QSize QAbstractItemModel::span(const QModelIndex &index) const

index で表される項目の行と列のスパンを返す。

[virtual slot] bool QAbstractItemModel::submit()

キャッシュされた情報を永続的なストレージに送信することをモデルに知らせます。この関数は通常、行の編集に使用される。

エラーがなければtrue を返し、エラーがなければfalse を返します。

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

[virtual] Qt::DropActions QAbstractItemModel::supportedDragActions() const

このモデルのデータがサポートするアクションを返します。

デフォルトの実装はsupportedDropActions() を返します。追加のアクションをサポートしたい場合は、この関数を再実装してください。

supportedDragActions() は、ドラッグが発生したときのデフォルト値としてQAbstractItemView::startDrag() によって使用されます。

Qt::DropActions およびUsing drag and drop with item viewsも参照してください 。

[virtual] Qt::DropActions QAbstractItemModel::supportedDropActions() const

このモデルがサポートするドロップアクションを返します。

デフォルトの実装はQt::CopyAction を返します。追加のアクションをサポートしたい場合は、この関数を再実装します。また、dropMimeData() 関数を再実装して、追加操作を処理する必要があります。

dropMimeData()、Qt::DropActions 、およびUsing drag and drop with item viewsも参照してください 。