Fabio Erculiani
311 lines
13 KiB
HTML
311 lines
13 KiB
HTML
<?xml version="1.0" encoding="ascii"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<title>entropy.core.EntropyPluginStore</title>
|
|
<link rel="stylesheet" href="epydoc.css" type="text/css" />
|
|
<script type="text/javascript" src="epydoc.js"></script>
|
|
</head>
|
|
|
|
<body bgcolor="white" text="black" link="blue" vlink="#204080"
|
|
alink="#204080">
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="entropy-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<!-- Project homepage -->
|
|
<th class="navbar" align="right" width="100%">
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><th class="navbar" align="center"
|
|
><a class="navbar" target="_top" href="http://www.sabayon.org/">Entropy Framework</a></th>
|
|
</tr></table></th>
|
|
</tr>
|
|
</table>
|
|
<table width="100%" cellpadding="0" cellspacing="0">
|
|
<tr valign="top">
|
|
<td width="100%">
|
|
<span class="breadcrumbs">
|
|
<a href="entropy-module.html">Package entropy</a> ::
|
|
<a href="entropy.core-module.html">Package core</a> ::
|
|
Class EntropyPluginStore
|
|
</span>
|
|
</td>
|
|
<td>
|
|
<table cellpadding="0" cellspacing="0">
|
|
<!-- hide/show private -->
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== CLASS DESCRIPTION ==================== -->
|
|
<h1 class="epydoc">Class EntropyPluginStore</h1><p class="nomargin-top"><span class="codelink"><a href="entropy.core-pysrc.html#EntropyPluginStore">source code</a></span></p>
|
|
<center>
|
|
<center> <map id="uml_class_diagram_for_entropy__22" name="uml_class_diagram_for_entropy__22">
|
|
<area shape="rect" id="node55" href="entropy.core.EntropyPluginStore-class.html#__init__" title="entropy.core.EntropyPluginStore.__init__" alt="" coords="292,39,552,57"/>
|
|
<area shape="rect" id="node55" href="entropy.core.EntropyPluginStore-class.html#get_plugins" title="Return a copy of the internal dictionary that contains the currently stored plugins map." alt="" coords="292,57,552,76"/>
|
|
<area shape="rect" id="node55" href="entropy.core.EntropyPluginStore-class.html#drop_plugins" title="Drop all the currently stored plugins from storage." alt="" coords="292,76,552,95"/>
|
|
<area shape="rect" id="node55" href="entropy.core.EntropyPluginStore-class.html#add_plugin" title="This method lets you add a plugin to the store." alt="" coords="292,95,552,113"/>
|
|
<area shape="rect" id="node55" href="entropy.core.EntropyPluginStore-class.html#remove_plugin" title="This method lets you remove previously added plugin objects via  identifiers." alt="" coords="292,113,552,132"/>
|
|
<area shape="rect" id="node1" href="entropy.core.EntropyPluginStore-class.html" title="This is a base class for handling a map of plugin objects by providing generic add/remove functions." alt="" coords="280,6,563,138"/>
|
|
<area shape="rect" id="node2" href="entropy.db.plugin_store.EntropyRepositoryPluginStore-class.html" title="EntropyRepository plugin interface." alt="" coords="5,158,328,197"/>
|
|
<area shape="rect" id="node4" href="entropy.qa.QAInterface-class.html" title="Entropy QA interface." alt="" coords="357,158,488,197"/>
|
|
<area shape="rect" id="node5" href="entropy.core.settings.base.SystemSettings-class.html" title="This is the place where all the Entropy settings are stored if they are not considered instance constants (etpConst)." alt="" coords="517,158,736,197"/>
|
|
<area shape="rect" id="node3" href="entropy.db.EntropyRepository-class.html" title="EntropyRepository implements SQLite3 based storage." alt="" coords="81,217,252,255"/>
|
|
</map>
|
|
<img src="uml_class_diagram_for_entropy__22.gif" alt='' usemap="#uml_class_diagram_for_entropy__22" ismap="ismap" class="graph-without-title" />
|
|
</center>
|
|
</center>
|
|
<hr />
|
|
<p>This is a base class for handling a map of plugin objects by providing
|
|
generic add/remove functions.</p>
|
|
|
|
<!-- ==================== INSTANCE METHODS ==================== -->
|
|
<a name="section-InstanceMethods"></a>
|
|
<table class="summary" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td align="left" colspan="2" class="table-header">
|
|
<span class="table-header">Instance Methods</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>)</span></td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="entropy.core-pysrc.html#EntropyPluginStore.__init__">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type">dict</span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="entropy.core.EntropyPluginStore-class.html#get_plugins" class="summary-sig-name">get_plugins</a>(<span class="summary-sig-arg">self</span>)</span><br />
|
|
Return a copy of the internal dictionary that contains the currently
|
|
stored plugins map.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="entropy.core-pysrc.html#EntropyPluginStore.get_plugins">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a name="drop_plugins"></a><span class="summary-sig-name">drop_plugins</span>(<span class="summary-sig-arg">self</span>)</span><br />
|
|
Drop all the currently stored plugins from storage.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="entropy.core-pysrc.html#EntropyPluginStore.drop_plugins">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="entropy.core.EntropyPluginStore-class.html#add_plugin" class="summary-sig-name">add_plugin</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">plugin_id</span>,
|
|
<span class="summary-sig-arg">plugin_object</span>)</span><br />
|
|
This method lets you add a plugin to the store.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="entropy.core-pysrc.html#EntropyPluginStore.add_plugin">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="entropy.core.EntropyPluginStore-class.html#remove_plugin" class="summary-sig-name">remove_plugin</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">plugin_id</span>)</span><br />
|
|
This method lets you remove previously added plugin objects via
|
|
identifiers.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="entropy.core-pysrc.html#EntropyPluginStore.remove_plugin">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== METHOD DETAILS ==================== -->
|
|
<a name="section-MethodDetails"></a>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td align="left" colspan="2" class="table-header">
|
|
<span class="table-header">Method Details</span></td>
|
|
</tr>
|
|
</table>
|
|
<a name="get_plugins"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_plugins</span>(<span class="sig-arg">self</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="entropy.core-pysrc.html#EntropyPluginStore.get_plugins">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<p>Return a copy of the internal dictionary that contains the currently
|
|
stored plugins map.</p>
|
|
<dl class="fields">
|
|
<dt>Returns: dict</dt>
|
|
<dd>stored plugins map</dd>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="add_plugin"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">add_plugin</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">plugin_id</span>,
|
|
<span class="sig-arg">plugin_object</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="entropy.core-pysrc.html#EntropyPluginStore.add_plugin">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<p>This method lets you add a plugin to the store.</p>
|
|
<dl class="fields">
|
|
<dt>Parameters:</dt>
|
|
<dd><ul class="nomargin-top">
|
|
<li><strong class="pname"><code>plugin_id</code></strong> (string) - plugin identifier</li>
|
|
<li><strong class="pname"><code>plugin_object</code></strong> (any Python object) - valid SystemSettingsPlugin instance</li>
|
|
</ul></dd>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="remove_plugin"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">remove_plugin</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">plugin_id</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="entropy.core-pysrc.html#EntropyPluginStore.remove_plugin">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<p>This method lets you remove previously added plugin objects via
|
|
identifiers.</p>
|
|
<dl class="fields">
|
|
<dt>Parameters:</dt>
|
|
<dd><ul class="nomargin-top">
|
|
<li><strong class="pname"><code>plugin_id</code></strong> (basestring) - plugin identifier</li>
|
|
</ul></dd>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<br />
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="entropy-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<!-- Project homepage -->
|
|
<th class="navbar" align="right" width="100%">
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><th class="navbar" align="center"
|
|
><a class="navbar" target="_top" href="http://www.sabayon.org/">Entropy Framework</a></th>
|
|
</tr></table></th>
|
|
</tr>
|
|
</table>
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
|
<tr>
|
|
<td align="left" class="footer">
|
|
Generated by Epydoc 3.0.1 on Mon Jan 4 22:00:21 2010
|
|
</td>
|
|
<td align="right" class="footer">
|
|
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
|
>http://epydoc.sourceforge.net</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<script type="text/javascript">
|
|
<!--
|
|
// Private objects are initially displayed (because if
|
|
// javascript is turned off then we want them to be
|
|
// visible); but by default, we want to hide them. So hide
|
|
// them unless we have a cookie that says to show them.
|
|
checkCookie();
|
|
// -->
|
|
</script>
|
|
</body>
|
|
</html>
|