Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.PromtEngine.html
eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.PromtEngine.html
- branch
- eric7
- changeset 9148
- b31f0d894b55
- parent 9147
- bbf3af40c223
- child 9149
- 1810eaf18d3f
equal
deleted
inserted
replaced
| 9147:bbf3af40c223 | 9148:b31f0d894b55 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.PromtEngine</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.PromtEngine</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the Promt 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="#PromtEngine">PromtEngine</a></td> | |
| 25 <td>Class implementing the translation engine for the Promt translation service.</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="PromtEngine" ID="PromtEngine"></a> | |
| 36 <h2>PromtEngine</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the translation engine for the Promt | |
| 40 translation service. | |
| 41 </p> | |
| 42 <h3>Derived from</h3> | |
| 43 TranslationEngine | |
| 44 <h3>Class Attributes</h3> | |
| 45 | |
| 46 <table> | |
| 47 <tr><td>TranslatorUrl</td></tr> | |
| 48 </table> | |
| 49 <h3>Class Methods</h3> | |
| 50 | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 | |
| 56 <table> | |
| 57 | |
| 58 <tr> | |
| 59 <td><a href="#PromtEngine.__init__">PromtEngine</a></td> | |
| 60 <td>Constructor</td> | |
| 61 </tr> | |
| 62 <tr> | |
| 63 <td><a href="#PromtEngine.engineName">engineName</a></td> | |
| 64 <td>Public method to return the name of the engine.</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#PromtEngine.getTranslation">getTranslation</a></td> | |
| 68 <td>Public method to translate the given text.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#PromtEngine.supportedLanguages">supportedLanguages</a></td> | |
| 72 <td>Public method to get the supported languages.</td> | |
| 73 </tr> | |
| 74 </table> | |
| 75 <h3>Static Methods</h3> | |
| 76 | |
| 77 <table> | |
| 78 <tr><td>None</td></tr> | |
| 79 </table> | |
| 80 | |
| 81 <a NAME="PromtEngine.__init__" ID="PromtEngine.__init__"></a> | |
| 82 <h4>PromtEngine (Constructor)</h4> | |
| 83 <b>PromtEngine</b>(<i>plugin, parent=None</i>) | |
| 84 | |
| 85 <p> | |
| 86 Constructor | |
| 87 </p> | |
| 88 <dl> | |
| 89 | |
| 90 <dt><i>plugin</i></dt> | |
| 91 <dd> | |
| 92 reference to the plugin object (TranslatorPlugin) | |
| 93 </dd> | |
| 94 <dt><i>parent</i></dt> | |
| 95 <dd> | |
| 96 reference to the parent object (QObject) | |
| 97 </dd> | |
| 98 </dl> | |
| 99 <a NAME="PromtEngine.engineName" ID="PromtEngine.engineName"></a> | |
| 100 <h4>PromtEngine.engineName</h4> | |
| 101 <b>engineName</b>(<i></i>) | |
| 102 | |
| 103 <p> | |
| 104 Public method to return the name of the engine. | |
| 105 </p> | |
| 106 <dl> | |
| 107 <dt>Return:</dt> | |
| 108 <dd> | |
| 109 engine name (string) | |
| 110 </dd> | |
| 111 </dl> | |
| 112 <a NAME="PromtEngine.getTranslation" ID="PromtEngine.getTranslation"></a> | |
| 113 <h4>PromtEngine.getTranslation</h4> | |
| 114 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>) | |
| 115 | |
| 116 <p> | |
| 117 Public method to translate the given text. | |
| 118 </p> | |
| 119 <dl> | |
| 120 | |
| 121 <dt><i>requestObject</i></dt> | |
| 122 <dd> | |
| 123 reference to the request object | |
| 124 (TranslatorRequest) | |
| 125 </dd> | |
| 126 <dt><i>text</i></dt> | |
| 127 <dd> | |
| 128 text to be translated (string) | |
| 129 </dd> | |
| 130 <dt><i>originalLanguage</i></dt> | |
| 131 <dd> | |
| 132 language code of the original (string) | |
| 133 </dd> | |
| 134 <dt><i>translationLanguage</i></dt> | |
| 135 <dd> | |
| 136 language code of the translation (string) | |
| 137 </dd> | |
| 138 </dl> | |
| 139 <dl> | |
| 140 <dt>Return:</dt> | |
| 141 <dd> | |
| 142 tuple of translated text (string) and flag indicating | |
| 143 success (boolean) | |
| 144 </dd> | |
| 145 </dl> | |
| 146 <a NAME="PromtEngine.supportedLanguages" ID="PromtEngine.supportedLanguages"></a> | |
| 147 <h4>PromtEngine.supportedLanguages</h4> | |
| 148 <b>supportedLanguages</b>(<i></i>) | |
| 149 | |
| 150 <p> | |
| 151 Public method to get the supported languages. | |
| 152 </p> | |
| 153 <dl> | |
| 154 <dt>Return:</dt> | |
| 155 <dd> | |
| 156 list of supported language codes (list of string) | |
| 157 </dd> | |
| 158 </dl> | |
| 159 <div align="right"><a href="#top">Up</a></div> | |
| 160 <hr /> | |
| 161 </body></html> |
