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 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.OpenSearchManager</h1> | 9 <h1>eric7.WebBrowser.OpenSearch.OpenSearchManager</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing a manager for open search engines. | 11 Module implementing a manager for open search engines. |
| 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="#OpenSearchManager">OpenSearchManager</a></td> | 22 <td><a href="#OpenSearchManager">OpenSearchManager</a></td> |
| 25 <td>Class implementing a manager for open search engines.</td> | 23 <td>Class implementing a manager for open search engines.</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="OpenSearchManager" ID="OpenSearchManager"></a> | 34 <a NAME="OpenSearchManager" ID="OpenSearchManager"></a> |
| 36 <h2>OpenSearchManager</h2> | 35 <h2>OpenSearchManager</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing a manager for open search engines. | 37 Class implementing a manager for open search engines. |
| 40 </p> | 38 </p> |
| 39 | |
| 41 <h3>Signals</h3> | 40 <h3>Signals</h3> |
| 42 <dl> | 41 <dl> |
| 43 | 42 |
| 44 <dt>changed()</dt> | 43 <dt>changed()</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 <tr><td>None</td></tr> | 62 <tr><td>None</td></tr> |
| 65 </table> | 63 </table> |
| 64 | |
| 66 <h3>Methods</h3> | 65 <h3>Methods</h3> |
| 67 | |
| 68 <table> | 66 <table> |
| 69 | |
| 70 <tr> | 67 <tr> |
| 71 <td><a href="#OpenSearchManager.__init__">OpenSearchManager</a></td> | 68 <td><a href="#OpenSearchManager.__init__">OpenSearchManager</a></td> |
| 72 <td>Constructor</td> | 69 <td>Constructor</td> |
| 73 </tr> | 70 </tr> |
| 74 <tr> | 71 <tr> |
| 190 <tr> | 187 <tr> |
| 191 <td><a href="#OpenSearchManager.setKeywordsForEngine">setKeywordsForEngine</a></td> | 188 <td><a href="#OpenSearchManager.setKeywordsForEngine">setKeywordsForEngine</a></td> |
| 192 <td>Public method to set the keywords for an engine.</td> | 189 <td>Public method to set the keywords for an engine.</td> |
| 193 </tr> | 190 </tr> |
| 194 </table> | 191 </table> |
| 192 | |
| 195 <h3>Static Methods</h3> | 193 <h3>Static Methods</h3> |
| 196 | |
| 197 <table> | 194 <table> |
| 198 <tr><td>None</td></tr> | 195 <tr><td>None</td></tr> |
| 199 </table> | 196 </table> |
| 200 | 197 |
| 198 | |
| 201 <a NAME="OpenSearchManager.__init__" ID="OpenSearchManager.__init__"></a> | 199 <a NAME="OpenSearchManager.__init__" ID="OpenSearchManager.__init__"></a> |
| 202 <h4>OpenSearchManager (Constructor)</h4> | 200 <h4>OpenSearchManager (Constructor)</h4> |
| 203 <b>OpenSearchManager</b>(<i>parent=None</i>) | 201 <b>OpenSearchManager</b>(<i>parent=None</i>) |
| 204 | |
| 205 <p> | 202 <p> |
| 206 Constructor | 203 Constructor |
| 207 </p> | 204 </p> |
| 205 | |
| 208 <dl> | 206 <dl> |
| 209 | 207 |
| 210 <dt><i>parent</i> (QObject)</dt> | 208 <dt><i>parent</i> (QObject)</dt> |
| 211 <dd> | 209 <dd> |
| 212 reference to the parent object | 210 reference to the parent object |
| 213 </dd> | 211 </dd> |
| 214 </dl> | 212 </dl> |
| 215 <a NAME="OpenSearchManager.__addEngineByEngine" ID="OpenSearchManager.__addEngineByEngine"></a> | 213 <a NAME="OpenSearchManager.__addEngineByEngine" ID="OpenSearchManager.__addEngineByEngine"></a> |
| 216 <h4>OpenSearchManager.__addEngineByEngine</h4> | 214 <h4>OpenSearchManager.__addEngineByEngine</h4> |
| 217 <b>__addEngineByEngine</b>(<i>engine</i>) | 215 <b>__addEngineByEngine</b>(<i>engine</i>) |
| 218 | |
| 219 <p> | 216 <p> |
| 220 Private method to add a new search engine given a reference to an | 217 Private method to add a new search engine given a reference to an |
| 221 engine. | 218 engine. |
| 222 </p> | 219 </p> |
| 220 | |
| 223 <dl> | 221 <dl> |
| 224 | 222 |
| 225 <dt><i>engine</i> (OpenSearchEngine)</dt> | 223 <dt><i>engine</i> (OpenSearchEngine)</dt> |
| 226 <dd> | 224 <dd> |
| 227 reference to an engine object | 225 reference to an engine object |
| 240 </dd> | 238 </dd> |
| 241 </dl> | 239 </dl> |
| 242 <a NAME="OpenSearchManager.__addEngineByFile" ID="OpenSearchManager.__addEngineByFile"></a> | 240 <a NAME="OpenSearchManager.__addEngineByFile" ID="OpenSearchManager.__addEngineByFile"></a> |
| 243 <h4>OpenSearchManager.__addEngineByFile</h4> | 241 <h4>OpenSearchManager.__addEngineByFile</h4> |
| 244 <b>__addEngineByFile</b>(<i>filename</i>) | 242 <b>__addEngineByFile</b>(<i>filename</i>) |
| 245 | |
| 246 <p> | 243 <p> |
| 247 Private method to add a new search engine given a filename. | 244 Private method to add a new search engine given a filename. |
| 248 </p> | 245 </p> |
| 246 | |
| 249 <dl> | 247 <dl> |
| 250 | 248 |
| 251 <dt><i>filename</i> (str)</dt> | 249 <dt><i>filename</i> (str)</dt> |
| 252 <dd> | 250 <dd> |
| 253 name of a file containing the engine definition | 251 name of a file containing the engine definition |
| 266 </dd> | 264 </dd> |
| 267 </dl> | 265 </dl> |
| 268 <a NAME="OpenSearchManager.__addEngineByUrl" ID="OpenSearchManager.__addEngineByUrl"></a> | 266 <a NAME="OpenSearchManager.__addEngineByUrl" ID="OpenSearchManager.__addEngineByUrl"></a> |
| 269 <h4>OpenSearchManager.__addEngineByUrl</h4> | 267 <h4>OpenSearchManager.__addEngineByUrl</h4> |
| 270 <b>__addEngineByUrl</b>(<i>url</i>) | 268 <b>__addEngineByUrl</b>(<i>url</i>) |
| 271 | |
| 272 <p> | 269 <p> |
| 273 Private method to add a new search engine given its URL. | 270 Private method to add a new search engine given its URL. |
| 274 </p> | 271 </p> |
| 272 | |
| 275 <dl> | 273 <dl> |
| 276 | 274 |
| 277 <dt><i>url</i> (QUrl)</dt> | 275 <dt><i>url</i> (QUrl)</dt> |
| 278 <dd> | 276 <dd> |
| 279 URL of the engine definition file | 277 URL of the engine definition file |
| 292 </dd> | 290 </dd> |
| 293 </dl> | 291 </dl> |
| 294 <a NAME="OpenSearchManager.__confirmAddition" ID="OpenSearchManager.__confirmAddition"></a> | 292 <a NAME="OpenSearchManager.__confirmAddition" ID="OpenSearchManager.__confirmAddition"></a> |
| 295 <h4>OpenSearchManager.__confirmAddition</h4> | 293 <h4>OpenSearchManager.__confirmAddition</h4> |
| 296 <b>__confirmAddition</b>(<i>engine</i>) | 294 <b>__confirmAddition</b>(<i>engine</i>) |
| 297 | |
| 298 <p> | 295 <p> |
| 299 Private method to confirm the addition of a new search engine. | 296 Private method to confirm the addition of a new search engine. |
| 300 </p> | 297 </p> |
| 298 | |
| 301 <dl> | 299 <dl> |
| 302 | 300 |
| 303 <dt><i>engine</i> (OpenSearchEngine)</dt> | 301 <dt><i>engine</i> (OpenSearchEngine)</dt> |
| 304 <dd> | 302 <dd> |
| 305 reference to the engine to be added | 303 reference to the engine to be added |
| 318 </dd> | 316 </dd> |
| 319 </dl> | 317 </dl> |
| 320 <a NAME="OpenSearchManager.__engineFromUrlAvailable" ID="OpenSearchManager.__engineFromUrlAvailable"></a> | 318 <a NAME="OpenSearchManager.__engineFromUrlAvailable" ID="OpenSearchManager.__engineFromUrlAvailable"></a> |
| 321 <h4>OpenSearchManager.__engineFromUrlAvailable</h4> | 319 <h4>OpenSearchManager.__engineFromUrlAvailable</h4> |
| 322 <b>__engineFromUrlAvailable</b>(<i>reply</i>) | 320 <b>__engineFromUrlAvailable</b>(<i>reply</i>) |
| 323 | |
| 324 <p> | 321 <p> |
| 325 Private slot to add a search engine from the net. | 322 Private slot to add a search engine from the net. |
| 326 </p> | 323 </p> |
| 324 | |
| 327 <dl> | 325 <dl> |
| 328 | 326 |
| 329 <dt><i>reply</i> (QNetworkReply)</dt> | 327 <dt><i>reply</i> (QNetworkReply)</dt> |
| 330 <dd> | 328 <dd> |
| 331 reference to the network reply | 329 reference to the network reply |
| 332 </dd> | 330 </dd> |
| 333 </dl> | 331 </dl> |
| 334 <a NAME="OpenSearchManager.addEngine" ID="OpenSearchManager.addEngine"></a> | 332 <a NAME="OpenSearchManager.addEngine" ID="OpenSearchManager.addEngine"></a> |
| 335 <h4>OpenSearchManager.addEngine</h4> | 333 <h4>OpenSearchManager.addEngine</h4> |
| 336 <b>addEngine</b>(<i>engine</i>) | 334 <b>addEngine</b>(<i>engine</i>) |
| 337 | |
| 338 <p> | 335 <p> |
| 339 Public method to add a new search engine. | 336 Public method to add a new search engine. |
| 340 </p> | 337 </p> |
| 338 | |
| 341 <dl> | 339 <dl> |
| 342 | 340 |
| 343 <dt><i>engine</i> (str)</dt> | 341 <dt><i>engine</i> (str)</dt> |
| 344 <dd> | 342 <dd> |
| 345 URL of the engine definition file (QUrl) or | 343 URL of the engine definition file (QUrl) or |
| 360 </dd> | 358 </dd> |
| 361 </dl> | 359 </dl> |
| 362 <a NAME="OpenSearchManager.addEngineFromForm" ID="OpenSearchManager.addEngineFromForm"></a> | 360 <a NAME="OpenSearchManager.addEngineFromForm" ID="OpenSearchManager.addEngineFromForm"></a> |
| 363 <h4>OpenSearchManager.addEngineFromForm</h4> | 361 <h4>OpenSearchManager.addEngineFromForm</h4> |
| 364 <b>addEngineFromForm</b>(<i>res, view</i>) | 362 <b>addEngineFromForm</b>(<i>res, view</i>) |
| 365 | |
| 366 <p> | 363 <p> |
| 367 Public method to add a new search engine from a form. | 364 Public method to add a new search engine from a form. |
| 368 </p> | 365 </p> |
| 366 | |
| 369 <dl> | 367 <dl> |
| 370 | 368 |
| 371 <dt><i>res</i> (dict or None)</dt> | 369 <dt><i>res</i> (dict or None)</dt> |
| 372 <dd> | 370 <dd> |
| 373 result of the JavaScript run on by | 371 result of the JavaScript run on by |
| 379 </dd> | 377 </dd> |
| 380 </dl> | 378 </dl> |
| 381 <a NAME="OpenSearchManager.allEnginesNames" ID="OpenSearchManager.allEnginesNames"></a> | 379 <a NAME="OpenSearchManager.allEnginesNames" ID="OpenSearchManager.allEnginesNames"></a> |
| 382 <h4>OpenSearchManager.allEnginesNames</h4> | 380 <h4>OpenSearchManager.allEnginesNames</h4> |
| 383 <b>allEnginesNames</b>(<i></i>) | 381 <b>allEnginesNames</b>(<i></i>) |
| 384 | |
| 385 <p> | 382 <p> |
| 386 Public method to get a list of all engine names. | 383 Public method to get a list of all engine names. |
| 387 </p> | 384 </p> |
| 385 | |
| 388 <dl> | 386 <dl> |
| 389 <dt>Return:</dt> | 387 <dt>Return:</dt> |
| 390 <dd> | 388 <dd> |
| 391 sorted list of all engine names | 389 sorted list of all engine names |
| 392 </dd> | 390 </dd> |
| 398 </dd> | 396 </dd> |
| 399 </dl> | 397 </dl> |
| 400 <a NAME="OpenSearchManager.close" ID="OpenSearchManager.close"></a> | 398 <a NAME="OpenSearchManager.close" ID="OpenSearchManager.close"></a> |
| 401 <h4>OpenSearchManager.close</h4> | 399 <h4>OpenSearchManager.close</h4> |
| 402 <b>close</b>(<i></i>) | 400 <b>close</b>(<i></i>) |
| 403 | |
| 404 <p> | 401 <p> |
| 405 Public method to close the open search engines manager. | 402 Public method to close the open search engines manager. |
| 406 </p> | 403 </p> |
| 404 | |
| 407 <a NAME="OpenSearchManager.convertKeywordSearchToUrl" ID="OpenSearchManager.convertKeywordSearchToUrl"></a> | 405 <a NAME="OpenSearchManager.convertKeywordSearchToUrl" ID="OpenSearchManager.convertKeywordSearchToUrl"></a> |
| 408 <h4>OpenSearchManager.convertKeywordSearchToUrl</h4> | 406 <h4>OpenSearchManager.convertKeywordSearchToUrl</h4> |
| 409 <b>convertKeywordSearchToUrl</b>(<i>keywordSearch</i>) | 407 <b>convertKeywordSearchToUrl</b>(<i>keywordSearch</i>) |
| 410 | |
| 411 <p> | 408 <p> |
| 412 Public method to get the search URL for a keyword search. | 409 Public method to get the search URL for a keyword search. |
| 413 </p> | 410 </p> |
| 411 | |
| 414 <dl> | 412 <dl> |
| 415 | 413 |
| 416 <dt><i>keywordSearch</i> (str)</dt> | 414 <dt><i>keywordSearch</i> (str)</dt> |
| 417 <dd> | 415 <dd> |
| 418 search string for keyword search | 416 search string for keyword search |
| 431 </dd> | 429 </dd> |
| 432 </dl> | 430 </dl> |
| 433 <a NAME="OpenSearchManager.currentEngine" ID="OpenSearchManager.currentEngine"></a> | 431 <a NAME="OpenSearchManager.currentEngine" ID="OpenSearchManager.currentEngine"></a> |
| 434 <h4>OpenSearchManager.currentEngine</h4> | 432 <h4>OpenSearchManager.currentEngine</h4> |
| 435 <b>currentEngine</b>(<i></i>) | 433 <b>currentEngine</b>(<i></i>) |
| 436 | |
| 437 <p> | 434 <p> |
| 438 Public method to get a reference to the current engine. | 435 Public method to get a reference to the current engine. |
| 439 </p> | 436 </p> |
| 437 | |
| 440 <dl> | 438 <dl> |
| 441 <dt>Return:</dt> | 439 <dt>Return:</dt> |
| 442 <dd> | 440 <dd> |
| 443 reference to the current engine | 441 reference to the current engine |
| 444 </dd> | 442 </dd> |
| 450 </dd> | 448 </dd> |
| 451 </dl> | 449 </dl> |
| 452 <a NAME="OpenSearchManager.currentEngineName" ID="OpenSearchManager.currentEngineName"></a> | 450 <a NAME="OpenSearchManager.currentEngineName" ID="OpenSearchManager.currentEngineName"></a> |
| 453 <h4>OpenSearchManager.currentEngineName</h4> | 451 <h4>OpenSearchManager.currentEngineName</h4> |
| 454 <b>currentEngineName</b>(<i></i>) | 452 <b>currentEngineName</b>(<i></i>) |
| 455 | |
| 456 <p> | 453 <p> |
| 457 Public method to get the name of the current search engine. | 454 Public method to get the name of the current search engine. |
| 458 </p> | 455 </p> |
| 456 | |
| 459 <dl> | 457 <dl> |
| 460 <dt>Return:</dt> | 458 <dt>Return:</dt> |
| 461 <dd> | 459 <dd> |
| 462 name of the current search engine | 460 name of the current search engine |
| 463 </dd> | 461 </dd> |
| 469 </dd> | 467 </dd> |
| 470 </dl> | 468 </dl> |
| 471 <a NAME="OpenSearchManager.engine" ID="OpenSearchManager.engine"></a> | 469 <a NAME="OpenSearchManager.engine" ID="OpenSearchManager.engine"></a> |
| 472 <h4>OpenSearchManager.engine</h4> | 470 <h4>OpenSearchManager.engine</h4> |
| 473 <b>engine</b>(<i>name</i>) | 471 <b>engine</b>(<i>name</i>) |
| 474 | |
| 475 <p> | 472 <p> |
| 476 Public method to get a reference to the named engine. | 473 Public method to get a reference to the named engine. |
| 477 </p> | 474 </p> |
| 475 | |
| 478 <dl> | 476 <dl> |
| 479 | 477 |
| 480 <dt><i>name</i> (str)</dt> | 478 <dt><i>name</i> (str)</dt> |
| 481 <dd> | 479 <dd> |
| 482 name of the engine | 480 name of the engine |
| 495 </dd> | 493 </dd> |
| 496 </dl> | 494 </dl> |
| 497 <a NAME="OpenSearchManager.engineExists" ID="OpenSearchManager.engineExists"></a> | 495 <a NAME="OpenSearchManager.engineExists" ID="OpenSearchManager.engineExists"></a> |
| 498 <h4>OpenSearchManager.engineExists</h4> | 496 <h4>OpenSearchManager.engineExists</h4> |
| 499 <b>engineExists</b>(<i>name</i>) | 497 <b>engineExists</b>(<i>name</i>) |
| 500 | |
| 501 <p> | 498 <p> |
| 502 Public method to check, if an engine exists. | 499 Public method to check, if an engine exists. |
| 503 </p> | 500 </p> |
| 501 | |
| 504 <dl> | 502 <dl> |
| 505 | 503 |
| 506 <dt><i>name</i> (str)</dt> | 504 <dt><i>name</i> (str)</dt> |
| 507 <dd> | 505 <dd> |
| 508 name of the engine | 506 name of the engine |
| 521 </dd> | 519 </dd> |
| 522 </dl> | 520 </dl> |
| 523 <a NAME="OpenSearchManager.engineForKeyword" ID="OpenSearchManager.engineForKeyword"></a> | 521 <a NAME="OpenSearchManager.engineForKeyword" ID="OpenSearchManager.engineForKeyword"></a> |
| 524 <h4>OpenSearchManager.engineForKeyword</h4> | 522 <h4>OpenSearchManager.engineForKeyword</h4> |
| 525 <b>engineForKeyword</b>(<i>keyword</i>) | 523 <b>engineForKeyword</b>(<i>keyword</i>) |
| 526 | |
| 527 <p> | 524 <p> |
| 528 Public method to get the engine for a keyword. | 525 Public method to get the engine for a keyword. |
| 529 </p> | 526 </p> |
| 527 | |
| 530 <dl> | 528 <dl> |
| 531 | 529 |
| 532 <dt><i>keyword</i> (str)</dt> | 530 <dt><i>keyword</i> (str)</dt> |
| 533 <dd> | 531 <dd> |
| 534 keyword to get engine for | 532 keyword to get engine for |
| 547 </dd> | 545 </dd> |
| 548 </dl> | 546 </dl> |
| 549 <a NAME="OpenSearchManager.enginesChanged" ID="OpenSearchManager.enginesChanged"></a> | 547 <a NAME="OpenSearchManager.enginesChanged" ID="OpenSearchManager.enginesChanged"></a> |
| 550 <h4>OpenSearchManager.enginesChanged</h4> | 548 <h4>OpenSearchManager.enginesChanged</h4> |
| 551 <b>enginesChanged</b>(<i></i>) | 549 <b>enginesChanged</b>(<i></i>) |
| 552 | |
| 553 <p> | 550 <p> |
| 554 Public slot to tell the search engine manager, that something has | 551 Public slot to tell the search engine manager, that something has |
| 555 changed. | 552 changed. |
| 556 </p> | 553 </p> |
| 554 | |
| 557 <a NAME="OpenSearchManager.enginesCount" ID="OpenSearchManager.enginesCount"></a> | 555 <a NAME="OpenSearchManager.enginesCount" ID="OpenSearchManager.enginesCount"></a> |
| 558 <h4>OpenSearchManager.enginesCount</h4> | 556 <h4>OpenSearchManager.enginesCount</h4> |
| 559 <b>enginesCount</b>(<i></i>) | 557 <b>enginesCount</b>(<i></i>) |
| 560 | |
| 561 <p> | 558 <p> |
| 562 Public method to get the number of available engines. | 559 Public method to get the number of available engines. |
| 563 </p> | 560 </p> |
| 561 | |
| 564 <dl> | 562 <dl> |
| 565 <dt>Return:</dt> | 563 <dt>Return:</dt> |
| 566 <dd> | 564 <dd> |
| 567 number of engines | 565 number of engines |
| 568 </dd> | 566 </dd> |
| 574 </dd> | 572 </dd> |
| 575 </dl> | 573 </dl> |
| 576 <a NAME="OpenSearchManager.enginesDirectory" ID="OpenSearchManager.enginesDirectory"></a> | 574 <a NAME="OpenSearchManager.enginesDirectory" ID="OpenSearchManager.enginesDirectory"></a> |
| 577 <h4>OpenSearchManager.enginesDirectory</h4> | 575 <h4>OpenSearchManager.enginesDirectory</h4> |
| 578 <b>enginesDirectory</b>(<i></i>) | 576 <b>enginesDirectory</b>(<i></i>) |
| 579 | |
| 580 <p> | 577 <p> |
| 581 Public method to determine the directory containing the search engine | 578 Public method to determine the directory containing the search engine |
| 582 descriptions. | 579 descriptions. |
| 583 </p> | 580 </p> |
| 581 | |
| 584 <dl> | 582 <dl> |
| 585 <dt>Return:</dt> | 583 <dt>Return:</dt> |
| 586 <dd> | 584 <dd> |
| 587 directory name | 585 directory name |
| 588 </dd> | 586 </dd> |
| 594 </dd> | 592 </dd> |
| 595 </dl> | 593 </dl> |
| 596 <a NAME="OpenSearchManager.generateEngineFileName" ID="OpenSearchManager.generateEngineFileName"></a> | 594 <a NAME="OpenSearchManager.generateEngineFileName" ID="OpenSearchManager.generateEngineFileName"></a> |
| 597 <h4>OpenSearchManager.generateEngineFileName</h4> | 595 <h4>OpenSearchManager.generateEngineFileName</h4> |
| 598 <b>generateEngineFileName</b>(<i>engineName</i>) | 596 <b>generateEngineFileName</b>(<i>engineName</i>) |
| 599 | |
| 600 <p> | 597 <p> |
| 601 Public method to generate a valid engine file name. | 598 Public method to generate a valid engine file name. |
| 602 </p> | 599 </p> |
| 600 | |
| 603 <dl> | 601 <dl> |
| 604 | 602 |
| 605 <dt><i>engineName</i> (str)</dt> | 603 <dt><i>engineName</i> (str)</dt> |
| 606 <dd> | 604 <dd> |
| 607 name of the engine | 605 name of the engine |
| 620 </dd> | 618 </dd> |
| 621 </dl> | 619 </dl> |
| 622 <a NAME="OpenSearchManager.keywordsForEngine" ID="OpenSearchManager.keywordsForEngine"></a> | 620 <a NAME="OpenSearchManager.keywordsForEngine" ID="OpenSearchManager.keywordsForEngine"></a> |
| 623 <h4>OpenSearchManager.keywordsForEngine</h4> | 621 <h4>OpenSearchManager.keywordsForEngine</h4> |
| 624 <b>keywordsForEngine</b>(<i>engine</i>) | 622 <b>keywordsForEngine</b>(<i>engine</i>) |
| 625 | |
| 626 <p> | 623 <p> |
| 627 Public method to get the keywords for a given engine. | 624 Public method to get the keywords for a given engine. |
| 628 </p> | 625 </p> |
| 626 | |
| 629 <dl> | 627 <dl> |
| 630 | 628 |
| 631 <dt><i>engine</i> (OpenSearchEngine)</dt> | 629 <dt><i>engine</i> (OpenSearchEngine)</dt> |
| 632 <dd> | 630 <dd> |
| 633 reference to the search engine object | 631 reference to the search engine object |
| 646 </dd> | 644 </dd> |
| 647 </dl> | 645 </dl> |
| 648 <a NAME="OpenSearchManager.load" ID="OpenSearchManager.load"></a> | 646 <a NAME="OpenSearchManager.load" ID="OpenSearchManager.load"></a> |
| 649 <h4>OpenSearchManager.load</h4> | 647 <h4>OpenSearchManager.load</h4> |
| 650 <b>load</b>(<i></i>) | 648 <b>load</b>(<i></i>) |
| 651 | |
| 652 <p> | 649 <p> |
| 653 Public method to load the search engines configuration. | 650 Public method to load the search engines configuration. |
| 654 </p> | 651 </p> |
| 652 | |
| 655 <a NAME="OpenSearchManager.loadDirectory" ID="OpenSearchManager.loadDirectory"></a> | 653 <a NAME="OpenSearchManager.loadDirectory" ID="OpenSearchManager.loadDirectory"></a> |
| 656 <h4>OpenSearchManager.loadDirectory</h4> | 654 <h4>OpenSearchManager.loadDirectory</h4> |
| 657 <b>loadDirectory</b>(<i>dirName</i>) | 655 <b>loadDirectory</b>(<i>dirName</i>) |
| 658 | |
| 659 <p> | 656 <p> |
| 660 Public method to load the search engine definitions from files. | 657 Public method to load the search engine definitions from files. |
| 661 </p> | 658 </p> |
| 659 | |
| 662 <dl> | 660 <dl> |
| 663 | 661 |
| 664 <dt><i>dirName</i> (str)</dt> | 662 <dt><i>dirName</i> (str)</dt> |
| 665 <dd> | 663 <dd> |
| 666 name of the directory to load the files from | 664 name of the directory to load the files from |
| 679 </dd> | 677 </dd> |
| 680 </dl> | 678 </dl> |
| 681 <a NAME="OpenSearchManager.removeEngine" ID="OpenSearchManager.removeEngine"></a> | 679 <a NAME="OpenSearchManager.removeEngine" ID="OpenSearchManager.removeEngine"></a> |
| 682 <h4>OpenSearchManager.removeEngine</h4> | 680 <h4>OpenSearchManager.removeEngine</h4> |
| 683 <b>removeEngine</b>(<i>name</i>) | 681 <b>removeEngine</b>(<i>name</i>) |
| 684 | |
| 685 <p> | 682 <p> |
| 686 Public method to remove an engine. | 683 Public method to remove an engine. |
| 687 </p> | 684 </p> |
| 685 | |
| 688 <dl> | 686 <dl> |
| 689 | 687 |
| 690 <dt><i>name</i> (str)</dt> | 688 <dt><i>name</i> (str)</dt> |
| 691 <dd> | 689 <dd> |
| 692 name of the engine | 690 name of the engine |
| 693 </dd> | 691 </dd> |
| 694 </dl> | 692 </dl> |
| 695 <a NAME="OpenSearchManager.restoreDefaults" ID="OpenSearchManager.restoreDefaults"></a> | 693 <a NAME="OpenSearchManager.restoreDefaults" ID="OpenSearchManager.restoreDefaults"></a> |
| 696 <h4>OpenSearchManager.restoreDefaults</h4> | 694 <h4>OpenSearchManager.restoreDefaults</h4> |
| 697 <b>restoreDefaults</b>(<i></i>) | 695 <b>restoreDefaults</b>(<i></i>) |
| 698 | |
| 699 <p> | 696 <p> |
| 700 Public method to restore the default search engines. | 697 Public method to restore the default search engines. |
| 701 </p> | 698 </p> |
| 699 | |
| 702 <a NAME="OpenSearchManager.save" ID="OpenSearchManager.save"></a> | 700 <a NAME="OpenSearchManager.save" ID="OpenSearchManager.save"></a> |
| 703 <h4>OpenSearchManager.save</h4> | 701 <h4>OpenSearchManager.save</h4> |
| 704 <b>save</b>(<i></i>) | 702 <b>save</b>(<i></i>) |
| 705 | |
| 706 <p> | 703 <p> |
| 707 Public method to save the search engines configuration. | 704 Public method to save the search engines configuration. |
| 708 </p> | 705 </p> |
| 706 | |
| 709 <a NAME="OpenSearchManager.saveDirectory" ID="OpenSearchManager.saveDirectory"></a> | 707 <a NAME="OpenSearchManager.saveDirectory" ID="OpenSearchManager.saveDirectory"></a> |
| 710 <h4>OpenSearchManager.saveDirectory</h4> | 708 <h4>OpenSearchManager.saveDirectory</h4> |
| 711 <b>saveDirectory</b>(<i>dirName</i>) | 709 <b>saveDirectory</b>(<i>dirName</i>) |
| 712 | |
| 713 <p> | 710 <p> |
| 714 Public method to save the search engine definitions to files. | 711 Public method to save the search engine definitions to files. |
| 715 </p> | 712 </p> |
| 713 | |
| 716 <dl> | 714 <dl> |
| 717 | 715 |
| 718 <dt><i>dirName</i> (str)</dt> | 716 <dt><i>dirName</i> (str)</dt> |
| 719 <dd> | 717 <dd> |
| 720 name of the directory to write the files to | 718 name of the directory to write the files to |
| 721 </dd> | 719 </dd> |
| 722 </dl> | 720 </dl> |
| 723 <a NAME="OpenSearchManager.setCurrentEngine" ID="OpenSearchManager.setCurrentEngine"></a> | 721 <a NAME="OpenSearchManager.setCurrentEngine" ID="OpenSearchManager.setCurrentEngine"></a> |
| 724 <h4>OpenSearchManager.setCurrentEngine</h4> | 722 <h4>OpenSearchManager.setCurrentEngine</h4> |
| 725 <b>setCurrentEngine</b>(<i>engine</i>) | 723 <b>setCurrentEngine</b>(<i>engine</i>) |
| 726 | |
| 727 <p> | 724 <p> |
| 728 Public method to set the current engine. | 725 Public method to set the current engine. |
| 729 </p> | 726 </p> |
| 727 | |
| 730 <dl> | 728 <dl> |
| 731 | 729 |
| 732 <dt><i>engine</i> (OpenSearchEngine)</dt> | 730 <dt><i>engine</i> (OpenSearchEngine)</dt> |
| 733 <dd> | 731 <dd> |
| 734 reference to the new current engine | 732 reference to the new current engine |
| 735 </dd> | 733 </dd> |
| 736 </dl> | 734 </dl> |
| 737 <a NAME="OpenSearchManager.setCurrentEngineName" ID="OpenSearchManager.setCurrentEngineName"></a> | 735 <a NAME="OpenSearchManager.setCurrentEngineName" ID="OpenSearchManager.setCurrentEngineName"></a> |
| 738 <h4>OpenSearchManager.setCurrentEngineName</h4> | 736 <h4>OpenSearchManager.setCurrentEngineName</h4> |
| 739 <b>setCurrentEngineName</b>(<i>name</i>) | 737 <b>setCurrentEngineName</b>(<i>name</i>) |
| 740 | |
| 741 <p> | 738 <p> |
| 742 Public method to set the current engine by name. | 739 Public method to set the current engine by name. |
| 743 </p> | 740 </p> |
| 741 | |
| 744 <dl> | 742 <dl> |
| 745 | 743 |
| 746 <dt><i>name</i> (str)</dt> | 744 <dt><i>name</i> (str)</dt> |
| 747 <dd> | 745 <dd> |
| 748 name of the new current engine | 746 name of the new current engine |
| 749 </dd> | 747 </dd> |
| 750 </dl> | 748 </dl> |
| 751 <a NAME="OpenSearchManager.setEngineForKeyword" ID="OpenSearchManager.setEngineForKeyword"></a> | 749 <a NAME="OpenSearchManager.setEngineForKeyword" ID="OpenSearchManager.setEngineForKeyword"></a> |
| 752 <h4>OpenSearchManager.setEngineForKeyword</h4> | 750 <h4>OpenSearchManager.setEngineForKeyword</h4> |
| 753 <b>setEngineForKeyword</b>(<i>keyword, engine</i>) | 751 <b>setEngineForKeyword</b>(<i>keyword, engine</i>) |
| 754 | |
| 755 <p> | 752 <p> |
| 756 Public method to set the engine for a keyword. | 753 Public method to set the engine for a keyword. |
| 757 </p> | 754 </p> |
| 755 | |
| 758 <dl> | 756 <dl> |
| 759 | 757 |
| 760 <dt><i>keyword</i> (str)</dt> | 758 <dt><i>keyword</i> (str)</dt> |
| 761 <dd> | 759 <dd> |
| 762 keyword to get engine for | 760 keyword to get engine for |
| 768 </dd> | 766 </dd> |
| 769 </dl> | 767 </dl> |
| 770 <a NAME="OpenSearchManager.setKeywordsForEngine" ID="OpenSearchManager.setKeywordsForEngine"></a> | 768 <a NAME="OpenSearchManager.setKeywordsForEngine" ID="OpenSearchManager.setKeywordsForEngine"></a> |
| 771 <h4>OpenSearchManager.setKeywordsForEngine</h4> | 769 <h4>OpenSearchManager.setKeywordsForEngine</h4> |
| 772 <b>setKeywordsForEngine</b>(<i>engine, keywords</i>) | 770 <b>setKeywordsForEngine</b>(<i>engine, keywords</i>) |
| 773 | |
| 774 <p> | 771 <p> |
| 775 Public method to set the keywords for an engine. | 772 Public method to set the keywords for an engine. |
| 776 </p> | 773 </p> |
| 774 | |
| 777 <dl> | 775 <dl> |
| 778 | 776 |
| 779 <dt><i>engine</i> (OpenSearchEngine)</dt> | 777 <dt><i>engine</i> (OpenSearchEngine)</dt> |
| 780 <dd> | 778 <dd> |
| 781 reference to the search engine object | 779 reference to the search engine object |
