Documentation/Source/eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.__init__.html

changeset 6018
1c858879d3d0
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.__init__.html	Sun Dec 10 16:23:29 2017 +0100
@@ -0,0 +1,150 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.__init__</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.__init__</h1>
+<p>
+Package containing the various translation engines.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#engineDisplayName">engineDisplayName</a></td>
+<td>Module function to get a translated name for an engine.</td>
+</tr><tr>
+<td><a href="#getEngineIcon">getEngineIcon</a></td>
+<td>Module function to get the icon of the named engine.</td>
+</tr><tr>
+<td><a href="#getKeyUrl">getKeyUrl</a></td>
+<td>Module function to get an URL to request a user key.</td>
+</tr><tr>
+<td><a href="#getTranslationEngine">getTranslationEngine</a></td>
+<td>Module function to instantiate an engine object for the named service.</td>
+</tr><tr>
+<td><a href="#supportedEngineNames">supportedEngineNames</a></td>
+<td>Module function to get the list of supported translation engines.</td>
+</tr>
+</table>
+<hr /><hr />
+<a NAME="engineDisplayName" ID="engineDisplayName"></a>
+<h2>engineDisplayName</h2>
+<b>engineDisplayName</b>(<i>name</i>)
+<p>
+    Module function to get a translated name for an engine.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+name of a translation engine (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+translated engine name (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="getEngineIcon" ID="getEngineIcon"></a>
+<h2>getEngineIcon</h2>
+<b>getEngineIcon</b>(<i>name</i>)
+<p>
+    Module function to get the icon of the named engine.
+</p><dl>
+<dt><i>name</i> (str)</dt>
+<dd>
+name of the translation engine
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+engine icon
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+QIcon
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="getKeyUrl" ID="getKeyUrl"></a>
+<h2>getKeyUrl</h2>
+<b>getKeyUrl</b>(<i>name</i>)
+<p>
+    Module function to get an URL to request a user key.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+name of the online translation service (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+key request URL (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="getTranslationEngine" ID="getTranslationEngine"></a>
+<h2>getTranslationEngine</h2>
+<b>getTranslationEngine</b>(<i>name, plugin, parent=None</i>)
+<p>
+    Module function to instantiate an engine object for the named service.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+name of the online translation service (string)
+</dd><dt><i>plugin</i></dt>
+<dd>
+reference to the plugin object (TranslatorPlugin)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent object
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+translation engine (TranslatorEngine)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="supportedEngineNames" ID="supportedEngineNames"></a>
+<h2>supportedEngineNames</h2>
+<b>supportedEngineNames</b>(<i></i>)
+<p>
+    Module function to get the list of supported translation engines.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+names of supported engines (list of string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial