<?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.Collection</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.9 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"> </div> <h1>Collection Class Reference</h1> <code>from PyKDE4.akonadi import *</code> <p> Inherits: <a href="../akonadi/Akonadi.Entity.html">Akonadi.Entity</a><br /> Namespace: <a href="../akonadi/Akonadi.html">Akonadi</a><br /> <h2>Detailed Description</h2> <p>Represents a collection of PIM items. </p> <p> This class represents a collection of PIM items, such as a folder on a mail- or groupware-server. </p> <p> Collections are hierarchical, i.e., they may have a parent collection. </p> <p> <pre class="fragment"> using namespace Akonadi; // fetching all collections recursive, starting at the root collection CollectionFetchJob *job = new CollectionFetchJob( Collection.root(), CollectionFetchJob.Recursive ); connect( job, SIGNAL( result( KJob* ) ), SLOT( fetchFinished( KJob* ) ) ); ... MyClass.fetchFinished( KJob *job ) { if ( job->error() ) { qDebug() << "Error occurred"; return; } CollectionFetchJob *fetchJob = qobject_cast<CollectionFetchJob*>( job ); const Collection.List collections = fetchJob->collections(); foreach ( const Collection &collection, collections ) { qDebug() << "Name:" << collection.name(); } } </pre> </p> <p> <dl class="author" compact><dt><b>Author:</b></dt><dd> Volker Krause <vkrause@kde.org> </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="#Right">Right</a> </td><td class="memItemRight" valign="bottom">{ ReadOnly, CanChangeItem, CanCreateItem, CanDeleteItem, CanChangeCollection, CanCreateCollection, CanDeleteCollection, CanLinkItem, CanUnlinkItem, AllRights }</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#UrlType">UrlType</a> </td><td class="memItemRight" valign="bottom">{ UrlShort, UrlWithName }</td></tr> <tr><td colspan="2"><br><h2>Methods</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Collection">__init__</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Collection">__init__</a> (self, <a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a> other)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Collection">__init__</a> (self, long id)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../akonadi/Akonadi.CachePolicy.html">Akonadi.CachePolicy</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#cachePolicy">cachePolicy</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#contentMimeTypes">contentMimeTypes</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isVirtual">isVirtual</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#name">name</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">Id </td><td class="memItemRight" valign="bottom"><a class="el" href="#parent">parent</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#parentRemoteId">parentRemoteId</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#resource">resource</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection.Rights</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#rights">rights</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setCachePolicy">setCachePolicy</a> (self, <a href="../akonadi/Akonadi.CachePolicy.html">Akonadi.CachePolicy</a> policy)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setContentMimeTypes">setContentMimeTypes</a> (self, QStringList types)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setName">setName</a> (self, QString name)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setParent">setParent</a> (self, <a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a> collection)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setParent">setParent</a> (self, long parent)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setParentRemoteId">setParentRemoteId</a> (self, QString identifier)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setResource">setResource</a> (self, QString identifier)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setRights">setRights</a> (self, <a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection.Rights</a> rights)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setStatistics">setStatistics</a> (self, <a href="../akonadi/Akonadi.CollectionStatistics.html">Akonadi.CollectionStatistics</a> statistics)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../akonadi/Akonadi.CollectionStatistics.html">Akonadi.CollectionStatistics</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#statistics">statistics</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KUrl.html">KUrl</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#url">url</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KUrl.html">KUrl</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#url">url</a> (self, <a href="../akonadi/Akonadi.Collection.html#UrlType">Akonadi.Collection.UrlType</a> type)</td></tr> <tr><td colspan="2"><br><h2>Static Methods</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#fromUrl">fromUrl</a> (<a href="../kdecore/KUrl.html">KUrl</a> url)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#mimeType">mimeType</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#root">root</a> ()</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">__init__</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Creates an invalid collection. </p></div></div><a class="anchor" name="Collection"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">__init__</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a> </td> <td class="paramname"><em>other</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Creates a collection from an <b>other</b> collection. </p></div></div><a class="anchor" name="Collection"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">__init__</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">long </td> <td class="paramname"><em>id</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Create a new collection. </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>id</em> </td><td> The unique identifier of the collection. </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="cachePolicy"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../akonadi/Akonadi.CachePolicy.html">Akonadi.CachePolicy</a> cachePolicy</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Returns the cache policy of the collection. </p></div></div><a class="anchor" name="contentMimeTypes"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QStringList contentMimeTypes</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Returns a list of possible content mimetypes, e.g. message/rfc822, x-akonadi/collection for a mail folder that supports sub-folders. </p></div></div><a class="anchor" name="isVirtual"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isVirtual</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Returns whether the collection is virtual, for example a search collection. </p> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6 </dd></dl> </p></div></div><a class="anchor" name="name"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString name</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Returns the i18n'ed name of the collection. </p></div></div><a class="anchor" name="parent"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">Id parent</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Returns the identifier of the parent collection. <dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd> Use parentCollection() </dd></dl> </p></div></div><a class="anchor" name="parentRemoteId"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString parentRemoteId</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Returns the parent remote identifier. <dl class="note" compact><dt><b>Note:</b></dt><dd> This usually returns nothing for collections retrieved from the backend. </dd></dl> <dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd> Use parentCollection() </dd></dl> </p></div></div><a class="anchor" name="resource"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString resource</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Returns the identifier of the resource owning the collection. </p></div></div><a class="anchor" name="rights"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection.Rights</a> rights</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Returns the rights the user has on the collection. </p></div></div><a class="anchor" name="setCachePolicy"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setCachePolicy</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../akonadi/Akonadi.CachePolicy.html">Akonadi.CachePolicy</a> </td> <td class="paramname"><em>policy</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Sets the cache <b>policy</b> of the collection. </p></div></div><a class="anchor" name="setContentMimeTypes"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setContentMimeTypes</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">QStringList </td> <td class="paramname"><em>types</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Sets the list of possible content mime <b>types.</b> </p></div></div><a class="anchor" name="setName"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setName</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">QString </td> <td class="paramname"><em>name</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Sets the i18n'ed name of the collection. </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>name</em> </td><td> The new collection name. </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="setParent"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setParent</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a> </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>Sets the parent <b>collection.</b> <dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd> Use setParentCollection() </dd></dl> </p></div></div><a class="anchor" name="setParent"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setParent</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">long </td> <td class="paramname"><em>parent</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Sets the parent <b>collection.</b> <dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd> Use setParentCollection() </dd></dl> </p></div></div><a class="anchor" name="setParentRemoteId"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setParentRemoteId</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">QString </td> <td class="paramname"><em>identifier</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Sets the parent's remote <b>identifier.</b> <dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd> Use setParentCollection() </dd></dl> </p></div></div><a class="anchor" name="setResource"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setResource</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">QString </td> <td class="paramname"><em>identifier</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Sets the <b>identifier</b> of the resource owning the collection. </p></div></div><a class="anchor" name="setRights"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setRights</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection.Rights</a> </td> <td class="paramname"><em>rights</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Sets the <b>rights</b> the user has on the collection. </p></div></div><a class="anchor" name="setStatistics"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setStatistics</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../akonadi/Akonadi.CollectionStatistics.html">Akonadi.CollectionStatistics</a> </td> <td class="paramname"><em>statistics</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Sets the collection <b>statistics</b> for the collection. </p></div></div><a class="anchor" name="statistics"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../akonadi/Akonadi.CollectionStatistics.html">Akonadi.CollectionStatistics</a> statistics</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Returns the collection statistics of the collection. </p></div></div><a class="anchor" name="url"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kdecore/KUrl.html">KUrl</a> url</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Returns the url of the collection. </p> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.7 </dd></dl> </p></div></div><a class="anchor" name="url"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kdecore/KUrl.html">KUrl</a> url</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../akonadi/Akonadi.Collection.html#UrlType">Akonadi.Collection.UrlType</a> </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 url of the collection. </p> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.7 </dd></dl> </p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="fromUrl"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a> fromUrl</td> <td>(</td> <td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td> <td class="paramname"><em>url</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Creates a collection from the given <b>url.</b> </p></div></div><a class="anchor" name="mimeType"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString mimeType</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">)</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Returns the mimetype used for collections. </p></div></div><a class="anchor" name="root"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a> root</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">)</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Returns the root collection. </p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Right"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">Right</td> </tr> </table> </div> <div class="memdoc"><p>Describes rights of a collection. </p><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>ReadOnly</em> = 0x0</td><td><tr><td valign="top"><em>CanChangeItem</em> = 0x1</td><td><tr><td valign="top"><em>CanCreateItem</em> = 0x2</td><td><tr><td valign="top"><em>CanDeleteItem</em> = 0x4</td><td><tr><td valign="top"><em>CanChangeCollection</em> = 0x8</td><td><tr><td valign="top"><em>CanCreateCollection</em> = 0x10</td><td><tr><td valign="top"><em>CanDeleteCollection</em> = 0x20</td><td><tr><td valign="top"><em>CanLinkItem</em> = 0x40</td><td><tr><td valign="top"><em>CanUnlinkItem</em> = 0x80</td><td><tr><td valign="top"><em>AllRights</em> = (CanChangeItem|CanCreateItem|CanDeleteItem|CanChangeCollection|CanCreateCollection|CanDeleteCollection)</td><td></table> </dl> </div></div><p><a class="anchor" name="UrlType"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">UrlType</td> </tr> </table> </div> <div class="memdoc"><p>Describes the type of url which is returned in url(). </p> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.7 </dd></dl> </p><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>UrlShort</em> = 0</td><td><tr><td valign="top"><em>UrlWithMimeType</em> = 1</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="mailto:simon@simonzone.com">Simon Edwards</a>.<br /> KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</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>