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

branch
eric7
changeset 10800
c6ce5522be30
parent 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.EricPluginWizard.Templates.html	Tue Jun 25 12:30:47 2024 +0200
+++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.EricPluginWizard.Templates.html	Tue Jun 25 14:44:19 2024 +0200
@@ -35,19 +35,27 @@
 </tr>
 <tr>
 <td><a href="#deactivate">deactivate</a></td>
-<td>Module function returning data as required by the configuration dialog.</td>
+<td>Function to create the Translator configuration page.</td>
+</tr>
+<tr>
+<td><a href="#getConfigData">getConfigData</a></td>
+<td>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="#installDependencies">installDependencies</a></td>
+<td>Function to clear the private data of the plug-in.</td>
+</tr>
+<tr>
 <td><a href="#prepareUninstall">prepareUninstall</a></td>
-<td>Module function to prepare for an un-installation.</td>
+<td>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>
+<td>Function to return the API files made available by this plug-in.</td>
 </tr>
 </table>
 
@@ -96,7 +104,36 @@
 <h2>deactivate</h2>
 <b>deactivate</b>(<i>self</i>)
 <p>
-    Module function returning data as required by the configuration dialog.
+    Function to create the Translator configuration page.
+</p>
+
+<dl>
+
+<dt><i>configDlg</i> (ConfigurationWidget)</dt>
+<dd>
+reference to the configuration dialog
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the configuration page
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+TranslatorPage
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getConfigData" ID="getConfigData"></a>
+<h2>getConfigData</h2>
+<b>getConfigData</b>(<i></i>)
+<p>
+    Function returning data as required by the configuration dialog.
 </p>
 
 <dl>
@@ -143,11 +180,21 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
+<a NAME="installDependencies" ID="installDependencies"></a>
+<h2>installDependencies</h2>
+<b>installDependencies</b>(<i>pipInstall</i>)
+<p>
+    Function to clear the private data of the plug-in.
+</p>
+
+<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.
+    Function to prepare for an un-installation.
 </p>
 
 <div align="right"><a href="#top">Up</a></div>
@@ -157,7 +204,7 @@
 <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.
+    Function to return the API files made available by this plug-in.
 </p>
 
 <dl>

eric ide

mercurial