/usr/share/doc/qmf/html/qmailfoldersortkey.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 | <?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">
<!-- qmailfoldersortkey.cpp -->
<head>
<title>QMailFolderSortKey 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">QMailFolderSortKey Class Reference</h1>
<p>The QMailFolderSortKey class defines the parameters used for sorting a subset of queried folders from the mail store. <a href="#details">More...</a></p>
<pre> #include <QMailFolderSortKey></pre><p><b>This class is under development and is subject to change.</b></p>
<ul>
<li><a href="qmailfoldersortkey-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="qmailfoldersortkey.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="qmailfoldersortkey.html#Property-enum">Property</a></b> { Id, Path, ParentFolderId, ParentAccountId, ..., ServerUndiscoveredCount }</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="qmailfoldersortkey.html#QMailFolderSortKey">QMailFolderSortKey</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#QMailFolderSortKey-2">QMailFolderSortKey</a></b> ( const QMailFolderSortKey & <i>other</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#dtor.QMailFolderSortKey">~QMailFolderSortKey</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const QList<ArgumentType> & </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#arguments">arguments</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.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="qmailfoldersortkey.html#isEmpty">isEmpty</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#serialize">serialize</a></b> ( Stream & <i>stream</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#operator-not-eq">operator!=</a></b> ( const QMailFolderSortKey & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderSortKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#operator-and">operator&</a></b> ( const QMailFolderSortKey & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderSortKey & </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#operator-and-eq">operator&=</a></b> ( const QMailFolderSortKey & <i>other</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderSortKey & </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#operator-eq">operator=</a></b> ( const QMailFolderSortKey & <i>other</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#operator-eq-eq">operator==</a></b> ( const QMailFolderSortKey & <i>other</i> ) 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">QMailFolderSortKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#displayName">displayName</a></b> ( Qt::SortOrder <i>order</i> = Qt::AscendingOrder )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderSortKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#id">id</a></b> ( Qt::SortOrder <i>order</i> = Qt::AscendingOrder )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderSortKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#parentAccountId">parentAccountId</a></b> ( Qt::SortOrder <i>order</i> = Qt::AscendingOrder )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderSortKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#parentFolderId">parentFolderId</a></b> ( Qt::SortOrder <i>order</i> = Qt::AscendingOrder )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderSortKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#path">path</a></b> ( Qt::SortOrder <i>order</i> = Qt::AscendingOrder )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderSortKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#serverCount">serverCount</a></b> ( Qt::SortOrder <i>order</i> = Qt::AscendingOrder )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderSortKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#serverUndiscoveredCount">serverUndiscoveredCount</a></b> ( Qt::SortOrder <i>order</i> = Qt::AscendingOrder )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderSortKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#serverUnreadCount">serverUnreadCount</a></b> ( Qt::SortOrder <i>order</i> = Qt::AscendingOrder )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderSortKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldersortkey.html#status">status</a></b> ( quint64 <i>mask</i>, Qt::SortOrder <i>order</i> = Qt::DescendingOrder )</td></tr>
</table>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QMailFolderSortKey class defines the parameters used for sorting a subset of queried folders from the mail store.</p>
<p>A QMailFolderSortKey is composed of a folder property to sort and a sort order. The QMailFolderSortKey class is used in conjunction with the <a href="qmailstore.html#queryFolders">QMailStore::queryFolders</a>() function to sort folder results according to the criteria defined by the sort key.</p>
<p>For example: To create a query for all folders sorted by the path in ascending order:</p>
<pre> QMailFolderSortKey sortKey(QMailFolderSortKey::path(Qt::Ascending));
QMailIdList results = QMailStore::instance()->queryFolders(QMailFolderKey(), sortKey);</pre>
<p>See also <a href="qmailstore.html">QMailStore</a> and <a href="qmailfolderkey.html">QMailFolderKey</a>.</p>
<hr />
<h2>Member Type Documentation</h2>
<h3 class="fn"><a name="ArgumentType-typedef"></a>typedef QMailFolderSortKey::ArgumentType</h3>
<p>Defines the type used to represent a single sort criterion of a folder sort key.</p>
<h3 class="fn"><a name="Property-enum"></a>enum QMailFolderSortKey::Property</h3>
<p>This enum type describes the sortable 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>QMailFolderSortKey::Id</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">The ID of the folder.</td></tr>
<tr><td valign="top"><tt>QMailFolderSortKey::Path</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">The path of the folder in native form.</td></tr>
<tr><td valign="top"><tt>QMailFolderSortKey::ParentFolderId</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top">The ID of the parent folder for a given folder.</td></tr>
<tr><td valign="top"><tt>QMailFolderSortKey::ParentAccountId</tt></td><td align="center" valign="top"><tt>3</tt></td><td valign="top">The ID of the parent account for a given folder.</td></tr>
<tr><td valign="top"><tt>QMailFolderSortKey::DisplayName</tt></td><td align="center" valign="top"><tt>4</tt></td><td valign="top">The name of the folder, designed for display to users.</td></tr>
<tr><td valign="top"><tt>QMailFolderSortKey::Status</tt></td><td align="center" valign="top"><tt>5</tt></td><td valign="top">The status value of the folder.</td></tr>
<tr><td valign="top"><tt>QMailFolderSortKey::ServerCount</tt></td><td align="center" valign="top"><tt>6</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>QMailFolderSortKey::ServerUnreadCount</tt></td><td align="center" valign="top"><tt>7</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>QMailFolderSortKey::ServerUndiscoveredCount</tt></td><td align="center" valign="top"><tt>8</tt></td><td valign="top">The number of undiscovered messages reported to be on the server for the folder.</td></tr>
</table></p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QMailFolderSortKey"></a>QMailFolderSortKey::QMailFolderSortKey ()</h3>
<p>Create a <a href="qmailfoldersortkey.html">QMailFolderSortKey</a> with specifying matching parameters.</p>
<p>A default-constructed key (one for which <a href="qmailfoldersortkey.html#isEmpty">isEmpty</a>() returns true) sorts no folders.</p>
<p>The result of combining an empty key with a non-empty key is the same as the original non-empty key.</p>
<p>The result of combining two empty keys is an empty key.</p>
<h3 class="fn"><a name="QMailFolderSortKey-2"></a>QMailFolderSortKey::QMailFolderSortKey ( const QMailFolderSortKey & <i>other</i> )</h3>
<p>Create a copy of the <a href="qmailfoldersortkey.html">QMailFolderSortKey</a> <i>other</i>.</p>
<h3 class="fn"><a name="dtor.QMailFolderSortKey"></a>QMailFolderSortKey::~QMailFolderSortKey () <tt> [virtual]</tt></h3>
<p>Destroys this <a href="qmailfoldersortkey.html">QMailFolderSortKey</a>.</p>
<h3 class="fn"><a name="arguments"></a>const <a href="http://doc.trolltech.com/4.5/qlist.html">QList</a><<a href="qmailfoldersortkey.html#ArgumentType-typedef">ArgumentType</a>> & QMailFolderSortKey::arguments () const</h3>
<p>Returns the list of arguments to this <a href="qmailfoldersortkey.html">QMailFolderSortKey</a>.</p>
<h3 class="fn"><a name="deserialize"></a>void QMailFolderSortKey::deserialize ( Stream & <i>stream</i> )</h3>
<p>Reads the contents of a <a href="qmailfoldersortkey.html">QMailFolderSortKey</a> from <i>stream</i>.</p>
<h3 class="fn"><a name="displayName"></a>QMailFolderSortKey QMailFolderSortKey::displayName ( <a href="http://doc.trolltech.com/4.5/qt.html#SortOrder-enum">Qt::SortOrder</a> <i>order</i> = Qt::AscendingOrder ) <tt> [static]</tt></h3>
<p>Returns a key that sorts folders by their display name, according to <i>order</i>.</p>
<p>See also <a href="qmailfolder.html#displayName">QMailFolder::displayName</a>().</p>
<h3 class="fn"><a name="id"></a>QMailFolderSortKey QMailFolderSortKey::id ( <a href="http://doc.trolltech.com/4.5/qt.html#SortOrder-enum">Qt::SortOrder</a> <i>order</i> = Qt::AscendingOrder ) <tt> [static]</tt></h3>
<p>Returns a key that sorts folders by their identifiers, according to <i>order</i>.</p>
<p>See also <a href="qmailfolder.html#id">QMailFolder::id</a>().</p>
<h3 class="fn"><a name="isEmpty"></a>bool QMailFolderSortKey::isEmpty () const</h3>
<p>Returns true if the key remains empty after default construction; otherwise returns false.</p>
<h3 class="fn"><a name="parentAccountId"></a>QMailFolderSortKey QMailFolderSortKey::parentAccountId ( <a href="http://doc.trolltech.com/4.5/qt.html#SortOrder-enum">Qt::SortOrder</a> <i>order</i> = Qt::AscendingOrder ) <tt> [static]</tt></h3>
<p>Returns a key that sorts folders by their parent accounts' identifiers, according to <i>order</i>.</p>
<p>See also <a href="qmailfolder.html#parentAccountId">QMailFolder::parentAccountId</a>().</p>
<h3 class="fn"><a name="parentFolderId"></a>QMailFolderSortKey QMailFolderSortKey::parentFolderId ( <a href="http://doc.trolltech.com/4.5/qt.html#SortOrder-enum">Qt::SortOrder</a> <i>order</i> = Qt::AscendingOrder ) <tt> [static]</tt></h3>
<p>Returns a key that sorts folders by their parent folders' identifiers, according to <i>order</i>.</p>
<p>See also <a href="qmailfolder.html#parentFolderId">QMailFolder::parentFolderId</a>().</p>
<h3 class="fn"><a name="path"></a>QMailFolderSortKey QMailFolderSortKey::path ( <a href="http://doc.trolltech.com/4.5/qt.html#SortOrder-enum">Qt::SortOrder</a> <i>order</i> = Qt::AscendingOrder ) <tt> [static]</tt></h3>
<p>Returns a key that sorts folders by their paths, according to <i>order</i>.</p>
<p>See also <a href="qmailfolder.html#path">QMailFolder::path</a>().</p>
<h3 class="fn"><a name="serialize"></a>void QMailFolderSortKey::serialize ( Stream & <i>stream</i> ) const</h3>
<p>Writes the contents of a <a href="qmailfoldersortkey.html">QMailFolderSortKey</a> to a <i>stream</i>.</p>
<h3 class="fn"><a name="serverCount"></a>QMailFolderSortKey QMailFolderSortKey::serverCount ( <a href="http://doc.trolltech.com/4.5/qt.html#SortOrder-enum">Qt::SortOrder</a> <i>order</i> = Qt::AscendingOrder ) <tt> [static]</tt></h3>
<p>Returns a key that sorts folders by their message count on server, according to <i>order</i>.</p>
<p>See also <a href="qmailfolder.html#status">QMailFolder::status</a>().</p>
<h3 class="fn"><a name="serverUndiscoveredCount"></a>QMailFolderSortKey QMailFolderSortKey::serverUndiscoveredCount ( <a href="http://doc.trolltech.com/4.5/qt.html#SortOrder-enum">Qt::SortOrder</a> <i>order</i> = Qt::AscendingOrder ) <tt> [static]</tt></h3>
<p>Returns a key that sorts folders by their message undiscovered count on server, according to <i>order</i>.</p>
<p>See also <a href="qmailfolder.html#status">QMailFolder::status</a>().</p>
<h3 class="fn"><a name="serverUnreadCount"></a>QMailFolderSortKey QMailFolderSortKey::serverUnreadCount ( <a href="http://doc.trolltech.com/4.5/qt.html#SortOrder-enum">Qt::SortOrder</a> <i>order</i> = Qt::AscendingOrder ) <tt> [static]</tt></h3>
<p>Returns a key that sorts folders by their message unread count on server, according to <i>order</i>.</p>
<p>See also <a href="qmailfolder.html#status">QMailFolder::status</a>().</p>
<h3 class="fn"><a name="status"></a>QMailFolderSortKey QMailFolderSortKey::status ( <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>mask</i>, <a href="http://doc.trolltech.com/4.5/qt.html#SortOrder-enum">Qt::SortOrder</a> <i>order</i> = Qt::DescendingOrder ) <tt> [static]</tt></h3>
<p>Returns a key that sorts folders by comparing their status value bitwise ANDed with <i>mask</i>, according to <i>order</i>.</p>
<p>See also <a href="qmailfolder.html#status">QMailFolder::status</a>().</p>
<h3 class="fn"><a name="operator-not-eq"></a>bool QMailFolderSortKey::operator!= ( const QMailFolderSortKey & <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>QMailFolderSortKey QMailFolderSortKey::operator& ( const QMailFolderSortKey & <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>QMailFolderSortKey & QMailFolderSortKey::operator&= ( const QMailFolderSortKey & <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>QMailFolderSortKey & QMailFolderSortKey::operator= ( const QMailFolderSortKey & <i>other</i> )</h3>
<p>Assign the value of the <a href="qmailfoldersortkey.html">QMailFolderSortKey</a> <i>other</i> to this.</p>
<h3 class="fn"><a name="operator-eq-eq"></a>bool QMailFolderSortKey::operator== ( const QMailFolderSortKey & <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>
<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>
|