<?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>Plasma.PluginLoader</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>PluginLoader Class Reference</h1>
<code>from PyKDE4.plasma import *</code>
<p>
Namespace: <a href="../plasma/Plasma.html">Plasma</a><br />
<h2>Detailed Description</h2>
<p>This is an abstract base class which defines an interface to which Plasma's
Applet Loading logic can communicate with a parent application. The plugin loader
must be set before any plugins are loaded, otherwise (for safety reasons), the
default PluginLoader implementation will be used. The reimplemented version should
not do more than simply returning a loaded plugin. It should not init() it, and it should not
hang on to it. The associated methods will be called only when a component of Plasma
needs to load a _new_ plugin. (e.g. DataEngine does it's own caching).
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Ryan Rix <ry@n.rix.si> </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
</dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><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="#PluginLoader">__init__</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#internalAppletInfo">internalAppletInfo</a> (self, QString category)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#internalDataEngineInfo">internalDataEngineInfo</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.Applet.html">Plasma.Applet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#internalLoadApplet">internalLoadApplet</a> (self, QString name, long appletId=0, [QVariant] args=QVariantList())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.DataEngine.html">Plasma.DataEngine</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#internalLoadDataEngine">internalLoadDataEngine</a> (self, QString name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.AbstractRunner.html">Plasma.AbstractRunner</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#internalLoadRunner">internalLoadRunner</a> (self, QString name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.Service.html">Plasma.Service</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#internalLoadService">internalLoadService</a> (self, QString name, [QVariant] args, QObject parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#internalRunnerInfo">internalRunnerInfo</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#internalServiceInfo">internalServiceInfo</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#listAppletInfo">listAppletInfo</a> (self, QString category, QString parentApp=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#listDataEngineInfo">listDataEngineInfo</a> (self, QString parentApp=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#listRunnerInfo">listRunnerInfo</a> (self, QString parentApp=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.Applet.html">Plasma.Applet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#loadApplet">loadApplet</a> (self, QString name, long appletId=0, [QVariant] args=QVariantList())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.DataEngine.html">Plasma.DataEngine</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#loadDataEngine">loadDataEngine</a> (self, QString name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.AbstractRunner.html">Plasma.AbstractRunner</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#loadRunner">loadRunner</a> (self, QString name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.Service.html">Plasma.Service</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#loadService">loadService</a> (self, QString name, [QVariant] args, QObject parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#standardInternalAppletInfo">standardInternalAppletInfo</a> (self, QString category)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#standardInternalDataEngineInfo">standardInternalDataEngineInfo</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#standardInternalRunnerInfo">standardInternalRunnerInfo</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#standardInternalServiceInfo">standardInternalServiceInfo</a> (self)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.PluginLoader.html">Plasma.PluginLoader</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#pluginLoader">pluginLoader</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setPluginLoader">setPluginLoader</a> (<a href="../plasma/Plasma.PluginLoader.html">Plasma.PluginLoader</a> loader)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="PluginLoader"></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"></div></div><a class="anchor" name="internalAppletInfo"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] internalAppletInfo</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>category</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>A re-implementable method that allows subclasses to provide additional applets
for listAppletInfo. If the application has no applets to give to the application,
then the implementation should return an empty list.
</p>
<p>
This method is called by listAppletInfo prior to generating the list of applets installed
on the system using the standard Plasma plugin mechanisms, and will try to find .desktop
files for your applets.
</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>category</em> </td><td> Only applets matching this category will be returned.
Useful in conjunction with knownCategories.
If "Misc" is passed in, then applets without a
Categories= entry are also returned.
If an empty string is passed in, all applets are
returned.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> list of applets
</dd></dl>
</p></div></div><a class="anchor" name="internalDataEngineInfo"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] internalDataEngineInfo</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>A re-implementable method that allows subclasses to provide additional DataEngines
for DataEngineManager.listDataEngines.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> list of DataEngines, or an empty list if none
</dd></dl>
</p></div></div><a class="anchor" name="internalLoadApplet"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.Applet.html">Plasma.Applet</a> internalLoadApplet</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 class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>appletId=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">[QVariant] </td>
<td class="paramname"><em>args=QVariantList()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>A re-implementable method that allows subclasses to override
the default behaviour of loadApplet. If the applet requested is not recognized,
then the implementation should return a NULL pointer. This method is called
by loadApplet prior to attempting to load an applet using the standard Plasma
plugin mechanisms.
</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 plugin name, as returned by KPluginInfo.pluginName()
<tr><td></td><td valign="top"><em>appletId</em> </td><td> unique ID to assign the applet, or zero to have one
assigned automatically.
<tr><td></td><td valign="top"><em>args</em> </td><td> to send the applet extra arguments
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> a pointer to the loaded applet, or 0 on load failure
</dd></dl>
</p></div></div><a class="anchor" name="internalLoadDataEngine"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.DataEngine.html">Plasma.DataEngine</a> internalLoadDataEngine</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>A re-implementable method that allows subclasses to override
the default behaviour of loadDataEngine. If the engine requested is not recognized,
then the implementation should return a NULL pointer. This method is called
by loadDataEngine prior to attempting to load a DataEgine using the standard Plasma
plugin mechanisms.
</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 name of the engine
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the data engine that was loaded, or the NullEngine on failure.
</dd></dl>
</p></div></div><a class="anchor" name="internalLoadRunner"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.AbstractRunner.html">Plasma.AbstractRunner</a> internalLoadRunner</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>A re-implementable method that allows subclasses to override
the default behaviour of loadRunner. If the runner requested is not recognized,
then the implementation should return a NULL pointer. This method is called
by loadRunner prior to attempting to load a DataEgine using the standard Plasma
plugin mechanisms.
</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 name of the engine
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the data engine that was loaded, or the NullEngine on failure.
</dd></dl>
</p></div></div><a class="anchor" name="internalLoadService"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.Service.html">Plasma.Service</a> internalLoadService</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 class="memname"></td>
<td></td>
<td class="paramtype">[QVariant] </td>
<td class="paramname"><em>args</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QObject </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>A re-implementable method that allows subclasses to override
the default behaviour of loadService. If the service requested is not recognized,
then the implementation should return a NULL pointer. This method is called
by loadService prior to attempting to load a Service using the standard Plasma
plugin mechanisms.
</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 plugin name of the service to load
<tr><td></td><td valign="top"><em>args</em> </td><td> a list of arguments to supply to the service plugin when loading it
<tr><td></td><td valign="top"><em>parent</em> </td><td> the parent object, if any, for the service
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> a Service object, unlike Plasma.Service.loadService, this can return null.
</dd></dl>
</p></div></div><a class="anchor" name="internalRunnerInfo"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] internalRunnerInfo</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 all known Runner implementations
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> list of AbstractRunners, or an empty list if none
</dd></dl>
</p></div></div><a class="anchor" name="internalServiceInfo"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] internalServiceInfo</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 all known Runner implementations
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> list of AbstractRunners, or an empty list if none
</dd></dl>
</p></div></div><a class="anchor" name="listAppletInfo"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] listAppletInfo</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>category</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>parentApp=QString()</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 list of all known applets.
This may skip applets based on security settings and ExcludeCategories in the application's config.
</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>category</em> </td><td> Only applets matchin this category will be returned.
Useful in conjunction with knownCategories.
If "Misc" is passed in, then applets without a
Categories= entry are also returned.
If an empty string is passed in, all applets are
returned.
<tr><td></td><td valign="top"><em>parentApp</em> </td><td> the application to filter applets on. Uses the
X-KDE-ParentApp entry (if any) in the plugin info.
The default value of QString() will result in a
list containing only applets not specifically
registered to an application.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> list of applets
</dd></dl>
</p></div></div><a class="anchor" name="listDataEngineInfo"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] listDataEngineInfo</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>parentApp=QString()</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 list of all known DataEngines.
</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>parentApp</em> </td><td> the application to filter applets on. Uses the
X-KDE-ParentApp entry (if any) in the plugin info.
The default value of QString() will result in a
list containing only applets not specifically
registered to an application.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> list of DataEngines
</dd></dl>
</p></div></div><a class="anchor" name="listRunnerInfo"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] listRunnerInfo</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>parentApp=QString()</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 list of all known Runner implementations
</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>parentApp</em> </td><td> the application to filter applets on. Uses the
X-KDE-ParentApp entry (if any) in the plugin info.
The default value of QString() will result in a
list containing only applets not specifically
registered to an application.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> list of AbstractRunners
</dd></dl>
</p></div></div><a class="anchor" name="loadApplet"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.Applet.html">Plasma.Applet</a> loadApplet</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 class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>appletId=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">[QVariant] </td>
<td class="paramname"><em>args=QVariantList()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Load an Applet plugin.
</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 plugin name, as returned by KPluginInfo.pluginName()
<tr><td></td><td valign="top"><em>appletId</em> </td><td> unique ID to assign the applet, or zero to have one
assigned automatically.
<tr><td></td><td valign="top"><em>args</em> </td><td> to send the applet extra arguments
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> a pointer to the loaded applet, or 0 on load failure
</dd></dl>
</p></div></div><a class="anchor" name="loadDataEngine"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.DataEngine.html">Plasma.DataEngine</a> loadDataEngine</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>Load a DataEngine plugin.
</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 name of the engine
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the DataEngine that was loaded, or the NullEngine on failure.
</dd></dl>
</p></div></div><a class="anchor" name="loadRunner"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.AbstractRunner.html">Plasma.AbstractRunner</a> loadRunner</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>Load a Runner plugin
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the Runner that was loaded, or 0 on failure.
</dd></dl>
</p></div></div><a class="anchor" name="loadService"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.Service.html">Plasma.Service</a> loadService</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 class="memname"></td>
<td></td>
<td class="paramtype">[QVariant] </td>
<td class="paramname"><em>args</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QObject </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>Load a Service plugin.
</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 plugin name of the service to load
<tr><td></td><td valign="top"><em>args</em> </td><td> a list of arguments to supply to the service plugin when loading it
<tr><td></td><td valign="top"><em>parent</em> </td><td> the parent object, if any, for the service
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> a Service object, unlike Plasma.Service.loadService, this can return null.
</dd></dl>
</p></div></div><a class="anchor" name="standardInternalAppletInfo"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] standardInternalAppletInfo</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>category</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Standardized mechanism for providing internal Applets by install .desktop files
in $APPPDATA/plasma/internal/applets/
</p>
<p>
For applications that do this, internalAppletInfo can be implemented as a one-liner
call to this method.
</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>category</em> </td><td> Only applets matching this category will be returned.
Useful in conjunction with knownCategories.
If "Misc" is passed in, then applets without a
Categories= entry are also returned.
If an empty string is passed in, all applets are
returned.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> list of Applets, or an empty list if none
</dd></dl>
</p></div></div><a class="anchor" name="standardInternalDataEngineInfo"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] standardInternalDataEngineInfo</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>Standardized mechanism for providing internal Applets by install .desktop files
in $APPPDATA/plasma/internal/dataengines/
</p>
<p>
For applications that do this, internalDataEngineInfo can be implemented as a one-liner
call to this method.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> list of applets
</dd></dl>
</p></div></div><a class="anchor" name="standardInternalRunnerInfo"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] standardInternalRunnerInfo</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>Standardized mechanism for providing internal Applets by install .desktop files
in $APPPDATA/plasma/internal/runners/
</p>
<p>
For applications that do this, internalRunnerInfo can be implemented as a one-liner
call to this method.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> list of applets
</dd></dl>
</p></div></div><a class="anchor" name="standardInternalServiceInfo"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] standardInternalServiceInfo</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>Standardized mechanism for providing internal Applets by install .desktop files
in $APPPDATA/plasma/internal/services/
</p>
<p>
For applications that do this, internalRunnerInfo can be implemented as a one-liner
call to this method.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> list of applets
</dd></dl>
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="pluginLoader"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.PluginLoader.html">Plasma.PluginLoader</a> pluginLoader</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Return the active plugin loader
</p></div></div><a class="anchor" name="setPluginLoader"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setPluginLoader</td>
<td>(</td>
<td class="paramtype"><a href="../plasma/Plasma.PluginLoader.html">Plasma.PluginLoader</a> </td>
<td class="paramname"><em>loader</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set the plugin loader which will be queried for all loads.
</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>loader</em> </td><td> A subclass of PluginLoader which will be supplied
by the application
</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>
