Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.TranslationEngine.html
src/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.TranslationEngine.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10259
- b51dfacef37f
- child 10684
- 58c7f23ae1cb
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.TranslationEngine</h1> | 9 <h1>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.TranslationEngine</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the translation engine base class. | 11 Module implementing the translation engine base class. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | 15 <table> |
| 16 <table> | 16 <tr><td>None</td></tr> |
| 17 <tr><td>None</td></tr> | 17 </table> |
| 18 </table> | 18 |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | 20 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#TranslationEngine">TranslationEngine</a></td> | 22 <td><a href="#TranslationEngine">TranslationEngine</a></td> |
| 25 <td>Class implementing the translation engine base class containing default methods.</td> | 23 <td>Class implementing the translation engine base class containing default methods.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | 28 <table> |
| 30 <table> | 29 <tr><td>None</td></tr> |
| 31 <tr><td>None</td></tr> | 30 </table> |
| 32 </table> | 31 |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="TranslationEngine" ID="TranslationEngine"></a> | 34 <a NAME="TranslationEngine" ID="TranslationEngine"></a> |
| 36 <h2>TranslationEngine</h2> | 35 <h2>TranslationEngine</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing the translation engine base class containing | 37 Class implementing the translation engine base class containing |
| 40 default methods. | 38 default methods. |
| 41 </p> | 39 </p> |
| 40 | |
| 42 <h3>Signals</h3> | 41 <h3>Signals</h3> |
| 43 <dl> | 42 <dl> |
| 44 | 43 |
| 45 <dt>availableTranslationsLoaded()</dt> | 44 <dt>availableTranslationsLoaded()</dt> |
| 46 <dd> | 45 <dd> |
| 49 </dd> | 48 </dd> |
| 50 </dl> | 49 </dl> |
| 51 <h3>Derived from</h3> | 50 <h3>Derived from</h3> |
| 52 QObject | 51 QObject |
| 53 <h3>Class Attributes</h3> | 52 <h3>Class Attributes</h3> |
| 54 | 53 <table> |
| 55 <table> | 54 <tr><td>None</td></tr> |
| 56 <tr><td>None</td></tr> | 55 </table> |
| 57 </table> | 56 |
| 58 <h3>Class Methods</h3> | 57 <h3>Class Methods</h3> |
| 59 | 58 <table> |
| 60 <table> | 59 <tr><td>None</td></tr> |
| 61 <tr><td>None</td></tr> | 60 </table> |
| 62 </table> | 61 |
| 63 <h3>Methods</h3> | 62 <h3>Methods</h3> |
| 64 | 63 <table> |
| 65 <table> | |
| 66 | |
| 67 <tr> | 64 <tr> |
| 68 <td><a href="#TranslationEngine.__init__">TranslationEngine</a></td> | 65 <td><a href="#TranslationEngine.__init__">TranslationEngine</a></td> |
| 69 <td>Constructor</td> | 66 <td>Constructor</td> |
| 70 </tr> | 67 </tr> |
| 71 <tr> | 68 <tr> |
| 91 <tr> | 88 <tr> |
| 92 <td><a href="#TranslationEngine.supportedTargetLanguages">supportedTargetLanguages</a></td> | 89 <td><a href="#TranslationEngine.supportedTargetLanguages">supportedTargetLanguages</a></td> |
| 93 <td>Public method to get a list of supported target languages for an original language.</td> | 90 <td>Public method to get a list of supported target languages for an original language.</td> |
| 94 </tr> | 91 </tr> |
| 95 </table> | 92 </table> |
| 93 | |
| 96 <h3>Static Methods</h3> | 94 <h3>Static Methods</h3> |
| 97 | 95 <table> |
| 98 <table> | 96 <tr><td>None</td></tr> |
| 99 <tr><td>None</td></tr> | 97 </table> |
| 100 </table> | 98 |
| 101 | 99 |
| 102 <a NAME="TranslationEngine.__init__" ID="TranslationEngine.__init__"></a> | 100 <a NAME="TranslationEngine.__init__" ID="TranslationEngine.__init__"></a> |
| 103 <h4>TranslationEngine (Constructor)</h4> | 101 <h4>TranslationEngine (Constructor)</h4> |
| 104 <b>TranslationEngine</b>(<i>plugin, parent=None</i>) | 102 <b>TranslationEngine</b>(<i>plugin, parent=None</i>) |
| 105 | |
| 106 <p> | 103 <p> |
| 107 Constructor | 104 Constructor |
| 108 </p> | 105 </p> |
| 106 | |
| 109 <dl> | 107 <dl> |
| 110 | 108 |
| 111 <dt><i>plugin</i> (TranslatorPlugin)</dt> | 109 <dt><i>plugin</i> (TranslatorPlugin)</dt> |
| 112 <dd> | 110 <dd> |
| 113 reference to the plugin object | 111 reference to the plugin object |
| 118 </dd> | 116 </dd> |
| 119 </dl> | 117 </dl> |
| 120 <a NAME="TranslationEngine.engineName" ID="TranslationEngine.engineName"></a> | 118 <a NAME="TranslationEngine.engineName" ID="TranslationEngine.engineName"></a> |
| 121 <h4>TranslationEngine.engineName</h4> | 119 <h4>TranslationEngine.engineName</h4> |
| 122 <b>engineName</b>(<i></i>) | 120 <b>engineName</b>(<i></i>) |
| 123 | |
| 124 <p> | 121 <p> |
| 125 Public method to get the name of the engine. | 122 Public method to get the name of the engine. |
| 126 </p> | 123 </p> |
| 124 | |
| 127 <dl> | 125 <dl> |
| 128 <dt>Return:</dt> | 126 <dt>Return:</dt> |
| 129 <dd> | 127 <dd> |
| 130 engine name | 128 engine name |
| 131 </dd> | 129 </dd> |
| 137 </dd> | 135 </dd> |
| 138 </dl> | 136 </dl> |
| 139 <a NAME="TranslationEngine.getTextToSpeechData" ID="TranslationEngine.getTextToSpeechData"></a> | 137 <a NAME="TranslationEngine.getTextToSpeechData" ID="TranslationEngine.getTextToSpeechData"></a> |
| 140 <h4>TranslationEngine.getTextToSpeechData</h4> | 138 <h4>TranslationEngine.getTextToSpeechData</h4> |
| 141 <b>getTextToSpeechData</b>(<i>requestObject, text, language</i>) | 139 <b>getTextToSpeechData</b>(<i>requestObject, text, language</i>) |
| 142 | |
| 143 <p> | 140 <p> |
| 144 Public method to pronounce the given text. | 141 Public method to pronounce the given text. |
| 145 </p> | 142 </p> |
| 143 | |
| 146 <dl> | 144 <dl> |
| 147 | 145 |
| 148 <dt><i>requestObject</i> (TranslatorRequest)</dt> | 146 <dt><i>requestObject</i> (TranslatorRequest)</dt> |
| 149 <dd> | 147 <dd> |
| 150 reference to the request object | 148 reference to the request object |
| 171 </dd> | 169 </dd> |
| 172 </dl> | 170 </dl> |
| 173 <a NAME="TranslationEngine.getTranslation" ID="TranslationEngine.getTranslation"></a> | 171 <a NAME="TranslationEngine.getTranslation" ID="TranslationEngine.getTranslation"></a> |
| 174 <h4>TranslationEngine.getTranslation</h4> | 172 <h4>TranslationEngine.getTranslation</h4> |
| 175 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>) | 173 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>) |
| 176 | |
| 177 <p> | 174 <p> |
| 178 Public method to translate the given text. | 175 Public method to translate the given text. |
| 179 </p> | 176 </p> |
| 177 | |
| 180 <dl> | 178 <dl> |
| 181 | 179 |
| 182 <dt><i>requestObject</i> (TranslatorRequest)</dt> | 180 <dt><i>requestObject</i> (TranslatorRequest)</dt> |
| 183 <dd> | 181 <dd> |
| 184 reference to the request object | 182 reference to the request object |
| 209 </dd> | 207 </dd> |
| 210 </dl> | 208 </dl> |
| 211 <a NAME="TranslationEngine.hasTTS" ID="TranslationEngine.hasTTS"></a> | 209 <a NAME="TranslationEngine.hasTTS" ID="TranslationEngine.hasTTS"></a> |
| 212 <h4>TranslationEngine.hasTTS</h4> | 210 <h4>TranslationEngine.hasTTS</h4> |
| 213 <b>hasTTS</b>(<i></i>) | 211 <b>hasTTS</b>(<i></i>) |
| 214 | |
| 215 <p> | 212 <p> |
| 216 Public method indicating the Text-to-Speech capability. | 213 Public method indicating the Text-to-Speech capability. |
| 217 </p> | 214 </p> |
| 215 | |
| 218 <dl> | 216 <dl> |
| 219 <dt>Return:</dt> | 217 <dt>Return:</dt> |
| 220 <dd> | 218 <dd> |
| 221 flag indicating the Text-to-Speech capability | 219 flag indicating the Text-to-Speech capability |
| 222 </dd> | 220 </dd> |
| 228 </dd> | 226 </dd> |
| 229 </dl> | 227 </dl> |
| 230 <a NAME="TranslationEngine.supportedLanguages" ID="TranslationEngine.supportedLanguages"></a> | 228 <a NAME="TranslationEngine.supportedLanguages" ID="TranslationEngine.supportedLanguages"></a> |
| 231 <h4>TranslationEngine.supportedLanguages</h4> | 229 <h4>TranslationEngine.supportedLanguages</h4> |
| 232 <b>supportedLanguages</b>(<i></i>) | 230 <b>supportedLanguages</b>(<i></i>) |
| 233 | |
| 234 <p> | 231 <p> |
| 235 Public method to get the supported languages. | 232 Public method to get the supported languages. |
| 236 </p> | 233 </p> |
| 234 | |
| 237 <dl> | 235 <dl> |
| 238 <dt>Return:</dt> | 236 <dt>Return:</dt> |
| 239 <dd> | 237 <dd> |
| 240 list of supported language codes | 238 list of supported language codes |
| 241 </dd> | 239 </dd> |
| 247 </dd> | 245 </dd> |
| 248 </dl> | 246 </dl> |
| 249 <a NAME="TranslationEngine.supportedTargetLanguages" ID="TranslationEngine.supportedTargetLanguages"></a> | 247 <a NAME="TranslationEngine.supportedTargetLanguages" ID="TranslationEngine.supportedTargetLanguages"></a> |
| 250 <h4>TranslationEngine.supportedTargetLanguages</h4> | 248 <h4>TranslationEngine.supportedTargetLanguages</h4> |
| 251 <b>supportedTargetLanguages</b>(<i>original</i>) | 249 <b>supportedTargetLanguages</b>(<i>original</i>) |
| 252 | |
| 253 <p> | 250 <p> |
| 254 Public method to get a list of supported target languages for an | 251 Public method to get a list of supported target languages for an |
| 255 original language. | 252 original language. |
| 256 </p> | 253 </p> |
| 257 <p> | 254 <p> |
| 258 Note: The default implementation return the list of supported languages | 255 Note: The default implementation return the list of supported languages |
| 259 (i.e. the same as those for the source) with the given original | 256 (i.e. the same as those for the source) with the given original |
| 260 removed. | 257 removed. |
| 261 </p> | 258 </p> |
| 259 | |
| 262 <dl> | 260 <dl> |
| 263 | 261 |
| 264 <dt><i>original</i> (str)</dt> | 262 <dt><i>original</i> (str)</dt> |
| 265 <dd> | 263 <dd> |
| 266 original language | 264 original language |
