mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-24 10:52:52 +00:00
245 lines
21 KiB
HTML
245 lines
21 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>Module PyKDE4.plasma</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>PyKDE4.plasma Module</h1>
|
|
<hr><p><h2>Plasma libraries </h2>
|
|
</p>
|
|
<p>
|
|
libplasma is the core of the Plasma desktop. It provides a framework of graphical
|
|
widgets (Plasma.Applet) that can be organised into managed groupings
|
|
(Plasma.Containment), such as a desktop or panel. It also provides a data
|
|
abstraction layer (Plasma.DataEngine) and a corresponding service interaction
|
|
layer (Plasma.Service) to make implementing widgets easier and a
|
|
system of callouts (Plasma.AbstractRunner) that provide responses to queries,
|
|
from running an application to performing a quick calculation.
|
|
</p>
|
|
<p>
|
|
The <a href="http://doc.trolltech.com/latest/graphicsview.html">Qt Graphics View
|
|
framework</a> and the <a href="http://api.kde.org/4.x-api/kdelibs-apidocs/">KDE
|
|
libraries</a> provide the underpinning for libplasma. As a result, it should
|
|
work anywhere that Qt and KDE do.
|
|
</p>
|
|
<p>
|
|
Although libplasma is developed for the use of the Plasma desktop shell in
|
|
KDE 4, it is general enough to be useful in other applications.
|
|
<a href="http://amarok.kde.org">Amarok</a> is using it for its context
|
|
view, allowing for pluggable widgets to display and interact with the music
|
|
collection, such as "current track" and "tag cloud" widgets.
|
|
</p>
|
|
<p>
|
|
libplasma itself only provides a framework, and the widgets, containments,
|
|
data engines and runners are all implemented as plugins. However, the framework
|
|
is designed to make implementing these plugins as easy as possible, including
|
|
providing scripting support.
|
|
</p>
|
|
<p>
|
|
Other important classes are:
|
|
</p>
|
|
<p>
|
|
- Plasma.Corona: the canvas that containments are placed on
|
|
- Plasma.View: a QWidget for displaying a containment
|
|
- Plasma.Theme: provides theming support
|
|
- Plasma.Animator: provides animations for things like elements appearing
|
|
and disappearing
|
|
- Plasma.Delegate: provides an item delegate for Qt's
|
|
<a href="http://doc.trolltech.com/latest/model-view-programming.html">Model /
|
|
View framework</a> for menu items.
|
|
- Plasma.ToolTipManager: allows widgets have (themed) tooltips displayed when the
|
|
mouse is hovered over them
|
|
- Plasma.Dialog: displays a themed application dialog
|
|
- Plasma.Extender: provides detachable sections to Plasma.Applet
|
|
- Plasma.GLApplet: provides an OpenGL-rendered Plasma.Applet
|
|
- Plasma.PackageStructure: provides descriptions of packages containing plugins
|
|
for libplasma
|
|
- Plasma.PopupApplet: provides a simple way of implementing a Plasma.Applet
|
|
consisting of an icon that shows a popup when clicked
|
|
- Plasma.Svg and Plasma.FrameSvg: provides themable, cached SVGs
|
|
- Plasma.Wallpaper: provides pluggable backgrounds for containments
|
|
- Plasma.AppletScript, Plasma.DataEngineScript, Plasma.RunnerScript and
|
|
Plasma.ScriptEngine: provide scripting interfaces for plugins
|
|
- Various themed QGraphicsWidgets for use in creating a Plasma.Applet
|
|
</p>
|
|
<p>
|
|
The
|
|
<a href="http://techbase.kde.org/Development/Tutorials/Plasma">Plasma tutorials</a>
|
|
on TechBase provide a good introduction to writing plugins, such as widgets and
|
|
data engines, for libplasma-based applications.
|
|
</p>
|
|
<p>
|
|
|
|
<dl compact><dt><b>Author(s):</b></dt><dd>
|
|
Aaron Seigo <aseigo@kde.org><br>
|
|
Alessandro Diaferia <alediaferia@gmail.com><br>
|
|
Alex Merry <kde@randomguy3.me.uk><br>
|
|
Alexander Wiedenbruch <wirr01@gmail.com><br>
|
|
Alexis Ménard <darktears31@gmail.com><br>
|
|
André Duffeck <andre@duffeck.de><br>
|
|
Andrew Lake <jamboarder@yahoo.com><br>
|
|
Artur de Souza <asouza@kde.org><br>
|
|
Bertjan Broeksema <b.broeksema@kdemail.net><br>
|
|
Chani Armitage <chanika@gmail.com><br>
|
|
Davide Bettio <davide.bettio@kdemail.net><br>
|
|
Dan Meltzer <hydrogen@notyetimplemented.com><br>
|
|
Fredrik Höglund <fredrik@kde.org><br>
|
|
Ivan Cukic <ivan.cukic+kde@gmail.com><br>
|
|
John Tapsell <tapsell@kde.org><br>
|
|
Jordi Polo <mumismo@gmail.com><br>
|
|
Kevin Ottens <ervin@kde.org><br>
|
|
Montel Laurent <montel@kde.org><br>
|
|
Marco Martin <notmart@gmail.com><br>
|
|
Matt Broadstone <mbroadst@gmail.com><br>
|
|
Petri Damsten <damu@iki.fi><br>
|
|
Rafael Fernández López <ereslibre@kde.org><br>
|
|
Riccardo Iaconelli <riccardo@kde.org><br>
|
|
Richard J. Moore <rich@kde.org><br>
|
|
Rob Scheepmaker <r.scheepmaker@student.utwente.nl><br>
|
|
Robert Knight <robertknight@gmail.com><br>
|
|
Sebastian Kuegler <sebas@kde.org><br>
|
|
Siraj Razick <siraj@kde.net><br>
|
|
Zack Rusin <zack@kde.org>
|
|
</dd></dl> </p>
|
|
<p>
|
|
|
|
<dl compact><dt><b>Maintainer(s):</b></dt><dd>
|
|
Aaron Seigo <aseigo@kde.org>
|
|
</dd></dl> </p>
|
|
<p>
|
|
|
|
<dl compact><dt><b>License(s):</b></dt><dd>
|
|
<a href="http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html#SEC1">LGPLv2</a>
|
|
</dd></dl>
|
|
</p><h2>Namespaces</h2>
|
|
<table width="95%" align="center" border="0" cellpadding="0" cellspacing="0">
|
|
<tbody><tr><td><a name="letter_G"> G </a></td><td><a name="letter_P"> P </a></td><td></td></tr>
|
|
<tr><td><a class="el" href="global.html"><i>global</i></a> </td><td><a class="el" href="Plasma.html">Plasma</a> </td><td></td></tr>
|
|
</table>
|
|
<h2>Class Index</h2>
|
|
<table width="95%" align="center" border="0" cellpadding="0" cellspacing="0">
|
|
<tbody><tr><td><a name="letter_A"> A </a></td><td><a class="el" href="Plasma.Dialog.html">Dialog</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.RunnerScript.html">RunnerScript</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.AbstractDialogManager.html">AbstractDialogManager</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a name="letter_E"> E </a></td><td><a class="el" href="Plasma.RunnerSyntax.html">RunnerSyntax</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.AbstractRunner.html">AbstractRunner</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.Extender.html">Extender</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a name="letter_S"> S </a></td></tr>
|
|
<tr><td><a class="el" href="Plasma.AbstractToolBox.html">AbstractToolBox</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.ExtenderGroup.html">ExtenderGroup</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.ScriptEngine.html">ScriptEngine</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.AccessAppletJob.html">AccessAppletJob</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.ExtenderItem.html">ExtenderItem</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.ScrollBar.html">ScrollBar</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.AccessManager.html">AccessManager</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a name="letter_F"> F </a></td><td><a class="el" href="Plasma.ScrollWidget.html">ScrollWidget</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.Animation.html">Animation</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.FlashingLabel.html">FlashingLabel</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.Separator.html">Separator</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.AnimationDriver.html">AnimationDriver</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.Frame.html">Frame</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.Service.html">Service</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.Animator.html">Animator</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.FrameSvg.html">FrameSvg</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.ServiceAccessJob.html">ServiceAccessJob</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.Applet.html">Applet</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a name="letter_G"> G </a></td><td><a class="el" href="Plasma.ServiceJob.html">ServiceJob</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.AppletProtectedThunk.html">AppletProtectedThunk</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.GLApplet.html">GLApplet</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.SignalPlotter.html">SignalPlotter</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.AppletScript.html">AppletScript</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.GroupBox.html">GroupBox</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.Slider.html">Slider</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.AuthorizationInterface.html">AuthorizationInterface</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a name="letter_I"> I </a></td><td><a class="el" href="Plasma.SpinBox.html">SpinBox</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.AuthorizationManager.html">AuthorizationManager</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.IconWidget.html">IconWidget</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.Containment.StyleOption.html">StyleOption</a> (<a class="el" href="Plasma.Containment.html">Plasma.Containment</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.AuthorizationRule.html">AuthorizationRule</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.ItemBackground.html">ItemBackground</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.Svg.html">Svg</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a name="letter_B"> B </a></td><td><a name="letter_L"> L </a></td><td><a class="el" href="Plasma.SvgWidget.html">SvgWidget</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.BusyWidget.html">BusyWidget</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.Label.html">Label</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a name="letter_T"> T </a></td></tr>
|
|
<tr><td><a name="letter_C"> C </a></td><td><a class="el" href="Plasma.LineEdit.html">LineEdit</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.TabBar.html">TabBar</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.CheckBox.html">CheckBox</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a name="letter_M"> M </a></td><td><a class="el" href="Plasma.TextBrowser.html">TextBrowser</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.ClientPinRequest.html">ClientPinRequest</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.Meter.html">Meter</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.TextEdit.html">TextEdit</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.ComboBox.html">ComboBox</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a name="letter_P"> P </a></td><td><a class="el" href="Plasma.Theme.html">Theme</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.ConfigLoader.html">ConfigLoader</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.Package.html">Package</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.ToolButton.html">ToolButton</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.Containment.html">Containment</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.PackageMetadata.html">PackageMetadata</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.ToolTipContent.html">ToolTipContent</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.ContainmentActions.html">ContainmentActions</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.PackageStructure.html">PackageStructure</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.ToolTipManager.html">ToolTipManager</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.ContainmentActionsPluginsConfig.html">ContainmentActionsPluginsConfig</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.PlotColor.html">PlotColor</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.TreeView.html">TreeView</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.Context.html">Context</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.PluginLoader.html">PluginLoader</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a name="letter_V"> V </a></td></tr>
|
|
<tr><td><a class="el" href="Plasma.Corona.html">Corona</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.PopupApplet.html">PopupApplet</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.VideoWidget.html">VideoWidget</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a name="letter_D"> D </a></td><td><a class="el" href="Plasma.PushButton.html">PushButton</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.View.html">View</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.DataContainer.html">DataContainer</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a name="letter_Q"> Q </a></td><td><a name="letter_W"> W </a></td></tr>
|
|
<tr><td><a class="el" href="Plasma.DataEngine.html">DataEngine</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.QueryMatch.html">QueryMatch</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.Wallpaper.html">Wallpaper</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.DataEngineManager.html">DataEngineManager</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a name="letter_R"> R </a></td><td><a class="el" href="Plasma.WallpaperScript.html">WallpaperScript</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.DataEngineScript.html">DataEngineScript</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.RadioButton.html">RadioButton</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.WebView.html">WebView</a> (<a class="el" href="Plasma.html">Plasma</a>) </td></tr>
|
|
<tr><td><a class="el" href="Plasma.DeclarativeWidget.html">DeclarativeWidget</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.RunnerContext.html">RunnerContext</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td></td></tr>
|
|
<tr><td><a class="el" href="Plasma.Delegate.html">Delegate</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td><a class="el" href="Plasma.RunnerManager.html">RunnerManager</a> (<a class="el" href="Plasma.html">Plasma</a>) </td><td></td></tr>
|
|
</table>
|
|
|
|
</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>
|