<?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_US" xml:lang="en_US">
<head>
<title>kutils: KCModuleLoader Class Reference (kutils)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">kutils</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">KCModuleLoader Class Reference<div class="ingroups"><a class="el" href="group__kcmodule.html">KControl module classes</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="KCModuleLoader" -->
<p>Loads a KControl Module.
<a href="classKCModuleLoader.html#details">More...</a></p>
<p><code>#include <<a class="el" href="kcmoduleloader_8h_source.html">kcmoduleloader.h</a>></code></p>
<p><a href="classKCModuleLoader-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCModuleLoader.html#a81df4206a4263bda1faeecc4e9d5747d">ErrorReporting</a> { <a class="el" href="classKCModuleLoader.html#a81df4206a4263bda1faeecc4e9d5747da20014ac1da26a191b4d9de679ae9d3e7">None</a> = 0,
<a class="el" href="classKCModuleLoader.html#a81df4206a4263bda1faeecc4e9d5747da005cd4b0726931d7e3c564b24c1e2bb1">Inline</a> = 1,
<a class="el" href="classKCModuleLoader.html#a81df4206a4263bda1faeecc4e9d5747da746e97d8f1d1cf1235b1d9e2559ede0a">Dialog</a> = 2,
<a class="el" href="classKCModuleLoader.html#a81df4206a4263bda1faeecc4e9d5747dac900aa7bd376141a32912f2e49ae68ed">Both</a> = 3
}</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCModuleLoader.html#ae85e392679245e6634291fb1e19f6e85">loadModule</a> (const <a class="el" href="classKCModuleInfo.html">KCModuleInfo</a> &module, bool withFallback=true, <a class="elRef" href="qwidget.html">QWidget</a> *parent=0, const char *name=0, const <a class="elRef" href="qstringlist.html">QStringList</a> &args=<a class="elRef" href="qstringlist.html">QStringList</a>()) KDE_DEPRECATED</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCModuleLoader.html#a033c12693971e67f18c648a2d43f044f">loadModule</a> (const <a class="elRef" href="qstring.html">QString</a> &module, <a class="elRef" href="qwidget.html">QWidget</a> *parent=0, const char *name=0, const <a class="elRef" href="qstringlist.html">QStringList</a> &args=<a class="elRef" href="qstringlist.html">QStringList</a>()) KDE_DEPRECATED</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCModuleLoader.html#a82dba232ca966518e1a2e0c79a5e1049">loadModule</a> (const <a class="el" href="classKCModuleInfo.html">KCModuleInfo</a> &module, <a class="el" href="classKCModuleLoader.html#a81df4206a4263bda1faeecc4e9d5747d">ErrorReporting</a> report, bool withFallback=true, <a class="elRef" href="qwidget.html">QWidget</a> *parent=0, const char *name=0, const <a class="elRef" href="qstringlist.html">QStringList</a> &args=<a class="elRef" href="qstringlist.html">QStringList</a>())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCModuleLoader.html#a1397422a3fd45bfb8a6d768767a47385">loadModule</a> (const <a class="elRef" href="qstring.html">QString</a> &module, <a class="el" href="classKCModuleLoader.html#a81df4206a4263bda1faeecc4e9d5747d">ErrorReporting</a> report, <a class="elRef" href="qwidget.html">QWidget</a> *parent=0, const char *name=0, const <a class="elRef" href="qstringlist.html">QStringList</a> &args=<a class="elRef" href="qstringlist.html">QStringList</a>())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCModuleLoader.html#a486d01e5f9c68b2c44d4c34de034a6ad">unloadModule</a> (const <a class="el" href="classKCModuleInfo.html">KCModuleInfo</a> &mod)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCModuleLoader.html#afc9cb3779047b23f3645f5007ae9f670">showLastLoaderError</a> (<a class="elRef" href="qwidget.html">QWidget</a> *parent) KDE_DEPRECATED</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCModuleLoader.html#a4033f00cbe6bcd5fcc0702aec749c94b">testModule</a> (const <a class="elRef" href="qstring.html">QString</a> &module)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCModuleLoader.html#aebdb15cace1e405eeee8d6eddb4f4dea">testModule</a> (const <a class="el" href="classKCModuleInfo.html">KCModuleInfo</a> &module)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCModuleLoader.html#af1732a74e1357cb9634026e384e6e1c0">reportError</a> (<a class="el" href="classKCModuleLoader.html#a81df4206a4263bda1faeecc4e9d5747d">ErrorReporting</a> report, const <a class="elRef" href="qstring.html">QString</a> &text, <a class="elRef" href="qstring.html">QString</a> details, <a class="elRef" href="qwidget.html">QWidget</a> *parent)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Loads a KControl Module. </p>
<p><a class="el" href="classKCModuleLoader.html" title="Loads a KControl Module.">KCModuleLoader</a> tries in several ways to locate and load a <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a>. If loading fails a zero pointer is returned. <br/>
It is very unlikely <a class="el" href="classKCModuleLoader.html" title="Loads a KControl Module.">KCModuleLoader</a> is what you want and <a class="el" href="classKCModuleProxy.html">KCModuleProxy</a> suits your needs.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Matthias Hoelzer-Kluepfel <<a href="mailto:mhk@kde.org">mhk@kde.org</a>> </dd>
<dd>
Frans Englich <<a href="mailto:frans.englich@telia.com">frans.englich@telia.com</a>> </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>3.2 </dd></dl>
<p>Definition at line <a class="el" href="kcmoduleloader_8h_source.html#l00045">45</a> of file <a class="el" href="kcmoduleloader_8h_source.html">kcmoduleloader.h</a>.</p>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a81df4206a4263bda1faeecc4e9d5747d"></a><!-- doxytag: member="KCModuleLoader::ErrorReporting" ref="a81df4206a4263bda1faeecc4e9d5747d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classKCModuleLoader.html#a81df4206a4263bda1faeecc4e9d5747d">KCModuleLoader::ErrorReporting</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determines the way errors are reported. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a81df4206a4263bda1faeecc4e9d5747da20014ac1da26a191b4d9de679ae9d3e7"></a><!-- doxytag: member="None" ref="a81df4206a4263bda1faeecc4e9d5747da20014ac1da26a191b4d9de679ae9d3e7" args="" -->None</em> </td><td>
<p>no error reporting is done </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a81df4206a4263bda1faeecc4e9d5747da005cd4b0726931d7e3c564b24c1e2bb1"></a><!-- doxytag: member="Inline" ref="a81df4206a4263bda1faeecc4e9d5747da005cd4b0726931d7e3c564b24c1e2bb1" args="" -->Inline</em> </td><td>
<p>the error report is shown instead of the <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a> that should have * been loaded </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a81df4206a4263bda1faeecc4e9d5747da746e97d8f1d1cf1235b1d9e2559ede0a"></a><!-- doxytag: member="Dialog" ref="a81df4206a4263bda1faeecc4e9d5747da746e97d8f1d1cf1235b1d9e2559ede0a" args="" -->Dialog</em> </td><td>
<p>shows a dialog with the error report </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a81df4206a4263bda1faeecc4e9d5747dac900aa7bd376141a32912f2e49ae68ed"></a><!-- doxytag: member="Both" ref="a81df4206a4263bda1faeecc4e9d5747dac900aa7bd376141a32912f2e49ae68ed" args="" -->Both</em> </td><td>
<p>does both Inline and Dialog </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kcmoduleloader_8h_source.html#l00084">84</a> of file <a class="el" href="kcmoduleloader_8h_source.html">kcmoduleloader.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae85e392679245e6634291fb1e19f6e85"></a><!-- doxytag: member="KCModuleLoader::loadModule" ref="ae85e392679245e6634291fb1e19f6e85" args="(const KCModuleInfo &module, bool withFallback=true, QWidget *parent=0, const char *name=0, const QStringList &args=QStringList()) KDE_DEPRECATED" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a> * KCModuleLoader::loadModule </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKCModuleInfo.html">KCModuleInfo</a> & </td>
<td class="paramname"><em>module</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>withFallback</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="qwidget.html">QWidget</a> * </td>
<td class="paramname"><em>parent</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qstringlist.html">QStringList</a> & </td>
<td class="paramname"><em>args</em> = <code><a class="elRef" href="qstringlist.html">QStringList</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Loads a <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a>. </p>
<p>If loading fails a zero pointer is returned. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">module</td><td>what module to load </td></tr>
<tr><td class="paramname">withFallback</td><td>if true and loading failed a separate window with the module may appear and a zero pointer is a returned </td></tr>
<tr><td class="paramname">parent</td><td>The parent widget </td></tr>
<tr><td class="paramname">name</td><td>The widget's name </td></tr>
<tr><td class="paramname">args</td><td>A list of arguments for the module to load</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the loaded <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a></dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd>use the function which explicitly states the error reporting method </dd></dl>
<p>Definition at line <a class="el" href="kcmoduleloader_8cpp_source.html#l00116">116</a> of file <a class="el" href="kcmoduleloader_8cpp_source.html">kcmoduleloader.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a033c12693971e67f18c648a2d43f044f"></a><!-- doxytag: member="KCModuleLoader::loadModule" ref="a033c12693971e67f18c648a2d43f044f" args="(const QString &module, QWidget *parent=0, const char *name=0, const QStringList &args=QStringList()) KDE_DEPRECATED" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a> * KCModuleLoader::loadModule </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>module</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="qwidget.html">QWidget</a> * </td>
<td class="paramname"><em>parent</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qstringlist.html">QStringList</a> & </td>
<td class="paramname"><em>args</em> = <code><a class="elRef" href="qstringlist.html">QStringList</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Loads a <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a>. </p>
<p>If loading fails a zero pointer is returned. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">module</td><td>what module to load with the module may appear and a zero pointer is a returned </td></tr>
<tr><td class="paramname">parent</td><td>The parent widget </td></tr>
<tr><td class="paramname">name</td><td>The widget's name </td></tr>
<tr><td class="paramname">args</td><td>A list of arguments for the module to load</td></tr>
</table>
</dd>
</dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000004">Deprecated:</a></b></dt><dd>use the function which explicitly states the error reporting method </dd></dl>
<p>Definition at line <a class="el" href="kcmoduleloader_8cpp_source.html#l00178">178</a> of file <a class="el" href="kcmoduleloader_8cpp_source.html">kcmoduleloader.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1397422a3fd45bfb8a6d768767a47385"></a><!-- doxytag: member="KCModuleLoader::loadModule" ref="a1397422a3fd45bfb8a6d768767a47385" args="(const QString &module, ErrorReporting report, QWidget *parent=0, const char *name=0, const QStringList &args=QStringList())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a> * KCModuleLoader::loadModule </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>module</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classKCModuleLoader.html#a81df4206a4263bda1faeecc4e9d5747d">ErrorReporting</a> </td>
<td class="paramname"><em>report</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="qwidget.html">QWidget</a> * </td>
<td class="paramname"><em>parent</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qstringlist.html">QStringList</a> & </td>
<td class="paramname"><em>args</em> = <code><a class="elRef" href="qstringlist.html">QStringList</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Loads a <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a>. </p>
<p>If loading fails a zero pointer is returned. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">module</td><td>what module to load </td></tr>
<tr><td class="paramname">report</td><td>see ErrorReporting with the module may appear and a zero pointer is a returned </td></tr>
<tr><td class="paramname">parent</td><td>The parent widget </td></tr>
<tr><td class="paramname">name</td><td>The widget's name </td></tr>
<tr><td class="paramname">args</td><td>A list of arguments for the module to load</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the loaded <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a> </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>3.4 </dd></dl>
<p>Definition at line <a class="el" href="kcmoduleloader_8cpp_source.html#l00184">184</a> of file <a class="el" href="kcmoduleloader_8cpp_source.html">kcmoduleloader.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a82dba232ca966518e1a2e0c79a5e1049"></a><!-- doxytag: member="KCModuleLoader::loadModule" ref="a82dba232ca966518e1a2e0c79a5e1049" args="(const KCModuleInfo &module, ErrorReporting report, bool withFallback=true, QWidget *parent=0, const char *name=0, const QStringList &args=QStringList())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a> * KCModuleLoader::loadModule </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKCModuleInfo.html">KCModuleInfo</a> & </td>
<td class="paramname"><em>module</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classKCModuleLoader.html#a81df4206a4263bda1faeecc4e9d5747d">ErrorReporting</a> </td>
<td class="paramname"><em>report</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>withFallback</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="qwidget.html">QWidget</a> * </td>
<td class="paramname"><em>parent</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qstringlist.html">QStringList</a> & </td>
<td class="paramname"><em>args</em> = <code><a class="elRef" href="qstringlist.html">QStringList</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Loads a <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a>. </p>
<p>If loading fails a zero pointer is returned. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">module</td><td>what module to load </td></tr>
<tr><td class="paramname">report</td><td>see ErrorReporting </td></tr>
<tr><td class="paramname">withFallback</td><td>if true and loading failed a separate window with the module may appear and a zero pointer is a returned </td></tr>
<tr><td class="paramname">parent</td><td>The parent widget </td></tr>
<tr><td class="paramname">name</td><td>The widget's name </td></tr>
<tr><td class="paramname">args</td><td>A list of arguments for the module to load</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the loaded <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a> </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>3.4 </dd></dl>
<p>Definition at line <a class="el" href="kcmoduleloader_8cpp_source.html#l00121">121</a> of file <a class="el" href="kcmoduleloader_8cpp_source.html">kcmoduleloader.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af1732a74e1357cb9634026e384e6e1c0"></a><!-- doxytag: member="KCModuleLoader::reportError" ref="af1732a74e1357cb9634026e384e6e1c0" args="(ErrorReporting report, const QString &text, QString details, QWidget *parent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a> * KCModuleLoader::reportError </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKCModuleLoader.html#a81df4206a4263bda1faeecc4e9d5747d">ErrorReporting</a> </td>
<td class="paramname"><em>report</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="qstring.html">QString</a> </td>
<td class="paramname"><em>details</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="qwidget.html">QWidget</a> * </td>
<td class="paramname"><em>parent</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a> containing the messages <code>report</code> and <code>text</code>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">report</td><td>the type of error reporting, see ErrorReporting </td></tr>
<tr><td class="paramname">text</td><td>the main message </td></tr>
<tr><td class="paramname">details</td><td>any additional details </td></tr>
<tr><td class="paramname">parent</td><td>The parent widget</td></tr>
</table>
</dd>
</dl>
<dl class="since"><dt><b>Since:</b></dt><dd>3.4 </dd></dl>
<p>Definition at line <a class="el" href="kcmoduleloader_8cpp_source.html#l00270">270</a> of file <a class="el" href="kcmoduleloader_8cpp_source.html">kcmoduleloader.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="afc9cb3779047b23f3645f5007ae9f670"></a><!-- doxytag: member="KCModuleLoader::showLastLoaderError" ref="afc9cb3779047b23f3645f5007ae9f670" args="(QWidget *parent) KDE_DEPRECATED" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KCModuleLoader::showLastLoaderError </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="qwidget.html">QWidget</a> * </td>
<td class="paramname"><em>parent</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Display a message box explaining an error occured and possible reasons to why. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>Use a constructor with ErrorReporting set to Dialog to show a message box like this function did. </dd></dl>
<p>Definition at line <a class="el" href="kcmoduleloader_8cpp_source.html#l00203">203</a> of file <a class="el" href="kcmoduleloader_8cpp_source.html">kcmoduleloader.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aebdb15cace1e405eeee8d6eddb4f4dea"></a><!-- doxytag: member="KCModuleLoader::testModule" ref="aebdb15cace1e405eeee8d6eddb4f4dea" args="(const KCModuleInfo &module)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KCModuleLoader::testModule </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKCModuleInfo.html">KCModuleInfo</a> & </td>
<td class="paramname"><em>module</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience function, essentially the same as above. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">module</td><td>the module to check </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the module should be loaded </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>3.4 </dd></dl>
<p><p>If something fails we return true - we can't risk functionality becoming unavailable because of a buggy test. Furthermore, the error needs to show so it is discovered. <a class="el" href="classKCModuleProxy.html" title="Encapsulates a KCModule for embedding.">KCModuleProxy</a> will detect the error and load a corresponding KCMError.</p>
</p>
<p>Definition at line <a class="el" href="kcmoduleloader_8cpp_source.html#l00221">221</a> of file <a class="el" href="kcmoduleloader_8cpp_source.html">kcmoduleloader.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4033f00cbe6bcd5fcc0702aec749c94b"></a><!-- doxytag: member="KCModuleLoader::testModule" ref="a4033f00cbe6bcd5fcc0702aec749c94b" args="(const QString &module)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KCModuleLoader::testModule </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>module</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks whether an <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKCModule.html">KCModule</a> should be shown by running its test function. </p>
<p>If it is unsure whether a module should be shown, it should be made available, leaving the decision to the user. If false is returned, the module should not be loaded in any interface.</p>
<p>A module declares it needs to be tested by having "X-KDE-Test-Module=true" in its desktop file. When that line exists, the following code must be available in the module's library:</p>
<div class="fragment"><pre class="fragment"> <span class="keyword">extern</span> <span class="stringliteral">"C"</span>
{
<span class="keywordtype">bool</span> test_moduleName()
{
<span class="comment">// Code testing for hardware/software presence.</span>
<span class="keywordflow">return</span> <span class="keyword">true</span>; <span class="comment">// and the modue will be loaded.</span>
}
}
</pre></div><p>where moduleName is the library name for the module.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">module</td><td>the module to check </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the module should be loaded </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>3.4 </dd></dl>
<p>Definition at line <a class="el" href="kcmoduleloader_8cpp_source.html#l00216">216</a> of file <a class="el" href="kcmoduleloader_8cpp_source.html">kcmoduleloader.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a486d01e5f9c68b2c44d4c34de034a6ad"></a><!-- doxytag: member="KCModuleLoader::unloadModule" ref="a486d01e5f9c68b2c44d4c34de034a6ad" args="(const KCModuleInfo &mod)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KCModuleLoader::unloadModule </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKCModuleInfo.html">KCModuleInfo</a> & </td>
<td class="paramname"><em>mod</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unloads the module's library. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">mod</td><td>What module to unload for </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kcmoduleloader_8cpp_source.html#l00190">190</a> of file <a class="el" href="kcmoduleloader_8cpp_source.html">kcmoduleloader.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="kcmoduleloader_8h_source.html">kcmoduleloader.h</a></li>
<li><a class="el" href="kcmoduleloader_8cpp_source.html">kcmoduleloader.cpp</a></li>
</ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kutils</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="modules.html">Modules</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classKCModuleContainer.html">kcmodulecontainer</option>, <option value="classKCModuleInfo.html">kcmoduleinfo</option>, <option value="classKCModuleLoader.html">kcmoduleloader</option>, <option value="classKCModuleProxy.html">kcmoduleproxy</option>, <option value="classKCModuleProxyIface.html">kcmoduleproxyiface</option>, <option value="classKCModuleProxyRootDispatcher.html">kcmoduleproxyrootdispatcher</option>, <option value="classKCMultiDialog.html">kcmultidialog</option>, <option value="classKFind.html">kfind</option>, <option value="classKFindDialog.html">kfinddialog</option>, <option value="classKMultiTabBar.html">kmultitabbar</option>, <option value="classKMultiTabBarButton.html">kmultitabbarbutton</option>, <option value="classKMultiTabBarTab.html">kmultitabbartab</option>, <option value="classKPluginInfo.html">kplugininfo</option>, <option value="classKPluginSelector.html">kpluginselector</option>, <option value="classKReplace.html">kreplace</option>, <option value="classKReplaceDialog.html">kreplacedialog</option>, <option value="classKSettings_1_1ComponentsDialog.html">ksettings::componentsdialog</option>, <option value="classKSettings_1_1Dialog.html">ksettings::dialog</option>, <option value="classKSettings_1_1Dispatcher.html">ksettings::dispatcher</option>, <option value="classKSettings_1_1PluginPage.html">ksettings::pluginpage</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" 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 id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
