Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.Helpviewer.OpenSearch.OpenSearchEngine.html

Documentation/Source/eric4.Helpviewer.OpenSearch.OpenSearchEngine.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Helpviewer.OpenSearch.OpenSearchEngine</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Helpviewer.OpenSearch.OpenSearchEngine</h1>
24 <p>
25 Module implementing the open search engine.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#OpenSearchEngine">OpenSearchEngine</a></td>
35 <td>Class implementing the open search engine.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="OpenSearchEngine" ID="OpenSearchEngine"></a>
44 <h2>OpenSearchEngine</h2>
45 <p>
46 Class implementing the open search engine.
47 </p><h4>Signals</h4>
48 <dl>
49 <dt>imageChanged()</dt>
50 <dd>
51 emitted after the icon has been changed
52 </dd><dt>suggestions(const QStringList&)</dt>
53 <dd>
54 emitted after the suggestions have
55 been received
56 </dd>
57 </dl>
58 <h3>Derived from</h3>
59 QObject
60 <h3>Class Attributes</h3>
61 <table>
62 <tr><td>_language</td></tr><tr><td>loc</td></tr>
63 </table>
64 <h3>Methods</h3>
65 <table>
66 <tr>
67 <td><a href="#OpenSearchEngine.__init__">OpenSearchEngine</a></td>
68 <td>Constructor</td>
69 </tr><tr>
70 <td><a href="#OpenSearchEngine.__eq__">__eq__</a></td>
71 <td>Public method implementing the == operator.</td>
72 </tr><tr>
73 <td><a href="#OpenSearchEngine.__imageObtained">__imageObtained</a></td>
74 <td>Private slot to receive the image of the engine.</td>
75 </tr><tr>
76 <td><a href="#OpenSearchEngine.__lt__">__lt__</a></td>
77 <td>Public method implementing the < operator.</td>
78 </tr><tr>
79 <td><a href="#OpenSearchEngine.__suggestionsObtained">__suggestionsObtained</a></td>
80 <td>Private slot to receive the suggestions.</td>
81 </tr><tr>
82 <td><a href="#OpenSearchEngine.description">description</a></td>
83 <td>Public method to get the description of the engine.</td>
84 </tr><tr>
85 <td><a href="#OpenSearchEngine.image">image</a></td>
86 <td>Public method to get the image of the engine.</td>
87 </tr><tr>
88 <td><a href="#OpenSearchEngine.imageUrl">imageUrl</a></td>
89 <td>Public method to get the image URL of the engine.</td>
90 </tr><tr>
91 <td><a href="#OpenSearchEngine.isValid">isValid</a></td>
92 <td>Public method to check, if the engine is valid.</td>
93 </tr><tr>
94 <td><a href="#OpenSearchEngine.loadImage">loadImage</a></td>
95 <td>Public method to load the image of the engine.</td>
96 </tr><tr>
97 <td><a href="#OpenSearchEngine.name">name</a></td>
98 <td>Public method to get the name of the engine.</td>
99 </tr><tr>
100 <td><a href="#OpenSearchEngine.networkAccessManager">networkAccessManager</a></td>
101 <td>Public method to get a reference to the network access manager object.</td>
102 </tr><tr>
103 <td><a href="#OpenSearchEngine.parseTemplate">parseTemplate</a></td>
104 <td>Class method to parse a search template.</td>
105 </tr><tr>
106 <td><a href="#OpenSearchEngine.providesSuggestions">providesSuggestions</a></td>
107 <td>Public method to check, if the engine provides suggestions.</td>
108 </tr><tr>
109 <td><a href="#OpenSearchEngine.requestSuggestions">requestSuggestions</a></td>
110 <td>Public method to request suggestions.</td>
111 </tr><tr>
112 <td><a href="#OpenSearchEngine.searchMethod">searchMethod</a></td>
113 <td>Public method to get the HTTP request method used to perform search requests.</td>
114 </tr><tr>
115 <td><a href="#OpenSearchEngine.searchParameters">searchParameters</a></td>
116 <td>Public method to get the search parameters of the engine.</td>
117 </tr><tr>
118 <td><a href="#OpenSearchEngine.searchUrl">searchUrl</a></td>
119 <td>Public method to get a URL ready for searching.</td>
120 </tr><tr>
121 <td><a href="#OpenSearchEngine.searchUrlTemplate">searchUrlTemplate</a></td>
122 <td>Public method to get the search URL template of the engine.</td>
123 </tr><tr>
124 <td><a href="#OpenSearchEngine.setDescription">setDescription</a></td>
125 <td>Public method to set the engine description.</td>
126 </tr><tr>
127 <td><a href="#OpenSearchEngine.setImage">setImage</a></td>
128 <td>Public method to set the image of the engine.</td>
129 </tr><tr>
130 <td><a href="#OpenSearchEngine.setImageUrl">setImageUrl</a></td>
131 <td>Public method to set the engine image URL.</td>
132 </tr><tr>
133 <td><a href="#OpenSearchEngine.setImageUrlAndLoad">setImageUrlAndLoad</a></td>
134 <td>Public method to set the engine image URL.</td>
135 </tr><tr>
136 <td><a href="#OpenSearchEngine.setName">setName</a></td>
137 <td>Public method to set the engine name.</td>
138 </tr><tr>
139 <td><a href="#OpenSearchEngine.setNetworkAccessManager">setNetworkAccessManager</a></td>
140 <td>Public method to set the reference to the network access manager.</td>
141 </tr><tr>
142 <td><a href="#OpenSearchEngine.setSearchMethod">setSearchMethod</a></td>
143 <td>Public method to set the HTTP request method used to perform search requests.</td>
144 </tr><tr>
145 <td><a href="#OpenSearchEngine.setSearchParameters">setSearchParameters</a></td>
146 <td>Public method to set the engine search parameters.</td>
147 </tr><tr>
148 <td><a href="#OpenSearchEngine.setSearchUrlTemplate">setSearchUrlTemplate</a></td>
149 <td>Public method to set the engine search URL template.</td>
150 </tr><tr>
151 <td><a href="#OpenSearchEngine.setSuggestionsMethod">setSuggestionsMethod</a></td>
152 <td>Public method to set the HTTP request method used to perform suggestions requests.</td>
153 </tr><tr>
154 <td><a href="#OpenSearchEngine.setSuggestionsParameters">setSuggestionsParameters</a></td>
155 <td>Public method to set the engine suggestions parameters.</td>
156 </tr><tr>
157 <td><a href="#OpenSearchEngine.setSuggestionsUrlTemplate">setSuggestionsUrlTemplate</a></td>
158 <td>Public method to set the engine suggestions URL template.</td>
159 </tr><tr>
160 <td><a href="#OpenSearchEngine.suggestionsMethod">suggestionsMethod</a></td>
161 <td>Public method to get the HTTP request method used to perform suggestions requests.</td>
162 </tr><tr>
163 <td><a href="#OpenSearchEngine.suggestionsParameters">suggestionsParameters</a></td>
164 <td>Public method to get the suggestions parameters of the engine.</td>
165 </tr><tr>
166 <td><a href="#OpenSearchEngine.suggestionsUrl">suggestionsUrl</a></td>
167 <td>Public method to get a URL ready for suggestions.</td>
168 </tr><tr>
169 <td><a href="#OpenSearchEngine.suggestionsUrlTemplate">suggestionsUrlTemplate</a></td>
170 <td>Public method to get the search URL template of the engine.</td>
171 </tr>
172 </table>
173 <a NAME="OpenSearchEngine.__init__" ID="OpenSearchEngine.__init__"></a>
174 <h4>OpenSearchEngine (Constructor)</h4>
175 <b>OpenSearchEngine</b>(<i>parent = None</i>)
176 <p>
177 Constructor
178 </p><dl>
179 <dt><i>parent</i></dt>
180 <dd>
181 reference to the parent object (QObject)
182 </dd>
183 </dl><a NAME="OpenSearchEngine.__eq__" ID="OpenSearchEngine.__eq__"></a>
184 <h4>OpenSearchEngine.__eq__</h4>
185 <b>__eq__</b>(<i>other</i>)
186 <p>
187 Public method implementing the == operator.
188 </p><dl>
189 <dt><i>other</i></dt>
190 <dd>
191 reference to an open search engine (OpenSearchEngine)
192 </dd>
193 </dl><dl>
194 <dt>Returns:</dt>
195 <dd>
196 flag indicating equality (boolean)
197 </dd>
198 </dl><a NAME="OpenSearchEngine.__imageObtained" ID="OpenSearchEngine.__imageObtained"></a>
199 <h4>OpenSearchEngine.__imageObtained</h4>
200 <b>__imageObtained</b>(<i></i>)
201 <p>
202 Private slot to receive the image of the engine.
203 </p><a NAME="OpenSearchEngine.__lt__" ID="OpenSearchEngine.__lt__"></a>
204 <h4>OpenSearchEngine.__lt__</h4>
205 <b>__lt__</b>(<i>other</i>)
206 <p>
207 Public method implementing the < operator.
208 </p><dl>
209 <dt><i>other</i></dt>
210 <dd>
211 reference to an open search engine (OpenSearchEngine)
212 </dd>
213 </dl><dl>
214 <dt>Returns:</dt>
215 <dd>
216 flag indicating less than (boolean)
217 </dd>
218 </dl><a NAME="OpenSearchEngine.__suggestionsObtained" ID="OpenSearchEngine.__suggestionsObtained"></a>
219 <h4>OpenSearchEngine.__suggestionsObtained</h4>
220 <b>__suggestionsObtained</b>(<i></i>)
221 <p>
222 Private slot to receive the suggestions.
223 </p><a NAME="OpenSearchEngine.description" ID="OpenSearchEngine.description"></a>
224 <h4>OpenSearchEngine.description</h4>
225 <b>description</b>(<i></i>)
226 <p>
227 Public method to get the description of the engine.
228 </p><dl>
229 <dt>Returns:</dt>
230 <dd>
231 description of the engine (string)
232 </dd>
233 </dl><a NAME="OpenSearchEngine.image" ID="OpenSearchEngine.image"></a>
234 <h4>OpenSearchEngine.image</h4>
235 <b>image</b>(<i></i>)
236 <p>
237 Public method to get the image of the engine.
238 </p><dl>
239 <dt>Returns:</dt>
240 <dd>
241 image of the engine (QImage)
242 </dd>
243 </dl><a NAME="OpenSearchEngine.imageUrl" ID="OpenSearchEngine.imageUrl"></a>
244 <h4>OpenSearchEngine.imageUrl</h4>
245 <b>imageUrl</b>(<i></i>)
246 <p>
247 Public method to get the image URL of the engine.
248 </p><dl>
249 <dt>Returns:</dt>
250 <dd>
251 image URL of the engine (string)
252 </dd>
253 </dl><a NAME="OpenSearchEngine.isValid" ID="OpenSearchEngine.isValid"></a>
254 <h4>OpenSearchEngine.isValid</h4>
255 <b>isValid</b>(<i></i>)
256 <p>
257 Public method to check, if the engine is valid.
258 </p><dl>
259 <dt>Returns:</dt>
260 <dd>
261 flag indicating validity (boolean)
262 </dd>
263 </dl><a NAME="OpenSearchEngine.loadImage" ID="OpenSearchEngine.loadImage"></a>
264 <h4>OpenSearchEngine.loadImage</h4>
265 <b>loadImage</b>(<i></i>)
266 <p>
267 Public method to load the image of the engine.
268 </p><a NAME="OpenSearchEngine.name" ID="OpenSearchEngine.name"></a>
269 <h4>OpenSearchEngine.name</h4>
270 <b>name</b>(<i></i>)
271 <p>
272 Public method to get the name of the engine.
273 </p><dl>
274 <dt>Returns:</dt>
275 <dd>
276 name of the engine (string)
277 </dd>
278 </dl><a NAME="OpenSearchEngine.networkAccessManager" ID="OpenSearchEngine.networkAccessManager"></a>
279 <h4>OpenSearchEngine.networkAccessManager</h4>
280 <b>networkAccessManager</b>(<i></i>)
281 <p>
282 Public method to get a reference to the network access manager object.
283 </p><dl>
284 <dt>Returns:</dt>
285 <dd>
286 reference to the network access manager object (QNetworkAccessManager)
287 </dd>
288 </dl><a NAME="OpenSearchEngine.parseTemplate" ID="OpenSearchEngine.parseTemplate"></a>
289 <h4>OpenSearchEngine.parseTemplate</h4>
290 <b>parseTemplate</b>(<i>searchTerm, searchTemplate</i>)
291 <p>
292 Class method to parse a search template.
293 </p><dl>
294 <dt><i>searchTerm</i></dt>
295 <dd>
296 term to search for (string)
297 </dd><dt><i>searchTemplate</i></dt>
298 <dd>
299 template to be parsed (string)
300 </dd>
301 </dl><dl>
302 <dt>Returns:</dt>
303 <dd>
304 parsed template (string)
305 </dd>
306 </dl><a NAME="OpenSearchEngine.providesSuggestions" ID="OpenSearchEngine.providesSuggestions"></a>
307 <h4>OpenSearchEngine.providesSuggestions</h4>
308 <b>providesSuggestions</b>(<i></i>)
309 <p>
310 Public method to check, if the engine provides suggestions.
311 </p><dl>
312 <dt>Returns:</dt>
313 <dd>
314 flag indicating suggestions are provided (boolean)
315 </dd>
316 </dl><a NAME="OpenSearchEngine.requestSuggestions" ID="OpenSearchEngine.requestSuggestions"></a>
317 <h4>OpenSearchEngine.requestSuggestions</h4>
318 <b>requestSuggestions</b>(<i>searchTerm</i>)
319 <p>
320 Public method to request suggestions.
321 </p><dl>
322 <dt><i>searchTerm</i></dt>
323 <dd>
324 term to get suggestions for (string)
325 </dd>
326 </dl><a NAME="OpenSearchEngine.searchMethod" ID="OpenSearchEngine.searchMethod"></a>
327 <h4>OpenSearchEngine.searchMethod</h4>
328 <b>searchMethod</b>(<i></i>)
329 <p>
330 Public method to get the HTTP request method used to perform search requests.
331 </p><dl>
332 <dt>Returns:</dt>
333 <dd>
334 HTTP request method (string)
335 </dd>
336 </dl><a NAME="OpenSearchEngine.searchParameters" ID="OpenSearchEngine.searchParameters"></a>
337 <h4>OpenSearchEngine.searchParameters</h4>
338 <b>searchParameters</b>(<i></i>)
339 <p>
340 Public method to get the search parameters of the engine.
341 </p><dl>
342 <dt>Returns:</dt>
343 <dd>
344 search parameters of the engine (list of two tuples)
345 </dd>
346 </dl><a NAME="OpenSearchEngine.searchUrl" ID="OpenSearchEngine.searchUrl"></a>
347 <h4>OpenSearchEngine.searchUrl</h4>
348 <b>searchUrl</b>(<i>searchTerm</i>)
349 <p>
350 Public method to get a URL ready for searching.
351 </p><dl>
352 <dt><i>searchTerm</i></dt>
353 <dd>
354 term to search for (string)
355 </dd>
356 </dl><dl>
357 <dt>Returns:</dt>
358 <dd>
359 URL (QUrl)
360 </dd>
361 </dl><a NAME="OpenSearchEngine.searchUrlTemplate" ID="OpenSearchEngine.searchUrlTemplate"></a>
362 <h4>OpenSearchEngine.searchUrlTemplate</h4>
363 <b>searchUrlTemplate</b>(<i></i>)
364 <p>
365 Public method to get the search URL template of the engine.
366 </p><dl>
367 <dt>Returns:</dt>
368 <dd>
369 search URL template of the engine (string)
370 </dd>
371 </dl><a NAME="OpenSearchEngine.setDescription" ID="OpenSearchEngine.setDescription"></a>
372 <h4>OpenSearchEngine.setDescription</h4>
373 <b>setDescription</b>(<i>description</i>)
374 <p>
375 Public method to set the engine description.
376 </p><dl>
377 <dt><i>description</i></dt>
378 <dd>
379 description of the engine (string)
380 </dd>
381 </dl><a NAME="OpenSearchEngine.setImage" ID="OpenSearchEngine.setImage"></a>
382 <h4>OpenSearchEngine.setImage</h4>
383 <b>setImage</b>(<i>image</i>)
384 <p>
385 Public method to set the image of the engine.
386 </p><dl>
387 <dt><i>image</i></dt>
388 <dd>
389 image to be set (QImage)
390 </dd>
391 </dl><a NAME="OpenSearchEngine.setImageUrl" ID="OpenSearchEngine.setImageUrl"></a>
392 <h4>OpenSearchEngine.setImageUrl</h4>
393 <b>setImageUrl</b>(<i>imageUrl</i>)
394 <p>
395 Public method to set the engine image URL.
396 </p><dl>
397 <dt><i>description</i></dt>
398 <dd>
399 image URL of the engine (string)
400 </dd>
401 </dl><a NAME="OpenSearchEngine.setImageUrlAndLoad" ID="OpenSearchEngine.setImageUrlAndLoad"></a>
402 <h4>OpenSearchEngine.setImageUrlAndLoad</h4>
403 <b>setImageUrlAndLoad</b>(<i>imageUrl</i>)
404 <p>
405 Public method to set the engine image URL.
406 </p><dl>
407 <dt><i>description</i></dt>
408 <dd>
409 image URL of the engine (string)
410 </dd>
411 </dl><a NAME="OpenSearchEngine.setName" ID="OpenSearchEngine.setName"></a>
412 <h4>OpenSearchEngine.setName</h4>
413 <b>setName</b>(<i>name</i>)
414 <p>
415 Public method to set the engine name.
416 </p><dl>
417 <dt><i>name</i></dt>
418 <dd>
419 name of the engine (string)
420 </dd>
421 </dl><a NAME="OpenSearchEngine.setNetworkAccessManager" ID="OpenSearchEngine.setNetworkAccessManager"></a>
422 <h4>OpenSearchEngine.setNetworkAccessManager</h4>
423 <b>setNetworkAccessManager</b>(<i>networkAccessManager</i>)
424 <p>
425 Public method to set the reference to the network access manager.
426 </p><dl>
427 <dt><i>networkAccessManager</i></dt>
428 <dd>
429 reference to the network access manager
430 object (QNetworkAccessManager)
431 </dd>
432 </dl><a NAME="OpenSearchEngine.setSearchMethod" ID="OpenSearchEngine.setSearchMethod"></a>
433 <h4>OpenSearchEngine.setSearchMethod</h4>
434 <b>setSearchMethod</b>(<i>method</i>)
435 <p>
436 Public method to set the HTTP request method used to perform search requests.
437 </p><dl>
438 <dt><i>method</i></dt>
439 <dd>
440 HTTP request method (string)
441 </dd>
442 </dl><a NAME="OpenSearchEngine.setSearchParameters" ID="OpenSearchEngine.setSearchParameters"></a>
443 <h4>OpenSearchEngine.setSearchParameters</h4>
444 <b>setSearchParameters</b>(<i>searchParameters</i>)
445 <p>
446 Public method to set the engine search parameters.
447 </p><dl>
448 <dt><i>searchParameters</i></dt>
449 <dd>
450 search parameters of the engine (list of two tuples)
451 </dd>
452 </dl><a NAME="OpenSearchEngine.setSearchUrlTemplate" ID="OpenSearchEngine.setSearchUrlTemplate"></a>
453 <h4>OpenSearchEngine.setSearchUrlTemplate</h4>
454 <b>setSearchUrlTemplate</b>(<i>searchUrlTemplate</i>)
455 <p>
456 Public method to set the engine search URL template.
457 </p><dl>
458 <dt><i>searchUrlTemplate</i></dt>
459 <dd>
460 search URL template of the engine (string)
461 </dd>
462 </dl><a NAME="OpenSearchEngine.setSuggestionsMethod" ID="OpenSearchEngine.setSuggestionsMethod"></a>
463 <h4>OpenSearchEngine.setSuggestionsMethod</h4>
464 <b>setSuggestionsMethod</b>(<i>method</i>)
465 <p>
466 Public method to set the HTTP request method used to perform suggestions requests.
467 </p><dl>
468 <dt><i>method</i></dt>
469 <dd>
470 HTTP request method (string)
471 </dd>
472 </dl><a NAME="OpenSearchEngine.setSuggestionsParameters" ID="OpenSearchEngine.setSuggestionsParameters"></a>
473 <h4>OpenSearchEngine.setSuggestionsParameters</h4>
474 <b>setSuggestionsParameters</b>(<i>suggestionsParameters</i>)
475 <p>
476 Public method to set the engine suggestions parameters.
477 </p><dl>
478 <dt><i>suggestionsParameters</i></dt>
479 <dd>
480 suggestions parameters of the
481 engine (list of two tuples)
482 </dd>
483 </dl><a NAME="OpenSearchEngine.setSuggestionsUrlTemplate" ID="OpenSearchEngine.setSuggestionsUrlTemplate"></a>
484 <h4>OpenSearchEngine.setSuggestionsUrlTemplate</h4>
485 <b>setSuggestionsUrlTemplate</b>(<i>suggestionsUrlTemplate</i>)
486 <p>
487 Public method to set the engine suggestions URL template.
488 </p><dl>
489 <dt><i>suggestionsUrlTemplate</i></dt>
490 <dd>
491 suggestions URL template of the
492 engine (string)
493 </dd>
494 </dl><a NAME="OpenSearchEngine.suggestionsMethod" ID="OpenSearchEngine.suggestionsMethod"></a>
495 <h4>OpenSearchEngine.suggestionsMethod</h4>
496 <b>suggestionsMethod</b>(<i></i>)
497 <p>
498 Public method to get the HTTP request method used to perform suggestions requests.
499 </p><dl>
500 <dt>Returns:</dt>
501 <dd>
502 HTTP request method (string)
503 </dd>
504 </dl><a NAME="OpenSearchEngine.suggestionsParameters" ID="OpenSearchEngine.suggestionsParameters"></a>
505 <h4>OpenSearchEngine.suggestionsParameters</h4>
506 <b>suggestionsParameters</b>(<i></i>)
507 <p>
508 Public method to get the suggestions parameters of the engine.
509 </p><dl>
510 <dt>Returns:</dt>
511 <dd>
512 suggestions parameters of the engine (list of two tuples)
513 </dd>
514 </dl><a NAME="OpenSearchEngine.suggestionsUrl" ID="OpenSearchEngine.suggestionsUrl"></a>
515 <h4>OpenSearchEngine.suggestionsUrl</h4>
516 <b>suggestionsUrl</b>(<i>searchTerm</i>)
517 <p>
518 Public method to get a URL ready for suggestions.
519 </p><dl>
520 <dt><i>searchTerm</i></dt>
521 <dd>
522 term to search for (string)
523 </dd>
524 </dl><dl>
525 <dt>Returns:</dt>
526 <dd>
527 URL (QUrl)
528 </dd>
529 </dl><a NAME="OpenSearchEngine.suggestionsUrlTemplate" ID="OpenSearchEngine.suggestionsUrlTemplate"></a>
530 <h4>OpenSearchEngine.suggestionsUrlTemplate</h4>
531 <b>suggestionsUrlTemplate</b>(<i></i>)
532 <p>
533 Public method to get the search URL template of the engine.
534 </p><dl>
535 <dt>Returns:</dt>
536 <dd>
537 search URL template of the engine (string)
538 </dd>
539 </dl>
540 <div align="right"><a href="#top">Up</a></div>
541 <hr />
542 </body></html>

Mercurial Repository: eric

eric ide

mercurial