<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qmessagefolderfilter.cpp -->
<title>Qt Mobility 1.2: QMessageFolderFilter Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtmessaging.html">QtMessaging</a></li>
<li>QMessageFolderFilter</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QMessageFolderFilter Class Reference</h1>
<!-- $$$QMessageFolderFilter-brief -->
<p>The QMessageFolderFilter class defines the parameters used for querying a subset of all available folders from the messaging store. <a href="#details">More...</a></p>
<!-- @@@QMessageFolderFilter -->
<pre class="cpp"> <span class="preprocessor">#include <QMessageFolderFilter></span></pre><p>This class was introduced in Qt Mobility 1.0.</p>
<ul>
<li><a href="qmessagefolderfilter-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#QMessageFolderFilter">QMessageFolderFilter</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#QMessageFolderFilter-2">QMessageFolderFilter</a></b> ( const QMessageFolderFilter & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#dtor.QMessageFolderFilter">~QMessageFolderFilter</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#isEmpty">isEmpty</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#isSupported">isSupported</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageDataComparator::MatchFlags </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#matchFlags">matchFlags</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#setMatchFlags">setMatchFlags</a></b> ( QMessageDataComparator::MatchFlags <i>matchFlags</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#operator-and">operator&</a></b> ( const QMessageFolderFilter & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QMessageFolderFilter & </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#operator-and-eq">operator&=</a></b> ( const QMessageFolderFilter & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#operator-7c">operator|</a></b> ( const QMessageFolderFilter & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QMessageFolderFilter & </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#operator-7c-eq">operator|=</a></b> ( const QMessageFolderFilter & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#operator-7e">operator~</a></b> () const</td></tr>
</table>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#byAncestorFolderIds">byAncestorFolderIds</a></b> ( const QMessageFolderId & <i>id</i>, QMessageDataComparator::InclusionComparator <i>cmp</i> = QMessageDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#byAncestorFolderIds-2">byAncestorFolderIds</a></b> ( const QMessageFolderFilter & <i>filter</i>, QMessageDataComparator::InclusionComparator <i>cmp</i> = QMessageDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#byId">byId</a></b> ( const QMessageFolderId & <i>id</i>, QMessageDataComparator::EqualityComparator <i>cmp</i> = QMessageDataComparator::Equal )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#byId-2">byId</a></b> ( const QMessageFolderIdList & <i>ids</i>, QMessageDataComparator::InclusionComparator <i>cmp</i> = QMessageDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#byId-3">byId</a></b> ( const QMessageFolderFilter & <i>filter</i>, QMessageDataComparator::InclusionComparator <i>cmp</i> = QMessageDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#byName">byName</a></b> ( const QString & <i>pattern</i>, QMessageDataComparator::LikeComparator <i>cmp</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#byName-2">byName</a></b> ( const QString & <i>value</i>, QMessageDataComparator::EqualityComparator <i>cmp</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#byName-3">byName</a></b> ( const QString & <i>value</i>, QMessageDataComparator::InclusionComparator <i>cmp</i> = QMessageDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#byParentAccountId">byParentAccountId</a></b> ( const QMessageAccountId & <i>id</i>, QMessageDataComparator::EqualityComparator <i>cmp</i> = QMessageDataComparator::Equal )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#byParentAccountId-2">byParentAccountId</a></b> ( const QMessageAccountFilter & <i>filter</i>, QMessageDataComparator::InclusionComparator <i>cmp</i> = QMessageDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#byParentFolderId">byParentFolderId</a></b> ( const QMessageFolderId & <i>id</i>, QMessageDataComparator::EqualityComparator <i>cmp</i> = QMessageDataComparator::Equal )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#byParentFolderId-2">byParentFolderId</a></b> ( const QMessageFolderFilter & <i>filter</i>, QMessageDataComparator::InclusionComparator <i>cmp</i> = QMessageDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#byPath">byPath</a></b> ( const QString & <i>pattern</i>, QMessageDataComparator::LikeComparator <i>cmp</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#byPath-2">byPath</a></b> ( const QString & <i>value</i>, QMessageDataComparator::EqualityComparator <i>cmp</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderFilter </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolderfilter.html#byPath-3">byPath</a></b> ( const QString & <i>value</i>, QMessageDataComparator::InclusionComparator <i>cmp</i> = QMessageDataComparator::Includes )</td></tr>
</table>
<a name="details"></a>
<!-- $$$QMessageFolderFilter-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QMessageFolderFilter class defines the parameters used for querying a subset of all available folders from the messaging store.</p>
<p>A QMessageFolderFilter is composed of a folder property, an optional comparison operator and a comparison value. The QMessageFolderFilter class is used in conjunction with the <a href="qmessagemanager.html#queryFolders">QMessageManager::queryFolders</a>() and <a href="qmessagemanager.html#countFolders">QMessageManager::countFolders</a>() functions to filter results which meet the criteria defined by the filter.</p>
<p>QMessageFolderFilters can be combined using the logical operators (&), (|) and (~) to create more refined queries.</p>
<p>Evaluation of filters is delayed until they are used in a <a href="qmessagemanager.html">QMessageManager</a> function such as queryFolders, except where explicitly documented otherwise.</p>
</div>
<p><b>See also </b><a href="qmessagemanager.html">QMessageManager</a> and <a href="qmessagefolder.html">QMessageFolder</a>.</p>
<!-- @@@QMessageFolderFilter -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QMessageFolderFilter[overload1]$$$QMessageFolderFilter -->
<h3 class="fn"><a name="QMessageFolderFilter"></a>QMessageFolderFilter::<span class="name">QMessageFolderFilter</span> ()</h3>
<p>Creates a <a href="qmessagefolderfilter.html">QMessageFolderFilter</a> without specifying matching parameters.</p>
<p>A default-constructed filter (one for which <a href="qmessagefolderfilter.html#isEmpty">isEmpty</a>() returns true) matches all folders.</p>
<p><b>See also </b><a href="qmessagefolderfilter.html#isEmpty">isEmpty</a>().</p>
<!-- @@@QMessageFolderFilter -->
<!-- $$$QMessageFolderFilter$$$QMessageFolderFilterconstQMessageFolderFilter& -->
<h3 class="fn"><a name="QMessageFolderFilter-2"></a>QMessageFolderFilter::<span class="name">QMessageFolderFilter</span> ( const <span class="type">QMessageFolderFilter</span> & <i>other</i> )</h3>
<p>Constructs a copy of <i>other</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@QMessageFolderFilter -->
<!-- $$$~QMessageFolderFilter[overload1]$$$~QMessageFolderFilter -->
<h3 class="fn"><a name="dtor.QMessageFolderFilter"></a>QMessageFolderFilter::<span class="name">~QMessageFolderFilter</span> ()<tt> [virtual]</tt></h3>
<p>Destroys the filter.</p>
<!-- @@@~QMessageFolderFilter -->
<!-- $$$byAncestorFolderIds[overload1]$$$byAncestorFolderIdsconstQMessageFolderId&QMessageDataComparator::InclusionComparator -->
<h3 class="fn"><a name="byAncestorFolderIds"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">byAncestorFolderIds</span> ( const <span class="type"><a href="qmessagefolderid.html">QMessageFolderId</a></span> & <i>id</i>, <span class="type"><a href="qmessagedatacomparator.html#InclusionComparator-enum">QMessageDataComparator::InclusionComparator</a></span> <i>cmp</i> = QMessageDataComparator::Includes )<tt> [static]</tt></h3>
<p>Returns a filter matching folders whose ancestor folders' identifiers contain <i>id</i>, according to <i>cmp</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmessagefolder.html#id">QMessageFolder::id</a>().</p>
<!-- @@@byAncestorFolderIds -->
<!-- $$$byAncestorFolderIds$$$byAncestorFolderIdsconstQMessageFolderFilter&QMessageDataComparator::InclusionComparator -->
<h3 class="fn"><a name="byAncestorFolderIds-2"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">byAncestorFolderIds</span> ( const <span class="type">QMessageFolderFilter</span> & <i>filter</i>, <span class="type"><a href="qmessagedatacomparator.html#InclusionComparator-enum">QMessageDataComparator::InclusionComparator</a></span> <i>cmp</i> = QMessageDataComparator::Includes )<tt> [static]</tt></h3>
<p>Returns a filter matching folders whose ancestor folders' identifiers contain a member of the set yielded by <i>filter</i>, according to <i>cmp</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmessagefolder.html#id">QMessageFolder::id</a>().</p>
<!-- @@@byAncestorFolderIds -->
<!-- $$$byId[overload1]$$$byIdconstQMessageFolderId&QMessageDataComparator::EqualityComparator -->
<h3 class="fn"><a name="byId"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">byId</span> ( const <span class="type"><a href="qmessagefolderid.html">QMessageFolderId</a></span> & <i>id</i>, <span class="type"><a href="qmessagedatacomparator.html#EqualityComparator-enum">QMessageDataComparator::EqualityComparator</a></span> <i>cmp</i> = QMessageDataComparator::Equal )<tt> [static]</tt></h3>
<p>Returns a filter matching folders whose identifier matches <i>id</i>, according to <i>cmp</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmessagefolder.html#id">QMessageFolder::id</a>().</p>
<!-- @@@byId -->
<!-- $$$byId$$$byIdconstQMessageFolderIdList&QMessageDataComparator::InclusionComparator -->
<h3 class="fn"><a name="byId-2"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">byId</span> ( const <span class="type">QMessageFolderIdList</span> & <i>ids</i>, <span class="type"><a href="qmessagedatacomparator.html#InclusionComparator-enum">QMessageDataComparator::InclusionComparator</a></span> <i>cmp</i> = QMessageDataComparator::Includes )<tt> [static]</tt></h3>
<p>Returns a filter matching folders whose identifier is a member of <i>ids</i>, according to <i>cmp</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmessagefolder.html#id">QMessageFolder::id</a>().</p>
<!-- @@@byId -->
<!-- $$$byId$$$byIdconstQMessageFolderFilter&QMessageDataComparator::InclusionComparator -->
<h3 class="fn"><a name="byId-3"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">byId</span> ( const <span class="type">QMessageFolderFilter</span> & <i>filter</i>, <span class="type"><a href="qmessagedatacomparator.html#InclusionComparator-enum">QMessageDataComparator::InclusionComparator</a></span> <i>cmp</i> = QMessageDataComparator::Includes )<tt> [static]</tt></h3>
<p>Returns a filter matching folders whose identifier is a member of the set yielded by <i>filter</i>, according to <i>cmp</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmessagefolder.html#id">QMessageFolder::id</a>().</p>
<!-- @@@byId -->
<!-- $$$byName[overload1]$$$byNameconstQString&QMessageDataComparator::LikeComparator -->
<h3 class="fn"><a name="byName"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">byName</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>pattern</i>, <span class="type"><a href="qmessagedatacomparator.html#LikeComparator-enum">QMessageDataComparator::LikeComparator</a></span> <i>cmp</i> )<tt> [static]</tt></h3>
<p>Returns a filter matching folders whose display name matches <i>pattern</i>, according to <i>cmp</i>.</p>
<p>This filter is evaluated when it is constructed.</p>
<p>This function was introduced in Qt Mobility 1.2.</p>
<p><b>See also </b><a href="qmessagefolder.html#name">QMessageFolder::name</a>().</p>
<!-- @@@byName -->
<!-- $$$byName$$$byNameconstQString&QMessageDataComparator::EqualityComparator -->
<h3 class="fn"><a name="byName-2"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">byName</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>value</i>, <span class="type"><a href="qmessagedatacomparator.html#EqualityComparator-enum">QMessageDataComparator::EqualityComparator</a></span> <i>cmp</i> )<tt> [static]</tt></h3>
<p>Returns a filter matching folders whose display name matches <i>value</i>, according to <i>cmp</i>.</p>
<p>Not supported on Linux, Harmattan and Meego.com (use InclusionComparator).</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmessagefolder.html#name">QMessageFolder::name</a>().</p>
<!-- @@@byName -->
<!-- $$$byName$$$byNameconstQString&QMessageDataComparator::InclusionComparator -->
<h3 class="fn"><a name="byName-3"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">byName</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>value</i>, <span class="type"><a href="qmessagedatacomparator.html#InclusionComparator-enum">QMessageDataComparator::InclusionComparator</a></span> <i>cmp</i> = QMessageDataComparator::Includes )<tt> [static]</tt></h3>
<p>Returns a filter matching folders whose display name matches the substring <i>value</i>, according to <i>cmp</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmessagefolder.html#name">QMessageFolder::name</a>().</p>
<!-- @@@byName -->
<!-- $$$byParentAccountId[overload1]$$$byParentAccountIdconstQMessageAccountId&QMessageDataComparator::EqualityComparator -->
<h3 class="fn"><a name="byParentAccountId"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">byParentAccountId</span> ( const <span class="type"><a href="qmessageaccountid.html">QMessageAccountId</a></span> & <i>id</i>, <span class="type"><a href="qmessagedatacomparator.html#EqualityComparator-enum">QMessageDataComparator::EqualityComparator</a></span> <i>cmp</i> = QMessageDataComparator::Equal )<tt> [static]</tt></h3>
<p>Returns a filter matching folders whose parent account identifier matches <i>id</i>, according to <i>cmp</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmessageaccount.html#id">QMessageAccount::id</a>().</p>
<!-- @@@byParentAccountId -->
<!-- $$$byParentAccountId$$$byParentAccountIdconstQMessageAccountFilter&QMessageDataComparator::InclusionComparator -->
<h3 class="fn"><a name="byParentAccountId-2"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">byParentAccountId</span> ( const <span class="type"><a href="qmessageaccountfilter.html">QMessageAccountFilter</a></span> & <i>filter</i>, <span class="type"><a href="qmessagedatacomparator.html#InclusionComparator-enum">QMessageDataComparator::InclusionComparator</a></span> <i>cmp</i> = QMessageDataComparator::Includes )<tt> [static]</tt></h3>
<p>Returns a filter matching folders whose parent account identifier is a member of the set yielded by <i>filter</i>, according to <i>cmp</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmessageaccount.html#id">QMessageAccount::id</a>().</p>
<!-- @@@byParentAccountId -->
<!-- $$$byParentFolderId[overload1]$$$byParentFolderIdconstQMessageFolderId&QMessageDataComparator::EqualityComparator -->
<h3 class="fn"><a name="byParentFolderId"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">byParentFolderId</span> ( const <span class="type"><a href="qmessagefolderid.html">QMessageFolderId</a></span> & <i>id</i>, <span class="type"><a href="qmessagedatacomparator.html#EqualityComparator-enum">QMessageDataComparator::EqualityComparator</a></span> <i>cmp</i> = QMessageDataComparator::Equal )<tt> [static]</tt></h3>
<p>Returns a filter matching folders whose parent folder identifier matches <i>id</i>, according to <i>cmp</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmessagefolder.html#id">QMessageFolder::id</a>().</p>
<!-- @@@byParentFolderId -->
<!-- $$$byParentFolderId$$$byParentFolderIdconstQMessageFolderFilter&QMessageDataComparator::InclusionComparator -->
<h3 class="fn"><a name="byParentFolderId-2"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">byParentFolderId</span> ( const <span class="type">QMessageFolderFilter</span> & <i>filter</i>, <span class="type"><a href="qmessagedatacomparator.html#InclusionComparator-enum">QMessageDataComparator::InclusionComparator</a></span> <i>cmp</i> = QMessageDataComparator::Includes )<tt> [static]</tt></h3>
<p>Returns a filter matching folders whose parent folder identifier is a member of the set yielded by <i>filter</i>, according to <i>cmp</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmessagefolder.html#id">QMessageFolder::id</a>().</p>
<!-- @@@byParentFolderId -->
<!-- $$$byPath[overload1]$$$byPathconstQString&QMessageDataComparator::LikeComparator -->
<h3 class="fn"><a name="byPath"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">byPath</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>pattern</i>, <span class="type"><a href="qmessagedatacomparator.html#LikeComparator-enum">QMessageDataComparator::LikeComparator</a></span> <i>cmp</i> )<tt> [static]</tt></h3>
<p>Returns a filter matching folders whose path matches <i>pattern</i>, according to <i>cmp</i>.</p>
<p>This filter is evaluated when it is constructed.</p>
<p>This function was introduced in Qt Mobility 1.2.</p>
<p><b>See also </b><a href="qmessagefolder.html#path">QMessageFolder::path</a>().</p>
<!-- @@@byPath -->
<!-- $$$byPath$$$byPathconstQString&QMessageDataComparator::EqualityComparator -->
<h3 class="fn"><a name="byPath-2"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">byPath</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>value</i>, <span class="type"><a href="qmessagedatacomparator.html#EqualityComparator-enum">QMessageDataComparator::EqualityComparator</a></span> <i>cmp</i> )<tt> [static]</tt></h3>
<p>Returns a filter matching folders whose path matches <i>value</i>, according to <i>cmp</i>.</p>
<p>Not supported on Linux, Harmattan and Meego.com (use InclusionComparator).</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmessagefolder.html#path">QMessageFolder::path</a>().</p>
<!-- @@@byPath -->
<!-- $$$byPath$$$byPathconstQString&QMessageDataComparator::InclusionComparator -->
<h3 class="fn"><a name="byPath-3"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">byPath</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>value</i>, <span class="type"><a href="qmessagedatacomparator.html#InclusionComparator-enum">QMessageDataComparator::InclusionComparator</a></span> <i>cmp</i> = QMessageDataComparator::Includes )<tt> [static]</tt></h3>
<p>Returns a filter matching folders whose path matches the substring <i>value</i>, according to <i>cmp</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmessagefolder.html#path">QMessageFolder::path</a>().</p>
<!-- @@@byPath -->
<!-- $$$isEmpty[overload1]$$$isEmpty -->
<h3 class="fn"><a name="isEmpty"></a><span class="type">bool</span> QMessageFolderFilter::<span class="name">isEmpty</span> () const</h3>
<p>Returns true if the filter remains empty after default construction; otherwise returns false.</p>
<p>An empty filter matches all folders.</p>
<p>The result of combining an empty filter with a non-empty filter using an AND operation is the original non-empty filter.</p>
<p>The result of combining an empty filter with a non-empty filter using an OR operation is the empty filter.</p>
<p>The result of combining two empty filters is an empty filter.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@isEmpty -->
<!-- $$$isSupported[overload1]$$$isSupported -->
<h3 class="fn"><a name="isSupported"></a><span class="type">bool</span> QMessageFolderFilter::<span class="name">isSupported</span> () const</h3>
<p>Returns true if the filter is supported on the current platform; otherwise returns false.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@isSupported -->
<!-- $$$matchFlags[overload1]$$$matchFlags -->
<h3 class="fn"><a name="matchFlags"></a><span class="type"><a href="qmessagedatacomparator.html#MatchFlag-enum">QMessageDataComparator::MatchFlags</a></span> QMessageFolderFilter::<span class="name">matchFlags</span> () const</h3>
<p>Return the match flags for the search filter.</p>
<p>Default is no match flags set.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmessagefolderfilter.html#setMatchFlags">setMatchFlags</a>().</p>
<!-- @@@matchFlags -->
<!-- $$$setMatchFlags[overload1]$$$setMatchFlagsQMessageDataComparator::MatchFlags -->
<h3 class="fn"><a name="setMatchFlags"></a><span class="type">void</span> QMessageFolderFilter::<span class="name">setMatchFlags</span> ( <span class="type"><a href="qmessagedatacomparator.html#MatchFlag-enum">QMessageDataComparator::MatchFlags</a></span> <i>matchFlags</i> )</h3>
<p>Set the match flags for the search filter to <i>matchFlags</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmessagefolderfilter.html#matchFlags">matchFlags</a>().</p>
<!-- @@@setMatchFlags -->
<!-- $$$operator&[overload1]$$$operator&constQMessageFolderFilter& -->
<h3 class="fn"><a name="operator-and"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">operator&</span> ( const <span class="type">QMessageFolderFilter</span> & <i>other</i> ) const</h3>
<p>Returns a filter that is the logical AND of this filter and the value of filter <i>other</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@operator& -->
<!-- $$$operator&=[overload1]$$$operator&=constQMessageFolderFilter& -->
<h3 class="fn"><a name="operator-and-eq"></a>const <span class="type">QMessageFolderFilter</span> & QMessageFolderFilter::<span class="name">operator&=</span> ( const <span class="type">QMessageFolderFilter</span> & <i>other</i> )</h3>
<p>Performs a logical AND with this filter and the filter <i>other</i> and assigns the result to this filter.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@operator&= -->
<!-- $$$operator|[overload1]$$$operator|constQMessageFolderFilter& -->
<h3 class="fn"><a name="operator-7c"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">operator|</span> ( const <span class="type">QMessageFolderFilter</span> & <i>other</i> ) const</h3>
<p>Returns a filter that is the logical OR of this filter and the value of filter <i>other</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@operator| -->
<!-- $$$operator|=[overload1]$$$operator|=constQMessageFolderFilter& -->
<h3 class="fn"><a name="operator-7c-eq"></a>const <span class="type">QMessageFolderFilter</span> & QMessageFolderFilter::<span class="name">operator|=</span> ( const <span class="type">QMessageFolderFilter</span> & <i>other</i> )</h3>
<p>Performs a logical OR with this filter and the filter <i>other</i> and assigns the result to this filter.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@operator|= -->
<!-- $$$operator~[overload1]$$$operator~ -->
<h3 class="fn"><a name="operator-7e"></a><span class="type">QMessageFolderFilter</span> QMessageFolderFilter::<span class="name">operator~</span> () const</h3>
<p>Returns a filter that is the logical NOT of the value of this filter (ignoring any <a href="qmessagefolderfilter.html#matchFlags">matchFlags</a>() set on the filter).</p>
<p>If this filter is empty, the result will be a non-matching filter; if this filter is non-matching, the result will be an empty filter.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmessagefolderfilter.html#isEmpty">isEmpty</a>().</p>
<!-- @@@operator~ -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2008-2011 Nokia Corporation and/or its
subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide.</p>
<p>
All other trademarks are property of their respective owners. <a title="Privacy Policy"
href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
<br />
<p>
Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.</p>
<p>
Alternatively, this document may be used under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU
Free Documentation License version 1.3</a>
as published by the Free Software Foundation.</p>
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
50facae208d4a6f280e44a513b104320
>
files
>
1119
