<?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.Wallpaper</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>Wallpaper Class Reference</h1>
<code>from PyKDE4.plasma import *</code>
<p>
Inherits: QObject<br />
Namespace: <a href="../plasma/Plasma.html">Plasma</a><br />
<h2>Detailed Description</h2>
<p>Wallpaper plasma/wallpaper.h <Plasma/Wallpaper>
</p>
<p>
The base Wallpaper class
</p>
<p>
"Wallpapers" are components that paint the background for Containments that
do not provide their own background rendering.
</p>
<p>
Wallpaper plugins are registered using .desktop files. These files should be
named using the following naming scheme:
</p>
<p>
plasma-wallpaper-<pluginname>.desktop
</p>
<p>
If a wallpaper plugin provides more than on mode (e.g. Single Image, Wallpaper)
it should include a Actions= entry in the .desktop file, listing the possible
actions. An actions group should be included to provide for translatable names.
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#ResizeMethod">ResizeMethod</a> </td><td class="memItemRight" valign="bottom">{ ScaledResize, CenteredResize, ScaledAndCroppedResize, TiledResize, CenterTiledResize, MaxpectResize, LastResizeMethod }</td></tr>
<tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#configNeedsSaving">configNeedsSaving</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#configurationRequired">configurationRequired</a> (bool needsConfig)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#configureRequested">configureRequested</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#renderCompleted">renderCompleted</a> (QImage image)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#renderHintsChanged">renderHintsChanged</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#update">update</a> (QRectF exposedArea)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#urlDropped">urlDropped</a> (<a href="../kdecore/KUrl.html">KUrl</a> url)</td></tr>
<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="#Wallpaper">__init__</a> (self, QObject parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Wallpaper">__init__</a> (self, QObject parent, [QVariant] args)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addUrls">addUrls</a> (self, <a href="../kdecore/KUrl.List.html">KUrl.List</a> urls)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QRectF </td><td class="memItemRight" valign="bottom"><a class="el" href="#boundingRect">boundingRect</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#configurationRequired">configurationRequired</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[QAction] </td><td class="memItemRight" valign="bottom"><a class="el" href="#contextualActions">contextualActions</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QWidget </td><td class="memItemRight" valign="bottom"><a class="el" href="#createConfigurationInterface">createConfigurationInterface</a> (self, QWidget parent)</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="#dataEngine">dataEngine</a> (self, QString name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#findInCache">findInCache</a> (self, QString key, QImage image, long lastModified=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#icon">icon</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#init">init</a> (self, <a href="../kdecore/KConfigGroup.html">KConfigGroup</a> config)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#insertIntoCache">insertIntoCache</a> (self, QString key, QImage image)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isInitialized">isInitialized</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isPreviewing">isPreviewing</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isUsingRenderingCache">isUsingRenderingCache</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdecore/KServiceAction.html">KServiceAction</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#listRenderingModes">listRenderingModes</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#mouseMoveEvent">mouseMoveEvent</a> (self, QGraphicsSceneMouseEvent event)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#mousePressEvent">mousePressEvent</a> (self, QGraphicsSceneMouseEvent event)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#mouseReleaseEvent">mouseReleaseEvent</a> (self, QGraphicsSceneMouseEvent event)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#name">name</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#needsPreviewDuringConfiguration">needsPreviewDuringConfiguration</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.Package.html">Plasma.Package</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#package">package</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#paint">paint</a> (self, QPainter painter, QRectF exposedRect)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#pluginName">pluginName</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#render">render</a> (self, QString sourceImagePath, QSize size, <a href="../plasma/Plasma.Wallpaper.html#ResizeMethod">Plasma.Wallpaper.ResizeMethod</a> resizeMethod=Plasma.Wallpaper.ScaledResize, QColor color=QColor(0,0,0))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#render">render</a> (self, QImage image, QSize size, <a href="../plasma/Plasma.Wallpaper.html#ResizeMethod">Plasma.Wallpaper.ResizeMethod</a> resizeMethod=Plasma.Wallpaper.ScaledResize, QColor color=QColor(0,0,0))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KServiceAction.html">KServiceAction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#renderingMode">renderingMode</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.Wallpaper.html#ResizeMethod">Plasma.Wallpaper.ResizeMethod</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#resizeMethodHint">resizeMethodHint</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#restore">restore</a> (self, <a href="../kdecore/KConfigGroup.html">KConfigGroup</a> config)</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, <a href="../kdecore/KConfigGroup.html">KConfigGroup</a> config)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setBoundingRect">setBoundingRect</a> (self, QRectF boundingRect)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setConfigurationRequired">setConfigurationRequired</a> (self, bool needsConfiguring, QString reason=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setContextualActions">setContextualActions</a> (self, [QAction] actions)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setPreviewDuringConfiguration">setPreviewDuringConfiguration</a> (self, bool preview)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setPreviewing">setPreviewing</a> (self, bool previewing)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setRenderingMode">setRenderingMode</a> (self, QString mode)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setResizeMethodHint">setResizeMethodHint</a> (self, <a href="../plasma/Plasma.Wallpaper.html#ResizeMethod">Plasma.Wallpaper.ResizeMethod</a> resizeMethod)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setTargetSizeHint">setTargetSizeHint</a> (self, QSizeF targetSize)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setUrls">setUrls</a> (self, <a href="../kdecore/KUrl.List.html">KUrl.List</a> urls)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setUsingRenderingCache">setUsingRenderingCache</a> (self, bool useCache)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#supportsMimetype">supportsMimetype</a> (self, QString mimetype)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QSizeF </td><td class="memItemRight" valign="bottom"><a class="el" href="#targetSizeHint">targetSizeHint</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#wheelEvent">wheelEvent</a> (self, QGraphicsSceneWheelEvent event)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></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="#listWallpaperInfo">listWallpaperInfo</a> (QString formFactor=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="#listWallpaperInfoForMimetype">listWallpaperInfoForMimetype</a> (QString mimetype, QString formFactor=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.Wallpaper.html">Plasma.Wallpaper</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#load">load</a> (QString name, [QVariant] args=QVariantList())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.Wallpaper.html">Plasma.Wallpaper</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#load">load</a> (<a href="../kdecore/KPluginInfo.html">KPluginInfo</a> info, [QVariant] args=QVariantList())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">KSharedPtr<Plasma::PackageStructure> </td><td class="memItemRight" valign="bottom"><a class="el" href="#packageStructure">packageStructure</a> (<a href="../plasma/Plasma.Wallpaper.html">Plasma.Wallpaper</a> paper=0)</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="configNeedsSaving"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> configNeedsSaving</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Emitted when the configuration of the wallpaper needs to be saved
to disk.
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("configNeedsSaving()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="configurationRequired"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> configurationRequired</td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>needsConfig</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Emitted when the state of the wallpaper requiring configuration
changes.
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("configurationRequired(bool)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="configureRequested"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> configureRequested</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Emitted when the user wants to configure/change the wallpaper.
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("configureRequested()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="renderCompleted"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> renderCompleted</td>
<td>(</td>
<td class="paramtype">QImage </td>
<td class="paramname"><em>image</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Emitted when a wallpaper image render is completed.
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("renderCompleted(const QImage&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="renderHintsChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> renderHintsChanged</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd>
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("renderHintsChanged()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="update"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> update</td>
<td>(</td>
<td class="paramtype">QRectF </td>
<td class="paramname"><em>exposedArea</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This signal indicates that wallpaper needs to be repainted.
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("update(const QRectF&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="urlDropped"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> urlDropped</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Emitted when a URL matching X-Plasma-DropMimeTypes is dropped on the wallpaper
</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>url</em> </td><td> the URL of the dropped file
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("urlDropped(const KUrl&)"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="Wallpaper"></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">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>Default constructor for an empty or null wallpaper
</p></div></div><a class="anchor" name="Wallpaper"></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">QObject </td>
<td class="paramname"><em>parent</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></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This constructor is to be used with the plugin loading systems
found in KPluginInfo and KService. The argument list is expected
to have one element: the KService service ID for the desktop entry.
</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>parent</em> </td><td> a QObject parent; you probably want to pass in 0
<tr><td></td><td valign="top"><em>args</em> </td><td> a list of strings containing one entry: the service id
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="addUrls"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> addUrls</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/KUrl.List.html">KUrl.List</a> </td>
<td class="paramname"><em>urls</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This method is invoked by setUrls(KUrl.List)
Can be Overriden by Plugins which want to support setting Image URLs
Will be changed to virtual method in libplasma2/KDE5
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.7
</dd></dl>
</p></div></div><a class="anchor" name="boundingRect"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QRectF boundingRect</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 bounding rectangle
</p></div></div><a class="anchor" name="configurationRequired"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool configurationRequired</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>Emitted when the state of the wallpaper requiring configuration
changes.
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="contextualActions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[QAction] contextualActions</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 wallpaper contextual actions (nothing by default)
</p></div></div><a class="anchor" name="createConfigurationInterface"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QWidget createConfigurationInterface</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">QWidget </td>
<td class="paramname"><em>parent</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns a widget that can be used to configure the options (if any)
associated with this wallpaper. It will be deleted by the caller
when it complete. The default implementation returns a null pointer.
</p>
<p>
To signal that settings have changed connect to
settingsChanged(bool modified) in <b>parent.</b>
</p>
<p>
<pre class="fragment"> connect(this, SIGNAL(settingsChanged(bool), parent, SLOT(settingsChanged(bool)))
</pre>
</p>
<p>
Emit settingsChanged(true) when the settings are changed and false when the original state is restored.
</p>
<p>
Implementation detail note: for best visual results, use a QGridLayout with two columns,
with the option labels in column 0
</p></div></div><a class="anchor" name="dataEngine"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.DataEngine.html">Plasma.DataEngine</a> dataEngine</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>Loads the given DataEngine
</p>
<p>
Tries to load the data engine given by <b>name.</b> Each engine is
only loaded once, and that instance is re-used on all subsequent
requests.
</p>
<p>
If the data engine was not found, an invalid data engine is returned
(see DataEngine.isValid()).
</p>
<p>
Note that you should <em>not</em> delete the returned engine.
</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> Name of the data engine to load
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> pointer to the data engine if it was loaded,
or an invalid data engine if the requested engine
could not be loaded
</dd></dl> </p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="findInCache"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool findInCache</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>key</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QImage </td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>lastModified=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Tries to load pixmap with the specified key from cache.
</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>key</em> </td><td> the name to use in the cache for this image
<tr><td></td><td valign="top"><em>image</em> </td><td> the image object to populate with the resulting data if found
<tr><td></td><td valign="top"><em>lastModified</em> </td><td> if non-zero, the time stamp is also checked on the file,
and must be newer than the timestamp to be loaded
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true when pixmap was found and loaded from cache, false otherwise
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="icon"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString icon</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 the icon related to this wallpaper
</p></div></div><a class="anchor" name="init"></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/KConfigGroup.html">KConfigGroup</a> </td>
<td class="paramname"><em>config</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This method is called once the wallpaper is loaded or mode is changed.
</p>
<p>
The mode can be retrieved using the renderingMode() 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>config</em> </td><td> Config group to load settings
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="insertIntoCache"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> insertIntoCache</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>key</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QImage </td>
<td class="paramname"><em>image</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Insert specified pixmap into the cache if usingRenderingCache.
If the cache already contains pixmap with the specified key then it is
overwritten.
</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>key</em> </td><td> the name use in the cache for this image; if the image is specific
to this wallpaper plugin, consider including the name() as part of
the cache key to avoid collisions with other plugins.
<tr><td></td><td valign="top"><em>image</em> </td><td> the image to store in the cache; passing in a null image will cause
the cached image to be removed from the cache
</td></tr>
</table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="isInitialized"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isInitialized</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> true if initialized (usually by calling restore), false otherwise
</dd></dl>
</p></div></div><a class="anchor" name="isPreviewing"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isPreviewing</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> true if in preview mode, such as in a configuation dialog
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="isUsingRenderingCache"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isUsingRenderingCache</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> true if disk caching is turned on.
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="listRenderingModes"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdecore/KServiceAction.html">KServiceAction</a>] listRenderingModes</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 modes the wallpaper has, as specified in the
.desktop file.
</p></div></div><a class="anchor" name="mouseMoveEvent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> mouseMoveEvent</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">QGraphicsSceneMouseEvent </td>
<td class="paramname"><em>event</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Mouse move event. To prevent further propagation of the event,
the event must be accepted.
</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>event</em> </td><td> the mouse event object
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="mousePressEvent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> mousePressEvent</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">QGraphicsSceneMouseEvent </td>
<td class="paramname"><em>event</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Mouse press event. To prevent further propagation of the even,
and to receive mouseMoveEvents, the event must be accepted.
</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>event</em> </td><td> the mouse event object
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="mouseReleaseEvent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> mouseReleaseEvent</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">QGraphicsSceneMouseEvent </td>
<td class="paramname"><em>event</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Mouse release event. To prevent further propagation of the event,
the event must be accepted.
</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>event</em> </td><td> the mouse event object
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="name"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString name</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 the user-visible name for the wallpaper, as specified in the
.desktop file.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the user-visible name for the wallpaper.
</dd></dl>
</p></div></div><a class="anchor" name="needsPreviewDuringConfiguration"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool needsPreviewDuringConfiguration</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> true if the wallpaper needs a live preview in the configuration UI
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
</dd></dl>
</p></div></div><a class="anchor" name="package"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.Package.html">Plasma.Package</a> package</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>Accessor for the associated Package object if any.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the Package object, or 0 if none
</dd></dl>
</p></div></div><a class="anchor" name="paint"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> paint</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">QPainter </td>
<td class="paramname"><em>painter</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QRectF </td>
<td class="paramname"><em>exposedRect</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>This method is called when the wallpaper should be painted.
</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>painter</em> </td><td> the QPainter to use to do the painting
<tr><td></td><td valign="top"><em>exposedRect</em> </td><td> the rect to paint within
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="pluginName"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString pluginName</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 the plugin name for the wallpaper
</p></div></div><a class="anchor" name="render"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> render</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>sourceImagePath</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QSize </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../plasma/Plasma.Wallpaper.html#ResizeMethod">Plasma.Wallpaper.ResizeMethod</a> </td>
<td class="paramname"><em>resizeMethod=Plasma.Wallpaper.ScaledResize</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QColor </td>
<td class="paramname"><em>color=QColor(0,0,0)</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Renders the wallpaper asyncronously with the given parameters. When the rendering is
complete, the renderCompleted signal is emitted.
</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>image</em> </td><td> the raw QImage
<tr><td></td><td valign="top"><em>size</em> </td><td> the size to render the image as
<tr><td></td><td valign="top"><em>resizeMethod</em> </td><td> the method to use when resizing the image to fit size, <dl class="see" compact><dt><b>See also:</b></dt><dd>
ResizeMethod
</dd></dl> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>color</em> </td><td> the color to use to pad the rendered image if it doesn't take up the
entire size with the given ResizeMethod
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.7.4
</dd></dl>
</p></div></div><a class="anchor" name="render"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> render</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">QImage </td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QSize </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../plasma/Plasma.Wallpaper.html#ResizeMethod">Plasma.Wallpaper.ResizeMethod</a> </td>
<td class="paramname"><em>resizeMethod=Plasma.Wallpaper.ScaledResize</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QColor </td>
<td class="paramname"><em>color=QColor(0,0,0)</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Renders the wallpaper asyncronously with the given parameters. When the rendering is
complete, the renderCompleted signal is emitted.
</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>image</em> </td><td> the raw QImage
<tr><td></td><td valign="top"><em>size</em> </td><td> the size to render the image as
<tr><td></td><td valign="top"><em>resizeMethod</em> </td><td> the method to use when resizing the image to fit size, <dl class="see" compact><dt><b>See also:</b></dt><dd>
ResizeMethod
</dd></dl> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>color</em> </td><td> the color to use to pad the rendered image if it doesn't take up the
entire size with the given ResizeMethod
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.7.4
</dd></dl>
</p></div></div><a class="anchor" name="renderingMode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KServiceAction.html">KServiceAction</a> renderingMode</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> the currently active rendering mode
</dd></dl>
</p></div></div><a class="anchor" name="resizeMethodHint"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.Wallpaper.html#ResizeMethod">Plasma.Wallpaper.ResizeMethod</a> resizeMethodHint</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> the current resize method hint
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.7.2
</dd></dl>
</p></div></div><a class="anchor" name="restore"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> restore</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/KConfigGroup.html">KConfigGroup</a> </td>
<td class="paramname"><em>config</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This method should be called once the wallpaper is loaded or mode is changed.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>config</em> </td><td> Config group to load settings
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> init
</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"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KConfigGroup.html">KConfigGroup</a> </td>
<td class="paramname"><em>config</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This method is called when settings need to be saved.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>config</em> </td><td> Config group to save settings
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setBoundingRect"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setBoundingRect</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">QRectF </td>
<td class="paramname"><em>boundingRect</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets bounding rectangle
</p></div></div><a class="anchor" name="setConfigurationRequired"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setConfigurationRequired</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">bool </td>
<td class="paramname"><em>needsConfiguring</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>reason=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>When the wallpaper needs to be configured before being usable, this
method can be called to denote that action is required
</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>needsConfiguring</em> </td><td> true if the applet needs to be configured,
or false if it doesn't
<tr><td></td><td valign="top"><em>reason</em> </td><td> a translated message for the user explaining that the
applet needs configuring; this should note what needs
to be configured
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="setContextualActions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setContextualActions</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">[QAction] </td>
<td class="paramname"><em>actions</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the contextual actions for this wallpaper.
</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>actions</em> </td><td> A list of contextual actions for this wallpaper
</td></tr>
</table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p></div></div><a class="anchor" name="setPreviewDuringConfiguration"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setPreviewDuringConfiguration</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">bool </td>
<td class="paramname"><em>preview</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets whether the configuration user interface of the wallpaper should have
a live preview rendered by a Wallpaper instance. note: this is just an
hint, the configuration user interface can choose to ignore it
</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>preview</em> </td><td> true if a preview should be shown
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
</dd></dl>
</p></div></div><a class="anchor" name="setPreviewing"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setPreviewing</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">bool </td>
<td class="paramname"><em>previewing</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Puts the wallpaper into preview mode
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="setRenderingMode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setRenderingMode</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>mode</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the rendering mode for this wallpaper.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>mode</em> </td><td> One of the modes supported by the plugin,
or an empty string for the default mode.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setResizeMethodHint"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setResizeMethodHint</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="../plasma/Plasma.Wallpaper.html#ResizeMethod">Plasma.Wallpaper.ResizeMethod</a> </td>
<td class="paramname"><em>resizeMethod</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Allows one to set rendering hints that may differ from the actualities of the
Wallpaper's current state, allowing for better selection of papers from packages,
for instance.
</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>resizeMethod</em> </td><td> The resize method to assume will be used for future wallpaper
scaling; may later be changed by calls to render()
</td></tr>
</table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="setTargetSizeHint"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setTargetSizeHint</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">QSizeF </td>
<td class="paramname"><em>targetSize</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Allows one to set rendering hints that may differ from the actualities of the
Wallpaper's current state, allowing for better selection of papers from packages,
for instance.
</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>targetSize</em> </td><td> The size to assume will be used for future wallpaper scaling
</td></tr>
</table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="setUrls"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setUrls</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/KUrl.List.html">KUrl.List</a> </td>
<td class="paramname"><em>urls</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the urls for the wallpaper
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>urls</em> </td><td> Urls of the selected images
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.7
</dd></dl>
</p></div></div><a class="anchor" name="setUsingRenderingCache"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setUsingRenderingCache</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">bool </td>
<td class="paramname"><em>useCache</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets whether or not to cache on disk the results of calls to render. If the wallpaper
changes often or is innexpensive to render, then it's probably best not to cache them.
</p>
<p>
The default is not to cache.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> render
</dd></dl> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>useCache</em> </td><td> true to cache rendered papers on disk, false not to cache
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="supportsMimetype"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool supportsMimetype</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>mimetype</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the mimetype is supported by this wallpaper and
can be used in renderering. Uses the MimeType= entry from
the .desktop file, and can include mimetypes that may not be
suitable for drag-and-drop purposes.
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.7
</dd></dl>
</p></div></div><a class="anchor" name="targetSizeHint"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QSizeF targetSizeHint</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> the current target size method hint
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.7.2
</dd></dl>
</p></div></div><a class="anchor" name="wheelEvent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> wheelEvent</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">QGraphicsSceneWheelEvent </td>
<td class="paramname"><em>event</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Mouse wheel event. To prevent further propagation of the event,
the event must be accepted.
</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>event</em> </td><td> the wheel event object
</td></tr>
</table></dl>
<p>
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="listWallpaperInfo"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] listWallpaperInfo</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>formFactor=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 wallpapers.
</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>formFactor</em> </td><td> the format of the wallpaper being search for (e.g. desktop)
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> list of wallpapers
</dd></dl>
</p></div></div><a class="anchor" name="listWallpaperInfoForMimetype"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] listWallpaperInfoForMimetype</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>mimetype</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>formFactor=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 wallpapers that can accept the given mimetype
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>mimetype</em> </td><td> the mimetype to search for
<tr><td></td><td valign="top"><em>formFactor</em> </td><td> the format of the wallpaper being search for (e.g. desktop)
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> list of wallpapers
</dd></dl>
</p></div></div><a class="anchor" name="load"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.Wallpaper.html">Plasma.Wallpaper</a> load</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=QVariantList()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Attempts to load a wallpaper
</p>
<p>
Returns a pointer to the wallpaper if successful.
The caller takes responsibility for the wallpaper, including
deleting it when no longer needed.
</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>info</em> </td><td> KPluginInfo object for the desired wallpaper
<tr><td></td><td valign="top"><em>args</em> </td><td> to send the wallpaper extra arguments
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> a pointer to the loaded wallpaper, or 0 on load failure
</dd></dl>
</p></div></div><a class="anchor" name="load"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.Wallpaper.html">Plasma.Wallpaper</a> load</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KPluginInfo.html">KPluginInfo</a> </td>
<td class="paramname"><em>info</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>Attempts to load a wallpaper
</p>
<p>
Returns a pointer to the wallpaper if successful.
The caller takes responsibility for the wallpaper, including
deleting it when no longer needed.
</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>info</em> </td><td> KPluginInfo object for the desired wallpaper
<tr><td></td><td valign="top"><em>args</em> </td><td> to send the wallpaper extra arguments
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> a pointer to the loaded wallpaper, or 0 on load failure
</dd></dl>
</p></div></div><a class="anchor" name="packageStructure"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">KSharedPtr<Plasma::PackageStructure> packageStructure</td>
<td>(</td>
<td class="paramtype"><a href="../plasma/Plasma.Wallpaper.html">Plasma.Wallpaper</a> </td>
<td class="paramname"><em>paper=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the Package specialization for wallpapers. May be queried for 'preferred'
which will return the preferred wallpaper image path given the associated Wallpaper
object, if any.
</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>paper</em> </td><td> the Wallpaper object to associated the PackageStructure with,
which will then use the Wallpaper object to define things such as
default size and resize methods.
</td></tr>
</table></dl>
<p>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="ResizeMethod"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">ResizeMethod</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Various resize modes supported by the built in image renderer
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>ScaledResize</em> </td><td><tr><td valign="top"><em>CenteredResize</em> </td><td><tr><td valign="top"><em>ScaledAndCroppedResize</em> </td><td><tr><td valign="top"><em>TiledResize</em> </td><td><tr><td valign="top"><em>CenterTiledResize</em> </td><td><tr><td valign="top"><em>MaxpectResize</em> </td><td><tr><td valign="top"><em>LastResizeMethod</em> = MaxpectResize</td><td></table>
</dl>
</div></div><p>
</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>
