<?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.CollectionPropertiesDialog</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>CollectionPropertiesDialog Class Reference</h1>
<code>from PyKDE4.akonadi import *</code>
<p>
Inherits: <a href="../kdeui/KDialog.html">KDialog</a> → QDialog → QWidget → QObject<br />
Namespace: <a href="../akonadi/Akonadi.html">Akonadi</a><br />
<h2>Detailed Description</h2>
<p>A generic and extensible dialog for collection properties.
</p>
<p>
This dialog allows you to show or modify the properties of a collection.
</p>
<p>
<pre class="fragment">
Akonadi.Collection collection = ...
CollectionPropertiesDialog dlg( collection, this );
dlg.exec();
</pre>
</p>
<p>
It can be extended by custom pages, which contains gui elements for custom
properties.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> Akonadi.CollectionPropertiesPage
</dd></dl> </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="#DefaultPage">DefaultPage</a> </td><td class="memItemRight" valign="bottom">{ GeneralPage, CachePage }</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="#CollectionPropertiesDialog">__init__</a> (self, <a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a> collection, QWidget parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#CollectionPropertiesDialog">__init__</a> (self, <a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a> collection, QStringList pages, QWidget parent=0)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#defaultPageObjectName">defaultPageObjectName</a> (<a href="../akonadi/Akonadi.CollectionPropertiesDialog.html#DefaultPage">Akonadi.CollectionPropertiesDialog.DefaultPage</a> page)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#registerPage">registerPage</a> (<a href="../akonadi/Akonadi.CollectionPropertiesPageFactory.html">Akonadi.CollectionPropertiesPageFactory</a> factory)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#useDefaultPage">useDefaultPage</a> (bool use)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="CollectionPropertiesDialog"></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>collection</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>parent=0</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 new collection properties dialog.
</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>collection</em> </td><td> The collection which properties should be shown.
<tr><td></td><td valign="top"><em>parent</em> </td><td> The parent widget.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="CollectionPropertiesDialog"></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>collection</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QStringList </td>
<td class="paramname"><em>pages</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>parent=0</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 new collection properties dialog.
</p>
<p>
This constructor allows to specify the subset of registered pages that will
be shown as well as their order. The pages have to set an objectName in their
constructor to make it work. If an empty list is passed, all registered pages
will be loaded. Use defaultPageObjectName() to fetch the object name for a
registered default page.
</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>collection</em> </td><td> The collection which properties should be shown.
<tr><td></td><td valign="top"><em>pages</em> </td><td> The object names of the pages that shall be loaded.
<tr><td></td><td valign="top"><em>parent</em> </td><td> The parent widget.
</td></tr>
</table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
</dd></dl>
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="defaultPageObjectName"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString defaultPageObjectName</td>
<td>(</td>
<td class="paramtype"><a href="../akonadi/Akonadi.CollectionPropertiesDialog.html#DefaultPage">Akonadi.CollectionPropertiesDialog.DefaultPage</a> </td>
<td class="paramname"><em>page</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 object name of one of the dialog's registered default pages.
The object name may be used in the QStringList constructor parameter to
specify which default pages should be shown.
</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>page</em> </td><td> the desired page
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the page's object name
</dd></dl> </p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.7
</dd></dl>
</p></div></div><a class="anchor" name="registerPage"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> registerPage</td>
<td>(</td>
<td class="paramtype"><a href="../akonadi/Akonadi.CollectionPropertiesPageFactory.html">Akonadi.CollectionPropertiesPageFactory</a> </td>
<td class="paramname"><em>factory</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Register custom pages for the collection properties dialog.
</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>factory</em> </td><td> The properties page factory that provides the custom page.
</td></tr>
</table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> Akonadi.CollectionPropertiesPageFactory
</dd></dl>
</p></div></div><a class="anchor" name="useDefaultPage"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> useDefaultPage</td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>use</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets whether to <b>use</b> default page or not.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="DefaultPage"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">DefaultPage</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Enumerates the registered default pages which can be displayed.
</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>GeneralPage</em> </td><td><tr><td valign="top"><em>CachePage</em> </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>
