--- a/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.PromtEngine.html Sun Jun 12 16:05:27 2022 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,161 +0,0 @@ -<!DOCTYPE html> -<html><head> -<title>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.PromtEngine</title> -<meta charset="UTF-8"> -<link rel="stylesheet" href="styles.css"> -</head> -<body> -<a NAME="top" ID="top"></a> -<h1>eric7.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 /> -<a NAME="PromtEngine" ID="PromtEngine"></a> -<h2>PromtEngine</h2> - -<p> - Class implementing the translation engine for the Promt - translation service. -</p> -<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> -<td><a href="#PromtEngine.engineName">engineName</a></td> -<td>Public method to return the name of the engine.</td> -</tr> -<tr> -<td><a href="#PromtEngine.getTranslation">getTranslation</a></td> -<td>Public method to translate the given text.</td> -</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> - -<dt><i>plugin</i></dt> -<dd> -reference to the plugin object (TranslatorPlugin) -</dd> -<dt><i>parent</i></dt> -<dd> -reference to the parent object (QObject) -</dd> -</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> -<dt>Return:</dt> -<dd> -engine name (string) -</dd> -</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> - -<dt><i>requestObject</i></dt> -<dd> -reference to the request object - (TranslatorRequest) -</dd> -<dt><i>text</i></dt> -<dd> -text to be translated (string) -</dd> -<dt><i>originalLanguage</i></dt> -<dd> -language code of the original (string) -</dd> -<dt><i>translationLanguage</i></dt> -<dd> -language code of the translation (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -tuple of translated text (string) and flag indicating - success (boolean) -</dd> -</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> -<dt>Return:</dt> -<dd> -list of supported language codes (list of string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -</body></html> \ No newline at end of file