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

branch
eric7
changeset 10436
f6881d10e995
parent 9209
b99e7fd55fd3
child 10479
856476537696
equal deleted inserted replaced
10435:c712d09cc839 10436:f6881d10e995
221 <p> 221 <p>
222 Class method to parse a search template. 222 Class method to parse a search template.
223 </p> 223 </p>
224 <dl> 224 <dl>
225 225
226 <dt><i>searchTerm</i></dt> 226 <dt><i>searchTerm</i> (str)</dt>
227 <dd> 227 <dd>
228 term to search for (string) 228 term to search for
229 </dd> 229 </dd>
230 <dt><i>searchTemplate</i></dt> 230 <dt><i>searchTemplate</i> (str)</dt>
231 <dd> 231 <dd>
232 template to be parsed (string) 232 template to be parsed
233 </dd> 233 </dd>
234 </dl> 234 </dl>
235 <dl> 235 <dl>
236 <dt>Return:</dt> 236 <dt>Return:</dt>
237 <dd> 237 <dd>
238 parsed template (string) 238 parsed template
239 </dd>
240 </dl>
241 <dl>
242 <dt>Return Type:</dt>
243 <dd>
244 str
239 </dd> 245 </dd>
240 </dl> 246 </dl>
241 <a NAME="OpenSearchEngine.__init__" ID="OpenSearchEngine.__init__"></a> 247 <a NAME="OpenSearchEngine.__init__" ID="OpenSearchEngine.__init__"></a>
242 <h4>OpenSearchEngine (Constructor)</h4> 248 <h4>OpenSearchEngine (Constructor)</h4>
243 <b>OpenSearchEngine</b>(<i>parent=None</i>) 249 <b>OpenSearchEngine</b>(<i>parent=None</i>)
245 <p> 251 <p>
246 Constructor 252 Constructor
247 </p> 253 </p>
248 <dl> 254 <dl>
249 255
250 <dt><i>parent</i></dt> 256 <dt><i>parent</i> (QObject)</dt>
251 <dd> 257 <dd>
252 reference to the parent object (QObject) 258 reference to the parent object
253 </dd> 259 </dd>
254 </dl> 260 </dl>
255 <a NAME="OpenSearchEngine.__eq__" ID="OpenSearchEngine.__eq__"></a> 261 <a NAME="OpenSearchEngine.__eq__" ID="OpenSearchEngine.__eq__"></a>
256 <h4>OpenSearchEngine.__eq__</h4> 262 <h4>OpenSearchEngine.__eq__</h4>
257 <b>__eq__</b>(<i>other</i>) 263 <b>__eq__</b>(<i>other</i>)
259 <p> 265 <p>
260 Special method implementing the == operator. 266 Special method implementing the == operator.
261 </p> 267 </p>
262 <dl> 268 <dl>
263 269
264 <dt><i>other</i></dt> 270 <dt><i>other</i> (OpenSearchEngine)</dt>
265 <dd> 271 <dd>
266 reference to an open search engine (OpenSearchEngine) 272 reference to an open search engine
267 </dd> 273 </dd>
268 </dl> 274 </dl>
269 <dl> 275 <dl>
270 <dt>Return:</dt> 276 <dt>Return:</dt>
271 <dd> 277 <dd>
272 flag indicating equality (boolean) 278 flag indicating equality
279 </dd>
280 </dl>
281 <dl>
282 <dt>Return Type:</dt>
283 <dd>
284 bool
273 </dd> 285 </dd>
274 </dl> 286 </dl>
275 <a NAME="OpenSearchEngine.__imageObtained" ID="OpenSearchEngine.__imageObtained"></a> 287 <a NAME="OpenSearchEngine.__imageObtained" ID="OpenSearchEngine.__imageObtained"></a>
276 <h4>OpenSearchEngine.__imageObtained</h4> 288 <h4>OpenSearchEngine.__imageObtained</h4>
277 <b>__imageObtained</b>(<i>reply</i>) 289 <b>__imageObtained</b>(<i>reply</i>)
293 <p> 305 <p>
294 Special method implementing the < operator. 306 Special method implementing the < operator.
295 </p> 307 </p>
296 <dl> 308 <dl>
297 309
298 <dt><i>other</i></dt> 310 <dt><i>other</i> (OpenSearchEngine)</dt>
299 <dd> 311 <dd>
300 reference to an open search engine (OpenSearchEngine) 312 reference to an open search engine
301 </dd> 313 </dd>
302 </dl> 314 </dl>
303 <dl> 315 <dl>
304 <dt>Return:</dt> 316 <dt>Return:</dt>
305 <dd> 317 <dd>
306 flag indicating less than (boolean) 318 flag indicating less than
319 </dd>
320 </dl>
321 <dl>
322 <dt>Return Type:</dt>
323 <dd>
324 bool
307 </dd> 325 </dd>
308 </dl> 326 </dl>
309 <a NAME="OpenSearchEngine.__suggestionsObtained" ID="OpenSearchEngine.__suggestionsObtained"></a> 327 <a NAME="OpenSearchEngine.__suggestionsObtained" ID="OpenSearchEngine.__suggestionsObtained"></a>
310 <h4>OpenSearchEngine.__suggestionsObtained</h4> 328 <h4>OpenSearchEngine.__suggestionsObtained</h4>
311 <b>__suggestionsObtained</b>(<i></i>) 329 <b>__suggestionsObtained</b>(<i></i>)
321 Public method to get the description of the engine. 339 Public method to get the description of the engine.
322 </p> 340 </p>
323 <dl> 341 <dl>
324 <dt>Return:</dt> 342 <dt>Return:</dt>
325 <dd> 343 <dd>
326 description of the engine (string) 344 description of the engine
345 </dd>
346 </dl>
347 <dl>
348 <dt>Return Type:</dt>
349 <dd>
350 str
327 </dd> 351 </dd>
328 </dl> 352 </dl>
329 <a NAME="OpenSearchEngine.image" ID="OpenSearchEngine.image"></a> 353 <a NAME="OpenSearchEngine.image" ID="OpenSearchEngine.image"></a>
330 <h4>OpenSearchEngine.image</h4> 354 <h4>OpenSearchEngine.image</h4>
331 <b>image</b>(<i></i>) 355 <b>image</b>(<i></i>)
334 Public method to get the image of the engine. 358 Public method to get the image of the engine.
335 </p> 359 </p>
336 <dl> 360 <dl>
337 <dt>Return:</dt> 361 <dt>Return:</dt>
338 <dd> 362 <dd>
339 image of the engine (QImage) 363 image of the engine
364 </dd>
365 </dl>
366 <dl>
367 <dt>Return Type:</dt>
368 <dd>
369 QImage
340 </dd> 370 </dd>
341 </dl> 371 </dl>
342 <a NAME="OpenSearchEngine.imageUrl" ID="OpenSearchEngine.imageUrl"></a> 372 <a NAME="OpenSearchEngine.imageUrl" ID="OpenSearchEngine.imageUrl"></a>
343 <h4>OpenSearchEngine.imageUrl</h4> 373 <h4>OpenSearchEngine.imageUrl</h4>
344 <b>imageUrl</b>(<i></i>) 374 <b>imageUrl</b>(<i></i>)
347 Public method to get the image URL of the engine. 377 Public method to get the image URL of the engine.
348 </p> 378 </p>
349 <dl> 379 <dl>
350 <dt>Return:</dt> 380 <dt>Return:</dt>
351 <dd> 381 <dd>
352 image URL of the engine (string) 382 image URL of the engine
383 </dd>
384 </dl>
385 <dl>
386 <dt>Return Type:</dt>
387 <dd>
388 str
353 </dd> 389 </dd>
354 </dl> 390 </dl>
355 <a NAME="OpenSearchEngine.isValid" ID="OpenSearchEngine.isValid"></a> 391 <a NAME="OpenSearchEngine.isValid" ID="OpenSearchEngine.isValid"></a>
356 <h4>OpenSearchEngine.isValid</h4> 392 <h4>OpenSearchEngine.isValid</h4>
357 <b>isValid</b>(<i></i>) 393 <b>isValid</b>(<i></i>)
360 Public method to check, if the engine is valid. 396 Public method to check, if the engine is valid.
361 </p> 397 </p>
362 <dl> 398 <dl>
363 <dt>Return:</dt> 399 <dt>Return:</dt>
364 <dd> 400 <dd>
365 flag indicating validity (boolean) 401 flag indicating validity
402 </dd>
403 </dl>
404 <dl>
405 <dt>Return Type:</dt>
406 <dd>
407 bool
366 </dd> 408 </dd>
367 </dl> 409 </dl>
368 <a NAME="OpenSearchEngine.loadImage" ID="OpenSearchEngine.loadImage"></a> 410 <a NAME="OpenSearchEngine.loadImage" ID="OpenSearchEngine.loadImage"></a>
369 <h4>OpenSearchEngine.loadImage</h4> 411 <h4>OpenSearchEngine.loadImage</h4>
370 <b>loadImage</b>(<i></i>) 412 <b>loadImage</b>(<i></i>)
380 Public method to get the name of the engine. 422 Public method to get the name of the engine.
381 </p> 423 </p>
382 <dl> 424 <dl>
383 <dt>Return:</dt> 425 <dt>Return:</dt>
384 <dd> 426 <dd>
385 name of the engine (string) 427 name of the engine
428 </dd>
429 </dl>
430 <dl>
431 <dt>Return Type:</dt>
432 <dd>
433 str
386 </dd> 434 </dd>
387 </dl> 435 </dl>
388 <a NAME="OpenSearchEngine.networkAccessManager" ID="OpenSearchEngine.networkAccessManager"></a> 436 <a NAME="OpenSearchEngine.networkAccessManager" ID="OpenSearchEngine.networkAccessManager"></a>
389 <h4>OpenSearchEngine.networkAccessManager</h4> 437 <h4>OpenSearchEngine.networkAccessManager</h4>
390 <b>networkAccessManager</b>(<i></i>) 438 <b>networkAccessManager</b>(<i></i>)
394 </p> 442 </p>
395 <dl> 443 <dl>
396 <dt>Return:</dt> 444 <dt>Return:</dt>
397 <dd> 445 <dd>
398 reference to the network access manager object 446 reference to the network access manager object
399 (QNetworkAccessManager) 447 </dd>
448 </dl>
449 <dl>
450 <dt>Return Type:</dt>
451 <dd>
452 QNetworkAccessManager
400 </dd> 453 </dd>
401 </dl> 454 </dl>
402 <a NAME="OpenSearchEngine.providesSuggestions" ID="OpenSearchEngine.providesSuggestions"></a> 455 <a NAME="OpenSearchEngine.providesSuggestions" ID="OpenSearchEngine.providesSuggestions"></a>
403 <h4>OpenSearchEngine.providesSuggestions</h4> 456 <h4>OpenSearchEngine.providesSuggestions</h4>
404 <b>providesSuggestions</b>(<i></i>) 457 <b>providesSuggestions</b>(<i></i>)
407 Public method to check, if the engine provides suggestions. 460 Public method to check, if the engine provides suggestions.
408 </p> 461 </p>
409 <dl> 462 <dl>
410 <dt>Return:</dt> 463 <dt>Return:</dt>
411 <dd> 464 <dd>
412 flag indicating suggestions are provided (boolean) 465 flag indicating suggestions are provided
466 </dd>
467 </dl>
468 <dl>
469 <dt>Return Type:</dt>
470 <dd>
471 bool
413 </dd> 472 </dd>
414 </dl> 473 </dl>
415 <a NAME="OpenSearchEngine.requestSuggestions" ID="OpenSearchEngine.requestSuggestions"></a> 474 <a NAME="OpenSearchEngine.requestSuggestions" ID="OpenSearchEngine.requestSuggestions"></a>
416 <h4>OpenSearchEngine.requestSuggestions</h4> 475 <h4>OpenSearchEngine.requestSuggestions</h4>
417 <b>requestSuggestions</b>(<i>searchTerm</i>) 476 <b>requestSuggestions</b>(<i>searchTerm</i>)
419 <p> 478 <p>
420 Public method to request suggestions. 479 Public method to request suggestions.
421 </p> 480 </p>
422 <dl> 481 <dl>
423 482
424 <dt><i>searchTerm</i></dt> 483 <dt><i>searchTerm</i> (str)</dt>
425 <dd> 484 <dd>
426 term to get suggestions for (string) 485 term to get suggestions for
427 </dd> 486 </dd>
428 </dl> 487 </dl>
429 <a NAME="OpenSearchEngine.searchMethod" ID="OpenSearchEngine.searchMethod"></a> 488 <a NAME="OpenSearchEngine.searchMethod" ID="OpenSearchEngine.searchMethod"></a>
430 <h4>OpenSearchEngine.searchMethod</h4> 489 <h4>OpenSearchEngine.searchMethod</h4>
431 <b>searchMethod</b>(<i></i>) 490 <b>searchMethod</b>(<i></i>)
435 requests. 494 requests.
436 </p> 495 </p>
437 <dl> 496 <dl>
438 <dt>Return:</dt> 497 <dt>Return:</dt>
439 <dd> 498 <dd>
440 HTTP request method (string) 499 HTTP request method
500 </dd>
501 </dl>
502 <dl>
503 <dt>Return Type:</dt>
504 <dd>
505 str
441 </dd> 506 </dd>
442 </dl> 507 </dl>
443 <a NAME="OpenSearchEngine.searchParameters" ID="OpenSearchEngine.searchParameters"></a> 508 <a NAME="OpenSearchEngine.searchParameters" ID="OpenSearchEngine.searchParameters"></a>
444 <h4>OpenSearchEngine.searchParameters</h4> 509 <h4>OpenSearchEngine.searchParameters</h4>
445 <b>searchParameters</b>(<i></i>) 510 <b>searchParameters</b>(<i></i>)
448 Public method to get the search parameters of the engine. 513 Public method to get the search parameters of the engine.
449 </p> 514 </p>
450 <dl> 515 <dl>
451 <dt>Return:</dt> 516 <dt>Return:</dt>
452 <dd> 517 <dd>
453 search parameters of the engine (list of two tuples) 518 search parameters of the engine
519 </dd>
520 </dl>
521 <dl>
522 <dt>Return Type:</dt>
523 <dd>
524 list of [tuple, tuple]
454 </dd> 525 </dd>
455 </dl> 526 </dl>
456 <a NAME="OpenSearchEngine.searchUrl" ID="OpenSearchEngine.searchUrl"></a> 527 <a NAME="OpenSearchEngine.searchUrl" ID="OpenSearchEngine.searchUrl"></a>
457 <h4>OpenSearchEngine.searchUrl</h4> 528 <h4>OpenSearchEngine.searchUrl</h4>
458 <b>searchUrl</b>(<i>searchTerm</i>) 529 <b>searchUrl</b>(<i>searchTerm</i>)
460 <p> 531 <p>
461 Public method to get a URL ready for searching. 532 Public method to get a URL ready for searching.
462 </p> 533 </p>
463 <dl> 534 <dl>
464 535
465 <dt><i>searchTerm</i></dt> 536 <dt><i>searchTerm</i> (str)</dt>
466 <dd> 537 <dd>
467 term to search for (string) 538 term to search for
468 </dd> 539 </dd>
469 </dl> 540 </dl>
470 <dl> 541 <dl>
471 <dt>Return:</dt> 542 <dt>Return:</dt>
472 <dd> 543 <dd>
473 URL (QUrl) 544 URL
545 </dd>
546 </dl>
547 <dl>
548 <dt>Return Type:</dt>
549 <dd>
550 QUrl
474 </dd> 551 </dd>
475 </dl> 552 </dl>
476 <a NAME="OpenSearchEngine.searchUrlTemplate" ID="OpenSearchEngine.searchUrlTemplate"></a> 553 <a NAME="OpenSearchEngine.searchUrlTemplate" ID="OpenSearchEngine.searchUrlTemplate"></a>
477 <h4>OpenSearchEngine.searchUrlTemplate</h4> 554 <h4>OpenSearchEngine.searchUrlTemplate</h4>
478 <b>searchUrlTemplate</b>(<i></i>) 555 <b>searchUrlTemplate</b>(<i></i>)
481 Public method to get the search URL template of the engine. 558 Public method to get the search URL template of the engine.
482 </p> 559 </p>
483 <dl> 560 <dl>
484 <dt>Return:</dt> 561 <dt>Return:</dt>
485 <dd> 562 <dd>
486 search URL template of the engine (string) 563 search URL template of the engine
564 </dd>
565 </dl>
566 <dl>
567 <dt>Return Type:</dt>
568 <dd>
569 str
487 </dd> 570 </dd>
488 </dl> 571 </dl>
489 <a NAME="OpenSearchEngine.setDescription" ID="OpenSearchEngine.setDescription"></a> 572 <a NAME="OpenSearchEngine.setDescription" ID="OpenSearchEngine.setDescription"></a>
490 <h4>OpenSearchEngine.setDescription</h4> 573 <h4>OpenSearchEngine.setDescription</h4>
491 <b>setDescription</b>(<i>description</i>) 574 <b>setDescription</b>(<i>description</i>)
493 <p> 576 <p>
494 Public method to set the engine description. 577 Public method to set the engine description.
495 </p> 578 </p>
496 <dl> 579 <dl>
497 580
498 <dt><i>description</i></dt> 581 <dt><i>description</i> (str)</dt>
499 <dd> 582 <dd>
500 description of the engine (string) 583 description of the engine
501 </dd> 584 </dd>
502 </dl> 585 </dl>
503 <a NAME="OpenSearchEngine.setImage" ID="OpenSearchEngine.setImage"></a> 586 <a NAME="OpenSearchEngine.setImage" ID="OpenSearchEngine.setImage"></a>
504 <h4>OpenSearchEngine.setImage</h4> 587 <h4>OpenSearchEngine.setImage</h4>
505 <b>setImage</b>(<i>image</i>) 588 <b>setImage</b>(<i>image</i>)
507 <p> 590 <p>
508 Public method to set the image of the engine. 591 Public method to set the image of the engine.
509 </p> 592 </p>
510 <dl> 593 <dl>
511 594
512 <dt><i>image</i></dt> 595 <dt><i>image</i> (QImage)</dt>
513 <dd> 596 <dd>
514 image to be set (QImage) 597 image to be set
515 </dd> 598 </dd>
516 </dl> 599 </dl>
517 <a NAME="OpenSearchEngine.setImageUrl" ID="OpenSearchEngine.setImageUrl"></a> 600 <a NAME="OpenSearchEngine.setImageUrl" ID="OpenSearchEngine.setImageUrl"></a>
518 <h4>OpenSearchEngine.setImageUrl</h4> 601 <h4>OpenSearchEngine.setImageUrl</h4>
519 <b>setImageUrl</b>(<i>imageUrl</i>) 602 <b>setImageUrl</b>(<i>imageUrl</i>)
521 <p> 604 <p>
522 Public method to set the engine image URL. 605 Public method to set the engine image URL.
523 </p> 606 </p>
524 <dl> 607 <dl>
525 608
526 <dt><i>imageUrl</i></dt> 609 <dt><i>imageUrl</i> (str)</dt>
527 <dd> 610 <dd>
528 image URL of the engine (string) 611 image URL of the engine
529 </dd> 612 </dd>
530 </dl> 613 </dl>
531 <a NAME="OpenSearchEngine.setImageUrlAndLoad" ID="OpenSearchEngine.setImageUrlAndLoad"></a> 614 <a NAME="OpenSearchEngine.setImageUrlAndLoad" ID="OpenSearchEngine.setImageUrlAndLoad"></a>
532 <h4>OpenSearchEngine.setImageUrlAndLoad</h4> 615 <h4>OpenSearchEngine.setImageUrlAndLoad</h4>
533 <b>setImageUrlAndLoad</b>(<i>imageUrl</i>) 616 <b>setImageUrlAndLoad</b>(<i>imageUrl</i>)
535 <p> 618 <p>
536 Public method to set the engine image URL. 619 Public method to set the engine image URL.
537 </p> 620 </p>
538 <dl> 621 <dl>
539 622
540 <dt><i>imageUrl</i></dt> 623 <dt><i>imageUrl</i> (str)</dt>
541 <dd> 624 <dd>
542 image URL of the engine (string) 625 image URL of the engine
543 </dd> 626 </dd>
544 </dl> 627 </dl>
545 <a NAME="OpenSearchEngine.setName" ID="OpenSearchEngine.setName"></a> 628 <a NAME="OpenSearchEngine.setName" ID="OpenSearchEngine.setName"></a>
546 <h4>OpenSearchEngine.setName</h4> 629 <h4>OpenSearchEngine.setName</h4>
547 <b>setName</b>(<i>name</i>) 630 <b>setName</b>(<i>name</i>)
549 <p> 632 <p>
550 Public method to set the engine name. 633 Public method to set the engine name.
551 </p> 634 </p>
552 <dl> 635 <dl>
553 636
554 <dt><i>name</i></dt> 637 <dt><i>name</i> (str)</dt>
555 <dd> 638 <dd>
556 name of the engine (string) 639 name of the engine
557 </dd> 640 </dd>
558 </dl> 641 </dl>
559 <a NAME="OpenSearchEngine.setNetworkAccessManager" ID="OpenSearchEngine.setNetworkAccessManager"></a> 642 <a NAME="OpenSearchEngine.setNetworkAccessManager" ID="OpenSearchEngine.setNetworkAccessManager"></a>
560 <h4>OpenSearchEngine.setNetworkAccessManager</h4> 643 <h4>OpenSearchEngine.setNetworkAccessManager</h4>
561 <b>setNetworkAccessManager</b>(<i>networkAccessManager</i>) 644 <b>setNetworkAccessManager</b>(<i>networkAccessManager</i>)
563 <p> 646 <p>
564 Public method to set the reference to the network access manager. 647 Public method to set the reference to the network access manager.
565 </p> 648 </p>
566 <dl> 649 <dl>
567 650
568 <dt><i>networkAccessManager</i></dt> 651 <dt><i>networkAccessManager</i> (QNetworkAccessManager)</dt>
569 <dd> 652 <dd>
570 reference to the network access manager 653 reference to the network access manager
571 object (QNetworkAccessManager) 654 object
572 </dd> 655 </dd>
573 </dl> 656 </dl>
574 <a NAME="OpenSearchEngine.setSearchMethod" ID="OpenSearchEngine.setSearchMethod"></a> 657 <a NAME="OpenSearchEngine.setSearchMethod" ID="OpenSearchEngine.setSearchMethod"></a>
575 <h4>OpenSearchEngine.setSearchMethod</h4> 658 <h4>OpenSearchEngine.setSearchMethod</h4>
576 <b>setSearchMethod</b>(<i>method</i>) 659 <b>setSearchMethod</b>(<i>method</i>)
579 Public method to set the HTTP request method used to perform search 662 Public method to set the HTTP request method used to perform search
580 requests. 663 requests.
581 </p> 664 </p>
582 <dl> 665 <dl>
583 666
584 <dt><i>method</i></dt> 667 <dt><i>method</i> (str)</dt>
585 <dd> 668 <dd>
586 HTTP request method (string) 669 HTTP request method
587 </dd> 670 </dd>
588 </dl> 671 </dl>
589 <a NAME="OpenSearchEngine.setSearchParameters" ID="OpenSearchEngine.setSearchParameters"></a> 672 <a NAME="OpenSearchEngine.setSearchParameters" ID="OpenSearchEngine.setSearchParameters"></a>
590 <h4>OpenSearchEngine.setSearchParameters</h4> 673 <h4>OpenSearchEngine.setSearchParameters</h4>
591 <b>setSearchParameters</b>(<i>searchParameters</i>) 674 <b>setSearchParameters</b>(<i>searchParameters</i>)
593 <p> 676 <p>
594 Public method to set the engine search parameters. 677 Public method to set the engine search parameters.
595 </p> 678 </p>
596 <dl> 679 <dl>
597 680
598 <dt><i>searchParameters</i></dt> 681 <dt><i>searchParameters</i> (list of [tuple, tuple])</dt>
599 <dd> 682 <dd>
600 search parameters of the engine 683 search parameters of the engine
601 (list of two tuples)
602 </dd> 684 </dd>
603 </dl> 685 </dl>
604 <a NAME="OpenSearchEngine.setSearchUrlTemplate" ID="OpenSearchEngine.setSearchUrlTemplate"></a> 686 <a NAME="OpenSearchEngine.setSearchUrlTemplate" ID="OpenSearchEngine.setSearchUrlTemplate"></a>
605 <h4>OpenSearchEngine.setSearchUrlTemplate</h4> 687 <h4>OpenSearchEngine.setSearchUrlTemplate</h4>
606 <b>setSearchUrlTemplate</b>(<i>searchUrlTemplate</i>) 688 <b>setSearchUrlTemplate</b>(<i>searchUrlTemplate</i>)
633 <td>application name, QCoreApplication::applicationName()</td></tr> 715 <td>application name, QCoreApplication::applicationName()</td></tr>
634 </table> 716 </table>
635 </p> 717 </p>
636 <dl> 718 <dl>
637 719
638 <dt><i>searchUrlTemplate</i></dt> 720 <dt><i>searchUrlTemplate</i> (str)</dt>
639 <dd> 721 <dd>
640 search URL template of the engine (string) 722 search URL template of the engine
641 </dd> 723 </dd>
642 </dl> 724 </dl>
643 <a NAME="OpenSearchEngine.setSuggestionsMethod" ID="OpenSearchEngine.setSuggestionsMethod"></a> 725 <a NAME="OpenSearchEngine.setSuggestionsMethod" ID="OpenSearchEngine.setSuggestionsMethod"></a>
644 <h4>OpenSearchEngine.setSuggestionsMethod</h4> 726 <h4>OpenSearchEngine.setSuggestionsMethod</h4>
645 <b>setSuggestionsMethod</b>(<i>method</i>) 727 <b>setSuggestionsMethod</b>(<i>method</i>)
648 Public method to set the HTTP request method used to perform 730 Public method to set the HTTP request method used to perform
649 suggestions requests. 731 suggestions requests.
650 </p> 732 </p>
651 <dl> 733 <dl>
652 734
653 <dt><i>method</i></dt> 735 <dt><i>method</i> (str)</dt>
654 <dd> 736 <dd>
655 HTTP request method (string) 737 HTTP request method
656 </dd> 738 </dd>
657 </dl> 739 </dl>
658 <a NAME="OpenSearchEngine.setSuggestionsParameters" ID="OpenSearchEngine.setSuggestionsParameters"></a> 740 <a NAME="OpenSearchEngine.setSuggestionsParameters" ID="OpenSearchEngine.setSuggestionsParameters"></a>
659 <h4>OpenSearchEngine.setSuggestionsParameters</h4> 741 <h4>OpenSearchEngine.setSuggestionsParameters</h4>
660 <b>setSuggestionsParameters</b>(<i>suggestionsParameters</i>) 742 <b>setSuggestionsParameters</b>(<i>suggestionsParameters</i>)
662 <p> 744 <p>
663 Public method to set the engine suggestions parameters. 745 Public method to set the engine suggestions parameters.
664 </p> 746 </p>
665 <dl> 747 <dl>
666 748
667 <dt><i>suggestionsParameters</i></dt> 749 <dt><i>suggestionsParameters</i> (list of [tuple, tuple])</dt>
668 <dd> 750 <dd>
669 suggestions parameters of the 751 suggestions parameters of the engine
670 engine (list of two tuples)
671 </dd> 752 </dd>
672 </dl> 753 </dl>
673 <a NAME="OpenSearchEngine.setSuggestionsUrlTemplate" ID="OpenSearchEngine.setSuggestionsUrlTemplate"></a> 754 <a NAME="OpenSearchEngine.setSuggestionsUrlTemplate" ID="OpenSearchEngine.setSuggestionsUrlTemplate"></a>
674 <h4>OpenSearchEngine.setSuggestionsUrlTemplate</h4> 755 <h4>OpenSearchEngine.setSuggestionsUrlTemplate</h4>
675 <b>setSuggestionsUrlTemplate</b>(<i>suggestionsUrlTemplate</i>) 756 <b>setSuggestionsUrlTemplate</b>(<i>suggestionsUrlTemplate</i>)
677 <p> 758 <p>
678 Public method to set the engine suggestions URL template. 759 Public method to set the engine suggestions URL template.
679 </p> 760 </p>
680 <dl> 761 <dl>
681 762
682 <dt><i>suggestionsUrlTemplate</i></dt> 763 <dt><i>suggestionsUrlTemplate</i> (str)</dt>
683 <dd> 764 <dd>
684 suggestions URL template of the 765 suggestions URL template of the
685 engine (string) 766 engine
686 </dd> 767 </dd>
687 </dl> 768 </dl>
688 <a NAME="OpenSearchEngine.suggestionsMethod" ID="OpenSearchEngine.suggestionsMethod"></a> 769 <a NAME="OpenSearchEngine.suggestionsMethod" ID="OpenSearchEngine.suggestionsMethod"></a>
689 <h4>OpenSearchEngine.suggestionsMethod</h4> 770 <h4>OpenSearchEngine.suggestionsMethod</h4>
690 <b>suggestionsMethod</b>(<i></i>) 771 <b>suggestionsMethod</b>(<i></i>)
694 suggestions requests. 775 suggestions requests.
695 </p> 776 </p>
696 <dl> 777 <dl>
697 <dt>Return:</dt> 778 <dt>Return:</dt>
698 <dd> 779 <dd>
699 HTTP request method (string) 780 HTTP request method
781 </dd>
782 </dl>
783 <dl>
784 <dt>Return Type:</dt>
785 <dd>
786 str
700 </dd> 787 </dd>
701 </dl> 788 </dl>
702 <a NAME="OpenSearchEngine.suggestionsParameters" ID="OpenSearchEngine.suggestionsParameters"></a> 789 <a NAME="OpenSearchEngine.suggestionsParameters" ID="OpenSearchEngine.suggestionsParameters"></a>
703 <h4>OpenSearchEngine.suggestionsParameters</h4> 790 <h4>OpenSearchEngine.suggestionsParameters</h4>
704 <b>suggestionsParameters</b>(<i></i>) 791 <b>suggestionsParameters</b>(<i></i>)
707 Public method to get the suggestions parameters of the engine. 794 Public method to get the suggestions parameters of the engine.
708 </p> 795 </p>
709 <dl> 796 <dl>
710 <dt>Return:</dt> 797 <dt>Return:</dt>
711 <dd> 798 <dd>
712 suggestions parameters of the engine (list of two tuples) 799 suggestions parameters of the engine
800 </dd>
801 </dl>
802 <dl>
803 <dt>Return Type:</dt>
804 <dd>
805 list of [tuple, tuple]
713 </dd> 806 </dd>
714 </dl> 807 </dl>
715 <a NAME="OpenSearchEngine.suggestionsUrl" ID="OpenSearchEngine.suggestionsUrl"></a> 808 <a NAME="OpenSearchEngine.suggestionsUrl" ID="OpenSearchEngine.suggestionsUrl"></a>
716 <h4>OpenSearchEngine.suggestionsUrl</h4> 809 <h4>OpenSearchEngine.suggestionsUrl</h4>
717 <b>suggestionsUrl</b>(<i>searchTerm</i>) 810 <b>suggestionsUrl</b>(<i>searchTerm</i>)
719 <p> 812 <p>
720 Public method to get a URL ready for suggestions. 813 Public method to get a URL ready for suggestions.
721 </p> 814 </p>
722 <dl> 815 <dl>
723 816
724 <dt><i>searchTerm</i></dt> 817 <dt><i>searchTerm</i> (str)</dt>
725 <dd> 818 <dd>
726 term to search for (string) 819 term to search for
727 </dd> 820 </dd>
728 </dl> 821 </dl>
729 <dl> 822 <dl>
730 <dt>Return:</dt> 823 <dt>Return:</dt>
731 <dd> 824 <dd>
732 URL (QUrl) 825 URL
826 </dd>
827 </dl>
828 <dl>
829 <dt>Return Type:</dt>
830 <dd>
831 QUrl
733 </dd> 832 </dd>
734 </dl> 833 </dl>
735 <a NAME="OpenSearchEngine.suggestionsUrlTemplate" ID="OpenSearchEngine.suggestionsUrlTemplate"></a> 834 <a NAME="OpenSearchEngine.suggestionsUrlTemplate" ID="OpenSearchEngine.suggestionsUrlTemplate"></a>
736 <h4>OpenSearchEngine.suggestionsUrlTemplate</h4> 835 <h4>OpenSearchEngine.suggestionsUrlTemplate</h4>
737 <b>suggestionsUrlTemplate</b>(<i></i>) 836 <b>suggestionsUrlTemplate</b>(<i></i>)
740 Public method to get the search URL template of the engine. 839 Public method to get the search URL template of the engine.
741 </p> 840 </p>
742 <dl> 841 <dl>
743 <dt>Return:</dt> 842 <dt>Return:</dt>
744 <dd> 843 <dd>
745 search URL template of the engine (string) 844 search URL template of the engine
845 </dd>
846 </dl>
847 <dl>
848 <dt>Return Type:</dt>
849 <dd>
850 str
746 </dd> 851 </dd>
747 </dl> 852 </dl>
748 <div align="right"><a href="#top">Up</a></div> 853 <div align="right"><a href="#top">Up</a></div>
749 <hr /> 854 <hr />
750 </body></html> 855 </body></html>

eric ide

mercurial