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
|
<?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>QMailMessageSet 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">QMailMessageSet Class Reference</h1>
<p>The QMailMessageSet class represents a subset of the messages in the mail store. <a href="#details">More...</a></p>
<pre> #include <QMailMessageSet></pre><p><b>This class is under development and is subject to change.</b></p>
<p>Inherits <a href="http://doc.trolltech.com/4.5/qobject.html">QObject</a> and <a href="qmailmessagesetcontainer.html">QMailMessageSetContainer</a>.</p>
<p>Inherited by <a href="qmailaccountmessageset.html">QMailAccountMessageSet</a>, <a href="qmailfiltermessageset.html">QMailFilterMessageSet</a>, and <a href="qmailfoldermessageset.html">QMailFolderMessageSet</a>.</p>
<ul>
<li><a href="qmailmessageset-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="qmailmessageset.html#QMailMessageSet">QMailMessageSet</a></b> ( QMailMessageSetContainer * <i>container</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QVariant </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessageset.html#data">data</a></b> ( int <i>role</i>, int <i>column</i> = 0 )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual QMailMessageKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessageset.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="qmailmessageset.html#displayName">displayName</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual QMailMessageKey </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessageset.html#messageKey">messageKey</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QModelIndex </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessageset.html#modelIndex">modelIndex</a></b> ( int <i>column</i> = 0 )</td></tr>
</table>
<ul>
<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="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="qmailmessageset.html#init">init</a></b> ()</td></tr>
</table>
<ul>
<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>4 static public members inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#static-public-members">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 QMailMessageSet class represents a subset of the messages in the mail store.</p>
<p>QMailMessageSet provides a representation for a named subset of messages, specified by a <a href="qmailmessagekey.html">QMailMessageKey</a> selection criterion.</p>
<p>QMailMessageSets are designed to be arranged in hierarchies, and each message set is a container for child message sets, implementing the <a href="qmailmessagesetcontainer.html">QMailMessageSetContainer</a> interface. Message sets are owned by <a href="qmailmessagesetmodel.html">QMailMessageSetModel</a> instances, and the index of a message set within the model can be retrieved using <a href="qmailmessageset.html#modelIndex">modelIndex</a>().</p>
<p>The <a href="qmailmessageset.html#messageKey">messageKey</a>() function of each QMailMessageSet object can be used to provide the message selection filter for a <a href="qmailmessagelistmodel.html">QMailMessageListModel</a>. The <a href="qmailmessageset.html#descendantsMessageKey">descendantsMessageKey</a>() function can be used to provide a message selection filter matching all messages beneath this message set in the hierarchy.</p>
<p>QMailMessageSet objects should not directly respond to events reported by the <a href="qmailstore.html">QMailStore</a>; instead, they should react to notifications of mail store events emitted by the <a href="qmailmessagesetmodel.html">QMailMessageSetModel</a> to which they are attached. Because the events they receive from the model may be filtered, QMailMessageSet instances must implement the <a href="qmailmessagesetcontainer.html#resyncState">resyncState</a>() function, resynchronizing their state with the current state of the mail store.</p>
<p>See also <a href="qmailmessagesetmodel.html">QMailMessageSetModel</a>.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QMailMessageSet"></a>QMailMessageSet::QMailMessageSet ( <a href="qmailmessagesetcontainer.html">QMailMessageSetContainer</a> * <i>container</i> )</h3>
<p>Constructs a new <a href="qmailmessageset.html">QMailMessageSet</a> within the container object <i>container</i>.</p>
<h3 class="fn"><a name="data"></a><a href="http://doc.trolltech.com/4.5/qvariant.html">QVariant</a> QMailMessageSet::data ( int <i>role</i>, int <i>column</i> = 0 )</h3>
<p>Returns the data element associated with the specified <i>role</i> and <i>column</i>, from the model that owns this message set.</p>
<h3 class="fn"><a name="descendantsMessageKey"></a><a href="qmailmessagekey.html">QMailMessageKey</a> QMailMessageSet::descendantsMessageKey () const <tt> [virtual]</tt></h3>
<p>Returns the <a href="qmailmessagekey.html">QMailMessageKey</a> that defines the messages found beneath this message set in the hierarchy, not including the messages of this message set itself.</p>
<h3 class="fn"><a name="displayName"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMailMessageSet::displayName () const <tt> [pure virtual]</tt></h3>
<p>Returns the name of this message set, suitable for display purposes.</p>
<h3 class="fn"><a name="init"></a>void QMailMessageSet::init () <tt> [virtual protected]</tt></h3>
<p>Initialises the message set after it has been appended to the parent container object.</p>
<h3 class="fn"><a name="messageKey"></a><a href="qmailmessagekey.html">QMailMessageKey</a> QMailMessageSet::messageKey () const <tt> [pure virtual]</tt></h3>
<p>Returns the <a href="qmailmessagekey.html">QMailMessageKey</a> that defines the messages represented by this message set.</p>
<h3 class="fn"><a name="modelIndex"></a><a href="http://doc.trolltech.com/4.5/qmodelindex.html">QModelIndex</a> QMailMessageSet::modelIndex ( int <i>column</i> = 0 )</h3>
<p>Returns the index of this message set within the model that owns it, having the specified <i>column</i>.</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>
|
