/usr/share/doc/qmf/html/qmailaccountsortkey.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 | <?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">
<!-- qmailaccountsortkey.cpp -->
<head>
<title>QMailAccountSortKey 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">QMailAccountSortKey Class Reference</h1>
<p>The QMailAccountSortKey class defines the parameters used for sorting a subset of queried accounts from the store. <a href="#details">More...</a></p>
<pre> #include <QMailAccountSortKey></pre><p><b>This class is under development and is subject to change.</b></p>
<ul>
<li><a href="qmailaccountsortkey-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="qmailaccountsortkey.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="qmailaccountsortkey.html#Property-enum">Property</a></b> { Id, Name, MessageType, Status, LastSynchronized }</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="qmailaccountsortkey.html#QMailAccountSortKey">QMailAccountSortKey</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountsortkey.html#QMailAccountSortKey-2">QMailAccountSortKey</a></b> ( const QMailAccountSortKey & <i>other</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountsortkey.html#dtor.QMailAccountSortKey">~QMailAccountSortKey</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const QList<ArgumentType> & </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountsortkey.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="qmailaccountsortkey.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="qmailaccountsortkey.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="qmailaccountsortkey.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="qmailaccountsortkey.html#operator-not-eq">operator!=</a></b> ( const QMailAccountSortKey & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailAccountSortKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountsortkey.html#operator-and">operator&</a></b> ( const QMailAccountSortKey & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailAccountSortKey & </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountsortkey.html#operator-and-eq">operator&=</a></b> ( const QMailAccountSortKey & <i>other</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailAccountSortKey & </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountsortkey.html#operator-eq">operator=</a></b> ( const QMailAccountSortKey & <i>other</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountsortkey.html#operator-eq-eq">operator==</a></b> ( const QMailAccountSortKey & <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">QMailAccountSortKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountsortkey.html#id">id</a></b> ( Qt::SortOrder <i>order</i> = Qt::AscendingOrder )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailAccountSortKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountsortkey.html#lastSynchronized">lastSynchronized</a></b> ( Qt::SortOrder <i>order</i> = Qt::AscendingOrder )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailAccountSortKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountsortkey.html#messageType">messageType</a></b> ( Qt::SortOrder <i>order</i> = Qt::AscendingOrder )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailAccountSortKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountsortkey.html#name">name</a></b> ( Qt::SortOrder <i>order</i> = Qt::AscendingOrder )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailAccountSortKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountsortkey.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 QMailAccountSortKey class defines the parameters used for sorting a subset of queried accounts from the store.</p>
<p>A QMailAccountSortKey is composed of an account property to sort and a sort order. The QMailAccountSortKey class is used in conjunction with the QMailStore::query() function to sort account results according to the criteria defined by the sort key.</p>
<p>For example: To create a query for all accounts sorted by the name in ascending order:</p>
<pre> QMailAccountSortKey sortNameKey(QMailAccountSortKey::name(Qt::Ascending));
QMailAccountIdList results = QMailStore::instance()->query(sortNameKey);</pre>
<p>See also <a href="qmailstore.html">QMailStore</a>.</p>
<hr />
<h2>Member Type Documentation</h2>
<h3 class="fn"><a name="ArgumentType-typedef"></a>typedef QMailAccountSortKey::ArgumentType</h3>
<p>Defines the type used to represent a single sort criterion of an account sort key.</p>
<h3 class="fn"><a name="Property-enum"></a>enum QMailAccountSortKey::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>QMailAccountSortKey::Id</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">The ID of the account.</td></tr>
<tr><td valign="top"><tt>QMailAccountSortKey::Name</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">The name of the account.</td></tr>
<tr><td valign="top"><tt>QMailAccountSortKey::MessageType</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top">The type of messages handled by the account.</td></tr>
<tr><td valign="top"><tt>QMailAccountSortKey::Status</tt></td><td align="center" valign="top"><tt>3</tt></td><td valign="top">The status value of the account.</td></tr>
<tr><td valign="top"><tt>QMailAccountSortKey::LastSynchronized</tt></td><td align="center" valign="top"><tt>4</tt></td><td valign="top">The most recent time that a check for new mail in all folders of the account was completed successfully.</td></tr>
</table></p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QMailAccountSortKey"></a>QMailAccountSortKey::QMailAccountSortKey ()</h3>
<p>Create a <a href="qmailaccountsortkey.html">QMailAccountSortKey</a> with specifying matching parameters.</p>
<p>A default-constructed key (one for which <a href="qmailaccountsortkey.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="QMailAccountSortKey-2"></a>QMailAccountSortKey::QMailAccountSortKey ( const QMailAccountSortKey & <i>other</i> )</h3>
<p>Create a copy of the <a href="qmailaccountsortkey.html">QMailAccountSortKey</a> <i>other</i>.</p>
<h3 class="fn"><a name="dtor.QMailAccountSortKey"></a>QMailAccountSortKey::~QMailAccountSortKey () <tt> [virtual]</tt></h3>
<p>Destroys this <a href="qmailaccountsortkey.html">QMailAccountSortKey</a>.</p>
<h3 class="fn"><a name="arguments"></a>const <a href="http://doc.trolltech.com/4.5/qlist.html">QList</a><<a href="qmailaccountsortkey.html#ArgumentType-typedef">ArgumentType</a>> & QMailAccountSortKey::arguments () const</h3>
<p>Returns the list of arguments to this <a href="qmailaccountsortkey.html">QMailAccountSortKey</a>.</p>
<h3 class="fn"><a name="deserialize"></a>void QMailAccountSortKey::deserialize ( Stream & <i>stream</i> )</h3>
<p>Reads the contents of a <a href="qmailaccountsortkey.html">QMailAccountSortKey</a> from <i>stream</i>.</p>
<h3 class="fn"><a name="id"></a>QMailAccountSortKey QMailAccountSortKey::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 accounts by their identifiers, according to <i>order</i>.</p>
<p>See also <a href="qmailaccount.html#id">QMailAccount::id</a>().</p>
<h3 class="fn"><a name="isEmpty"></a>bool QMailAccountSortKey::isEmpty () const</h3>
<p>Returns true if the key remains empty after default construction; otherwise returns false.</p>
<h3 class="fn"><a name="lastSynchronized"></a>QMailAccountSortKey QMailAccountSortKey::lastSynchronized ( <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 accounts by the message type they handle, according to <i>order</i>.</p>
<p>See also <a href="qmailaccount.html#lastSynchronized">QMailAccount::lastSynchronized</a>().</p>
<h3 class="fn"><a name="messageType"></a>QMailAccountSortKey QMailAccountSortKey::messageType ( <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 accounts by the message type they handle, according to <i>order</i>.</p>
<p>See also <a href="qmailaccount.html#messageType">QMailAccount::messageType</a>().</p>
<h3 class="fn"><a name="name"></a>QMailAccountSortKey QMailAccountSortKey::name ( <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 accounts by their names, according to <i>order</i>.</p>
<p>See also <a href="qmailaccount.html#name">QMailAccount::name</a>().</p>
<h3 class="fn"><a name="serialize"></a>void QMailAccountSortKey::serialize ( Stream & <i>stream</i> ) const</h3>
<p>Writes the contents of a <a href="qmailaccountsortkey.html">QMailAccountSortKey</a> to a <i>stream</i>.</p>
<h3 class="fn"><a name="status"></a>QMailAccountSortKey QMailAccountSortKey::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 accounts by comparing their status value bitwise ANDed with <i>mask</i>, according to <i>order</i>.</p>
<p>See also <a href="qmailaccount.html#status">QMailAccount::status</a>().</p>
<h3 class="fn"><a name="operator-not-eq"></a>bool QMailAccountSortKey::operator!= ( const QMailAccountSortKey & <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>QMailAccountSortKey QMailAccountSortKey::operator& ( const QMailAccountSortKey & <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>QMailAccountSortKey & QMailAccountSortKey::operator&= ( const QMailAccountSortKey & <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>QMailAccountSortKey & QMailAccountSortKey::operator= ( const QMailAccountSortKey & <i>other</i> )</h3>
<p>Assign the value of the <a href="qmailaccountsortkey.html">QMailAccountSortKey</a> <i>other</i> to this.</p>
<h3 class="fn"><a name="operator-eq-eq"></a>bool QMailAccountSortKey::operator== ( const QMailAccountSortKey & <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>
|