src/eric7/Documentation/Source/eric7.PluginManager.PluginUtilities.html

branch
eric7
changeset 10064
8c3207703dac
child 10479
856476537696
diff -r 9a6a92fd1eae -r 8c3207703dac src/eric7/Documentation/Source/eric7.PluginManager.PluginUtilities.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.PluginManager.PluginUtilities.html	Wed May 24 17:28:58 2023 +0200
@@ -0,0 +1,108 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.PluginManager.PluginUtilities</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.PluginManager.PluginUtilities</h1>
+
+<p>
+Module implementing common utility functions needed for plugin management.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+
+<tr>
+<td><a href="#getPluginHeaderEntry">getPluginHeaderEntry</a></td>
+<td>Function to get an entry of the plugin header.</td>
+</tr>
+<tr>
+<td><a href="#hasPluginHeaderEntry">hasPluginHeaderEntry</a></td>
+<td>Function to check, if the plugin header contains the given entry.</td>
+</tr>
+</table>
+<hr />
+<hr />
+<a NAME="getPluginHeaderEntry" ID="getPluginHeaderEntry"></a>
+<h2>getPluginHeaderEntry</h2>
+<b>getPluginHeaderEntry</b>(<i>plugin, entry, default</i>)
+
+<p>
+    Function to get an entry of the plugin header.
+</p>
+<dl>
+
+<dt><i>plugin</i> (module)</dt>
+<dd>
+reference to the plugin module
+</dd>
+<dt><i>entry</i> (str)</dt>
+<dd>
+name of the entry
+</dd>
+<dt><i>default</i> (Any)</dt>
+<dd>
+value to be returned if the entry does not exist
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+requested value
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Any
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="hasPluginHeaderEntry" ID="hasPluginHeaderEntry"></a>
+<h2>hasPluginHeaderEntry</h2>
+<b>hasPluginHeaderEntry</b>(<i>plugin, entry</i>)
+
+<p>
+    Function to check, if the plugin header contains the given entry.
+</p>
+<dl>
+
+<dt><i>plugin</i> (module)</dt>
+<dd>
+reference to the plugin module
+</dd>
+<dt><i>entry</i> (str)</dt>
+<dd>
+name of the entry
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating the existence
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial