Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchManager.html
src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchManager.html
- branch
- eric7
- changeset 10436
- f6881d10e995
- parent 9209
- b99e7fd55fd3
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 10435:c712d09cc839 | 10436:f6881d10e995 |
|---|---|
| 205 <p> | 205 <p> |
| 206 Constructor | 206 Constructor |
| 207 </p> | 207 </p> |
| 208 <dl> | 208 <dl> |
| 209 | 209 |
| 210 <dt><i>parent</i></dt> | 210 <dt><i>parent</i> (QObject)</dt> |
| 211 <dd> | 211 <dd> |
| 212 reference to the parent object (QObject) | 212 reference to the parent object |
| 213 </dd> | 213 </dd> |
| 214 </dl> | 214 </dl> |
| 215 <a NAME="OpenSearchManager.__addEngineByEngine" ID="OpenSearchManager.__addEngineByEngine"></a> | 215 <a NAME="OpenSearchManager.__addEngineByEngine" ID="OpenSearchManager.__addEngineByEngine"></a> |
| 216 <h4>OpenSearchManager.__addEngineByEngine</h4> | 216 <h4>OpenSearchManager.__addEngineByEngine</h4> |
| 217 <b>__addEngineByEngine</b>(<i>engine</i>) | 217 <b>__addEngineByEngine</b>(<i>engine</i>) |
| 220 Private method to add a new search engine given a reference to an | 220 Private method to add a new search engine given a reference to an |
| 221 engine. | 221 engine. |
| 222 </p> | 222 </p> |
| 223 <dl> | 223 <dl> |
| 224 | 224 |
| 225 <dt><i>engine</i></dt> | 225 <dt><i>engine</i> (OpenSearchEngine)</dt> |
| 226 <dd> | 226 <dd> |
| 227 reference to an engine object (OpenSearchEngine) | 227 reference to an engine object |
| 228 </dd> | 228 </dd> |
| 229 </dl> | 229 </dl> |
| 230 <dl> | 230 <dl> |
| 231 <dt>Return:</dt> | 231 <dt>Return:</dt> |
| 232 <dd> | 232 <dd> |
| 233 flag indicating success (boolean) | 233 flag indicating success |
| 234 </dd> | |
| 235 </dl> | |
| 236 <dl> | |
| 237 <dt>Return Type:</dt> | |
| 238 <dd> | |
| 239 bool | |
| 234 </dd> | 240 </dd> |
| 235 </dl> | 241 </dl> |
| 236 <a NAME="OpenSearchManager.__addEngineByFile" ID="OpenSearchManager.__addEngineByFile"></a> | 242 <a NAME="OpenSearchManager.__addEngineByFile" ID="OpenSearchManager.__addEngineByFile"></a> |
| 237 <h4>OpenSearchManager.__addEngineByFile</h4> | 243 <h4>OpenSearchManager.__addEngineByFile</h4> |
| 238 <b>__addEngineByFile</b>(<i>filename</i>) | 244 <b>__addEngineByFile</b>(<i>filename</i>) |
| 240 <p> | 246 <p> |
| 241 Private method to add a new search engine given a filename. | 247 Private method to add a new search engine given a filename. |
| 242 </p> | 248 </p> |
| 243 <dl> | 249 <dl> |
| 244 | 250 |
| 245 <dt><i>filename</i></dt> | 251 <dt><i>filename</i> (str)</dt> |
| 246 <dd> | 252 <dd> |
| 247 name of a file containing the engine definition | 253 name of a file containing the engine definition |
| 248 (string) | 254 </dd> |
| 249 </dd> | 255 </dl> |
| 250 </dl> | 256 <dl> |
| 251 <dl> | 257 <dt>Return:</dt> |
| 252 <dt>Return:</dt> | 258 <dd> |
| 253 <dd> | 259 flag indicating success |
| 254 flag indicating success (boolean) | 260 </dd> |
| 261 </dl> | |
| 262 <dl> | |
| 263 <dt>Return Type:</dt> | |
| 264 <dd> | |
| 265 bool | |
| 255 </dd> | 266 </dd> |
| 256 </dl> | 267 </dl> |
| 257 <a NAME="OpenSearchManager.__addEngineByUrl" ID="OpenSearchManager.__addEngineByUrl"></a> | 268 <a NAME="OpenSearchManager.__addEngineByUrl" ID="OpenSearchManager.__addEngineByUrl"></a> |
| 258 <h4>OpenSearchManager.__addEngineByUrl</h4> | 269 <h4>OpenSearchManager.__addEngineByUrl</h4> |
| 259 <b>__addEngineByUrl</b>(<i>url</i>) | 270 <b>__addEngineByUrl</b>(<i>url</i>) |
| 261 <p> | 272 <p> |
| 262 Private method to add a new search engine given its URL. | 273 Private method to add a new search engine given its URL. |
| 263 </p> | 274 </p> |
| 264 <dl> | 275 <dl> |
| 265 | 276 |
| 266 <dt><i>url</i></dt> | 277 <dt><i>url</i> (QUrl)</dt> |
| 267 <dd> | 278 <dd> |
| 268 URL of the engine definition file (QUrl) | 279 URL of the engine definition file |
| 269 </dd> | 280 </dd> |
| 270 </dl> | 281 </dl> |
| 271 <dl> | 282 <dl> |
| 272 <dt>Return:</dt> | 283 <dt>Return:</dt> |
| 273 <dd> | 284 <dd> |
| 274 flag indicating success (boolean) | 285 flag indicating success |
| 286 </dd> | |
| 287 </dl> | |
| 288 <dl> | |
| 289 <dt>Return Type:</dt> | |
| 290 <dd> | |
| 291 bool | |
| 275 </dd> | 292 </dd> |
| 276 </dl> | 293 </dl> |
| 277 <a NAME="OpenSearchManager.__confirmAddition" ID="OpenSearchManager.__confirmAddition"></a> | 294 <a NAME="OpenSearchManager.__confirmAddition" ID="OpenSearchManager.__confirmAddition"></a> |
| 278 <h4>OpenSearchManager.__confirmAddition</h4> | 295 <h4>OpenSearchManager.__confirmAddition</h4> |
| 279 <b>__confirmAddition</b>(<i>engine</i>) | 296 <b>__confirmAddition</b>(<i>engine</i>) |
| 281 <p> | 298 <p> |
| 282 Private method to confirm the addition of a new search engine. | 299 Private method to confirm the addition of a new search engine. |
| 283 </p> | 300 </p> |
| 284 <dl> | 301 <dl> |
| 285 | 302 |
| 286 <dt><i>engine</i></dt> | 303 <dt><i>engine</i> (OpenSearchEngine)</dt> |
| 287 <dd> | 304 <dd> |
| 288 reference to the engine to be added (OpenSearchEngine) | 305 reference to the engine to be added |
| 289 </dd> | 306 </dd> |
| 290 </dl> | 307 </dl> |
| 291 <dl> | 308 <dl> |
| 292 <dt>Return:</dt> | 309 <dt>Return:</dt> |
| 293 <dd> | 310 <dd> |
| 294 flag indicating the engine shall be added (boolean) | 311 flag indicating the engine shall be added |
| 312 </dd> | |
| 313 </dl> | |
| 314 <dl> | |
| 315 <dt>Return Type:</dt> | |
| 316 <dd> | |
| 317 bool | |
| 295 </dd> | 318 </dd> |
| 296 </dl> | 319 </dl> |
| 297 <a NAME="OpenSearchManager.__engineFromUrlAvailable" ID="OpenSearchManager.__engineFromUrlAvailable"></a> | 320 <a NAME="OpenSearchManager.__engineFromUrlAvailable" ID="OpenSearchManager.__engineFromUrlAvailable"></a> |
| 298 <h4>OpenSearchManager.__engineFromUrlAvailable</h4> | 321 <h4>OpenSearchManager.__engineFromUrlAvailable</h4> |
| 299 <b>__engineFromUrlAvailable</b>(<i>reply</i>) | 322 <b>__engineFromUrlAvailable</b>(<i>reply</i>) |
| 315 <p> | 338 <p> |
| 316 Public method to add a new search engine. | 339 Public method to add a new search engine. |
| 317 </p> | 340 </p> |
| 318 <dl> | 341 <dl> |
| 319 | 342 |
| 320 <dt><i>engine</i></dt> | 343 <dt><i>engine</i> (str)</dt> |
| 321 <dd> | 344 <dd> |
| 322 URL of the engine definition file (QUrl) or | 345 URL of the engine definition file (QUrl) or |
| 323 name of a file containing the engine definition (string) | 346 name of a file containing the engine definition |
| 324 or reference to an engine object (OpenSearchEngine) | 347 or reference to an engine object (OpenSearchEngine) |
| 325 </dd> | 348 </dd> |
| 326 </dl> | 349 </dl> |
| 327 <dl> | 350 <dl> |
| 328 <dt>Return:</dt> | 351 <dt>Return:</dt> |
| 329 <dd> | 352 <dd> |
| 330 flag indicating success (boolean) | 353 flag indicating success |
| 354 </dd> | |
| 355 </dl> | |
| 356 <dl> | |
| 357 <dt>Return Type:</dt> | |
| 358 <dd> | |
| 359 bool | |
| 331 </dd> | 360 </dd> |
| 332 </dl> | 361 </dl> |
| 333 <a NAME="OpenSearchManager.addEngineFromForm" ID="OpenSearchManager.addEngineFromForm"></a> | 362 <a NAME="OpenSearchManager.addEngineFromForm" ID="OpenSearchManager.addEngineFromForm"></a> |
| 334 <h4>OpenSearchManager.addEngineFromForm</h4> | 363 <h4>OpenSearchManager.addEngineFromForm</h4> |
| 335 <b>addEngineFromForm</b>(<i>res, view</i>) | 364 <b>addEngineFromForm</b>(<i>res, view</i>) |
| 357 Public method to get a list of all engine names. | 386 Public method to get a list of all engine names. |
| 358 </p> | 387 </p> |
| 359 <dl> | 388 <dl> |
| 360 <dt>Return:</dt> | 389 <dt>Return:</dt> |
| 361 <dd> | 390 <dd> |
| 362 sorted list of all engine names (list of strings) | 391 sorted list of all engine names |
| 392 </dd> | |
| 393 </dl> | |
| 394 <dl> | |
| 395 <dt>Return Type:</dt> | |
| 396 <dd> | |
| 397 list of str | |
| 363 </dd> | 398 </dd> |
| 364 </dl> | 399 </dl> |
| 365 <a NAME="OpenSearchManager.close" ID="OpenSearchManager.close"></a> | 400 <a NAME="OpenSearchManager.close" ID="OpenSearchManager.close"></a> |
| 366 <h4>OpenSearchManager.close</h4> | 401 <h4>OpenSearchManager.close</h4> |
| 367 <b>close</b>(<i></i>) | 402 <b>close</b>(<i></i>) |
| 376 <p> | 411 <p> |
| 377 Public method to get the search URL for a keyword search. | 412 Public method to get the search URL for a keyword search. |
| 378 </p> | 413 </p> |
| 379 <dl> | 414 <dl> |
| 380 | 415 |
| 381 <dt><i>keywordSearch</i></dt> | 416 <dt><i>keywordSearch</i> (str)</dt> |
| 382 <dd> | 417 <dd> |
| 383 search string for keyword search (string) | 418 search string for keyword search |
| 384 </dd> | 419 </dd> |
| 385 </dl> | 420 </dl> |
| 386 <dl> | 421 <dl> |
| 387 <dt>Return:</dt> | 422 <dt>Return:</dt> |
| 388 <dd> | 423 <dd> |
| 389 search URL (QUrl) | 424 search URL |
| 425 </dd> | |
| 426 </dl> | |
| 427 <dl> | |
| 428 <dt>Return Type:</dt> | |
| 429 <dd> | |
| 430 QUrl | |
| 390 </dd> | 431 </dd> |
| 391 </dl> | 432 </dl> |
| 392 <a NAME="OpenSearchManager.currentEngine" ID="OpenSearchManager.currentEngine"></a> | 433 <a NAME="OpenSearchManager.currentEngine" ID="OpenSearchManager.currentEngine"></a> |
| 393 <h4>OpenSearchManager.currentEngine</h4> | 434 <h4>OpenSearchManager.currentEngine</h4> |
| 394 <b>currentEngine</b>(<i></i>) | 435 <b>currentEngine</b>(<i></i>) |
| 397 Public method to get a reference to the current engine. | 438 Public method to get a reference to the current engine. |
| 398 </p> | 439 </p> |
| 399 <dl> | 440 <dl> |
| 400 <dt>Return:</dt> | 441 <dt>Return:</dt> |
| 401 <dd> | 442 <dd> |
| 402 reference to the current engine (OpenSearchEngine) | 443 reference to the current engine |
| 444 </dd> | |
| 445 </dl> | |
| 446 <dl> | |
| 447 <dt>Return Type:</dt> | |
| 448 <dd> | |
| 449 OpenSearchEngine | |
| 403 </dd> | 450 </dd> |
| 404 </dl> | 451 </dl> |
| 405 <a NAME="OpenSearchManager.currentEngineName" ID="OpenSearchManager.currentEngineName"></a> | 452 <a NAME="OpenSearchManager.currentEngineName" ID="OpenSearchManager.currentEngineName"></a> |
| 406 <h4>OpenSearchManager.currentEngineName</h4> | 453 <h4>OpenSearchManager.currentEngineName</h4> |
| 407 <b>currentEngineName</b>(<i></i>) | 454 <b>currentEngineName</b>(<i></i>) |
| 410 Public method to get the name of the current search engine. | 457 Public method to get the name of the current search engine. |
| 411 </p> | 458 </p> |
| 412 <dl> | 459 <dl> |
| 413 <dt>Return:</dt> | 460 <dt>Return:</dt> |
| 414 <dd> | 461 <dd> |
| 415 name of the current search engine (string) | 462 name of the current search engine |
| 463 </dd> | |
| 464 </dl> | |
| 465 <dl> | |
| 466 <dt>Return Type:</dt> | |
| 467 <dd> | |
| 468 str | |
| 416 </dd> | 469 </dd> |
| 417 </dl> | 470 </dl> |
| 418 <a NAME="OpenSearchManager.engine" ID="OpenSearchManager.engine"></a> | 471 <a NAME="OpenSearchManager.engine" ID="OpenSearchManager.engine"></a> |
| 419 <h4>OpenSearchManager.engine</h4> | 472 <h4>OpenSearchManager.engine</h4> |
| 420 <b>engine</b>(<i>name</i>) | 473 <b>engine</b>(<i>name</i>) |
| 422 <p> | 475 <p> |
| 423 Public method to get a reference to the named engine. | 476 Public method to get a reference to the named engine. |
| 424 </p> | 477 </p> |
| 425 <dl> | 478 <dl> |
| 426 | 479 |
| 427 <dt><i>name</i></dt> | 480 <dt><i>name</i> (str)</dt> |
| 428 <dd> | 481 <dd> |
| 429 name of the engine (string) | 482 name of the engine |
| 430 </dd> | 483 </dd> |
| 431 </dl> | 484 </dl> |
| 432 <dl> | 485 <dl> |
| 433 <dt>Return:</dt> | 486 <dt>Return:</dt> |
| 434 <dd> | 487 <dd> |
| 435 reference to the engine (OpenSearchEngine) | 488 reference to the engine |
| 489 </dd> | |
| 490 </dl> | |
| 491 <dl> | |
| 492 <dt>Return Type:</dt> | |
| 493 <dd> | |
| 494 OpenSearchEngine | |
| 436 </dd> | 495 </dd> |
| 437 </dl> | 496 </dl> |
| 438 <a NAME="OpenSearchManager.engineExists" ID="OpenSearchManager.engineExists"></a> | 497 <a NAME="OpenSearchManager.engineExists" ID="OpenSearchManager.engineExists"></a> |
| 439 <h4>OpenSearchManager.engineExists</h4> | 498 <h4>OpenSearchManager.engineExists</h4> |
| 440 <b>engineExists</b>(<i>name</i>) | 499 <b>engineExists</b>(<i>name</i>) |
| 442 <p> | 501 <p> |
| 443 Public method to check, if an engine exists. | 502 Public method to check, if an engine exists. |
| 444 </p> | 503 </p> |
| 445 <dl> | 504 <dl> |
| 446 | 505 |
| 447 <dt><i>name</i></dt> | 506 <dt><i>name</i> (str)</dt> |
| 448 <dd> | 507 <dd> |
| 449 name of the engine (string) | 508 name of the engine |
| 450 </dd> | 509 </dd> |
| 451 </dl> | 510 </dl> |
| 452 <dl> | 511 <dl> |
| 453 <dt>Return:</dt> | 512 <dt>Return:</dt> |
| 454 <dd> | 513 <dd> |
| 455 flag indicating an existing engine (boolean) | 514 flag indicating an existing engine |
| 515 </dd> | |
| 516 </dl> | |
| 517 <dl> | |
| 518 <dt>Return Type:</dt> | |
| 519 <dd> | |
| 520 bool | |
| 456 </dd> | 521 </dd> |
| 457 </dl> | 522 </dl> |
| 458 <a NAME="OpenSearchManager.engineForKeyword" ID="OpenSearchManager.engineForKeyword"></a> | 523 <a NAME="OpenSearchManager.engineForKeyword" ID="OpenSearchManager.engineForKeyword"></a> |
| 459 <h4>OpenSearchManager.engineForKeyword</h4> | 524 <h4>OpenSearchManager.engineForKeyword</h4> |
| 460 <b>engineForKeyword</b>(<i>keyword</i>) | 525 <b>engineForKeyword</b>(<i>keyword</i>) |
| 462 <p> | 527 <p> |
| 463 Public method to get the engine for a keyword. | 528 Public method to get the engine for a keyword. |
| 464 </p> | 529 </p> |
| 465 <dl> | 530 <dl> |
| 466 | 531 |
| 467 <dt><i>keyword</i></dt> | 532 <dt><i>keyword</i> (str)</dt> |
| 468 <dd> | 533 <dd> |
| 469 keyword to get engine for (string) | 534 keyword to get engine for |
| 470 </dd> | 535 </dd> |
| 471 </dl> | 536 </dl> |
| 472 <dl> | 537 <dl> |
| 473 <dt>Return:</dt> | 538 <dt>Return:</dt> |
| 474 <dd> | 539 <dd> |
| 475 reference to the search engine object (OpenSearchEngine) | 540 reference to the search engine object |
| 541 </dd> | |
| 542 </dl> | |
| 543 <dl> | |
| 544 <dt>Return Type:</dt> | |
| 545 <dd> | |
| 546 OpenSearchEngine | |
| 476 </dd> | 547 </dd> |
| 477 </dl> | 548 </dl> |
| 478 <a NAME="OpenSearchManager.enginesChanged" ID="OpenSearchManager.enginesChanged"></a> | 549 <a NAME="OpenSearchManager.enginesChanged" ID="OpenSearchManager.enginesChanged"></a> |
| 479 <h4>OpenSearchManager.enginesChanged</h4> | 550 <h4>OpenSearchManager.enginesChanged</h4> |
| 480 <b>enginesChanged</b>(<i></i>) | 551 <b>enginesChanged</b>(<i></i>) |
| 491 Public method to get the number of available engines. | 562 Public method to get the number of available engines. |
| 492 </p> | 563 </p> |
| 493 <dl> | 564 <dl> |
| 494 <dt>Return:</dt> | 565 <dt>Return:</dt> |
| 495 <dd> | 566 <dd> |
| 496 number of engines (integer) | 567 number of engines |
| 568 </dd> | |
| 569 </dl> | |
| 570 <dl> | |
| 571 <dt>Return Type:</dt> | |
| 572 <dd> | |
| 573 int | |
| 497 </dd> | 574 </dd> |
| 498 </dl> | 575 </dl> |
| 499 <a NAME="OpenSearchManager.enginesDirectory" ID="OpenSearchManager.enginesDirectory"></a> | 576 <a NAME="OpenSearchManager.enginesDirectory" ID="OpenSearchManager.enginesDirectory"></a> |
| 500 <h4>OpenSearchManager.enginesDirectory</h4> | 577 <h4>OpenSearchManager.enginesDirectory</h4> |
| 501 <b>enginesDirectory</b>(<i></i>) | 578 <b>enginesDirectory</b>(<i></i>) |
| 505 descriptions. | 582 descriptions. |
| 506 </p> | 583 </p> |
| 507 <dl> | 584 <dl> |
| 508 <dt>Return:</dt> | 585 <dt>Return:</dt> |
| 509 <dd> | 586 <dd> |
| 510 directory name (string) | 587 directory name |
| 588 </dd> | |
| 589 </dl> | |
| 590 <dl> | |
| 591 <dt>Return Type:</dt> | |
| 592 <dd> | |
| 593 str | |
| 511 </dd> | 594 </dd> |
| 512 </dl> | 595 </dl> |
| 513 <a NAME="OpenSearchManager.generateEngineFileName" ID="OpenSearchManager.generateEngineFileName"></a> | 596 <a NAME="OpenSearchManager.generateEngineFileName" ID="OpenSearchManager.generateEngineFileName"></a> |
| 514 <h4>OpenSearchManager.generateEngineFileName</h4> | 597 <h4>OpenSearchManager.generateEngineFileName</h4> |
| 515 <b>generateEngineFileName</b>(<i>engineName</i>) | 598 <b>generateEngineFileName</b>(<i>engineName</i>) |
| 517 <p> | 600 <p> |
| 518 Public method to generate a valid engine file name. | 601 Public method to generate a valid engine file name. |
| 519 </p> | 602 </p> |
| 520 <dl> | 603 <dl> |
| 521 | 604 |
| 522 <dt><i>engineName</i></dt> | 605 <dt><i>engineName</i> (str)</dt> |
| 523 <dd> | 606 <dd> |
| 524 name of the engine (string) | 607 name of the engine |
| 525 </dd> | 608 </dd> |
| 526 </dl> | 609 </dl> |
| 527 <dl> | 610 <dl> |
| 528 <dt>Return:</dt> | 611 <dt>Return:</dt> |
| 529 <dd> | 612 <dd> |
| 530 valid engine file name (string) | 613 valid engine file name |
| 614 </dd> | |
| 615 </dl> | |
| 616 <dl> | |
| 617 <dt>Return Type:</dt> | |
| 618 <dd> | |
| 619 str | |
| 531 </dd> | 620 </dd> |
| 532 </dl> | 621 </dl> |
| 533 <a NAME="OpenSearchManager.keywordsForEngine" ID="OpenSearchManager.keywordsForEngine"></a> | 622 <a NAME="OpenSearchManager.keywordsForEngine" ID="OpenSearchManager.keywordsForEngine"></a> |
| 534 <h4>OpenSearchManager.keywordsForEngine</h4> | 623 <h4>OpenSearchManager.keywordsForEngine</h4> |
| 535 <b>keywordsForEngine</b>(<i>engine</i>) | 624 <b>keywordsForEngine</b>(<i>engine</i>) |
| 537 <p> | 626 <p> |
| 538 Public method to get the keywords for a given engine. | 627 Public method to get the keywords for a given engine. |
| 539 </p> | 628 </p> |
| 540 <dl> | 629 <dl> |
| 541 | 630 |
| 542 <dt><i>engine</i></dt> | 631 <dt><i>engine</i> (OpenSearchEngine)</dt> |
| 543 <dd> | 632 <dd> |
| 544 reference to the search engine object (OpenSearchEngine) | 633 reference to the search engine object |
| 545 </dd> | 634 </dd> |
| 546 </dl> | 635 </dl> |
| 547 <dl> | 636 <dl> |
| 548 <dt>Return:</dt> | 637 <dt>Return:</dt> |
| 549 <dd> | 638 <dd> |
| 550 list of keywords (list of strings) | 639 list of keywords |
| 640 </dd> | |
| 641 </dl> | |
| 642 <dl> | |
| 643 <dt>Return Type:</dt> | |
| 644 <dd> | |
| 645 list of str | |
| 551 </dd> | 646 </dd> |
| 552 </dl> | 647 </dl> |
| 553 <a NAME="OpenSearchManager.load" ID="OpenSearchManager.load"></a> | 648 <a NAME="OpenSearchManager.load" ID="OpenSearchManager.load"></a> |
| 554 <h4>OpenSearchManager.load</h4> | 649 <h4>OpenSearchManager.load</h4> |
| 555 <b>load</b>(<i></i>) | 650 <b>load</b>(<i></i>) |
| 564 <p> | 659 <p> |
| 565 Public method to load the search engine definitions from files. | 660 Public method to load the search engine definitions from files. |
| 566 </p> | 661 </p> |
| 567 <dl> | 662 <dl> |
| 568 | 663 |
| 569 <dt><i>dirName</i></dt> | 664 <dt><i>dirName</i> (str)</dt> |
| 570 <dd> | 665 <dd> |
| 571 name of the directory to load the files from (string) | 666 name of the directory to load the files from |
| 572 </dd> | 667 </dd> |
| 573 </dl> | 668 </dl> |
| 574 <dl> | 669 <dl> |
| 575 <dt>Return:</dt> | 670 <dt>Return:</dt> |
| 576 <dd> | 671 <dd> |
| 577 flag indicating success (boolean) | 672 flag indicating success |
| 673 </dd> | |
| 674 </dl> | |
| 675 <dl> | |
| 676 <dt>Return Type:</dt> | |
| 677 <dd> | |
| 678 bool | |
| 578 </dd> | 679 </dd> |
| 579 </dl> | 680 </dl> |
| 580 <a NAME="OpenSearchManager.removeEngine" ID="OpenSearchManager.removeEngine"></a> | 681 <a NAME="OpenSearchManager.removeEngine" ID="OpenSearchManager.removeEngine"></a> |
| 581 <h4>OpenSearchManager.removeEngine</h4> | 682 <h4>OpenSearchManager.removeEngine</h4> |
| 582 <b>removeEngine</b>(<i>name</i>) | 683 <b>removeEngine</b>(<i>name</i>) |
| 584 <p> | 685 <p> |
| 585 Public method to remove an engine. | 686 Public method to remove an engine. |
| 586 </p> | 687 </p> |
| 587 <dl> | 688 <dl> |
| 588 | 689 |
| 589 <dt><i>name</i></dt> | 690 <dt><i>name</i> (str)</dt> |
| 590 <dd> | 691 <dd> |
| 591 name of the engine (string) | 692 name of the engine |
| 592 </dd> | 693 </dd> |
| 593 </dl> | 694 </dl> |
| 594 <a NAME="OpenSearchManager.restoreDefaults" ID="OpenSearchManager.restoreDefaults"></a> | 695 <a NAME="OpenSearchManager.restoreDefaults" ID="OpenSearchManager.restoreDefaults"></a> |
| 595 <h4>OpenSearchManager.restoreDefaults</h4> | 696 <h4>OpenSearchManager.restoreDefaults</h4> |
| 596 <b>restoreDefaults</b>(<i></i>) | 697 <b>restoreDefaults</b>(<i></i>) |
| 612 <p> | 713 <p> |
| 613 Public method to save the search engine definitions to files. | 714 Public method to save the search engine definitions to files. |
| 614 </p> | 715 </p> |
| 615 <dl> | 716 <dl> |
| 616 | 717 |
| 617 <dt><i>dirName</i></dt> | 718 <dt><i>dirName</i> (str)</dt> |
| 618 <dd> | 719 <dd> |
| 619 name of the directory to write the files to (string) | 720 name of the directory to write the files to |
| 620 </dd> | 721 </dd> |
| 621 </dl> | 722 </dl> |
| 622 <a NAME="OpenSearchManager.setCurrentEngine" ID="OpenSearchManager.setCurrentEngine"></a> | 723 <a NAME="OpenSearchManager.setCurrentEngine" ID="OpenSearchManager.setCurrentEngine"></a> |
| 623 <h4>OpenSearchManager.setCurrentEngine</h4> | 724 <h4>OpenSearchManager.setCurrentEngine</h4> |
| 624 <b>setCurrentEngine</b>(<i>engine</i>) | 725 <b>setCurrentEngine</b>(<i>engine</i>) |
| 626 <p> | 727 <p> |
| 627 Public method to set the current engine. | 728 Public method to set the current engine. |
| 628 </p> | 729 </p> |
| 629 <dl> | 730 <dl> |
| 630 | 731 |
| 631 <dt><i>engine</i></dt> | 732 <dt><i>engine</i> (OpenSearchEngine)</dt> |
| 632 <dd> | 733 <dd> |
| 633 reference to the new current engine (OpenSearchEngine) | 734 reference to the new current engine |
| 634 </dd> | 735 </dd> |
| 635 </dl> | 736 </dl> |
| 636 <a NAME="OpenSearchManager.setCurrentEngineName" ID="OpenSearchManager.setCurrentEngineName"></a> | 737 <a NAME="OpenSearchManager.setCurrentEngineName" ID="OpenSearchManager.setCurrentEngineName"></a> |
| 637 <h4>OpenSearchManager.setCurrentEngineName</h4> | 738 <h4>OpenSearchManager.setCurrentEngineName</h4> |
| 638 <b>setCurrentEngineName</b>(<i>name</i>) | 739 <b>setCurrentEngineName</b>(<i>name</i>) |
| 640 <p> | 741 <p> |
| 641 Public method to set the current engine by name. | 742 Public method to set the current engine by name. |
| 642 </p> | 743 </p> |
| 643 <dl> | 744 <dl> |
| 644 | 745 |
| 645 <dt><i>name</i></dt> | 746 <dt><i>name</i> (str)</dt> |
| 646 <dd> | 747 <dd> |
| 647 name of the new current engine (string) | 748 name of the new current engine |
| 648 </dd> | 749 </dd> |
| 649 </dl> | 750 </dl> |
| 650 <a NAME="OpenSearchManager.setEngineForKeyword" ID="OpenSearchManager.setEngineForKeyword"></a> | 751 <a NAME="OpenSearchManager.setEngineForKeyword" ID="OpenSearchManager.setEngineForKeyword"></a> |
| 651 <h4>OpenSearchManager.setEngineForKeyword</h4> | 752 <h4>OpenSearchManager.setEngineForKeyword</h4> |
| 652 <b>setEngineForKeyword</b>(<i>keyword, engine</i>) | 753 <b>setEngineForKeyword</b>(<i>keyword, engine</i>) |
| 654 <p> | 755 <p> |
| 655 Public method to set the engine for a keyword. | 756 Public method to set the engine for a keyword. |
| 656 </p> | 757 </p> |
| 657 <dl> | 758 <dl> |
| 658 | 759 |
| 659 <dt><i>keyword</i></dt> | 760 <dt><i>keyword</i> (str)</dt> |
| 660 <dd> | 761 <dd> |
| 661 keyword to get engine for (string) | 762 keyword to get engine for |
| 662 </dd> | 763 </dd> |
| 663 <dt><i>engine</i></dt> | 764 <dt><i>engine</i> (OpenSearchEngine)</dt> |
| 664 <dd> | 765 <dd> |
| 665 reference to the search engine object (OpenSearchEngine) | 766 reference to the search engine object or None to |
| 666 or None to remove the keyword | 767 remove the keyword |
| 667 </dd> | 768 </dd> |
| 668 </dl> | 769 </dl> |
| 669 <a NAME="OpenSearchManager.setKeywordsForEngine" ID="OpenSearchManager.setKeywordsForEngine"></a> | 770 <a NAME="OpenSearchManager.setKeywordsForEngine" ID="OpenSearchManager.setKeywordsForEngine"></a> |
| 670 <h4>OpenSearchManager.setKeywordsForEngine</h4> | 771 <h4>OpenSearchManager.setKeywordsForEngine</h4> |
| 671 <b>setKeywordsForEngine</b>(<i>engine, keywords</i>) | 772 <b>setKeywordsForEngine</b>(<i>engine, keywords</i>) |
| 673 <p> | 774 <p> |
| 674 Public method to set the keywords for an engine. | 775 Public method to set the keywords for an engine. |
| 675 </p> | 776 </p> |
| 676 <dl> | 777 <dl> |
| 677 | 778 |
| 678 <dt><i>engine</i></dt> | 779 <dt><i>engine</i> (OpenSearchEngine)</dt> |
| 679 <dd> | 780 <dd> |
| 680 reference to the search engine object (OpenSearchEngine) | 781 reference to the search engine object |
| 681 </dd> | 782 </dd> |
| 682 <dt><i>keywords</i></dt> | 783 <dt><i>keywords</i> (list of str)</dt> |
| 683 <dd> | 784 <dd> |
| 684 list of keywords (list of strings) | 785 list of keywords |
| 685 </dd> | 786 </dd> |
| 686 </dl> | 787 </dl> |
| 687 <div align="right"><a href="#top">Up</a></div> | 788 <div align="right"><a href="#top">Up</a></div> |
| 688 <hr /> | 789 <hr /> |
| 689 </body></html> | 790 </body></html> |
