Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.DeepLEngine.html
src/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.DeepLEngine.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 9503
- ae9232bf4854
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.DeepLEngine</h1> | 9 <h1>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.DeepLEngine</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the DeepL translation engine. | 11 Module implementing the DeepL translation engine. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>None</td></tr> | 16 <tr><td>None</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | 20 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#DeepLEngine">DeepLEngine</a></td> | 22 <td><a href="#DeepLEngine">DeepLEngine</a></td> |
| 25 <td>Class implementing the translation engine for the DeepL translation service.</td> | 23 <td>Class implementing the translation engine for the DeepL translation service.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | 28 <table> |
| 30 <table> | |
| 31 | |
| 32 <tr> | 29 <tr> |
| 33 <td><a href="#createEngine">createEngine</a></td> | 30 <td><a href="#createEngine">createEngine</a></td> |
| 34 <td>Function to instantiate a translator engine object.</td> | 31 <td>Function to instantiate a translator engine object.</td> |
| 35 </tr> | 32 </tr> |
| 36 </table> | 33 </table> |
| 34 | |
| 37 <hr /> | 35 <hr /> |
| 38 <hr /> | 36 <hr /> |
| 39 <a NAME="DeepLEngine" ID="DeepLEngine"></a> | 37 <a NAME="DeepLEngine" ID="DeepLEngine"></a> |
| 40 <h2>DeepLEngine</h2> | 38 <h2>DeepLEngine</h2> |
| 41 | |
| 42 <p> | 39 <p> |
| 43 Class implementing the translation engine for the DeepL | 40 Class implementing the translation engine for the DeepL |
| 44 translation service. | 41 translation service. |
| 45 </p> | 42 </p> |
| 43 | |
| 46 <h3>Derived from</h3> | 44 <h3>Derived from</h3> |
| 47 TranslationEngine | 45 TranslationEngine |
| 48 <h3>Class Attributes</h3> | 46 <h3>Class Attributes</h3> |
| 49 | 47 <table> |
| 50 <table> | 48 <tr><td>MaxTranslationTextLen</td></tr> |
| 51 <tr><td>MaxTranslationTextLen</td></tr><tr><td>TranslatorUrls</td></tr> | 49 <tr><td>TranslatorUrls</td></tr> |
| 52 </table> | 50 </table> |
| 51 | |
| 53 <h3>Class Methods</h3> | 52 <h3>Class Methods</h3> |
| 54 | |
| 55 <table> | 53 <table> |
| 56 <tr><td>None</td></tr> | 54 <tr><td>None</td></tr> |
| 57 </table> | 55 </table> |
| 56 | |
| 58 <h3>Methods</h3> | 57 <h3>Methods</h3> |
| 59 | 58 <table> |
| 60 <table> | |
| 61 | |
| 62 <tr> | 59 <tr> |
| 63 <td><a href="#DeepLEngine.__init__">DeepLEngine</a></td> | 60 <td><a href="#DeepLEngine.__init__">DeepLEngine</a></td> |
| 64 <td>Constructor</td> | 61 <td>Constructor</td> |
| 65 </tr> | 62 </tr> |
| 66 <tr> | 63 <tr> |
| 74 <tr> | 71 <tr> |
| 75 <td><a href="#DeepLEngine.supportedLanguages">supportedLanguages</a></td> | 72 <td><a href="#DeepLEngine.supportedLanguages">supportedLanguages</a></td> |
| 76 <td>Public method to get the supported languages.</td> | 73 <td>Public method to get the supported languages.</td> |
| 77 </tr> | 74 </tr> |
| 78 </table> | 75 </table> |
| 76 | |
| 79 <h3>Static Methods</h3> | 77 <h3>Static Methods</h3> |
| 80 | |
| 81 <table> | 78 <table> |
| 82 <tr><td>None</td></tr> | 79 <tr><td>None</td></tr> |
| 83 </table> | 80 </table> |
| 81 | |
| 84 | 82 |
| 85 <a NAME="DeepLEngine.__init__" ID="DeepLEngine.__init__"></a> | 83 <a NAME="DeepLEngine.__init__" ID="DeepLEngine.__init__"></a> |
| 86 <h4>DeepLEngine (Constructor)</h4> | 84 <h4>DeepLEngine (Constructor)</h4> |
| 87 <b>DeepLEngine</b>(<i>plugin, parent=None</i>) | 85 <b>DeepLEngine</b>(<i>plugin, parent=None</i>) |
| 88 | |
| 89 <p> | 86 <p> |
| 90 Constructor | 87 Constructor |
| 91 </p> | 88 </p> |
| 89 | |
| 92 <dl> | 90 <dl> |
| 93 | 91 |
| 94 <dt><i>plugin</i> (TranslatorPlugin)</dt> | 92 <dt><i>plugin</i> (TranslatorPlugin)</dt> |
| 95 <dd> | 93 <dd> |
| 96 reference to the plugin object | 94 reference to the plugin object |
| 101 </dd> | 99 </dd> |
| 102 </dl> | 100 </dl> |
| 103 <a NAME="DeepLEngine.engineName" ID="DeepLEngine.engineName"></a> | 101 <a NAME="DeepLEngine.engineName" ID="DeepLEngine.engineName"></a> |
| 104 <h4>DeepLEngine.engineName</h4> | 102 <h4>DeepLEngine.engineName</h4> |
| 105 <b>engineName</b>(<i></i>) | 103 <b>engineName</b>(<i></i>) |
| 106 | |
| 107 <p> | 104 <p> |
| 108 Public method to return the name of the engine. | 105 Public method to return the name of the engine. |
| 109 </p> | 106 </p> |
| 107 | |
| 110 <dl> | 108 <dl> |
| 111 <dt>Return:</dt> | 109 <dt>Return:</dt> |
| 112 <dd> | 110 <dd> |
| 113 engine name | 111 engine name |
| 114 </dd> | 112 </dd> |
| 120 </dd> | 118 </dd> |
| 121 </dl> | 119 </dl> |
| 122 <a NAME="DeepLEngine.getTranslation" ID="DeepLEngine.getTranslation"></a> | 120 <a NAME="DeepLEngine.getTranslation" ID="DeepLEngine.getTranslation"></a> |
| 123 <h4>DeepLEngine.getTranslation</h4> | 121 <h4>DeepLEngine.getTranslation</h4> |
| 124 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>) | 122 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>) |
| 125 | |
| 126 <p> | 123 <p> |
| 127 Public method to translate the given text. | 124 Public method to translate the given text. |
| 128 </p> | 125 </p> |
| 126 | |
| 129 <dl> | 127 <dl> |
| 130 | 128 |
| 131 <dt><i>requestObject</i> (TranslatorRequest)</dt> | 129 <dt><i>requestObject</i> (TranslatorRequest)</dt> |
| 132 <dd> | 130 <dd> |
| 133 reference to the request object | 131 reference to the request object |
| 158 </dd> | 156 </dd> |
| 159 </dl> | 157 </dl> |
| 160 <a NAME="DeepLEngine.supportedLanguages" ID="DeepLEngine.supportedLanguages"></a> | 158 <a NAME="DeepLEngine.supportedLanguages" ID="DeepLEngine.supportedLanguages"></a> |
| 161 <h4>DeepLEngine.supportedLanguages</h4> | 159 <h4>DeepLEngine.supportedLanguages</h4> |
| 162 <b>supportedLanguages</b>(<i></i>) | 160 <b>supportedLanguages</b>(<i></i>) |
| 163 | |
| 164 <p> | 161 <p> |
| 165 Public method to get the supported languages. | 162 Public method to get the supported languages. |
| 166 </p> | 163 </p> |
| 164 | |
| 167 <dl> | 165 <dl> |
| 168 <dt>Return:</dt> | 166 <dt>Return:</dt> |
| 169 <dd> | 167 <dd> |
| 170 list of supported language codes | 168 list of supported language codes |
| 171 </dd> | 169 </dd> |
| 180 <hr /> | 178 <hr /> |
| 181 <hr /> | 179 <hr /> |
| 182 <a NAME="createEngine" ID="createEngine"></a> | 180 <a NAME="createEngine" ID="createEngine"></a> |
| 183 <h2>createEngine</h2> | 181 <h2>createEngine</h2> |
| 184 <b>createEngine</b>(<i>plugin, parent=None</i>) | 182 <b>createEngine</b>(<i>plugin, parent=None</i>) |
| 185 | |
| 186 <p> | 183 <p> |
| 187 Function to instantiate a translator engine object. | 184 Function to instantiate a translator engine object. |
| 188 </p> | 185 </p> |
| 186 | |
| 189 <dl> | 187 <dl> |
| 190 | 188 |
| 191 <dt><i>plugin</i> (TranslatorPlugin)</dt> | 189 <dt><i>plugin</i> (TranslatorPlugin)</dt> |
| 192 <dd> | 190 <dd> |
| 193 reference to the plugin object | 191 reference to the plugin object |
