Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.TranslationEngine.html
eric6/Documentation/Source/eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.TranslationEngine.html
- changeset 6942
- 2602857055c5
- parent 6412
- d71b094845e7
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.TranslationEngine</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.TranslationEngine</h1> | |
| 23 <p> | |
| 24 Module implementing the translation engine base class. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#TranslationEngine">TranslationEngine</a></td> | |
| 34 <td>Class implementing the translation engine base class containing default methods.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="TranslationEngine" ID="TranslationEngine"></a> | |
| 43 <h2>TranslationEngine</h2> | |
| 44 <p> | |
| 45 Class implementing the translation engine base class containing | |
| 46 default methods. | |
| 47 </p><h3>Signals</h3> | |
| 48 <dl> | |
| 49 <dt>availableTranslationsLoaded()</dt> | |
| 50 <dd> | |
| 51 emitted to indicate the availability | |
| 52 of the list of supported translation languages | |
| 53 </dd> | |
| 54 </dl> | |
| 55 <h3>Derived from</h3> | |
| 56 QObject | |
| 57 <h3>Class Attributes</h3> | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Class Methods</h3> | |
| 62 <table> | |
| 63 <tr><td>None</td></tr> | |
| 64 </table> | |
| 65 <h3>Methods</h3> | |
| 66 <table> | |
| 67 <tr> | |
| 68 <td><a href="#TranslationEngine.__init__">TranslationEngine</a></td> | |
| 69 <td>Constructor</td> | |
| 70 </tr><tr> | |
| 71 <td><a href="#TranslationEngine.engineName">engineName</a></td> | |
| 72 <td>Public method to get the name of the engine.</td> | |
| 73 </tr><tr> | |
| 74 <td><a href="#TranslationEngine.getTextToSpeechData">getTextToSpeechData</a></td> | |
| 75 <td>Public method to pronounce the given text.</td> | |
| 76 </tr><tr> | |
| 77 <td><a href="#TranslationEngine.getTranslation">getTranslation</a></td> | |
| 78 <td>Public method to translate the given text.</td> | |
| 79 </tr><tr> | |
| 80 <td><a href="#TranslationEngine.hasTTS">hasTTS</a></td> | |
| 81 <td>Public method indicating the Text-to-Speech capability.</td> | |
| 82 </tr><tr> | |
| 83 <td><a href="#TranslationEngine.supportedLanguages">supportedLanguages</a></td> | |
| 84 <td>Public method to get the supported languages.</td> | |
| 85 </tr><tr> | |
| 86 <td><a href="#TranslationEngine.supportedTargetLanguages">supportedTargetLanguages</a></td> | |
| 87 <td>Public method to get a list of supported target languages for an original language.</td> | |
| 88 </tr> | |
| 89 </table> | |
| 90 <h3>Static Methods</h3> | |
| 91 <table> | |
| 92 <tr><td>None</td></tr> | |
| 93 </table> | |
| 94 <a NAME="TranslationEngine.__init__" ID="TranslationEngine.__init__"></a> | |
| 95 <h4>TranslationEngine (Constructor)</h4> | |
| 96 <b>TranslationEngine</b>(<i>plugin, parent=None</i>) | |
| 97 <p> | |
| 98 Constructor | |
| 99 </p><dl> | |
| 100 <dt><i>plugin</i></dt> | |
| 101 <dd> | |
| 102 reference to the plugin object (TranslatorPlugin) | |
| 103 </dd><dt><i>parent</i></dt> | |
| 104 <dd> | |
| 105 reference to the parent object (QObject) | |
| 106 </dd> | |
| 107 </dl><a NAME="TranslationEngine.engineName" ID="TranslationEngine.engineName"></a> | |
| 108 <h4>TranslationEngine.engineName</h4> | |
| 109 <b>engineName</b>(<i></i>) | |
| 110 <p> | |
| 111 Public method to get the name of the engine. | |
| 112 </p><dl> | |
| 113 <dt>Returns:</dt> | |
| 114 <dd> | |
| 115 engine name (string) | |
| 116 </dd> | |
| 117 </dl><a NAME="TranslationEngine.getTextToSpeechData" ID="TranslationEngine.getTextToSpeechData"></a> | |
| 118 <h4>TranslationEngine.getTextToSpeechData</h4> | |
| 119 <b>getTextToSpeechData</b>(<i>requestObject, text, language</i>) | |
| 120 <p> | |
| 121 Public method to pronounce the given text. | |
| 122 </p><dl> | |
| 123 <dt><i>requestObject</i></dt> | |
| 124 <dd> | |
| 125 reference to the request object | |
| 126 (TranslatorRequest) | |
| 127 </dd><dt><i>text</i></dt> | |
| 128 <dd> | |
| 129 text to be pronounced (string) | |
| 130 </dd><dt><i>language</i></dt> | |
| 131 <dd> | |
| 132 language code of the text (string) | |
| 133 </dd> | |
| 134 </dl><dl> | |
| 135 <dt>Returns:</dt> | |
| 136 <dd> | |
| 137 tuple with pronounce data (QByteArray) or error string (string) | |
| 138 and success flag (boolean) | |
| 139 </dd> | |
| 140 </dl><a NAME="TranslationEngine.getTranslation" ID="TranslationEngine.getTranslation"></a> | |
| 141 <h4>TranslationEngine.getTranslation</h4> | |
| 142 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>) | |
| 143 <p> | |
| 144 Public method to translate the given text. | |
| 145 </p><dl> | |
| 146 <dt><i>requestObject</i></dt> | |
| 147 <dd> | |
| 148 reference to the request object | |
| 149 (TranslatorRequest) | |
| 150 </dd><dt><i>text</i></dt> | |
| 151 <dd> | |
| 152 text to be translated (string) | |
| 153 </dd><dt><i>originalLanguage</i></dt> | |
| 154 <dd> | |
| 155 language code of the original (string) | |
| 156 </dd><dt><i>translationLanguage</i></dt> | |
| 157 <dd> | |
| 158 language code of the translation (string) | |
| 159 </dd> | |
| 160 </dl><dl> | |
| 161 <dt>Returns:</dt> | |
| 162 <dd> | |
| 163 tuple of translated text (string) and flag indicating | |
| 164 success (boolean) | |
| 165 </dd> | |
| 166 </dl><a NAME="TranslationEngine.hasTTS" ID="TranslationEngine.hasTTS"></a> | |
| 167 <h4>TranslationEngine.hasTTS</h4> | |
| 168 <b>hasTTS</b>(<i></i>) | |
| 169 <p> | |
| 170 Public method indicating the Text-to-Speech capability. | |
| 171 </p><dl> | |
| 172 <dt>Returns:</dt> | |
| 173 <dd> | |
| 174 flag indicating the Text-to-Speech capability (boolean) | |
| 175 </dd> | |
| 176 </dl><a NAME="TranslationEngine.supportedLanguages" ID="TranslationEngine.supportedLanguages"></a> | |
| 177 <h4>TranslationEngine.supportedLanguages</h4> | |
| 178 <b>supportedLanguages</b>(<i></i>) | |
| 179 <p> | |
| 180 Public method to get the supported languages. | |
| 181 </p><dl> | |
| 182 <dt>Returns:</dt> | |
| 183 <dd> | |
| 184 list of supported language codes (list of string) | |
| 185 </dd> | |
| 186 </dl><a NAME="TranslationEngine.supportedTargetLanguages" ID="TranslationEngine.supportedTargetLanguages"></a> | |
| 187 <h4>TranslationEngine.supportedTargetLanguages</h4> | |
| 188 <b>supportedTargetLanguages</b>(<i>original</i>) | |
| 189 <p> | |
| 190 Public method to get a list of supported target languages for an | |
| 191 original language. | |
| 192 </p><p> | |
| 193 Note: The default implementation return the list of supported languages | |
| 194 (i.e. the same as those for the source) with the given original | |
| 195 removed. | |
| 196 </p><dl> | |
| 197 <dt><i>original</i> (str)</dt> | |
| 198 <dd> | |
| 199 original language | |
| 200 </dd> | |
| 201 </dl><dl> | |
| 202 <dt>Returns:</dt> | |
| 203 <dd> | |
| 204 list of supported target languages for the given original | |
| 205 </dd> | |
| 206 </dl><dl> | |
| 207 <dt>Return Type:</dt> | |
| 208 <dd> | |
| 209 list of str | |
| 210 </dd> | |
| 211 </dl> | |
| 212 <div align="right"><a href="#top">Up</a></div> | |
| 213 <hr /> | |
| 214 </body></html> |
