Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 50facae208d4a6f280e44a513b104320 > files > 1117

qt-mobility-doc-1.2.0-13.mga5.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qmessagefolder.cpp -->
  <title>Qt Mobility 1.2: QMessageFolder Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtmessaging.html">QtMessaging</a></li>
<li>QMessageFolder</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QMessageFolder Class Reference</h1>
<!-- $$$QMessageFolder-brief -->
<p>The QMessageFolder class provides an interface for folders containing messages in the messaging store. <a href="#details">More...</a></p>
<!-- @@@QMessageFolder -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QMessageFolder&gt;</span></pre><p>This class was introduced in Qt Mobility 1.0.</p>
<ul>
<li><a href="qmessagefolder-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolder.html#QMessageFolder">QMessageFolder</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolder.html#QMessageFolder-2">QMessageFolder</a></b> ( const QMessageFolderId &amp; <i>id</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolder.html#QMessageFolder-3">QMessageFolder</a></b> ( const QMessageFolder &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolder.html#dtor.QMessageFolder">~QMessageFolder</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderId </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolder.html#id">id</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolder.html#name">name</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageAccountId </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolder.html#parentAccountId">parentAccountId</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMessageFolderId </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolder.html#parentFolderId">parentFolderId</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qmessagefolder.html#path">path</a></b> () const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QMessageFolder-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QMessageFolder class provides an interface for folders containing messages in the messaging store.</p>
<p>QMessageFolder represents a folder of messages, either fully or partially stored in the messaging store. A QMessageFolder object has an optional parent of the same type, allowing folders to be arranged in tree structures. Messages may be associated with folders, allowing for simple classification and access by their parentFolderId property.</p>
</div>
<p><b>See also </b><a href="qmessage.html">QMessage</a> and <a href="qmessagestore.html#folder">QMessageStore::folder</a>().</p>
<!-- @@@QMessageFolder -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QMessageFolder[overload1]$$$QMessageFolder -->
<h3 class="fn"><a name="QMessageFolder"></a>QMessageFolder::<span class="name">QMessageFolder</span> ()</h3>
<p>Constructor that creates an empty and invalid <a href="qmessagefolder.html">QMessageFolder</a>. An empty folder is one which has no path, no parent folder and no parent account. An invalid folder does not exist in the database and has an invalid id.</p>
<!-- @@@QMessageFolder -->
<!-- $$$QMessageFolder$$$QMessageFolderconstQMessageFolderId& -->
<h3 class="fn"><a name="QMessageFolder-2"></a>QMessageFolder::<span class="name">QMessageFolder</span> ( const <span class="type"><a href="qmessagefolderid.html">QMessageFolderId</a></span> &amp; <i>id</i> )</h3>
<p>Constructor that creates a <a href="qmessagefolder.html">QMessageFolder</a> by loading the data from the messaging store as specified by the <a href="qmessagefolderid.html">QMessageFolderId</a> <i>id</i>. If the folder does not exist in the messaging store, then this constructor will create an empty and invalid <a href="qmessagefolder.html">QMessageFolder</a>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@QMessageFolder -->
<!-- $$$QMessageFolder$$$QMessageFolderconstQMessageFolder& -->
<h3 class="fn"><a name="QMessageFolder-3"></a>QMessageFolder::<span class="name">QMessageFolder</span> ( const <span class="type">QMessageFolder</span> &amp; <i>other</i> )</h3>
<p>Constructs a copy of <i>other</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@QMessageFolder -->
<!-- $$$~QMessageFolder[overload1]$$$~QMessageFolder -->
<h3 class="fn"><a name="dtor.QMessageFolder"></a>QMessageFolder::<span class="name">~QMessageFolder</span> ()<tt> [virtual]</tt></h3>
<p>Destroys the <a href="qmessagefolder.html">QMessageFolder</a> object.</p>
<!-- @@@~QMessageFolder -->
<!-- $$$id[overload1]$$$id -->
<h3 class="fn"><a name="id"></a><span class="type"><a href="qmessagefolderid.html">QMessageFolderId</a></span> QMessageFolder::<span class="name">id</span> () const</h3>
<p>Returns the identifier of the <a href="qmessagefolder.html">QMessageFolder</a> object. A <a href="qmessagefolder.html">QMessageFolder</a> with an invalid identifier does not yet exist in the messaging store.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@id -->
<!-- $$$name[overload1]$$$name -->
<h3 class="fn"><a name="name"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QMessageFolder::<span class="name">name</span> () const</h3>
<p>Returns the display name of the folder suitable for viewing in a user interface. This is typically the same as, or a simplification of the <a href="qmessagefolder.html#path">path</a>() for the folder.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@name -->
<!-- $$$parentAccountId[overload1]$$$parentAccountId -->
<h3 class="fn"><a name="parentAccountId"></a><span class="type"><a href="qmessageaccountid.html">QMessageAccountId</a></span> QMessageFolder::<span class="name">parentAccountId</span> () const</h3>
<p>Returns the identifier of the parent account of the folder. If the folder is not linked to an account an invalid identifier is returned.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@parentAccountId -->
<!-- $$$parentFolderId[overload1]$$$parentFolderId -->
<h3 class="fn"><a name="parentFolderId"></a><span class="type"><a href="qmessagefolderid.html">QMessageFolderId</a></span> QMessageFolder::<span class="name">parentFolderId</span> () const</h3>
<p>Returns the identifier of the parent folder. This folder is a root folder if the parent identifier is invalid.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@parentFolderId -->
<!-- $$$path[overload1]$$$path -->
<h3 class="fn"><a name="path"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QMessageFolder::<span class="name">path</span> () const</h3>
<p>Returns the path of the folder.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@path -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
  <p>
     <acronym title="Copyright">&copy;</acronym> 2008-2011 Nokia Corporation and/or its
     subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
     in Finland and/or other countries worldwide.</p>
  <p>
     All other trademarks are property of their respective owners. <a title="Privacy Policy"
     href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
  <br />
  <p>
    Licensees holding valid Qt Commercial licenses may use this document in accordance with the    Qt Commercial License Agreement provided with the Software or, alternatively, in accordance    with the terms contained in a written agreement between you and Nokia.</p>
  <p>
    Alternatively, this document may be used under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU
    Free Documentation License version 1.3</a>
    as published by the Free Software Foundation.</p>
</div>
</body>
</html>