Documentation/Source/eric4.PluginManager.PluginExceptions.html

changeset 3
0d9daebf5b8c
diff -r bc6196164237 -r 0d9daebf5b8c Documentation/Source/eric4.PluginManager.PluginExceptions.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric4.PluginManager.PluginExceptions.html	Mon Dec 28 16:18:43 2009 +0000
@@ -0,0 +1,304 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric4.PluginManager.PluginExceptions</title>
+<style>
+body {
+    background:white;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #4FA4FF; }
+h2 { color: white; background: #4FA4FF; }
+h3 { color: white; background: #00557F; }
+h4 { color: white; background: #00557F; }
+    
+a { color: #AA5500; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric4.PluginManager.PluginExceptions</h1>
+<p>
+Module implementing the exceptions raised by the plugin system.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PluginActivationError">PluginActivationError</a></td>
+<td>Class defining an error raised, when there was an error during plugin activation.</td>
+</tr><tr>
+<td><a href="#PluginClassFormatError">PluginClassFormatError</a></td>
+<td>Class defining an error raised, when the plugin module's class is invalid.</td>
+</tr><tr>
+<td><a href="#PluginError">PluginError</a></td>
+<td>Class defining a special error for the plugin classes.</td>
+</tr><tr>
+<td><a href="#PluginLoadError">PluginLoadError</a></td>
+<td>Class defining an error raised, when there was an error during plugin loading.</td>
+</tr><tr>
+<td><a href="#PluginModuleFormatError">PluginModuleFormatError</a></td>
+<td>Class defining an error raised, when the plugin module is invalid.</td>
+</tr><tr>
+<td><a href="#PluginModulesError">PluginModulesError</a></td>
+<td>Class defining an error raised, when no plugin modules were found.</td>
+</tr><tr>
+<td><a href="#PluginPathError">PluginPathError</a></td>
+<td>Class defining an error raised, when the plugin paths were not found and could not be created.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="PluginActivationError" ID="PluginActivationError"></a>
+<h2>PluginActivationError</h2>
+<p>
+    Class defining an error raised, when there was an error during plugin activation.
+</p>
+<h3>Derived from</h3>
+PluginError
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PluginActivationError.__init__">PluginActivationError</a></td>
+<td>Constructor</td>
+</tr>
+</table>
+<a NAME="PluginActivationError.__init__" ID="PluginActivationError.__init__"></a>
+<h4>PluginActivationError (Constructor)</h4>
+<b>PluginActivationError</b>(<i>name</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+name of the plugin module (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="PluginClassFormatError" ID="PluginClassFormatError"></a>
+<h2>PluginClassFormatError</h2>
+<p>
+    Class defining an error raised, when the plugin module's class is invalid.
+</p>
+<h3>Derived from</h3>
+PluginError
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PluginClassFormatError.__init__">PluginClassFormatError</a></td>
+<td>Constructor</td>
+</tr>
+</table>
+<a NAME="PluginClassFormatError.__init__" ID="PluginClassFormatError.__init__"></a>
+<h4>PluginClassFormatError (Constructor)</h4>
+<b>PluginClassFormatError</b>(<i>name, class_, missing</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+name of the plugin module (string)
+</dd><dt><i>class_</i></dt>
+<dd>
+name of the class not satisfying the requirements (string)
+</dd><dt><i>missing</i></dt>
+<dd>
+description of the missing element (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="PluginError" ID="PluginError"></a>
+<h2>PluginError</h2>
+<p>
+    Class defining a special error for the plugin classes.
+</p>
+<h3>Derived from</h3>
+Exception
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PluginError.__init__">PluginError</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#PluginError.__repr__">__repr__</a></td>
+<td>Private method returning a representation of the exception.</td>
+</tr><tr>
+<td><a href="#PluginError.__str__">__str__</a></td>
+<td>Private method returning a string representation of the exception.</td>
+</tr>
+</table>
+<a NAME="PluginError.__init__" ID="PluginError.__init__"></a>
+<h4>PluginError (Constructor)</h4>
+<b>PluginError</b>(<i></i>)
+<p>
+        Constructor
+</p><a NAME="PluginError.__repr__" ID="PluginError.__repr__"></a>
+<h4>PluginError.__repr__</h4>
+<b>__repr__</b>(<i></i>)
+<p>
+        Private method returning a representation of the exception.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+string representing the error message
+</dd>
+</dl><a NAME="PluginError.__str__" ID="PluginError.__str__"></a>
+<h4>PluginError.__str__</h4>
+<b>__str__</b>(<i></i>)
+<p>
+        Private method returning a string representation of the exception.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+string representing the error message
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="PluginLoadError" ID="PluginLoadError"></a>
+<h2>PluginLoadError</h2>
+<p>
+    Class defining an error raised, when there was an error during plugin loading.
+</p>
+<h3>Derived from</h3>
+PluginError
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PluginLoadError.__init__">PluginLoadError</a></td>
+<td>Constructor</td>
+</tr>
+</table>
+<a NAME="PluginLoadError.__init__" ID="PluginLoadError.__init__"></a>
+<h4>PluginLoadError (Constructor)</h4>
+<b>PluginLoadError</b>(<i>name</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+name of the plugin module (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="PluginModuleFormatError" ID="PluginModuleFormatError"></a>
+<h2>PluginModuleFormatError</h2>
+<p>
+    Class defining an error raised, when the plugin module is invalid.
+</p>
+<h3>Derived from</h3>
+PluginError
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PluginModuleFormatError.__init__">PluginModuleFormatError</a></td>
+<td>Constructor</td>
+</tr>
+</table>
+<a NAME="PluginModuleFormatError.__init__" ID="PluginModuleFormatError.__init__"></a>
+<h4>PluginModuleFormatError (Constructor)</h4>
+<b>PluginModuleFormatError</b>(<i>name, missing</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+name of the plugin module (string)
+</dd><dt><i>missing</i></dt>
+<dd>
+description of the missing element (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="PluginModulesError" ID="PluginModulesError"></a>
+<h2>PluginModulesError</h2>
+<p>
+    Class defining an error raised, when no plugin modules were found.
+</p>
+<h3>Derived from</h3>
+PluginError
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PluginModulesError.__init__">PluginModulesError</a></td>
+<td>Constructor</td>
+</tr>
+</table>
+<a NAME="PluginModulesError.__init__" ID="PluginModulesError.__init__"></a>
+<h4>PluginModulesError (Constructor)</h4>
+<b>PluginModulesError</b>(<i></i>)
+<p>
+        Constructor
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="PluginPathError" ID="PluginPathError"></a>
+<h2>PluginPathError</h2>
+<p>
+    Class defining an error raised, when the plugin paths were not found and
+    could not be created.
+</p>
+<h3>Derived from</h3>
+PluginError
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PluginPathError.__init__">PluginPathError</a></td>
+<td>Constructor</td>
+</tr>
+</table>
+<a NAME="PluginPathError.__init__" ID="PluginPathError.__init__"></a>
+<h4>PluginPathError (Constructor)</h4>
+<b>PluginPathError</b>(<i>msg = None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>msg</i></dt>
+<dd>
+message to be used by the exception (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial