Wt
4.10.0
|
A proxy model for Wt's item models that provides filtering and/or sorting. More...
#include <Wt/WSortFilterProxyModel.h>
Public Member Functions | |
WSortFilterProxyModel () | |
Constructor. | |
virtual | ~WSortFilterProxyModel () |
Destructor. | |
virtual WModelIndex | mapFromSource (const WModelIndex &sourceIndex) const override |
Maps a source model index to the proxy model. More... | |
virtual WModelIndex | mapToSource (const WModelIndex &proxyIndex) const override |
Maps a proxy model index to the source model. More... | |
virtual void | setSourceModel (const std::shared_ptr< WAbstractItemModel > &sourceModel) override |
Sets the source model. More... | |
void | setFilterKeyColumn (int column) |
Specify the column on which the filtering is applied. More... | |
int | filterKeyColumn () const |
Return the column on which the filtering is applied. More... | |
void | setFilterRegExp (std::unique_ptr< std::regex > pattern) |
Specify a regular expression for filtering. More... | |
std::regex * | filterRegExp () const |
Return the regular expression used for filtering. More... | |
void | setFilterRole (ItemDataRole role) |
Specify the data role used for filtering. More... | |
ItemDataRole | filterRole () const |
Return the data role used for filtering. More... | |
void | setSortRole (ItemDataRole role) |
Specify the data role used used for sorting. More... | |
ItemDataRole | sortRole () const |
Return the data role used for sorting. More... | |
int | sortColumn () const |
Returns the current sort column. More... | |
SortOrder | sortOrder () const |
Returns the current sort order. More... | |
void | setDynamicSortFilter (bool enable) |
Configure the proxy to dynamically track changes in the source model. More... | |
bool | dynamicSortFilter () const |
Returns whether this proxy dynmically filters and sorts. More... | |
void | invalidate () |
Invalidates the current filter. More... | |
virtual int | columnCount (const WModelIndex &parent=WModelIndex()) const override |
Returns the number of columns. More... | |
virtual int | rowCount (const WModelIndex &parent=WModelIndex()) const override |
Returns the number of rows. More... | |
virtual WModelIndex | parent (const WModelIndex &index) const override |
Returns the parent for a model index. More... | |
virtual WModelIndex | index (int row, int column, const WModelIndex &parent=WModelIndex()) const override |
Returns the child index for the given row and column. More... | |
virtual bool | setHeaderData (int section, Orientation orientation, const cpp17::any &value, ItemDataRole role=ItemDataRole::Edit) override |
Sets header data for a column or row. More... | |
virtual cpp17::any | headerData (int section, Orientation orientation=Orientation::Horizontal, ItemDataRole role=ItemDataRole::Display) const override |
Returns the row or column header data. More... | |
virtual WFlags< HeaderFlag > | headerFlags (int section, Orientation orientation=Orientation::Horizontal) const override |
Returns the flags for a header. More... | |
virtual bool | insertRows (int row, int count, const WModelIndex &parent=WModelIndex()) override |
Inserts a number rows. More... | |
virtual bool | removeRows (int row, int count, const WModelIndex &parent=WModelIndex()) override |
Removes a number rows. More... | |
virtual void | sort (int column, SortOrder order=SortOrder::Ascending) override |
Sorts the model according to a particular column. More... | |
![]() | |
WAbstractProxyModel () | |
Constructor. | |
std::shared_ptr< WAbstractItemModel > | sourceModel () const |
Returns the source model. More... | |
virtual cpp17::any | data (const WModelIndex &index, ItemDataRole role=ItemDataRole::Display) const override |
Returns the data at a specific model index. More... | |
virtual bool | setData (const WModelIndex &index, const cpp17::any &value, ItemDataRole role=ItemDataRole::Edit) override |
Sets the data at the given model index. More... | |
virtual bool | setItemData (const WModelIndex &index, const DataMap &values) override |
Sets the data at the given model index. More... | |
virtual WFlags< ItemFlag > | flags (const WModelIndex &index) const override |
Returns the flags for an item. More... | |
virtual bool | insertColumns (int column, int count, const WModelIndex &parent=WModelIndex()) override |
Inserts one or more columns. More... | |
virtual bool | removeColumns (int column, int count, const WModelIndex &parent=WModelIndex()) override |
Removes columns. More... | |
virtual std::string | mimeType () const override |
Returns a mime-type for dragging a set of indexes. More... | |
virtual std::vector< std::string > | acceptDropMimeTypes () const override |
Returns a list of mime-types that could be accepted for a drop event. More... | |
virtual void | dropEvent (const WDropEvent &e, DropAction action, int row, int column, const WModelIndex &parent) override |
Handles a drop event. More... | |
virtual void * | toRawIndex (const WModelIndex &index) const override |
Converts a model index to a raw pointer that remains valid while the model's layout is changed. More... | |
virtual WModelIndex | fromRawIndex (void *rawIndex) const override |
Converts a raw pointer to a model index. More... | |
virtual bool | setData (const WModelIndex &index, const cpp17::any &value, ItemDataRole role=ItemDataRole::Edit) |
Sets data at the given model index. More... | |
bool | setData (int row, int column, const cpp17::any &value, ItemDataRole role=ItemDataRole::Edit, const WModelIndex &parent=WModelIndex()) |
Sets data at the given row and column. More... | |
virtual cpp17::any | data (const WModelIndex &index, ItemDataRole role=ItemDataRole::Display) const=0 |
Returns data at a specified model index for the given role. More... | |
cpp17::any | data (int row, int column, ItemDataRole role=ItemDataRole::Display, const WModelIndex &parent=WModelIndex()) const |
Returns the data item at the given column and row. More... | |
virtual bool | setHeaderData (int section, Orientation orientation, const cpp17::any &value, ItemDataRole role=ItemDataRole::Edit) |
Sets header data for a column or row. More... | |
bool | setHeaderData (int section, const cpp17::any &value) |
Sets column header data. More... | |
![]() | |
WAbstractItemModel () | |
Creates a new data model. | |
virtual bool | hasChildren (const WModelIndex &index) const |
Returns if there are children at an index. More... | |
virtual DataMap | itemData (const WModelIndex &index) const |
Returns all data at a specific index. More... | |
virtual WModelIndexList | match (const WModelIndex &start, ItemDataRole role, const cpp17::any &value, int hits=-1, WFlags< MatchFlag > flags=WFlags< MatchFlag >(MatchFlag::StartsWith|MatchFlag::Wrap)) const |
Returns an index list for data items that match. More... | |
cpp17::any | data (int row, int column, ItemDataRole role=ItemDataRole::Display, const WModelIndex &parent=WModelIndex()) const |
Returns the data item at the given column and row. More... | |
virtual bool | hasIndex (int row, int column, const WModelIndex &parent=WModelIndex()) const |
Returns if an index at the given position is valid (i.e. falls within the column-row bounds). More... | |
bool | setHeaderData (int section, const cpp17::any &value) |
Sets column header data. More... | |
virtual void | expandColumn (int column) |
Expands a column. More... | |
virtual void | collapseColumn (int column) |
Collapses a column. More... | |
virtual void | dropEvent (const WDropEvent &e, DropAction action, const WModelIndex &index, Wt::Side side) |
Handles a drop event. More... | |
bool | insertColumn (int column, const WModelIndex &parent=WModelIndex()) |
Inserts one column. More... | |
bool | insertRow (int row, const WModelIndex &parent=WModelIndex()) |
Inserts one row. More... | |
bool | removeColumn (int column, const WModelIndex &parent=WModelIndex()) |
Removes one column. More... | |
bool | removeRow (int row, const WModelIndex &parent=WModelIndex()) |
Removes one row. More... | |
bool | setData (int row, int column, const cpp17::any &value, ItemDataRole role=ItemDataRole::Edit, const WModelIndex &parent=WModelIndex()) |
Sets data at the given row and column. More... | |
virtual Signal< WModelIndex, int, int > & | columnsAboutToBeInserted () |
Signal emitted before a number of columns will be inserted. More... | |
virtual Signal< WModelIndex, int, int > & | columnsAboutToBeRemoved () |
Signal emitted before a number of columns will be removed. More... | |
virtual Signal< WModelIndex, int, int > & | columnsInserted () |
Signal emitted after a number of columns were inserted. More... | |
virtual Signal< WModelIndex, int, int > & | columnsRemoved () |
Signal emitted after a number of columns were removed. More... | |
virtual Signal< WModelIndex, int, int > & | rowsAboutToBeInserted () |
Signal emitted before a number of rows will be inserted. More... | |
virtual Signal< WModelIndex, int, int > & | rowsAboutToBeRemoved () |
Signal emitted before a number of rows will be removed. More... | |
virtual Signal< WModelIndex, int, int > & | rowsInserted () |
Signal emitted after a number of rows were inserted. More... | |
virtual Signal< WModelIndex, int, int > & | rowsRemoved () |
Signal emitted after a number of rows were removed. More... | |
virtual Signal< WModelIndex, WModelIndex > & | dataChanged () |
Signal emitted when some data was changed. More... | |
virtual Signal< Orientation, int, int > & | headerDataChanged () |
Signal emitted when some header data was changed. More... | |
virtual Signal & | layoutAboutToBeChanged () |
Signal emitted when the layout is about to be changed. More... | |
virtual Signal & | layoutChanged () |
Signal emitted when the layout is changed. More... | |
virtual Signal & | modelReset () |
Signal emitted when the model was reset. More... | |
![]() | |
void | addChild (std::unique_ptr< WObject > child) |
Add a child WObject whose lifetime is determined by this WObject. | |
template<typename Child > | |
Child * | addChild (std::unique_ptr< Child > child) |
Add a child WObject, returning a raw pointer. More... | |
std::unique_ptr< WObject > | removeChild (WObject *child) |
Remove a child WObject, so its lifetime is no longer determined by this WObject. | |
template<typename Child > | |
std::unique_ptr< Child > | removeChild (Child *child) |
Remove a child WObject, so its lifetime is no longer determined by this WObject. More... | |
virtual const std::string | id () const |
Returns the (unique) identifier for this object. More... | |
virtual void | setObjectName (const std::string &name) |
Sets an object name. More... | |
virtual std::string | objectName () const |
Returns the object name. More... | |
void | resetLearnedSlots () |
Resets learned stateless slot implementations. More... | |
template<class T > | |
void | resetLearnedSlot (void(T::*method)()) |
Resets a learned stateless slot implementation. More... | |
template<class T > | |
WStatelessSlot * | implementStateless (void(T::*method)()) |
Declares a slot to be stateless and learn client-side behaviour on first invocation. More... | |
template<class T > | |
WStatelessSlot * | implementStateless (void(T::*method)(), void(T::*undoMethod)()) |
Declares a slot to be stateless and learn client-side behaviour in advance. More... | |
void | isNotStateless () |
Marks the current function as not stateless. More... | |
template<class T > | |
WStatelessSlot * | implementJavaScript (void(T::*method)(), const std::string &jsCode) |
Provides a JavaScript implementation for a method. More... | |
![]() | |
observable () noexcept | |
Default constructor. | |
virtual | ~observable () |
Destructor. More... | |
template<typename... Args, typename C > | |
auto | bindSafe (void(C::*method)(Args...)) noexcept |
Protects a method call against object destruction. More... | |
template<typename... Args, typename C > | |
auto | bindSafe (void(C::*method)(Args...) const) const noexcept |
Protects a const method call against object destruction. More... | |
template<typename Function > | |
auto | bindSafe (const Function &function) noexcept |
Protects a function against object destruction. More... | |
Protected Member Functions | |
virtual bool | filterAcceptRow (int sourceRow, const WModelIndex &sourceParent) const |
Returns whether a source row is accepted by the filter. More... | |
virtual bool | lessThan (const WModelIndex &lhs, const WModelIndex &rhs) const |
Compares two indexes. More... | |
![]() | |
WModelIndex | createSourceIndex (int row, int column, void *ptr) const |
Create a source model index. More... | |
void | startShiftModelIndexes (const WModelIndex &sourceParent, int start, int count, ItemMap &items) |
Utility methods to shift items in an item map. More... | |
![]() | |
void | reset () |
Resets the model and invalidate any data. More... | |
WModelIndex | createIndex (int row, int column, void *ptr) const |
Creates a model index for the given row and column. More... | |
WModelIndex | createIndex (int row, int column, ::uint64_t id) const |
Creates a model index for the given row and column. More... | |
void | beginInsertColumns (const WModelIndex &parent, int first, int last) |
Method to be called before inserting columns. More... | |
void | beginInsertRows (const WModelIndex &parent, int first, int last) |
Method to be called before inserting rows. More... | |
void | beginRemoveColumns (const WModelIndex &parent, int first, int last) |
Method to be called before removing columns. More... | |
void | beginRemoveRows (const WModelIndex &parent, int first, int last) |
Method to be called before removing rows. More... | |
void | endInsertColumns () |
Method to be called after inserting columns. More... | |
void | endInsertRows () |
Method to be called after inserting rows. More... | |
void | endRemoveColumns () |
Method to be called after removing columns. More... | |
void | endRemoveRows () |
Method to be called after removing rows. More... | |
virtual void | copyData (const WModelIndex &sIndex, const WModelIndex &dIndex) |
Copy data to an index in this model. More... | |
![]() | |
virtual WStatelessSlot * | getStateless (Method method) |
On-demand stateless slot implementation. More... | |
Additional Inherited Members | |
![]() | |
typedef std::map< ItemDataRole, cpp17::any > | DataMap |
Data map. More... | |
![]() | |
typedef void(WObject::* | Method) () |
Typedef for a WObject method without arguments. | |
![]() | |
typedef std::map< WModelIndex, BaseItem * > | ItemMap |
A map for items. More... | |
A proxy model for Wt's item models that provides filtering and/or sorting.
This proxy model does not store data itself, but presents data from a source model, after filtering rows. It also allows sorting of the source model data, without actually altering the source model. This may be convenient when the source model does not support sorting (i.e. does not reimplement WAbstractProxyModel::sort()), or you do not want to reorder the underlying model since that affects all views on the model.
To use the proxy model to filter data, you use the methods setFilterKeyColumn(), setFilterRegExp() and setFilterRole() to specify a filtering operation based on the values of a single column. If this filtering mechanism is too limiting, you can provide specialized filtering by reimplementing the filterAcceptRow() method.
Sorting is provided by reimplementing the standard WAbstractItemModel::sort() method. In this way, a view class such as WTreeView may resort the model as indicated by the user. Use setSortRole() to indicate on what data role sorting should be done, or reimplement the lessThan() method to provide a specialized sorting method.
By default, the proxy does not automatically refilter and resort when the original model changes. Data changes or row additions to the source model are not automatically reflected in the proxy model, but to maintain integrity, row removals in the source model are always reflected in the proxy model. You can enable the model to always refilter and resort when the underlying model changes using setDynamicSortFilter().
Usage example:
|
overridevirtual |
Returns the number of columns.
This returns the number of columns at index parent
.
Implements Wt::WAbstractItemModel.
bool Wt::WSortFilterProxyModel::dynamicSortFilter | ( | ) | const |
Returns whether this proxy dynmically filters and sorts.
|
protectedvirtual |
Returns whether a source row is accepted by the filter.
The default implementation uses filterKeyColumn(), filterRole() and filterRegExp().
You may want to reimplement this method to provide specialized filtering.
int Wt::WSortFilterProxyModel::filterKeyColumn | ( | ) | const |
Return the column on which the filtering is applied.
std::regex * Wt::WSortFilterProxyModel::filterRegExp | ( | ) | const |
Return the regular expression used for filtering.
ItemDataRole Wt::WSortFilterProxyModel::filterRole | ( | ) | const |
Return the data role used for filtering.
|
overridevirtual |
Returns the row or column header data.
The default proxy implementation constructs a dummy WModelIndex with the row set to 0 and column set to section
if the orientation is Wt::Orientation::Horizontal, or with the row set to section
and the column set to 0 if the orientation is Wt::Orientation::Vertical.
The resulting section that is forwarded to sourceModel()->headerData() depends on how the WModelIndex is transformed with mapToSource().
Reimplemented from Wt::WAbstractProxyModel.
|
overridevirtual |
Returns the flags for a header.
The default proxy implementation constructs a dummy WModelIndex with the row set to 0 and column set to section
if the orientation is Wt::Orientation::Horizontal, or with the row set to section
and the column set to 0 if the orientation is Wt::Orientation::Vertical.
The resulting section that is forwarded to sourceModel()->headerFlags() depends on how the WModelIndex is transformed with mapToSource().
Reimplemented from Wt::WAbstractProxyModel.
|
overridevirtual |
Returns the child index for the given row and column.
When implementing this method, you can use createIndex() to create an index that corresponds to the item at row
and column
within parent
.
If the location is invalid (out of bounds at the parent), then an invalid index must be returned.
Implements Wt::WAbstractItemModel.
|
overridevirtual |
Inserts a number rows.
The rows are inserted in the source model, and if successful, also in the proxy model regardless of whether they are matched by the current filter. They are inserted at the indicated row, regardless of whether this is the correct place according to the defined sorting.
As soon as you set data for the column on which the filtering is active, or which affects the sorting, the row may be filtered out or change position when dynamic sorting/filtering is enabled. Therefore, it is usually a good idea to temporarily disable the dynamic sort/filtering behaviour while inserting new row(s) of data.
Reimplemented from Wt::WAbstractItemModel.
void Wt::WSortFilterProxyModel::invalidate | ( | ) |
Invalidates the current filter.
This refilters and resorts the model, and is useful only if you have reimplemented filterAcceptRow() and/or lessThan()
|
protectedvirtual |
Compares two indexes.
The default implementation uses sortRole() and an ordering using the operator< when the data is of the same type or compares lexicographically otherwise.
You may want to reimplement this method to provide specialized sorting.
|
overridevirtual |
Maps a source model index to the proxy model.
This method returns a model index in the proxy model that corresponds to the model index sourceIndex
in the source model. This method must only be implemented for source model indexes that are mapped and thus are the result of mapToSource().
Implements Wt::WAbstractProxyModel.
|
overridevirtual |
Maps a proxy model index to the source model.
This method returns a model index in the source model that corresponds to the proxy model index proxyIndex
.
Implements Wt::WAbstractProxyModel.
|
overridevirtual |
Returns the parent for a model index.
An implementation should use createIndex() to create a model index that corresponds to the parent of a given index.
Note that the index itself may be stale (referencing a row/column within the parent that is outside the model geometry), but its parent (identified by the WModelIndex::internalPointer()) is referencing an existing parent. A stale index can only be used while the model geometry is being updated, i.e. during the emission of the corresponding [rows/columns](Being)[Removed/Inserted]() signals.
Implements Wt::WAbstractItemModel.
|
overridevirtual |
Removes a number rows.
The rows are removed from the source model.
Reimplemented from Wt::WAbstractItemModel.
|
overridevirtual |
Returns the number of rows.
This returns the number of rows at index parent
.
Implements Wt::WAbstractItemModel.
void Wt::WSortFilterProxyModel::setDynamicSortFilter | ( | bool | enable | ) |
Configure the proxy to dynamically track changes in the source model.
When enable
is true
, the proxy will re-filter and re-sort the model when changes happen to the source model.
void Wt::WSortFilterProxyModel::setFilterKeyColumn | ( | int | column | ) |
Specify the column on which the filtering is applied.
This configures the column on which the filterRegExp() is applied.
The default value is 0.
void Wt::WSortFilterProxyModel::setFilterRegExp | ( | std::unique_ptr< std::regex > | pattern | ) |
Specify a regular expression for filtering.
This configures the regular expression used for filtering on filterKeyColumn().
The default value is an empty expression, which disables filtering.
void Wt::WSortFilterProxyModel::setFilterRole | ( | ItemDataRole | role | ) |
Specify the data role used for filtering.
This configures the data role used for filtering on filterKeyColumn().
The default value is ItemDataRole::Display.
|
overridevirtual |
Sets header data for a column or row.
Returns true
if the operation was successful.
Reimplemented from Wt::WAbstractItemModel.
void Wt::WSortFilterProxyModel::setSortRole | ( | ItemDataRole | role | ) |
Specify the data role used used for sorting.
This configures the data role used for sorting.
The default value is ItemDataRole::Display.
|
overridevirtual |
Sets the source model.
The source model provides the actual data for the proxy model.
Ownership of the source model is not transferred.
All signals of the source model are forwarded to the proxy model.
Reimplemented from Wt::WAbstractProxyModel.
|
overridevirtual |
Sorts the model according to a particular column.
If the model supports sorting, then it should emit the layoutAboutToBeChanged() signal, rearrange its items, and afterwards emit the layoutChanged() signal.
Reimplemented from Wt::WAbstractItemModel.
int Wt::WSortFilterProxyModel::sortColumn | ( | ) | const |
SortOrder Wt::WSortFilterProxyModel::sortOrder | ( | ) | const |
Returns the current sort order.
ItemDataRole Wt::WSortFilterProxyModel::sortRole | ( | ) | const |
Return the data role used for sorting.