106 <p> |
106 <p> |
107 Constructor |
107 Constructor |
108 </p> |
108 </p> |
109 <dl> |
109 <dl> |
110 |
110 |
111 <dt><i>plugin</i></dt> |
111 <dt><i>plugin</i> (TranslatorPlugin)</dt> |
112 <dd> |
112 <dd> |
113 reference to the plugin object (TranslatorPlugin) |
113 reference to the plugin object |
114 </dd> |
114 </dd> |
115 <dt><i>parent</i></dt> |
115 <dt><i>parent</i> (QObject)</dt> |
116 <dd> |
116 <dd> |
117 reference to the parent object (QObject) |
117 reference to the parent object |
118 </dd> |
118 </dd> |
119 </dl> |
119 </dl> |
120 <a NAME="TranslationEngine.engineName" ID="TranslationEngine.engineName"></a> |
120 <a NAME="TranslationEngine.engineName" ID="TranslationEngine.engineName"></a> |
121 <h4>TranslationEngine.engineName</h4> |
121 <h4>TranslationEngine.engineName</h4> |
122 <b>engineName</b>(<i></i>) |
122 <b>engineName</b>(<i></i>) |
125 Public method to get the name of the engine. |
125 Public method to get the name of the engine. |
126 </p> |
126 </p> |
127 <dl> |
127 <dl> |
128 <dt>Return:</dt> |
128 <dt>Return:</dt> |
129 <dd> |
129 <dd> |
130 engine name (string) |
130 engine name |
|
131 </dd> |
|
132 </dl> |
|
133 <dl> |
|
134 <dt>Return Type:</dt> |
|
135 <dd> |
|
136 str |
131 </dd> |
137 </dd> |
132 </dl> |
138 </dl> |
133 <a NAME="TranslationEngine.getTextToSpeechData" ID="TranslationEngine.getTextToSpeechData"></a> |
139 <a NAME="TranslationEngine.getTextToSpeechData" ID="TranslationEngine.getTextToSpeechData"></a> |
134 <h4>TranslationEngine.getTextToSpeechData</h4> |
140 <h4>TranslationEngine.getTextToSpeechData</h4> |
135 <b>getTextToSpeechData</b>(<i>requestObject, text, language</i>) |
141 <b>getTextToSpeechData</b>(<i>requestObject, text, language</i>) |
137 <p> |
143 <p> |
138 Public method to pronounce the given text. |
144 Public method to pronounce the given text. |
139 </p> |
145 </p> |
140 <dl> |
146 <dl> |
141 |
147 |
142 <dt><i>requestObject</i></dt> |
148 <dt><i>requestObject</i> (TranslatorRequest)</dt> |
143 <dd> |
149 <dd> |
144 reference to the request object |
150 reference to the request object |
145 (TranslatorRequest) |
151 </dd> |
146 </dd> |
152 <dt><i>text</i> (str)</dt> |
147 <dt><i>text</i></dt> |
153 <dd> |
148 <dd> |
154 text to be pronounced |
149 text to be pronounced (string) |
155 </dd> |
150 </dd> |
156 <dt><i>language</i> (str)</dt> |
151 <dt><i>language</i></dt> |
157 <dd> |
152 <dd> |
158 language code of the text |
153 language code of the text (string) |
159 </dd> |
154 </dd> |
160 </dl> |
155 </dl> |
161 <dl> |
156 <dl> |
162 <dt>Return:</dt> |
157 <dt>Return:</dt> |
163 <dd> |
158 <dd> |
164 tuple with pronounce data or an error string and a success flag |
159 tuple with pronounce data (QByteArray) or error string (string) |
165 </dd> |
160 and success flag (boolean) |
166 </dl> |
|
167 <dl> |
|
168 <dt>Return Type:</dt> |
|
169 <dd> |
|
170 tuple of (QByteArray or str, bool) |
161 </dd> |
171 </dd> |
162 </dl> |
172 </dl> |
163 <a NAME="TranslationEngine.getTranslation" ID="TranslationEngine.getTranslation"></a> |
173 <a NAME="TranslationEngine.getTranslation" ID="TranslationEngine.getTranslation"></a> |
164 <h4>TranslationEngine.getTranslation</h4> |
174 <h4>TranslationEngine.getTranslation</h4> |
165 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>) |
175 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>) |
167 <p> |
177 <p> |
168 Public method to translate the given text. |
178 Public method to translate the given text. |
169 </p> |
179 </p> |
170 <dl> |
180 <dl> |
171 |
181 |
172 <dt><i>requestObject</i></dt> |
182 <dt><i>requestObject</i> (TranslatorRequest)</dt> |
173 <dd> |
183 <dd> |
174 reference to the request object |
184 reference to the request object |
175 (TranslatorRequest) |
185 </dd> |
176 </dd> |
186 <dt><i>text</i> (str)</dt> |
177 <dt><i>text</i></dt> |
187 <dd> |
178 <dd> |
188 text to be translated |
179 text to be translated (string) |
189 </dd> |
180 </dd> |
190 <dt><i>originalLanguage</i> (str)</dt> |
181 <dt><i>originalLanguage</i></dt> |
191 <dd> |
182 <dd> |
192 language code of the original |
183 language code of the original (string) |
193 </dd> |
184 </dd> |
194 <dt><i>translationLanguage</i> (str)</dt> |
185 <dt><i>translationLanguage</i></dt> |
195 <dd> |
186 <dd> |
196 language code of the translation |
187 language code of the translation (string) |
197 </dd> |
188 </dd> |
198 </dl> |
189 </dl> |
199 <dl> |
190 <dl> |
200 <dt>Return:</dt> |
191 <dt>Return:</dt> |
201 <dd> |
192 <dd> |
202 tuple of translated text and flag indicating success |
193 tuple of translated text (string) and flag indicating |
203 </dd> |
194 success (boolean) |
204 </dl> |
|
205 <dl> |
|
206 <dt>Return Type:</dt> |
|
207 <dd> |
|
208 tuple of (str, bool) |
195 </dd> |
209 </dd> |
196 </dl> |
210 </dl> |
197 <a NAME="TranslationEngine.hasTTS" ID="TranslationEngine.hasTTS"></a> |
211 <a NAME="TranslationEngine.hasTTS" ID="TranslationEngine.hasTTS"></a> |
198 <h4>TranslationEngine.hasTTS</h4> |
212 <h4>TranslationEngine.hasTTS</h4> |
199 <b>hasTTS</b>(<i></i>) |
213 <b>hasTTS</b>(<i></i>) |
202 Public method indicating the Text-to-Speech capability. |
216 Public method indicating the Text-to-Speech capability. |
203 </p> |
217 </p> |
204 <dl> |
218 <dl> |
205 <dt>Return:</dt> |
219 <dt>Return:</dt> |
206 <dd> |
220 <dd> |
207 flag indicating the Text-to-Speech capability (boolean) |
221 flag indicating the Text-to-Speech capability |
|
222 </dd> |
|
223 </dl> |
|
224 <dl> |
|
225 <dt>Return Type:</dt> |
|
226 <dd> |
|
227 bool |
208 </dd> |
228 </dd> |
209 </dl> |
229 </dl> |
210 <a NAME="TranslationEngine.supportedLanguages" ID="TranslationEngine.supportedLanguages"></a> |
230 <a NAME="TranslationEngine.supportedLanguages" ID="TranslationEngine.supportedLanguages"></a> |
211 <h4>TranslationEngine.supportedLanguages</h4> |
231 <h4>TranslationEngine.supportedLanguages</h4> |
212 <b>supportedLanguages</b>(<i></i>) |
232 <b>supportedLanguages</b>(<i></i>) |
215 Public method to get the supported languages. |
235 Public method to get the supported languages. |
216 </p> |
236 </p> |
217 <dl> |
237 <dl> |
218 <dt>Return:</dt> |
238 <dt>Return:</dt> |
219 <dd> |
239 <dd> |
220 list of supported language codes (list of string) |
240 list of supported language codes |
|
241 </dd> |
|
242 </dl> |
|
243 <dl> |
|
244 <dt>Return Type:</dt> |
|
245 <dd> |
|
246 list of str |
221 </dd> |
247 </dd> |
222 </dl> |
248 </dl> |
223 <a NAME="TranslationEngine.supportedTargetLanguages" ID="TranslationEngine.supportedTargetLanguages"></a> |
249 <a NAME="TranslationEngine.supportedTargetLanguages" ID="TranslationEngine.supportedTargetLanguages"></a> |
224 <h4>TranslationEngine.supportedTargetLanguages</h4> |
250 <h4>TranslationEngine.supportedTargetLanguages</h4> |
225 <b>supportedTargetLanguages</b>(<i>original</i>) |
251 <b>supportedTargetLanguages</b>(<i>original</i>) |