--- a/eric6/Documentation/Source/eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.PromtEngine.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.PromtEngine.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,29 +18,37 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.PromtEngine</h1> + <p> Module implementing the Promt translation engine. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#PromtEngine">PromtEngine</a></td> <td>Class implementing the translation engine for the Promt translation service.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="PromtEngine" ID="PromtEngine"></a> <h2>PromtEngine</h2> + <p> Class implementing the translation engine for the Promt translation service. @@ -48,88 +56,115 @@ <h3>Derived from</h3> TranslationEngine <h3>Class Attributes</h3> + <table> <tr><td>TranslatorUrl</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#PromtEngine.__init__">PromtEngine</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#PromtEngine.engineName">engineName</a></td> <td>Public method to return the name of the engine.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PromtEngine.getTranslation">getTranslation</a></td> <td>Public method to translate the given text.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PromtEngine.supportedLanguages">supportedLanguages</a></td> <td>Public method to get the supported languages.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="PromtEngine.__init__" ID="PromtEngine.__init__"></a> <h4>PromtEngine (Constructor)</h4> <b>PromtEngine</b>(<i>plugin, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>plugin</i></dt> <dd> reference to the plugin object (TranslatorPlugin) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent object (QObject) </dd> -</dl><a NAME="PromtEngine.engineName" ID="PromtEngine.engineName"></a> +</dl> +<a NAME="PromtEngine.engineName" ID="PromtEngine.engineName"></a> <h4>PromtEngine.engineName</h4> <b>engineName</b>(<i></i>) + <p> Public method to return the name of the engine. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> engine name (string) </dd> -</dl><a NAME="PromtEngine.getTranslation" ID="PromtEngine.getTranslation"></a> +</dl> +<a NAME="PromtEngine.getTranslation" ID="PromtEngine.getTranslation"></a> <h4>PromtEngine.getTranslation</h4> <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>) + <p> Public method to translate the given text. -</p><dl> +</p> +<dl> + <dt><i>requestObject</i></dt> <dd> reference to the request object (TranslatorRequest) -</dd><dt><i>text</i></dt> +</dd> +<dt><i>text</i></dt> <dd> text to be translated (string) -</dd><dt><i>originalLanguage</i></dt> +</dd> +<dt><i>originalLanguage</i></dt> <dd> language code of the original (string) -</dd><dt><i>translationLanguage</i></dt> +</dd> +<dt><i>translationLanguage</i></dt> <dd> language code of the translation (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> tuple of translated text (string) and flag indicating success (boolean) </dd> -</dl><a NAME="PromtEngine.supportedLanguages" ID="PromtEngine.supportedLanguages"></a> +</dl> +<a NAME="PromtEngine.supportedLanguages" ID="PromtEngine.supportedLanguages"></a> <h4>PromtEngine.supportedLanguages</h4> <b>supportedLanguages</b>(<i></i>) + <p> Public method to get the supported languages. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> list of supported language codes (list of string)