QRangeModel Class

成员函数文档

构建一个QRangeModel 实例，该实例对range 中的数据进行操作。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;
    }
};

否则，如果该范围中的行类型有RowOptions 的定制版本，且该定制版本具有合适的canDropMimeData()类成员函数，则此实现将返回调用该函数的结果。

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。

返回存储在给定role 下的、位于index 所指范围内的值的数据。

如果该索引的项类型是一个关联容器，该容器将int 、Qt::ItemDataRole 或QString 映射到QVariant ，则会在该容器中查找角色数据并返回。

如果该项目是小工具或QObject ，则实现将返回该项目中与roleNames()映射中role 条目匹配的属性的值。

否则，实现将返回一个通过QVariant::fromValue() 基于该项构建的QVariant ，用于Qt::DisplayRole 或Qt::EditRole 。对于其他角色，实现将返回一个无效的（默认构造的）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;
    }
};

否则，如果范围中的行类型有RowOptions 的定制版本，且该定制版本具有合适的dropMimeData()类成员函数，则此实现将返回调用该函数的结果。

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。

返回标题中指定role 和section 对应的数据，其orientation 为指定值。

对于水平标题，部分编号对应于列号。同样，对于垂直标题，部分编号对应于行号。

对于水平标题和Qt::DisplayRole role ，对使用数组作为行类型的范围进行操作的模型将返回section 。如果行类型是元组，则该实现将返回section 处该类型的名称。对于属于gadget或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)。

在parent 处指定的范围内，将count 个空行插入到row 之前。成功时返回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。

返回一个索引列表，其中包含start 列中那些数据（存储于role ）与value 匹配的项，匹配依据由flags 定义。若使用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;
    }
};

否则，如果该范围中的行类型有可用的 `RowOptions ` 定制版本，且该定制版本具有合适的 `mimeData()` 类成员函数，则此实现将返回调用该函数的结果。

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
        };
    }
};

否则，如果范围中的行类型有可用的 `RowOptions ` 定制版本，且该定制版本具有合适的 `mimeTypes()` 类成员函数，则此实现将返回调用该函数的结果。

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）。

count 将父节点sourceParent 下的第 sourceRow 行（从给定的sourceRow 开始）移动到父节点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 中的范围中移除count 行，从给定的row 开始。成功时返回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 中的值赋给范围中index 位置的项（针对Qt::DisplayRole 和Qt::EditRole ），并返回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 ，则仅存储data 中那些在role names 表中存在映射关系的值。

如果项目类型是小工具或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。

返回位于row 和column 处、与位于index 的项目相对应的兄弟项；如果该位置没有兄弟项，则返回无效的QModelIndex 。

此实现比通过parent() 调用index 的方式快得多。

另请参阅 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。