mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-25 03:12:52 +00:00
1169 lines
40 KiB
HTML
1169 lines
40 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||
|
|
|
||
|
|
<head>
|
||
|
|
<title>Plasma.PackageStructure</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>PackageStructure 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>PackageStructure plasma/packagestructure.h <Plasma/PackageStructure>
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
A description of the expected file structure of a given package type
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
PackageStructure defines what is in a package. This information is used
|
||
|
|
to create packages and provides a way to programatically refer to contents.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
An example usage of this class might be:
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
<pre class="fragment">
|
||
|
|
PackageStructure structure;
|
||
|
|
|
||
|
|
structure.addDirectoryDefinition("images", "pics/", i18n("Images"));
|
||
|
|
QStringList mimetypes;
|
||
|
|
mimetypes << "image/svg" << "image/png" << "image/jpeg";
|
||
|
|
structure.setMimetypes("images", mimetypes);
|
||
|
|
|
||
|
|
structure.addDirectoryDefinition("scripts", "code/", i18n("Executable Scripts"));
|
||
|
|
mimetypes.clear();
|
||
|
|
mimetypes << "text/\*";
|
||
|
|
structure.setMimetypes("scripts", mimetypes);
|
||
|
|
|
||
|
|
structure.addFileDefinition("mainscript", "code/main.js", i18n("Main Script File"));
|
||
|
|
structure.setRequired("mainscript", true);
|
||
|
|
</pre>
|
||
|
|
One may also choose to create a subclass of PackageStructure and include the setup
|
||
|
|
in the constructor.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
Either way, PackageStructure creates a sort of "contract" between the packager and
|
||
|
|
the application which is also self-documenting.
|
||
|
|
</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="#newWidgetBrowserFinished">newWidgetBrowserFinished</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="#PackageStructure">__init__</a> (self, QObject parent=0, QString type=i18nc("A non-functional package","Invalid"))</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addDirectoryDefinition">addDirectoryDefinition</a> (self, QString key, QString path, QString name)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addFileDefinition">addFileDefinition</a> (self, QString key, QString path, QString name)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#allowExternalPaths">allowExternalPaths</a> (self)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#contentsPrefix">contentsPrefix</a> (self)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#contentsPrefixPaths">contentsPrefixPaths</a> (self)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#createNewWidgetBrowser">createNewWidgetBrowser</a> (self, QWidget parent=0)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#defaultPackageRoot">defaultPackageRoot</a> (self)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">[QString] </td><td class="memItemRight" valign="bottom"><a class="el" href="#directories">directories</a> (self)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#entryList">entryList</a> (self, QString key)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">[QString] </td><td class="memItemRight" valign="bottom"><a class="el" href="#files">files</a> (self)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#installPackage">installPackage</a> (self, QString archivePath, QString packageRoot)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isRequired">isRequired</a> (self, QString key)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#mimetypes">mimetypes</a> (self, QString key)</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, QString key)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#path">path</a> (self, QString key)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#path">path</a> (self)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#pathChanged">pathChanged</a> (self)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#read">read</a> (self, <a href="../kdecore/KConfigBase.html">KConfigBase</a> config)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#removeDefinition">removeDefinition</a> (self, QString key)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">[QString] </td><td class="memItemRight" valign="bottom"><a class="el" href="#requiredDirectories">requiredDirectories</a> (self)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">[QString] </td><td class="memItemRight" valign="bottom"><a class="el" href="#requiredFiles">requiredFiles</a> (self)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#searchPath">searchPath</a> (self, QString key)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#servicePrefix">servicePrefix</a> (self)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setAllowExternalPaths">setAllowExternalPaths</a> (self, bool allow)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setContentsPrefix">setContentsPrefix</a> (self, QString prefix)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setContentsPrefixPaths">setContentsPrefixPaths</a> (self, QStringList prefixPaths)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setDefaultMimetypes">setDefaultMimetypes</a> (self, QStringList mimetypes)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setDefaultPackageRoot">setDefaultPackageRoot</a> (self, QString packageRoot)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setMimetypes">setMimetypes</a> (self, QString key, QStringList mimetypes)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setPath">setPath</a> (self, QString path)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setRequired">setRequired</a> (self, QString key, bool required)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setServicePrefix">setServicePrefix</a> (self, QString servicePrefix)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#type">type</a> (self)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#uninstallPackage">uninstallPackage</a> (self, QString packageName, QString packageRoot)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#write">write</a> (self, <a href="../kdecore/KConfigBase.html">KConfigBase</a> config)</td></tr>
|
||
|
|
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">KSharedPtr<Plasma::PackageStructure> </td><td class="memItemRight" valign="bottom"><a class="el" href="#load">load</a> (QString packageFormat)</td></tr>
|
||
|
|
</table>
|
||
|
|
<hr><h2>Signal Documentation</h2><a class="anchor" name="newWidgetBrowserFinished"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> newWidgetBrowserFinished</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 new widget browser process completes.
|
||
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("newWidgetBrowserFinished()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="PackageStructure"></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 class="memname"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">QString </td>
|
||
|
|
<td class="paramname"><em>type=i18nc("A non-functional package","Invalid")</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 a package structure definition
|
||
|
|
</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>type</em> </td><td> the type of package. This is often application specific.
|
||
|
|
</td></tr>
|
||
|
|
</table></dl>
|
||
|
|
<p>
|
||
|
|
</p></div></div><a class="anchor" name="addDirectoryDefinition"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> addDirectoryDefinition</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">QString </td>
|
||
|
|
<td class="paramname"><em>path</em>, </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>Adds a directory to the structure of the package. It is added as
|
||
|
|
a not-required element with no associated mimetypes.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
Starting in 4.6, if an entry with the given key
|
||
|
|
already exists, the path is added to it as a search alternative.
|
||
|
|
</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> used as an internal label for this directory
|
||
|
|
|
||
|
|
<tr><td></td><td valign="top"><em>path</em> </td><td> the path within the package for this directory
|
||
|
|
|
||
|
|
<tr><td></td><td valign="top"><em>name</em> </td><td> the user visible (translated) name for the directory
|
||
|
|
</td></tr>
|
||
|
|
</table></dl>
|
||
|
|
<p>
|
||
|
|
</p></div></div><a class="anchor" name="addFileDefinition"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> addFileDefinition</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">QString </td>
|
||
|
|
<td class="paramname"><em>path</em>, </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>Adds a file to the structure of the package. It is added as
|
||
|
|
a not-required element with no associated mimetypes.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
Starting in 4.6, if an entry with the given key
|
||
|
|
already exists, the path is added to it as a search alternative.
|
||
|
|
</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> used as an internal label for this file
|
||
|
|
|
||
|
|
<tr><td></td><td valign="top"><em>path</em> </td><td> the path within the package for this file
|
||
|
|
|
||
|
|
<tr><td></td><td valign="top"><em>name</em> </td><td> the user visible (translated) name for the file
|
||
|
|
</td></tr>
|
||
|
|
</table></dl>
|
||
|
|
<p>
|
||
|
|
</p></div></div><a class="anchor" name="allowExternalPaths"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">bool allowExternalPaths</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 paths/symlinks outside the package itself should be followed.
|
||
|
|
By default this is set to false for security reasons.
|
||
|
|
</dd></dl>
|
||
|
|
</p></div></div><a class="anchor" name="contentsPrefix"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">QString contentsPrefix</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 prefix inserted between the base path and content entries
|
||
|
|
</dd></dl> <dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd> use contentsPrefixPaths() instead.
|
||
|
|
</dd></dl>
|
||
|
|
</p></div></div><a class="anchor" name="contentsPrefixPaths"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">QStringList contentsPrefixPaths</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 prefix paths inserted between the base path and content entries, in order of priority.
|
||
|
|
When searching for a file, all paths will be tried in order.
|
||
|
|
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
|
||
|
|
</dd></dl>
|
||
|
|
</p></div></div><a class="anchor" name="createNewWidgetBrowser"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> createNewWidgetBrowser</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=0</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td width="100%"> </td>
|
||
|
|
</tr></table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc"><p>When called, the package plugin should display a window to the user
|
||
|
|
that they can use to browser, select and then install widgets supported by
|
||
|
|
this package plugin with.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
The user interface may be an in-process dialog or an out-of-process application.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
When the process is complete, the newWidgetBrowserFinished() signal must be
|
||
|
|
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>parent</em> </td><td> the parent widget to use for the widget
|
||
|
|
</td></tr>
|
||
|
|
</table></dl>
|
||
|
|
<p>
|
||
|
|
</p></div></div><a class="anchor" name="defaultPackageRoot"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">QString defaultPackageRoot</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> preferred package root. This defaults to plasma/plasmoids/
|
||
|
|
</dd></dl>
|
||
|
|
</p></div></div><a class="anchor" name="directories"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">[QString] directories</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>The directories defined for this package
|
||
|
|
</p></div></div><a class="anchor" name="entryList"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">QStringList entryList</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></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td width="100%"> </td>
|
||
|
|
</tr></table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc"><p>Get the list of files of a given type.
|
||
|
|
</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 type of file to look for
|
||
|
|
</td></tr> </table></dl>
|
||
|
|
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> list of files by name
|
||
|
|
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
|
||
|
|
</dd></dl>
|
||
|
|
</p></div></div><a class="anchor" name="files"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">[QString] files</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>The individual files, by key, that are defined for this package
|
||
|
|
</p></div></div><a class="anchor" name="installPackage"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">bool installPackage</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>archivePath</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="memname"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">QString </td>
|
||
|
|
<td class="paramname"><em>packageRoot</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td width="100%"> </td>
|
||
|
|
</tr></table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc"><p>Installs a package matching this package structure. By default installs a
|
||
|
|
native Plasma.Package.
|
||
|
|
</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>archivePath</em> </td><td> path to the package archive file
|
||
|
|
|
||
|
|
<tr><td></td><td valign="top"><em>packageRoot</em> </td><td> path to the directory where the package should be
|
||
|
|
installed to
|
||
|
|
</td></tr> </table></dl>
|
||
|
|
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on successful installation, false otherwise
|
||
|
|
</dd></dl>
|
||
|
|
</p></div></div><a class="anchor" name="isRequired"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">bool isRequired</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></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 item at path exists and is required
|
||
|
|
</dd></dl>
|
||
|
|
</p></div></div><a class="anchor" name="mimetypes"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">QStringList mimetypes</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></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> the mimetypes associated with the path, if any
|
||
|
|
</dd></dl>
|
||
|
|
</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"> <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></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> user visible name for the given entry
|
||
|
|
</dd></dl>
|
||
|
|
</p></div></div><a class="anchor" name="path"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">QString path</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></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> the path to the package, or QString() if none
|
||
|
|
</dd></dl>
|
||
|
|
</p></div></div><a class="anchor" name="path"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">QString path</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 path to the package, or QString() if none
|
||
|
|
</dd></dl>
|
||
|
|
</p></div></div><a class="anchor" name="pathChanged"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> pathChanged</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>Called whenever the path changes so that subclasses may take
|
||
|
|
package specific actions.
|
||
|
|
</p></div></div><a class="anchor" name="read"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> read</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/KConfigBase.html">KConfigBase</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>Read a package structure from a config file.
|
||
|
|
</p></div></div><a class="anchor" name="removeDefinition"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> removeDefinition</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></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td width="100%"> </td>
|
||
|
|
</tr></table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc"><p>Removes a definition from the structure of the package.
|
||
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
|
||
|
|
</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>key</em> </td><td> the internal label of the file or directory to remove
|
||
|
|
</td></tr>
|
||
|
|
</table></dl>
|
||
|
|
<p>
|
||
|
|
</p></div></div><a class="anchor" name="requiredDirectories"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">[QString] requiredDirectories</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>The required directories defined for this package
|
||
|
|
</p></div></div><a class="anchor" name="requiredFiles"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">[QString] requiredFiles</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>The individual required files, by key, that are defined for this package
|
||
|
|
</p></div></div><a class="anchor" name="searchPath"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">QStringList searchPath</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></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> a list of paths relative to the package root for the given entry.
|
||
|
|
They are orted by importance: when searching for a file the paths
|
||
|
|
will be searched in order
|
||
|
|
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
|
||
|
|
</dd></dl>
|
||
|
|
</p></div></div><a class="anchor" name="servicePrefix"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">QString servicePrefix</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> service prefix used in desktop files. This defaults to plasma-applet-
|
||
|
|
</dd></dl>
|
||
|
|
</p></div></div><a class="anchor" name="setAllowExternalPaths"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> setAllowExternalPaths</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>allow</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 external paths/symlinks can be followed by a package
|
||
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td></td><td valign="top"><em>allow</em> </td><td> true if paths/symlinks outside of the package should be followed,
|
||
|
|
false if they should be rejected.
|
||
|
|
</td></tr>
|
||
|
|
</table></dl>
|
||
|
|
<p>
|
||
|
|
</p></div></div><a class="anchor" name="setContentsPrefix"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> setContentsPrefix</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>prefix</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 prefix that all the contents in this package should
|
||
|
|
appear under. This defaults to "contents/" and is added automatically
|
||
|
|
between the base path and the entries as defined by the package
|
||
|
|
structure
|
||
|
|
</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>prefix</em> </td><td> the directory prefix to use
|
||
|
|
</td></tr> </table></dl>
|
||
|
|
<p> <dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd> use setContentsPrefixPaths() instead.
|
||
|
|
</dd></dl>
|
||
|
|
</p></div></div><a class="anchor" name="setContentsPrefixPaths"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> setContentsPrefixPaths</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">QStringList </td>
|
||
|
|
<td class="paramname"><em>prefixPaths</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 prefixes that all the contents in this package should
|
||
|
|
appear under. This defaults to "contents/" and is added automatically
|
||
|
|
between the base path and the entries as defined by the package
|
||
|
|
structure. Multiple entries can be added.
|
||
|
|
In this case each file request will be searched in all prefixes in order,
|
||
|
|
and the first found will be returned.
|
||
|
|
</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>prefix</em> </td><td> paths the directory prefix to use
|
||
|
|
</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="setDefaultMimetypes"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> setDefaultMimetypes</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">QStringList </td>
|
||
|
|
<td class="paramname"><em>mimetypes</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td width="100%"> </td>
|
||
|
|
</tr></table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc"><p>Defines the default mimetypes for any definitions that do not have
|
||
|
|
associated mimetypes. Handy for packages with only one or predominantly
|
||
|
|
one file type.
|
||
|
|
</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>mimetypes</em> </td><td> a list of mimetypes
|
||
|
|
</td></tr>
|
||
|
|
</table></dl>
|
||
|
|
<p>
|
||
|
|
</p></div></div><a class="anchor" name="setDefaultPackageRoot"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> setDefaultPackageRoot</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>packageRoot</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td width="100%"> </td>
|
||
|
|
</tr></table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc"><p>Sets preferred package root.
|
||
|
|
</p></div></div><a class="anchor" name="setMimetypes"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> setMimetypes</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">QStringList </td>
|
||
|
|
<td class="paramname"><em>mimetypes</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td width="100%"> </td>
|
||
|
|
</tr></table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc"><p>Define mimetypes for a given part of the structure
|
||
|
|
The path must already have been added using addDirectoryDefinition
|
||
|
|
or addFileDefinition.
|
||
|
|
</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 entry within the package
|
||
|
|
|
||
|
|
<tr><td></td><td valign="top"><em>mimetypes</em> </td><td> a list of mimetypes
|
||
|
|
</td></tr>
|
||
|
|
</table></dl>
|
||
|
|
<p>
|
||
|
|
</p></div></div><a class="anchor" name="setPath"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> setPath</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 to the package. Useful for package formats
|
||
|
|
which do not have well defined contents prior to installation.
|
||
|
|
</p></div></div><a class="anchor" name="setRequired"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> setRequired</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">bool </td>
|
||
|
|
<td class="paramname"><em>required</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 a given part of the structure is required or not.
|
||
|
|
The path must already have been added using addDirectoryDefinition
|
||
|
|
or addFileDefinition.
|
||
|
|
</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 entry within the package
|
||
|
|
|
||
|
|
<tr><td></td><td valign="top"><em>required</em> </td><td> true if this entry is required, false if not
|
||
|
|
</td></tr>
|
||
|
|
</table></dl>
|
||
|
|
<p>
|
||
|
|
</p></div></div><a class="anchor" name="setServicePrefix"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> setServicePrefix</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>servicePrefix</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td width="100%"> </td>
|
||
|
|
</tr></table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc"><p>Sets service prefix.
|
||
|
|
</p></div></div><a class="anchor" name="type"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">QString type</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>Type of package this structure describes
|
||
|
|
</p></div></div><a class="anchor" name="uninstallPackage"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">bool uninstallPackage</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>packageName</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="memname"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">QString </td>
|
||
|
|
<td class="paramname"><em>packageRoot</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td width="100%"> </td>
|
||
|
|
</tr></table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc"><p>Uninstalls a package matching this package structure.
|
||
|
|
</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>packageName</em> </td><td> the name of the package to remove
|
||
|
|
|
||
|
|
<tr><td></td><td valign="top"><em>packageRoot</em> </td><td> path to the directory where the package should be installed to
|
||
|
|
</td></tr> </table></dl>
|
||
|
|
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on successful removal of the package, false otherwise
|
||
|
|
</dd></dl>
|
||
|
|
</p></div></div><a class="anchor" name="write"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname"> write</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/KConfigBase.html">KConfigBase</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>Write this package structure to a config file.
|
||
|
|
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="load"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname"><tr>
|
||
|
|
<td class="memname">KSharedPtr<Plasma::PackageStructure> load</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">QString </td>
|
||
|
|
<td class="paramname"><em>packageFormat</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td>
|
||
|
|
<td></td>
|
||
|
|
<td width="100%"> </td>
|
||
|
|
</tr></table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc"><p>Loads a package format by name.
|
||
|
|
</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>format</em> </td><td> If not empty, attempts to locate the given format, either
|
||
|
|
from built-ins or via plugins.
|
||
|
|
</td></tr> </table></dl>
|
||
|
|
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> a package that matches the format, if available. The caller
|
||
|
|
is responsible for deleting the object.
|
||
|
|
</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>
|