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

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

eric ide

mercurial