Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchEngine.html

src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchEngine.html

branch
eric7
changeset 10479
856476537696
parent 10436
f6881d10e995
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.WebBrowser.OpenSearch.OpenSearchEngine</h1> 9 <h1>eric7.WebBrowser.OpenSearch.OpenSearchEngine</h1>
10
11 <p> 10 <p>
12 Module implementing the open search engine. 11 Module implementing the open search engine.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#OpenSearchEngine">OpenSearchEngine</a></td> 22 <td><a href="#OpenSearchEngine">OpenSearchEngine</a></td>
25 <td>Class implementing the open search engine.</td> 23 <td>Class implementing the open search engine.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="OpenSearchEngine" ID="OpenSearchEngine"></a> 34 <a NAME="OpenSearchEngine" ID="OpenSearchEngine"></a>
36 <h2>OpenSearchEngine</h2> 35 <h2>OpenSearchEngine</h2>
37
38 <p> 36 <p>
39 Class implementing the open search engine. 37 Class implementing the open search engine.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>imageChanged()</dt> 43 <dt>imageChanged()</dt>
45 <dd> 44 <dd>
52 </dd> 51 </dd>
53 </dl> 52 </dl>
54 <h3>Derived from</h3> 53 <h3>Derived from</h3>
55 QObject 54 QObject
56 <h3>Class Attributes</h3> 55 <h3>Class Attributes</h3>
57
58 <table> 56 <table>
59 <tr><td>None</td></tr> 57 <tr><td>None</td></tr>
60 </table> 58 </table>
59
61 <h3>Class Methods</h3> 60 <h3>Class Methods</h3>
62
63 <table> 61 <table>
64
65 <tr> 62 <tr>
66 <td><a href="#OpenSearchEngine.parseTemplate">parseTemplate</a></td> 63 <td><a href="#OpenSearchEngine.parseTemplate">parseTemplate</a></td>
67 <td>Class method to parse a search template.</td> 64 <td>Class method to parse a search template.</td>
68 </tr> 65 </tr>
69 </table> 66 </table>
67
70 <h3>Methods</h3> 68 <h3>Methods</h3>
71
72 <table> 69 <table>
73
74 <tr> 70 <tr>
75 <td><a href="#OpenSearchEngine.__init__">OpenSearchEngine</a></td> 71 <td><a href="#OpenSearchEngine.__init__">OpenSearchEngine</a></td>
76 <td>Constructor</td> 72 <td>Constructor</td>
77 </tr> 73 </tr>
78 <tr> 74 <tr>
206 <tr> 202 <tr>
207 <td><a href="#OpenSearchEngine.suggestionsUrlTemplate">suggestionsUrlTemplate</a></td> 203 <td><a href="#OpenSearchEngine.suggestionsUrlTemplate">suggestionsUrlTemplate</a></td>
208 <td>Public method to get the search URL template of the engine.</td> 204 <td>Public method to get the search URL template of the engine.</td>
209 </tr> 205 </tr>
210 </table> 206 </table>
207
211 <h3>Static Methods</h3> 208 <h3>Static Methods</h3>
212
213 <table> 209 <table>
214 <tr><td>None</td></tr> 210 <tr><td>None</td></tr>
215 </table> 211 </table>
216 212
213
217 <a NAME="OpenSearchEngine.parseTemplate" ID="OpenSearchEngine.parseTemplate"></a> 214 <a NAME="OpenSearchEngine.parseTemplate" ID="OpenSearchEngine.parseTemplate"></a>
218 <h4>OpenSearchEngine.parseTemplate (class method)</h4> 215 <h4>OpenSearchEngine.parseTemplate (class method)</h4>
219 <b>parseTemplate</b>(<i>searchTerm, searchTemplate</i>) 216 <b>parseTemplate</b>(<i>searchTerm, searchTemplate</i>)
220
221 <p> 217 <p>
222 Class method to parse a search template. 218 Class method to parse a search template.
223 </p> 219 </p>
220
224 <dl> 221 <dl>
225 222
226 <dt><i>searchTerm</i> (str)</dt> 223 <dt><i>searchTerm</i> (str)</dt>
227 <dd> 224 <dd>
228 term to search for 225 term to search for
245 </dd> 242 </dd>
246 </dl> 243 </dl>
247 <a NAME="OpenSearchEngine.__init__" ID="OpenSearchEngine.__init__"></a> 244 <a NAME="OpenSearchEngine.__init__" ID="OpenSearchEngine.__init__"></a>
248 <h4>OpenSearchEngine (Constructor)</h4> 245 <h4>OpenSearchEngine (Constructor)</h4>
249 <b>OpenSearchEngine</b>(<i>parent=None</i>) 246 <b>OpenSearchEngine</b>(<i>parent=None</i>)
250
251 <p> 247 <p>
252 Constructor 248 Constructor
253 </p> 249 </p>
250
254 <dl> 251 <dl>
255 252
256 <dt><i>parent</i> (QObject)</dt> 253 <dt><i>parent</i> (QObject)</dt>
257 <dd> 254 <dd>
258 reference to the parent object 255 reference to the parent object
259 </dd> 256 </dd>
260 </dl> 257 </dl>
261 <a NAME="OpenSearchEngine.__eq__" ID="OpenSearchEngine.__eq__"></a> 258 <a NAME="OpenSearchEngine.__eq__" ID="OpenSearchEngine.__eq__"></a>
262 <h4>OpenSearchEngine.__eq__</h4> 259 <h4>OpenSearchEngine.__eq__</h4>
263 <b>__eq__</b>(<i>other</i>) 260 <b>__eq__</b>(<i>other</i>)
264
265 <p> 261 <p>
266 Special method implementing the == operator. 262 Special method implementing the == operator.
267 </p> 263 </p>
264
268 <dl> 265 <dl>
269 266
270 <dt><i>other</i> (OpenSearchEngine)</dt> 267 <dt><i>other</i> (OpenSearchEngine)</dt>
271 <dd> 268 <dd>
272 reference to an open search engine 269 reference to an open search engine
285 </dd> 282 </dd>
286 </dl> 283 </dl>
287 <a NAME="OpenSearchEngine.__imageObtained" ID="OpenSearchEngine.__imageObtained"></a> 284 <a NAME="OpenSearchEngine.__imageObtained" ID="OpenSearchEngine.__imageObtained"></a>
288 <h4>OpenSearchEngine.__imageObtained</h4> 285 <h4>OpenSearchEngine.__imageObtained</h4>
289 <b>__imageObtained</b>(<i>reply</i>) 286 <b>__imageObtained</b>(<i>reply</i>)
290
291 <p> 287 <p>
292 Private slot to receive the image of the engine. 288 Private slot to receive the image of the engine.
293 </p> 289 </p>
290
294 <dl> 291 <dl>
295 292
296 <dt><i>reply</i> (QNetworkReply)</dt> 293 <dt><i>reply</i> (QNetworkReply)</dt>
297 <dd> 294 <dd>
298 reference to the network reply 295 reference to the network reply
299 </dd> 296 </dd>
300 </dl> 297 </dl>
301 <a NAME="OpenSearchEngine.__lt__" ID="OpenSearchEngine.__lt__"></a> 298 <a NAME="OpenSearchEngine.__lt__" ID="OpenSearchEngine.__lt__"></a>
302 <h4>OpenSearchEngine.__lt__</h4> 299 <h4>OpenSearchEngine.__lt__</h4>
303 <b>__lt__</b>(<i>other</i>) 300 <b>__lt__</b>(<i>other</i>)
304
305 <p> 301 <p>
306 Special method implementing the < operator. 302 Special method implementing the < operator.
307 </p> 303 </p>
304
308 <dl> 305 <dl>
309 306
310 <dt><i>other</i> (OpenSearchEngine)</dt> 307 <dt><i>other</i> (OpenSearchEngine)</dt>
311 <dd> 308 <dd>
312 reference to an open search engine 309 reference to an open search engine
325 </dd> 322 </dd>
326 </dl> 323 </dl>
327 <a NAME="OpenSearchEngine.__suggestionsObtained" ID="OpenSearchEngine.__suggestionsObtained"></a> 324 <a NAME="OpenSearchEngine.__suggestionsObtained" ID="OpenSearchEngine.__suggestionsObtained"></a>
328 <h4>OpenSearchEngine.__suggestionsObtained</h4> 325 <h4>OpenSearchEngine.__suggestionsObtained</h4>
329 <b>__suggestionsObtained</b>(<i></i>) 326 <b>__suggestionsObtained</b>(<i></i>)
330
331 <p> 327 <p>
332 Private slot to receive the suggestions. 328 Private slot to receive the suggestions.
333 </p> 329 </p>
330
334 <a NAME="OpenSearchEngine.description" ID="OpenSearchEngine.description"></a> 331 <a NAME="OpenSearchEngine.description" ID="OpenSearchEngine.description"></a>
335 <h4>OpenSearchEngine.description</h4> 332 <h4>OpenSearchEngine.description</h4>
336 <b>description</b>(<i></i>) 333 <b>description</b>(<i></i>)
337
338 <p> 334 <p>
339 Public method to get the description of the engine. 335 Public method to get the description of the engine.
340 </p> 336 </p>
337
341 <dl> 338 <dl>
342 <dt>Return:</dt> 339 <dt>Return:</dt>
343 <dd> 340 <dd>
344 description of the engine 341 description of the engine
345 </dd> 342 </dd>
351 </dd> 348 </dd>
352 </dl> 349 </dl>
353 <a NAME="OpenSearchEngine.image" ID="OpenSearchEngine.image"></a> 350 <a NAME="OpenSearchEngine.image" ID="OpenSearchEngine.image"></a>
354 <h4>OpenSearchEngine.image</h4> 351 <h4>OpenSearchEngine.image</h4>
355 <b>image</b>(<i></i>) 352 <b>image</b>(<i></i>)
356
357 <p> 353 <p>
358 Public method to get the image of the engine. 354 Public method to get the image of the engine.
359 </p> 355 </p>
356
360 <dl> 357 <dl>
361 <dt>Return:</dt> 358 <dt>Return:</dt>
362 <dd> 359 <dd>
363 image of the engine 360 image of the engine
364 </dd> 361 </dd>
370 </dd> 367 </dd>
371 </dl> 368 </dl>
372 <a NAME="OpenSearchEngine.imageUrl" ID="OpenSearchEngine.imageUrl"></a> 369 <a NAME="OpenSearchEngine.imageUrl" ID="OpenSearchEngine.imageUrl"></a>
373 <h4>OpenSearchEngine.imageUrl</h4> 370 <h4>OpenSearchEngine.imageUrl</h4>
374 <b>imageUrl</b>(<i></i>) 371 <b>imageUrl</b>(<i></i>)
375
376 <p> 372 <p>
377 Public method to get the image URL of the engine. 373 Public method to get the image URL of the engine.
378 </p> 374 </p>
375
379 <dl> 376 <dl>
380 <dt>Return:</dt> 377 <dt>Return:</dt>
381 <dd> 378 <dd>
382 image URL of the engine 379 image URL of the engine
383 </dd> 380 </dd>
389 </dd> 386 </dd>
390 </dl> 387 </dl>
391 <a NAME="OpenSearchEngine.isValid" ID="OpenSearchEngine.isValid"></a> 388 <a NAME="OpenSearchEngine.isValid" ID="OpenSearchEngine.isValid"></a>
392 <h4>OpenSearchEngine.isValid</h4> 389 <h4>OpenSearchEngine.isValid</h4>
393 <b>isValid</b>(<i></i>) 390 <b>isValid</b>(<i></i>)
394
395 <p> 391 <p>
396 Public method to check, if the engine is valid. 392 Public method to check, if the engine is valid.
397 </p> 393 </p>
394
398 <dl> 395 <dl>
399 <dt>Return:</dt> 396 <dt>Return:</dt>
400 <dd> 397 <dd>
401 flag indicating validity 398 flag indicating validity
402 </dd> 399 </dd>
408 </dd> 405 </dd>
409 </dl> 406 </dl>
410 <a NAME="OpenSearchEngine.loadImage" ID="OpenSearchEngine.loadImage"></a> 407 <a NAME="OpenSearchEngine.loadImage" ID="OpenSearchEngine.loadImage"></a>
411 <h4>OpenSearchEngine.loadImage</h4> 408 <h4>OpenSearchEngine.loadImage</h4>
412 <b>loadImage</b>(<i></i>) 409 <b>loadImage</b>(<i></i>)
413
414 <p> 410 <p>
415 Public method to load the image of the engine. 411 Public method to load the image of the engine.
416 </p> 412 </p>
413
417 <a NAME="OpenSearchEngine.name" ID="OpenSearchEngine.name"></a> 414 <a NAME="OpenSearchEngine.name" ID="OpenSearchEngine.name"></a>
418 <h4>OpenSearchEngine.name</h4> 415 <h4>OpenSearchEngine.name</h4>
419 <b>name</b>(<i></i>) 416 <b>name</b>(<i></i>)
420
421 <p> 417 <p>
422 Public method to get the name of the engine. 418 Public method to get the name of the engine.
423 </p> 419 </p>
420
424 <dl> 421 <dl>
425 <dt>Return:</dt> 422 <dt>Return:</dt>
426 <dd> 423 <dd>
427 name of the engine 424 name of the engine
428 </dd> 425 </dd>
434 </dd> 431 </dd>
435 </dl> 432 </dl>
436 <a NAME="OpenSearchEngine.networkAccessManager" ID="OpenSearchEngine.networkAccessManager"></a> 433 <a NAME="OpenSearchEngine.networkAccessManager" ID="OpenSearchEngine.networkAccessManager"></a>
437 <h4>OpenSearchEngine.networkAccessManager</h4> 434 <h4>OpenSearchEngine.networkAccessManager</h4>
438 <b>networkAccessManager</b>(<i></i>) 435 <b>networkAccessManager</b>(<i></i>)
439
440 <p> 436 <p>
441 Public method to get a reference to the network access manager object. 437 Public method to get a reference to the network access manager object.
442 </p> 438 </p>
439
443 <dl> 440 <dl>
444 <dt>Return:</dt> 441 <dt>Return:</dt>
445 <dd> 442 <dd>
446 reference to the network access manager object 443 reference to the network access manager object
447 </dd> 444 </dd>
453 </dd> 450 </dd>
454 </dl> 451 </dl>
455 <a NAME="OpenSearchEngine.providesSuggestions" ID="OpenSearchEngine.providesSuggestions"></a> 452 <a NAME="OpenSearchEngine.providesSuggestions" ID="OpenSearchEngine.providesSuggestions"></a>
456 <h4>OpenSearchEngine.providesSuggestions</h4> 453 <h4>OpenSearchEngine.providesSuggestions</h4>
457 <b>providesSuggestions</b>(<i></i>) 454 <b>providesSuggestions</b>(<i></i>)
458
459 <p> 455 <p>
460 Public method to check, if the engine provides suggestions. 456 Public method to check, if the engine provides suggestions.
461 </p> 457 </p>
458
462 <dl> 459 <dl>
463 <dt>Return:</dt> 460 <dt>Return:</dt>
464 <dd> 461 <dd>
465 flag indicating suggestions are provided 462 flag indicating suggestions are provided
466 </dd> 463 </dd>
472 </dd> 469 </dd>
473 </dl> 470 </dl>
474 <a NAME="OpenSearchEngine.requestSuggestions" ID="OpenSearchEngine.requestSuggestions"></a> 471 <a NAME="OpenSearchEngine.requestSuggestions" ID="OpenSearchEngine.requestSuggestions"></a>
475 <h4>OpenSearchEngine.requestSuggestions</h4> 472 <h4>OpenSearchEngine.requestSuggestions</h4>
476 <b>requestSuggestions</b>(<i>searchTerm</i>) 473 <b>requestSuggestions</b>(<i>searchTerm</i>)
477
478 <p> 474 <p>
479 Public method to request suggestions. 475 Public method to request suggestions.
480 </p> 476 </p>
477
481 <dl> 478 <dl>
482 479
483 <dt><i>searchTerm</i> (str)</dt> 480 <dt><i>searchTerm</i> (str)</dt>
484 <dd> 481 <dd>
485 term to get suggestions for 482 term to get suggestions for
486 </dd> 483 </dd>
487 </dl> 484 </dl>
488 <a NAME="OpenSearchEngine.searchMethod" ID="OpenSearchEngine.searchMethod"></a> 485 <a NAME="OpenSearchEngine.searchMethod" ID="OpenSearchEngine.searchMethod"></a>
489 <h4>OpenSearchEngine.searchMethod</h4> 486 <h4>OpenSearchEngine.searchMethod</h4>
490 <b>searchMethod</b>(<i></i>) 487 <b>searchMethod</b>(<i></i>)
491
492 <p> 488 <p>
493 Public method to get the HTTP request method used to perform search 489 Public method to get the HTTP request method used to perform search
494 requests. 490 requests.
495 </p> 491 </p>
492
496 <dl> 493 <dl>
497 <dt>Return:</dt> 494 <dt>Return:</dt>
498 <dd> 495 <dd>
499 HTTP request method 496 HTTP request method
500 </dd> 497 </dd>
506 </dd> 503 </dd>
507 </dl> 504 </dl>
508 <a NAME="OpenSearchEngine.searchParameters" ID="OpenSearchEngine.searchParameters"></a> 505 <a NAME="OpenSearchEngine.searchParameters" ID="OpenSearchEngine.searchParameters"></a>
509 <h4>OpenSearchEngine.searchParameters</h4> 506 <h4>OpenSearchEngine.searchParameters</h4>
510 <b>searchParameters</b>(<i></i>) 507 <b>searchParameters</b>(<i></i>)
511
512 <p> 508 <p>
513 Public method to get the search parameters of the engine. 509 Public method to get the search parameters of the engine.
514 </p> 510 </p>
511
515 <dl> 512 <dl>
516 <dt>Return:</dt> 513 <dt>Return:</dt>
517 <dd> 514 <dd>
518 search parameters of the engine 515 search parameters of the engine
519 </dd> 516 </dd>
525 </dd> 522 </dd>
526 </dl> 523 </dl>
527 <a NAME="OpenSearchEngine.searchUrl" ID="OpenSearchEngine.searchUrl"></a> 524 <a NAME="OpenSearchEngine.searchUrl" ID="OpenSearchEngine.searchUrl"></a>
528 <h4>OpenSearchEngine.searchUrl</h4> 525 <h4>OpenSearchEngine.searchUrl</h4>
529 <b>searchUrl</b>(<i>searchTerm</i>) 526 <b>searchUrl</b>(<i>searchTerm</i>)
530
531 <p> 527 <p>
532 Public method to get a URL ready for searching. 528 Public method to get a URL ready for searching.
533 </p> 529 </p>
530
534 <dl> 531 <dl>
535 532
536 <dt><i>searchTerm</i> (str)</dt> 533 <dt><i>searchTerm</i> (str)</dt>
537 <dd> 534 <dd>
538 term to search for 535 term to search for
551 </dd> 548 </dd>
552 </dl> 549 </dl>
553 <a NAME="OpenSearchEngine.searchUrlTemplate" ID="OpenSearchEngine.searchUrlTemplate"></a> 550 <a NAME="OpenSearchEngine.searchUrlTemplate" ID="OpenSearchEngine.searchUrlTemplate"></a>
554 <h4>OpenSearchEngine.searchUrlTemplate</h4> 551 <h4>OpenSearchEngine.searchUrlTemplate</h4>
555 <b>searchUrlTemplate</b>(<i></i>) 552 <b>searchUrlTemplate</b>(<i></i>)
556
557 <p> 553 <p>
558 Public method to get the search URL template of the engine. 554 Public method to get the search URL template of the engine.
559 </p> 555 </p>
556
560 <dl> 557 <dl>
561 <dt>Return:</dt> 558 <dt>Return:</dt>
562 <dd> 559 <dd>
563 search URL template of the engine 560 search URL template of the engine
564 </dd> 561 </dd>
570 </dd> 567 </dd>
571 </dl> 568 </dl>
572 <a NAME="OpenSearchEngine.setDescription" ID="OpenSearchEngine.setDescription"></a> 569 <a NAME="OpenSearchEngine.setDescription" ID="OpenSearchEngine.setDescription"></a>
573 <h4>OpenSearchEngine.setDescription</h4> 570 <h4>OpenSearchEngine.setDescription</h4>
574 <b>setDescription</b>(<i>description</i>) 571 <b>setDescription</b>(<i>description</i>)
575
576 <p> 572 <p>
577 Public method to set the engine description. 573 Public method to set the engine description.
578 </p> 574 </p>
575
579 <dl> 576 <dl>
580 577
581 <dt><i>description</i> (str)</dt> 578 <dt><i>description</i> (str)</dt>
582 <dd> 579 <dd>
583 description of the engine 580 description of the engine
584 </dd> 581 </dd>
585 </dl> 582 </dl>
586 <a NAME="OpenSearchEngine.setImage" ID="OpenSearchEngine.setImage"></a> 583 <a NAME="OpenSearchEngine.setImage" ID="OpenSearchEngine.setImage"></a>
587 <h4>OpenSearchEngine.setImage</h4> 584 <h4>OpenSearchEngine.setImage</h4>
588 <b>setImage</b>(<i>image</i>) 585 <b>setImage</b>(<i>image</i>)
589
590 <p> 586 <p>
591 Public method to set the image of the engine. 587 Public method to set the image of the engine.
592 </p> 588 </p>
589
593 <dl> 590 <dl>
594 591
595 <dt><i>image</i> (QImage)</dt> 592 <dt><i>image</i> (QImage)</dt>
596 <dd> 593 <dd>
597 image to be set 594 image to be set
598 </dd> 595 </dd>
599 </dl> 596 </dl>
600 <a NAME="OpenSearchEngine.setImageUrl" ID="OpenSearchEngine.setImageUrl"></a> 597 <a NAME="OpenSearchEngine.setImageUrl" ID="OpenSearchEngine.setImageUrl"></a>
601 <h4>OpenSearchEngine.setImageUrl</h4> 598 <h4>OpenSearchEngine.setImageUrl</h4>
602 <b>setImageUrl</b>(<i>imageUrl</i>) 599 <b>setImageUrl</b>(<i>imageUrl</i>)
603
604 <p> 600 <p>
605 Public method to set the engine image URL. 601 Public method to set the engine image URL.
606 </p> 602 </p>
603
607 <dl> 604 <dl>
608 605
609 <dt><i>imageUrl</i> (str)</dt> 606 <dt><i>imageUrl</i> (str)</dt>
610 <dd> 607 <dd>
611 image URL of the engine 608 image URL of the engine
612 </dd> 609 </dd>
613 </dl> 610 </dl>
614 <a NAME="OpenSearchEngine.setImageUrlAndLoad" ID="OpenSearchEngine.setImageUrlAndLoad"></a> 611 <a NAME="OpenSearchEngine.setImageUrlAndLoad" ID="OpenSearchEngine.setImageUrlAndLoad"></a>
615 <h4>OpenSearchEngine.setImageUrlAndLoad</h4> 612 <h4>OpenSearchEngine.setImageUrlAndLoad</h4>
616 <b>setImageUrlAndLoad</b>(<i>imageUrl</i>) 613 <b>setImageUrlAndLoad</b>(<i>imageUrl</i>)
617
618 <p> 614 <p>
619 Public method to set the engine image URL. 615 Public method to set the engine image URL.
620 </p> 616 </p>
617
621 <dl> 618 <dl>
622 619
623 <dt><i>imageUrl</i> (str)</dt> 620 <dt><i>imageUrl</i> (str)</dt>
624 <dd> 621 <dd>
625 image URL of the engine 622 image URL of the engine
626 </dd> 623 </dd>
627 </dl> 624 </dl>
628 <a NAME="OpenSearchEngine.setName" ID="OpenSearchEngine.setName"></a> 625 <a NAME="OpenSearchEngine.setName" ID="OpenSearchEngine.setName"></a>
629 <h4>OpenSearchEngine.setName</h4> 626 <h4>OpenSearchEngine.setName</h4>
630 <b>setName</b>(<i>name</i>) 627 <b>setName</b>(<i>name</i>)
631
632 <p> 628 <p>
633 Public method to set the engine name. 629 Public method to set the engine name.
634 </p> 630 </p>
631
635 <dl> 632 <dl>
636 633
637 <dt><i>name</i> (str)</dt> 634 <dt><i>name</i> (str)</dt>
638 <dd> 635 <dd>
639 name of the engine 636 name of the engine
640 </dd> 637 </dd>
641 </dl> 638 </dl>
642 <a NAME="OpenSearchEngine.setNetworkAccessManager" ID="OpenSearchEngine.setNetworkAccessManager"></a> 639 <a NAME="OpenSearchEngine.setNetworkAccessManager" ID="OpenSearchEngine.setNetworkAccessManager"></a>
643 <h4>OpenSearchEngine.setNetworkAccessManager</h4> 640 <h4>OpenSearchEngine.setNetworkAccessManager</h4>
644 <b>setNetworkAccessManager</b>(<i>networkAccessManager</i>) 641 <b>setNetworkAccessManager</b>(<i>networkAccessManager</i>)
645
646 <p> 642 <p>
647 Public method to set the reference to the network access manager. 643 Public method to set the reference to the network access manager.
648 </p> 644 </p>
645
649 <dl> 646 <dl>
650 647
651 <dt><i>networkAccessManager</i> (QNetworkAccessManager)</dt> 648 <dt><i>networkAccessManager</i> (QNetworkAccessManager)</dt>
652 <dd> 649 <dd>
653 reference to the network access manager 650 reference to the network access manager
655 </dd> 652 </dd>
656 </dl> 653 </dl>
657 <a NAME="OpenSearchEngine.setSearchMethod" ID="OpenSearchEngine.setSearchMethod"></a> 654 <a NAME="OpenSearchEngine.setSearchMethod" ID="OpenSearchEngine.setSearchMethod"></a>
658 <h4>OpenSearchEngine.setSearchMethod</h4> 655 <h4>OpenSearchEngine.setSearchMethod</h4>
659 <b>setSearchMethod</b>(<i>method</i>) 656 <b>setSearchMethod</b>(<i>method</i>)
660
661 <p> 657 <p>
662 Public method to set the HTTP request method used to perform search 658 Public method to set the HTTP request method used to perform search
663 requests. 659 requests.
664 </p> 660 </p>
661
665 <dl> 662 <dl>
666 663
667 <dt><i>method</i> (str)</dt> 664 <dt><i>method</i> (str)</dt>
668 <dd> 665 <dd>
669 HTTP request method 666 HTTP request method
670 </dd> 667 </dd>
671 </dl> 668 </dl>
672 <a NAME="OpenSearchEngine.setSearchParameters" ID="OpenSearchEngine.setSearchParameters"></a> 669 <a NAME="OpenSearchEngine.setSearchParameters" ID="OpenSearchEngine.setSearchParameters"></a>
673 <h4>OpenSearchEngine.setSearchParameters</h4> 670 <h4>OpenSearchEngine.setSearchParameters</h4>
674 <b>setSearchParameters</b>(<i>searchParameters</i>) 671 <b>setSearchParameters</b>(<i>searchParameters</i>)
675
676 <p> 672 <p>
677 Public method to set the engine search parameters. 673 Public method to set the engine search parameters.
678 </p> 674 </p>
675
679 <dl> 676 <dl>
680 677
681 <dt><i>searchParameters</i> (list of [tuple, tuple])</dt> 678 <dt><i>searchParameters</i> (list of [tuple, tuple])</dt>
682 <dd> 679 <dd>
683 search parameters of the engine 680 search parameters of the engine
684 </dd> 681 </dd>
685 </dl> 682 </dl>
686 <a NAME="OpenSearchEngine.setSearchUrlTemplate" ID="OpenSearchEngine.setSearchUrlTemplate"></a> 683 <a NAME="OpenSearchEngine.setSearchUrlTemplate" ID="OpenSearchEngine.setSearchUrlTemplate"></a>
687 <h4>OpenSearchEngine.setSearchUrlTemplate</h4> 684 <h4>OpenSearchEngine.setSearchUrlTemplate</h4>
688 <b>setSearchUrlTemplate</b>(<i>searchUrlTemplate</i>) 685 <b>setSearchUrlTemplate</b>(<i>searchUrlTemplate</i>)
689
690 <p> 686 <p>
691 Public method to set the engine search URL template. 687 Public method to set the engine search URL template.
692 </p> 688 </p>
693 <p> 689 <p>
694 The URL template is processed according to the specification: 690 The URL template is processed according to the specification:
713 <tr><td>{searchTerms}</td><td>the string supplied by the user</td></tr> 709 <tr><td>{searchTerms}</td><td>the string supplied by the user</td></tr>
714 <tr><td>{*:source}</td> 710 <tr><td>{*:source}</td>
715 <td>application name, QCoreApplication::applicationName()</td></tr> 711 <td>application name, QCoreApplication::applicationName()</td></tr>
716 </table> 712 </table>
717 </p> 713 </p>
714
718 <dl> 715 <dl>
719 716
720 <dt><i>searchUrlTemplate</i> (str)</dt> 717 <dt><i>searchUrlTemplate</i> (str)</dt>
721 <dd> 718 <dd>
722 search URL template of the engine 719 search URL template of the engine
723 </dd> 720 </dd>
724 </dl> 721 </dl>
725 <a NAME="OpenSearchEngine.setSuggestionsMethod" ID="OpenSearchEngine.setSuggestionsMethod"></a> 722 <a NAME="OpenSearchEngine.setSuggestionsMethod" ID="OpenSearchEngine.setSuggestionsMethod"></a>
726 <h4>OpenSearchEngine.setSuggestionsMethod</h4> 723 <h4>OpenSearchEngine.setSuggestionsMethod</h4>
727 <b>setSuggestionsMethod</b>(<i>method</i>) 724 <b>setSuggestionsMethod</b>(<i>method</i>)
728
729 <p> 725 <p>
730 Public method to set the HTTP request method used to perform 726 Public method to set the HTTP request method used to perform
731 suggestions requests. 727 suggestions requests.
732 </p> 728 </p>
729
733 <dl> 730 <dl>
734 731
735 <dt><i>method</i> (str)</dt> 732 <dt><i>method</i> (str)</dt>
736 <dd> 733 <dd>
737 HTTP request method 734 HTTP request method
738 </dd> 735 </dd>
739 </dl> 736 </dl>
740 <a NAME="OpenSearchEngine.setSuggestionsParameters" ID="OpenSearchEngine.setSuggestionsParameters"></a> 737 <a NAME="OpenSearchEngine.setSuggestionsParameters" ID="OpenSearchEngine.setSuggestionsParameters"></a>
741 <h4>OpenSearchEngine.setSuggestionsParameters</h4> 738 <h4>OpenSearchEngine.setSuggestionsParameters</h4>
742 <b>setSuggestionsParameters</b>(<i>suggestionsParameters</i>) 739 <b>setSuggestionsParameters</b>(<i>suggestionsParameters</i>)
743
744 <p> 740 <p>
745 Public method to set the engine suggestions parameters. 741 Public method to set the engine suggestions parameters.
746 </p> 742 </p>
743
747 <dl> 744 <dl>
748 745
749 <dt><i>suggestionsParameters</i> (list of [tuple, tuple])</dt> 746 <dt><i>suggestionsParameters</i> (list of [tuple, tuple])</dt>
750 <dd> 747 <dd>
751 suggestions parameters of the engine 748 suggestions parameters of the engine
752 </dd> 749 </dd>
753 </dl> 750 </dl>
754 <a NAME="OpenSearchEngine.setSuggestionsUrlTemplate" ID="OpenSearchEngine.setSuggestionsUrlTemplate"></a> 751 <a NAME="OpenSearchEngine.setSuggestionsUrlTemplate" ID="OpenSearchEngine.setSuggestionsUrlTemplate"></a>
755 <h4>OpenSearchEngine.setSuggestionsUrlTemplate</h4> 752 <h4>OpenSearchEngine.setSuggestionsUrlTemplate</h4>
756 <b>setSuggestionsUrlTemplate</b>(<i>suggestionsUrlTemplate</i>) 753 <b>setSuggestionsUrlTemplate</b>(<i>suggestionsUrlTemplate</i>)
757
758 <p> 754 <p>
759 Public method to set the engine suggestions URL template. 755 Public method to set the engine suggestions URL template.
760 </p> 756 </p>
757
761 <dl> 758 <dl>
762 759
763 <dt><i>suggestionsUrlTemplate</i> (str)</dt> 760 <dt><i>suggestionsUrlTemplate</i> (str)</dt>
764 <dd> 761 <dd>
765 suggestions URL template of the 762 suggestions URL template of the
767 </dd> 764 </dd>
768 </dl> 765 </dl>
769 <a NAME="OpenSearchEngine.suggestionsMethod" ID="OpenSearchEngine.suggestionsMethod"></a> 766 <a NAME="OpenSearchEngine.suggestionsMethod" ID="OpenSearchEngine.suggestionsMethod"></a>
770 <h4>OpenSearchEngine.suggestionsMethod</h4> 767 <h4>OpenSearchEngine.suggestionsMethod</h4>
771 <b>suggestionsMethod</b>(<i></i>) 768 <b>suggestionsMethod</b>(<i></i>)
772
773 <p> 769 <p>
774 Public method to get the HTTP request method used to perform 770 Public method to get the HTTP request method used to perform
775 suggestions requests. 771 suggestions requests.
776 </p> 772 </p>
773
777 <dl> 774 <dl>
778 <dt>Return:</dt> 775 <dt>Return:</dt>
779 <dd> 776 <dd>
780 HTTP request method 777 HTTP request method
781 </dd> 778 </dd>
787 </dd> 784 </dd>
788 </dl> 785 </dl>
789 <a NAME="OpenSearchEngine.suggestionsParameters" ID="OpenSearchEngine.suggestionsParameters"></a> 786 <a NAME="OpenSearchEngine.suggestionsParameters" ID="OpenSearchEngine.suggestionsParameters"></a>
790 <h4>OpenSearchEngine.suggestionsParameters</h4> 787 <h4>OpenSearchEngine.suggestionsParameters</h4>
791 <b>suggestionsParameters</b>(<i></i>) 788 <b>suggestionsParameters</b>(<i></i>)
792
793 <p> 789 <p>
794 Public method to get the suggestions parameters of the engine. 790 Public method to get the suggestions parameters of the engine.
795 </p> 791 </p>
792
796 <dl> 793 <dl>
797 <dt>Return:</dt> 794 <dt>Return:</dt>
798 <dd> 795 <dd>
799 suggestions parameters of the engine 796 suggestions parameters of the engine
800 </dd> 797 </dd>
806 </dd> 803 </dd>
807 </dl> 804 </dl>
808 <a NAME="OpenSearchEngine.suggestionsUrl" ID="OpenSearchEngine.suggestionsUrl"></a> 805 <a NAME="OpenSearchEngine.suggestionsUrl" ID="OpenSearchEngine.suggestionsUrl"></a>
809 <h4>OpenSearchEngine.suggestionsUrl</h4> 806 <h4>OpenSearchEngine.suggestionsUrl</h4>
810 <b>suggestionsUrl</b>(<i>searchTerm</i>) 807 <b>suggestionsUrl</b>(<i>searchTerm</i>)
811
812 <p> 808 <p>
813 Public method to get a URL ready for suggestions. 809 Public method to get a URL ready for suggestions.
814 </p> 810 </p>
811
815 <dl> 812 <dl>
816 813
817 <dt><i>searchTerm</i> (str)</dt> 814 <dt><i>searchTerm</i> (str)</dt>
818 <dd> 815 <dd>
819 term to search for 816 term to search for
832 </dd> 829 </dd>
833 </dl> 830 </dl>
834 <a NAME="OpenSearchEngine.suggestionsUrlTemplate" ID="OpenSearchEngine.suggestionsUrlTemplate"></a> 831 <a NAME="OpenSearchEngine.suggestionsUrlTemplate" ID="OpenSearchEngine.suggestionsUrlTemplate"></a>
835 <h4>OpenSearchEngine.suggestionsUrlTemplate</h4> 832 <h4>OpenSearchEngine.suggestionsUrlTemplate</h4>
836 <b>suggestionsUrlTemplate</b>(<i></i>) 833 <b>suggestionsUrlTemplate</b>(<i></i>)
837
838 <p> 834 <p>
839 Public method to get the search URL template of the engine. 835 Public method to get the search URL template of the engine.
840 </p> 836 </p>
837
841 <dl> 838 <dl>
842 <dt>Return:</dt> 839 <dt>Return:</dt>
843 <dd> 840 <dd>
844 search URL template of the engine 841 search URL template of the engine
845 </dd> 842 </dd>

Mercurial Repository: eric

eric ide

mercurial