<?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>KParts.Factory</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>Factory Class Reference</h1>
<code>from PyKDE4.kparts import *</code>
<p>
Inherits: <a href="../kdecore/KPluginFactory.html">KPluginFactory</a> → QObject<br />
Namespace: <a href="../kparts/KParts.html">KParts</a><br />
<h2>Detailed Description</h2>
<p>A generic factory object to create a Part.
</p>
<p>
Factory is an abstract class. Reimplement the
createPartObject() method to give it functionality.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KLibFactory.
</dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Factory">__init__</a> (self, QObject parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kparts/KParts.Part.html">KParts.Part</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#createPart">createPart</a> (self, QWidget parentWidget=0, QObject parent=0, QString classname="KParts.Part", QStringList args=QStringList())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kparts/KParts.Part.html">KParts.Part</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#createPartObject">createPartObject</a> (self, QWidget parentWidget=0, QObject parent=0, QString classname="KParts.Part", QStringList args=QStringList())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KComponentData.html">KComponentData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#partComponentData">partComponentData</a> (self)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KComponentData.html">KComponentData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#partComponentDataFromLibrary">partComponentDataFromLibrary</a> (QString libraryName)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="Factory"></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"></div></div><a class="anchor" name="createPart"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kparts/KParts.Part.html">KParts.Part</a> createPart</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>parentWidget=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QObject </td>
<td class="paramname"><em>parent=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>classname="KParts.Part"</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QStringList </td>
<td class="paramname"><em>args=QStringList()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Creates a part.
</p>
<p>
The QStringList can be used to pass additional arguments to the part.
If the part needs additional arguments, it should take them as
name="value" pairs. This is the way additional arguments will get passed
to the part from eg. khtml. You can for example emebed the part into HTML
by using the following code:
<pre class="fragment">
<object type="my_mimetype" data="url_to_my_data">
<param name="name1" value="value1">
<param name="name2" value="value2">
</object>
</pre>
This could result in a call to
<pre class="fragment">
createPart( parentWidget, parentObject, "KParts.Part",
QStringList("name1="value1"", "name2="value2") );
</pre>
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the newly created part.
</dd></dl> </p>
<p>
createPart() automatically emits a signal KLibFactory.objectCreated to tell
the library about its newly created object. This is very
important for reference counting, and allows unloading the
library automatically once all its objects have been destroyed.
</p></div></div><a class="anchor" name="createPartObject"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kparts/KParts.Part.html">KParts.Part</a> createPartObject</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>parentWidget=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QObject </td>
<td class="paramname"><em>parent=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>classname="KParts.Part"</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QStringList </td>
<td class="paramname"><em>args=QStringList()</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>Reimplement this method in your implementation to create the Part.
</p>
<p>
The QStringList can be used to pass additional arguments to the part.
If the part needs additional arguments, it should take them as
name="value" pairs. This is the way additional arguments will get passed
to the part from eg. khtml. You can for example emebed the part into HTML
by using the following code:
<pre class="fragment">
<object type="my_mimetype" data="url_to_my_data">
<param name="name1" value="value1">
<param name="name2" value="value2">
</object>
</pre>
This could result in a call to
<pre class="fragment">
createPart( parentWidget, parentObject, "KParts.Part",
QStringList("name1="value1"", "name2="value2") );
</pre>
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the newly created part.
</dd></dl>
</p></div></div><a class="anchor" name="partComponentData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KComponentData.html">KComponentData</a> partComponentData</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>If you have a part contained in a shared library you might want to query
for meta-information like the about-data, or the KComponentData in general.
If the part is exported using KParts.GenericFactory then this method will
return the instance that belongs to the part without the need to instantiate
the part component.
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="partComponentDataFromLibrary"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KComponentData.html">KComponentData</a> partComponentDataFromLibrary</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>libraryName</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>A convenience method for partComponentData that takes care of retrieving
the factory for a given library name and calling partComponentData on 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>libraryName</em> </td><td> name of the library to query the instance from
</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>
