<?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>KCMultiDialog</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"> </div> <h1>KCMultiDialog Class Reference</h1> <code>from PyKDE4.kutils import *</code> <p> Inherits: <a href="../kdeui/KPageDialog.html">KPageDialog</a> → <a href="../kdeui/KDialog.html">KDialog</a> → <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qdialog.html">QDialog</a> → <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> → <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a><br /> Subclasses: <a href="../kutils/KSettings.Dialog.html">KSettings.Dialog</a><br /> <h2>Detailed Description</h2> <p>A class that offers a KPageDialog containing arbitrary KControl Modules. </p> <p> <dl class="author" compact><dt><b>Author:</b></dt><dd> Matthias Elter <elter@kde.org>, Daniel Molkentin <molkentin@kde.org> </dd></dl> </p> <table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Signals</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#configCommitted">configCommitted</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#configCommitted">configCommitted</a> (, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> componentName)</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="#KCMultiDialog">__init__</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> parent=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KCMultiDialog">__init__</a> (self, <a href="../kdeui/KPageWidget.html">KPageWidget</a> pageWidget, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> parent, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::WFlags</a> flags=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KPageWidgetItem.html">KPageWidgetItem</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addModule">addModule</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> module, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstringlist.html">QStringList</a> args=QStringList())</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KPageWidgetItem.html">KPageWidgetItem</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addModule">addModule</a> (self, <a href="../kutils/KCModuleInfo.html">KCModuleInfo</a> moduleinfo, <a href="../kdeui/KPageWidgetItem.html">KPageWidgetItem</a> parent=0, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstringlist.html">QStringList</a> args=QStringList())</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#clear">clear</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#configCommitted">configCommitted</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#configCommitted">configCommitted</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> componentName)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#slotApplyClicked">slotApplyClicked</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#slotDefaultClicked">slotDefaultClicked</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#slotHelpClicked">slotHelpClicked</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#slotOkClicked">slotOkClicked</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#slotUser1Clicked">slotUser1Clicked</a> (self)</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="KCMultiDialog"></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="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> </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>Constructs a new KCMultiDialog </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>parent</em> </td><td> The parent widget </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="KCMultiDialog"></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="../kdeui/KPageWidget.html">KPageWidget</a> </td> <td class="paramname"><em>pageWidget</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> </td> <td class="paramname"><em>parent</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::WFlags</a> </td> <td class="paramname"><em>flags=0</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>This constructor can be used by subclasses to provide a custom KPageWidget. </p></div></div><a class="anchor" name="addModule"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kdeui/KPageWidgetItem.html">KPageWidgetItem</a> addModule</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="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td> <td class="paramname"><em>module</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstringlist.html">QStringList</a> </td> <td class="paramname"><em>args=QStringList()</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Add a module. </p> <p> The module is added according to its KCModuleInfo.weight(). The weight determines where in the list the module will appear. Lighter modules on top, heavier modules at the bottom. </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>moduleinfo</em> </td><td> Pass a KCModuleInfo object which will be used for creating the module. It will be added to the list of modules the dialog will show. </td></tr> <tr><td></td><td valign="top"><em>parent</em> </td><td> The <dl class="see" compact><dt><b>See also:</b></dt><dd> KPageWidgetItem that should appear as parents in the tree view or a 0 pointer if there is no parent. </dd></dl> </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>args</em> </td><td> The arguments that should be given to the KCModule when it is created </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="addModule"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kdeui/KPageWidgetItem.html">KPageWidgetItem</a> addModule</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="../kutils/KCModuleInfo.html">KCModuleInfo</a> </td> <td class="paramname"><em>moduleinfo</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdeui/KPageWidgetItem.html">KPageWidgetItem</a> </td> <td class="paramname"><em>parent=0</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstringlist.html">QStringList</a> </td> <td class="paramname"><em>args=QStringList()</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Add a module. </p> <p> The module is added according to its KCModuleInfo.weight(). The weight determines where in the list the module will appear. Lighter modules on top, heavier modules at the bottom. </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>moduleinfo</em> </td><td> Pass a KCModuleInfo object which will be used for creating the module. It will be added to the list of modules the dialog will show. </td></tr> <tr><td></td><td valign="top"><em>parent</em> </td><td> The <dl class="see" compact><dt><b>See also:</b></dt><dd> KPageWidgetItem that should appear as parents in the tree view or a 0 pointer if there is no parent. </dd></dl> </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>args</em> </td><td> The arguments that should be given to the KCModule when it is created </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="clear"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> clear</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>Removes all modules from the dialog. </p></div></div><a class="anchor" name="configCommitted"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> configCommitted</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>Emitted after the KCModules have been told to save their configuration. It is emitted once for every instance the KCMs that were changed belong to. </p> <p> You can make use of this if you have more than one component in your application. componentName tells you the instance that has to reload its configuration. </p> <p> The applyClicked and okClicked signals are emitted before the configuration is saved. </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>componentName</em> </td><td> The name of the instance that needs to reload its configuration. </td></tr> </table></dl> <p> </p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("configCommitted()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="configCommitted"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> configCommitted</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="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> </td> <td class="paramname"><em>componentName</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Emitted after the KCModules have been told to save their configuration. It is emitted once for every instance the KCMs that were changed belong to. </p> <p> You can make use of this if you have more than one component in your application. componentName tells you the instance that has to reload its configuration. </p> <p> The applyClicked and okClicked signals are emitted before the configuration is saved. </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>componentName</em> </td><td> The name of the instance that needs to reload its configuration. </td></tr> </table></dl> <p> </p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("configCommitted(const QByteArray&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="slotApplyClicked"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> slotApplyClicked</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>This slot is called when the user presses the "Apply" Button. You can reimplement it if needed. </p> <p> <dl class="note" compact><dt><b>Note:</b></dt><dd> Make sure you call the original implementation. </dd></dl> </p></div></div><a class="anchor" name="slotDefaultClicked"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> slotDefaultClicked</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>This slot is called when the user presses the "Default" Button. You can reimplement it if needed. </p> <p> <dl class="note" compact><dt><b>Note:</b></dt><dd> Make sure you call the original implementation. </dd></dl> </p></div></div><a class="anchor" name="slotHelpClicked"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> slotHelpClicked</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>This slot is called when the user presses the "Help" Button. It reads the X-DocPath field of the currently selected KControl module's .desktop file to find the path to the documentation, which it then attempts to load. </p> <p> You can reimplement this slot if needed. </p> <p> <dl class="note" compact><dt><b>Note:</b></dt><dd> Make sure you call the original implementation. </dd></dl> </p></div></div><a class="anchor" name="slotOkClicked"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> slotOkClicked</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>This slot is called when the user presses the "OK" Button. You can reimplement it if needed. </p> <p> <dl class="note" compact><dt><b>Note:</b></dt><dd> Make sure you call the original implementation. </dd></dl> </p></div></div><a class="anchor" name="slotUser1Clicked"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> slotUser1Clicked</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>This slot is called when the user presses the "Reset" Button. You can reimplement it if needed. </p> <p> <dl class="note" compact><dt><b>Note:</b></dt><dd> Make sure you call the original implementation. </dd></dl> </p></div></div> </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>