Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.LibreTranslateEngine.html
src/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.LibreTranslateEngine.html
- branch
- eric7
- changeset 9956
- 5b138f996a1e
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9955:aa02420279fe | 9956:5b138f996a1e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.LibreTranslateEngine</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.LibreTranslateEngine</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the LibreTranslate translation engine. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#LibreTranslateEngine">LibreTranslateEngine</a></td> | |
| 25 <td>Class implementing the translation engine for the LibreTranslate service.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 | |
| 32 <tr> | |
| 33 <td><a href="#createEngine">createEngine</a></td> | |
| 34 <td>Function to instantiate a translator engine object.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="LibreTranslateEngine" ID="LibreTranslateEngine"></a> | |
| 40 <h2>LibreTranslateEngine</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing the translation engine for the LibreTranslate service. | |
| 44 </p> | |
| 45 <h3>Derived from</h3> | |
| 46 TranslationEngine | |
| 47 <h3>Class Attributes</h3> | |
| 48 | |
| 49 <table> | |
| 50 <tr><td>None</td></tr> | |
| 51 </table> | |
| 52 <h3>Class Methods</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 | |
| 61 <tr> | |
| 62 <td><a href="#LibreTranslateEngine.__init__">LibreTranslateEngine</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#LibreTranslateEngine.__getTranslationModels">__getTranslationModels</a></td> | |
| 67 <td>Private method to get the translation models supported by IBM Watson Language Translator.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#LibreTranslateEngine.__getTranslationModelsReplyFinished">__getTranslationModelsReplyFinished</a></td> | |
| 71 <td>Private slot handling the receipt of the available translations.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#LibreTranslateEngine.engineName">engineName</a></td> | |
| 75 <td>Public method to return the name of the engine.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#LibreTranslateEngine.getTranslation">getTranslation</a></td> | |
| 79 <td>Public method to translate the given text.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#LibreTranslateEngine.hasTTS">hasTTS</a></td> | |
| 83 <td>Public method indicating the Text-to-Speech capability.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#LibreTranslateEngine.supportedLanguages">supportedLanguages</a></td> | |
| 87 <td>Public method to get the supported languages.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#LibreTranslateEngine.supportedTargetLanguages">supportedTargetLanguages</a></td> | |
| 91 <td>Public method to get a list of supported target languages for an original language.</td> | |
| 92 </tr> | |
| 93 </table> | |
| 94 <h3>Static Methods</h3> | |
| 95 | |
| 96 <table> | |
| 97 <tr><td>None</td></tr> | |
| 98 </table> | |
| 99 | |
| 100 <a NAME="LibreTranslateEngine.__init__" ID="LibreTranslateEngine.__init__"></a> | |
| 101 <h4>LibreTranslateEngine (Constructor)</h4> | |
| 102 <b>LibreTranslateEngine</b>(<i>plugin, parent=None</i>) | |
| 103 | |
| 104 <p> | |
| 105 Constructor | |
| 106 </p> | |
| 107 <dl> | |
| 108 | |
| 109 <dt><i>plugin</i> (TranslatorPlugin)</dt> | |
| 110 <dd> | |
| 111 reference to the plugin object | |
| 112 </dd> | |
| 113 <dt><i>parent</i> (QObject)</dt> | |
| 114 <dd> | |
| 115 reference to the parent object | |
| 116 </dd> | |
| 117 </dl> | |
| 118 <a NAME="LibreTranslateEngine.__getTranslationModels" ID="LibreTranslateEngine.__getTranslationModels"></a> | |
| 119 <h4>LibreTranslateEngine.__getTranslationModels</h4> | |
| 120 <b>__getTranslationModels</b>(<i></i>) | |
| 121 | |
| 122 <p> | |
| 123 Private method to get the translation models supported by IBM Watson | |
| 124 Language Translator. | |
| 125 </p> | |
| 126 <a NAME="LibreTranslateEngine.__getTranslationModelsReplyFinished" ID="LibreTranslateEngine.__getTranslationModelsReplyFinished"></a> | |
| 127 <h4>LibreTranslateEngine.__getTranslationModelsReplyFinished</h4> | |
| 128 <b>__getTranslationModelsReplyFinished</b>(<i>reply</i>) | |
| 129 | |
| 130 <p> | |
| 131 Private slot handling the receipt of the available translations. | |
| 132 </p> | |
| 133 <dl> | |
| 134 | |
| 135 <dt><i>reply</i> (QNetworkReply)</dt> | |
| 136 <dd> | |
| 137 reference to the network reply object | |
| 138 </dd> | |
| 139 </dl> | |
| 140 <a NAME="LibreTranslateEngine.engineName" ID="LibreTranslateEngine.engineName"></a> | |
| 141 <h4>LibreTranslateEngine.engineName</h4> | |
| 142 <b>engineName</b>(<i></i>) | |
| 143 | |
| 144 <p> | |
| 145 Public method to return the name of the engine. | |
| 146 </p> | |
| 147 <dl> | |
| 148 <dt>Return:</dt> | |
| 149 <dd> | |
| 150 engine name | |
| 151 </dd> | |
| 152 </dl> | |
| 153 <dl> | |
| 154 <dt>Return Type:</dt> | |
| 155 <dd> | |
| 156 str | |
| 157 </dd> | |
| 158 </dl> | |
| 159 <a NAME="LibreTranslateEngine.getTranslation" ID="LibreTranslateEngine.getTranslation"></a> | |
| 160 <h4>LibreTranslateEngine.getTranslation</h4> | |
| 161 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>) | |
| 162 | |
| 163 <p> | |
| 164 Public method to translate the given text. | |
| 165 </p> | |
| 166 <dl> | |
| 167 | |
| 168 <dt><i>requestObject</i> (TranslatorRequest)</dt> | |
| 169 <dd> | |
| 170 reference to the request object | |
| 171 </dd> | |
| 172 <dt><i>text</i> (str)</dt> | |
| 173 <dd> | |
| 174 text to be translated | |
| 175 </dd> | |
| 176 <dt><i>originalLanguage</i> (str)</dt> | |
| 177 <dd> | |
| 178 language code of the original | |
| 179 </dd> | |
| 180 <dt><i>translationLanguage</i> (str)</dt> | |
| 181 <dd> | |
| 182 language code of the translation | |
| 183 </dd> | |
| 184 </dl> | |
| 185 <dl> | |
| 186 <dt>Return:</dt> | |
| 187 <dd> | |
| 188 tuple of translated text and flag indicating success | |
| 189 </dd> | |
| 190 </dl> | |
| 191 <dl> | |
| 192 <dt>Return Type:</dt> | |
| 193 <dd> | |
| 194 tuple of (str, bool) | |
| 195 </dd> | |
| 196 </dl> | |
| 197 <a NAME="LibreTranslateEngine.hasTTS" ID="LibreTranslateEngine.hasTTS"></a> | |
| 198 <h4>LibreTranslateEngine.hasTTS</h4> | |
| 199 <b>hasTTS</b>(<i></i>) | |
| 200 | |
| 201 <p> | |
| 202 Public method indicating the Text-to-Speech capability. | |
| 203 </p> | |
| 204 <dl> | |
| 205 <dt>Return:</dt> | |
| 206 <dd> | |
| 207 flag indicating the Text-to-Speech capability | |
| 208 </dd> | |
| 209 </dl> | |
| 210 <dl> | |
| 211 <dt>Return Type:</dt> | |
| 212 <dd> | |
| 213 bool | |
| 214 </dd> | |
| 215 </dl> | |
| 216 <a NAME="LibreTranslateEngine.supportedLanguages" ID="LibreTranslateEngine.supportedLanguages"></a> | |
| 217 <h4>LibreTranslateEngine.supportedLanguages</h4> | |
| 218 <b>supportedLanguages</b>(<i></i>) | |
| 219 | |
| 220 <p> | |
| 221 Public method to get the supported languages. | |
| 222 </p> | |
| 223 <dl> | |
| 224 <dt>Return:</dt> | |
| 225 <dd> | |
| 226 list of supported language codes | |
| 227 </dd> | |
| 228 </dl> | |
| 229 <dl> | |
| 230 <dt>Return Type:</dt> | |
| 231 <dd> | |
| 232 list of str | |
| 233 </dd> | |
| 234 </dl> | |
| 235 <a NAME="LibreTranslateEngine.supportedTargetLanguages" ID="LibreTranslateEngine.supportedTargetLanguages"></a> | |
| 236 <h4>LibreTranslateEngine.supportedTargetLanguages</h4> | |
| 237 <b>supportedTargetLanguages</b>(<i>original</i>) | |
| 238 | |
| 239 <p> | |
| 240 Public method to get a list of supported target languages for an | |
| 241 original language. | |
| 242 </p> | |
| 243 <dl> | |
| 244 | |
| 245 <dt><i>original</i> (str)</dt> | |
| 246 <dd> | |
| 247 original language | |
| 248 </dd> | |
| 249 </dl> | |
| 250 <dl> | |
| 251 <dt>Return:</dt> | |
| 252 <dd> | |
| 253 list of supported target languages for the given original | |
| 254 </dd> | |
| 255 </dl> | |
| 256 <dl> | |
| 257 <dt>Return Type:</dt> | |
| 258 <dd> | |
| 259 list of str | |
| 260 </dd> | |
| 261 </dl> | |
| 262 <div align="right"><a href="#top">Up</a></div> | |
| 263 <hr /> | |
| 264 <hr /> | |
| 265 <a NAME="createEngine" ID="createEngine"></a> | |
| 266 <h2>createEngine</h2> | |
| 267 <b>createEngine</b>(<i>plugin, parent=None</i>) | |
| 268 | |
| 269 <p> | |
| 270 Function to instantiate a translator engine object. | |
| 271 </p> | |
| 272 <dl> | |
| 273 | |
| 274 <dt><i>plugin</i> (TranslatorPlugin)</dt> | |
| 275 <dd> | |
| 276 reference to the plugin object | |
| 277 </dd> | |
| 278 <dt><i>parent</i> (QObject (optional))</dt> | |
| 279 <dd> | |
| 280 reference to the parent object (defaults to None) | |
| 281 </dd> | |
| 282 </dl> | |
| 283 <dl> | |
| 284 <dt>Return:</dt> | |
| 285 <dd> | |
| 286 reference to the instantiated translator engine object | |
| 287 </dd> | |
| 288 </dl> | |
| 289 <dl> | |
| 290 <dt>Return Type:</dt> | |
| 291 <dd> | |
| 292 IbmWatsonEngine | |
| 293 </dd> | |
| 294 </dl> | |
| 295 <div align="right"><a href="#top">Up</a></div> | |
| 296 <hr /> | |
| 297 </body></html> |
