src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.EricPluginWizard.Templates.html

branch
eric7
changeset 10259
b51dfacef37f
parent 9209
b99e7fd55fd3
child 10417
c6011e501282
diff -r e7764f992a01 -r b51dfacef37f src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.EricPluginWizard.Templates.html
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.EricPluginWizard.Templates.html	Fri Oct 27 14:07:03 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.EricPluginWizard.Templates.html	Fri Oct 27 14:09:40 2023 +0200
@@ -9,12 +9,12 @@
 <h1>eric7.Plugins.WizardPlugins.EricPluginWizard.Templates</h1>
 
 <p>
-Module implementing the various plug-in templates.
+    Class documentation goes here.
 </p>
 <h3>Global Attributes</h3>
 
 <table>
-<tr><td>apiFilesTemplate</td></tr><tr><td>configTemplate0</td></tr><tr><td>configTemplate1</td></tr><tr><td>configTemplate2</td></tr><tr><td>configTemplate3</td></tr><tr><td>exeDisplayDataInfoTemplate</td></tr><tr><td>exeDisplayDataListTemplate</td></tr><tr><td>exeDisplayDataTemplate</td></tr><tr><td>mainTemplate</td></tr><tr><td>moduleSetupTemplate</td></tr><tr><td>onDemandTemplate</td></tr><tr><td>previewPixmapTemplate</td></tr>
+<tr><td>__header__</td></tr><tr><td>error</td></tr><tr><td>mainTemplate</td></tr>
 </table>
 <h3>Classes</h3>
 
@@ -24,7 +24,160 @@
 <h3>Functions</h3>
 
 <table>
-<tr><td>None</td></tr>
+
+<tr>
+<td><a href="#__init__">__init__</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#activate">activate</a></td>
+<td>Public method to activate this plug-in.</td>
+</tr>
+<tr>
+<td><a href="#deactivate">deactivate</a></td>
+<td>Module function returning data as required by the configuration dialog.</td>
+</tr>
+<tr>
+<td><a href="#getPreferences">getPreferences</a></td>
+<td>Public method to retrieve the various settings values.</td>
+</tr>
+<tr>
+<td><a href="#prepareUninstall">prepareUninstall</a></td>
+<td>Module function to prepare for an un-installation.</td>
+</tr>
+<tr>
+<td><a href="#setPreferences">setPreferences</a></td>
+<td>Module function to return the API files made available by this plug-in.</td>
+</tr>
 </table>
 <hr />
+<hr />
+<a NAME="__init__" ID="__init__"></a>
+<h2>__init__</h2>
+<b>__init__</b>(<i>self, ui</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>ui</i> (UI.UserInterface)</dt>
+<dd>
+reference to the user interface object
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="activate" ID="activate"></a>
+<h2>activate</h2>
+<b>activate</b>(<i>self</i>)
+
+<p>
+        Public method to activate this plug-in.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple of None and activation status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="deactivate" ID="deactivate"></a>
+<h2>deactivate</h2>
+<b>deactivate</b>(<i>self</i>)
+
+<p>
+    Module function returning data as required by the configuration dialog.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing the relevant data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getPreferences" ID="getPreferences"></a>
+<h2>getPreferences</h2>
+<b>getPreferences</b>(<i>self, key</i>)
+
+<p>
+        Public method to retrieve the various settings values.
+</p>
+<dl>
+
+<dt><i>key</i> (str)</dt>
+<dd>
+the key of the value to get
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+the requested setting 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="prepareUninstall" ID="prepareUninstall"></a>
+<h2>prepareUninstall</h2>
+<b>prepareUninstall</b>(<i></i>)
+
+<p>
+    Module function to prepare for an un-installation.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="setPreferences" ID="setPreferences"></a>
+<h2>setPreferences</h2>
+<b>setPreferences</b>(<i>self, key, value</i>)
+
+<p>
+    Module function to return the API files made available by this plug-in.
+</p>
+<dl>
+
+<dt><i>language</i> (str)</dt>
+<dd>
+language to get APIs for
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of API filenames
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
 </body></html>
\ No newline at end of file

eric ide

mercurial