Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchEngine.html
src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchEngine.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.OpenSearchEngine</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.OpenSearchEngine</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the open search engine. | |
| 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="#OpenSearchEngine">OpenSearchEngine</a></td> | |
| 25 <td>Class implementing the open search engine.</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="OpenSearchEngine" ID="OpenSearchEngine"></a> | |
| 36 <h2>OpenSearchEngine</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the open search engine. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>imageChanged()</dt> | |
| 45 <dd> | |
| 46 emitted after the icon has been changed | |
| 47 </dd> | |
| 48 <dt>suggestions(list of strings)</dt> | |
| 49 <dd> | |
| 50 emitted after the suggestions have | |
| 51 been received | |
| 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 | |
| 65 <tr> | |
| 66 <td><a href="#OpenSearchEngine.parseTemplate">parseTemplate</a></td> | |
| 67 <td>Class method to parse a search template.</td> | |
| 68 </tr> | |
| 69 </table> | |
| 70 <h3>Methods</h3> | |
| 71 | |
| 72 <table> | |
| 73 | |
| 74 <tr> | |
| 75 <td><a href="#OpenSearchEngine.__init__">OpenSearchEngine</a></td> | |
| 76 <td>Constructor</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#OpenSearchEngine.__eq__">__eq__</a></td> | |
| 80 <td>Special method implementing the == operator.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#OpenSearchEngine.__imageObtained">__imageObtained</a></td> | |
| 84 <td>Private slot to receive the image of the engine.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#OpenSearchEngine.__lt__">__lt__</a></td> | |
| 88 <td>Special method implementing the < operator.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#OpenSearchEngine.__suggestionsObtained">__suggestionsObtained</a></td> | |
| 92 <td>Private slot to receive the suggestions.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#OpenSearchEngine.description">description</a></td> | |
| 96 <td>Public method to get the description of the engine.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#OpenSearchEngine.image">image</a></td> | |
| 100 <td>Public method to get the image of the engine.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#OpenSearchEngine.imageUrl">imageUrl</a></td> | |
| 104 <td>Public method to get the image URL of the engine.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#OpenSearchEngine.isValid">isValid</a></td> | |
| 108 <td>Public method to check, if the engine is valid.</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#OpenSearchEngine.loadImage">loadImage</a></td> | |
| 112 <td>Public method to load the image of the engine.</td> | |
| 113 </tr> | |
| 114 <tr> | |
| 115 <td><a href="#OpenSearchEngine.name">name</a></td> | |
| 116 <td>Public method to get the name of the engine.</td> | |
| 117 </tr> | |
| 118 <tr> | |
| 119 <td><a href="#OpenSearchEngine.networkAccessManager">networkAccessManager</a></td> | |
| 120 <td>Public method to get a reference to the network access manager object.</td> | |
| 121 </tr> | |
| 122 <tr> | |
| 123 <td><a href="#OpenSearchEngine.providesSuggestions">providesSuggestions</a></td> | |
| 124 <td>Public method to check, if the engine provides suggestions.</td> | |
| 125 </tr> | |
| 126 <tr> | |
| 127 <td><a href="#OpenSearchEngine.requestSuggestions">requestSuggestions</a></td> | |
| 128 <td>Public method to request suggestions.</td> | |
| 129 </tr> | |
| 130 <tr> | |
| 131 <td><a href="#OpenSearchEngine.searchMethod">searchMethod</a></td> | |
| 132 <td>Public method to get the HTTP request method used to perform search requests.</td> | |
| 133 </tr> | |
| 134 <tr> | |
| 135 <td><a href="#OpenSearchEngine.searchParameters">searchParameters</a></td> | |
| 136 <td>Public method to get the search parameters of the engine.</td> | |
| 137 </tr> | |
| 138 <tr> | |
| 139 <td><a href="#OpenSearchEngine.searchUrl">searchUrl</a></td> | |
| 140 <td>Public method to get a URL ready for searching.</td> | |
| 141 </tr> | |
| 142 <tr> | |
| 143 <td><a href="#OpenSearchEngine.searchUrlTemplate">searchUrlTemplate</a></td> | |
| 144 <td>Public method to get the search URL template of the engine.</td> | |
| 145 </tr> | |
| 146 <tr> | |
| 147 <td><a href="#OpenSearchEngine.setDescription">setDescription</a></td> | |
| 148 <td>Public method to set the engine description.</td> | |
| 149 </tr> | |
| 150 <tr> | |
| 151 <td><a href="#OpenSearchEngine.setImage">setImage</a></td> | |
| 152 <td>Public method to set the image of the engine.</td> | |
| 153 </tr> | |
| 154 <tr> | |
| 155 <td><a href="#OpenSearchEngine.setImageUrl">setImageUrl</a></td> | |
| 156 <td>Public method to set the engine image URL.</td> | |
| 157 </tr> | |
| 158 <tr> | |
| 159 <td><a href="#OpenSearchEngine.setImageUrlAndLoad">setImageUrlAndLoad</a></td> | |
| 160 <td>Public method to set the engine image URL.</td> | |
| 161 </tr> | |
| 162 <tr> | |
| 163 <td><a href="#OpenSearchEngine.setName">setName</a></td> | |
| 164 <td>Public method to set the engine name.</td> | |
| 165 </tr> | |
| 166 <tr> | |
| 167 <td><a href="#OpenSearchEngine.setNetworkAccessManager">setNetworkAccessManager</a></td> | |
| 168 <td>Public method to set the reference to the network access manager.</td> | |
| 169 </tr> | |
| 170 <tr> | |
| 171 <td><a href="#OpenSearchEngine.setSearchMethod">setSearchMethod</a></td> | |
| 172 <td>Public method to set the HTTP request method used to perform search requests.</td> | |
| 173 </tr> | |
| 174 <tr> | |
| 175 <td><a href="#OpenSearchEngine.setSearchParameters">setSearchParameters</a></td> | |
| 176 <td>Public method to set the engine search parameters.</td> | |
| 177 </tr> | |
| 178 <tr> | |
| 179 <td><a href="#OpenSearchEngine.setSearchUrlTemplate">setSearchUrlTemplate</a></td> | |
| 180 <td>Public method to set the engine search URL template.</td> | |
| 181 </tr> | |
| 182 <tr> | |
| 183 <td><a href="#OpenSearchEngine.setSuggestionsMethod">setSuggestionsMethod</a></td> | |
| 184 <td>Public method to set the HTTP request method used to perform suggestions requests.</td> | |
| 185 </tr> | |
| 186 <tr> | |
| 187 <td><a href="#OpenSearchEngine.setSuggestionsParameters">setSuggestionsParameters</a></td> | |
| 188 <td>Public method to set the engine suggestions parameters.</td> | |
| 189 </tr> | |
| 190 <tr> | |
| 191 <td><a href="#OpenSearchEngine.setSuggestionsUrlTemplate">setSuggestionsUrlTemplate</a></td> | |
| 192 <td>Public method to set the engine suggestions URL template.</td> | |
| 193 </tr> | |
| 194 <tr> | |
| 195 <td><a href="#OpenSearchEngine.suggestionsMethod">suggestionsMethod</a></td> | |
| 196 <td>Public method to get the HTTP request method used to perform suggestions requests.</td> | |
| 197 </tr> | |
| 198 <tr> | |
| 199 <td><a href="#OpenSearchEngine.suggestionsParameters">suggestionsParameters</a></td> | |
| 200 <td>Public method to get the suggestions parameters of the engine.</td> | |
| 201 </tr> | |
| 202 <tr> | |
| 203 <td><a href="#OpenSearchEngine.suggestionsUrl">suggestionsUrl</a></td> | |
| 204 <td>Public method to get a URL ready for suggestions.</td> | |
| 205 </tr> | |
| 206 <tr> | |
| 207 <td><a href="#OpenSearchEngine.suggestionsUrlTemplate">suggestionsUrlTemplate</a></td> | |
| 208 <td>Public method to get the search URL template of the engine.</td> | |
| 209 </tr> | |
| 210 </table> | |
| 211 <h3>Static Methods</h3> | |
| 212 | |
| 213 <table> | |
| 214 <tr><td>None</td></tr> | |
| 215 </table> | |
| 216 | |
| 217 <a NAME="OpenSearchEngine.parseTemplate" ID="OpenSearchEngine.parseTemplate"></a> | |
| 218 <h4>OpenSearchEngine.parseTemplate (class method)</h4> | |
| 219 <b>parseTemplate</b>(<i>searchTerm, searchTemplate</i>) | |
| 220 | |
| 221 <p> | |
| 222 Class method to parse a search template. | |
| 223 </p> | |
| 224 <dl> | |
| 225 | |
| 226 <dt><i>searchTerm</i></dt> | |
| 227 <dd> | |
| 228 term to search for (string) | |
| 229 </dd> | |
| 230 <dt><i>searchTemplate</i></dt> | |
| 231 <dd> | |
| 232 template to be parsed (string) | |
| 233 </dd> | |
| 234 </dl> | |
| 235 <dl> | |
| 236 <dt>Return:</dt> | |
| 237 <dd> | |
| 238 parsed template (string) | |
| 239 </dd> | |
| 240 </dl> | |
| 241 <a NAME="OpenSearchEngine.__init__" ID="OpenSearchEngine.__init__"></a> | |
| 242 <h4>OpenSearchEngine (Constructor)</h4> | |
| 243 <b>OpenSearchEngine</b>(<i>parent=None</i>) | |
| 244 | |
| 245 <p> | |
| 246 Constructor | |
| 247 </p> | |
| 248 <dl> | |
| 249 | |
| 250 <dt><i>parent</i></dt> | |
| 251 <dd> | |
| 252 reference to the parent object (QObject) | |
| 253 </dd> | |
| 254 </dl> | |
| 255 <a NAME="OpenSearchEngine.__eq__" ID="OpenSearchEngine.__eq__"></a> | |
| 256 <h4>OpenSearchEngine.__eq__</h4> | |
| 257 <b>__eq__</b>(<i>other</i>) | |
| 258 | |
| 259 <p> | |
| 260 Special method implementing the == operator. | |
| 261 </p> | |
| 262 <dl> | |
| 263 | |
| 264 <dt><i>other</i></dt> | |
| 265 <dd> | |
| 266 reference to an open search engine (OpenSearchEngine) | |
| 267 </dd> | |
| 268 </dl> | |
| 269 <dl> | |
| 270 <dt>Return:</dt> | |
| 271 <dd> | |
| 272 flag indicating equality (boolean) | |
| 273 </dd> | |
| 274 </dl> | |
| 275 <a NAME="OpenSearchEngine.__imageObtained" ID="OpenSearchEngine.__imageObtained"></a> | |
| 276 <h4>OpenSearchEngine.__imageObtained</h4> | |
| 277 <b>__imageObtained</b>(<i>reply</i>) | |
| 278 | |
| 279 <p> | |
| 280 Private slot to receive the image of the engine. | |
| 281 </p> | |
| 282 <dl> | |
| 283 | |
| 284 <dt><i>reply</i> (QNetworkReply)</dt> | |
| 285 <dd> | |
| 286 reference to the network reply | |
| 287 </dd> | |
| 288 </dl> | |
| 289 <a NAME="OpenSearchEngine.__lt__" ID="OpenSearchEngine.__lt__"></a> | |
| 290 <h4>OpenSearchEngine.__lt__</h4> | |
| 291 <b>__lt__</b>(<i>other</i>) | |
| 292 | |
| 293 <p> | |
| 294 Special method implementing the < operator. | |
| 295 </p> | |
| 296 <dl> | |
| 297 | |
| 298 <dt><i>other</i></dt> | |
| 299 <dd> | |
| 300 reference to an open search engine (OpenSearchEngine) | |
| 301 </dd> | |
| 302 </dl> | |
| 303 <dl> | |
| 304 <dt>Return:</dt> | |
| 305 <dd> | |
| 306 flag indicating less than (boolean) | |
| 307 </dd> | |
| 308 </dl> | |
| 309 <a NAME="OpenSearchEngine.__suggestionsObtained" ID="OpenSearchEngine.__suggestionsObtained"></a> | |
| 310 <h4>OpenSearchEngine.__suggestionsObtained</h4> | |
| 311 <b>__suggestionsObtained</b>(<i></i>) | |
| 312 | |
| 313 <p> | |
| 314 Private slot to receive the suggestions. | |
| 315 </p> | |
| 316 <a NAME="OpenSearchEngine.description" ID="OpenSearchEngine.description"></a> | |
| 317 <h4>OpenSearchEngine.description</h4> | |
| 318 <b>description</b>(<i></i>) | |
| 319 | |
| 320 <p> | |
| 321 Public method to get the description of the engine. | |
| 322 </p> | |
| 323 <dl> | |
| 324 <dt>Return:</dt> | |
| 325 <dd> | |
| 326 description of the engine (string) | |
| 327 </dd> | |
| 328 </dl> | |
| 329 <a NAME="OpenSearchEngine.image" ID="OpenSearchEngine.image"></a> | |
| 330 <h4>OpenSearchEngine.image</h4> | |
| 331 <b>image</b>(<i></i>) | |
| 332 | |
| 333 <p> | |
| 334 Public method to get the image of the engine. | |
| 335 </p> | |
| 336 <dl> | |
| 337 <dt>Return:</dt> | |
| 338 <dd> | |
| 339 image of the engine (QImage) | |
| 340 </dd> | |
| 341 </dl> | |
| 342 <a NAME="OpenSearchEngine.imageUrl" ID="OpenSearchEngine.imageUrl"></a> | |
| 343 <h4>OpenSearchEngine.imageUrl</h4> | |
| 344 <b>imageUrl</b>(<i></i>) | |
| 345 | |
| 346 <p> | |
| 347 Public method to get the image URL of the engine. | |
| 348 </p> | |
| 349 <dl> | |
| 350 <dt>Return:</dt> | |
| 351 <dd> | |
| 352 image URL of the engine (string) | |
| 353 </dd> | |
| 354 </dl> | |
| 355 <a NAME="OpenSearchEngine.isValid" ID="OpenSearchEngine.isValid"></a> | |
| 356 <h4>OpenSearchEngine.isValid</h4> | |
| 357 <b>isValid</b>(<i></i>) | |
| 358 | |
| 359 <p> | |
| 360 Public method to check, if the engine is valid. | |
| 361 </p> | |
| 362 <dl> | |
| 363 <dt>Return:</dt> | |
| 364 <dd> | |
| 365 flag indicating validity (boolean) | |
| 366 </dd> | |
| 367 </dl> | |
| 368 <a NAME="OpenSearchEngine.loadImage" ID="OpenSearchEngine.loadImage"></a> | |
| 369 <h4>OpenSearchEngine.loadImage</h4> | |
| 370 <b>loadImage</b>(<i></i>) | |
| 371 | |
| 372 <p> | |
| 373 Public method to load the image of the engine. | |
| 374 </p> | |
| 375 <a NAME="OpenSearchEngine.name" ID="OpenSearchEngine.name"></a> | |
| 376 <h4>OpenSearchEngine.name</h4> | |
| 377 <b>name</b>(<i></i>) | |
| 378 | |
| 379 <p> | |
| 380 Public method to get the name of the engine. | |
| 381 </p> | |
| 382 <dl> | |
| 383 <dt>Return:</dt> | |
| 384 <dd> | |
| 385 name of the engine (string) | |
| 386 </dd> | |
| 387 </dl> | |
| 388 <a NAME="OpenSearchEngine.networkAccessManager" ID="OpenSearchEngine.networkAccessManager"></a> | |
| 389 <h4>OpenSearchEngine.networkAccessManager</h4> | |
| 390 <b>networkAccessManager</b>(<i></i>) | |
| 391 | |
| 392 <p> | |
| 393 Public method to get a reference to the network access manager object. | |
| 394 </p> | |
| 395 <dl> | |
| 396 <dt>Return:</dt> | |
| 397 <dd> | |
| 398 reference to the network access manager object | |
| 399 (QNetworkAccessManager) | |
| 400 </dd> | |
| 401 </dl> | |
| 402 <a NAME="OpenSearchEngine.providesSuggestions" ID="OpenSearchEngine.providesSuggestions"></a> | |
| 403 <h4>OpenSearchEngine.providesSuggestions</h4> | |
| 404 <b>providesSuggestions</b>(<i></i>) | |
| 405 | |
| 406 <p> | |
| 407 Public method to check, if the engine provides suggestions. | |
| 408 </p> | |
| 409 <dl> | |
| 410 <dt>Return:</dt> | |
| 411 <dd> | |
| 412 flag indicating suggestions are provided (boolean) | |
| 413 </dd> | |
| 414 </dl> | |
| 415 <a NAME="OpenSearchEngine.requestSuggestions" ID="OpenSearchEngine.requestSuggestions"></a> | |
| 416 <h4>OpenSearchEngine.requestSuggestions</h4> | |
| 417 <b>requestSuggestions</b>(<i>searchTerm</i>) | |
| 418 | |
| 419 <p> | |
| 420 Public method to request suggestions. | |
| 421 </p> | |
| 422 <dl> | |
| 423 | |
| 424 <dt><i>searchTerm</i></dt> | |
| 425 <dd> | |
| 426 term to get suggestions for (string) | |
| 427 </dd> | |
| 428 </dl> | |
| 429 <a NAME="OpenSearchEngine.searchMethod" ID="OpenSearchEngine.searchMethod"></a> | |
| 430 <h4>OpenSearchEngine.searchMethod</h4> | |
| 431 <b>searchMethod</b>(<i></i>) | |
| 432 | |
| 433 <p> | |
| 434 Public method to get the HTTP request method used to perform search | |
| 435 requests. | |
| 436 </p> | |
| 437 <dl> | |
| 438 <dt>Return:</dt> | |
| 439 <dd> | |
| 440 HTTP request method (string) | |
| 441 </dd> | |
| 442 </dl> | |
| 443 <a NAME="OpenSearchEngine.searchParameters" ID="OpenSearchEngine.searchParameters"></a> | |
| 444 <h4>OpenSearchEngine.searchParameters</h4> | |
| 445 <b>searchParameters</b>(<i></i>) | |
| 446 | |
| 447 <p> | |
| 448 Public method to get the search parameters of the engine. | |
| 449 </p> | |
| 450 <dl> | |
| 451 <dt>Return:</dt> | |
| 452 <dd> | |
| 453 search parameters of the engine (list of two tuples) | |
| 454 </dd> | |
| 455 </dl> | |
| 456 <a NAME="OpenSearchEngine.searchUrl" ID="OpenSearchEngine.searchUrl"></a> | |
| 457 <h4>OpenSearchEngine.searchUrl</h4> | |
| 458 <b>searchUrl</b>(<i>searchTerm</i>) | |
| 459 | |
| 460 <p> | |
| 461 Public method to get a URL ready for searching. | |
| 462 </p> | |
| 463 <dl> | |
| 464 | |
| 465 <dt><i>searchTerm</i></dt> | |
| 466 <dd> | |
| 467 term to search for (string) | |
| 468 </dd> | |
| 469 </dl> | |
| 470 <dl> | |
| 471 <dt>Return:</dt> | |
| 472 <dd> | |
| 473 URL (QUrl) | |
| 474 </dd> | |
| 475 </dl> | |
| 476 <a NAME="OpenSearchEngine.searchUrlTemplate" ID="OpenSearchEngine.searchUrlTemplate"></a> | |
| 477 <h4>OpenSearchEngine.searchUrlTemplate</h4> | |
| 478 <b>searchUrlTemplate</b>(<i></i>) | |
| 479 | |
| 480 <p> | |
| 481 Public method to get the search URL template of the engine. | |
| 482 </p> | |
| 483 <dl> | |
| 484 <dt>Return:</dt> | |
| 485 <dd> | |
| 486 search URL template of the engine (string) | |
| 487 </dd> | |
| 488 </dl> | |
| 489 <a NAME="OpenSearchEngine.setDescription" ID="OpenSearchEngine.setDescription"></a> | |
| 490 <h4>OpenSearchEngine.setDescription</h4> | |
| 491 <b>setDescription</b>(<i>description</i>) | |
| 492 | |
| 493 <p> | |
| 494 Public method to set the engine description. | |
| 495 </p> | |
| 496 <dl> | |
| 497 | |
| 498 <dt><i>description</i></dt> | |
| 499 <dd> | |
| 500 description of the engine (string) | |
| 501 </dd> | |
| 502 </dl> | |
| 503 <a NAME="OpenSearchEngine.setImage" ID="OpenSearchEngine.setImage"></a> | |
| 504 <h4>OpenSearchEngine.setImage</h4> | |
| 505 <b>setImage</b>(<i>image</i>) | |
| 506 | |
| 507 <p> | |
| 508 Public method to set the image of the engine. | |
| 509 </p> | |
| 510 <dl> | |
| 511 | |
| 512 <dt><i>image</i></dt> | |
| 513 <dd> | |
| 514 image to be set (QImage) | |
| 515 </dd> | |
| 516 </dl> | |
| 517 <a NAME="OpenSearchEngine.setImageUrl" ID="OpenSearchEngine.setImageUrl"></a> | |
| 518 <h4>OpenSearchEngine.setImageUrl</h4> | |
| 519 <b>setImageUrl</b>(<i>imageUrl</i>) | |
| 520 | |
| 521 <p> | |
| 522 Public method to set the engine image URL. | |
| 523 </p> | |
| 524 <dl> | |
| 525 | |
| 526 <dt><i>imageUrl</i></dt> | |
| 527 <dd> | |
| 528 image URL of the engine (string) | |
| 529 </dd> | |
| 530 </dl> | |
| 531 <a NAME="OpenSearchEngine.setImageUrlAndLoad" ID="OpenSearchEngine.setImageUrlAndLoad"></a> | |
| 532 <h4>OpenSearchEngine.setImageUrlAndLoad</h4> | |
| 533 <b>setImageUrlAndLoad</b>(<i>imageUrl</i>) | |
| 534 | |
| 535 <p> | |
| 536 Public method to set the engine image URL. | |
| 537 </p> | |
| 538 <dl> | |
| 539 | |
| 540 <dt><i>imageUrl</i></dt> | |
| 541 <dd> | |
| 542 image URL of the engine (string) | |
| 543 </dd> | |
| 544 </dl> | |
| 545 <a NAME="OpenSearchEngine.setName" ID="OpenSearchEngine.setName"></a> | |
| 546 <h4>OpenSearchEngine.setName</h4> | |
| 547 <b>setName</b>(<i>name</i>) | |
| 548 | |
| 549 <p> | |
| 550 Public method to set the engine name. | |
| 551 </p> | |
| 552 <dl> | |
| 553 | |
| 554 <dt><i>name</i></dt> | |
| 555 <dd> | |
| 556 name of the engine (string) | |
| 557 </dd> | |
| 558 </dl> | |
| 559 <a NAME="OpenSearchEngine.setNetworkAccessManager" ID="OpenSearchEngine.setNetworkAccessManager"></a> | |
| 560 <h4>OpenSearchEngine.setNetworkAccessManager</h4> | |
| 561 <b>setNetworkAccessManager</b>(<i>networkAccessManager</i>) | |
| 562 | |
| 563 <p> | |
| 564 Public method to set the reference to the network access manager. | |
| 565 </p> | |
| 566 <dl> | |
| 567 | |
| 568 <dt><i>networkAccessManager</i></dt> | |
| 569 <dd> | |
| 570 reference to the network access manager | |
| 571 object (QNetworkAccessManager) | |
| 572 </dd> | |
| 573 </dl> | |
| 574 <a NAME="OpenSearchEngine.setSearchMethod" ID="OpenSearchEngine.setSearchMethod"></a> | |
| 575 <h4>OpenSearchEngine.setSearchMethod</h4> | |
| 576 <b>setSearchMethod</b>(<i>method</i>) | |
| 577 | |
| 578 <p> | |
| 579 Public method to set the HTTP request method used to perform search | |
| 580 requests. | |
| 581 </p> | |
| 582 <dl> | |
| 583 | |
| 584 <dt><i>method</i></dt> | |
| 585 <dd> | |
| 586 HTTP request method (string) | |
| 587 </dd> | |
| 588 </dl> | |
| 589 <a NAME="OpenSearchEngine.setSearchParameters" ID="OpenSearchEngine.setSearchParameters"></a> | |
| 590 <h4>OpenSearchEngine.setSearchParameters</h4> | |
| 591 <b>setSearchParameters</b>(<i>searchParameters</i>) | |
| 592 | |
| 593 <p> | |
| 594 Public method to set the engine search parameters. | |
| 595 </p> | |
| 596 <dl> | |
| 597 | |
| 598 <dt><i>searchParameters</i></dt> | |
| 599 <dd> | |
| 600 search parameters of the engine | |
| 601 (list of two tuples) | |
| 602 </dd> | |
| 603 </dl> | |
| 604 <a NAME="OpenSearchEngine.setSearchUrlTemplate" ID="OpenSearchEngine.setSearchUrlTemplate"></a> | |
| 605 <h4>OpenSearchEngine.setSearchUrlTemplate</h4> | |
| 606 <b>setSearchUrlTemplate</b>(<i>searchUrlTemplate</i>) | |
| 607 | |
| 608 <p> | |
| 609 Public method to set the engine search URL template. | |
| 610 </p> | |
| 611 <p> | |
| 612 The URL template is processed according to the specification: | |
| 613 <a | |
| 614 href="http://www.opensearch.org/Specifications/OpenSearch/1.1#OpenSearch_URL_template_syntax"> | |
| 615 http://www.opensearch.org/Specifications/OpenSearch/1.1#OpenSearch_URL_template_syntax</a> | |
| 616 </p> | |
| 617 <p> | |
| 618 A list of template parameters currently supported and what they are | |
| 619 replaced with: | |
| 620 <table> | |
| 621 <tr><td><b>Parameter</b></td><td><b>Value</b></td></tr> | |
| 622 <tr><td>{count}</td><td>20</td></tr> | |
| 623 <tr><td>{startIndex}</td><td>0</td></tr> | |
| 624 <tr><td>{startPage}</td><td>0</td></tr> | |
| 625 <tr><td>{language}</td> | |
| 626 <td>the default language code (RFC 3066)</td></tr> | |
| 627 <tr><td>{country}</td> | |
| 628 <td>the default country code (first part of language)</td></tr> | |
| 629 <tr><td>{inputEncoding}</td><td>UTF-8</td></tr> | |
| 630 <tr><td>{outputEncoding}</td><td>UTF-8</td></tr> | |
| 631 <tr><td>{searchTerms}</td><td>the string supplied by the user</td></tr> | |
| 632 <tr><td>{*:source}</td> | |
| 633 <td>application name, QCoreApplication::applicationName()</td></tr> | |
| 634 </table> | |
| 635 </p> | |
| 636 <dl> | |
| 637 | |
| 638 <dt><i>searchUrlTemplate</i></dt> | |
| 639 <dd> | |
| 640 search URL template of the engine (string) | |
| 641 </dd> | |
| 642 </dl> | |
| 643 <a NAME="OpenSearchEngine.setSuggestionsMethod" ID="OpenSearchEngine.setSuggestionsMethod"></a> | |
| 644 <h4>OpenSearchEngine.setSuggestionsMethod</h4> | |
| 645 <b>setSuggestionsMethod</b>(<i>method</i>) | |
| 646 | |
| 647 <p> | |
| 648 Public method to set the HTTP request method used to perform | |
| 649 suggestions requests. | |
| 650 </p> | |
| 651 <dl> | |
| 652 | |
| 653 <dt><i>method</i></dt> | |
| 654 <dd> | |
| 655 HTTP request method (string) | |
| 656 </dd> | |
| 657 </dl> | |
| 658 <a NAME="OpenSearchEngine.setSuggestionsParameters" ID="OpenSearchEngine.setSuggestionsParameters"></a> | |
| 659 <h4>OpenSearchEngine.setSuggestionsParameters</h4> | |
| 660 <b>setSuggestionsParameters</b>(<i>suggestionsParameters</i>) | |
| 661 | |
| 662 <p> | |
| 663 Public method to set the engine suggestions parameters. | |
| 664 </p> | |
| 665 <dl> | |
| 666 | |
| 667 <dt><i>suggestionsParameters</i></dt> | |
| 668 <dd> | |
| 669 suggestions parameters of the | |
| 670 engine (list of two tuples) | |
| 671 </dd> | |
| 672 </dl> | |
| 673 <a NAME="OpenSearchEngine.setSuggestionsUrlTemplate" ID="OpenSearchEngine.setSuggestionsUrlTemplate"></a> | |
| 674 <h4>OpenSearchEngine.setSuggestionsUrlTemplate</h4> | |
| 675 <b>setSuggestionsUrlTemplate</b>(<i>suggestionsUrlTemplate</i>) | |
| 676 | |
| 677 <p> | |
| 678 Public method to set the engine suggestions URL template. | |
| 679 </p> | |
| 680 <dl> | |
| 681 | |
| 682 <dt><i>suggestionsUrlTemplate</i></dt> | |
| 683 <dd> | |
| 684 suggestions URL template of the | |
| 685 engine (string) | |
| 686 </dd> | |
| 687 </dl> | |
| 688 <a NAME="OpenSearchEngine.suggestionsMethod" ID="OpenSearchEngine.suggestionsMethod"></a> | |
| 689 <h4>OpenSearchEngine.suggestionsMethod</h4> | |
| 690 <b>suggestionsMethod</b>(<i></i>) | |
| 691 | |
| 692 <p> | |
| 693 Public method to get the HTTP request method used to perform | |
| 694 suggestions requests. | |
| 695 </p> | |
| 696 <dl> | |
| 697 <dt>Return:</dt> | |
| 698 <dd> | |
| 699 HTTP request method (string) | |
| 700 </dd> | |
| 701 </dl> | |
| 702 <a NAME="OpenSearchEngine.suggestionsParameters" ID="OpenSearchEngine.suggestionsParameters"></a> | |
| 703 <h4>OpenSearchEngine.suggestionsParameters</h4> | |
| 704 <b>suggestionsParameters</b>(<i></i>) | |
| 705 | |
| 706 <p> | |
| 707 Public method to get the suggestions parameters of the engine. | |
| 708 </p> | |
| 709 <dl> | |
| 710 <dt>Return:</dt> | |
| 711 <dd> | |
| 712 suggestions parameters of the engine (list of two tuples) | |
| 713 </dd> | |
| 714 </dl> | |
| 715 <a NAME="OpenSearchEngine.suggestionsUrl" ID="OpenSearchEngine.suggestionsUrl"></a> | |
| 716 <h4>OpenSearchEngine.suggestionsUrl</h4> | |
| 717 <b>suggestionsUrl</b>(<i>searchTerm</i>) | |
| 718 | |
| 719 <p> | |
| 720 Public method to get a URL ready for suggestions. | |
| 721 </p> | |
| 722 <dl> | |
| 723 | |
| 724 <dt><i>searchTerm</i></dt> | |
| 725 <dd> | |
| 726 term to search for (string) | |
| 727 </dd> | |
| 728 </dl> | |
| 729 <dl> | |
| 730 <dt>Return:</dt> | |
| 731 <dd> | |
| 732 URL (QUrl) | |
| 733 </dd> | |
| 734 </dl> | |
| 735 <a NAME="OpenSearchEngine.suggestionsUrlTemplate" ID="OpenSearchEngine.suggestionsUrlTemplate"></a> | |
| 736 <h4>OpenSearchEngine.suggestionsUrlTemplate</h4> | |
| 737 <b>suggestionsUrlTemplate</b>(<i></i>) | |
| 738 | |
| 739 <p> | |
| 740 Public method to get the search URL template of the engine. | |
| 741 </p> | |
| 742 <dl> | |
| 743 <dt>Return:</dt> | |
| 744 <dd> | |
| 745 search URL template of the engine (string) | |
| 746 </dd> | |
| 747 </dl> | |
| 748 <div align="right"><a href="#top">Up</a></div> | |
| 749 <hr /> | |
| 750 </body></html> |
