#include <Wt/WSortFilterProxyModel>
Public Member Functions | |
WSortFilterProxyModel (WObject *parent=0) | |
Constructor. | |
virtual | ~WSortFilterProxyModel () |
Destructor. | |
virtual WModelIndex | mapFromSource (const WModelIndex &sourceIndex) const |
Map a source model index to the proxy model. | |
virtual WModelIndex | mapToSource (const WModelIndex &proxyIndex) const |
Map a proxy model index to the source model. | |
virtual void | setSourceModel (WAbstractItemModel *sourceModel) |
Set a source model. | |
void | setFilterKeyColumn (int column) |
Specify the column on which the filtering is applied. | |
int | filterKeyColumn () const |
Return the column on which the filtering is applied. | |
void | setFilterRegExp (const WString &pattern) |
Specify a regular expression for filtering. | |
WString | filterRegExp () const |
Return the regular expression used for filtering. | |
void | setFilterRole (int role) |
Specify the data role used for filtering. | |
int | filterRole () const |
Return the data role used for filtering. | |
void | setSortRole (int role) |
Specify the data role used used for sorting. | |
int | sortRole () const |
Return the data role used for sorting. | |
void | setDynamicSortFilter (bool enable) |
Configure the proxy to dynamically track changes in the source model. | |
bool | dynamicSortFilter () const |
Returns whether this proxy dynmically filters and sorts. | |
virtual int | columnCount (const WModelIndex &parent=WModelIndex()) const |
Returns the number of columns. | |
virtual int | rowCount (const WModelIndex &parent=WModelIndex()) const |
Returns the number of rows. | |
virtual WModelIndex | parent (const WModelIndex &index) const |
Returns the parent for a model index. | |
virtual WModelIndex | index (int row, int column, const WModelIndex &parent=WModelIndex()) const |
Returns the child index for the given row and column. | |
virtual void | sort (int column, SortOrder order=AscendingOrder) |
Sort the model according to a particular column. | |
Protected Member Functions | |
virtual bool | filterAcceptRow (int sourceRow, const WModelIndex &sourceParent) const |
Returns whether a source row is accepted by the filter. | |
virtual bool | lessThan (const WModelIndex &lhs, const WModelIndex &rhs) const |
Compares two indexes. |
Wt/WSortFilterProxyModel 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 re-filter and re-sort when the original model changes. You can enable this behaviour using setDynamicSortFilter().
Usage example:
// model is the source model Wt::WAbstractItemModel *model = ... // we setup a proxy to filter the source model Wt::WSortFilterProxyModel *proxy = new Wt::WSortFilterProxyModel(this); proxy->setSourceModel(model); proxy->setDynamicSortFilter(true); proxy->setFilterKeyColumn(0); proxy->setFilterRole(Wt::UserRole); proxy->setFilterRegExp("Wt::.*"); // configure a view to use the proxy model instead of the source model Wt::WTreeView *view = new Wt::WTreeView(this); view->setModel(proxy); ...
WModelIndex Wt::WSortFilterProxyModel::mapFromSource | ( | const WModelIndex & | sourceIndex | ) | const [virtual] |
Map 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.
WModelIndex Wt::WSortFilterProxyModel::mapToSource | ( | const WModelIndex & | proxyIndex | ) | const [virtual] |
Map 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.
void Wt::WSortFilterProxyModel::setSourceModel | ( | WAbstractItemModel * | sourceModel | ) | [virtual] |
Set a source model.
The source model provides the actual data for the proxy model.
Ownership of the source model is not transferred.
Reimplemented from Wt::WAbstractProxyModel.
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.
int Wt::WSortFilterProxyModel::filterKeyColumn | ( | ) | const [inline] |
void Wt::WSortFilterProxyModel::setFilterRegExp | ( | const WString & | 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.
WString Wt::WSortFilterProxyModel::filterRegExp | ( | ) | const |
void Wt::WSortFilterProxyModel::setFilterRole | ( | int | role | ) |
Specify the data role used for filtering.
This configures the data role used for filtering on filterKeyColumn().
The default value is DisplayRole.
int Wt::WSortFilterProxyModel::filterRole | ( | ) | const [inline] |
void Wt::WSortFilterProxyModel::setSortRole | ( | int | role | ) |
Specify the data role used used for sorting.
This configures the data role used for sorting.
The default value is DisplayRole.
int Wt::WSortFilterProxyModel::sortRole | ( | ) | const [inline] |
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.
bool Wt::WSortFilterProxyModel::dynamicSortFilter | ( | ) | const [inline] |
int Wt::WSortFilterProxyModel::columnCount | ( | const WModelIndex & | parent = WModelIndex() |
) | const [virtual] |
Returns the number of columns.
This returns the number of columns at index parent.
Implements Wt::WAbstractItemModel.
int Wt::WSortFilterProxyModel::rowCount | ( | const WModelIndex & | parent = WModelIndex() |
) | const [virtual] |
Returns the number of rows.
This returns the number of rows at index parent.
Implements Wt::WAbstractItemModel.
WModelIndex Wt::WSortFilterProxyModel::parent | ( | const WModelIndex & | index | ) | const [virtual] |
Returns the parent for a model index.
You should use createIndex() to create a model index that corresponds to the parent of a given index.
Implements Wt::WAbstractItemModel.
WModelIndex Wt::WSortFilterProxyModel::index | ( | int | row, | |
int | column, | |||
const WModelIndex & | parent = WModelIndex() | |||
) | const [virtual] |
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.
void Wt::WSortFilterProxyModel::sort | ( | int | column, | |
SortOrder | order = AscendingOrder | |||
) | [virtual] |
Sort 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.
bool Wt::WSortFilterProxyModel::filterAcceptRow | ( | int | sourceRow, | |
const WModelIndex & | sourceParent | |||
) | const [protected, virtual] |
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.
bool Wt::WSortFilterProxyModel::lessThan | ( | const WModelIndex & | lhs, | |
const WModelIndex & | rhs | |||
) | const [protected, virtual] |
Compares two indexes.
The default implementation uses sortRole() and an order operator that tries to use the operator< when the data is of the same type, or lexicographical ordering otherwise.
You may want to reimplement this method to provide specialized sorting.