src/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.LibreTranslateEngine.html

branch
eric7
changeset 10479
856476537696
parent 9956
5b138f996a1e
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.LibreTranslateEngine</h1> 9 <h1>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.LibreTranslateEngine</h1>
10
11 <p> 10 <p>
12 Module implementing the LibreTranslate translation engine. 11 Module implementing the LibreTranslate translation engine.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#LibreTranslateEngine">LibreTranslateEngine</a></td> 22 <td><a href="#LibreTranslateEngine">LibreTranslateEngine</a></td>
25 <td>Class implementing the translation engine for the LibreTranslate service.</td> 23 <td>Class implementing the translation engine for the LibreTranslate 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="LibreTranslateEngine" ID="LibreTranslateEngine"></a> 37 <a NAME="LibreTranslateEngine" ID="LibreTranslateEngine"></a>
40 <h2>LibreTranslateEngine</h2> 38 <h2>LibreTranslateEngine</h2>
41
42 <p> 39 <p>
43 Class implementing the translation engine for the LibreTranslate service. 40 Class implementing the translation engine for the LibreTranslate service.
44 </p> 41 </p>
42
45 <h3>Derived from</h3> 43 <h3>Derived from</h3>
46 TranslationEngine 44 TranslationEngine
47 <h3>Class Attributes</h3> 45 <h3>Class Attributes</h3>
48 46 <table>
49 <table> 47 <tr><td>None</td></tr>
50 <tr><td>None</td></tr> 48 </table>
51 </table> 49
52 <h3>Class Methods</h3> 50 <h3>Class Methods</h3>
53 51 <table>
54 <table> 52 <tr><td>None</td></tr>
55 <tr><td>None</td></tr> 53 </table>
56 </table> 54
57 <h3>Methods</h3> 55 <h3>Methods</h3>
58 56 <table>
59 <table>
60
61 <tr> 57 <tr>
62 <td><a href="#LibreTranslateEngine.__init__">LibreTranslateEngine</a></td> 58 <td><a href="#LibreTranslateEngine.__init__">LibreTranslateEngine</a></td>
63 <td>Constructor</td> 59 <td>Constructor</td>
64 </tr> 60 </tr>
65 <tr> 61 <tr>
89 <tr> 85 <tr>
90 <td><a href="#LibreTranslateEngine.supportedTargetLanguages">supportedTargetLanguages</a></td> 86 <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> 87 <td>Public method to get a list of supported target languages for an original language.</td>
92 </tr> 88 </tr>
93 </table> 89 </table>
90
94 <h3>Static Methods</h3> 91 <h3>Static Methods</h3>
95 92 <table>
96 <table> 93 <tr><td>None</td></tr>
97 <tr><td>None</td></tr> 94 </table>
98 </table> 95
99 96
100 <a NAME="LibreTranslateEngine.__init__" ID="LibreTranslateEngine.__init__"></a> 97 <a NAME="LibreTranslateEngine.__init__" ID="LibreTranslateEngine.__init__"></a>
101 <h4>LibreTranslateEngine (Constructor)</h4> 98 <h4>LibreTranslateEngine (Constructor)</h4>
102 <b>LibreTranslateEngine</b>(<i>plugin, parent=None</i>) 99 <b>LibreTranslateEngine</b>(<i>plugin, parent=None</i>)
103
104 <p> 100 <p>
105 Constructor 101 Constructor
106 </p> 102 </p>
103
107 <dl> 104 <dl>
108 105
109 <dt><i>plugin</i> (TranslatorPlugin)</dt> 106 <dt><i>plugin</i> (TranslatorPlugin)</dt>
110 <dd> 107 <dd>
111 reference to the plugin object 108 reference to the plugin object
116 </dd> 113 </dd>
117 </dl> 114 </dl>
118 <a NAME="LibreTranslateEngine.__getTranslationModels" ID="LibreTranslateEngine.__getTranslationModels"></a> 115 <a NAME="LibreTranslateEngine.__getTranslationModels" ID="LibreTranslateEngine.__getTranslationModels"></a>
119 <h4>LibreTranslateEngine.__getTranslationModels</h4> 116 <h4>LibreTranslateEngine.__getTranslationModels</h4>
120 <b>__getTranslationModels</b>(<i></i>) 117 <b>__getTranslationModels</b>(<i></i>)
121
122 <p> 118 <p>
123 Private method to get the translation models supported by IBM Watson 119 Private method to get the translation models supported by IBM Watson
124 Language Translator. 120 Language Translator.
125 </p> 121 </p>
122
126 <a NAME="LibreTranslateEngine.__getTranslationModelsReplyFinished" ID="LibreTranslateEngine.__getTranslationModelsReplyFinished"></a> 123 <a NAME="LibreTranslateEngine.__getTranslationModelsReplyFinished" ID="LibreTranslateEngine.__getTranslationModelsReplyFinished"></a>
127 <h4>LibreTranslateEngine.__getTranslationModelsReplyFinished</h4> 124 <h4>LibreTranslateEngine.__getTranslationModelsReplyFinished</h4>
128 <b>__getTranslationModelsReplyFinished</b>(<i>reply</i>) 125 <b>__getTranslationModelsReplyFinished</b>(<i>reply</i>)
129
130 <p> 126 <p>
131 Private slot handling the receipt of the available translations. 127 Private slot handling the receipt of the available translations.
132 </p> 128 </p>
129
133 <dl> 130 <dl>
134 131
135 <dt><i>reply</i> (QNetworkReply)</dt> 132 <dt><i>reply</i> (QNetworkReply)</dt>
136 <dd> 133 <dd>
137 reference to the network reply object 134 reference to the network reply object
138 </dd> 135 </dd>
139 </dl> 136 </dl>
140 <a NAME="LibreTranslateEngine.engineName" ID="LibreTranslateEngine.engineName"></a> 137 <a NAME="LibreTranslateEngine.engineName" ID="LibreTranslateEngine.engineName"></a>
141 <h4>LibreTranslateEngine.engineName</h4> 138 <h4>LibreTranslateEngine.engineName</h4>
142 <b>engineName</b>(<i></i>) 139 <b>engineName</b>(<i></i>)
143
144 <p> 140 <p>
145 Public method to return the name of the engine. 141 Public method to return the name of the engine.
146 </p> 142 </p>
143
147 <dl> 144 <dl>
148 <dt>Return:</dt> 145 <dt>Return:</dt>
149 <dd> 146 <dd>
150 engine name 147 engine name
151 </dd> 148 </dd>
157 </dd> 154 </dd>
158 </dl> 155 </dl>
159 <a NAME="LibreTranslateEngine.getTranslation" ID="LibreTranslateEngine.getTranslation"></a> 156 <a NAME="LibreTranslateEngine.getTranslation" ID="LibreTranslateEngine.getTranslation"></a>
160 <h4>LibreTranslateEngine.getTranslation</h4> 157 <h4>LibreTranslateEngine.getTranslation</h4>
161 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>) 158 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>)
162
163 <p> 159 <p>
164 Public method to translate the given text. 160 Public method to translate the given text.
165 </p> 161 </p>
162
166 <dl> 163 <dl>
167 164
168 <dt><i>requestObject</i> (TranslatorRequest)</dt> 165 <dt><i>requestObject</i> (TranslatorRequest)</dt>
169 <dd> 166 <dd>
170 reference to the request object 167 reference to the request object
195 </dd> 192 </dd>
196 </dl> 193 </dl>
197 <a NAME="LibreTranslateEngine.hasTTS" ID="LibreTranslateEngine.hasTTS"></a> 194 <a NAME="LibreTranslateEngine.hasTTS" ID="LibreTranslateEngine.hasTTS"></a>
198 <h4>LibreTranslateEngine.hasTTS</h4> 195 <h4>LibreTranslateEngine.hasTTS</h4>
199 <b>hasTTS</b>(<i></i>) 196 <b>hasTTS</b>(<i></i>)
200
201 <p> 197 <p>
202 Public method indicating the Text-to-Speech capability. 198 Public method indicating the Text-to-Speech capability.
203 </p> 199 </p>
200
204 <dl> 201 <dl>
205 <dt>Return:</dt> 202 <dt>Return:</dt>
206 <dd> 203 <dd>
207 flag indicating the Text-to-Speech capability 204 flag indicating the Text-to-Speech capability
208 </dd> 205 </dd>
214 </dd> 211 </dd>
215 </dl> 212 </dl>
216 <a NAME="LibreTranslateEngine.supportedLanguages" ID="LibreTranslateEngine.supportedLanguages"></a> 213 <a NAME="LibreTranslateEngine.supportedLanguages" ID="LibreTranslateEngine.supportedLanguages"></a>
217 <h4>LibreTranslateEngine.supportedLanguages</h4> 214 <h4>LibreTranslateEngine.supportedLanguages</h4>
218 <b>supportedLanguages</b>(<i></i>) 215 <b>supportedLanguages</b>(<i></i>)
219
220 <p> 216 <p>
221 Public method to get the supported languages. 217 Public method to get the supported languages.
222 </p> 218 </p>
219
223 <dl> 220 <dl>
224 <dt>Return:</dt> 221 <dt>Return:</dt>
225 <dd> 222 <dd>
226 list of supported language codes 223 list of supported language codes
227 </dd> 224 </dd>
233 </dd> 230 </dd>
234 </dl> 231 </dl>
235 <a NAME="LibreTranslateEngine.supportedTargetLanguages" ID="LibreTranslateEngine.supportedTargetLanguages"></a> 232 <a NAME="LibreTranslateEngine.supportedTargetLanguages" ID="LibreTranslateEngine.supportedTargetLanguages"></a>
236 <h4>LibreTranslateEngine.supportedTargetLanguages</h4> 233 <h4>LibreTranslateEngine.supportedTargetLanguages</h4>
237 <b>supportedTargetLanguages</b>(<i>original</i>) 234 <b>supportedTargetLanguages</b>(<i>original</i>)
238
239 <p> 235 <p>
240 Public method to get a list of supported target languages for an 236 Public method to get a list of supported target languages for an
241 original language. 237 original language.
242 </p> 238 </p>
239
243 <dl> 240 <dl>
244 241
245 <dt><i>original</i> (str)</dt> 242 <dt><i>original</i> (str)</dt>
246 <dd> 243 <dd>
247 original language 244 original language
263 <hr /> 260 <hr />
264 <hr /> 261 <hr />
265 <a NAME="createEngine" ID="createEngine"></a> 262 <a NAME="createEngine" ID="createEngine"></a>
266 <h2>createEngine</h2> 263 <h2>createEngine</h2>
267 <b>createEngine</b>(<i>plugin, parent=None</i>) 264 <b>createEngine</b>(<i>plugin, parent=None</i>)
268
269 <p> 265 <p>
270 Function to instantiate a translator engine object. 266 Function to instantiate a translator engine object.
271 </p> 267 </p>
268
272 <dl> 269 <dl>
273 270
274 <dt><i>plugin</i> (TranslatorPlugin)</dt> 271 <dt><i>plugin</i> (TranslatorPlugin)</dt>
275 <dd> 272 <dd>
276 reference to the plugin object 273 reference to the plugin object

eric ide

mercurial