/usr/share/doc/qmf/html/qmailfoldermessageset.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 | <?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">
<!-- qmailmessageset.cpp -->
<head>
<title>QMailFolderMessageSet 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">QMailFolderMessageSet Class Reference</h1>
<p>The QMailFolderMessageSet class represents a set of messages corresponding to the content of a <a href="qmailfolder.html">QMailFolder</a>. <a href="#details">More...</a></p>
<pre> #include <QMailFolderMessageSet></pre><p><b>This class is under development and is subject to change.</b></p>
<p>Inherits <a href="qmailmessageset.html">QMailMessageSet</a>.</p>
<ul>
<li><a href="qmailfoldermessageset-members.html">List of all members, including inherited members</a></li>
</ul>
<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="qmailfoldermessageset.html#QMailFolderMessageSet">QMailFolderMessageSet</a></b> ( QMailMessageSetContainer * <i>container</i>, const QMailFolderId & <i>folderId</i>, bool <i>hierarchical</i> = true )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderId </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldermessageset.html#folderId">folderId</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldermessageset.html#hierarchical">hierarchical</a></b> () const</td></tr>
</table>
<hr />
<a name="reimplemented-public-functions"></a>
<h2>Reimplemented Public Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">virtual QMailMessageKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldermessageset.html#descendantsMessageKey">descendantsMessageKey</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldermessageset.html#displayName">displayName</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual QMailMessageKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldermessageset.html#messageKey">messageKey</a></b> () const</td></tr>
</table>
<ul>
<li><div bar="2" class="fn"></div>5 public functions inherited from <a href="qmailmessageset.html#public-functions">QMailMessageSet</a></li>
<li><div bar="2" class="fn"></div>29 public functions inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#public-functions">QObject</a></li>
<li><div bar="2" class="fn"></div>10 public functions inherited from <a href="qmailmessagesetcontainer.html#public-functions">QMailMessageSetContainer</a></li>
</ul>
<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">QMailMessageKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldermessageset.html#contentKey">contentKey</a></b> ( const QMailFolderId & <i>id</i>, bool <i>descendants</i> )</td></tr>
</table>
<ul>
<li><div bar="2" class="fn"></div>4 static public members inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#static-public-members">QObject</a></li>
</ul>
<hr />
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="qmailfoldermessageset.html#createChild">createChild</a></b> ( const QMailFolderId & <i>childId</i> )</td></tr>
</table>
<ul>
<li><div bar="2" class="fn"></div>1 protected function inherited from <a href="qmailmessageset.html#protected-functions">QMailMessageSet</a></li>
<li><div bar="2" class="fn"></div>7 protected functions inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#protected-functions">QObject</a></li>
<li><div bar="2" class="fn"></div>1 protected function inherited from <a href="qmailmessagesetcontainer.html#protected-functions">QMailMessageSetContainer</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li><div class="fn"></div>1 property inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#properties">QObject</a></li>
<li><div class="fn"></div>1 public slot inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#public-slots">QObject</a></li>
<li><div class="fn"></div>1 signal inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#signals">QObject</a></li>
<li><div class="fn"></div>1 public type inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#public-variables">QObject</a></li>
<li><div class="fn"></div>2 protected variables inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QMailFolderMessageSet class represents a set of messages corresponding to the content of a <a href="qmailfolder.html">QMailFolder</a>.</p>
<p>QMailFolderMessageSet provides a representation for a named subset of messages, specified by their parent <a href="qmailfolder.html">QMailFolder</a>.</p>
<p>If the QMailFolderMessageSet is <a href="qmailfoldermessageset.html#hierarchical">hierarchical</a>(), then any folders contained by the parent <a href="qmailfolder.html">QMailFolder</a> will automatically be managed as child QMailFolderMessageSets of the parent QMailFolderMessageSet.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QMailFolderMessageSet"></a>QMailFolderMessageSet::QMailFolderMessageSet ( <a href="qmailmessagesetcontainer.html">QMailMessageSetContainer</a> * <i>container</i>, const <a href="qmailfolderid.html">QMailFolderId</a> & <i>folderId</i>, bool <i>hierarchical</i> = true )</h3>
<p>Constructs a <a href="qmailfoldermessageset.html">QMailFolderMessageSet</a> within the parent container <i>container</i>, whose message set is defined by the content of the <a href="qmailfolder.html">QMailFolder</a> identified by <i>folderId</i>. If <i>hierarchical</i> is true, the message set will automatically maintain a set of child QMailFolderMessageSets corresponding to <a href="qmailfolder.html">QMailFolder</a>s whose <a href="qmailfolder.html#parentFolderId">parentFolderId</a> is <i>folderId</i>.</p>
<h3 class="fn"><a name="contentKey"></a><a href="qmailmessagekey.html">QMailMessageKey</a> QMailFolderMessageSet::contentKey ( const <a href="qmailfolderid.html">QMailFolderId</a> & <i>id</i>, bool <i>descendants</i> ) <tt> [static]</tt></h3>
<p>Returns the message key that defines the content of a <a href="qmailfoldermessageset.html">QMailFolderMessageSet</a> for the folder identified by <i>id</i>. If <i>descendants</i> is true, then the result is the key that defines the descendantMessageKey() content.</p>
<h3 class="fn"><a name="createChild"></a>void QMailFolderMessageSet::createChild ( const <a href="qmailfolderid.html">QMailFolderId</a> & <i>childId</i> ) <tt> [virtual protected]</tt></h3>
<p>Creates a message set object for the folder identified by <i>childId</i>, and appends it to this object.</p>
<p>Override this function to specialize the type created for child nodes.</p>
<h3 class="fn"><a name="descendantsMessageKey"></a><a href="qmailmessagekey.html">QMailMessageKey</a> QMailFolderMessageSet::descendantsMessageKey () const <tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qmailmessageset.html#descendantsMessageKey">QMailMessageSet::descendantsMessageKey</a>().</p>
<p>Returns the <a href="qmailmessagekey.html">QMailMessageKey</a> that selects the messages beneath the configured folder in the hierarchy.</p>
<h3 class="fn"><a name="displayName"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMailFolderMessageSet::displayName () const <tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qmailmessageset.html#displayName">QMailMessageSet::displayName</a>().</p>
<p>Returns the display name of the folder that this message set represents.</p>
<p>See also <a href="qmailfolder.html#displayName">QMailFolder::displayName</a>().</p>
<h3 class="fn"><a name="folderId"></a><a href="qmailfolderid.html">QMailFolderId</a> QMailFolderMessageSet::folderId () const</h3>
<p>Returns the identifier of the <a href="qmailfolder.html">QMailFolder</a> associated with this message set.</p>
<h3 class="fn"><a name="hierarchical"></a>bool QMailFolderMessageSet::hierarchical () const</h3>
<p>Returns true if this message set automatically maintains a hierarchy of child folder message sets.</p>
<h3 class="fn"><a name="messageKey"></a><a href="qmailmessagekey.html">QMailMessageKey</a> QMailFolderMessageSet::messageKey () const <tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qmailmessageset.html#messageKey">QMailMessageSet::messageKey</a>().</p>
<p>Returns the <a href="qmailmessagekey.html">QMailMessageKey</a> that selects the messages contained by the configured folder.</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>
|