<?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.DeclarativeWidget</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>DeclarativeWidget Class Reference</h1>
<code>from PyKDE4.plasma import *</code>
<p>
Inherits: QGraphicsWidget → QObject<br />
Namespace: <a href="../plasma/Plasma.html">Plasma</a><br />
<h2>Detailed Description</h2>
<p>DeclarativeWidget plasma/declarativewidget.h <Plasma/DeclarativeWidget>
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Marco Martin <mart@kde.org> </dd></dl>
</p>
<p>
A widget that contains an entire QML context, with its own declarative engine
</p>
<p>
Plasma.DeclarativeWidget provides a class for conveniently use QML based
declarative user interfaces inside Plasma widgets.
To one DeclarativeWidget corresponds one QML file (that can eventually include others)
tere will be its own QDeclarativeEngine with a single root object,
described in the QML file.
</p>
<table border="0" cellpadding="0" cellspacing="0"><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="#finished">finished</a> ()</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="#DeclarativeWidget">__init__</a> (self, QGraphicsWidget parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QDeclarativeEngine </td><td class="memItemRight" valign="bottom"><a class="el" href="#engine">engine</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isInitializationDelayed">isInitializationDelayed</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QDeclarativeComponent </td><td class="memItemRight" valign="bottom"><a class="el" href="#mainComponent">mainComponent</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#qmlPath">qmlPath</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#resizeEvent">resizeEvent</a> (self, QGraphicsSceneResizeEvent event)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QObject </td><td class="memItemRight" valign="bottom"><a class="el" href="#rootObject">rootObject</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QScriptEngine </td><td class="memItemRight" valign="bottom"><a class="el" href="#scriptEngine">scriptEngine</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setInitializationDelayed">setInitializationDelayed</a> (self, bool delay)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setQmlPath">setQmlPath</a> (self, QString path)</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="finished"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> finished</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 parsing and execution of the QML file is terminated
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("finished()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="DeclarativeWidget"></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">QGraphicsWidget </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>Constructs a new DeclarativeWidget
</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> the parent of this widget
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="engine"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QDeclarativeEngine engine</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 declarative engine that runs the qml file assigned to this widget.
</dd></dl>
</p></div></div><a class="anchor" name="isInitializationDelayed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isInitializationDelayed</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 initilization of the QML file will be delayed
at the end of the event loop
</dd></dl>
</p></div></div><a class="anchor" name="mainComponent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QDeclarativeComponent mainComponent</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 main QDeclarativeComponent of the engine
</dd></dl>
</p></div></div><a class="anchor" name="qmlPath"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString qmlPath</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 absolute path of the current QML file
</dd></dl>
</p></div></div><a class="anchor" name="resizeEvent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> resizeEvent</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">QGraphicsSceneResizeEvent </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"></div></div><a class="anchor" name="rootObject"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QObject rootObject</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 root object of the declarative object tree
</dd></dl>
</p></div></div><a class="anchor" name="scriptEngine"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QScriptEngine scriptEngine</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 script engine used by the declarative engine
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.7
</dd></dl>
</p></div></div><a class="anchor" name="setInitializationDelayed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setInitializationDelayed</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>delay</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 execution of the QML file has to be delayed later in the event loop. It has to be called before setQmlPath().
In this case will be possible to assign new objects in the main engine context
before the main component gets initialized.
So it will be possible to access it immediately from the QML code.
</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>delay</em> </td><td> if true the initilization of the QML file will be delayed
at the end of the event loop
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setQmlPath"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setQmlPath</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>path</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 path of the QML file to parse and execute
</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>path</em> </td><td> the absolute path of a QML file
</td></tr>
</table></dl>
<p>
</p></div></div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
