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