QSortFilterProxyModel Class

成员函数文档

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

根据给定的parent 构建一个排序过滤器模型。

[virtual noexcept] QSortFilterProxyModel::~QSortFilterProxyModel()

删除此排序过滤器模型。

[signal, since 6.0] void QSortFilterProxyModel::autoAcceptChildRowsChanged(bool autoAcceptChildRows)

当autoAcceptChildRows 属性的值发生变化时，会触发此信号。

该函数在 Qt 6.0 中引入。

另请参阅 autoAcceptChildRows 。

[protected, since 6.9] void QSortFilterProxyModel::beginFilterChange()

准备更换过滤器。

如果您正在实现自定义过滤（例如filterAcceptsRow()），且过滤器参数即将发生变更，则应调用此函数。

void MySortFilterProxyModel::setFilterMaximumDate(QDate date)
{
    beginFilterChange();
    maxDate = date;
    endFilterChange(QSortFilterProxyModel::Direction::Rows);
}

过滤器更改完成后，请调用endFilterChange()：若为行过滤器，则传入Direction::Rows ；若为列过滤器，则传入Direction::Columns ；若同时对行和列进行过滤，则传入Direction::Columns|Direction::Rows 。

该函数在 Qt 6.9 中引入。

另请参阅 endFilterChange()。

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

重写了：QAbstractProxyModel::buddy(const QModelIndex &index) const。

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

重写：QAbstractProxyModel::canFetchMore(const QModelIndex &parent) const。

[override virtual] int QSortFilterProxyModel::columnCount(const QModelIndex &parent = QModelIndex()) const

重写了：QAbstractItemModel::columnCount(const QModelIndex &parent) const。

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

重写了：QAbstractProxyModel::data(const QModelIndex &proxyIndex, int role) const。

另请参阅 setData()。

[protected invokable, since 6.12] QSortFilterProxyModel::DataChangeRelevanceFlags QSortFilterProxyModel::dataChangeRelevanceFlags(const QModelIndex &sourceTopLeft, const QModelIndex &sourceBottomRight, const QList<int> &roles) const

在子类中重新实现此插槽，以指示源模型的更改何时与过滤或排序相关。此功能用于性能优化，以避免在源模型发生不影响排序和过滤结果的更改时，不必要地调用filterAcceptsRow() 和lessThan()。 参数sourceTopLeft 、sourceBottomRight 和roles 由源模型的dataChanged() 信号发出，该信号对应于正在评估相关性的变更。

该函数在 Qt 6.12 中引入。

另请参阅 DataChangeRelevanceFlags 、filterAcceptsRow() 以及lessThan()。

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

重写了：QAbstractProxyModel::dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)。

[protected, since 6.10] void QSortFilterProxyModel::endFilterChange(QSortFilterProxyModel::Directions directions = Direction::Both)

在过滤器参数发生变化后，使当前过滤失效。

如果您实现了自定义筛选（例如 `filterAcceptsRow()`），且筛选参数已发生变化，则应调用此函数。参数 `directions ` 指定自定义筛选影响行、列还是两者。

当过滤参数即将发生变化时，请调用 `beginFilterChange()`；待过滤参数变更完成后，请随即调用此函数。 对于行过滤器，请将directions 设置为Direction::Rows （即实现了filterAcceptsRow()）；对于列过滤器，请设置为Direction::Columns （即实现了filterAcceptsColumn()）；若同时实现了行和列过滤器，则请设置为Direction::Both 。

该函数于 Qt 6.10 中引入。

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

重写了：QAbstractProxyModel::fetchMore(const QModelIndex &parent)。

[virtual protected] bool QSortFilterProxyModel::filterAcceptsColumn(int source_column, const QModelIndex &source_parent) const

如果应将由给定的source_column 和source_parent 所指明的列中的项包含在模型中，则返回true ；否则返回false 。

另请参阅 filterAcceptsRow()、setFilterFixedString()、setFilterRegularExpression() 以及setFilterWildcard()。

[virtual protected] bool QSortFilterProxyModel::filterAcceptsRow(int source_row, const QModelIndex &source_parent) const

如果给定的source_row 和source_parent 所指向的行中的项应被纳入模型，则返回true ；否则返回false。

默认实现会在相关项的值与过滤字符串、通配符字符串或正则表达式匹配时返回 `true `。

另请参阅 filterAcceptsColumn()、setFilterFixedString()、setFilterRegularExpression() 和setFilterWildcard()。

[signal] void QSortFilterProxyModel::filterCaseSensitivityChanged(Qt::CaseSensitivity filterCaseSensitivity)

当过滤器的大小写敏感性更改为filterCaseSensitivity 时，将发出此信号。

[signal] void QSortFilterProxyModel::filterRoleChanged(int filterRole)

当过滤器角色变为filterRole 时，会发出此信号。

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

重写了：QAbstractProxyModel::flags(const QModelIndex &index) const。

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

重写了：QAbstractProxyModel::hasChildren(const QModelIndex &parent) const。

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

重写了：QAbstractProxyModel::headerData(int section, Qt::Orientation orientation, int role) const。

另请参阅 setHeaderData()。

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

重写了：QAbstractItemModel::index(int row, int column, const QModelIndex &parent) const。

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

重写了：QAbstractItemModel::insertColumns(int column, int count, const QModelIndex &parent)。

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

重写了：QAbstractItemModel::insertRows(int row, int count, const QModelIndex &parent)。

[slot] void QSortFilterProxyModel::invalidate()

清除当前的排序和筛选设置。

另请参阅 beginFilterChange() 和endFilterChange()。

[protected, since 6.0, until 6.13] void QSortFilterProxyModel::invalidateColumnsFilter()

该函数计划在 6.13 版本中被废弃。

请改用beginFilterChange() 和endFilterChange(Direction::Rows)。

使列的当前过滤失效。

如果您正在实现自定义过滤（通过filterAcceptsColumn()），且过滤参数已发生变化，则应调用此函数。它与invalidateFilter() 的区别在于，它不会调用filterAcceptsRow()，而只会调用filterAcceptsColumn()。如果您想隐藏或显示行内容未发生变化的列，可以使用此函数代替invalidateFilter()。

在过滤器参数发生变化之前，请调用beginFilterChange()。

该函数在 Qt 6.0 中引入。

另请参阅 invalidate()、invalidateRowsFilter() 和beginFilterChange()。

[protected, until 6.13] void QSortFilterProxyModel::invalidateFilter()

该函数计划在 6.13 版本中被废弃。

请改用beginFilterChange() 和endFilterChange()。

使当前过滤失效。

如果您正在实现自定义过滤（例如filterAcceptsRow()），且过滤参数已发生变化，则应调用此函数。

在过滤器参数更改之前，请调用beginFilterChange()。

void MySortFilterProxyModel::setFilterMaximumDate(QDate date)
{
    beginFilterChange();
    maxDate = date;
    endFilterChange(QSortFilterProxyModel::Direction::Rows);
}

另请参阅 invalidate()、invalidateColumnsFilter()、invalidateRowsFilter() 和beginFilterChange()。

[protected, since 6.0, until 6.13] void QSortFilterProxyModel::invalidateRowsFilter()

该函数计划在 6.13 版本中被废弃。

请改用beginFilterChange() 和endFilterChange(Direction::Columns)。

使当前对行进行的过滤失效。

如果您正在实现自定义过滤（通过filterAcceptsRow()），且过滤参数已发生变化，则应调用此函数。它与invalidateFilter() 的区别在于，它不会调用filterAcceptsColumn()，而只会调用filterAcceptsRow()。如果您想隐藏或显示列内容未发生变化的行，可以使用此函数代替invalidateFilter()。

在过滤器参数发生变化之前，请调用beginFilterChange()。

该函数在 Qt 6.0 中引入。

另请参阅 invalidate()、invalidateFilter() 和invalidateColumnsFilter()。

[virtual protected] bool QSortFilterProxyModel::lessThan(const QModelIndex &source_left, const QModelIndex &source_right) const

如果给定索引source_left 所指向的项的值小于给定索引source_right 所指向的项的值，则返回true ；否则返回false 。

该函数在排序时用作operator< ，并使用QAbstractItemModel::compareData()。

默认情况下，QString的比较区分大小写；这可以通过sortCaseSensitivity 属性进行更改。

默认情况下，将使用与QModelIndexes关联的Qt::DisplayRole 进行比较。可以通过设置sortRole 属性来更改这一点。

另请参阅 sortRole 、sortCaseSensitivity 和dynamicSortFilter 。

[override virtual] QModelIndex QSortFilterProxyModel::mapFromSource(const QModelIndex &sourceIndex) const

重写：QAbstractProxyModel::mapFromSource(const QModelIndex &sourceIndex) const。

根据源模型中的sourceIndex ，返回QSortFilterProxyModel 中的模型索引。

另请参阅 mapToSource()。

[override virtual] QItemSelection QSortFilterProxyModel::mapSelectionFromSource(const QItemSelection &sourceSelection) const

重写了：QAbstractProxyModel::mapSelectionFromSource(const QItemSelection &sourceSelection) const。

[override virtual] QItemSelection QSortFilterProxyModel::mapSelectionToSource(const QItemSelection &proxySelection) const

重写了：QAbstractProxyModel::mapSelectionToSource(const QItemSelection &proxySelection) const。

[override virtual] QModelIndex QSortFilterProxyModel::mapToSource(const QModelIndex &proxyIndex) const

重写：QAbstractProxyModel::mapToSource(const QModelIndex &proxyIndex) const。

从排序过滤器模型中返回与给定的proxyIndex 对应的源模型索引。

另请参阅 mapFromSource()。

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

重写了以下函数：QAbstractItemModel::match(const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const。

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

重写了：QAbstractProxyModel::mimeData(const QModelIndexList &indexes) const。

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

重新实现了：QAbstractProxyModel::mimeTypes() const。

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

重写了：QAbstractItemModel::parent(const QModelIndex &index) const。

[signal] void QSortFilterProxyModel::recursiveFilteringEnabledChanged(bool recursiveFilteringEnabled)

当递归过滤器设置更改为recursiveFilteringEnabled 时，会发出此信号。

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

重写了：QAbstractItemModel::removeColumns （int column, int count, const QModelIndex &parent）。

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

重写了：QAbstractItemModel::removeRows （int row, int count, const QModelIndex &parent）。

[override virtual] int QSortFilterProxyModel::rowCount(const QModelIndex &parent = QModelIndex()) const

重写了：QAbstractItemModel::rowCount(const QModelIndex &parent) const。

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

重写了：QAbstractProxyModel::setData （const QModelIndex &index, const QVariant &value, int role）。

另请参阅 data()。

[slot] void QSortFilterProxyModel::setFilterFixedString(const QString &pattern)

将用于过滤源模型内容的固定字符串设置为给定的pattern 。

此方法将重置正则表达式选项，但会保留大小写敏感性。

另请参阅 setFilterCaseSensitivity()、setFilterRegularExpression()、setFilterWildcard() 以及filterRegularExpression()。

[slot] void QSortFilterProxyModel::setFilterRegularExpression(const QString &pattern)

将用于过滤源模型内容的正则表达式设置为pattern 。

在新代码中应优先使用此方法，因为它会在内部使用QRegularExpression 。

此方法将重置正则表达式选项，但会保留大小写敏感性。

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        sortFilterProxyModel, qOverload(&QSortFilterProxyModel::setFilterRegularExpression));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        sortFilterProxyModel, [receiver = sortFilterProxyModel](const QString &pattern) { receiver->setFilterRegularExpression(pattern); });

另请参阅 setFilterCaseSensitivity()、setFilterWildcard()、setFilterFixedString() 以及filterRegularExpression()。

[slot] void QSortFilterProxyModel::setFilterWildcard(const QString &pattern)

将用于过滤源模型内容的通配符表达式设置为给定的pattern 。

此方法将重置正则表达式选项，但会保留大小写敏感性。

另请参阅 setFilterCaseSensitivity()、setFilterRegularExpression()、setFilterFixedString() 和filterRegularExpression()。

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

重写了：QAbstractProxyModel::setHeaderData(int section, Qt::Orientation orientation, const QVariant &value, int role)。

另请参阅 headerData()。

[override virtual] void QSortFilterProxyModel::setSourceModel(QAbstractItemModel *sourceModel)

重写了：QAbstractProxyModel::setSourceModel(QAbstractItemModel *sourceModel)。

[override virtual] QModelIndex QSortFilterProxyModel::sibling(int row, int column, const QModelIndex &idx) const

重写：QAbstractProxyModel::sibling （int row, int column, const QModelIndex &idx）const。

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

重写了：QAbstractProxyModel::sort(int column, Qt::SortOrder order)。

根据给定的order ，按column 对模型进行排序。如果排序column 小于零，则模型将根据给定的order 按源模型行进行排序。

另请参阅 sortColumn()。

[signal] void QSortFilterProxyModel::sortCaseSensitivityChanged(Qt::CaseSensitivity sortCaseSensitivity)

当排序的大写小写敏感性更改为sortCaseSensitivity 时，会发出此信号。

int QSortFilterProxyModel::sortColumn() const

返回当前用于排序的列

此方法返回最近使用的排序列。默认值为 -1，表示该代理模型不进行排序。

另请参阅 sort()。

[signal] void QSortFilterProxyModel::sortLocaleAwareChanged(bool sortLocaleAware)

当“支持区域设置”的配置更改为sortLocaleAware 时，会发出此信号。

Qt::SortOrder QSortFilterProxyModel::sortOrder() const

返回当前用于排序的排序顺序

该函数返回最近使用的排序顺序。默认值为Qt::AscendingOrder 。

另请参阅 sort()。

[signal] void QSortFilterProxyModel::sortRoleChanged(int sortRole)

当排序角色变为sortRole 时，会发出此信号。

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

重写了：QAbstractProxyModel::span(const QModelIndex &index) const。

[override virtual] Qt::DropActions QSortFilterProxyModel::supportedDropActions() const

重新实现了：QAbstractProxyModel::supportedDropActions() const。