Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchManager.html
eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchManager.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.OpenSearch.OpenSearchManager</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.WebBrowser.OpenSearch.OpenSearchManager</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing a manager for open search engines. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 | |
| 37 <tr> | |
| 38 <td><a href="#OpenSearchManager">OpenSearchManager</a></td> | |
| 39 <td>Class implementing a manager for open search engines.</td> | |
| 40 </tr> | |
| 41 </table> | |
| 42 <h3>Functions</h3> | |
| 43 | |
| 44 <table> | |
| 45 <tr><td>None</td></tr> | |
| 46 </table> | |
| 47 <hr /> | |
| 48 <hr /> | |
| 49 <a NAME="OpenSearchManager" ID="OpenSearchManager"></a> | |
| 50 <h2>OpenSearchManager</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class implementing a manager for open search engines. | |
| 54 </p> | |
| 55 <h3>Signals</h3> | |
| 56 <dl> | |
| 57 | |
| 58 <dt>changed()</dt> | |
| 59 <dd> | |
| 60 emitted to indicate a change | |
| 61 </dd> | |
| 62 <dt>currentEngineChanged()</dt> | |
| 63 <dd> | |
| 64 emitted to indicate a change of | |
| 65 the current search engine | |
| 66 </dd> | |
| 67 </dl> | |
| 68 <h3>Derived from</h3> | |
| 69 QObject | |
| 70 <h3>Class Attributes</h3> | |
| 71 | |
| 72 <table> | |
| 73 <tr><td>None</td></tr> | |
| 74 </table> | |
| 75 <h3>Class Methods</h3> | |
| 76 | |
| 77 <table> | |
| 78 <tr><td>None</td></tr> | |
| 79 </table> | |
| 80 <h3>Methods</h3> | |
| 81 | |
| 82 <table> | |
| 83 | |
| 84 <tr> | |
| 85 <td><a href="#OpenSearchManager.__init__">OpenSearchManager</a></td> | |
| 86 <td>Constructor</td> | |
| 87 </tr> | |
| 88 <tr> | |
| 89 <td><a href="#OpenSearchManager.__addEngineByEngine">__addEngineByEngine</a></td> | |
| 90 <td>Private method to add a new search engine given a reference to an engine.</td> | |
| 91 </tr> | |
| 92 <tr> | |
| 93 <td><a href="#OpenSearchManager.__addEngineByFile">__addEngineByFile</a></td> | |
| 94 <td>Private method to add a new search engine given a filename.</td> | |
| 95 </tr> | |
| 96 <tr> | |
| 97 <td><a href="#OpenSearchManager.__addEngineByUrl">__addEngineByUrl</a></td> | |
| 98 <td>Private method to add a new search engine given its URL.</td> | |
| 99 </tr> | |
| 100 <tr> | |
| 101 <td><a href="#OpenSearchManager.__confirmAddition">__confirmAddition</a></td> | |
| 102 <td>Private method to confirm the addition of a new search engine.</td> | |
| 103 </tr> | |
| 104 <tr> | |
| 105 <td><a href="#OpenSearchManager.__engineFromUrlAvailable">__engineFromUrlAvailable</a></td> | |
| 106 <td>Private slot to add a search engine from the net.</td> | |
| 107 </tr> | |
| 108 <tr> | |
| 109 <td><a href="#OpenSearchManager.addEngine">addEngine</a></td> | |
| 110 <td>Public method to add a new search engine.</td> | |
| 111 </tr> | |
| 112 <tr> | |
| 113 <td><a href="#OpenSearchManager.addEngineFromForm">addEngineFromForm</a></td> | |
| 114 <td>Public method to add a new search engine from a form.</td> | |
| 115 </tr> | |
| 116 <tr> | |
| 117 <td><a href="#OpenSearchManager.allEnginesNames">allEnginesNames</a></td> | |
| 118 <td>Public method to get a list of all engine names.</td> | |
| 119 </tr> | |
| 120 <tr> | |
| 121 <td><a href="#OpenSearchManager.close">close</a></td> | |
| 122 <td>Public method to close the open search engines manager.</td> | |
| 123 </tr> | |
| 124 <tr> | |
| 125 <td><a href="#OpenSearchManager.convertKeywordSearchToUrl">convertKeywordSearchToUrl</a></td> | |
| 126 <td>Public method to get the search URL for a keyword search.</td> | |
| 127 </tr> | |
| 128 <tr> | |
| 129 <td><a href="#OpenSearchManager.currentEngine">currentEngine</a></td> | |
| 130 <td>Public method to get a reference to the current engine.</td> | |
| 131 </tr> | |
| 132 <tr> | |
| 133 <td><a href="#OpenSearchManager.currentEngineName">currentEngineName</a></td> | |
| 134 <td>Public method to get the name of the current search engine.</td> | |
| 135 </tr> | |
| 136 <tr> | |
| 137 <td><a href="#OpenSearchManager.engine">engine</a></td> | |
| 138 <td>Public method to get a reference to the named engine.</td> | |
| 139 </tr> | |
| 140 <tr> | |
| 141 <td><a href="#OpenSearchManager.engineExists">engineExists</a></td> | |
| 142 <td>Public method to check, if an engine exists.</td> | |
| 143 </tr> | |
| 144 <tr> | |
| 145 <td><a href="#OpenSearchManager.engineForKeyword">engineForKeyword</a></td> | |
| 146 <td>Public method to get the engine for a keyword.</td> | |
| 147 </tr> | |
| 148 <tr> | |
| 149 <td><a href="#OpenSearchManager.enginesChanged">enginesChanged</a></td> | |
| 150 <td>Public slot to tell the search engine manager, that something has changed.</td> | |
| 151 </tr> | |
| 152 <tr> | |
| 153 <td><a href="#OpenSearchManager.enginesCount">enginesCount</a></td> | |
| 154 <td>Public method to get the number of available engines.</td> | |
| 155 </tr> | |
| 156 <tr> | |
| 157 <td><a href="#OpenSearchManager.enginesDirectory">enginesDirectory</a></td> | |
| 158 <td>Public method to determine the directory containing the search engine descriptions.</td> | |
| 159 </tr> | |
| 160 <tr> | |
| 161 <td><a href="#OpenSearchManager.generateEngineFileName">generateEngineFileName</a></td> | |
| 162 <td>Public method to generate a valid engine file name.</td> | |
| 163 </tr> | |
| 164 <tr> | |
| 165 <td><a href="#OpenSearchManager.keywordsForEngine">keywordsForEngine</a></td> | |
| 166 <td>Public method to get the keywords for a given engine.</td> | |
| 167 </tr> | |
| 168 <tr> | |
| 169 <td><a href="#OpenSearchManager.load">load</a></td> | |
| 170 <td>Public method to load the search engines configuration.</td> | |
| 171 </tr> | |
| 172 <tr> | |
| 173 <td><a href="#OpenSearchManager.loadDirectory">loadDirectory</a></td> | |
| 174 <td>Public method to load the search engine definitions from files.</td> | |
| 175 </tr> | |
| 176 <tr> | |
| 177 <td><a href="#OpenSearchManager.removeEngine">removeEngine</a></td> | |
| 178 <td>Public method to remove an engine.</td> | |
| 179 </tr> | |
| 180 <tr> | |
| 181 <td><a href="#OpenSearchManager.restoreDefaults">restoreDefaults</a></td> | |
| 182 <td>Public method to restore the default search engines.</td> | |
| 183 </tr> | |
| 184 <tr> | |
| 185 <td><a href="#OpenSearchManager.save">save</a></td> | |
| 186 <td>Public method to save the search engines configuration.</td> | |
| 187 </tr> | |
| 188 <tr> | |
| 189 <td><a href="#OpenSearchManager.saveDirectory">saveDirectory</a></td> | |
| 190 <td>Public method to save the search engine definitions to files.</td> | |
| 191 </tr> | |
| 192 <tr> | |
| 193 <td><a href="#OpenSearchManager.setCurrentEngine">setCurrentEngine</a></td> | |
| 194 <td>Public method to set the current engine.</td> | |
| 195 </tr> | |
| 196 <tr> | |
| 197 <td><a href="#OpenSearchManager.setCurrentEngineName">setCurrentEngineName</a></td> | |
| 198 <td>Public method to set the current engine by name.</td> | |
| 199 </tr> | |
| 200 <tr> | |
| 201 <td><a href="#OpenSearchManager.setEngineForKeyword">setEngineForKeyword</a></td> | |
| 202 <td>Public method to set the engine for a keyword.</td> | |
| 203 </tr> | |
| 204 <tr> | |
| 205 <td><a href="#OpenSearchManager.setKeywordsForEngine">setKeywordsForEngine</a></td> | |
| 206 <td>Public method to set the keywords for an engine.</td> | |
| 207 </tr> | |
| 208 </table> | |
| 209 <h3>Static Methods</h3> | |
| 210 | |
| 211 <table> | |
| 212 <tr><td>None</td></tr> | |
| 213 </table> | |
| 214 | |
| 215 <a NAME="OpenSearchManager.__init__" ID="OpenSearchManager.__init__"></a> | |
| 216 <h4>OpenSearchManager (Constructor)</h4> | |
| 217 <b>OpenSearchManager</b>(<i>parent=None</i>) | |
| 218 | |
| 219 <p> | |
| 220 Constructor | |
| 221 </p> | |
| 222 <dl> | |
| 223 | |
| 224 <dt><i>parent</i></dt> | |
| 225 <dd> | |
| 226 reference to the parent object (QObject) | |
| 227 </dd> | |
| 228 </dl> | |
| 229 <a NAME="OpenSearchManager.__addEngineByEngine" ID="OpenSearchManager.__addEngineByEngine"></a> | |
| 230 <h4>OpenSearchManager.__addEngineByEngine</h4> | |
| 231 <b>__addEngineByEngine</b>(<i>engine</i>) | |
| 232 | |
| 233 <p> | |
| 234 Private method to add a new search engine given a reference to an | |
| 235 engine. | |
| 236 </p> | |
| 237 <dl> | |
| 238 | |
| 239 <dt><i>engine</i></dt> | |
| 240 <dd> | |
| 241 reference to an engine object (OpenSearchEngine) | |
| 242 </dd> | |
| 243 </dl> | |
| 244 <dl> | |
| 245 <dt>Return:</dt> | |
| 246 <dd> | |
| 247 flag indicating success (boolean) | |
| 248 </dd> | |
| 249 </dl> | |
| 250 <a NAME="OpenSearchManager.__addEngineByFile" ID="OpenSearchManager.__addEngineByFile"></a> | |
| 251 <h4>OpenSearchManager.__addEngineByFile</h4> | |
| 252 <b>__addEngineByFile</b>(<i>filename</i>) | |
| 253 | |
| 254 <p> | |
| 255 Private method to add a new search engine given a filename. | |
| 256 </p> | |
| 257 <dl> | |
| 258 | |
| 259 <dt><i>filename</i></dt> | |
| 260 <dd> | |
| 261 name of a file containing the engine definition | |
| 262 (string) | |
| 263 </dd> | |
| 264 </dl> | |
| 265 <dl> | |
| 266 <dt>Return:</dt> | |
| 267 <dd> | |
| 268 flag indicating success (boolean) | |
| 269 </dd> | |
| 270 </dl> | |
| 271 <a NAME="OpenSearchManager.__addEngineByUrl" ID="OpenSearchManager.__addEngineByUrl"></a> | |
| 272 <h4>OpenSearchManager.__addEngineByUrl</h4> | |
| 273 <b>__addEngineByUrl</b>(<i>url</i>) | |
| 274 | |
| 275 <p> | |
| 276 Private method to add a new search engine given its URL. | |
| 277 </p> | |
| 278 <dl> | |
| 279 | |
| 280 <dt><i>url</i></dt> | |
| 281 <dd> | |
| 282 URL of the engine definition file (QUrl) | |
| 283 </dd> | |
| 284 </dl> | |
| 285 <dl> | |
| 286 <dt>Return:</dt> | |
| 287 <dd> | |
| 288 flag indicating success (boolean) | |
| 289 </dd> | |
| 290 </dl> | |
| 291 <a NAME="OpenSearchManager.__confirmAddition" ID="OpenSearchManager.__confirmAddition"></a> | |
| 292 <h4>OpenSearchManager.__confirmAddition</h4> | |
| 293 <b>__confirmAddition</b>(<i>engine</i>) | |
| 294 | |
| 295 <p> | |
| 296 Private method to confirm the addition of a new search engine. | |
| 297 </p> | |
| 298 <dl> | |
| 299 | |
| 300 <dt><i>engine</i></dt> | |
| 301 <dd> | |
| 302 reference to the engine to be added (OpenSearchEngine) | |
| 303 </dd> | |
| 304 </dl> | |
| 305 <dl> | |
| 306 <dt>Return:</dt> | |
| 307 <dd> | |
| 308 flag indicating the engine shall be added (boolean) | |
| 309 </dd> | |
| 310 </dl> | |
| 311 <a NAME="OpenSearchManager.__engineFromUrlAvailable" ID="OpenSearchManager.__engineFromUrlAvailable"></a> | |
| 312 <h4>OpenSearchManager.__engineFromUrlAvailable</h4> | |
| 313 <b>__engineFromUrlAvailable</b>(<i>reply</i>) | |
| 314 | |
| 315 <p> | |
| 316 Private slot to add a search engine from the net. | |
| 317 </p> | |
| 318 <dl> | |
| 319 | |
| 320 <dt><i>reply</i> (QNetworkReply)</dt> | |
| 321 <dd> | |
| 322 reference to the network reply | |
| 323 </dd> | |
| 324 </dl> | |
| 325 <a NAME="OpenSearchManager.addEngine" ID="OpenSearchManager.addEngine"></a> | |
| 326 <h4>OpenSearchManager.addEngine</h4> | |
| 327 <b>addEngine</b>(<i>engine</i>) | |
| 328 | |
| 329 <p> | |
| 330 Public method to add a new search engine. | |
| 331 </p> | |
| 332 <dl> | |
| 333 | |
| 334 <dt><i>engine</i></dt> | |
| 335 <dd> | |
| 336 URL of the engine definition file (QUrl) or | |
| 337 name of a file containing the engine definition (string) | |
| 338 or reference to an engine object (OpenSearchEngine) | |
| 339 </dd> | |
| 340 </dl> | |
| 341 <dl> | |
| 342 <dt>Return:</dt> | |
| 343 <dd> | |
| 344 flag indicating success (boolean) | |
| 345 </dd> | |
| 346 </dl> | |
| 347 <a NAME="OpenSearchManager.addEngineFromForm" ID="OpenSearchManager.addEngineFromForm"></a> | |
| 348 <h4>OpenSearchManager.addEngineFromForm</h4> | |
| 349 <b>addEngineFromForm</b>(<i>res, view</i>) | |
| 350 | |
| 351 <p> | |
| 352 Public method to add a new search engine from a form. | |
| 353 </p> | |
| 354 <dl> | |
| 355 | |
| 356 <dt><i>res</i> (dict or None)</dt> | |
| 357 <dd> | |
| 358 result of the JavaScript run on by | |
| 359 WebBrowserView.__addSearchEngine() | |
| 360 </dd> | |
| 361 <dt><i>view</i> (WebBrowserView)</dt> | |
| 362 <dd> | |
| 363 reference to the web browser view | |
| 364 </dd> | |
| 365 </dl> | |
| 366 <a NAME="OpenSearchManager.allEnginesNames" ID="OpenSearchManager.allEnginesNames"></a> | |
| 367 <h4>OpenSearchManager.allEnginesNames</h4> | |
| 368 <b>allEnginesNames</b>(<i></i>) | |
| 369 | |
| 370 <p> | |
| 371 Public method to get a list of all engine names. | |
| 372 </p> | |
| 373 <dl> | |
| 374 <dt>Return:</dt> | |
| 375 <dd> | |
| 376 sorted list of all engine names (list of strings) | |
| 377 </dd> | |
| 378 </dl> | |
| 379 <a NAME="OpenSearchManager.close" ID="OpenSearchManager.close"></a> | |
| 380 <h4>OpenSearchManager.close</h4> | |
| 381 <b>close</b>(<i></i>) | |
| 382 | |
| 383 <p> | |
| 384 Public method to close the open search engines manager. | |
| 385 </p> | |
| 386 <a NAME="OpenSearchManager.convertKeywordSearchToUrl" ID="OpenSearchManager.convertKeywordSearchToUrl"></a> | |
| 387 <h4>OpenSearchManager.convertKeywordSearchToUrl</h4> | |
| 388 <b>convertKeywordSearchToUrl</b>(<i>keywordSearch</i>) | |
| 389 | |
| 390 <p> | |
| 391 Public method to get the search URL for a keyword search. | |
| 392 </p> | |
| 393 <dl> | |
| 394 | |
| 395 <dt><i>keywordSearch</i></dt> | |
| 396 <dd> | |
| 397 search string for keyword search (string) | |
| 398 </dd> | |
| 399 </dl> | |
| 400 <dl> | |
| 401 <dt>Return:</dt> | |
| 402 <dd> | |
| 403 search URL (QUrl) | |
| 404 </dd> | |
| 405 </dl> | |
| 406 <a NAME="OpenSearchManager.currentEngine" ID="OpenSearchManager.currentEngine"></a> | |
| 407 <h4>OpenSearchManager.currentEngine</h4> | |
| 408 <b>currentEngine</b>(<i></i>) | |
| 409 | |
| 410 <p> | |
| 411 Public method to get a reference to the current engine. | |
| 412 </p> | |
| 413 <dl> | |
| 414 <dt>Return:</dt> | |
| 415 <dd> | |
| 416 reference to the current engine (OpenSearchEngine) | |
| 417 </dd> | |
| 418 </dl> | |
| 419 <a NAME="OpenSearchManager.currentEngineName" ID="OpenSearchManager.currentEngineName"></a> | |
| 420 <h4>OpenSearchManager.currentEngineName</h4> | |
| 421 <b>currentEngineName</b>(<i></i>) | |
| 422 | |
| 423 <p> | |
| 424 Public method to get the name of the current search engine. | |
| 425 </p> | |
| 426 <dl> | |
| 427 <dt>Return:</dt> | |
| 428 <dd> | |
| 429 name of the current search engine (string) | |
| 430 </dd> | |
| 431 </dl> | |
| 432 <a NAME="OpenSearchManager.engine" ID="OpenSearchManager.engine"></a> | |
| 433 <h4>OpenSearchManager.engine</h4> | |
| 434 <b>engine</b>(<i>name</i>) | |
| 435 | |
| 436 <p> | |
| 437 Public method to get a reference to the named engine. | |
| 438 </p> | |
| 439 <dl> | |
| 440 | |
| 441 <dt><i>name</i></dt> | |
| 442 <dd> | |
| 443 name of the engine (string) | |
| 444 </dd> | |
| 445 </dl> | |
| 446 <dl> | |
| 447 <dt>Return:</dt> | |
| 448 <dd> | |
| 449 reference to the engine (OpenSearchEngine) | |
| 450 </dd> | |
| 451 </dl> | |
| 452 <a NAME="OpenSearchManager.engineExists" ID="OpenSearchManager.engineExists"></a> | |
| 453 <h4>OpenSearchManager.engineExists</h4> | |
| 454 <b>engineExists</b>(<i>name</i>) | |
| 455 | |
| 456 <p> | |
| 457 Public method to check, if an engine exists. | |
| 458 </p> | |
| 459 <dl> | |
| 460 | |
| 461 <dt><i>name</i></dt> | |
| 462 <dd> | |
| 463 name of the engine (string) | |
| 464 </dd> | |
| 465 </dl> | |
| 466 <dl> | |
| 467 <dt>Return:</dt> | |
| 468 <dd> | |
| 469 flag indicating an existing engine (boolean) | |
| 470 </dd> | |
| 471 </dl> | |
| 472 <a NAME="OpenSearchManager.engineForKeyword" ID="OpenSearchManager.engineForKeyword"></a> | |
| 473 <h4>OpenSearchManager.engineForKeyword</h4> | |
| 474 <b>engineForKeyword</b>(<i>keyword</i>) | |
| 475 | |
| 476 <p> | |
| 477 Public method to get the engine for a keyword. | |
| 478 </p> | |
| 479 <dl> | |
| 480 | |
| 481 <dt><i>keyword</i></dt> | |
| 482 <dd> | |
| 483 keyword to get engine for (string) | |
| 484 </dd> | |
| 485 </dl> | |
| 486 <dl> | |
| 487 <dt>Return:</dt> | |
| 488 <dd> | |
| 489 reference to the search engine object (OpenSearchEngine) | |
| 490 </dd> | |
| 491 </dl> | |
| 492 <a NAME="OpenSearchManager.enginesChanged" ID="OpenSearchManager.enginesChanged"></a> | |
| 493 <h4>OpenSearchManager.enginesChanged</h4> | |
| 494 <b>enginesChanged</b>(<i></i>) | |
| 495 | |
| 496 <p> | |
| 497 Public slot to tell the search engine manager, that something has | |
| 498 changed. | |
| 499 </p> | |
| 500 <a NAME="OpenSearchManager.enginesCount" ID="OpenSearchManager.enginesCount"></a> | |
| 501 <h4>OpenSearchManager.enginesCount</h4> | |
| 502 <b>enginesCount</b>(<i></i>) | |
| 503 | |
| 504 <p> | |
| 505 Public method to get the number of available engines. | |
| 506 </p> | |
| 507 <dl> | |
| 508 <dt>Return:</dt> | |
| 509 <dd> | |
| 510 number of engines (integer) | |
| 511 </dd> | |
| 512 </dl> | |
| 513 <a NAME="OpenSearchManager.enginesDirectory" ID="OpenSearchManager.enginesDirectory"></a> | |
| 514 <h4>OpenSearchManager.enginesDirectory</h4> | |
| 515 <b>enginesDirectory</b>(<i></i>) | |
| 516 | |
| 517 <p> | |
| 518 Public method to determine the directory containing the search engine | |
| 519 descriptions. | |
| 520 </p> | |
| 521 <dl> | |
| 522 <dt>Return:</dt> | |
| 523 <dd> | |
| 524 directory name (string) | |
| 525 </dd> | |
| 526 </dl> | |
| 527 <a NAME="OpenSearchManager.generateEngineFileName" ID="OpenSearchManager.generateEngineFileName"></a> | |
| 528 <h4>OpenSearchManager.generateEngineFileName</h4> | |
| 529 <b>generateEngineFileName</b>(<i>engineName</i>) | |
| 530 | |
| 531 <p> | |
| 532 Public method to generate a valid engine file name. | |
| 533 </p> | |
| 534 <dl> | |
| 535 | |
| 536 <dt><i>engineName</i></dt> | |
| 537 <dd> | |
| 538 name of the engine (string) | |
| 539 </dd> | |
| 540 </dl> | |
| 541 <dl> | |
| 542 <dt>Return:</dt> | |
| 543 <dd> | |
| 544 valid engine file name (string) | |
| 545 </dd> | |
| 546 </dl> | |
| 547 <a NAME="OpenSearchManager.keywordsForEngine" ID="OpenSearchManager.keywordsForEngine"></a> | |
| 548 <h4>OpenSearchManager.keywordsForEngine</h4> | |
| 549 <b>keywordsForEngine</b>(<i>engine</i>) | |
| 550 | |
| 551 <p> | |
| 552 Public method to get the keywords for a given engine. | |
| 553 </p> | |
| 554 <dl> | |
| 555 | |
| 556 <dt><i>engine</i></dt> | |
| 557 <dd> | |
| 558 reference to the search engine object (OpenSearchEngine) | |
| 559 </dd> | |
| 560 </dl> | |
| 561 <dl> | |
| 562 <dt>Return:</dt> | |
| 563 <dd> | |
| 564 list of keywords (list of strings) | |
| 565 </dd> | |
| 566 </dl> | |
| 567 <a NAME="OpenSearchManager.load" ID="OpenSearchManager.load"></a> | |
| 568 <h4>OpenSearchManager.load</h4> | |
| 569 <b>load</b>(<i></i>) | |
| 570 | |
| 571 <p> | |
| 572 Public method to load the search engines configuration. | |
| 573 </p> | |
| 574 <a NAME="OpenSearchManager.loadDirectory" ID="OpenSearchManager.loadDirectory"></a> | |
| 575 <h4>OpenSearchManager.loadDirectory</h4> | |
| 576 <b>loadDirectory</b>(<i>dirName</i>) | |
| 577 | |
| 578 <p> | |
| 579 Public method to load the search engine definitions from files. | |
| 580 </p> | |
| 581 <dl> | |
| 582 | |
| 583 <dt><i>dirName</i></dt> | |
| 584 <dd> | |
| 585 name of the directory to load the files from (string) | |
| 586 </dd> | |
| 587 </dl> | |
| 588 <dl> | |
| 589 <dt>Return:</dt> | |
| 590 <dd> | |
| 591 flag indicating success (boolean) | |
| 592 </dd> | |
| 593 </dl> | |
| 594 <a NAME="OpenSearchManager.removeEngine" ID="OpenSearchManager.removeEngine"></a> | |
| 595 <h4>OpenSearchManager.removeEngine</h4> | |
| 596 <b>removeEngine</b>(<i>name</i>) | |
| 597 | |
| 598 <p> | |
| 599 Public method to remove an engine. | |
| 600 </p> | |
| 601 <dl> | |
| 602 | |
| 603 <dt><i>name</i></dt> | |
| 604 <dd> | |
| 605 name of the engine (string) | |
| 606 </dd> | |
| 607 </dl> | |
| 608 <a NAME="OpenSearchManager.restoreDefaults" ID="OpenSearchManager.restoreDefaults"></a> | |
| 609 <h4>OpenSearchManager.restoreDefaults</h4> | |
| 610 <b>restoreDefaults</b>(<i></i>) | |
| 611 | |
| 612 <p> | |
| 613 Public method to restore the default search engines. | |
| 614 </p> | |
| 615 <a NAME="OpenSearchManager.save" ID="OpenSearchManager.save"></a> | |
| 616 <h4>OpenSearchManager.save</h4> | |
| 617 <b>save</b>(<i></i>) | |
| 618 | |
| 619 <p> | |
| 620 Public method to save the search engines configuration. | |
| 621 </p> | |
| 622 <a NAME="OpenSearchManager.saveDirectory" ID="OpenSearchManager.saveDirectory"></a> | |
| 623 <h4>OpenSearchManager.saveDirectory</h4> | |
| 624 <b>saveDirectory</b>(<i>dirName</i>) | |
| 625 | |
| 626 <p> | |
| 627 Public method to save the search engine definitions to files. | |
| 628 </p> | |
| 629 <dl> | |
| 630 | |
| 631 <dt><i>dirName</i></dt> | |
| 632 <dd> | |
| 633 name of the directory to write the files to (string) | |
| 634 </dd> | |
| 635 </dl> | |
| 636 <a NAME="OpenSearchManager.setCurrentEngine" ID="OpenSearchManager.setCurrentEngine"></a> | |
| 637 <h4>OpenSearchManager.setCurrentEngine</h4> | |
| 638 <b>setCurrentEngine</b>(<i>engine</i>) | |
| 639 | |
| 640 <p> | |
| 641 Public method to set the current engine. | |
| 642 </p> | |
| 643 <dl> | |
| 644 | |
| 645 <dt><i>engine</i></dt> | |
| 646 <dd> | |
| 647 reference to the new current engine (OpenSearchEngine) | |
| 648 </dd> | |
| 649 </dl> | |
| 650 <a NAME="OpenSearchManager.setCurrentEngineName" ID="OpenSearchManager.setCurrentEngineName"></a> | |
| 651 <h4>OpenSearchManager.setCurrentEngineName</h4> | |
| 652 <b>setCurrentEngineName</b>(<i>name</i>) | |
| 653 | |
| 654 <p> | |
| 655 Public method to set the current engine by name. | |
| 656 </p> | |
| 657 <dl> | |
| 658 | |
| 659 <dt><i>name</i></dt> | |
| 660 <dd> | |
| 661 name of the new current engine (string) | |
| 662 </dd> | |
| 663 </dl> | |
| 664 <a NAME="OpenSearchManager.setEngineForKeyword" ID="OpenSearchManager.setEngineForKeyword"></a> | |
| 665 <h4>OpenSearchManager.setEngineForKeyword</h4> | |
| 666 <b>setEngineForKeyword</b>(<i>keyword, engine</i>) | |
| 667 | |
| 668 <p> | |
| 669 Public method to set the engine for a keyword. | |
| 670 </p> | |
| 671 <dl> | |
| 672 | |
| 673 <dt><i>keyword</i></dt> | |
| 674 <dd> | |
| 675 keyword to get engine for (string) | |
| 676 </dd> | |
| 677 <dt><i>engine</i></dt> | |
| 678 <dd> | |
| 679 reference to the search engine object (OpenSearchEngine) | |
| 680 or None to remove the keyword | |
| 681 </dd> | |
| 682 </dl> | |
| 683 <a NAME="OpenSearchManager.setKeywordsForEngine" ID="OpenSearchManager.setKeywordsForEngine"></a> | |
| 684 <h4>OpenSearchManager.setKeywordsForEngine</h4> | |
| 685 <b>setKeywordsForEngine</b>(<i>engine, keywords</i>) | |
| 686 | |
| 687 <p> | |
| 688 Public method to set the keywords for an engine. | |
| 689 </p> | |
| 690 <dl> | |
| 691 | |
| 692 <dt><i>engine</i></dt> | |
| 693 <dd> | |
| 694 reference to the search engine object (OpenSearchEngine) | |
| 695 </dd> | |
| 696 <dt><i>keywords</i></dt> | |
| 697 <dd> | |
| 698 list of keywords (list of strings) | |
| 699 </dd> | |
| 700 </dl> | |
| 701 <div align="right"><a href="#top">Up</a></div> | |
| 702 <hr /> | |
| 703 </body></html> |
