--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginTranslator.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,292 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.PluginTranslator</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Plugins.PluginTranslator</h1> + +<p> +Module implementing the Translator plugin. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>translatorPluginObject</td></tr><tr><td>version</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#TranslatorPlugin">TranslatorPlugin</a></td> +<td>Class implementing the Translator plug-in.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#createTranslatorPage">createTranslatorPage</a></td> +<td>Module function to create the Translator configuration page.</td> +</tr> +<tr> +<td><a href="#getConfigData">getConfigData</a></td> +<td>Module function returning data as required by the configuration dialog.</td> +</tr> +<tr> +<td><a href="#prepareUninstall">prepareUninstall</a></td> +<td>Module function to prepare for an uninstallation.</td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="TranslatorPlugin" ID="TranslatorPlugin"></a> +<h2>TranslatorPlugin</h2> + +<p> + Class implementing the Translator plug-in. +</p> +<h3>Signals</h3> +<dl> + +<dt>updateLanguages()</dt> +<dd> +emitted to indicate a languages update +</dd> +</dl> +<h3>Derived from</h3> +QObject +<h3>Class Attributes</h3> + +<table> +<tr><td>PreferencesKey</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#TranslatorPlugin.__init__">TranslatorPlugin</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#TranslatorPlugin.__initialize">__initialize</a></td> +<td>Private slot to (re)initialize the plugin.</td> +</tr> +<tr> +<td><a href="#TranslatorPlugin.activate">activate</a></td> +<td>Public method to activate this plugin.</td> +</tr> +<tr> +<td><a href="#TranslatorPlugin.deactivate">deactivate</a></td> +<td>Public method to deactivate this plugin.</td> +</tr> +<tr> +<td><a href="#TranslatorPlugin.getPreferences">getPreferences</a></td> +<td>Public method to retrieve the various settings.</td> +</tr> +<tr> +<td><a href="#TranslatorPlugin.getPreferencesDefault">getPreferencesDefault</a></td> +<td>Public method to retrieve the various default settings.</td> +</tr> +<tr> +<td><a href="#TranslatorPlugin.setPreferences">setPreferences</a></td> +<td>Public method to store the various settings.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="TranslatorPlugin.__init__" ID="TranslatorPlugin.__init__"></a> +<h4>TranslatorPlugin (Constructor)</h4> +<b>TranslatorPlugin</b>(<i>ui</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>ui</i> (UI.UserInterface)</dt> +<dd> +reference to the user interface object +</dd> +</dl> +<a NAME="TranslatorPlugin.__initialize" ID="TranslatorPlugin.__initialize"></a> +<h4>TranslatorPlugin.__initialize</h4> +<b>__initialize</b>(<i></i>) + +<p> + Private slot to (re)initialize the plugin. +</p> +<a NAME="TranslatorPlugin.activate" ID="TranslatorPlugin.activate"></a> +<h4>TranslatorPlugin.activate</h4> +<b>activate</b>(<i></i>) + +<p> + Public method to activate this plugin. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (None, bool) +</dd> +</dl> +<a NAME="TranslatorPlugin.deactivate" ID="TranslatorPlugin.deactivate"></a> +<h4>TranslatorPlugin.deactivate</h4> +<b>deactivate</b>(<i></i>) + +<p> + Public method to deactivate this plugin. +</p> +<a NAME="TranslatorPlugin.getPreferences" ID="TranslatorPlugin.getPreferences"></a> +<h4>TranslatorPlugin.getPreferences</h4> +<b>getPreferences</b>(<i>key</i>) + +<p> + Public method to retrieve the various settings. +</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 +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +any +</dd> +</dl> +<a NAME="TranslatorPlugin.getPreferencesDefault" ID="TranslatorPlugin.getPreferencesDefault"></a> +<h4>TranslatorPlugin.getPreferencesDefault</h4> +<b>getPreferencesDefault</b>(<i>key</i>) + +<p> + Public method to retrieve the various default settings. +</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 +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +any +</dd> +</dl> +<a NAME="TranslatorPlugin.setPreferences" ID="TranslatorPlugin.setPreferences"></a> +<h4>TranslatorPlugin.setPreferences</h4> +<b>setPreferences</b>(<i>key, value</i>) + +<p> + Public method to store the various settings. +</p> +<dl> + +<dt><i>key</i> (str)</dt> +<dd> +the key of the setting to be set +</dd> +<dt><i>value</i> (any)</dt> +<dd> +the value to be set +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="createTranslatorPage" ID="createTranslatorPage"></a> +<h2>createTranslatorPage</h2> +<b>createTranslatorPage</b>(<i>configDlg</i>) + +<p> + Module 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> + 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="prepareUninstall" ID="prepareUninstall"></a> +<h2>prepareUninstall</h2> +<b>prepareUninstall</b>(<i></i>) + +<p> + Module function to prepare for an uninstallation. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file