Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > b77dda48f87d4eda8cc559e40c49a652 > files > 90

python-kde4-doc-4.4.5-0.2mdv2010.2.i586.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">

<head>
  <title>Akonadi.SpecialMailCollections</title>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta http-equiv="Content-Style-Type" content="text/css" />
  <link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
  <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
  <div id="header_top">
    <div>
      <div>
        <img alt ="" src="../common/top-kde.jpg"/>
        KDE 4.4 PyKDE API Reference
      </div>
    </div>
  </div>
  <div id="header_bottom">
    <div id="location">
      <ul>
        <li>KDE's Python API</li>
      </ul>
    </div>

    <div id="menu">
      <ul>
        <li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
    </div>
  </div>
</div>

<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer">&nbsp;</div>

<h1>SpecialMailCollections Class Reference</h1>
<code>from PyKDE4.akonadi import *</code>
<p>
Inherits: Akonadi.SpecialCollections &#x2192; <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a><br />

Namespace: Akonadi.SpecialMailCollections<br />
<h2>Detailed Description</h2>
<dl class="abstract" compact><dt><b>Abstract class:</b></dt>
<dd>This class can be used as a base class for new classes, but can not be instantiated directly.</dd></dl>
<p>Interface to special mail collections such as inbox, outbox etc.
</p>
<p>
This class is the central interface to the local mail folders. These folders
can either be in the default resource (stored in ~/.local/share/local-mail)
or in any number of custom resources. Special collections of the following types
are supported: inbox, outbox, sent-mail, trash, drafts, templates and spam.
</p>
<p>
To check whether a special mail collection is available, simply use the hasCollection() and
hasDefaultCollection() methods. Available special mail collections are accessible through
the collection() and defaultCollection() methods.
</p>
<p>
To create a special mail collection, use a SpecialMailCollectionsRequestJob.
This will create the special mail collections you request and automatically
register them with SpecialMailCollections, so that it now knows they are available.
</p>
<p>
This class monitors all special mail collections known to it, and removes it
from the known list if they are deleted. Note that this class does not
automatically rebuild the collections that disappeared.
</p>
<p>
The defaultCollectionsChanged() and collectionsChanged() signals are emitted when
the special mail collections for a resource change (i.e. some became available or some
become unavailable).
</p>
<p>
<pre class="fragment">
if( SpecialMailCollections.self()-&gt;hasDefaultCollection( SpecialMailCollections.Outbox ) ) {
const Collection col = SpecialMailCollections.self()-&gt;defaultCollection( SpecialMailCollections.Outbox );
// ...
} else {
// ... use SpecialMailCollectionsRequestJob to request the collection...
}
</pre>
</p>
<p>

<dl class="author" compact><dt><b>Author:</b></dt><dd> Constantin Berzan &lt;exit3219@gmail.com&gt; </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Type">Type</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;Invalid, Root, Inbox, Outbox, SentMail, Trash, Drafts, Templates, LastType&nbsp;}</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#collection">collection</a> (self, <a href="../akonadi/Akonadi.SpecialMailCollections.html#Type">Akonadi.SpecialMailCollections.Type</a> type, <a href="../akonadi/Akonadi.AgentInstance.html">Akonadi.AgentInstance</a> instance)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#defaultCollection">defaultCollection</a> (self, <a href="../akonadi/Akonadi.SpecialMailCollections.html#Type">Akonadi.SpecialMailCollections.Type</a> type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#hasCollection">hasCollection</a> (self, <a href="../akonadi/Akonadi.SpecialMailCollections.html#Type">Akonadi.SpecialMailCollections.Type</a> type, <a href="../akonadi/Akonadi.AgentInstance.html">Akonadi.AgentInstance</a> instance)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#hasDefaultCollection">hasDefaultCollection</a> (self, <a href="../akonadi/Akonadi.SpecialMailCollections.html#Type">Akonadi.SpecialMailCollections.Type</a> type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#registerCollection">registerCollection</a> (self, <a href="../akonadi/Akonadi.SpecialMailCollections.html#Type">Akonadi.SpecialMailCollections.Type</a> type, <a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a> collection)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../akonadi/Akonadi.SpecialMailCollections.html">Akonadi.SpecialMailCollections</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#self">self</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="collection"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a> collection</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.SpecialMailCollections.html#Type">Akonadi.SpecialMailCollections.Type</a>&nbsp;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.AgentInstance.html">Akonadi.AgentInstance</a>&nbsp;</td>
<td class="paramname"><em>instance</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the special mail collection of the given <b>type</b> in the given agent
<b>instance,</b> or an invalid collection if such a collection is unknown.
</p></div></div><a class="anchor" name="defaultCollection"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a> defaultCollection</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.SpecialMailCollections.html#Type">Akonadi.SpecialMailCollections.Type</a>&nbsp;</td>
<td class="paramname"><em>type</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the special mail collection of given <b>type</b> in the default
resource, or an invalid collection if such a collection is unknown.
</p></div></div><a class="anchor" name="hasCollection"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool hasCollection</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.SpecialMailCollections.html#Type">Akonadi.SpecialMailCollections.Type</a>&nbsp;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.AgentInstance.html">Akonadi.AgentInstance</a>&nbsp;</td>
<td class="paramname"><em>instance</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns whether the given agent <b>instance</b> has a special collection of
the given <b>type.</b>
</p></div></div><a class="anchor" name="hasDefaultCollection"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool hasDefaultCollection</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.SpecialMailCollections.html#Type">Akonadi.SpecialMailCollections.Type</a>&nbsp;</td>
<td class="paramname"><em>type</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns whether the default resource has a special mail collection of
the given <b>type.</b>
</p></div></div><a class="anchor" name="registerCollection"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool registerCollection</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.SpecialMailCollections.html#Type">Akonadi.SpecialMailCollections.Type</a>&nbsp;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a>&nbsp;</td>
<td class="paramname"><em>collection</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Registers the given <b>collection</b> as a special mail collection
with the given <b>type.</b>
</p>
<p>
The collection must be owned by a valid resource.
Registering a new collection of a previously registered type forgets the
old collection.
</p></div></div><a class="anchor" name="self"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../akonadi/Akonadi.SpecialMailCollections.html">Akonadi.SpecialMailCollections</a> self</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the global SpecialMailCollections instance.
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Type"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Type</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Describes the possible types of special mail collections.
</p>
<p>
Generally, there may not be two special mail collections of
the same type in the same resource.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>CreateCollection</em>&nbsp;</td><td><tr><td valign="top"><em>CopyCollections</em>&nbsp;</td><td><tr><td valign="top"><em>DeleteCollections</em>&nbsp;</td><td><tr><td valign="top"><em>SynchronizeCollections</em>&nbsp;</td><td><tr><td valign="top"><em>CollectionProperties</em>&nbsp;</td><td><tr><td valign="top"><em>CopyItems</em>&nbsp;</td><td><tr><td valign="top"><em>Paste</em>&nbsp;</td><td><tr><td valign="top"><em>DeleteItems</em>&nbsp;</td><td><tr><td valign="top"><em>ManageLocalSubscriptions</em>&nbsp;</td><td><tr><td valign="top"><em>AddToFavoriteCollections</em>&nbsp;</td><td><tr><td valign="top"><em>RemoveFromFavoriteCollections</em>&nbsp;</td><td><tr><td valign="top"><em>RenameFavoriteCollection</em>&nbsp;</td><td><tr><td valign="top"><em>CopyCollectionToMenu</em>&nbsp;</td><td><tr><td valign="top"><em>CopyItemToMenu</em>&nbsp;</td><td><tr><td valign="top"><em>MoveItemToMenu</em>&nbsp;</td><td><tr><td valign="top"><em>MoveCollectionToMenu</em>&nbsp;</td><td><tr><td valign="top"><em>CutItems</em>&nbsp;</td><td><tr><td valign="top"><em>CutCollections</em>&nbsp;</td><td><tr><td valign="top"><em>LastType</em>&nbsp;</td><td></table>
</dl>
</div></div><p>
</div>
</div>
</div>

<div id="left">

<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>

<a name="cp-menu" /><div class="menutitle"><div>
  <h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>

</div>

</div>
  <div class="clearer"/>
</div>

<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;simon&#64;simonzone&#46;com">Simon Edwards</a>.<br />
        KDE<sup>&#174;</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>&#174;</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
        <a href="http://www.kde.org/contact/impressum.php">Legal</a>
    </div></div>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional