<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Wt: Wt::WSortFilterProxyModel Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1WSortFilterProxyModel.html">WSortFilterProxyModel</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::WSortFilterProxyModel Class Reference<div class="ingroups"><a class="el" href="group__modelview.html">Model/view system</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WSortFilterProxyModel" --><!-- doxytag: inherits="Wt::WAbstractProxyModel" -->
<p>A proxy model for Wt's item models that provides filtering and/or sorting.
<a href="classWt_1_1WSortFilterProxyModel.html#details">More...</a></p>
<p><code>#include <Wt/WSortFilterProxyModel></code></p>
<div class="dynheader">
Inheritance diagram for Wt::WSortFilterProxyModel:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1WSortFilterProxyModel__inherit__graph.png" border="0" usemap="#Wt_1_1WSortFilterProxyModel_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1WSortFilterProxyModel_inherit__map" id="Wt_1_1WSortFilterProxyModel_inherit__map">
<area shape="rect" href="classWt_1_1WAbstractProxyModel.html" title="An abstract proxy model for Wt's item models." alt="" coords="8,155,184,181"/><area shape="rect" href="classWt_1_1WAbstractItemModel.html" title="An abstract model for use with Wt's view classes." alt="" coords="12,80,180,107"/><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="48,5,144,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1WSortFilterProxyModel-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec8bd731a505369b12695beeecc1fd19"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::WSortFilterProxyModel" ref="aec8bd731a505369b12695beeecc1fd19" args="(WObject *parent=0)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#aec8bd731a505369b12695beeecc1fd19">WSortFilterProxyModel</a> (<a class="el" href="classWt_1_1WObject.html">WObject</a> *parent=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf3b4890f299bb548b0351f6e68610b4"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::~WSortFilterProxyModel" ref="acf3b4890f299bb548b0351f6e68610b4" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#acf3b4890f299bb548b0351f6e68610b4">~WSortFilterProxyModel</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#ab32e734793e3a6e657b3b5655831885e">mapFromSource</a> (const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> &sourceIndex) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maps a source model index to the proxy model. <a href="#ab32e734793e3a6e657b3b5655831885e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a290351f93612a5180c055328e2ff3663">mapToSource</a> (const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> &proxyIndex) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maps a proxy model index to the source model. <a href="#a290351f93612a5180c055328e2ff3663"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a805bcc6964e8c0194638c05f30d2a8cb">setSourceModel</a> (<a class="el" href="classWt_1_1WAbstractItemModel.html">WAbstractItemModel</a> *sourceModel)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the source model. <a href="#a805bcc6964e8c0194638c05f30d2a8cb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#aaf272fe23196b67a409e7d0de03fd8d5">setFilterKeyColumn</a> (int column)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specify the column on which the filtering is applied. <a href="#aaf272fe23196b67a409e7d0de03fd8d5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a9c1714947d1910e049ec26067e0cf4d0">filterKeyColumn</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the column on which the filtering is applied. <a href="#a9c1714947d1910e049ec26067e0cf4d0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a1c9dce68769668570bb5bccc3e0a9969">setFilterRegExp</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &pattern)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specify a regular expression for filtering. <a href="#a1c9dce68769668570bb5bccc3e0a9969"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a2e5b064ec7ebf4e738b7e423a7449ed3">filterRegExp</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the regular expression used for filtering. <a href="#a2e5b064ec7ebf4e738b7e423a7449ed3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e907bc557a0d657cbd38493babbfc05"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::setFilterFlags" ref="a0e907bc557a0d657cbd38493babbfc05" args="(WFlags< RegExpFlag > flags)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a0e907bc557a0d657cbd38493babbfc05">setFilterFlags</a> (WFlags< <a class="el" href="namespaceWt.html#a6bde75e90de6c0a1611951ae632e2ca2">RegExpFlag</a> > flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the filter regular expression flags. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aadefa2d17ddeb4c19a7327c2e115962a"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::filterFlags" ref="aadefa2d17ddeb4c19a7327c2e115962a" args="() const " -->
WFlags< <a class="el" href="namespaceWt.html#a6bde75e90de6c0a1611951ae632e2ca2">RegExpFlag</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#aadefa2d17ddeb4c19a7327c2e115962a">filterFlags</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the filter regular expression flags. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a0ca42014aa2f383154409032c9a3c8d3">setFilterRole</a> (int role)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specify the data role used for filtering. <a href="#a0ca42014aa2f383154409032c9a3c8d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#acbbbb4a3a95a61ea1289036d4069f0bc">filterRole</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the data role used for filtering. <a href="#acbbbb4a3a95a61ea1289036d4069f0bc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a63686e0718a623c6507f61195e020917">setSortRole</a> (int role)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specify the data role used used for sorting. <a href="#a63686e0718a623c6507f61195e020917"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a35cfadde9afc4495dfab93234e5e169b">sortRole</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the data role used for sorting. <a href="#a35cfadde9afc4495dfab93234e5e169b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a21df26d902ba1f7d1fe0caa0d0c7f0ee">sortColumn</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current sort column. <a href="#a21df26d902ba1f7d1fe0caa0d0c7f0ee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__modelview.html#ga4173856040cf108a9c7360927a43ebac">SortOrder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a1289e017240cdda372f605dd5386beaf">sortOrder</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current sort order. <a href="#a1289e017240cdda372f605dd5386beaf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a4dfdc62d591249454cbb38e5099f19b4">setDynamicSortFilter</a> (bool enable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Configure the proxy to dynamically track changes in the source model. <a href="#a4dfdc62d591249454cbb38e5099f19b4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a1d977245afeec04711241c70bff84c5d">dynamicSortFilter</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether this proxy dynmically filters and sorts. <a href="#a1d977245afeec04711241c70bff84c5d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#ad295e3835ffd9f5e602b3dbb29f93f22">columnCount</a> (const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> &parent=<a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a>()) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of columns. <a href="#ad295e3835ffd9f5e602b3dbb29f93f22"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#aa4d6d01a9ec7bbdb1d77f31fbd332791">rowCount</a> (const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> &parent=<a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a>()) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of rows. <a href="#aa4d6d01a9ec7bbdb1d77f31fbd332791"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a6ad76d2a537d2f8e3f6f084a10e493a3">parent</a> (const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> &index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the parent for a model index. <a href="#a6ad76d2a537d2f8e3f6f084a10e493a3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a018f06cc89846655bd0db3c7a9eebfcb">index</a> (int row, int column, const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> &parent=<a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a>()) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the child index for the given row and column. <a href="#a018f06cc89846655bd0db3c7a9eebfcb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a54eea17b2e88ebebcdba479f2f2ffc9c">setHeaderData</a> (int section, <a class="el" href="namespaceWt.html#a2a8d45559e16a0185bf61bfad0a67912">Orientation</a> orientation, const boost::any &value, int role=EditRole)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets header data for a column or row. <a href="#a54eea17b2e88ebebcdba479f2f2ffc9c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual boost::any </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#abd144908bf36785333b43c48b437dbdd">headerData</a> (int section, <a class="el" href="namespaceWt.html#a2a8d45559e16a0185bf61bfad0a67912">Orientation</a> orientation=Horizontal, int role=DisplayRole) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the row or column header data. <a href="#abd144908bf36785333b43c48b437dbdd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual WFlags< <a class="el" href="group__modelview.html#gafb18b4339442f1327c2a65850f3d8a53">HeaderFlag</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a90bbd117c1a20c7627f36baceb551dcb">headerFlags</a> (int section, <a class="el" href="namespaceWt.html#a2a8d45559e16a0185bf61bfad0a67912">Orientation</a> orientation=Horizontal) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the flags for a header. <a href="#a90bbd117c1a20c7627f36baceb551dcb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a0a65e908c140bc48c5e0a5fb3ada12b8">insertRows</a> (int row, int count, const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> &parent=<a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inserts a number rows. <a href="#a0a65e908c140bc48c5e0a5fb3ada12b8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#ac05897acd82abbe355dc57c79a2d01be">removeRows</a> (int row, int count, const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> &parent=<a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes a number rows. <a href="#ac05897acd82abbe355dc57c79a2d01be"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a119a5cdf51974371db37ae6972e5955b">sort</a> (int column, <a class="el" href="group__modelview.html#ga4173856040cf108a9c7360927a43ebac">SortOrder</a> order=AscendingOrder)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sorts the model according to a particular column. <a href="#a119a5cdf51974371db37ae6972e5955b"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#acabfd24268c9b37e6dc296557423e5a5">filterAcceptRow</a> (int sourceRow, const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> &sourceParent) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a source row is accepted by the filter. <a href="#acabfd24268c9b37e6dc296557423e5a5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a5fc984dd492c02e47de2d87df6816d17">lessThan</a> (const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> &lhs, const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> &rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compares two indexes. <a href="#a5fc984dd492c02e47de2d87df6816d17"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A proxy model for Wt's item models that provides filtering and/or sorting. </p>
<p>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 <a class="el" href="classWt_1_1WAbstractItemModel.html#a133931424d4daa8422bcdea911cda713" title="Sorts the model according to a particular column.">WAbstractProxyModel::sort()</a>), or you do not want to reorder the underlying model since that affects all views on the model.</p>
<p>To use the proxy model to filter data, you use the methods <a class="el" href="classWt_1_1WSortFilterProxyModel.html#aaf272fe23196b67a409e7d0de03fd8d5" title="Specify the column on which the filtering is applied.">setFilterKeyColumn()</a>, <a class="el" href="classWt_1_1WSortFilterProxyModel.html#a1c9dce68769668570bb5bccc3e0a9969" title="Specify a regular expression for filtering.">setFilterRegExp()</a> and <a class="el" href="classWt_1_1WSortFilterProxyModel.html#a0ca42014aa2f383154409032c9a3c8d3" title="Specify the data role used for filtering.">setFilterRole()</a> 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 <a class="el" href="classWt_1_1WSortFilterProxyModel.html#acabfd24268c9b37e6dc296557423e5a5" title="Returns whether a source row is accepted by the filter.">filterAcceptRow()</a> method.</p>
<p>Sorting is provided by reimplementing the standard <a class="el" href="classWt_1_1WAbstractItemModel.html#a133931424d4daa8422bcdea911cda713" title="Sorts the model according to a particular column.">WAbstractItemModel::sort()</a> method. In this way, a view class such as <a class="el" href="classWt_1_1WTreeView.html" title="A view class that displays a model as a tree or tree table.">WTreeView</a> may resort the model as indicated by the user. Use <a class="el" href="classWt_1_1WSortFilterProxyModel.html#a63686e0718a623c6507f61195e020917" title="Specify the data role used used for sorting.">setSortRole()</a> to indicate on what data role sorting should be done, or reimplement the <a class="el" href="classWt_1_1WSortFilterProxyModel.html#a5fc984dd492c02e47de2d87df6816d17" title="Compares two indexes.">lessThan()</a> method to provide a specialized sorting method.</p>
<p>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 <a class="el" href="classWt_1_1WSortFilterProxyModel.html#a4dfdc62d591249454cbb38e5099f19b4" title="Configure the proxy to dynamically track changes in the source model.">setDynamicSortFilter()</a>.</p>
<p>Usage example: </p>
<div class="fragment"><pre class="fragment"> <span class="comment">// model is the source model</span>
<a class="code" href="classWt_1_1WAbstractItemModel.html" title="An abstract model for use with Wt's view classes.">Wt::WAbstractItemModel</a> *model = ...
<span class="comment">// we setup a proxy to filter the source model</span>
<a class="code" href="classWt_1_1WSortFilterProxyModel.html" title="A proxy model for Wt's item models that provides filtering and/or sorting.">Wt::WSortFilterProxyModel</a> *proxy = <span class="keyword">new</span> <a class="code" href="classWt_1_1WSortFilterProxyModel.html#aec8bd731a505369b12695beeecc1fd19" title="Constructor.">Wt::WSortFilterProxyModel</a>(<span class="keyword">this</span>);
proxy-><a class="code" href="classWt_1_1WSortFilterProxyModel.html#a805bcc6964e8c0194638c05f30d2a8cb" title="Sets the source model.">setSourceModel</a>(model);
proxy-><a class="code" href="classWt_1_1WSortFilterProxyModel.html#a4dfdc62d591249454cbb38e5099f19b4" title="Configure the proxy to dynamically track changes in the source model.">setDynamicSortFilter</a>(<span class="keyword">true</span>);
proxy-><a class="code" href="classWt_1_1WSortFilterProxyModel.html#aaf272fe23196b67a409e7d0de03fd8d5" title="Specify the column on which the filtering is applied.">setFilterKeyColumn</a>(0);
proxy-><a class="code" href="classWt_1_1WSortFilterProxyModel.html#a0ca42014aa2f383154409032c9a3c8d3" title="Specify the data role used for filtering.">setFilterRole</a>(<a class="code" href="group__modelview.html#gga0ae864e12320f9f89172735e075ed068a9b7eae9fc07ea4fd8afe7bc97954162c" title="First role reserved for user purposes.">Wt::UserRole</a>);
proxy-><a class="code" href="classWt_1_1WSortFilterProxyModel.html#a1c9dce68769668570bb5bccc3e0a9969" title="Specify a regular expression for filtering.">setFilterRegExp</a>(<span class="stringliteral">"Wt::.*"</span>);
<span class="comment">// configure a view to use the proxy model instead of the source model</span>
<a class="code" href="classWt_1_1WTreeView.html" title="A view class that displays a model as a tree or tree table.">Wt::WTreeView</a> *view = <span class="keyword">new</span> <a class="code" href="classWt_1_1WTreeView.html" title="A view class that displays a model as a tree or tree table.">Wt::WTreeView</a>(<span class="keyword">this</span>);
view-><a class="code" href="classWt_1_1WTreeView.html#a390300f766472476e6a0df5aefaa2ef0" title="Sets the model.">setModel</a>(proxy);
...
</pre></div> </div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad295e3835ffd9f5e602b3dbb29f93f22"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::columnCount" ref="ad295e3835ffd9f5e602b3dbb29f93f22" args="(const WModelIndex &parent=WModelIndex()) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::WSortFilterProxyModel::columnCount </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> & </td>
<td class="paramname"><em>parent</em> = <code><a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a>()</code></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of columns. </p>
<p>This returns the number of columns at index <code>parent</code>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#aa4d6d01a9ec7bbdb1d77f31fbd332791" title="Returns the number of rows.">rowCount()</a> </dd></dl>
<p>Implements <a class="el" href="classWt_1_1WAbstractItemModel.html#abcf7912a95a0a60f8e9b1c37d30b8383">Wt::WAbstractItemModel</a>.</p>
</div>
</div>
<a class="anchor" id="a1d977245afeec04711241c70bff84c5d"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::dynamicSortFilter" ref="a1d977245afeec04711241c70bff84c5d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WSortFilterProxyModel::dynamicSortFilter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether this proxy dynmically filters and sorts. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a4dfdc62d591249454cbb38e5099f19b4" title="Configure the proxy to dynamically track changes in the source model.">setDynamicSortFilter()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="acabfd24268c9b37e6dc296557423e5a5"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::filterAcceptRow" ref="acabfd24268c9b37e6dc296557423e5a5" args="(int sourceRow, const WModelIndex &sourceParent) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WSortFilterProxyModel::filterAcceptRow </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>sourceRow</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> & </td>
<td class="paramname"><em>sourceParent</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether a source row is accepted by the filter. </p>
<p>The default implementation uses <a class="el" href="classWt_1_1WSortFilterProxyModel.html#a9c1714947d1910e049ec26067e0cf4d0" title="Return the column on which the filtering is applied.">filterKeyColumn()</a>, <a class="el" href="classWt_1_1WSortFilterProxyModel.html#acbbbb4a3a95a61ea1289036d4069f0bc" title="Return the data role used for filtering.">filterRole()</a> and <a class="el" href="classWt_1_1WSortFilterProxyModel.html#a2e5b064ec7ebf4e738b7e423a7449ed3" title="Return the regular expression used for filtering.">filterRegExp()</a>.</p>
<p>You may want to reimplement this method to provide specialized filtering. </p>
</div>
</div>
<a class="anchor" id="a9c1714947d1910e049ec26067e0cf4d0"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::filterKeyColumn" ref="a9c1714947d1910e049ec26067e0cf4d0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::WSortFilterProxyModel::filterKeyColumn </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the column on which the filtering is applied. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#aaf272fe23196b67a409e7d0de03fd8d5" title="Specify the column on which the filtering is applied.">setFilterKeyColumn()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a2e5b064ec7ebf4e738b7e423a7449ed3"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::filterRegExp" ref="a2e5b064ec7ebf4e738b7e423a7449ed3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> Wt::WSortFilterProxyModel::filterRegExp </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the regular expression used for filtering. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a1c9dce68769668570bb5bccc3e0a9969" title="Specify a regular expression for filtering.">setFilterRegExp()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="acbbbb4a3a95a61ea1289036d4069f0bc"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::filterRole" ref="acbbbb4a3a95a61ea1289036d4069f0bc" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::WSortFilterProxyModel::filterRole </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the data role used for filtering. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a0ca42014aa2f383154409032c9a3c8d3" title="Specify the data role used for filtering.">setFilterRole()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="abd144908bf36785333b43c48b437dbdd"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::headerData" ref="abd144908bf36785333b43c48b437dbdd" args="(int section, Orientation orientation=Horizontal, int role=DisplayRole) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::any Wt::WSortFilterProxyModel::headerData </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>section</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceWt.html#a2a8d45559e16a0185bf61bfad0a67912">Orientation</a> </td>
<td class="paramname"><em>orientation</em> = <code>Horizontal</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>role</em> = <code>DisplayRole</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the row or column header data. </p>
<p>When <code>orientation</code> is <a class="el" href="namespaceWt.html#a2a8d45559e16a0185bf61bfad0a67912ac2ebf22b096a22b18eef23e736aa2e28">Horizontal</a>, <code>section</code> is a column number, when <code>orientation</code> is <a class="el" href="namespaceWt.html#a2a8d45559e16a0185bf61bfad0a67912af916b7ec24727db2d972f0770170c7f5">Vertical</a>, <code>section</code> is a row number.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WAbstractItemModel.html#a9112b74d160f916ef75fb6c1c09dd8fe" title="Returns data at a specific model index.">data()</a>, <a class="el" href="classWt_1_1WSortFilterProxyModel.html#a54eea17b2e88ebebcdba479f2f2ffc9c" title="Sets header data for a column or row.">setHeaderData()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classWt_1_1WAbstractItemModel.html#a86bbab7c809fce4de9b5cb543b2fb124">Wt::WAbstractItemModel</a>.</p>
</div>
</div>
<a class="anchor" id="a90bbd117c1a20c7627f36baceb551dcb"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::headerFlags" ref="a90bbd117c1a20c7627f36baceb551dcb" args="(int section, Orientation orientation=Horizontal) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WFlags< <a class="el" href="group__modelview.html#gafb18b4339442f1327c2a65850f3d8a53">HeaderFlag</a> > Wt::WSortFilterProxyModel::headerFlags </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>section</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceWt.html#a2a8d45559e16a0185bf61bfad0a67912">Orientation</a> </td>
<td class="paramname"><em>orientation</em> = <code>Horizontal</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the flags for a header. </p>
<p>The default implementation returns no flags set.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__modelview.html#gafb18b4339442f1327c2a65850f3d8a53" title="Flags that indicate table header options.">Wt::HeaderFlag</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classWt_1_1WAbstractItemModel.html#a6bb2a7e70f816606351be4a23c453a49">Wt::WAbstractItemModel</a>.</p>
</div>
</div>
<a class="anchor" id="a018f06cc89846655bd0db3c7a9eebfcb"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::index" ref="a018f06cc89846655bd0db3c7a9eebfcb" args="(int row, int column, const WModelIndex &parent=WModelIndex()) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> Wt::WSortFilterProxyModel::index </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>column</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> & </td>
<td class="paramname"><em>parent</em> = <code><a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the child index for the given row and column. </p>
<p>When implementing this method, you can use <a class="el" href="classWt_1_1WAbstractItemModel.html#ac837a73fe423255035ffb076946de122" title="Creates a model index for the given row and column.">createIndex()</a> to create an index that corresponds to the item at <code>row</code> and <code>column</code> within <code>parent</code>.</p>
<p>If the location is invalid (out of bounds at the parent), then an invalid index must be returned.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a6ad76d2a537d2f8e3f6f084a10e493a3" title="Returns the parent for a model index.">parent()</a> </dd></dl>
<p>Implements <a class="el" href="classWt_1_1WAbstractItemModel.html#a83f37bf04b8574b328c139b02523b8cb">Wt::WAbstractItemModel</a>.</p>
</div>
</div>
<a class="anchor" id="a0a65e908c140bc48c5e0a5fb3ada12b8"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::insertRows" ref="a0a65e908c140bc48c5e0a5fb3ada12b8" args="(int row, int count, const WModelIndex &parent=WModelIndex())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WSortFilterProxyModel::insertRows </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> & </td>
<td class="paramname"><em>parent</em> = <code><a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Inserts a number rows. </p>
<p>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.</p>
<p>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. </p>
<p>Reimplemented from <a class="el" href="classWt_1_1WAbstractItemModel.html#abcafc38dc24fd9edf70eafe834ca411d">Wt::WAbstractItemModel</a>.</p>
</div>
</div>
<a class="anchor" id="a5fc984dd492c02e47de2d87df6816d17"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::lessThan" ref="a5fc984dd492c02e47de2d87df6816d17" args="(const WModelIndex &lhs, const WModelIndex &rhs) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WSortFilterProxyModel::lessThan </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> & </td>
<td class="paramname"><em>lhs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> & </td>
<td class="paramname"><em>rhs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compares two indexes. </p>
<p>The default implementation uses <a class="el" href="classWt_1_1WSortFilterProxyModel.html#a35cfadde9afc4495dfab93234e5e169b" title="Return the data role used for sorting.">sortRole()</a> and an ordering using the operator< when the data is of the same type or compares lexicographically otherwise.</p>
<p>You may want to reimplement this method to provide specialized sorting. </p>
</div>
</div>
<a class="anchor" id="ab32e734793e3a6e657b3b5655831885e"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::mapFromSource" ref="ab32e734793e3a6e657b3b5655831885e" args="(const WModelIndex &sourceIndex) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> Wt::WSortFilterProxyModel::mapFromSource </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> & </td>
<td class="paramname"><em>sourceIndex</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Maps a source model index to the proxy model. </p>
<p>This method returns a model index in the proxy model that corresponds to the model index <code>sourceIndex</code> in the source model. This method must only be implemented for source model indexes that are mapped and thus are the result of <a class="el" href="classWt_1_1WSortFilterProxyModel.html#a290351f93612a5180c055328e2ff3663" title="Maps a proxy model index to the source model.">mapToSource()</a>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a290351f93612a5180c055328e2ff3663" title="Maps a proxy model index to the source model.">mapToSource()</a> </dd></dl>
<p>Implements <a class="el" href="classWt_1_1WAbstractProxyModel.html#a856d190cc66edcf05462e2476f43b01d">Wt::WAbstractProxyModel</a>.</p>
</div>
</div>
<a class="anchor" id="a290351f93612a5180c055328e2ff3663"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::mapToSource" ref="a290351f93612a5180c055328e2ff3663" args="(const WModelIndex &proxyIndex) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> Wt::WSortFilterProxyModel::mapToSource </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> & </td>
<td class="paramname"><em>proxyIndex</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Maps a proxy model index to the source model. </p>
<p>This method returns a model index in the source model that corresponds to the proxy model index <code>proxyIndex</code>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#ab32e734793e3a6e657b3b5655831885e" title="Maps a source model index to the proxy model.">mapFromSource()</a> </dd></dl>
<p>Implements <a class="el" href="classWt_1_1WAbstractProxyModel.html#ac36b0ee3110073578da8b999d1882bf7">Wt::WAbstractProxyModel</a>.</p>
</div>
</div>
<a class="anchor" id="a6ad76d2a537d2f8e3f6f084a10e493a3"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::parent" ref="a6ad76d2a537d2f8e3f6f084a10e493a3" args="(const WModelIndex &index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> Wt::WSortFilterProxyModel::parent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> & </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the parent for a model index. </p>
<p>An implementation should use <a class="el" href="classWt_1_1WAbstractItemModel.html#ac837a73fe423255035ffb076946de122" title="Creates a model index for the given row and column.">createIndex()</a> to create a model index that corresponds to the parent of a given index.</p>
<p>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 <a class="el" href="classWt_1_1WModelIndex.html#a44aabe692bba87ba144c1ab9a7f98eb3" title="Returns the internal pointer.">WModelIndex::internalPointer()</a>) 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.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a018f06cc89846655bd0db3c7a9eebfcb" title="Returns the child index for the given row and column.">index()</a> </dd></dl>
<p>Implements <a class="el" href="classWt_1_1WAbstractItemModel.html#ada454d45706ca0c1a0921dedd351c48c">Wt::WAbstractItemModel</a>.</p>
</div>
</div>
<a class="anchor" id="ac05897acd82abbe355dc57c79a2d01be"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::removeRows" ref="ac05897acd82abbe355dc57c79a2d01be" args="(int row, int count, const WModelIndex &parent=WModelIndex())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WSortFilterProxyModel::removeRows </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> & </td>
<td class="paramname"><em>parent</em> = <code><a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes a number rows. </p>
<p>The rows are removed from the source model. </p>
<p>Reimplemented from <a class="el" href="classWt_1_1WAbstractItemModel.html#a29cf3003ee8f97b2b5de9c52af27361a">Wt::WAbstractItemModel</a>.</p>
</div>
</div>
<a class="anchor" id="aa4d6d01a9ec7bbdb1d77f31fbd332791"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::rowCount" ref="aa4d6d01a9ec7bbdb1d77f31fbd332791" args="(const WModelIndex &parent=WModelIndex()) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::WSortFilterProxyModel::rowCount </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> & </td>
<td class="paramname"><em>parent</em> = <code><a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a>()</code></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of rows. </p>
<p>This returns the number of rows at index <code>parent</code>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#ad295e3835ffd9f5e602b3dbb29f93f22" title="Returns the number of columns.">columnCount()</a> </dd></dl>
<p>Implements <a class="el" href="classWt_1_1WAbstractItemModel.html#ab0709a8f71fd5df882f29bb29fd055f0">Wt::WAbstractItemModel</a>.</p>
</div>
</div>
<a class="anchor" id="a4dfdc62d591249454cbb38e5099f19b4"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::setDynamicSortFilter" ref="a4dfdc62d591249454cbb38e5099f19b4" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WSortFilterProxyModel::setDynamicSortFilter </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>enable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Configure the proxy to dynamically track changes in the source model. </p>
<p>When <code>enable</code> is <code>true</code>, the proxy will re-filter and re-sort the model when changes happen to the source model.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>This may be ackward when editing through the proxy model, since changing some data may rearrange the model and thus invalidate model indexes. Therefore it is usually less complicated to manipulate directly the source model instead.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a5fc984dd492c02e47de2d87df6816d17" title="Compares two indexes.">lessThan()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aaf272fe23196b67a409e7d0de03fd8d5"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::setFilterKeyColumn" ref="aaf272fe23196b67a409e7d0de03fd8d5" args="(int column)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WSortFilterProxyModel::setFilterKeyColumn </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>column</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Specify the column on which the filtering is applied. </p>
<p>This configures the column on which the <a class="el" href="classWt_1_1WSortFilterProxyModel.html#a2e5b064ec7ebf4e738b7e423a7449ed3" title="Return the regular expression used for filtering.">filterRegExp()</a> is applied.</p>
<p>The default value is 0.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a1c9dce68769668570bb5bccc3e0a9969" title="Specify a regular expression for filtering.">setFilterRegExp()</a>, <a class="el" href="classWt_1_1WSortFilterProxyModel.html#a0ca42014aa2f383154409032c9a3c8d3" title="Specify the data role used for filtering.">setFilterRole()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1c9dce68769668570bb5bccc3e0a9969"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::setFilterRegExp" ref="a1c9dce68769668570bb5bccc3e0a9969" args="(const WString &pattern)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WSortFilterProxyModel::setFilterRegExp </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>pattern</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Specify a regular expression for filtering. </p>
<p>This configures the regular expression used for filtering on <a class="el" href="classWt_1_1WSortFilterProxyModel.html#a9c1714947d1910e049ec26067e0cf4d0" title="Return the column on which the filtering is applied.">filterKeyColumn()</a>.</p>
<p>The default value is an empty expression, which disables filtering.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#aaf272fe23196b67a409e7d0de03fd8d5" title="Specify the column on which the filtering is applied.">setFilterKeyColumn()</a>, <a class="el" href="classWt_1_1WSortFilterProxyModel.html#a0ca42014aa2f383154409032c9a3c8d3" title="Specify the data role used for filtering.">setFilterRole()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0ca42014aa2f383154409032c9a3c8d3"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::setFilterRole" ref="a0ca42014aa2f383154409032c9a3c8d3" args="(int role)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WSortFilterProxyModel::setFilterRole </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>role</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Specify the data role used for filtering. </p>
<p>This configures the data role used for filtering on <a class="el" href="classWt_1_1WSortFilterProxyModel.html#a9c1714947d1910e049ec26067e0cf4d0" title="Return the column on which the filtering is applied.">filterKeyColumn()</a>.</p>
<p>The default value is <a class="el" href="group__modelview.html#gga0ae864e12320f9f89172735e075ed068a5ed17aded8a0e3b712698cf85a218f1f">DisplayRole</a>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#aaf272fe23196b67a409e7d0de03fd8d5" title="Specify the column on which the filtering is applied.">setFilterKeyColumn()</a>, <a class="el" href="classWt_1_1WSortFilterProxyModel.html#a1c9dce68769668570bb5bccc3e0a9969" title="Specify a regular expression for filtering.">setFilterRegExp()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a54eea17b2e88ebebcdba479f2f2ffc9c"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::setHeaderData" ref="a54eea17b2e88ebebcdba479f2f2ffc9c" args="(int section, Orientation orientation, const boost::any &value, int role=EditRole)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WSortFilterProxyModel::setHeaderData </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>section</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceWt.html#a2a8d45559e16a0185bf61bfad0a67912">Orientation</a> </td>
<td class="paramname"><em>orientation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const boost::any & </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>role</em> = <code>EditRole</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets header data for a column or row. </p>
<p>Returns <code>true</code> if the operation was successful.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#abd144908bf36785333b43c48b437dbdd" title="Returns the row or column header data.">headerData()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classWt_1_1WAbstractItemModel.html#a57f5d417f933440db0d38ece7dd370f4">Wt::WAbstractItemModel</a>.</p>
</div>
</div>
<a class="anchor" id="a63686e0718a623c6507f61195e020917"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::setSortRole" ref="a63686e0718a623c6507f61195e020917" args="(int role)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WSortFilterProxyModel::setSortRole </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>role</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Specify the data role used used for sorting. </p>
<p>This configures the data role used for sorting.</p>
<p>The default value is <a class="el" href="group__modelview.html#gga0ae864e12320f9f89172735e075ed068a5ed17aded8a0e3b712698cf85a218f1f">DisplayRole</a>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a5fc984dd492c02e47de2d87df6816d17" title="Compares two indexes.">lessThan()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a805bcc6964e8c0194638c05f30d2a8cb"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::setSourceModel" ref="a805bcc6964e8c0194638c05f30d2a8cb" args="(WAbstractItemModel *sourceModel)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WSortFilterProxyModel::setSourceModel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WAbstractItemModel.html">WAbstractItemModel</a> * </td>
<td class="paramname"><em>sourceModel</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the source model. </p>
<p>The source model provides the actual data for the proxy model.</p>
<p>Ownership of the source model is <em>not</em> transferred. </p>
<p>Reimplemented from <a class="el" href="classWt_1_1WAbstractProxyModel.html#a2e21723dd84569f7e42f118efd7eecce">Wt::WAbstractProxyModel</a>.</p>
</div>
</div>
<a class="anchor" id="a119a5cdf51974371db37ae6972e5955b"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::sort" ref="a119a5cdf51974371db37ae6972e5955b" args="(int column, SortOrder order=AscendingOrder)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WSortFilterProxyModel::sort </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>column</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__modelview.html#ga4173856040cf108a9c7360927a43ebac">SortOrder</a> </td>
<td class="paramname"><em>order</em> = <code>AscendingOrder</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sorts the model according to a particular column. </p>
<p>If the model supports sorting, then it should emit the <a class="el" href="classWt_1_1WAbstractItemModel.html#ab377ac2fcb9de9d191bd1353665d1389" title="Signal emitted when the layout is about to be changed.">layoutAboutToBeChanged()</a> signal, rearrange its items, and afterwards emit the <a class="el" href="classWt_1_1WAbstractItemModel.html#afe7cb1d5186881f83aa8f0e452aaef66" title="Signal emitted when the layout is changed.">layoutChanged()</a> signal.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WAbstractItemModel.html#ab377ac2fcb9de9d191bd1353665d1389" title="Signal emitted when the layout is about to be changed.">layoutAboutToBeChanged()</a>, <a class="el" href="classWt_1_1WAbstractItemModel.html#afe7cb1d5186881f83aa8f0e452aaef66" title="Signal emitted when the layout is changed.">layoutChanged()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classWt_1_1WAbstractItemModel.html#a133931424d4daa8422bcdea911cda713">Wt::WAbstractItemModel</a>.</p>
</div>
</div>
<a class="anchor" id="a21df26d902ba1f7d1fe0caa0d0c7f0ee"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::sortColumn" ref="a21df26d902ba1f7d1fe0caa0d0c7f0ee" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::WSortFilterProxyModel::sortColumn </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the current sort column. </p>
<p>When <a class="el" href="classWt_1_1WSortFilterProxyModel.html#a119a5cdf51974371db37ae6972e5955b" title="Sorts the model according to a particular column.">sort()</a> has not been called, the model is unsorted, and this method returns -1.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a119a5cdf51974371db37ae6972e5955b" title="Sorts the model according to a particular column.">sort()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1289e017240cdda372f605dd5386beaf"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::sortOrder" ref="a1289e017240cdda372f605dd5386beaf" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__modelview.html#ga4173856040cf108a9c7360927a43ebac">SortOrder</a> Wt::WSortFilterProxyModel::sortOrder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the current sort order. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a119a5cdf51974371db37ae6972e5955b" title="Sorts the model according to a particular column.">sort()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a35cfadde9afc4495dfab93234e5e169b"></a><!-- doxytag: member="Wt::WSortFilterProxyModel::sortRole" ref="a35cfadde9afc4495dfab93234e5e169b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::WSortFilterProxyModel::sortRole </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the data role used for sorting. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WSortFilterProxyModel.html#a63686e0718a623c6507f61195e020917" title="Specify the data role used used for sorting.">setSortRole()</a> </dd></dl>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
