/usr/share/doc/qmf/html/qmailfolderkey.html is in qmf-doc-html 1.0.7~2011w23.2-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 | <?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">
<!-- qmailfolderkey.cpp -->
<head>
<title>QMailFolderKey Class Reference</title>
<link href="classic.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"><img src="images/qtlogo.png" align="left" border="0" /></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a></td>
<td align="right" valign="top" width="230"><img src="images/codeless.png" border="0" /></td></tr></table><h1 class="title">QMailFolderKey Class Reference</h1>
<p>The QMailFolderKey class defines the parameters used for querying a subset of all available folders from the mail store. <a href="#details">More...</a></p>
<pre> #include <QMailFolderKey></pre><p><b>This class is under development and is subject to change.</b></p>
<ul>
<li><a href="qmailfolderkey-members.html">List of all members, including inherited members</a></li>
</ul>
<hr />
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">typedef </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#ArgumentType-typedef">ArgumentType</a></b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#Property-enum">Property</a></b> { Id, Path, ParentFolderId, ParentAccountId, ..., Custom }</td></tr>
</table>
<hr />
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#QMailFolderKey">QMailFolderKey</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#QMailFolderKey-2">QMailFolderKey</a></b> ( const QMailFolderKey & <i>other</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#dtor.QMailFolderKey">~QMailFolderKey</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const QList<ArgumentType> & </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#arguments">arguments</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailKey::Combiner </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#combiner">combiner</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#deserialize">deserialize</a></b> ( Stream & <i>stream</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#isEmpty">isEmpty</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#isNegated">isNegated</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#isNonMatching">isNonMatching</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#serialize">serialize</a></b> ( Stream & <i>stream</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const QList<QMailFolderKey> & </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#subKeys">subKeys</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#operator-QVariant">operator QVariant</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#operator-not-eq">operator!=</a></b> ( const QMailFolderKey & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#operator-and">operator&</a></b> ( const QMailFolderKey & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const QMailFolderKey & </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#operator-and-eq">operator&=</a></b> ( const QMailFolderKey & <i>other</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const QMailFolderKey & </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#operator-eq">operator=</a></b> ( const QMailFolderKey & <i>other</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#operator-eq-eq">operator==</a></b> ( const QMailFolderKey & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#operator-7c">operator|</a></b> ( const QMailFolderKey & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const QMailFolderKey & </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#operator-7c-eq">operator|=</a></b> ( const QMailFolderKey & <i>other</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#operator-7e">operator~</a></b> () const</td></tr>
</table>
<hr />
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#ancestorFolderIds">ancestorFolderIds</a></b> ( const QMailFolderId & <i>id</i>, QMailDataComparator::InclusionComparator <i>cmp</i> = QMailDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#ancestorFolderIds-2">ancestorFolderIds</a></b> ( const QMailFolderIdList & <i>ids</i>, QMailDataComparator::InclusionComparator <i>cmp</i> = QMailDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#ancestorFolderIds-3">ancestorFolderIds</a></b> ( const QMailFolderKey & <i>key</i>, QMailDataComparator::InclusionComparator <i>cmp</i> = QMailDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#customField">customField</a></b> ( const QString & <i>name</i>, QMailDataComparator::PresenceComparator <i>cmp</i> = QMailDataComparator::Present )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#customField-2">customField</a></b> ( const QString & <i>name</i>, const QString & <i>value</i>, QMailDataComparator::EqualityComparator <i>cmp</i> = QMailDataComparator::Equal )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#customField-3">customField</a></b> ( const QString & <i>name</i>, const QString & <i>value</i>, QMailDataComparator::InclusionComparator <i>cmp</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#displayName">displayName</a></b> ( const QString & <i>value</i>, QMailDataComparator::EqualityComparator <i>cmp</i> = QMailDataComparator::Equal )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#displayName-2">displayName</a></b> ( const QString & <i>value</i>, QMailDataComparator::InclusionComparator <i>cmp</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#displayName-3">displayName</a></b> ( const QStringList & <i>values</i>, QMailDataComparator::InclusionComparator <i>cmp</i> = QMailDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#id">id</a></b> ( const QMailFolderId & <i>id</i>, QMailDataComparator::EqualityComparator <i>cmp</i> = QMailDataComparator::Equal )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#id-2">id</a></b> ( const QMailFolderIdList & <i>ids</i>, QMailDataComparator::InclusionComparator <i>cmp</i> = QMailDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#id-3">id</a></b> ( const QMailFolderKey & <i>key</i>, QMailDataComparator::InclusionComparator <i>cmp</i> = QMailDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#nonMatchingKey">nonMatchingKey</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#parentAccountId">parentAccountId</a></b> ( const QMailAccountId & <i>id</i>, QMailDataComparator::EqualityComparator <i>cmp</i> = QMailDataComparator::Equal )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#parentAccountId-2">parentAccountId</a></b> ( const QMailAccountIdList & <i>ids</i>, QMailDataComparator::InclusionComparator <i>cmp</i> = QMailDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#parentAccountId-3">parentAccountId</a></b> ( const QMailAccountKey & <i>key</i>, QMailDataComparator::InclusionComparator <i>cmp</i> = QMailDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#parentFolderId">parentFolderId</a></b> ( const QMailFolderId & <i>id</i>, QMailDataComparator::EqualityComparator <i>cmp</i> = QMailDataComparator::Equal )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#parentFolderId-2">parentFolderId</a></b> ( const QMailFolderIdList & <i>ids</i>, QMailDataComparator::InclusionComparator <i>cmp</i> = QMailDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#parentFolderId-3">parentFolderId</a></b> ( const QMailFolderKey & <i>key</i>, QMailDataComparator::InclusionComparator <i>cmp</i> = QMailDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#path">path</a></b> ( const QString & <i>value</i>, QMailDataComparator::EqualityComparator <i>cmp</i> = QMailDataComparator::Equal )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#path-2">path</a></b> ( const QString & <i>value</i>, QMailDataComparator::InclusionComparator <i>cmp</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#path-3">path</a></b> ( const QStringList & <i>values</i>, QMailDataComparator::InclusionComparator <i>cmp</i> = QMailDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#serverCount">serverCount</a></b> ( int <i>value</i>, QMailDataComparator::EqualityComparator <i>cmp</i> = QMailDataComparator::Equal )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#serverCount-2">serverCount</a></b> ( int <i>value</i>, QMailDataComparator::RelationComparator <i>cmp</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#serverUndiscoveredCount">serverUndiscoveredCount</a></b> ( int <i>value</i>, QMailDataComparator::EqualityComparator <i>cmp</i> = QMailDataComparator::Equal )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#serverUndiscoveredCount-2">serverUndiscoveredCount</a></b> ( int <i>value</i>, QMailDataComparator::RelationComparator <i>cmp</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#serverUnreadCount">serverUnreadCount</a></b> ( int <i>value</i>, QMailDataComparator::EqualityComparator <i>cmp</i> = QMailDataComparator::Equal )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#serverUnreadCount-2">serverUnreadCount</a></b> ( int <i>value</i>, QMailDataComparator::RelationComparator <i>cmp</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#status">status</a></b> ( quint64 <i>mask</i>, QMailDataComparator::InclusionComparator <i>cmp</i> = QMailDataComparator::Includes )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfolderkey.html#status-2">status</a></b> ( quint64 <i>value</i>, QMailDataComparator::EqualityComparator <i>cmp</i> )</td></tr>
</table>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QMailFolderKey class defines the parameters used for querying a subset of all available folders from the mail store.</p>
<p>A QMailFolderKey is composed of a folder property, an optional comparison operator and a comparison value. The QMailFolderKey class is used in conjunction with the <a href="qmailstore.html#queryFolders">QMailStore::queryFolders</a>() and <a href="qmailstore.html#countFolders">QMailStore::countFolders</a>() functions to filter results which meet the criteria defined by the key.</p>
<p>QMailFolderKey's can be combined using the logical operators (&), (|) and (~) to build more sophisticated queries.</p>
<p>For example:</p>
<p>To create a query for folders with paths containing "inbox" or "sms":</p>
<pre> QMailFolderKey inboxKey(QMailFolderKey::path("inbox", QMailDataComparator::Includes));
QMailFolderKey smsKey(QMailFolderKey::path("sms", QMailDataComparator::Includes));
QMailFolderIdList results = QMailStore::instance()->queryFolders(inboxKey | smsKey);</pre>
<p>To query all folders with name containing "foo" for a specified account:</p>
<pre> QMailFolderIdList fooFolders(const QMailAccountId& accountId)
{
QMailFolderKey nameKey(QMailFolderKey::displayName("foo", QMailDataComparator::Includes);
QMailFolderKey accountKey(QMailFolderKey::parentAccountId(accountId));
return QMailStore::instance()->queryFolders(nameKey & accountKey);
}</pre>
<p>See also <a href="qmailstore.html">QMailStore</a> and <a href="qmailfolder.html">QMailFolder</a>.</p>
<hr />
<h2>Member Type Documentation</h2>
<h3 class="fn"><a name="ArgumentType-typedef"></a>typedef QMailFolderKey::ArgumentType</h3>
<p>Defines the type used to represent a single criterion of a folder filter.</p>
<p>Synonym for <a href="qmailkeyargument.html">QMailKeyArgument</a><<a href="qmailfolderkey.html#Property-enum">QMailFolderKey::Property</a>>.</p>
<h3 class="fn"><a name="Property-enum"></a>enum QMailFolderKey::Property</h3>
<p>This enum type describes the queryable data properties of a <a href="qmailfolder.html">QMailFolder</a>.</p>
<p><table class="valuelist" border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QMailFolderKey::Id</tt></td><td align="center" valign="top"><tt>( 1<<0 )</tt></td><td valign="top">The ID of the folder.</td></tr>
<tr><td valign="top"><tt>QMailFolderKey::Path</tt></td><td align="center" valign="top"><tt>( 1<<1 )</tt></td><td valign="top">The path of the folder in native form.</td></tr>
<tr><td valign="top"><tt>QMailFolderKey::ParentFolderId</tt></td><td align="center" valign="top"><tt>( 1<<2 )</tt></td><td valign="top">The ID of the parent folder for a given folder.</td></tr>
<tr><td valign="top"><tt>QMailFolderKey::ParentAccountId</tt></td><td align="center" valign="top"><tt>( 1<<3 )</tt></td><td valign="top">The ID of the parent account for this folder.</td></tr>
<tr><td valign="top"><tt>QMailFolderKey::DisplayName</tt></td><td align="center" valign="top"><tt>( 1<<4 )</tt></td><td valign="top">The name of the folder, designed for display to users.</td></tr>
<tr><td valign="top"><tt>QMailFolderKey::Status</tt></td><td align="center" valign="top"><tt>( 1<<5 )</tt></td><td valign="top">The status value of the folder.</td></tr>
<tr><td valign="top"><tt>QMailFolderKey::AncestorFolderIds</tt></td><td align="center" valign="top"><tt>( 1<<6 )</tt></td><td valign="top">The set of IDs of folders which are direct or indirect parents of this folder.</td></tr>
<tr><td valign="top"><tt>QMailFolderKey::ServerCount</tt></td><td align="center" valign="top"><tt>( 1<<7 )</tt></td><td valign="top">The number of messages reported to be on the server for the folder.</td></tr>
<tr><td valign="top"><tt>QMailFolderKey::ServerUnreadCount</tt></td><td align="center" valign="top"><tt>( 1<<8 )</tt></td><td valign="top">The number of unread messages reported to be on the server for the folder.</td></tr>
<tr><td valign="top"><tt>QMailFolderKey::ServerUndiscoveredCount</tt></td><td align="center" valign="top"><tt>( 1<<9 )</tt></td><td valign="top">The number of undiscovered messages reported to be on the server for the folder.</td></tr>
<tr><td valign="top"><tt>QMailFolderKey::Custom</tt></td><td align="center" valign="top"><tt>( 1<<10 )</tt></td><td valign="top">The custom fields of the folder.</td></tr>
</table></p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QMailFolderKey"></a>QMailFolderKey::QMailFolderKey ()</h3>
<p>Creates a <a href="qmailfolderkey.html">QMailFolderKey</a> without specifying matching parameters.</p>
<p>A default-constructed key (one for which <a href="qmailfolderkey.html#isEmpty">isEmpty</a>() returns true) matches all folders.</p>
<p>See also <a href="qmailfolderkey.html#isEmpty">isEmpty</a>().</p>
<h3 class="fn"><a name="QMailFolderKey-2"></a>QMailFolderKey::QMailFolderKey ( const QMailFolderKey & <i>other</i> )</h3>
<p>Creates a copy of the <a href="qmailfolderkey.html">QMailFolderKey</a> <i>other</i>.</p>
<h3 class="fn"><a name="dtor.QMailFolderKey"></a>QMailFolderKey::~QMailFolderKey () <tt> [virtual]</tt></h3>
<p>Destroys this <a href="qmailfolderkey.html">QMailFolderKey</a>.</p>
<h3 class="fn"><a name="ancestorFolderIds"></a>QMailFolderKey QMailFolderKey::ancestorFolderIds ( const <a href="qmailfolderid.html">QMailFolderId</a> & <i>id</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> = QMailDataComparator::Includes ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose ancestor folders' identifiers contain <i>id</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#parentFolderId">QMailFolder::parentFolderId</a>().</p>
<h3 class="fn"><a name="ancestorFolderIds-2"></a>QMailFolderKey QMailFolderKey::ancestorFolderIds ( const <a href="qmailfolderid.html#QMailFolderIdList-typedef">QMailFolderIdList</a> & <i>ids</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> = QMailDataComparator::Includes ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose ancestor folders' identifiers contain a member of <i>ids</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#parentFolderId">QMailFolder::parentFolderId</a>().</p>
<h3 class="fn"><a name="ancestorFolderIds-3"></a>QMailFolderKey QMailFolderKey::ancestorFolderIds ( const QMailFolderKey & <i>key</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> = QMailDataComparator::Includes ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose ancestor folders' identifiers contain a member of the set yielded by <i>key</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#parentFolderId">QMailFolder::parentFolderId</a>().</p>
<h3 class="fn"><a name="arguments"></a>const <a href="http://doc.trolltech.com/4.5/qlist.html">QList</a><<a href="qmailfolderkey.html#ArgumentType-typedef">ArgumentType</a>> & QMailFolderKey::arguments () const</h3>
<p>Returns the list of arguments to this <a href="qmailfolderkey.html">QMailFolderKey</a>.</p>
<h3 class="fn"><a name="combiner"></a><a href="qmailkey.html#Combiner-enum">QMailKey::Combiner</a> QMailFolderKey::combiner () const</h3>
<p>Returns the combiner used to combine arguments or sub keys of this <a href="qmailfolderkey.html">QMailFolderKey</a>.</p>
<h3 class="fn"><a name="customField"></a>QMailFolderKey QMailFolderKey::customField ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>name</i>, <a href="qmaildatacomparator.html#PresenceComparator-enum">QMailDataComparator::PresenceComparator</a> <i>cmp</i> = QMailDataComparator::Present ) <tt> [static]</tt></h3>
<p>Returns a key matching folders that possess a custom field with the name <i>name</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#customField">QMailFolder::customField</a>().</p>
<h3 class="fn"><a name="customField-2"></a>QMailFolderKey QMailFolderKey::customField ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>name</i>, const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>value</i>, <a href="qmaildatacomparator.html#EqualityComparator-enum">QMailDataComparator::EqualityComparator</a> <i>cmp</i> = QMailDataComparator::Equal ) <tt> [static]</tt></h3>
<p>Returns a key matching folders that possess a custom field with the name <i>name</i>, whose value matches <i>value</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#customField">QMailFolder::customField</a>().</p>
<h3 class="fn"><a name="customField-3"></a>QMailFolderKey QMailFolderKey::customField ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>name</i>, const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>value</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> ) <tt> [static]</tt></h3>
<p>Returns a key matching folders that possess a custom field with the name <i>name</i>, whose value matches the substring <i>value</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#customField">QMailFolder::customField</a>().</p>
<h3 class="fn"><a name="deserialize"></a>void QMailFolderKey::deserialize ( Stream & <i>stream</i> )</h3>
<p>Reads the contents of a <a href="qmailfolderkey.html">QMailFolderKey</a> from <i>stream</i>.</p>
<h3 class="fn"><a name="displayName"></a>QMailFolderKey QMailFolderKey::displayName ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>value</i>, <a href="qmaildatacomparator.html#EqualityComparator-enum">QMailDataComparator::EqualityComparator</a> <i>cmp</i> = QMailDataComparator::Equal ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose display name matches <i>value</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#displayName">QMailFolder::displayName</a>().</p>
<h3 class="fn"><a name="displayName-2"></a>QMailFolderKey QMailFolderKey::displayName ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>value</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose display name matches the substring <i>value</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#displayName">QMailFolder::displayName</a>().</p>
<h3 class="fn"><a name="displayName-3"></a>QMailFolderKey QMailFolderKey::displayName ( const <a href="http://doc.trolltech.com/4.5/qstringlist.html">QStringList</a> & <i>values</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> = QMailDataComparator::Includes ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose display name is a member of <i>values</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#displayName">QMailFolder::displayName</a>().</p>
<h3 class="fn"><a name="id"></a>QMailFolderKey QMailFolderKey::id ( const <a href="qmailfolderid.html">QMailFolderId</a> & <i>id</i>, <a href="qmaildatacomparator.html#EqualityComparator-enum">QMailDataComparator::EqualityComparator</a> <i>cmp</i> = QMailDataComparator::Equal ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose identifier matches <i>id</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#id">QMailFolder::id</a>().</p>
<h3 class="fn"><a name="id-2"></a>QMailFolderKey QMailFolderKey::id ( const <a href="qmailfolderid.html#QMailFolderIdList-typedef">QMailFolderIdList</a> & <i>ids</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> = QMailDataComparator::Includes ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose identifier is a member of <i>ids</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#id">QMailFolder::id</a>().</p>
<h3 class="fn"><a name="id-3"></a>QMailFolderKey QMailFolderKey::id ( const QMailFolderKey & <i>key</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> = QMailDataComparator::Includes ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose identifier is a member of the set yielded by <i>key</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#id">QMailFolder::id</a>().</p>
<h3 class="fn"><a name="isEmpty"></a>bool QMailFolderKey::isEmpty () const</h3>
<p>Returns true if the key remains empty after default construction; otherwise returns false.</p>
<p>An empty key matches all folders.</p>
<p>The result of combining an empty key with a non-empty key is the original non-empty key. This is true regardless of whether the combination is formed by an AND or an OR operation.</p>
<p>The result of combining two empty keys is an empty key.</p>
<p>See also <a href="qmailfolderkey.html#isNonMatching">isNonMatching</a>().</p>
<h3 class="fn"><a name="isNegated"></a>bool QMailFolderKey::isNegated () const</h3>
<p>Returns true if the key's criteria should be negated in application.</p>
<h3 class="fn"><a name="isNonMatching"></a>bool QMailFolderKey::isNonMatching () const</h3>
<p>Returns true if the key is a non-matching key; otherwise returns false.</p>
<p>A non-matching key does not match any folders.</p>
<p>The result of ANDing a non-matching key with a matching key is a non-matching key. The result of ORing a non-matching key with a matching key is the original matching key.</p>
<p>The result of combining two non-matching keys is a non-matching key.</p>
<p>See also <a href="qmailfolderkey.html#nonMatchingKey">nonMatchingKey</a>() and <a href="qmailfolderkey.html#isEmpty">isEmpty</a>().</p>
<h3 class="fn"><a name="nonMatchingKey"></a>QMailFolderKey QMailFolderKey::nonMatchingKey () <tt> [static]</tt></h3>
<p>Returns a key that does not match any folders (unlike an empty key).</p>
<p>See also <a href="qmailfolderkey.html#isNonMatching">isNonMatching</a>() and <a href="qmailfolderkey.html#isEmpty">isEmpty</a>().</p>
<h3 class="fn"><a name="parentAccountId"></a>QMailFolderKey QMailFolderKey::parentAccountId ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>id</i>, <a href="qmaildatacomparator.html#EqualityComparator-enum">QMailDataComparator::EqualityComparator</a> <i>cmp</i> = QMailDataComparator::Equal ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose parent account's identifier matches <i>id</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#parentAccountId">QMailFolder::parentAccountId</a>().</p>
<h3 class="fn"><a name="parentAccountId-2"></a>QMailFolderKey QMailFolderKey::parentAccountId ( const <a href="qmailaccountid.html#QMailAccountIdList-typedef">QMailAccountIdList</a> & <i>ids</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> = QMailDataComparator::Includes ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose parent account's identifier is a member of <i>ids</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#parentAccountId">QMailFolder::parentAccountId</a>().</p>
<h3 class="fn"><a name="parentAccountId-3"></a>QMailFolderKey QMailFolderKey::parentAccountId ( const <a href="qmailaccountkey.html">QMailAccountKey</a> & <i>key</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> = QMailDataComparator::Includes ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose parent account's identifier is a member of the set yielded by <i>key</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#parentAccountId">QMailFolder::parentAccountId</a>().</p>
<h3 class="fn"><a name="parentFolderId"></a>QMailFolderKey QMailFolderKey::parentFolderId ( const <a href="qmailfolderid.html">QMailFolderId</a> & <i>id</i>, <a href="qmaildatacomparator.html#EqualityComparator-enum">QMailDataComparator::EqualityComparator</a> <i>cmp</i> = QMailDataComparator::Equal ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose parent folder's identifier matches <i>id</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#parentFolderId">QMailFolder::parentFolderId</a>().</p>
<h3 class="fn"><a name="parentFolderId-2"></a>QMailFolderKey QMailFolderKey::parentFolderId ( const <a href="qmailfolderid.html#QMailFolderIdList-typedef">QMailFolderIdList</a> & <i>ids</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> = QMailDataComparator::Includes ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose parent folder's identifier is a member of <i>ids</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#parentFolderId">QMailFolder::parentFolderId</a>().</p>
<h3 class="fn"><a name="parentFolderId-3"></a>QMailFolderKey QMailFolderKey::parentFolderId ( const QMailFolderKey & <i>key</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> = QMailDataComparator::Includes ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose parent folder's identifier is a member of the set yielded by <i>key</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#parentFolderId">QMailFolder::parentFolderId</a>().</p>
<h3 class="fn"><a name="path"></a>QMailFolderKey QMailFolderKey::path ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>value</i>, <a href="qmaildatacomparator.html#EqualityComparator-enum">QMailDataComparator::EqualityComparator</a> <i>cmp</i> = QMailDataComparator::Equal ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose path matches <i>value</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#path">QMailFolder::path</a>().</p>
<h3 class="fn"><a name="path-2"></a>QMailFolderKey QMailFolderKey::path ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>value</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose path matches the substring <i>value</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#path">QMailFolder::path</a>().</p>
<h3 class="fn"><a name="path-3"></a>QMailFolderKey QMailFolderKey::path ( const <a href="http://doc.trolltech.com/4.5/qstringlist.html">QStringList</a> & <i>values</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> = QMailDataComparator::Includes ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose path is a member of <i>values</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#path">QMailFolder::path</a>().</p>
<h3 class="fn"><a name="serialize"></a>void QMailFolderKey::serialize ( Stream & <i>stream</i> ) const</h3>
<p>Writes the contents of a <a href="qmailfolderkey.html">QMailFolderKey</a> to a <i>stream</i>.</p>
<h3 class="fn"><a name="serverCount"></a>QMailFolderKey QMailFolderKey::serverCount ( int <i>value</i>, <a href="qmaildatacomparator.html#EqualityComparator-enum">QMailDataComparator::EqualityComparator</a> <i>cmp</i> = QMailDataComparator::Equal ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose serverCount matches <i>value</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#serverCount">QMailFolder::serverCount</a>().</p>
<h3 class="fn"><a name="serverCount-2"></a>QMailFolderKey QMailFolderKey::serverCount ( int <i>value</i>, <a href="qmaildatacomparator.html#RelationComparator-enum">QMailDataComparator::RelationComparator</a> <i>cmp</i> ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose serverCount has the relation to <i>value</i> that is specified by <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#serverCount">QMailFolder::serverCount</a>().</p>
<h3 class="fn"><a name="serverUndiscoveredCount"></a>QMailFolderKey QMailFolderKey::serverUndiscoveredCount ( int <i>value</i>, <a href="qmaildatacomparator.html#EqualityComparator-enum">QMailDataComparator::EqualityComparator</a> <i>cmp</i> = QMailDataComparator::Equal ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose serverUndiscoveredCount matches <i>value</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#serverUndiscoveredCount">QMailFolder::serverUndiscoveredCount</a>().</p>
<h3 class="fn"><a name="serverUndiscoveredCount-2"></a>QMailFolderKey QMailFolderKey::serverUndiscoveredCount ( int <i>value</i>, <a href="qmaildatacomparator.html#RelationComparator-enum">QMailDataComparator::RelationComparator</a> <i>cmp</i> ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose serverUndiscoveredCount has the relation to <i>value</i> that is specified by <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#serverUndiscoveredCount">QMailFolder::serverUndiscoveredCount</a>().</p>
<h3 class="fn"><a name="serverUnreadCount"></a>QMailFolderKey QMailFolderKey::serverUnreadCount ( int <i>value</i>, <a href="qmaildatacomparator.html#EqualityComparator-enum">QMailDataComparator::EqualityComparator</a> <i>cmp</i> = QMailDataComparator::Equal ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose serverUnreadCount matches <i>value</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#serverUnreadCount">QMailFolder::serverUnreadCount</a>().</p>
<h3 class="fn"><a name="serverUnreadCount-2"></a>QMailFolderKey QMailFolderKey::serverUnreadCount ( int <i>value</i>, <a href="qmaildatacomparator.html#RelationComparator-enum">QMailDataComparator::RelationComparator</a> <i>cmp</i> ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose serverUnreadCount has the relation to <i>value</i> that is specified by <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#serverUnreadCount">QMailFolder::serverUnreadCount</a>().</p>
<h3 class="fn"><a name="status"></a>QMailFolderKey QMailFolderKey::status ( <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>mask</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> = QMailDataComparator::Includes ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose status is a bitwise match to <i>mask</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#status">QMailFolder::status</a>().</p>
<h3 class="fn"><a name="status-2"></a>QMailFolderKey QMailFolderKey::status ( <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>value</i>, <a href="qmaildatacomparator.html#EqualityComparator-enum">QMailDataComparator::EqualityComparator</a> <i>cmp</i> ) <tt> [static]</tt></h3>
<p>Returns a key matching folders whose status matches <i>value</i>, according to <i>cmp</i>.</p>
<p>See also <a href="qmailfolder.html#status">QMailFolder::status</a>().</p>
<h3 class="fn"><a name="subKeys"></a>const <a href="http://doc.trolltech.com/4.5/qlist.html">QList</a><QMailFolderKey> & QMailFolderKey::subKeys () const</h3>
<p>Returns the list of sub keys held by this <a href="qmailfolderkey.html">QMailFolderKey</a>.</p>
<h3 class="fn"><a name="operator-QVariant"></a>QMailFolderKey::operator QVariant () const</h3>
<p>Returns the <a href="http://doc.trolltech.com/4.5/qvariant.html">QVariant</a> representation of this <a href="qmailfolderkey.html">QMailFolderKey</a>.</p>
<h3 class="fn"><a name="operator-not-eq"></a>bool QMailFolderKey::operator!= ( const QMailFolderKey & <i>other</i> ) const</h3>
<p>Returns <tt>true</tt> if the value of this key is not the same as the key <i>other</i>. Returns <tt>false</tt> otherwise.</p>
<h3 class="fn"><a name="operator-and"></a>QMailFolderKey QMailFolderKey::operator& ( const QMailFolderKey & <i>other</i> ) const</h3>
<p>Returns a key that is the logical AND of this key and the value of key <i>other</i>.</p>
<h3 class="fn"><a name="operator-and-eq"></a>const QMailFolderKey & QMailFolderKey::operator&= ( const QMailFolderKey & <i>other</i> )</h3>
<p>Performs a logical AND with this key and the key <i>other</i> and assigns the result to this key.</p>
<h3 class="fn"><a name="operator-eq"></a>const QMailFolderKey & QMailFolderKey::operator= ( const QMailFolderKey & <i>other</i> )</h3>
<p>Assign the value of the <a href="qmailfolderkey.html">QMailFolderKey</a> <i>other</i> to this.</p>
<h3 class="fn"><a name="operator-eq-eq"></a>bool QMailFolderKey::operator== ( const QMailFolderKey & <i>other</i> ) const</h3>
<p>Returns <tt>true</tt> if the value of this key is the same as the key <i>other</i>. Returns <tt>false</tt> otherwise.</p>
<h3 class="fn"><a name="operator-7c"></a>QMailFolderKey QMailFolderKey::operator| ( const QMailFolderKey & <i>other</i> ) const</h3>
<p>Returns a key that is the logical OR of this key and the value of key <i>other</i>.</p>
<h3 class="fn"><a name="operator-7c-eq"></a>const QMailFolderKey & QMailFolderKey::operator|= ( const QMailFolderKey & <i>other</i> )</h3>
<p>Performs a logical OR with this key and the key <i>other</i> and assigns the result to this key.</p>
<h3 class="fn"><a name="operator-7e"></a>QMailFolderKey QMailFolderKey::operator~ () const</h3>
<p>Returns a key that is the logical NOT of the value of this key.</p>
<p>If this key is empty, the result will be a non-matching key; if this key is non-matching, the result will be an empty key.</p>
<p>See also <a href="qmailfolderkey.html#isEmpty">isEmpty</a>() and <a href="qmailfolderkey.html#isNonMatching">isNonMatching</a>().</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td align="left">Copyright © 2010 QtSoftware</td>
<td align="right"><div align="right">Messaging Framework</div></td>
</tr></table></div></address></body>
</html>
|