diff options
| author | Don Sanders <don.sanders@nokia.com> | 2011-03-09 21:58:43 +1000 |
|---|---|---|
| committer | Don Sanders <don.sanders@nokia.com> | 2011-03-09 21:58:43 +1000 |
| commit | 2ff1cd5609eb3b58e11d75d843240468a2ceb0bd (patch) | |
| tree | d282f504377b4ee0c304e8199fb1dc7ff1b627da /doc | |
| parent | 4b2d660e865c8ad5e2edb19acdd75b090022c472 (diff) | |
Updated doc.2011W10
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/html/annotated.html | 11 | ||||
| -rw-r--r-- | doc/html/classes.html | 14 | ||||
| -rw-r--r-- | doc/html/classeshierarchy.html | 1 | ||||
| -rw-r--r-- | doc/html/messaginglibrary.html | 15 | ||||
| -rw-r--r-- | doc/html/qmailmessagekey.html | 4 | ||||
| -rw-r--r-- | doc/html/qmailmessagemetadata.html | 4 | ||||
| -rw-r--r-- | doc/html/qmailmessagesortkey.html | 2 | ||||
| -rw-r--r-- | doc/html/qmailstore.html | 39 | ||||
| -rw-r--r-- | doc/html/qmailthread.html | 8 | ||||
| -rw-r--r-- | doc/html/qmailthreadid-members.html | 31 | ||||
| -rw-r--r-- | doc/html/qmailthreadid.html | 70 | ||||
| -rw-r--r-- | doc/html/qmailthreadkey.html | 4 | ||||
| -rw-r--r-- | doc/html/qmf.qhp | 12 | ||||
| -rw-r--r-- | doc/html/qt-messaging-framework.dcf | 10 | ||||
| -rw-r--r-- | doc/html/qt-messaging-framework.index | 21 | ||||
| -rw-r--r-- | doc/html/qtextendedmail.html | 12 |
16 files changed, 213 insertions, 45 deletions
diff --git a/doc/html/annotated.html b/doc/html/annotated.html index 38dbfb26..9f6d1e3a 100644 --- a/doc/html/annotated.html +++ b/doc/html/annotated.html @@ -89,11 +89,12 @@ <tr valign="top" class="even"><th><a href="qmailstore.html">QMailStore</a></th><td>Represents the main interface for storage and retrieval of messages and folders on the message store</td></tr> <tr valign="top" class="odd"><th><a href="qmailstoreaccountfilter.html">QMailStoreAccountFilter</a></th><td>Filtered view of QMailStore signals, affecting a single account</td></tr> <tr valign="top" class="even"><th><a href="qmailthread.html">QMailThread</a></th><td>Represents a thread of mail messages in the mail store</td></tr> -<tr valign="top" class="odd"><th><a href="qmailthreadkey.html">QMailThreadKey</a></th><td>Defines the parameters used for querying a subset of all message threads from the mail store</td></tr> -<tr valign="top" class="even"><th><a href="qmailthreadsortkey.html">QMailThreadSortKey</a></th><td>Defines the parameters used for sorting a subset of threads from the mail store</td></tr> -<tr valign="top" class="odd"><th><a href="qmailtimestamp.html">QMailTimeStamp</a></th><td>Manages message time stamps</td></tr> -<tr valign="top" class="even"><th><a href="qmailtransmitaction.html">QMailTransmitAction</a></th><td>The interface for transmitting messages to external message services</td></tr> -<tr valign="top" class="odd"><th><a href="qmailtransport.html">QMailTransport</a></th><td>Line-oriented socket for messaging communications</td></tr> +<tr valign="top" class="odd"><th><a href="qmailthreadid.html">QMailThreadId</a></th><td>Used to identify threads stored by QMailStore</td></tr> +<tr valign="top" class="even"><th><a href="qmailthreadkey.html">QMailThreadKey</a></th><td>Defines the parameters used for querying a subset of all message threads from the mail store</td></tr> +<tr valign="top" class="odd"><th><a href="qmailthreadsortkey.html">QMailThreadSortKey</a></th><td>Defines the parameters used for sorting a subset of threads from the mail store</td></tr> +<tr valign="top" class="even"><th><a href="qmailtimestamp.html">QMailTimeStamp</a></th><td>Manages message time stamps</td></tr> +<tr valign="top" class="odd"><th><a href="qmailtransmitaction.html">QMailTransmitAction</a></th><td>The interface for transmitting messages to external message services</td></tr> +<tr valign="top" class="even"><th><a href="qmailtransport.html">QMailTransport</a></th><td>Line-oriented socket for messaging communications</td></tr> </table></p> <p /><address><hr /><div align="center"> <table width="100%" cellspacing="0" border="0"><tr class="address"> diff --git a/doc/html/classes.html b/doc/html/classes.html index 338f5a01..0a2e4549 100644 --- a/doc/html/classes.html +++ b/doc/html/classes.html @@ -163,7 +163,7 @@ <td align="right"></td> <td><a href="qmailmessageserviceplugininterface.html">QMailMessageServicePluginInterface</a></td> <td align="right"></td> -<td><a href="qmailthreadkey.html">QMailThreadKey</a></td> +<td><a href="qmailthreadid.html">QMailThreadId</a></td> </tr> <tr> <td align="right"></td> @@ -173,7 +173,7 @@ <td align="right"></td> <td><a href="qmailmessageset.html">QMailMessageSet</a></td> <td align="right"></td> -<td><a href="qmailthreadsortkey.html">QMailThreadSortKey</a></td> +<td><a href="qmailthreadkey.html">QMailThreadKey</a></td> </tr> <tr> <td align="right"></td> @@ -183,7 +183,7 @@ <td align="right"></td> <td><a href="qmailmessagesetcontainer.html">QMailMessageSetContainer</a></td> <td align="right"></td> -<td><a href="qmailtimestamp.html">QMailTimeStamp</a></td> +<td><a href="qmailthreadsortkey.html">QMailThreadSortKey</a></td> </tr> <tr> <td align="right"><b>D </b></td> @@ -193,7 +193,7 @@ <td align="right"></td> <td><a href="qmailmessagesetmodel.html">QMailMessageSetModel</a></td> <td align="right"></td> -<td><a href="qmailtransmitaction.html">QMailTransmitAction</a></td> +<td><a href="qmailtimestamp.html">QMailTimeStamp</a></td> </tr> <tr> <td align="right"><b>F </b></td> @@ -203,7 +203,7 @@ <td align="right"></td> <td><a href="qmailmessagesink.html">QMailMessageSink</a></td> <td align="right"></td> -<td><a href="qmailtransport.html">QMailTransport</a></td> +<td><a href="qmailtransmitaction.html">QMailTransmitAction</a></td> </tr> <tr> <td align="right"></td> @@ -212,8 +212,8 @@ <td><a href="qmailmessagelistmodel.html">QMailMessageListModel</a></td> <td align="right"></td> <td><a href="qmailmessagesortkey.html">QMailMessageSortKey</a></td> -<td> -</td> +<td align="right"></td> +<td><a href="qmailtransport.html">QMailTransport</a></td> </tr> </table></p> <p /><address><hr /><div align="center"> diff --git a/doc/html/classeshierarchy.html b/doc/html/classeshierarchy.html index e7d8ada8..b74e4ac2 100644 --- a/doc/html/classeshierarchy.html +++ b/doc/html/classeshierarchy.html @@ -108,6 +108,7 @@ <li><a href="qmailmessagesortkey.html">QMailMessageSortKey</a></li> <li><a href="qmailserviceconfiguration.html">QMailServiceConfiguration</a></li> <li><a href="qmailthread.html">QMailThread</a></li> +<li><a href="qmailthreadid.html">QMailThreadId</a></li> <li><a href="qmailthreadkey.html">QMailThreadKey</a></li> <li><a href="qmailthreadsortkey.html">QMailThreadSortKey</a></li> <li><a href="qmailtimestamp.html">QMailTimeStamp</a></li> diff --git a/doc/html/messaginglibrary.html b/doc/html/messaginglibrary.html index 42b68445..814eda6a 100644 --- a/doc/html/messaginglibrary.html +++ b/doc/html/messaginglibrary.html @@ -72,13 +72,14 @@ <tr valign="top" class="even"><th><a href="qmailstorageaction.html">QMailStorageAction</a></th><td>The interface for requesting operations on the storage of messages within external message services</td></tr> <tr valign="top" class="odd"><th><a href="qmailstore.html">QMailStore</a></th><td>Represents the main interface for storage and retrieval of messages and folders on the message store</td></tr> <tr valign="top" class="even"><th><a href="qmailthread.html">QMailThread</a></th><td>Represents a thread of mail messages in the mail store</td></tr> -<tr valign="top" class="odd"><th><a href="qmailthreadkey.html">QMailThreadKey</a></th><td>Defines the parameters used for querying a subset of all message threads from the mail store</td></tr> -<tr valign="top" class="even"><th><a href="qmailthreadsortkey.html">QMailThreadSortKey</a></th><td>Defines the parameters used for sorting a subset of threads from the mail store</td></tr> -<tr valign="top" class="odd"><th><a href="qmailtimestamp.html">QMailTimeStamp</a></th><td>Manages message time stamps</td></tr> -<tr valign="top" class="even"><th><a href="qmailtransmitaction.html">QMailTransmitAction</a></th><td>The interface for transmitting messages to external message services</td></tr> -<tr valign="top" class="odd"><th><a href="qmailaccountconfiguration-serviceconfiguration.html">QMailAccountConfiguration::ServiceConfiguration</a></th><td>Access to the configuration parameters of a single named service within an account</td></tr> -<tr valign="top" class="even"><th><a href="qmailserviceaction-status.html">QMailServiceAction::Status</a></th><td>Encapsulates the instantaneous state of a QMailServiceAction</td></tr> -<tr valign="top" class="odd"><th><a href="qmailkeyargument-valuelist.html">QMailKeyArgument::ValueList</a></th><td>List of variant values that can be serialized to a stream, and compared</td></tr> +<tr valign="top" class="odd"><th><a href="qmailthreadid.html">QMailThreadId</a></th><td>Used to identify threads stored by QMailStore</td></tr> +<tr valign="top" class="even"><th><a href="qmailthreadkey.html">QMailThreadKey</a></th><td>Defines the parameters used for querying a subset of all message threads from the mail store</td></tr> +<tr valign="top" class="odd"><th><a href="qmailthreadsortkey.html">QMailThreadSortKey</a></th><td>Defines the parameters used for sorting a subset of threads from the mail store</td></tr> +<tr valign="top" class="even"><th><a href="qmailtimestamp.html">QMailTimeStamp</a></th><td>Manages message time stamps</td></tr> +<tr valign="top" class="odd"><th><a href="qmailtransmitaction.html">QMailTransmitAction</a></th><td>The interface for transmitting messages to external message services</td></tr> +<tr valign="top" class="even"><th><a href="qmailaccountconfiguration-serviceconfiguration.html">QMailAccountConfiguration::ServiceConfiguration</a></th><td>Access to the configuration parameters of a single named service within an account</td></tr> +<tr valign="top" class="odd"><th><a href="qmailserviceaction-status.html">QMailServiceAction::Status</a></th><td>Encapsulates the instantaneous state of a QMailServiceAction</td></tr> +<tr valign="top" class="even"><th><a href="qmailkeyargument-valuelist.html">QMailKeyArgument::ValueList</a></th><td>List of variant values that can be serialized to a stream, and compared</td></tr> </table></p> <p /><address><hr /><div align="center"> <table width="100%" cellspacing="0" border="0"><tr class="address"> diff --git a/doc/html/qmailmessagekey.html b/doc/html/qmailmessagekey.html index da90487c..212e82e4 100644 --- a/doc/html/qmailmessagekey.html +++ b/doc/html/qmailmessagekey.html @@ -320,9 +320,9 @@ <h3 class="fn"><a name="parentFolderId-3"></a>QMailMessageKey QMailMessageKey::parentFolderId ( const <a href="qmailfolderkey.html">QMailFolderKey</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 messages 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="qmailmessagemetadata.html#parentFolderId">QMailMessage::parentFolderId</a>().</p> -<h3 class="fn"><a name="parentThreadId"></a>QMailMessageKey QMailMessageKey::parentThreadId ( const QMailThreadId & <i>id</i>, <a href="qmaildatacomparator.html#EqualityComparator-enum">QMailDataComparator::EqualityComparator</a> <i>cmp</i> = QMailDataComparator::Equal ) <tt> [static]</tt></h3> +<h3 class="fn"><a name="parentThreadId"></a>QMailMessageKey QMailMessageKey::parentThreadId ( const <a href="qmailthreadid.html">QMailThreadId</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 messages whose parent thread identifier matches <i>id</i>, according to <i>cmp</i>.</p> -<h3 class="fn"><a name="parentThreadId-2"></a>QMailMessageKey QMailMessageKey::parentThreadId ( const QMailThreadIdList & <i>ids</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> = QMailDataComparator::Includes ) <tt> [static]</tt></h3> +<h3 class="fn"><a name="parentThreadId-2"></a>QMailMessageKey QMailMessageKey::parentThreadId ( const <a href="qmailthreadid.html#QMailThreadIdList-typedef">QMailThreadIdList</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 messages whose thread is a member of <i>ids</i>, according to <i>cmp</i>.</p> <h3 class="fn"><a name="parentThreadId-3"></a>QMailMessageKey QMailMessageKey::parentThreadId ( const <a href="qmailthreadkey.html">QMailThreadKey</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 messages whose thread matched <i>key</i>, according to <i>cmp</i>.</p> diff --git a/doc/html/qmailmessagemetadata.html b/doc/html/qmailmessagemetadata.html index ebd29ed4..8a96e73e 100644 --- a/doc/html/qmailmessagemetadata.html +++ b/doc/html/qmailmessagemetadata.html @@ -182,7 +182,7 @@ <h3 class="fn"><a name="parentFolderId"></a><a href="qmailfolderid.html">QMailFolderId</a> QMailMessageMetaData::parentFolderId () const <tt> [virtual]</tt></h3> <p>Return the <a href="qmailfolderid.html">QMailFolderId</a> of the folder that contains the message.</p> <p>See also <a href="qmailmessagemetadata.html#setParentFolderId">setParentFolderId</a>().</p> -<h3 class="fn"><a name="parentThreadId"></a>QMailThreadId QMailMessageMetaData::parentThreadId () const <tt> [virtual]</tt></h3> +<h3 class="fn"><a name="parentThreadId"></a><a href="qmailthreadid.html">QMailThreadId</a> QMailMessageMetaData::parentThreadId () const <tt> [virtual]</tt></h3> <p>Returns the id of the thread this message belongs to.</p> <p>See also <a href="qmailmessagemetadata.html#setParentThreadId">setParentThreadId</a>().</p> <h3 class="fn"><a name="partialContentAvailable"></a>bool QMailMessageMetaData::partialContentAvailable () const <tt> [virtual]</tt></h3> @@ -252,7 +252,7 @@ <h3 class="fn"><a name="setParentFolderId"></a>void QMailMessageMetaData::setParentFolderId ( const <a href="qmailfolderid.html">QMailFolderId</a> & <i>id</i> ) <tt> [virtual]</tt></h3> <p>Sets the <a href="qmailfolderid.html">QMailFolderId</a> of the folder that contains the message to <i>id</i>.</p> <p>See also <a href="qmailmessagemetadata.html#parentFolderId">parentFolderId</a>().</p> -<h3 class="fn"><a name="setParentThreadId"></a>void QMailMessageMetaData::setParentThreadId ( const QMailThreadId & <i>id</i> ) <tt> [virtual]</tt></h3> +<h3 class="fn"><a name="setParentThreadId"></a>void QMailMessageMetaData::setParentThreadId ( const <a href="qmailthreadid.html">QMailThreadId</a> & <i>id</i> ) <tt> [virtual]</tt></h3> <p>Sets the id of the thread this message belongs to <i>id</i>. If this is left blank then the thread will be detected/generated.</p> <p>See also <a href="qmailmessagemetadata.html#parentThreadId">parentThreadId</a>().</p> <h3 class="fn"><a name="setPreview"></a>void QMailMessageMetaData::setPreview ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>s</i> ) <tt> [virtual]</tt></h3> diff --git a/doc/html/qmailmessagesortkey.html b/doc/html/qmailmessagesortkey.html index ee55b448..fccea0fe 100644 --- a/doc/html/qmailmessagesortkey.html +++ b/doc/html/qmailmessagesortkey.html @@ -100,7 +100,7 @@ <tr><td valign="top"><tt>QMailMessageSortKey::ListId</tt></td><td align="center" valign="top"><tt>15</tt></td><td valign="top">The name of the list</td></tr> <tr><td valign="top"><tt>QMailMessageSortKey::RestoreFolderId</tt></td><td align="center" valign="top"><tt>16</tt></td><td valign="top">The folderId of where the message should be restored to</td></tr> <tr><td valign="top"><tt>QMailMessageSortKey::RfcId</tt></td><td align="center" valign="top"><tt>17</tt></td><td valign="top">The message rfcId, that is the message-id header field value.</td></tr> -<tr><td valign="top"><tt>QMailMessageSortKey::ParentThreadId</tt></td><td align="center" valign="top"><tt>18</tt></td><td valign="top">The QMailThreadId of the thread (conversation) of the message.</td></tr> +<tr><td valign="top"><tt>QMailMessageSortKey::ParentThreadId</tt></td><td align="center" valign="top"><tt>18</tt></td><td valign="top">The <a href="qmailthreadid.html">QMailThreadId</a> of the thread (conversation) of the message.</td></tr> </table></p> <hr /> <h2>Member Function Documentation</h2> diff --git a/doc/html/qmailstore.html b/doc/html/qmailstore.html index 9f012075..0d431401 100644 --- a/doc/html/qmailstore.html +++ b/doc/html/qmailstore.html @@ -151,11 +151,12 @@ <hr /> <h2>Detailed Description</h2> <p>The QMailStore class represents the main interface for storage and retrieval of messages and folders on the message store.</p> -<p>The QMailStore class is accessed through a singleton interface and provides functions for adding, updating and deleting of QMailAccounts, QMailFolders and QMailMessages on the message store.</p> -<p>QMailStore also provides functions for querying and counting of QMailFolders, QMailAccounts and QMailMessages when used in conjunction with <a href="qmailmessagekey.html">QMailMessageKey</a>, <a href="qmailfolderkey.html">QMailFolderKey</a> and <a href="qmailaccountkey.html">QMailAccountKey</a> classes.</p> +<p>The QMailStore class is accessed through a singleton interface and provides functions for adding, updating and deleting of QMailAccounts, QMailFolders, QMailThreads and QMailMessages on the message store.</p> +<p>QMailStore also provides functions for querying and counting of QMailFolders, QMailAccounts, QMailThreads and QMailMessages when used in conjunction with <a href="qmailfolderkey.html">QMailFolderKey</a> and <a href="qmailaccountkey.html">QMailAccountKey</a>, <a href="qmailthreadkey.html">QMailThreadKey</a> and <a href="qmailmessagekey.html">QMailMessageKey</a> classes.</p> <p>If a QMailStore operation fails, the <a href="qmailstore.html#lastError">lastError</a>() function will return an error code value indicating the failure mode encountered. A successful operation will set the <a href="qmailstore.html#lastError">lastError</a>() result to <a href="qmailstore.html#ErrorCode-enum">QMailStore::NoError</a>.</p> <p>Messaging accounts are represented by <a href="qmailaccountid.html">QMailAccountId</a> objects. The data associated with accounts is separated into two components: <a href="qmailaccount.html">QMailAccount</a> objects hold account properties exported to mail store client applications, and <a href="qmailaccountconfiguration.html">QMailAccountConfiguration</a> objects hold data used only by the messageserver and the protocol plugins it loads.</p> <p>Account objects are accessed via the <a href="qmailstore.html#account">account</a>(), <a href="qmailstore.html#accountConfiguration">accountConfiguration</a>(), <a href="qmailstore.html#countAccounts">countAccounts</a>() and <a href="qmailstore.html#queryAccounts">queryAccounts</a>() functions. Accounts in the mail store can be manipulated via the <a href="qmailstore.html#addAccount">addAccount</a>(), <a href="qmailstore.html#updateAccount">updateAccount</a>() and <a href="qmailstore.html#removeAccount">removeAccount</a>() functions. Mail store manipulations affecting accounts are reported via the <a href="qmailstore.html#accountsAdded">accountsAdded</a>(), <a href="qmailstore.html#accountsUpdated">accountsUpdated</a>(), <a href="qmailstore.html#accountContentsModified">accountContentsModified</a>() and <a href="qmailstore.html#accountsRemoved">accountsRemoved</a>() signals.</p> +<p>Thread (a.k.a. conversation) objects are accessed via the <a href="qmailstore.html#thread">thread</a>(), <a href="qmailstore.html#countThreads">countThreads</a>() and <a href="qmailstore.html#queryThreads">queryThreads</a>() functions. Accounts in the mail store can be manipulated via the <a href="qmailstore.html#addThread">addThread</a>(), <a href="qmailstore.html#updateThread">updateThread</a>() and <a href="qmailstore.html#removeThread">removeThread</a>() functions. Mail store manipulations affecting accounts are reported via the <a href="qmailstore.html#threadsAdded">threadsAdded</a>(), <a href="qmailstore.html#threadsUpdated">threadsUpdated</a>(), threadsContentsModified() and <a href="qmailstore.html#threadsRemoved">threadsRemoved</a>() signals.</p> <p>Fixed logical groupings of message are modelled as folders, represented by <a href="qmailfolderid.html">QMailFolderId</a> objects. The data associated with folders is held by instances of the <a href="qmailfolder.html">QMailFolder</a> class.</p> <p>Folder objects are accessed via the <a href="qmailstore.html#folder">folder</a>(), <a href="qmailstore.html#countFolders">countFolders</a>() and <a href="qmailstore.html#queryFolders">queryFolders</a>() functions. Folders in the mail store can be manipulated via the <a href="qmailstore.html#addFolder">addFolder</a>(), <a href="qmailstore.html#updateFolder">updateFolder</a>() and <a href="qmailstore.html#removeFolder">removeFolder</a>() functions. Mail store manipulations affecting folders are reported via the <a href="qmailstore.html#foldersAdded">foldersAdded</a>(), <a href="qmailstore.html#foldersUpdated">foldersUpdated</a>(), <a href="qmailstore.html#folderContentsModified">folderContentsModified</a>() and <a href="qmailstore.html#foldersRemoved">foldersRemoved</a>() signals.</p> <p>Messages in the mail store are represented by <a href="qmailmessageid.html">QMailMessageId</a> objects. The data associated with a message can be retrieved in two forms: <a href="qmailmessagemetadata.html">QMailMessageMetaData</a> objects contain only the meta data fields associated with a message, and <a href="qmailmessage.html">QMailMessage</a> objects contain both the meta data fields and the message content proper.</p> @@ -244,6 +245,7 @@ <h3 class="fn"><a name="addMessages-2"></a>bool QMailStore::addMessages ( const <a href="http://doc.trolltech.com/4.5/qlist.html">QList</a><<a href="qmailmessagemetadata.html">QMailMessageMetaData</a> *> & <i>messages</i> )</h3> <p>Adds a new QMailMessageMetData object into the message store for each entry in the list <i>messages</i>, performing all respective integrity checks. Returns <tt>true</tt> if the operation completed successfully, <tt>false</tt> otherwise.</p> <h3 class="fn"><a name="addThread"></a>bool QMailStore::addThread ( <a href="qmailthread.html">QMailThread</a> * <i>t</i> )</h3> +<p>Adds a new <a href="qmailthread.html">QMailThread</a> object <i>t</i> into the message store, performing respective integrity checks. Returns <tt>true</tt> if the operation completed successfully, <tt>false</tt> otherwise.</p> <h3 class="fn"><a name="asynchronousEmission"></a>bool QMailStore::asynchronousEmission () const</h3> <p>Returns true if the running process is in the act of emitting an asynchronous <a href="qmailstore.html">QMailStore</a> signal caused by another process. This can only be true when called from a slot invoked by a <a href="qmailstore.html">QMailStore</a> signal.</p> <h3 class="fn"><a name="countAccounts"></a>int QMailStore::countAccounts ( const <a href="qmailaccountkey.html">QMailAccountKey</a> & <i>key</i> = QMailAccountKey() ) const</h3> @@ -253,6 +255,7 @@ <h3 class="fn"><a name="countMessages"></a>int QMailStore::countMessages ( const <a href="qmailmessagekey.html">QMailMessageKey</a> & <i>key</i> = QMailMessageKey() ) const</h3> <p>Returns the count of the number of messages which pass the filtering criteria defined in <a href="qmailmessagekey.html">QMailMessageKey</a> <i>key</i>. If key is empty a count of all messages is returned.</p> <h3 class="fn"><a name="countThreads"></a>int QMailStore::countThreads ( const <a href="qmailthreadkey.html">QMailThreadKey</a> & <i>key</i> = QMailThreadKey() ) const</h3> +<p>Returns the count of the number of threads which pass the filtering criteria defined in <a href="qmailthreadkey.html">QMailThreadKey</a> <i>key</i>. If key is empty a count of all folders is returned.</p> <h3 class="fn"><a name="errorOccurred"></a>void QMailStore::errorOccurred ( <a href="qmailstore.html#ErrorCode-enum">QMailStore::ErrorCode</a> <i>code</i> ) <tt> [signal]</tt></h3> <p>Signal that is emitted when an error is encountered in processing a <a href="qmailstore.html">QMailStore</a> operation. The error condition is indeicated by <i>code</i>.</p> <p>See also <a href="qmailstore.html#lastError">lastError</a>().</p> @@ -345,8 +348,8 @@ <h3 class="fn"><a name="queryMessages"></a>const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> QMailStore::queryMessages ( const <a href="qmailmessagekey.html">QMailMessageKey</a> & <i>key</i> = QMailMessageKey(), const <a href="qmailmessagesortkey.html">QMailMessageSortKey</a> & <i>sortKey</i> = QMailMessageSortKey(), <a href="http://doc.trolltech.com/4.5/qtglobal.html#uint-typedef">uint</a> <i>limit</i> = 0, <a href="http://doc.trolltech.com/4.5/qtglobal.html#uint-typedef">uint</a> <i>offset</i> = 0 ) const</h3> <p>Returns the <a href="qmailmessageid.html">QMailMessageId</a>s of messages in the message store. If <i>key</i> is not empty only messages matching the parameters set by <i>key</i> will be returned, otherwise all message identifiers will be returned. If <i>sortKey</i> is not empty, the identifiers will be sorted by the parameters set by <i>sortKey</i>. If <i>limit</i> is non-zero, then no more than <i>limit</i> matching message IDs should be returned. If <i>offset</i> is non-zero, then the first <i>offset</i> matching IDs should be omitted from the returned list.</p> <p>Note: if the implementation cannot support the <i>limit</i> and <i>offset</i> parameters, it should not attempt to perform a query where either of these values is non-zero; instead, it should return an empty list and set <a href="qmailstore.html#lastError">lastError</a>() to <a href="qmailstore.html#ErrorCode-enum">QMailStore::NotYetImplemented</a>.</p> -<h3 class="fn"><a name="queryThreads"></a>const QMailThreadIdList QMailStore::queryThreads ( const <a href="qmailthreadkey.html">QMailThreadKey</a> & <i>key</i> = QMailThreadKey(), const <a href="qmailthreadsortkey.html">QMailThreadSortKey</a> & <i>sortKey</i> = QMailThreadSortKey(), <a href="http://doc.trolltech.com/4.5/qtglobal.html#uint-typedef">uint</a> <i>limit</i> = 0, <a href="http://doc.trolltech.com/4.5/qtglobal.html#uint-typedef">uint</a> <i>offset</i> = 0 ) const</h3> -<p>Returns the QMailThreadIds of messages in the message store. If <i>key</i> is not empty only messages matching the parameters set by <i>key</i> will be returned, otherwise all message identifiers will be returned. If <i>sortKey</i> is not empty, the identifiers will be sorted by the parameters set by <i>sortKey</i>. If <i>limit</i> is non-zero, then no more than <i>limit</i> matching message IDs should be returned. If <i>offset</i> is non-zero, then the first <i>offset</i> matching IDs should be omitted from the returned list.</p> +<h3 class="fn"><a name="queryThreads"></a>const <a href="qmailthreadid.html#QMailThreadIdList-typedef">QMailThreadIdList</a> QMailStore::queryThreads ( const <a href="qmailthreadkey.html">QMailThreadKey</a> & <i>key</i> = QMailThreadKey(), const <a href="qmailthreadsortkey.html">QMailThreadSortKey</a> & <i>sortKey</i> = QMailThreadSortKey(), <a href="http://doc.trolltech.com/4.5/qtglobal.html#uint-typedef">uint</a> <i>limit</i> = 0, <a href="http://doc.trolltech.com/4.5/qtglobal.html#uint-typedef">uint</a> <i>offset</i> = 0 ) const</h3> +<p>Returns the <a href="qmailthreadid.html">QMailThreadId</a>s of threads in the message store. If <i>key</i> is not empty only threads matching the parameters set by <i>key</i> will be returned, otherwise all thread identifiers will be returned. If <i>sortKey</i> is not empty, the identifiers will be sorted by the parameters set by <i>sortKey</i>. If <i>limit</i> is non-zero, then no more than <i>limit</i> matching thread IDs should be returned. If <i>offset</i> is non-zero, then the first <i>offset</i> matching IDs should be omitted from the returned list.</p> <p>Note: if the implementation cannot support the <i>limit</i> and <i>offset</i> parameters, it should not attempt to perform a query where either of these values is non-zero; instead, it should return an empty list and set <a href="qmailstore.html#lastError">lastError</a>() to <a href="qmailstore.html#ErrorCode-enum">QMailStore::NotYetImplemented</a>.</p> <h3 class="fn"><a name="registerAccountStatusFlag"></a>bool QMailStore::registerAccountStatusFlag ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>name</i> )</h3> <p>Registers a status flag for <a href="qmailaccount.html">QMailAccount</a> objects, with the identifier <i>name</i>. Returns true if the flag is already registered, or if it is successfully registered; otherwise returns false.</p> @@ -375,11 +378,11 @@ <h3 class="fn"><a name="removeMessages"></a>bool QMailStore::removeMessages ( const <a href="qmailmessagekey.html">QMailMessageKey</a> & <i>key</i>, <a href="qmailstore.html#MessageRemovalOption-enum">MessageRemovalOption</a> <i>option</i> = NoRemovalRecord )</h3> <p>Removes all QMailMessages identified by the key <i>key</i> from the message store. If <i>option</i> is <a href="qmailstore.html#MessageRemovalOption-enum">QMailStore::CreateRemovalRecord</a> then removal records will be created for each removed message. Returns <tt>true</tt> if the operation completed successfully, <tt>false</tt> otherwise.</p> <p>Note: Using a <a href="qmailmessage.html">QMailMessage</a> instance after it has been removed from the store will result in undefined behavior.</p> -<h3 class="fn"><a name="removeThread"></a>bool QMailStore::removeThread ( const QMailThreadId & <i>id</i>, <a href="qmailstore.html#MessageRemovalOption-enum">MessageRemovalOption</a> <i>option</i> = NoRemovalRecord )</h3> -<p>Removes all QMailThreads identified by the id <i>id</i> from the message store. If <i>option</i> is <a href="qmailstore.html#MessageRemovalOption-enum">QMailStore::CreateRemovalRecord</a> then removal records will be created for each removed message. Returns <tt>true</tt> if the operation completed successfully, <tt>false</tt> otherwise.</p> +<h3 class="fn"><a name="removeThread"></a>bool QMailStore::removeThread ( const <a href="qmailthreadid.html">QMailThreadId</a> & <i>id</i>, <a href="qmailstore.html#MessageRemovalOption-enum">MessageRemovalOption</a> <i>option</i> = NoRemovalRecord )</h3> +<p>Removes all QMailThreads identified by the id <i>id</i> from the message store. If <i>option</i> is <a href="qmailstore.html#MessageRemovalOption-enum">QMailStore::CreateRemovalRecord</a> then removal records will be created for each removed thread. Returns <tt>true</tt> if the operation completed successfully, <tt>false</tt> otherwise.</p> <p>Note: Using a QMailThreads instance after it has been removed from the store will result in undefined behavior.</p> <h3 class="fn"><a name="removeThreads"></a>bool QMailStore::removeThreads ( const <a href="qmailthreadkey.html">QMailThreadKey</a> & <i>key</i>, <a href="qmailstore.html#MessageRemovalOption-enum">QMailStore::MessageRemovalOption</a> <i>option</i> = NoRemovalRecord )</h3> -<p>Removes all QMailThreads identified by the key <i>key</i> from the message store. If <i>option</i> is <a href="qmailstore.html#MessageRemovalOption-enum">QMailStore::CreateRemovalRecord</a> then removal records will be created for each removed message. Returns <tt>true</tt> if the operation completed successfully, <tt>false</tt> otherwise.</p> +<p>Removes all QMailThreads identified by the key <i>key</i> from the message store. If <i>option</i> is <a href="qmailstore.html#MessageRemovalOption-enum">QMailStore::CreateRemovalRecord</a> then removal records will be created for each removed thread. Returns <tt>true</tt> if the operation completed successfully, <tt>false</tt> otherwise.</p> <p>Note: Using a QMailThreads instance after it has been removed from the store will result in undefined behavior.</p> <h3 class="fn"><a name="retrievalInProgress"></a>void QMailStore::retrievalInProgress ( const <a href="qmailaccountid.html#QMailAccountIdList-typedef">QMailAccountIdList</a> & <i>ids</i> ) <tt> [signal]</tt></h3> <p>Signal that is emitted when the set of accounts currently retrieving from external sources is modified to <i>ids</i>. Accounts listed in <i>ids</i> are likely to be the source of numerous mail store signals; some clients may wish to ignore updates associated with these accounts whilst they are engaged in retrieving.</p> @@ -392,12 +395,20 @@ <p>See also <a href="qmailstore.html#transmissionInProgress">transmissionInProgress</a>().</p> <h3 class="fn"><a name="sizeOfMessages"></a>int QMailStore::sizeOfMessages ( const <a href="qmailmessagekey.html">QMailMessageKey</a> & <i>key</i> = QMailMessageKey() ) const</h3> <p>Returns the total size of the messages which pass the filtering criteria defined in <a href="qmailmessagekey.html">QMailMessageKey</a> <i>key</i>. If key is empty the total size of all messages is returned.</p> -<h3 class="fn"><a name="thread"></a><a href="qmailthread.html">QMailThread</a> QMailStore::thread ( const QMailThreadId & <i>id</i> ) const</h3> -<p>Returns the <a href="qmailthread.html">QMailThread</a> defined by QMailThreadId <i>id</i> from the store.</p> -<h3 class="fn"><a name="threadContentsModified"></a>void QMailStore::threadContentsModified ( const QMailThreadIdList & <i>ids</i> ) <tt> [signal]</tt></h3> -<h3 class="fn"><a name="threadsAdded"></a>void QMailStore::threadsAdded ( const QMailThreadIdList & <i>ids</i> ) <tt> [signal]</tt></h3> -<h3 class="fn"><a name="threadsRemoved"></a>void QMailStore::threadsRemoved ( const QMailThreadIdList & <i>ids</i> ) <tt> [signal]</tt></h3> -<h3 class="fn"><a name="threadsUpdated"></a>void QMailStore::threadsUpdated ( const QMailThreadIdList & <i>ids</i> ) <tt> [signal]</tt></h3> +<h3 class="fn"><a name="thread"></a><a href="qmailthread.html">QMailThread</a> QMailStore::thread ( const <a href="qmailthreadid.html">QMailThreadId</a> & <i>id</i> ) const</h3> +<p>Returns the <a href="qmailthread.html">QMailThread</a> defined by <a href="qmailthreadid.html">QMailThreadId</a> <i>id</i> from the store.</p> +<h3 class="fn"><a name="threadContentsModified"></a>void QMailStore::threadContentsModified ( const <a href="qmailthreadid.html#QMailThreadIdList-typedef">QMailThreadIdList</a> & <i>ids</i> ) <tt> [signal]</tt></h3> +<p>Signal that is emitted when changes to messages in the mail store affect the content of the threads in the list <i>ids</i>.</p> +<p>See also <a href="qmailstore.html#messagesAdded">messagesAdded</a>(), <a href="qmailstore.html#messagesUpdated">messagesUpdated</a>(), and <a href="qmailstore.html#messagesRemoved">messagesRemoved</a>().</p> +<h3 class="fn"><a name="threadsAdded"></a>void QMailStore::threadsAdded ( const <a href="qmailthreadid.html#QMailThreadIdList-typedef">QMailThreadIdList</a> & <i>ids</i> ) <tt> [signal]</tt></h3> +<p>Signal that is emitted when the threads in the list <i>ids</i> are added to the store.</p> +<p>See also <a href="qmailstore.html#threadsRemoved">threadsRemoved</a>() and <a href="qmailstore.html#threadsUpdated">threadsUpdated</a>().</p> +<h3 class="fn"><a name="threadsRemoved"></a>void QMailStore::threadsRemoved ( const <a href="qmailthreadid.html#QMailThreadIdList-typedef">QMailThreadIdList</a> & <i>ids</i> ) <tt> [signal]</tt></h3> +<p>Signal that is emitted when the threads in the list <i>ids</i> are removed from the store.</p> +<p>See also <a href="qmailstore.html#threadsAdded">threadsAdded</a>() and <a href="qmailstore.html#threadsUpdated">threadsUpdated</a>().</p> +<h3 class="fn"><a name="threadsUpdated"></a>void QMailStore::threadsUpdated ( const <a href="qmailthreadid.html#QMailThreadIdList-typedef">QMailThreadIdList</a> & <i>ids</i> ) <tt> [signal]</tt></h3> +<p>Signal that is emitted when the threads in the list <i>ids</i> are updated within the store.</p> +<p>See also <a href="qmailstore.html#threadsAdded">threadsAdded</a>() and <a href="qmailstore.html#threadsRemoved">threadsRemoved</a>().</p> <h3 class="fn"><a name="transmissionInProgress"></a>void QMailStore::transmissionInProgress ( const <a href="qmailaccountid.html#QMailAccountIdList-typedef">QMailAccountIdList</a> & <i>ids</i> ) <tt> [signal]</tt></h3> <p>Signal that is emitted when the set of accounts currently transmitting to external sources is modified to <i>ids</i>. Accounts listed in <i>ids</i> are likely to be the source of numerous mail store signals; some clients may wish to ignore updates associated with these accounts whilst they are engaged in transmitting.</p> <p>See also <a href="qmailstore.html#setTransmissionInProgress">setTransmissionInProgress</a>() and <a href="qmailstore.html#retrievalInProgress">retrievalInProgress</a>().</p> @@ -426,7 +437,7 @@ <p>Updates message status flags set in <i>status</i> according to <i>set</i>, for messages which match the criteria defined by <i>key</i>.</p> <p>Returns <tt>true</tt> if the operation completed successfully, or <tt>false</tt> otherwise.</p> <h3 class="fn"><a name="updateThread"></a>bool QMailStore::updateThread ( <a href="qmailthread.html">QMailThread</a> * <i>t</i> )</h3> -<p>Updates existing <a href="qmailthread.html">QMailThread</a> <i>thread</i> in the message store. Returns <tt>true</tt> if the operation completed successfully, <tt>false</tt> otherwise.</p> +<p>Updates existing <a href="qmailthread.html">QMailThread</a> <i>t</i> in the message store. Returns <tt>true</tt> if the operation completed successfully, <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> diff --git a/doc/html/qmailthread.html b/doc/html/qmailthread.html index 45d0d30d..077c5531 100644 --- a/doc/html/qmailthread.html +++ b/doc/html/qmailthread.html @@ -48,13 +48,13 @@ <h2>Member Function Documentation</h2> <h3 class="fn"><a name="QMailThread"></a>QMailThread::QMailThread ()</h3> <p>Constructor that creates an empty and invalid <tt>QMailThread</tt>. An empty thread is one which has no id or messages account. An invalid thread does not exist in the database and has an invalid id.</p> -<h3 class="fn"><a name="QMailThread-2"></a>QMailThread::QMailThread ( const QMailThreadId & <i>id</i> )</h3> -<p>Constructor that creates a <a href="qmailthread.html">QMailThread</a> by loading the data from the message store as specified by the QMailThreadId <i>id</i>. If the thread does not exist in the message store, then this constructor will create an empty and invalid <a href="qmailthread.html">QMailThread</a>.</p> +<h3 class="fn"><a name="QMailThread-2"></a>QMailThread::QMailThread ( const <a href="qmailthreadid.html">QMailThreadId</a> & <i>id</i> )</h3> +<p>Constructor that creates a <a href="qmailthread.html">QMailThread</a> by loading the data from the message store as specified by the <a href="qmailthreadid.html">QMailThreadId</a> <i>id</i>. If the thread does not exist in the message store, then this constructor will create an empty and invalid <a href="qmailthread.html">QMailThread</a>.</p> <h3 class="fn"><a name="QMailThread-3"></a>QMailThread::QMailThread ( const QMailThread & <i>other</i> )</h3> <p>Creates a copy of the <tt>QMailThread</tt> object <i>other</i>.</p> <h3 class="fn"><a name="dtor.QMailThread"></a>QMailThread::~QMailThread ()</h3> <p>Destroys the <tt>QMailThread</tt> object.</p> -<h3 class="fn"><a name="id"></a>QMailThreadId QMailThread::id () const</h3> +<h3 class="fn"><a name="id"></a><a href="qmailthreadid.html">QMailThreadId</a> QMailThread::id () const</h3> <p>Returns the <tt>ID</tt> of the <tt>QMailThread</tt> object. A <tt>QMailThread</tt> with an invalid ID is one which does not yet exist on the message store.</p> <p>See also <a href="qmailthread.html#setId">setId</a>().</p> <h3 class="fn"><a name="messageCount"></a><a href="http://doc.trolltech.com/4.5/qtglobal.html#uint-typedef">uint</a> QMailThread::messageCount () const</h3> @@ -66,7 +66,7 @@ <h3 class="fn"><a name="serverUid"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMailThread::serverUid () const</h3> <p>Gets the serverUid of the thread.</p> <p>See also <a href="qmailthread.html#setServerUid">setServerUid</a>().</p> -<h3 class="fn"><a name="setId"></a>void QMailThread::setId ( const QMailThreadId & <i>id</i> )</h3> +<h3 class="fn"><a name="setId"></a>void QMailThread::setId ( const <a href="qmailthreadid.html">QMailThreadId</a> & <i>id</i> )</h3> <p>Sets the ID of this thread to <i>id</i></p> <p>See also <a href="qmailthread.html#id">id</a>().</p> <h3 class="fn"><a name="setMessageCount"></a>void QMailThread::setMessageCount ( <a href="http://doc.trolltech.com/4.5/qtglobal.html#uint-typedef">uint</a> <i>value</i> )</h3> diff --git a/doc/html/qmailthreadid-members.html b/doc/html/qmailthreadid-members.html new file mode 100644 index 00000000..0601c643 --- /dev/null +++ b/doc/html/qmailthreadid-members.html @@ -0,0 +1,31 @@ +<?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"> +<!-- qmailid.cpp --> +<head> + <title>List of All Members for QMailThreadId</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">List of All Members for QMailThreadId</h1> +<p>This is the complete list of members for <a href="qmailthreadid.html">QMailThreadId</a>, including inherited members.</p> +<ul> +<li><div class="fn"><b><a href="qmailthreadid.html#QMailThreadId">QMailThreadId</a></b> ()</div></li> +<li><div class="fn"><b><a href="qmailthreadid.html#QMailThreadId-2">QMailThreadId</a></b> ( quint64 )</div></li> +<li><div class="fn"><b><a href="qmailthreadid.html#isValid">isValid</a></b> () const : bool</div></li> +<li><div class="fn"><b><a href="qmailthreadid.html#operator-QVariant">operator QVariant</a></b> () const</div></li> +<li><div class="fn"><b><a href="qmailthreadid.html#operator-not-eq">operator!=</a></b> ( const QMailThreadId & ) const : bool</div></li> +<li><div class="fn"><b><a href="qmailthreadid.html#operator-lt">operator<</a></b> ( const QMailThreadId & ) const : bool</div></li> +<li><div class="fn"><b><a href="qmailthreadid.html#operator-eq-eq">operator==</a></b> ( const QMailThreadId & ) const : bool</div></li> +</ul> +<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> diff --git a/doc/html/qmailthreadid.html b/doc/html/qmailthreadid.html new file mode 100644 index 00000000..4f7959bf --- /dev/null +++ b/doc/html/qmailthreadid.html @@ -0,0 +1,70 @@ +<?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"> +<!-- qmailid.cpp --> +<head> + <title>QMailThreadId 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">QMailThreadId Class Reference</h1> +<p>The QMailThreadId class is used to identify threads stored by <a href="qmailstore.html">QMailStore</a>. <a href="#details">More...</a></p> +<pre> #include <QMailThreadId></pre><p><b>This class is under development and is subject to change.</b></p> +<ul> +<li><a href="qmailthreadid-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="qmailthreadid.html#QMailThreadId">QMailThreadId</a></b> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailthreadid.html#QMailThreadId-2">QMailThreadId</a></b> ( quint64 <i>value</i> )</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailthreadid.html#isValid">isValid</a></b> () const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailthreadid.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="qmailthreadid.html#operator-not-eq">operator!=</a></b> ( const QMailThreadId & <i>other</i> ) const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailthreadid.html#operator-lt">operator<</a></b> ( const QMailThreadId & <i>other</i> ) const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailthreadid.html#operator-eq-eq">operator==</a></b> ( const QMailThreadId & <i>other</i> ) const</td></tr> +</table> +<hr /> +<a name="related-non-members"></a> +<h2>Related Non-Members</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="qmailthreadid.html#QMailThreadIdList-typedef">QMailThreadIdList</a></b></td></tr> +</table> +<a name="details"></a> +<hr /> +<h2>Detailed Description</h2> +<p>The QMailThreadId class is used to identify threads stored by <a href="qmailstore.html">QMailStore</a>.</p> +<p>QMailThreadId is a class used to represent threads stored by the <a href="qmailstore.html">QMailStore</a>, identified by their unique numeric internal indentifer.</p> +<p>A QMailThreadId instance can be tested for validity, and compared to other instances for equality. The numeric value of the identifier is not intrinsically meaningful and cannot be modified.</p> +<p>See also <a href="qmailthread.html">QMailThread</a> and <a href="qmailstore.html#thread">QMailStore::thread</a>().</p> +<hr /> +<h2>Member Function Documentation</h2> +<h3 class="fn"><a name="QMailThreadId"></a>QMailThreadId::QMailThreadId ()</h3> +<p>Construct an uninitialized <a href="qmailthreadid.html">QMailThreadId</a>, for which <a href="qmailthreadid.html#isValid">isValid</a>() returns false.</p> +<h3 class="fn"><a name="QMailThreadId-2"></a>QMailThreadId::QMailThreadId ( <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>value</i> )</h3> +<p>Construct a <a href="qmailthreadid.html">QMailThreadId</a> with the supplied numeric identifier <i>value</i>.</p> +<h3 class="fn"><a name="isValid"></a>bool QMailThreadId::isValid () const</h3> +<p>Returns true if this object has been initialized with an identifier.</p> +<h3 class="fn"><a name="operator-QVariant"></a>QMailThreadId::operator QVariant () const</h3> +<p>Returns a <a href="http://doc.trolltech.com/4.5/qvariant.html">QVariant</a> containing the value of this thread identfier.</p> +<h3 class="fn"><a name="operator-not-eq"></a>bool QMailThreadId::operator!= ( const QMailThreadId & <i>other</i> ) const</h3> +<p>Returns true if this object's identifier value differs from that of <i>other</i>.</p> +<h3 class="fn"><a name="operator-lt"></a>bool QMailThreadId::operator< ( const QMailThreadId & <i>other</i> ) const</h3> +<p>Returns true if this object's identifier value is less than that of <i>other</i>.</p> +<h3 class="fn"><a name="operator-eq-eq"></a>bool QMailThreadId::operator== ( const QMailThreadId & <i>other</i> ) const</h3> +<p>Returns true if this object's identifier value is equal to that of <i>other</i>.</p> +<hr /> +<h2>Related Non-Members</h2> +<h3 class="fn"><a name="QMailThreadIdList-typedef"></a>typedef QMailThreadIdList</h3> +<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> diff --git a/doc/html/qmailthreadkey.html b/doc/html/qmailthreadkey.html index 8630083e..c03c5bd1 100644 --- a/doc/html/qmailthreadkey.html +++ b/doc/html/qmailthreadkey.html @@ -100,10 +100,10 @@ <p>Returns the combiner used to combine arguments or sub keys of this <a href="qmailthreadkey.html">QMailThreadKey</a>.</p> <h3 class="fn"><a name="deserialize"></a>void QMailThreadKey::deserialize ( Stream & <i>stream</i> )</h3> <p>Reads the contents of a QMailThradKey from <i>stream</i>.</p> -<h3 class="fn"><a name="id"></a>QMailThreadKey QMailThreadKey::id ( const QMailThreadId & <i>id</i>, <a href="qmaildatacomparator.html#EqualityComparator-enum">QMailDataComparator::EqualityComparator</a> <i>cmp</i> = QMailDataComparator::Equal ) <tt> [static]</tt></h3> +<h3 class="fn"><a name="id"></a>QMailThreadKey QMailThreadKey::id ( const <a href="qmailthreadid.html">QMailThreadId</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 threads 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>QMailThreadKey QMailThreadKey::id ( const QMailThreadIdList & <i>ids</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> = QMailDataComparator::Includes ) <tt> [static]</tt></h3> +<h3 class="fn"><a name="id-2"></a>QMailThreadKey QMailThreadKey::id ( const <a href="qmailthreadid.html#QMailThreadIdList-typedef">QMailThreadIdList</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 threads whose identifier is a member of <i>ids</i>, according to <i>cmp</i>.</p> <p>See also <a href="qmailthread.html#id">QMailThread::id</a>().</p> <h3 class="fn"><a name="id-3"></a>QMailThreadKey QMailThreadKey::id ( const QMailThreadKey & <i>key</i>, <a href="qmaildatacomparator.html#InclusionComparator-enum">QMailDataComparator::InclusionComparator</a> <i>cmp</i> = QMailDataComparator::Includes ) <tt> [static]</tt></h3> diff --git a/doc/html/qmf.qhp b/doc/html/qmf.qhp index 59b5121f..3c82a445 100644 --- a/doc/html/qmf.qhp +++ b/doc/html/qmf.qhp @@ -248,6 +248,9 @@ <section ref="qmailthread.html" title="QMailThread Class Reference"> <section ref="qmailthread-members.html" title="List of all members"/> </section> + <section ref="qmailthreadid.html" title="QMailThreadId Class Reference"> + <section ref="qmailthreadid-members.html" title="List of all members"/> + </section> <section ref="qmailthreadkey.html" title="QMailThreadKey Class Reference"> <section ref="qmailthreadkey-members.html" title="List of all members"/> </section> @@ -1604,6 +1607,13 @@ <keyword name="setUnreadCount" id="QMailThread::setUnreadCount" ref="qmailthread.html#setUnreadCount"/> <keyword name="unreadCount" id="QMailThread::unreadCount" ref="qmailthread.html#unreadCount"/> <keyword name="~QMailThread" id="QMailThread::~QMailThread" ref="qmailthread.html#dtor.QMailThread"/> + <keyword name="QMailThreadId" id="QMailThreadId" ref="qmailthreadid.html"/> + <keyword name="isValid" id="QMailThreadId::isValid" ref="qmailthreadid.html#isValid"/> + <keyword name="operator QVariant" id="QMailThreadId::operator QVariant" ref="qmailthreadid.html#operator-QVariant"/> + <keyword name="operator!=" id="QMailThreadId::operator!=" ref="qmailthreadid.html#operator-not-eq"/> + <keyword name="operator<" id="QMailThreadId::operator<" ref="qmailthreadid.html#operator-lt"/> + <keyword name="operator==" id="QMailThreadId::operator==" ref="qmailthreadid.html#operator-eq-eq"/> + <keyword name="QMailThreadIdList" id="QMailThreadIdList" ref="qmailthreadid.html#QMailThreadIdList-typedef"/> <keyword name="QMailThreadKey" id="QMailThreadKey" ref="qmailthreadkey.html"/> <keyword name="QMailThreadKey::ArgumentType" id="QMailThreadKey::ArgumentType" ref="qmailthreadkey.html#ArgumentType-typedef"/> <keyword name="QMailThreadKey::Property" id="QMailThreadKey::Property" ref="qmailthreadkey.html#Property-enum"/> @@ -1702,6 +1712,7 @@ <file>qmailcontentmanager-members.html</file> <file>qmailaccountmessageset-members.html</file> <file>qmailpluginmanager-members.html</file> + <file>qmailthreadid-members.html</file> <file>qtextendedmail-qmfutil.html</file> <file>qtextended-messaging.html</file> <file>qmailmessageserver-members.html</file> @@ -1835,6 +1846,7 @@ <file>qmailfolderkey-members.html</file> <file>qmailmessagecontentdispositionfwd.html</file> <file>qmailcodec-members.html</file> + <file>qmailthreadid.html</file> <file>qmailmessageservicefactory.html</file> <file>qmailaddress.html</file> <file>qmailcontentmanagerplugin.html</file> diff --git a/doc/html/qt-messaging-framework.dcf b/doc/html/qt-messaging-framework.dcf index bb0ef1dd..102ed21a 100644 --- a/doc/html/qt-messaging-framework.dcf +++ b/doc/html/qt-messaging-framework.dcf @@ -1559,6 +1559,16 @@ <keyword ref="qmailthread.html#operator-eq">operator=</keyword> <section ref="qmailthread-members.html" title="List of all members"/> </section> + <section ref="qmailthreadid.html" title="QMailThreadId Class Reference"> + <keyword ref="qmailthreadid.html">QMailThreadId</keyword> + <keyword ref="qmailthreadid.html#isValid">isValid</keyword> + <keyword ref="qmailthreadid.html#operator-QVariant">operator QVariant</keyword> + <keyword ref="qmailthreadid.html#operator-not-eq">operator!=</keyword> + <keyword ref="qmailthreadid.html#operator-lt">operator<</keyword> + <keyword ref="qmailthreadid.html#operator-eq-eq">operator==</keyword> + <keyword ref="qmailthreadid.html#QMailThreadIdList-typedef">QMailThreadIdList</keyword> + <section ref="qmailthreadid-members.html" title="List of all members"/> + </section> <section ref="qmailthreadkey.html" title="QMailThreadKey Class Reference"> <keyword ref="qmailthreadkey.html">QMailThreadKey</keyword> <keyword ref="qmailthreadkey.html#ArgumentType-typedef">ArgumentType</keyword> diff --git a/doc/html/qt-messaging-framework.index b/doc/html/qt-messaging-framework.index index 08ff0293..63205196 100644 --- a/doc/html/qt-messaging-framework.index +++ b/doc/html/qt-messaging-framework.index @@ -1256,7 +1256,7 @@ <function access="public" threadsafety="unspecified" status="commendable" name="addMessages" fullname="QMailStore::addMessages" href="qmailstore.html#addMessages-2" location="qmailstore.h" virtual="non" meta="plain" const="false" static="false" overload="true" overload-number="2" type="bool" signature="addMessages(const QList<QMailMessageMetaData *> & messages)"> <parameter left="const QList<QMailMessageMetaData *> &" right="" name="messages" default=""/> </function> - <function access="public" threadsafety="unspecified" status="commendable" name="addThread" fullname="QMailStore::addThread" href="qmailstore.html#addThread" location="qmailstore.cpp" virtual="non" meta="plain" const="false" static="false" overload="false" type="bool" signature="addThread(QMailThread * t)"> + <function access="public" threadsafety="unspecified" status="commendable" name="addThread" fullname="QMailStore::addThread" href="qmailstore.html#addThread" location="qmailstore.h" virtual="non" meta="plain" const="false" static="false" overload="false" type="bool" signature="addThread(QMailThread * t)"> <parameter left="QMailThread *" right="" name="t" default=""/> </function> <function access="public" threadsafety="unspecified" status="commendable" name="removeAccount" fullname="QMailStore::removeAccount" href="qmailstore.html#removeAccount" location="qmailstore.h" virtual="non" meta="plain" const="false" static="false" overload="false" type="bool" signature="removeAccount(const QMailAccountId & id)"> @@ -1657,9 +1657,27 @@ <parameter left="const QMailMessageId &" right="" name="other" default=""/> </function> </class> + <class access="public" threadsafety="unspecified" status="preliminary" name="QMailThreadId" href="qmailthreadid.html" location="qmailid.h" bases="" module=""> + <function access="public" threadsafety="unspecified" status="commendable" name="QMailThreadId" fullname="QMailThreadId::QMailThreadId" href="qmailthreadid.html#QMailThreadId" location="qmailid.h" virtual="non" meta="constructor" const="false" static="false" overload="false" type="" signature="QMailThreadId()"/> + <function access="public" threadsafety="unspecified" status="commendable" name="QMailThreadId" fullname="QMailThreadId::QMailThreadId" href="qmailthreadid.html#QMailThreadId-2" location="qmailid.h" virtual="non" meta="constructor" const="false" static="false" overload="true" overload-number="2" type="" signature="QMailThreadId(quint64 value)"> + <parameter left="quint64" right="" name="value" default=""/> + </function> + <function access="public" threadsafety="unspecified" status="commendable" name="isValid" fullname="QMailThreadId::isValid" href="qmailthreadid.html#isValid" location="qmailid.h" virtual="non" meta="plain" const="true" static="false" overload="false" type="bool" signature="isValid() const"/> + <function access="public" threadsafety="unspecified" status="commendable" name="operator QVariant" fullname="QMailThreadId::operator QVariant" href="qmailthreadid.html#operator QVariant" location="qmailid.h" virtual="non" meta="plain" const="true" static="false" overload="false" type="" signature="operator QVariant() const"/> + <function access="public" threadsafety="unspecified" status="commendable" name="operator!=" fullname="QMailThreadId::operator!=" href="qmailthreadid.html#operator!=" location="qmailid.h" virtual="non" meta="plain" const="true" static="false" overload="false" type="bool" signature="operator!=(const QMailThreadId & other) const"> + <parameter left="const QMailThreadId &" right="" name="other" default=""/> + </function> + <function access="public" threadsafety="unspecified" status="commendable" name="operator==" fullname="QMailThreadId::operator==" href="qmailthreadid.html#operator==" location="qmailid.h" virtual="non" meta="plain" const="true" static="false" overload="false" type="bool" signature="operator==(const QMailThreadId & other) const"> + <parameter left="const QMailThreadId &" right="" name="other" default=""/> + </function> + <function access="public" threadsafety="unspecified" status="commendable" name="operator<" fullname="QMailThreadId::operator<" href="qmailthreadid.html#operator<" location="qmailid.h" virtual="non" meta="plain" const="true" static="false" overload="false" type="bool" signature="operator<(const QMailThreadId & other) const"> + <parameter left="const QMailThreadId &" right="" name="other" default=""/> + </function> + </class> <typedef access="public" threadsafety="unspecified" status="commendable" name="QMailAccountIdList" href="qmailaccountid.html#QMailAccountIdList-typedef" location="qmailid.h"/> <typedef access="public" threadsafety="unspecified" status="commendable" name="QMailFolderIdList" href="qmailfolderid.html#QMailFolderIdList-typedef" location="qmailid.h"/> <typedef access="public" threadsafety="unspecified" status="commendable" name="QMailMessageIdList" href="qmailmessageid.html#QMailMessageIdList-typedef" location="qmailid.h"/> + <typedef access="public" threadsafety="unspecified" status="commendable" name="QMailThreadIdList" href="qmailthreadid.html#QMailThreadIdList-typedef" location="qmailid.h"/> <class access="public" threadsafety="unspecified" status="preliminary" name="QMailMessageRemovalRecord" href="qmailmessageremovalrecord.html" location="qmailmessageremovalrecord.h" bases="" module=""> <function access="public" threadsafety="unspecified" status="commendable" name="QMailMessageRemovalRecord" fullname="QMailMessageRemovalRecord::QMailMessageRemovalRecord" href="qmailmessageremovalrecord.html#QMailMessageRemovalRecord" location="qmailmessageremovalrecord.h" virtual="non" meta="constructor" const="false" static="false" overload="false" type="" signature="QMailMessageRemovalRecord(const QMailAccountId & parentAccountId, const QString & serverUid, const QMailFolderId & parentFolderId)"> <parameter left="const QMailAccountId &" right="" name="parentAccountId" default=""/> @@ -4173,6 +4191,7 @@ <contents name="overview" title="Overview" level="1"/> <contents name="composition-and-manipulation-of-messages" title="Composition and Manipulation of Messages" level="1"/> <contents name="message-accounts" title="Message Accounts" level="1"/> + <contents name="message-threads" title="Message threads" level="1"/> <contents name="message-listing" title="Message Listing" level="1"/> <contents name="message-navigation" title="Message Navigation" level="1"/> <contents name="sorting-and-searching-functionality" title="Sorting and Searching Functionality" level="1"/> diff --git a/doc/html/qtextendedmail.html b/doc/html/qtextendedmail.html index 532cb971..82608eb4 100644 --- a/doc/html/qtextendedmail.html +++ b/doc/html/qtextendedmail.html @@ -17,6 +17,7 @@ <ul><li><a href="#overview">Overview</a></li> <li><a href="#composition-and-manipulation-of-messages">Composition and Manipulation of Messages</a></li> <li><a href="#message-accounts">Message Accounts</a></li> +<li><a href="#message-threads">Message threads</a></li> <li><a href="#message-listing">Message Listing</a></li> <li><a href="#message-navigation">Message Navigation</a></li> <li><a href="#sorting-and-searching-functionality">Sorting and Searching Functionality</a></li> @@ -71,6 +72,15 @@ <tr valign="top" class="odd"><td><a href="qmailmessageremovalrecord.html">QMailMessageRemovalRecord</a></td><td>Represents a message deleted from the local mail store.</td></tr> <tr valign="top" class="even"><td><a href="qmailaccountconfiguration.html">QMailAccountConfiguration</a></td><td>Contains the configuration details for an account.</td></tr> </table></p> +<a name="message-threads"></a> +<h2>Message threads</h2> +<p>The Client Library provides classes for storing information about message threads (a.k.a. conversations).</p> +<p>Classes relating to message threads:</p> +<p><table class="generic" align="center" cellpadding="2" cellspacing="1" border="0"> +<thead><tr valign="top" class="qt-style"><th>Class</th><th>Description</th></tr></thead> +<tr valign="top" class="odd"><td><a href="qmailthreadid.html">QMailThreadId</a></td><td>Represents the mail store identifiers for thread records.</td></tr> +<tr valign="top" class="even"><td><a href="qmailthread.html">QMailThread</a></td><td>Stores attributes for a message thread.</td></tr> +</table></p> <a name="message-listing"></a> <h2>Message Listing</h2> <p>The Client library provides classes to assist with displaying lists of message data. These classes allow clients to display lists of messages and accounts with minimal effort, and with minimal resource consumption.</p> @@ -105,6 +115,8 @@ <tr valign="top" class="odd"><td><a href="qmailaccountsortkey.html">QMailAccountSortKey</a></td><td>Defines the parameters used for sorting accounts queried from the mail store.</td></tr> <tr valign="top" class="even"><td><a href="qmailfolderkey.html">QMailFolderKey</a></td><td>Defines the parameters used for querying a subset of all available mail folders from the mail store.</td></tr> <tr valign="top" class="odd"><td><a href="qmailfoldersortkey.html">QMailFolderSortKey</a></td><td>Defines the parameters used for sorting mail folders queried from the mail store.</td></tr> +<tr valign="top" class="even"><td><a href="qmailthreadkey.html">QMailThreadKey</a></td><td>Defines the parameters used for querying a subset of all available threads from the mail store.</td></tr> +<tr valign="top" class="odd"><td><a href="qmailthreadsortkey.html">QMailThreadSortKey</a></td><td>Defines the parameters used for sorting threads queried from the mail store.</td></tr> <tr valign="top" class="even"><td><a href="qmailmessagekey.html">QMailMessageKey</a></td><td>Defines the parameters used for querying a subset of all available mail messages from the mail store.</td></tr> <tr valign="top" class="odd"><td><a href="qmailmessagesortkey.html">QMailMessageSortKey</a></td><td>Defines the parameters used for sorting messages queried from the mail store.</td></tr> </table></p> |