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

<!DOCTYPE html>
<html><head>
<title>eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.DeepLEngine</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.DeepLEngine</h1>
<p>
Module implementing the DeepL translation engine.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#DeepLEngine">DeepLEngine</a></td>
<td>Class implementing the translation engine for the DeepL translation service.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="DeepLEngine" ID="DeepLEngine"></a>
<h2>DeepLEngine</h2>
<p>
    Class implementing the translation engine for the DeepL
    translation service.
</p>
<h3>Derived from</h3>
TranslationEngine
<h3>Class Attributes</h3>
<table>
<tr><td>MaxTranslationTextLen</td></tr><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="#DeepLEngine.__init__">DeepLEngine</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#DeepLEngine.engineName">engineName</a></td>
<td>Public method to return the name of the engine.</td>
</tr><tr>
<td><a href="#DeepLEngine.getTranslation">getTranslation</a></td>
<td>Public method to translate the given text.</td>
</tr><tr>
<td><a href="#DeepLEngine.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="DeepLEngine.__init__" ID="DeepLEngine.__init__"></a>
<h4>DeepLEngine (Constructor)</h4>
<b>DeepLEngine</b>(<i>plugin, parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>plugin</i> (TranslatorPlugin)</dt>
<dd>
reference to the plugin object
</dd><dt><i>parent</i> (QObject)</dt>
<dd>
reference to the parent object
</dd>
</dl><a NAME="DeepLEngine.engineName" ID="DeepLEngine.engineName"></a>
<h4>DeepLEngine.engineName</h4>
<b>engineName</b>(<i></i>)
<p>
        Public method to return the name of the engine.
</p><dl>
<dt>Returns:</dt>
<dd>
engine name
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl><a NAME="DeepLEngine.getTranslation" ID="DeepLEngine.getTranslation"></a>
<h4>DeepLEngine.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>Returns:</dt>
<dd>
tuple of translated text (string) and flag indicating
            success (boolean)
</dd>
</dl><a NAME="DeepLEngine.supportedLanguages" ID="DeepLEngine.supportedLanguages"></a>
<h4>DeepLEngine.supportedLanguages</h4>
<b>supportedLanguages</b>(<i></i>)
<p>
        Public method to get the supported languages.
</p><dl>
<dt>Returns:</dt>
<dd>
list of supported language codes
</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>