--- a/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.MicrosoftEngine.html Sun Jun 12 16:05:27 2022 +0200
+++ b/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.MicrosoftEngine.html Mon Jun 13 16:39:53 2022 +0200
@@ -44,7 +44,7 @@
<h3>Class Attributes</h3>
<table>
-<tr><td>AccessTokenUrl</td></tr><tr><td>TextToSpeechUrl</td></tr><tr><td>TranslatorUrl</td></tr>
+<tr><td>TranslatorUrl</td></tr>
</table>
<h3>Class Methods</h3>
@@ -60,10 +60,6 @@
<td>Constructor</td>
</tr>
<tr>
-<td><a href="#MicrosoftEngine.__getAccessToken">__getAccessToken</a></td>
-<td>Private slot to get an access token.</td>
-</tr>
-<tr>
<td><a href="#MicrosoftEngine.__getClientDataAzure">__getClientDataAzure</a></td>
<td>Private method to retrieve the client data.</td>
</tr>
@@ -76,18 +72,10 @@
<td>Public method to return the name of the engine.</td>
</tr>
<tr>
-<td><a href="#MicrosoftEngine.getTextToSpeechData">getTextToSpeechData</a></td>
-<td>Public method to pronounce the given text.</td>
-</tr>
-<tr>
<td><a href="#MicrosoftEngine.getTranslation">getTranslation</a></td>
<td>Public method to translate the given text.</td>
</tr>
<tr>
-<td><a href="#MicrosoftEngine.hasTTS">hasTTS</a></td>
-<td>Public method indicating the Text-to-Speech capability.</td>
-</tr>
-<tr>
<td><a href="#MicrosoftEngine.supportedLanguages">supportedLanguages</a></td>
<td>Public method to get the supported languages.</td>
</tr>
@@ -107,37 +95,13 @@
</p>
<dl>
-<dt><i>plugin</i></dt>
+<dt><i>plugin</i> (TranslatorPlugin)</dt>
<dd>
-reference to the plugin object (TranslatorPlugin)
-</dd>
-<dt><i>parent</i></dt>
-<dd>
-reference to the parent object (QObject)
+reference to the plugin object
</dd>
-</dl>
-<a NAME="MicrosoftEngine.__getAccessToken" ID="MicrosoftEngine.__getAccessToken"></a>
-<h4>MicrosoftEngine.__getAccessToken</h4>
-<b>__getAccessToken</b>(<i>requestObject</i>)
-
-<p>
- Private slot to get an access token.
-</p>
-<p>
- If the stored token is no longer valid, get a new one and store it.
-</p>
-<dl>
-
-<dt><i>requestObject</i></dt>
+<dt><i>parent</i> (QObject)</dt>
<dd>
-reference to the request object
- (TranslatorRequest)
-</dd>
-</dl>
-<dl>
-<dt>Return:</dt>
-<dd>
-access token (string)
+reference to the parent object
</dd>
</dl>
<a NAME="MicrosoftEngine.__getClientDataAzure" ID="MicrosoftEngine.__getClientDataAzure"></a>
@@ -150,14 +114,14 @@
<dl>
<dt>Return:</dt>
<dd>
-tuple giving the API subscription key and a flag indicating
- validity
+tuple giving the API subscription key, the API subscription
+ region and a flag indicating validity
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
-tuple of (str, bool)
+tuple of (str, str, bool)
</dd>
</dl>
<a NAME="MicrosoftEngine.__mapLanguageCode" ID="MicrosoftEngine.__mapLanguageCode"></a>
@@ -169,15 +133,21 @@
</p>
<dl>
-<dt><i>code</i></dt>
+<dt><i>code</i> (str)</dt>
<dd>
-language code (string)
+language code
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-mapped language code (string)
+mapped language code
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="MicrosoftEngine.engineName" ID="MicrosoftEngine.engineName"></a>
@@ -190,37 +160,13 @@
<dl>
<dt>Return:</dt>
<dd>
-engine name (string)
-</dd>
-</dl>
-<a NAME="MicrosoftEngine.getTextToSpeechData" ID="MicrosoftEngine.getTextToSpeechData"></a>
-<h4>MicrosoftEngine.getTextToSpeechData</h4>
-<b>getTextToSpeechData</b>(<i>requestObject, text, language</i>)
-
-<p>
- Public method to pronounce 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 pronounced (string)
-</dd>
-<dt><i>language</i></dt>
-<dd>
-language code of the text (string)
+engine name
</dd>
</dl>
<dl>
-<dt>Return:</dt>
+<dt>Return Type:</dt>
<dd>
-tuple with pronounce data (QByteArray) or error string (string)
- and success flag (boolean)
+str
</dd>
</dl>
<a NAME="MicrosoftEngine.getTranslation" ID="MicrosoftEngine.getTranslation"></a>
@@ -232,42 +178,33 @@
</p>
<dl>
-<dt><i>requestObject</i></dt>
+<dt><i>requestObject</i> (TranslatorRequest)</dt>
<dd>
reference to the request object
- (TranslatorRequest)
</dd>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
<dd>
-text to be translated (string)
+text to be translated
</dd>
-<dt><i>originalLanguage</i></dt>
+<dt><i>originalLanguage</i> (str)</dt>
<dd>
-language code of the original (string)
+language code of the original
</dd>
-<dt><i>translationLanguage</i></dt>
+<dt><i>translationLanguage</i> (str)</dt>
<dd>
-language code of the translation (string)
+language code of the translation
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-tuple of translated text (string) and flag indicating
- success (boolean)
+tuple of translated text and flag indicating success
</dd>
</dl>
-<a NAME="MicrosoftEngine.hasTTS" ID="MicrosoftEngine.hasTTS"></a>
-<h4>MicrosoftEngine.hasTTS</h4>
-<b>hasTTS</b>(<i></i>)
-
-<p>
- Public method indicating the Text-to-Speech capability.
-</p>
<dl>
-<dt>Return:</dt>
+<dt>Return Type:</dt>
<dd>
-flag indicating the Text-to-Speech capability (boolean)
+tuple of (str, bool)
</dd>
</dl>
<a NAME="MicrosoftEngine.supportedLanguages" ID="MicrosoftEngine.supportedLanguages"></a>
@@ -280,7 +217,13 @@
<dl>
<dt>Return:</dt>
<dd>
-list of supported language codes (list of string)
+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>
