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

Mercurial Repository: eric

eric ide

mercurial