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