<?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>KCModuleLoader</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>KCModuleLoader Namespace Reference</h1> <code>from PyKDE4.kutils.KCModuleLoader import *</code> <p> <h2>Detailed Description</h2> <p>Loads a KControl Module. </p> <p> KCModuleLoader tries in several ways to locate and load a KCModule. If loading fails a zero pointer is returned. It is very unlikely KCModuleLoader is what you want and KCModuleProxy suits your needs. </p> <p> <dl class="author" compact><dt><b>Author:</b></dt><dd> Matthias Hoelzer-Kluepfel <mhk@kde.org> </dd></dl> <dl class="author" compact><dt><b>Author:</b></dt><dd> Frans Englich <frans.englich@telia.com> </dd></dl> <dl class="internal" compact><dt><b>Internal:</b></dt><dd> </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="#ErrorReporting">ErrorReporting</a> </td><td class="memItemRight" valign="bottom">{ None, Inline, Dialog, Both }</td></tr> <tr><td colspan="2"><br><h2>Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KCModule.html">KCModule</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#loadModule">loadModule</a> (, <a href="../kutils/KCModuleInfo.html">KCModuleInfo</a> module, <a href="../kutils/KCModuleLoader.html#ErrorReporting">KCModuleLoader.ErrorReporting</a> report, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</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"><a href="../kdeui/KCModule.html">KCModule</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#loadModule">loadModule</a> (, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> module, <a href="../kutils/KCModuleLoader.html#ErrorReporting">KCModuleLoader.ErrorReporting</a> report, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</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"><a href="../kdeui/KCModule.html">KCModule</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#reportError">reportError</a> (, <a href="../kutils/KCModuleLoader.html#ErrorReporting">KCModuleLoader.ErrorReporting</a> report, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> text, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> details, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> parent)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#showLastLoaderError">showLastLoaderError</a> (, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> parent)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#unloadModule">unloadModule</a> (, <a href="../kutils/KCModuleInfo.html">KCModuleInfo</a> mod)</td></tr> </table> <hr><h2>Enumeration Documentation</h2><a class="anchor" name="ErrorReporting"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">ErrorReporting</td> </tr> </table> </div> <div class="memdoc"><p>Determines the way errors are reported </p><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>None</em> = 0</td><td><tr><td valign="top"><em>Inline</em> = 1</td><td><tr><td valign="top"><em>Dialog</em> = 2</td><td><tr><td valign="top"><em>Both</em> = 3</td><td></table> </dl> </div></div><p><hr><h2>Function Documentation</h2><a class="anchor" name="loadModule"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kdeui/KCModule.html">KCModule</a> loadModule</td> <td>(</td> <td class="paramtype"><a href="../kutils/KCModuleInfo.html">KCModuleInfo</a> </td> <td class="paramname"><em>module</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kutils/KCModuleLoader.html#ErrorReporting">KCModuleLoader.ErrorReporting</a> </td> <td class="paramname"><em>report</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=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>Loads a KCModule. If loading fails a zero pointer is returned. </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>module</em> </td><td> what module to load <tr><td></td><td valign="top"><em>report</em> </td><td> see ErrorReporting </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> a pointer to the loaded KCModule </dd></dl> </p></div></div><a class="anchor" name="loadModule"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kdeui/KCModule.html">KCModule</a> loadModule</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="../kutils/KCModuleLoader.html#ErrorReporting">KCModuleLoader.ErrorReporting</a> </td> <td class="paramname"><em>report</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=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>Loads a KCModule. If loading fails a zero pointer is returned. </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>module</em> </td><td> what module to load <tr><td></td><td valign="top"><em>report</em> </td><td> see ErrorReporting </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> a pointer to the loaded KCModule </dd></dl> </p></div></div><a class="anchor" name="reportError"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kdeui/KCModule.html">KCModule</a> reportError</td> <td>(</td> <td class="paramtype"><a href="../kutils/KCModuleLoader.html#ErrorReporting">KCModuleLoader.ErrorReporting</a> </td> <td class="paramname"><em>report</em>, </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>text</em>, </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>details</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></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Returns a KCModule containing the messages <b>report</b> and <b>text.</b> </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>report</em> </td><td> the type of error reporting, see ErrorReporting <tr><td></td><td valign="top"><em>text</em> </td><td> the main message <tr><td></td><td valign="top"><em>details</em> </td><td> any additional details </td></tr> </table></dl> <p> <dl class="internal" compact><dt><b>Internal:</b></dt><dd> </dd></dl> </p></div></div><a class="anchor" name="showLastLoaderError"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> showLastLoaderError</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></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Display a message box explaining an error occurred and possible reasons to why. </p> <p> <dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd> Use a constructor with ErrorReporting set to Dialog to show a message box like this function did. </dd></dl> </p></div></div><a class="anchor" name="unloadModule"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> unloadModule</td> <td>(</td> <td class="paramtype"><a href="../kutils/KCModuleInfo.html">KCModuleInfo</a> </td> <td class="paramname"><em>mod</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Unloads the module's library </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>mod</em> </td><td> What module to unload for </td></tr> </table></dl> <p> </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>