<?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>KNS.Engine</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.4 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>Engine Class Reference</h1>
<code>from PyKDE4.knewstuff import *</code>
<p>
Namespace: KNS.Engine<br />
<h2>Detailed Description</h2>
<p>The KNewStuff2 engine is the top-level class to handle GHNS and DXS workflows.
</p>
<p>
An engine implements GHNS workflows, which consist of discrete steps
performed by the inherited engine. Depending on the provider, traditional
GHNS or DXS are used transparently.
This class is the one which applications should use.
In most cases, either upload() or download() will be called by the
application to upload or download data.
</p>
<p>
Deprecated, use knewstuff3!
</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="#Engine">__init__</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Engine">__init__</a> (self, <a href="../knewstuff/KNS.Engine.html">KNS.Engine</a> a0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../knewstuff/KNS.Entry.List.html">KNS.Entry.List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#download">download</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#downloadDialog">downloadDialog</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#downloadDialog">downloadDialog</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> receiver, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> slot)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../knewstuff/KNS.Entry.List.html">KNS.Entry.List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#downloadDialogModal">downloadDialogModal</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#init">init</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> config)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../knewstuff/KNS.Entry.html">KNS.Entry</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#upload">upload</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> file)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#uploadDialog">uploadDialog</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> file)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../knewstuff/KNS.Entry.html">KNS.Entry</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#uploadDialogModal">uploadDialogModal</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> file)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="Engine"></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="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> </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>Engine constructor.
</p>
<p>
As many engines as needed can be instantiated, although one should use
the static methods download() and upload() instead.
</p></div></div><a class="anchor" name="Engine"></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="../knewstuff/KNS.Engine.html">KNS.Engine</a> </td>
<td class="paramname"><em>a0</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="download"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../knewstuff/KNS.Entry.List.html">KNS.Entry.List</a> download</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>Recommended download workflow entry point.
</p>
<p>
This method is a static convenience wrapper around downloadDialogModal()
which does not require the manual construction of an engine object.
The engine will be configured to load appname.knsrc.
The resulting entry list must not be freed, as the engine will continue
to keep track of it.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> List of installed or deinstalled entries
NOTE: this is a copy of each entry because this call deletes its own
engine which deletes the original entries, so you need to delete the entries
returned in the list
</dd></dl> </p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> downloadDialogModal()
</dd></dl>
</p></div></div><a class="anchor" name="downloadDialog"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> downloadDialog</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>Asynchronous way of starting the download workflow and getting feedback to a slot when the dialog closes.
</p>
<p>
This method should be used whenever a blocking application with a
non-blocking GUI during GHNS operations is not suitable.
the slot passed in should have the signature (KNS.Entry.List) as its parameter
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> downloadDialogModal()
</dd></dl>
</p></div></div><a class="anchor" name="downloadDialog"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> downloadDialog</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="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> </td>
<td class="paramname"><em>receiver</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>slot</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Asynchronous way of starting the download workflow and getting feedback to a slot when the dialog closes.
</p>
<p>
This method should be used whenever a blocking application with a
non-blocking GUI during GHNS operations is not suitable.
the slot passed in should have the signature (KNS.Entry.List) as its parameter
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> downloadDialogModal()
</dd></dl>
</p></div></div><a class="anchor" name="downloadDialogModal"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../knewstuff/KNS.Entry.List.html">KNS.Entry.List</a> downloadDialogModal</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="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> </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>Synchronous way of starting the download workflow.
</p>
<p>
Starts the download workflow. This workflow will turn up a dialog
where the user can select entries for installation and uninstallation.
This method is a modal one. It will return all affected entries as
a list.
</p>
<p>
NOTE: this list must be queried to see which ones were installed and which were uninstalled
since both are in the one list. i.e. (entry->status() == KNS.Entry.Installed)
NOTE: the list returned is not a copy of each entry, so do not delete the entries returned here
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> List of installed or deinstalled entries
</dd></dl>
</p></div></div><a class="anchor" name="init"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool 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="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</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"></div></div><a class="anchor" name="upload"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../knewstuff/KNS.Entry.html">KNS.Entry</a> upload</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="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>file</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Recommended upload workflow entry point.
</p>
<p>
This method is a static convenience wrapper around uploadDialogModal()
which does not require the manual construction of an engine object.
The engine will be configured to load appname.knsrc.
The resulting entry must not be freed, as the engine will continue
to keep track of it.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> Uploaded entry, or <b>null</b> in case of failures
</dd></dl> </p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> uploadDialogModal()
</dd></dl>
</p></div></div><a class="anchor" name="uploadDialog"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> uploadDialog</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="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>file</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Asynchronous way of starting the upload workflow.
</p>
<p>
This method should be used whenever a blocking application with a
non-blocking GUI during GHNS operations is not suitable.
The affected entry will be reported by signals.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> uploadDialogModal()
</dd></dl>
</p></div></div><a class="anchor" name="uploadDialogModal"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../knewstuff/KNS.Entry.html">KNS.Entry</a> uploadDialogModal</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="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>file</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Synchronous way of starting the upload workflow.
</p>
<p>
Starts the upload workflow. This workflow will offer provider
selection and afterwards upload all files associated with an entry.
This method is a modal one. It will return the uploaded entry.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> Uploaded entry, or <b>null</b> in case of failures
</dd></dl>
</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>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
b77dda48f87d4eda8cc559e40c49a652
>
files
>
886
