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 9209
- b99e7fd55fd3
- parent 9148
- b31f0d894b55
- child 10070
- 9f5758c0fec1
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.TranslationEngine</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.TranslationEngine</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the translation engine base class. | |
| 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="#TranslationEngine">TranslationEngine</a></td> | |
| 25 <td>Class implementing the translation engine base class containing default methods.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="TranslationEngine" ID="TranslationEngine"></a> | |
| 36 <h2>TranslationEngine</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the translation engine base class containing | |
| 40 default methods. | |
| 41 </p> | |
| 42 <h3>Signals</h3> | |
| 43 <dl> | |
| 44 | |
| 45 <dt>availableTranslationsLoaded()</dt> | |
| 46 <dd> | |
| 47 emitted to indicate the availability | |
| 48 of the list of supported translation languages | |
| 49 </dd> | |
| 50 </dl> | |
| 51 <h3>Derived from</h3> | |
| 52 QObject | |
| 53 <h3>Class Attributes</h3> | |
| 54 | |
| 55 <table> | |
| 56 <tr><td>None</td></tr> | |
| 57 </table> | |
| 58 <h3>Class Methods</h3> | |
| 59 | |
| 60 <table> | |
| 61 <tr><td>None</td></tr> | |
| 62 </table> | |
| 63 <h3>Methods</h3> | |
| 64 | |
| 65 <table> | |
| 66 | |
| 67 <tr> | |
| 68 <td><a href="#TranslationEngine.__init__">TranslationEngine</a></td> | |
| 69 <td>Constructor</td> | |
| 70 </tr> | |
| 71 <tr> | |
| 72 <td><a href="#TranslationEngine.engineName">engineName</a></td> | |
| 73 <td>Public method to get the name of the engine.</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#TranslationEngine.getTextToSpeechData">getTextToSpeechData</a></td> | |
| 77 <td>Public method to pronounce the given text.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#TranslationEngine.getTranslation">getTranslation</a></td> | |
| 81 <td>Public method to translate the given text.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#TranslationEngine.hasTTS">hasTTS</a></td> | |
| 85 <td>Public method indicating the Text-to-Speech capability.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#TranslationEngine.supportedLanguages">supportedLanguages</a></td> | |
| 89 <td>Public method to get the supported languages.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <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> | |
| 94 </tr> | |
| 95 </table> | |
| 96 <h3>Static Methods</h3> | |
| 97 | |
| 98 <table> | |
| 99 <tr><td>None</td></tr> | |
| 100 </table> | |
| 101 | |
| 102 <a NAME="TranslationEngine.__init__" ID="TranslationEngine.__init__"></a> | |
| 103 <h4>TranslationEngine (Constructor)</h4> | |
| 104 <b>TranslationEngine</b>(<i>plugin, parent=None</i>) | |
| 105 | |
| 106 <p> | |
| 107 Constructor | |
| 108 </p> | |
| 109 <dl> | |
| 110 | |
| 111 <dt><i>plugin</i> (TranslatorPlugin)</dt> | |
| 112 <dd> | |
| 113 reference to the plugin object | |
| 114 </dd> | |
| 115 <dt><i>parent</i> (QObject)</dt> | |
| 116 <dd> | |
| 117 reference to the parent object | |
| 118 </dd> | |
| 119 </dl> | |
| 120 <a NAME="TranslationEngine.engineName" ID="TranslationEngine.engineName"></a> | |
| 121 <h4>TranslationEngine.engineName</h4> | |
| 122 <b>engineName</b>(<i></i>) | |
| 123 | |
| 124 <p> | |
| 125 Public method to get the name of the engine. | |
| 126 </p> | |
| 127 <dl> | |
| 128 <dt>Return:</dt> | |
| 129 <dd> | |
| 130 engine name | |
| 131 </dd> | |
| 132 </dl> | |
| 133 <dl> | |
| 134 <dt>Return Type:</dt> | |
| 135 <dd> | |
| 136 str | |
| 137 </dd> | |
| 138 </dl> | |
| 139 <a NAME="TranslationEngine.getTextToSpeechData" ID="TranslationEngine.getTextToSpeechData"></a> | |
| 140 <h4>TranslationEngine.getTextToSpeechData</h4> | |
| 141 <b>getTextToSpeechData</b>(<i>requestObject, text, language</i>) | |
| 142 | |
| 143 <p> | |
| 144 Public method to pronounce the given text. | |
| 145 </p> | |
| 146 <dl> | |
| 147 | |
| 148 <dt><i>requestObject</i> (TranslatorRequest)</dt> | |
| 149 <dd> | |
| 150 reference to the request object | |
| 151 </dd> | |
| 152 <dt><i>text</i> (str)</dt> | |
| 153 <dd> | |
| 154 text to be pronounced | |
| 155 </dd> | |
| 156 <dt><i>language</i> (str)</dt> | |
| 157 <dd> | |
| 158 language code of the text | |
| 159 </dd> | |
| 160 </dl> | |
| 161 <dl> | |
| 162 <dt>Return:</dt> | |
| 163 <dd> | |
| 164 tuple with pronounce data or an error string and a success flag | |
| 165 </dd> | |
| 166 </dl> | |
| 167 <dl> | |
| 168 <dt>Return Type:</dt> | |
| 169 <dd> | |
| 170 tuple of (QByteArray or str, bool) | |
| 171 </dd> | |
| 172 </dl> | |
| 173 <a NAME="TranslationEngine.getTranslation" ID="TranslationEngine.getTranslation"></a> | |
| 174 <h4>TranslationEngine.getTranslation</h4> | |
| 175 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>) | |
| 176 | |
| 177 <p> | |
| 178 Public method to translate the given text. | |
| 179 </p> | |
| 180 <dl> | |
| 181 | |
| 182 <dt><i>requestObject</i> (TranslatorRequest)</dt> | |
| 183 <dd> | |
| 184 reference to the request object | |
| 185 </dd> | |
| 186 <dt><i>text</i> (str)</dt> | |
| 187 <dd> | |
| 188 text to be translated | |
| 189 </dd> | |
| 190 <dt><i>originalLanguage</i> (str)</dt> | |
| 191 <dd> | |
| 192 language code of the original | |
| 193 </dd> | |
| 194 <dt><i>translationLanguage</i> (str)</dt> | |
| 195 <dd> | |
| 196 language code of the translation | |
| 197 </dd> | |
| 198 </dl> | |
| 199 <dl> | |
| 200 <dt>Return:</dt> | |
| 201 <dd> | |
| 202 tuple of translated text and flag indicating success | |
| 203 </dd> | |
| 204 </dl> | |
| 205 <dl> | |
| 206 <dt>Return Type:</dt> | |
| 207 <dd> | |
| 208 tuple of (str, bool) | |
| 209 </dd> | |
| 210 </dl> | |
| 211 <a NAME="TranslationEngine.hasTTS" ID="TranslationEngine.hasTTS"></a> | |
| 212 <h4>TranslationEngine.hasTTS</h4> | |
| 213 <b>hasTTS</b>(<i></i>) | |
| 214 | |
| 215 <p> | |
| 216 Public method indicating the Text-to-Speech capability. | |
| 217 </p> | |
| 218 <dl> | |
| 219 <dt>Return:</dt> | |
| 220 <dd> | |
| 221 flag indicating the Text-to-Speech capability | |
| 222 </dd> | |
| 223 </dl> | |
| 224 <dl> | |
| 225 <dt>Return Type:</dt> | |
| 226 <dd> | |
| 227 bool | |
| 228 </dd> | |
| 229 </dl> | |
| 230 <a NAME="TranslationEngine.supportedLanguages" ID="TranslationEngine.supportedLanguages"></a> | |
| 231 <h4>TranslationEngine.supportedLanguages</h4> | |
| 232 <b>supportedLanguages</b>(<i></i>) | |
| 233 | |
| 234 <p> | |
| 235 Public method to get the supported languages. | |
| 236 </p> | |
| 237 <dl> | |
| 238 <dt>Return:</dt> | |
| 239 <dd> | |
| 240 list of supported language codes | |
| 241 </dd> | |
| 242 </dl> | |
| 243 <dl> | |
| 244 <dt>Return Type:</dt> | |
| 245 <dd> | |
| 246 list of str | |
| 247 </dd> | |
| 248 </dl> | |
| 249 <a NAME="TranslationEngine.supportedTargetLanguages" ID="TranslationEngine.supportedTargetLanguages"></a> | |
| 250 <h4>TranslationEngine.supportedTargetLanguages</h4> | |
| 251 <b>supportedTargetLanguages</b>(<i>original</i>) | |
| 252 | |
| 253 <p> | |
| 254 Public method to get a list of supported target languages for an | |
| 255 original language. | |
| 256 </p> | |
| 257 <p> | |
| 258 Note: The default implementation return the list of supported languages | |
| 259 (i.e. the same as those for the source) with the given original | |
| 260 removed. | |
| 261 </p> | |
| 262 <dl> | |
| 263 | |
| 264 <dt><i>original</i> (str)</dt> | |
| 265 <dd> | |
| 266 original language | |
| 267 </dd> | |
| 268 </dl> | |
| 269 <dl> | |
| 270 <dt>Return:</dt> | |
| 271 <dd> | |
| 272 list of supported target languages for the given original | |
| 273 </dd> | |
| 274 </dl> | |
| 275 <dl> | |
| 276 <dt>Return Type:</dt> | |
| 277 <dd> | |
| 278 list of str | |
| 279 </dd> | |
| 280 </dl> | |
| 281 <div align="right"><a href="#top">Up</a></div> | |
| 282 <hr /> | |
| 283 </body></html> |
