QRangeModel Class

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

range 内のデータを操作するQRangeModel インスタンスを構築します。range は、コンパイラが引数依存検索を通じてbegin およびend のオーバーロードを検出できるシーケンシャル範囲であるか、あるいはstd::begin およびstd::end が実装されている範囲でなければなりません。protocol が指定された場合、モデルはその範囲をプロトコル実装を用いてツリーとして表現します。このモデルインスタンスは、parent の子となります。

range はポインタまたは参照ラッパーである可能性があります。その場合、モデルAPIの変更（setData()やinsertRow()など）によって、参照先の範囲インスタンス内のデータが変更されます。range が値である場合（またはモデル内に移動された場合）、モデルの発行するシグナルに接続して、データの変更に応答します。

QRangeModel このコンストラクタは、構築中にrange にアクセスすることはありません。これにより、例えばsubclassing QRangeModel の場合のように、まだ完全に構築されていない範囲オブジェクトへのポインタや参照をこのコンストラクタに渡すことが許容されます。

range がモデル内に移動された場合、モデルの破棄時に、その範囲およびその中のすべてのデータが破棄されます。

QRangeModelAdapterも参照してください 。

[override virtual noexcept] QRangeModel::~QRangeModel()

QRangeModel を破棄します。

モデルが構築された範囲にはアクセスされず、モデルが移動された範囲から構築された場合にのみ破棄されます。

[override virtual] QModelIndex QRangeModel::buddy(const QModelIndex &index) const

QAbstractItemModel::buddy(const QModelIndex &index) const を再実装します。

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

QAbstractItemModel::canDropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const を再実装します。

範囲に格納されている項目タイプに対してItemAccess のカスタマイズが利用可能であり、そのカスタマイズが適切なcanDropMimeData() クラスメンバ関数を実装している場合、この実装はその関数を呼び出し、その結果を返します。

template <>
struct QRangeModel::ItemAccess<ColorEntry>
{
    static bool canDropMimeData(const QMimeData *mimeData)
    {
        // ...
        return true;
    }
};

それ以外の場合、範囲内の行タイプに対して、適切なcanDropMimeData() クラスメンバ関数を持つRowOptions のカスタマイズが利用可能な場合は、この実装はその関数を呼び出してその結果を返します。

template <>
struct QRangeModel::RowOptions<ColorEntry>
{
    static bool canDropMimeData(const QMimeData *mimeData)
    {
        // ...
        return true;
    }
};

どちらのカスタマイズも利用できない場合、この実装は `QAbstractItemModel ` のデフォルト実装の結果を返します。

Drag'n'drop handling 、RowOptions::canDropMimeData()、ItemAccess::canDropMimeData()、dropMimeData()、mimeTypes()、およびmimeData()も参照してください 。

[override virtual] bool QRangeModel::canFetchMore(const QModelIndex &parent) const

QAbstractItemModel::canFetchMore(const QModelIndex &parent) const を再実装しています。

[override virtual] bool QRangeModel::clearItemData(const QModelIndex &index)

QAbstractItemModel::clearItemData(const QModelIndex &index) を再実装します。

index の範囲に格納されている値を、デフォルト構築された値に置き換えます。

読み取り専用範囲、または `the C++ tuple protocol` を実装する行型の読み取り専用列を操作するモデルの場合、この実装は直ちに `false ` を返します。

[override virtual] int QRangeModel::columnCount(const QModelIndex &parent = {}) const

QAbstractItemModel::columnCount(const QModelIndex &parent) const を再実装します。

モデルの列数を返します。この関数は、すべての `parent ` インデックスに対して同じ値を返します。

静的な行サイズを持つ行型を扱うモデルの場合、この戻り値はモデルの存続期間を通じて常に同じです。動的な行サイズを持つ行型を扱うモデルの場合、モデルは最初の行の項目数を返します。行がない場合は 0 を返します。

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

[override virtual] QVariant QRangeModel::data(const QModelIndex &index, int role = Qt::DisplayRole) const

QAbstractItemModel::data(const QModelIndex &index, int role) const を再実装します。

index が指す範囲内の値について、指定されたrole の下に格納されているデータを返します。

そのインデックスのアイテム型が、int 、Qt::ItemDataRole 、またはQString のいずれかからQVariant へマッピングする連想コンテナである場合、そのコンテナ内でroleデータが検索され、返されます。

項目がガジェットまたはQObject である場合、実装は、roleNames()のマッピングにおけるrole エントリに一致する項目のプロパティの値を返します。

それ以外の場合、実装は、Qt::DisplayRole またはQt::EditRole に対して、QVariant::fromValue() を介してその項目から構築されたQVariant を返します。その他の役割については、実装は無効な（デフォルト構築された）QVariant を返します。

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

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

QAbstractItemModel::dropMimeData （const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent）を再実装します。

範囲に格納されている項目タイプに対してItemAccess のカスタマイズが利用可能であり、そのカスタマイズが適切なdropMimeData() クラスメンバ関数を実装している場合、この実装はその関数を呼び出し、その結果を返します。

template <>
struct QRangeModel::ItemAccess<ColorEntry>
{
    static bool dropMimeData(const QMimeData *mimeData, auto inserter)
    {
        QByteArray data = mimeData->data(mimeTypes().first());
        if (data.isEmpty())
            return false;
        QTextStream stream(&data, QIODevice::ReadOnly);
        while (!stream.atEnd()) {
            QString colorName;
            stream >> colorName;
            inserter = ColorEntry(colorName);
        }
        return true;
    }
};

それ以外の場合、範囲内の行タイプに対して、適切なdropMimeData() クラスメンバ関数を持つRowOptions のカスタマイズが利用可能な場合、この実装はその関数を呼び出してその結果を返します。

template <>
struct QRangeModel::RowOptions<ColorEntry>
{
    static bool dropMimeData(const QMimeData *mimeData, auto inserter)
    {
        const QByteArray data = mimeData->data(mimeTypes().first());
        if (data.isEmpty())
            return false;
        QXmlStreamReader stream(data);
        while (!stream.atEnd()) {
            stream.readNext();
            if (stream.isStartElement() && stream.name() == u"li"_s)
                inserter = ColorEntry(stream.readElementText());
        }

        return true;
    }
};

どちらのカスタマイズも利用できない場合、この実装はデフォルトの `QAbstractItemModel ` 実装の結果を返します。

Drag'n'drop handling 、RowOptions::dropMimeData()、ItemAccess::dropMimeData()、canDropMimeData()、mimeTypes()、およびmimeData()も参照してください 。

[override virtual protected] bool QRangeModel::event(QEvent *event)

QObject::event(QEvent *e) の再実装です。

[override virtual protected] bool QRangeModel::eventFilter(QObject *object, QEvent *event)

QObject::eventFilter(QObject *watched, QEvent *event) を再実装します。

[override virtual] void QRangeModel::fetchMore(const QModelIndex &parent)

QAbstractItemModel::fetchMore （const QModelIndex &parent）を再実装します。

[override virtual] Qt::ItemFlags QRangeModel::flags(const QModelIndex &index) const

QAbstractItemModel::flags(const QModelIndex &index) const の再実装。

指定された `index` に対するアイテムフラグを返します。

この実装は、アイテム (ItemIsEnabled) を有効にし、それが選択可能になる (ItemIsSelectable) ようにするフラグの組み合わせを返します。可変データを含む範囲を操作するモデルの場合、アイテムが編集可能になる (ItemIsEditable) ようにするフラグも設定します。

mimeTypes() の非空リストを返すモデルも、Qt::ItemIsDragEnabled を設定し、読み取り専用でない限り、Qt::ItemIsDropEnabled フラグも設定します。

フラットモデルはすべての項目に対してQt::ItemNeverHasChildren を設定しますが、階層モデルは0より上の列にあるすべての項目に対してそのフラグを設定します。

独自のデータ型に合わせてフラグをカスタマイズするには、行型または項目型に対して `RowOptions ` および/または `ItemAccess ` の特化型を定義し、静的メンバ関数 `flags()` を実装します。

template <>
struct QRangeModel::ItemAccess<ColorEntry>
{
    static Qt::ItemFlags flags(const ColorEntry &entry)
    {
        return entry.flags();
    }
};

Qt::ItemFlags 、RowOptions 、およびItemAccessも参照してください 。

[override virtual] bool QRangeModel::hasChildren(const QModelIndex &parent = QModelIndex()) const

QAbstractItemModel::hasChildren(const QModelIndex &parent) const を再実装します。

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

QAbstractItemModel::headerData(int section, Qt::Orientation orientation, int role) const を再実装します。

指定されたorientation を持つヘッダー内の、指定されたrole およびsection に対応するデータを返します。

水平ヘッダーの場合、セクション番号は列番号に対応します。同様に、垂直ヘッダーの場合、セクション番号は行番号に対応します。

水平ヘッダーおよびQt::DisplayRole role については、行の型として配列を使用する範囲に対して動作するモデルは、section を返します。行の型がタプルの場合、実装はsection にある型の名前を返します。ガジェットまたはQObject 型の行については、この関数はsection のインデックスにあるプロパティの名前を返します。

独自の範囲の水平ヘッダーデータをカスタマイズするには、行型に対してRowOptions の特化形を定義し、headerData() というクラスメンバー関数を実装します:

template <>
struct QRangeModel::RowOptions<ColorEntry>
{
    static QVariant headerData(int section, int role)
    {
        switch (section) {
            // ...
        }
        return {};
    }
};

縦方向のヘッダーについては、この関数は常にQAbstractItemModel 内のデフォルト実装の結果を返します。

Qt::ItemDataRole 、setHeaderData()、QHeaderView 、およびRowOptionsも参照してください 。

[override virtual] QModelIndex QRangeModel::index(int row, int column, const QModelIndex &parent = {}) const

QAbstractItemModel::index(int row, int column, const QModelIndex &parent) const の再実装。

parent において、row およびcolumn におけるモデル項目のインデックスを返します。

有効な親を指定すると、リストやテーブルの範囲を操作するモデルでは無効なインデックスが生成されます。

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

[override virtual] bool QRangeModel::insertColumns(int column, int count, const QModelIndex &parent = {})

QAbstractItemModel::insertColumns(int column, int count, const QModelIndex &parent) を再実装します。

parent で指定された範囲内のすべての行において、column にある項目の前に、count 個の空の列を挿入します。成功した場合はtrue を返し、失敗した場合はfalse を返します。

読み取り専用の範囲、または静的にサイズが決定された行型（タプル、配列、構造体など）を持つ範囲を操作するモデルの場合、この実装は何も行わず、直ちに `false ` を返します。これはツリーモデルでは常に当てはまります。

[override virtual] bool QRangeModel::insertRows(int row, int count, const QModelIndex &parent = {})

QAbstractItemModel::insertRows(int row, int count, const QModelIndex &parent) を再実装します。

指定されたrow の前に、count の空の行を、parent の範囲内に挿入します。成功した場合はtrue を返し、失敗した場合はfalse を返します。

読み取り専用または静的なサイズを持つ範囲（配列など）を操作するモデルの場合、この実装は何も行わず、直ちに `false ` を返します。

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

QAbstractItemModel::itemData(const QModelIndex &index) const を再実装します。

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

そのindex のアイテム型が、int 、Qt::ItemDataRole 、またはQString のいずれかからQVariant へマッピングする連想コンテナである場合、そのコンテナのデータが返されます。

項目のタイプがガジェットまたはQObject のサブクラスである場合、role name に一致するプロパティの値が返されます。

項目が連想コンテナ、ガジェット、またはQObject のサブクラスでない場合、この関数は基底クラスの実装を呼び出します。

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

[override virtual] QModelIndexList QRangeModel::match(const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const

QAbstractItemModel::match(const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const を再実装します。

flags で定義された一致条件を用いて、role に格納されたデータがvalue と一致する、start の列内の項目のインデックスのリストを返します。hits = -1 を使用すると、一致するすべての項目を検索できます。

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

QAbstractItemModel::mimeData(const QModelIndexList &indexes) const を再実装します。

範囲内に格納されている項目型に対してItemAccess のカスタマイズが利用可能であり、かつそのカスタマイズが適切なmimeData()クラスメンバ関数を実装している場合、この実装はその関数を呼び出し、その結果を返します。

template <>
struct QRangeModel::ItemAccess<ColorEntry>
{
    static QMimeData *mimeData(const auto &range)
    {
        QByteArray data;
        QTextStream stream(&data, QIODevice::WriteOnly);
        for (const auto &[item, index] : range)
            stream << item.colorName() << Qt::endl;

        QMimeData *result = new QMimeData;
        result->setData(mimeTypes().first(), data);
        // Qt handles encoding into the default mime type
        return result;
    }
};

そうでない場合、範囲内の行型に対して、適切な `mimeData()` クラスメンバ関数を持つ `RowOptions ` のカスタマイズが利用可能な場合、この実装はその関数を呼び出して結果を返します。

template <>
struct QRangeModel::RowOptions<ColorEntry>
{
    template <typename Items>
    static QMimeData *mimeData(const Items &items)
    {
        if (items.isEmpty())
            return nullptr;
        QByteArray data;
        QXmlStreamWriter stream(&data);
        stream.writeStartElement("ul");
        for (const auto &[item, index] : items)
            stream.writeTextElement("li", item.colorName());
        stream.writeEndElement();

        QMimeData *mimeData = new QMimeData;
        mimeData->setData(mimeTypes().first(), data);
        return mimeData;
    }
};

どちらのカスタマイズも利用できない場合、この実装はQAbstractItemModel のデフォルト実装の結果を返します。

Drag'n'drop handling 、RowOptions::mimeData()、ItemAccess::mimeData()、canDropMimeData()、dropMimeData()、およびmimeTypes()も参照してください 。

[override virtual] QStringList QRangeModel::mimeTypes() const

QAbstractItemModel::mimeTypes() const を再実装します。

範囲に格納されている項目型に対してItemAccess のカスタマイズが利用可能であり、かつそのカスタマイズが適切なmimeTypes()クラスメンバ関数を実装している場合、この実装はその関数を呼び出し、その結果を返します。

template <>
struct QRangeModel::ItemAccess<ColorEntry>
{
    static QStringList mimeTypes()
    {
        return {
            u"text/plain"_s,
            u"application/x-qabstractitemmodeldatalist"_s
        };
    }
};

それ以外の場合、範囲内の行型に対して、適切な `mimeTypes()` クラスメンバ関数を持つ `RowOptions ` のカスタマイズが利用可能な場合、この実装はその関数を呼び出してその結果を返します。

template <>
struct QRangeModel::RowOptions<ColorEntry>
{
    static QStringList mimeTypes()
    {
        return {
            u"text/html"_s
        };
    }
};

どちらのカスタマイズも利用できない場合、この実装はQAbstractItemModel のデフォルトの実装の結果を返します。

Drag'n'drop handling 、RowOptions::mimeTypes()、ItemAccess::mimeTypes()、canDropMimeData()、dropMimeData()、およびmimeData()も参照してください 。

[override virtual] bool QRangeModel::moveColumns(const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationColumn)

再実装対象：QAbstractItemModel::moveColumns(const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)。

親sourceParent の下にある、指定されたsourceColumn から始まるcount の列を、親destinationParent の下にあるdestinationColumn の列へ移動します。

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

[override virtual] bool QRangeModel::moveRows(const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationRow)

再実装対象：QAbstractItemModel::moveRows(const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)。

指定されたsourceRow から始まるcount の行を、親sourceParent の下から、親destinationParent の下にある行destinationRow へ移動します。

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

[override virtual] void QRangeModel::multiData(const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const

QAbstractItemModel::multiData(const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const を再実装します。

[override virtual] QModelIndex QRangeModel::parent(const QModelIndex &child) const

QAbstractItemModel::parent(const QModelIndex &index) const を再実装します。

child のインデックスにある項目の親を返します。

この関数は、リストやテーブルの範囲を操作するモデルに対しては、常に無効なインデックスを返します。ツリーを操作するモデルの場合、この関数は、ツリー探索プロトコルの parent() 実装によって返される行項目のインデックスを返します。

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

[override virtual] bool QRangeModel::removeColumns(int column, int count, const QModelIndex &parent = {})

QAbstractItemModel::removeColumns(int column, int count, const QModelIndex &parent) を再実装します。

範囲parent のすべての行において、column にある項目からcount 列を削除します。成功した場合はtrue を返し、失敗した場合はfalse を返します。

読み取り専用の範囲、または静的にサイズが決定された行型（タプル、配列、構造体など）を持つ範囲で動作するモデルの場合、この実装は何も行わず、直ちにfalse を返します。これはツリーモデルでは常に当てはまります。

[override virtual] bool QRangeModel::removeRows(int row, int count, const QModelIndex &parent = {})

QAbstractItemModel::removeRows(int row, int count, const QModelIndex &parent) を再実装します。

parent にある範囲から、指定されたrow を起点として、count の行を削除します。成功した場合はtrue を返し、失敗した場合はfalse を返します。

読み取り専用またはサイズが静的に決定された範囲（配列など）を操作するモデルの場合、この実装は何も行わず、直ちにfalse を返します。

[override virtual protected slot] void QRangeModel::resetInternalData()

QAbstractItemModel::resetInternalData() の再実装です。

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

QAbstractItemModel::roleNames() const を再実装します。

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

[override virtual] int QRangeModel::rowCount(const QModelIndex &parent = {}) const

QAbstractItemModel::rowCount(const QModelIndex &parent) const を再実装します。

指定された `parent` の直下に存在する行の数を返します。これは、無効な `parent ` インデックスに対するルート範囲内の項目数です。

parent インデックスが有効な場合、リストおよびテーブルの範囲を操作するモデルでは、この関数は常に 0 を返します。ツリーの場合、これはツリー走査プロトコルの childRows() 実装によって返される範囲のサイズを返します。

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

[override virtual] bool QRangeModel::setData(const QModelIndex &index, const QVariant &data, int role = Qt::EditRole)

QAbstractItemModel::setData(const QModelIndex &index, const QVariant &value, int role) を再実装します。

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

そのindex の項目タイプが、int 、Qt::ItemDataRole 、またはQString のいずれかからQVariant へのマッピングを行う連想コンテナである場合、data は、role で指定されたキーに対してそのコンテナに格納されます。

アイテムがガジェットまたはQObject である場合、data は、roleNames() マッピング内のrole エントリに一致するアイテムのプロパティに書き込まれます。この関数は、プロパティが見つかり、かつdata に格納された値が要求された型に変換可能な場合、true を返し、そうでない場合はfalse を返します。

それ以外の場合、この実装は、data にある値を、Qt::DisplayRole およびQt::EditRole の範囲内のindex にある項目に割り当て、true を返します。その他の役割については、この実装はfalse を返します。

読み取り専用範囲、またはthe C++ tuple protocol を実装する行型内の読み取り専用列に対して操作を行うモデルの場合、この実装は直ちにfalse を返します。

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

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

QAbstractItemModel::setHeaderData(int section, Qt::Orientation orientation, const QVariant &value, int role) を再実装します。

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

[override virtual] bool QRangeModel::setItemData(const QModelIndex &index, const QMap<int, QVariant> &data)

QAbstractItemModel::setItemData(const QModelIndex &index, const QMap<int, QVariant> &roles) を再実装します。

そのindex の項目型が、int またはQt::ItemDataRole からQVariant へのマッピングを行う連想コンテナである場合、data 内のエントリはそのコンテナに格納されます。連想コンテナがQString からQVariant へのマッピングを行う場合、role names テーブルにマッピングが存在するdata 内の値のみが格納されます。

アイテムのタイプがガジェットまたはQObject のサブクラスである場合、role name に一致するプロパティは、data 内の対応する値に設定されます。

data にエントリがないロールは変更されません。

コピー可能なアイテムタイプの場合、この実装はトランザクション処理となり、data のすべてのエントリを保存できた場合に true を返します。いずれかのエントリを更新できなかった場合、元のコンテナは一切変更されず、関数は false を返します。

アイテムが連想コンテナ、ガジェット、または `QObject ` のサブクラスでない場合、この関数は基底クラスの実装を呼び出し、基底クラスの実装は `data` 内の各エントリに対して `setData()` を呼び出します。

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

[override virtual] QModelIndex QRangeModel::sibling(int row, int column, const QModelIndex &index) const

QAbstractItemModel::sibling(int row, int column, const QModelIndex &index) const を再実装します。

index にある項目の、row およびcolumn にある兄弟要素を返します。その位置に兄弟要素が存在しない場合は、無効なQModelIndex を返します。

この実装は、index のparent()を経由するよりも大幅に高速です。

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

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

QAbstractItemModel::sort(int column, Qt::SortOrder order) を再実装します。

column 内の項目のsortRole （デフォルトではQt::DisplayRole ）のデータに基づいて、指定されたorder に従って、基となる範囲をソートします。

sortRole およびQSortFilterProxyModelも参照してください 。

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

QAbstractItemModel::span(const QModelIndex &index) const を再実装します。