mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-24 10:52:52 +00:00
250 lines
8.5 KiB
HTML
250 lines
8.5 KiB
HTML
|
<?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>KSettings.PluginPage</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>PluginPage Class Reference</h1>
|
||
|
|
<code>from PyKDE4.kutils import *</code>
|
||
|
|
<p>
|
||
|
|
Inherits: <a href="../kdeui/KCModule.html">KCModule</a> → QWidget → QObject<br />
|
||
|
|
|
||
|
|
Namespace: <a href="../kutils/KSettings.html">KSettings</a><br />
|
||
|
|
<h2>Detailed Description</h2>
|
||
|
|
|
||
|
|
<p>Convenience KCModule for creating a plugins config page.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
This class makes it very easy to create a plugins configuration page to your
|
||
|
|
program. All you need to do is create a class that is derived from
|
||
|
|
PluginPage and add the appropriate plugin information to the KPluginSelector.
|
||
|
|
This is done using the pluginSelector() method:
|
||
|
|
<pre class="fragment">
|
||
|
|
K_PLUGIN_FACTORY(MyAppPluginConfigFactory,
|
||
|
|
registerPlugin<MyAppPluginConfig>();
|
||
|
|
)
|
||
|
|
K_EXPORT_PLUGIN(MyAppConfigFactory("kcm_myapppluginconfig"));
|
||
|
|
|
||
|
|
MyAppPluginConfig(QWidget * parent, const QVariantList & args)
|
||
|
|
: PluginPage(MyAppPluginConfigFactory.componentData(), parent, args)
|
||
|
|
{
|
||
|
|
pluginSelector()->addPlugins( KGlobal.mainComponent().componentName(), i18n( "General Plugins" ), "General" );
|
||
|
|
pluginSelector()->addPlugins( KGlobal.mainComponent().componentName(), i18n( "Effects" ), "Effects" );
|
||
|
|
}
|
||
|
|
</pre>
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
All that remains to be done is to create the appropriate .desktop file
|
||
|
|
<pre>
|
||
|
|
[Desktop Entry]
|
||
|
|
Encoding=UTF-8
|
||
|
|
Icon=plugin
|
||
|
|
Type=Service
|
||
|
|
ServiceTypes=KCModule
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
X-KDE-Library=myapppluginconfig
|
||
|
|
X-KDE-FactoryName=MyAppPluginConfigFactory
|
||
|
|
X-KDE-ParentApp=myapp
|
||
|
|
X-KDE-ParentComponents=myapp
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
Name=Plugins
|
||
|
|
Comment=Select and configure your plugins:
|
||
|
|
</pre>
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
|
||
|
|
<dl class="author" compact><dt><b>Author:</b></dt><dd> Matthias Kretz <kretz@kde.org> </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="#PluginPage">__init__</a> (self, <a href="../kdecore/KComponentData.html">KComponentData</a> componentData, QWidget parent=0, [QVariant] args=QVariantList())</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#defaults">defaults</a> (self)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#load">load</a> (self)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kutils/KPluginSelector.html">KPluginSelector</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#pluginSelector">pluginSelector</a> (self)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#save">save</a> (self)</td></tr>
|
||
|
|
</table>
|
||
|
|
<hr><h2>Method Documentation</h2><a class="anchor" name="PluginPage"></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="../kdecore/KComponentData.html">KComponentData</a> </td>
|
||
|
|
<td class="paramname"><em>componentData</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="memname"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">QWidget </td>
|
||
|
|
<td class="paramname"><em>parent=0</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td 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>Standard KCModule constructor.
|
||
|
|
Automatically creates the KPluginSelector widget.
|
||
|
|
</p></div></div><a class="anchor" name="defaults"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> defaults</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="load"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> load</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>Load the state of the plugins (selected or not) from the KPluginInfo
|
||
|
|
objects. For KParts plugins everything should work automatically. For
|
||
|
|
your own type of plugins you might need to reimplement the
|
||
|
|
KPluginInfo.pluginLoaded() method. If that doesn't fit your needs
|
||
|
|
you can also reimplement this method.
|
||
|
|
</p></div></div><a class="anchor" name="pluginSelector"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"><a href="../kutils/KPluginSelector.html">KPluginSelector</a> pluginSelector</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> a reference to the KPluginSelector.
|
||
|
|
</dd></dl>
|
||
|
|
</p></div></div><a class="anchor" name="save"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> save</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>Save the state of the plugins to KConfig objects
|
||
|
|
</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>
|