<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /builddir/build/BUILD/libqxt/src/gui/qxtsortfilterproxymodel.cpp -->
<head>
<title>QxtSortFilterProxyModel Class Reference</title>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://libqxt.org"><img src="images/qxt-logo.png" width="50" height="40" align="left" border="0" /></a></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a> · <a href="classes.html"><font color="#004faf">Classes</font></a> · <a href="namespaces.html"><font color="#004faf">Namespaces</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">QxtSortFilterProxyModel Class Reference<br /><span class="small-subtitle">[<a href="qxtgui.html">QxtGui</a> module]</span>
</h1>
<p>The QxtSortFilterProxyModel class is a multi column filter model. <a href="#details">More...</a></p>
<pre> #include <QxtSortFilterProxyModel></pre><p>Inherits <a href="http://doc.qtsoftware.com/4.5/qsortfilterproxymodel.html">QSortFilterProxyModel</a>.</p>
<ul>
<li><a href="qxtsortfilterproxymodel-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"></div><b><a href="qxtsortfilterproxymodel.html#QxtSortFilterProxyModel">QxtSortFilterProxyModel</a></b> ( QObject * <i>parent</i> = 0 )</li>
<li><div class="fn"></div>void <b><a href="qxtsortfilterproxymodel.html#beginDeclareFilter">beginDeclareFilter</a></b> ()</li>
<li><div class="fn"></div>void <b><a href="qxtsortfilterproxymodel.html#endDeclareFilter">endDeclareFilter</a></b> ()</li>
<li><div class="fn"></div>Qt::MatchFlags <b><a href="qxtsortfilterproxymodel.html#filterFlags">filterFlags</a></b> ( const int <i>column</i> ) const</li>
<li><div class="fn"></div>int <b><a href="qxtsortfilterproxymodel.html#filterRole">filterRole</a></b> ( const int <i>column</i> ) const</li>
<li><div class="fn"></div>QVariant <b><a href="qxtsortfilterproxymodel.html#filterValue">filterValue</a></b> ( const int <i>column</i> ) const</li>
<li><div class="fn"></div>bool <b><a href="qxtsortfilterproxymodel.html#isFiltered">isFiltered</a></b> ( const int <i>column</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtsortfilterproxymodel.html#removeFilter">removeFilter</a></b> ( const int <i>column</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtsortfilterproxymodel.html#setFilter">setFilter</a></b> ( const int <i>column</i>, const QVariant & <i>value</i>, const int <i>role</i> = Qt::DisplayRole, Qt::MatchFlags <i>flags</i> = Qt::MatchContains )</li>
<li><div class="fn"></div>void <b><a href="qxtsortfilterproxymodel.html#setFilterFlags">setFilterFlags</a></b> ( const int <i>column</i>, const Qt::MatchFlags <i>flags</i> = Qt::MatchContains )</li>
<li><div class="fn"></div>void <b><a href="qxtsortfilterproxymodel.html#setFilterRole">setFilterRole</a></b> ( const int <i>column</i>, const int <i>role</i> = Qt::DisplayRole )</li>
<li><div class="fn"></div>void <b><a href="qxtsortfilterproxymodel.html#setFilterValue">setFilterValue</a></b> ( const int <i>column</i>, const QVariant & <i>value</i> )</li>
</ul>
<ul>
<li><div class="fn"></div>20 public functions inherited from <a href="http://doc.qtsoftware.com/4.5/qsortfilterproxymodel.html#public-functions">QSortFilterProxyModel</a></li>
<li><div class="fn"></div>6 public functions inherited from <a href="http://doc.qtsoftware.com/4.5/qabstractproxymodel.html#public-functions">QAbstractProxyModel</a></li>
<li><div class="fn"></div>34 public functions inherited from <a href="http://doc.qtsoftware.com/4.5/qabstractitemmodel.html#public-functions">QAbstractItemModel</a></li>
<li><div class="fn"></div>29 public functions inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li><div class="fn"></div>8 properties inherited from <a href="http://doc.qtsoftware.com/4.5/qsortfilterproxymodel.html#properties">QSortFilterProxyModel</a></li>
<li><div class="fn"></div>1 property inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#properties">QObject</a></li>
<li><div class="fn"></div>4 public slots inherited from <a href="http://doc.qtsoftware.com/4.5/qsortfilterproxymodel.html#public-slots">QSortFilterProxyModel</a></li>
<li><div class="fn"></div>2 public slots inherited from <a href="http://doc.qtsoftware.com/4.5/qabstractitemmodel.html#public-slots">QAbstractItemModel</a></li>
<li><div class="fn"></div>1 public slot inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-slots">QObject</a></li>
<li><div class="fn"></div>14 signals inherited from <a href="http://doc.qtsoftware.com/4.5/qabstractitemmodel.html#signals">QAbstractItemModel</a></li>
<li><div class="fn"></div>1 signal inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#signals">QObject</a></li>
<li><div class="fn"></div>1 public type inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-variables">QObject</a></li>
<li><div class="fn"></div>4 static public members inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#static-public-members">QObject</a></li>
<li><div class="fn"></div>4 protected functions inherited from <a href="http://doc.qtsoftware.com/4.5/qsortfilterproxymodel.html#protected-functions">QSortFilterProxyModel</a></li>
<li><div class="fn"></div>14 protected functions inherited from <a href="http://doc.qtsoftware.com/4.5/qabstractitemmodel.html#protected-functions">QAbstractItemModel</a></li>
<li><div class="fn"></div>7 protected functions inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#protected-functions">QObject</a></li>
<li><div class="fn"></div>2 protected variables inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QxtSortFilterProxyModel class is a multi column filter model.</p>
<p>The QxtSortFilterProxyModel makes it possible to filter over multiple columns.</p>
<pre> QxtSortFilterProxyModel * filterModel = new QxtSortFilterProxyModel(parent);
filterModel->setSourceModel(sourceModel);
filterModel->beginDeclareFilter();
filterModel->setFilter(1,QVariant("SomeStringValue"),Qt::DisplayRole,Qt::MatchExactly);
<span class="comment"> //remove some old filter</span>
filterModel->removeFilter(2);
filterModel->setFilter(5,QVariant(1234),Qt::DisplayRole,Qt::MatchExactly);
filterModel->endDeclateFilter();</pre>
<p>Now the model will filter column 1 and 5, to be accepted by the filtermodel a row needs to pass all filters</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QxtSortFilterProxyModel"></a>QxtSortFilterProxyModel::QxtSortFilterProxyModel ( <a href="http://doc.qtsoftware.com/4.5/qobject.html">QObject</a> * <i>parent</i> = 0 )</h3>
<p>Constructs a new <a href="qxtsortfilterproxymodel.html">QxtSortFilterProxyModel</a> with <i>parent</i>.</p>
<h3 class="fn"><a name="beginDeclareFilter"></a>void QxtSortFilterProxyModel::beginDeclareFilter ()</h3>
<p>tells the model you want to declare a new filter</p>
<p>If you have a lot of data in your model it can be slow to declare more than one filter, because the model will always rebuild itself. If you call this member before setting the new filters the model will invalidate its contents not before you call</p>
<p>See also <a href="qxtsortfilterproxymodel.html#endDeclareFilter">endDeclareFilter</a>().</p>
<h3 class="fn"><a name="endDeclareFilter"></a>void QxtSortFilterProxyModel::endDeclareFilter ()</h3>
<p>stops the filter declaration and invalidates the filter</p>
<p>See also <a href="qxtsortfilterproxymodel.html#beginDeclareFilter">beginDeclareFilter</a>().</p>
<h3 class="fn"><a name="filterFlags"></a><a href="http://doc.qtsoftware.com/4.5/qt.html#MatchFlags-typedef">Qt::MatchFlags</a> QxtSortFilterProxyModel::filterFlags ( const int <i>column</i> ) const</h3>
<p>returns the filter flags for the given <i>column</i></p>
<p><b>Note:</b> if the column is not filtered it will return the default value</p>
<p>See also <a href="qxtsortfilterproxymodel.html#setFilterFlags">setFilterFlags</a>().</p>
<h3 class="fn"><a name="filterRole"></a>int QxtSortFilterProxyModel::filterRole ( const int <i>column</i> ) const</h3>
<p>Returns the filter role for the given <i>column</i></p>
<p><b>Note:</b> if the column is not filtered it will return <tt>-1</tt></p>
<p>See also <a href="qxtsortfilterproxymodel.html#setFilterRole">setFilterRole</a>().</p>
<h3 class="fn"><a name="filterValue"></a><a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> QxtSortFilterProxyModel::filterValue ( const int <i>column</i> ) const</h3>
<p>Returns the filter value for the given <i>column</i></p>
<p><b>Note:</b> if the column is not filtered it will return a null variant</p>
<p>See also <a href="qxtsortfilterproxymodel.html#setFilterValue">setFilterValue</a>().</p>
<h3 class="fn"><a name="isFiltered"></a>bool QxtSortFilterProxyModel::isFiltered ( const int <i>column</i> )</h3>
<p>Returns true if the <i>column</i> is filtered</p>
<h3 class="fn"><a name="removeFilter"></a>void QxtSortFilterProxyModel::removeFilter ( const int <i>column</i> )</h3>
<p>Removes the filter from the given <i>column</i></p>
<h3 class="fn"><a name="setFilter"></a>void QxtSortFilterProxyModel::setFilter ( const int <i>column</i>, const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>value</i>, const int <i>role</i> = Qt::DisplayRole, <a href="http://doc.qtsoftware.com/4.5/qt.html#MatchFlags-typedef">Qt::MatchFlags</a> <i>flags</i> = Qt::MatchContains )</h3>
<p>Sets the filter with <i>value</i>, <i>role</i> and <i>flags</i> to the given <i>column</i></p>
<h3 class="fn"><a name="setFilterFlags"></a>void QxtSortFilterProxyModel::setFilterFlags ( const int <i>column</i>, const <a href="http://doc.qtsoftware.com/4.5/qt.html#MatchFlags-typedef">Qt::MatchFlags</a> <i>flags</i> = Qt::MatchContains )</h3>
<p>Sets the filter <i>flags</i> for the given <i>column</i></p>
<p>See also <a href="qxtsortfilterproxymodel.html#filterFlags">filterFlags</a>().</p>
<h3 class="fn"><a name="setFilterRole"></a>void QxtSortFilterProxyModel::setFilterRole ( const int <i>column</i>, const int <i>role</i> = Qt::DisplayRole )</h3>
<p>Sets the filter <i>role</i> for the given <i>column</i></p>
<p>See also <a href="qxtsortfilterproxymodel.html#filterRole">filterRole</a>().</p>
<h3 class="fn"><a name="setFilterValue"></a>void QxtSortFilterProxyModel::setFilterValue ( const int <i>column</i>, const <a href="http://doc.qtsoftware.com/4.5/qvariant.html">QVariant</a> & <i>value</i> )</h3>
<p>Sets the filter <i>value</i> for the given <i>column</i></p>
<p>See also <a href="qxtsortfilterproxymodel.html#filterValue">filterValue</a>().</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td align="left">Copyright © 2007-2010
<a href="mailto:foundation@libqxt.org">Qxt Foundation</a></td>
<td align="right"><div align="right">
<a href="http://libqxt.org">Qxt</a> 0.6.1</div></td>
</tr></table></div></address></body>
</html>
