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

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.WizardPlugins.EricPluginWizard.Templates</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.WizardPlugins.EricPluginWizard.Templates</h1>
<p>
    Class documentation goes here.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>__header__</td></tr>
<tr><td>error</td></tr>
<tr><td>mainTemplate</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Functions</h3>
<table>
<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>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>Function to prepare for an un-installation.</td>
</tr>
<tr>
<td><a href="#setPreferences">setPreferences</a></td>
<td>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>
    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>
<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="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>
    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>
    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>