Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.OpenSearch.OpenSearchEngine.html
Documentation/Source/eric5.Helpviewer.OpenSearch.OpenSearchEngine.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Helpviewer.OpenSearch.OpenSearchEngine</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.Helpviewer.OpenSearch.OpenSearchEngine</h1> | |
| 12 <p> | |
| 13 Module implementing the open search engine. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#OpenSearchEngine">OpenSearchEngine</a></td> | |
| 23 <td>Class implementing the open search engine.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="OpenSearchEngine" ID="OpenSearchEngine"></a> | |
| 32 <h2>OpenSearchEngine</h2> | |
| 33 <p> | |
| 34 Class implementing the open search engine. | |
| 35 </p><h4>Signals</h4> | |
| 36 <dl> | |
| 37 <dt>imageChanged()</dt> | |
| 38 <dd> | |
| 39 emitted after the icon has been changed | |
| 40 </dd><dt>suggestions(const QStringList&)</dt> | |
| 41 <dd> | |
| 42 emitted after the suggestions have | |
| 43 been received | |
| 44 </dd> | |
| 45 </dl> | |
| 46 <h3>Derived from</h3> | |
| 47 QObject | |
| 48 <h3>Class Attributes</h3> | |
| 49 <table> | |
| 50 <tr><td>_language</td></tr><tr><td>loc</td></tr> | |
| 51 </table> | |
| 52 <h3>Methods</h3> | |
| 53 <table> | |
| 54 <tr> | |
| 55 <td><a href="#OpenSearchEngine.__init__">OpenSearchEngine</a></td> | |
| 56 <td>Constructor</td> | |
| 57 </tr><tr> | |
| 58 <td><a href="#OpenSearchEngine.__eq__">__eq__</a></td> | |
| 59 <td>Public method implementing the == operator.</td> | |
| 60 </tr><tr> | |
| 61 <td><a href="#OpenSearchEngine.__imageObtained">__imageObtained</a></td> | |
| 62 <td>Private slot to receive the image of the engine.</td> | |
| 63 </tr><tr> | |
| 64 <td><a href="#OpenSearchEngine.__lt__">__lt__</a></td> | |
| 65 <td>Public method implementing the < operator.</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#OpenSearchEngine.__suggestionsObtained">__suggestionsObtained</a></td> | |
| 68 <td>Private slot to receive the suggestions.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#OpenSearchEngine.description">description</a></td> | |
| 71 <td>Public method to get the description of the engine.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#OpenSearchEngine.image">image</a></td> | |
| 74 <td>Public method to get the image of the engine.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#OpenSearchEngine.imageUrl">imageUrl</a></td> | |
| 77 <td>Public method to get the image URL of the engine.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#OpenSearchEngine.isValid">isValid</a></td> | |
| 80 <td>Public method to check, if the engine is valid.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#OpenSearchEngine.loadImage">loadImage</a></td> | |
| 83 <td>Public method to load the image of the engine.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#OpenSearchEngine.name">name</a></td> | |
| 86 <td>Public method to get the name of the engine.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#OpenSearchEngine.networkAccessManager">networkAccessManager</a></td> | |
| 89 <td>Public method to get a reference to the network access manager object.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#OpenSearchEngine.parseTemplate">parseTemplate</a></td> | |
| 92 <td>Class method to parse a search template.</td> | |
| 93 </tr><tr> | |
| 94 <td><a href="#OpenSearchEngine.providesSuggestions">providesSuggestions</a></td> | |
| 95 <td>Public method to check, if the engine provides suggestions.</td> | |
| 96 </tr><tr> | |
| 97 <td><a href="#OpenSearchEngine.requestSuggestions">requestSuggestions</a></td> | |
| 98 <td>Public method to request suggestions.</td> | |
| 99 </tr><tr> | |
| 100 <td><a href="#OpenSearchEngine.searchMethod">searchMethod</a></td> | |
| 101 <td>Public method to get the HTTP request method used to perform search requests.</td> | |
| 102 </tr><tr> | |
| 103 <td><a href="#OpenSearchEngine.searchParameters">searchParameters</a></td> | |
| 104 <td>Public method to get the search parameters of the engine.</td> | |
| 105 </tr><tr> | |
| 106 <td><a href="#OpenSearchEngine.searchUrl">searchUrl</a></td> | |
| 107 <td>Public method to get a URL ready for searching.</td> | |
| 108 </tr><tr> | |
| 109 <td><a href="#OpenSearchEngine.searchUrlTemplate">searchUrlTemplate</a></td> | |
| 110 <td>Public method to get the search URL template of the engine.</td> | |
| 111 </tr><tr> | |
| 112 <td><a href="#OpenSearchEngine.setDescription">setDescription</a></td> | |
| 113 <td>Public method to set the engine description.</td> | |
| 114 </tr><tr> | |
| 115 <td><a href="#OpenSearchEngine.setImage">setImage</a></td> | |
| 116 <td>Public method to set the image of the engine.</td> | |
| 117 </tr><tr> | |
| 118 <td><a href="#OpenSearchEngine.setImageUrl">setImageUrl</a></td> | |
| 119 <td>Public method to set the engine image URL.</td> | |
| 120 </tr><tr> | |
| 121 <td><a href="#OpenSearchEngine.setImageUrlAndLoad">setImageUrlAndLoad</a></td> | |
| 122 <td>Public method to set the engine image URL.</td> | |
| 123 </tr><tr> | |
| 124 <td><a href="#OpenSearchEngine.setName">setName</a></td> | |
| 125 <td>Public method to set the engine name.</td> | |
| 126 </tr><tr> | |
| 127 <td><a href="#OpenSearchEngine.setNetworkAccessManager">setNetworkAccessManager</a></td> | |
| 128 <td>Public method to set the reference to the network access manager.</td> | |
| 129 </tr><tr> | |
| 130 <td><a href="#OpenSearchEngine.setSearchMethod">setSearchMethod</a></td> | |
| 131 <td>Public method to set the HTTP request method used to perform search requests.</td> | |
| 132 </tr><tr> | |
| 133 <td><a href="#OpenSearchEngine.setSearchParameters">setSearchParameters</a></td> | |
| 134 <td>Public method to set the engine search parameters.</td> | |
| 135 </tr><tr> | |
| 136 <td><a href="#OpenSearchEngine.setSearchUrlTemplate">setSearchUrlTemplate</a></td> | |
| 137 <td>Public method to set the engine search URL template.</td> | |
| 138 </tr><tr> | |
| 139 <td><a href="#OpenSearchEngine.setSuggestionsMethod">setSuggestionsMethod</a></td> | |
| 140 <td>Public method to set the HTTP request method used to perform suggestions requests.</td> | |
| 141 </tr><tr> | |
| 142 <td><a href="#OpenSearchEngine.setSuggestionsParameters">setSuggestionsParameters</a></td> | |
| 143 <td>Public method to set the engine suggestions parameters.</td> | |
| 144 </tr><tr> | |
| 145 <td><a href="#OpenSearchEngine.setSuggestionsUrlTemplate">setSuggestionsUrlTemplate</a></td> | |
| 146 <td>Public method to set the engine suggestions URL template.</td> | |
| 147 </tr><tr> | |
| 148 <td><a href="#OpenSearchEngine.suggestionsMethod">suggestionsMethod</a></td> | |
| 149 <td>Public method to get the HTTP request method used to perform suggestions requests.</td> | |
| 150 </tr><tr> | |
| 151 <td><a href="#OpenSearchEngine.suggestionsParameters">suggestionsParameters</a></td> | |
| 152 <td>Public method to get the suggestions parameters of the engine.</td> | |
| 153 </tr><tr> | |
| 154 <td><a href="#OpenSearchEngine.suggestionsUrl">suggestionsUrl</a></td> | |
| 155 <td>Public method to get a URL ready for suggestions.</td> | |
| 156 </tr><tr> | |
| 157 <td><a href="#OpenSearchEngine.suggestionsUrlTemplate">suggestionsUrlTemplate</a></td> | |
| 158 <td>Public method to get the search URL template of the engine.</td> | |
| 159 </tr> | |
| 160 </table> | |
| 161 <a NAME="OpenSearchEngine.__init__" ID="OpenSearchEngine.__init__"></a> | |
| 162 <h4>OpenSearchEngine (Constructor)</h4> | |
| 163 <b>OpenSearchEngine</b>(<i>parent = None</i>) | |
| 164 <p> | |
| 165 Constructor | |
| 166 </p><dl> | |
| 167 <dt><i>parent</i></dt> | |
| 168 <dd> | |
| 169 reference to the parent object (QObject) | |
| 170 </dd> | |
| 171 </dl><a NAME="OpenSearchEngine.__eq__" ID="OpenSearchEngine.__eq__"></a> | |
| 172 <h4>OpenSearchEngine.__eq__</h4> | |
| 173 <b>__eq__</b>(<i>other</i>) | |
| 174 <p> | |
| 175 Public method implementing the == operator. | |
| 176 </p><dl> | |
| 177 <dt><i>other</i></dt> | |
| 178 <dd> | |
| 179 reference to an open search engine (OpenSearchEngine) | |
| 180 </dd> | |
| 181 </dl><dl> | |
| 182 <dt>Returns:</dt> | |
| 183 <dd> | |
| 184 flag indicating equality (boolean) | |
| 185 </dd> | |
| 186 </dl><a NAME="OpenSearchEngine.__imageObtained" ID="OpenSearchEngine.__imageObtained"></a> | |
| 187 <h4>OpenSearchEngine.__imageObtained</h4> | |
| 188 <b>__imageObtained</b>(<i></i>) | |
| 189 <p> | |
| 190 Private slot to receive the image of the engine. | |
| 191 </p><a NAME="OpenSearchEngine.__lt__" ID="OpenSearchEngine.__lt__"></a> | |
| 192 <h4>OpenSearchEngine.__lt__</h4> | |
| 193 <b>__lt__</b>(<i>other</i>) | |
| 194 <p> | |
| 195 Public method implementing the < operator. | |
| 196 </p><dl> | |
| 197 <dt><i>other</i></dt> | |
| 198 <dd> | |
| 199 reference to an open search engine (OpenSearchEngine) | |
| 200 </dd> | |
| 201 </dl><dl> | |
| 202 <dt>Returns:</dt> | |
| 203 <dd> | |
| 204 flag indicating less than (boolean) | |
| 205 </dd> | |
| 206 </dl><a NAME="OpenSearchEngine.__suggestionsObtained" ID="OpenSearchEngine.__suggestionsObtained"></a> | |
| 207 <h4>OpenSearchEngine.__suggestionsObtained</h4> | |
| 208 <b>__suggestionsObtained</b>(<i></i>) | |
| 209 <p> | |
| 210 Private slot to receive the suggestions. | |
| 211 </p><a NAME="OpenSearchEngine.description" ID="OpenSearchEngine.description"></a> | |
| 212 <h4>OpenSearchEngine.description</h4> | |
| 213 <b>description</b>(<i></i>) | |
| 214 <p> | |
| 215 Public method to get the description of the engine. | |
| 216 </p><dl> | |
| 217 <dt>Returns:</dt> | |
| 218 <dd> | |
| 219 description of the engine (string) | |
| 220 </dd> | |
| 221 </dl><a NAME="OpenSearchEngine.image" ID="OpenSearchEngine.image"></a> | |
| 222 <h4>OpenSearchEngine.image</h4> | |
| 223 <b>image</b>(<i></i>) | |
| 224 <p> | |
| 225 Public method to get the image of the engine. | |
| 226 </p><dl> | |
| 227 <dt>Returns:</dt> | |
| 228 <dd> | |
| 229 image of the engine (QImage) | |
| 230 </dd> | |
| 231 </dl><a NAME="OpenSearchEngine.imageUrl" ID="OpenSearchEngine.imageUrl"></a> | |
| 232 <h4>OpenSearchEngine.imageUrl</h4> | |
| 233 <b>imageUrl</b>(<i></i>) | |
| 234 <p> | |
| 235 Public method to get the image URL of the engine. | |
| 236 </p><dl> | |
| 237 <dt>Returns:</dt> | |
| 238 <dd> | |
| 239 image URL of the engine (string) | |
| 240 </dd> | |
| 241 </dl><a NAME="OpenSearchEngine.isValid" ID="OpenSearchEngine.isValid"></a> | |
| 242 <h4>OpenSearchEngine.isValid</h4> | |
| 243 <b>isValid</b>(<i></i>) | |
| 244 <p> | |
| 245 Public method to check, if the engine is valid. | |
| 246 </p><dl> | |
| 247 <dt>Returns:</dt> | |
| 248 <dd> | |
| 249 flag indicating validity (boolean) | |
| 250 </dd> | |
| 251 </dl><a NAME="OpenSearchEngine.loadImage" ID="OpenSearchEngine.loadImage"></a> | |
| 252 <h4>OpenSearchEngine.loadImage</h4> | |
| 253 <b>loadImage</b>(<i></i>) | |
| 254 <p> | |
| 255 Public method to load the image of the engine. | |
| 256 </p><a NAME="OpenSearchEngine.name" ID="OpenSearchEngine.name"></a> | |
| 257 <h4>OpenSearchEngine.name</h4> | |
| 258 <b>name</b>(<i></i>) | |
| 259 <p> | |
| 260 Public method to get the name of the engine. | |
| 261 </p><dl> | |
| 262 <dt>Returns:</dt> | |
| 263 <dd> | |
| 264 name of the engine (string) | |
| 265 </dd> | |
| 266 </dl><a NAME="OpenSearchEngine.networkAccessManager" ID="OpenSearchEngine.networkAccessManager"></a> | |
| 267 <h4>OpenSearchEngine.networkAccessManager</h4> | |
| 268 <b>networkAccessManager</b>(<i></i>) | |
| 269 <p> | |
| 270 Public method to get a reference to the network access manager object. | |
| 271 </p><dl> | |
| 272 <dt>Returns:</dt> | |
| 273 <dd> | |
| 274 reference to the network access manager object (QNetworkAccessManager) | |
| 275 </dd> | |
| 276 </dl><a NAME="OpenSearchEngine.parseTemplate" ID="OpenSearchEngine.parseTemplate"></a> | |
| 277 <h4>OpenSearchEngine.parseTemplate</h4> | |
| 278 <b>parseTemplate</b>(<i>searchTerm, searchTemplate</i>) | |
| 279 <p> | |
| 280 Class method to parse a search template. | |
| 281 </p><dl> | |
| 282 <dt><i>searchTerm</i></dt> | |
| 283 <dd> | |
| 284 term to search for (string) | |
| 285 </dd><dt><i>searchTemplate</i></dt> | |
| 286 <dd> | |
| 287 template to be parsed (string) | |
| 288 </dd> | |
| 289 </dl><dl> | |
| 290 <dt>Returns:</dt> | |
| 291 <dd> | |
| 292 parsed template (string) | |
| 293 </dd> | |
| 294 </dl><a NAME="OpenSearchEngine.providesSuggestions" ID="OpenSearchEngine.providesSuggestions"></a> | |
| 295 <h4>OpenSearchEngine.providesSuggestions</h4> | |
| 296 <b>providesSuggestions</b>(<i></i>) | |
| 297 <p> | |
| 298 Public method to check, if the engine provides suggestions. | |
| 299 </p><dl> | |
| 300 <dt>Returns:</dt> | |
| 301 <dd> | |
| 302 flag indicating suggestions are provided (boolean) | |
| 303 </dd> | |
| 304 </dl><a NAME="OpenSearchEngine.requestSuggestions" ID="OpenSearchEngine.requestSuggestions"></a> | |
| 305 <h4>OpenSearchEngine.requestSuggestions</h4> | |
| 306 <b>requestSuggestions</b>(<i>searchTerm</i>) | |
| 307 <p> | |
| 308 Public method to request suggestions. | |
| 309 </p><dl> | |
| 310 <dt><i>searchTerm</i></dt> | |
| 311 <dd> | |
| 312 term to get suggestions for (string) | |
| 313 </dd> | |
| 314 </dl><a NAME="OpenSearchEngine.searchMethod" ID="OpenSearchEngine.searchMethod"></a> | |
| 315 <h4>OpenSearchEngine.searchMethod</h4> | |
| 316 <b>searchMethod</b>(<i></i>) | |
| 317 <p> | |
| 318 Public method to get the HTTP request method used to perform search requests. | |
| 319 </p><dl> | |
| 320 <dt>Returns:</dt> | |
| 321 <dd> | |
| 322 HTTP request method (string) | |
| 323 </dd> | |
| 324 </dl><a NAME="OpenSearchEngine.searchParameters" ID="OpenSearchEngine.searchParameters"></a> | |
| 325 <h4>OpenSearchEngine.searchParameters</h4> | |
| 326 <b>searchParameters</b>(<i></i>) | |
| 327 <p> | |
| 328 Public method to get the search parameters of the engine. | |
| 329 </p><dl> | |
| 330 <dt>Returns:</dt> | |
| 331 <dd> | |
| 332 search parameters of the engine (list of two tuples) | |
| 333 </dd> | |
| 334 </dl><a NAME="OpenSearchEngine.searchUrl" ID="OpenSearchEngine.searchUrl"></a> | |
| 335 <h4>OpenSearchEngine.searchUrl</h4> | |
| 336 <b>searchUrl</b>(<i>searchTerm</i>) | |
| 337 <p> | |
| 338 Public method to get a URL ready for searching. | |
| 339 </p><dl> | |
| 340 <dt><i>searchTerm</i></dt> | |
| 341 <dd> | |
| 342 term to search for (string) | |
| 343 </dd> | |
| 344 </dl><dl> | |
| 345 <dt>Returns:</dt> | |
| 346 <dd> | |
| 347 URL (QUrl) | |
| 348 </dd> | |
| 349 </dl><a NAME="OpenSearchEngine.searchUrlTemplate" ID="OpenSearchEngine.searchUrlTemplate"></a> | |
| 350 <h4>OpenSearchEngine.searchUrlTemplate</h4> | |
| 351 <b>searchUrlTemplate</b>(<i></i>) | |
| 352 <p> | |
| 353 Public method to get the search URL template of the engine. | |
| 354 </p><dl> | |
| 355 <dt>Returns:</dt> | |
| 356 <dd> | |
| 357 search URL template of the engine (string) | |
| 358 </dd> | |
| 359 </dl><a NAME="OpenSearchEngine.setDescription" ID="OpenSearchEngine.setDescription"></a> | |
| 360 <h4>OpenSearchEngine.setDescription</h4> | |
| 361 <b>setDescription</b>(<i>description</i>) | |
| 362 <p> | |
| 363 Public method to set the engine description. | |
| 364 </p><dl> | |
| 365 <dt><i>description</i></dt> | |
| 366 <dd> | |
| 367 description of the engine (string) | |
| 368 </dd> | |
| 369 </dl><a NAME="OpenSearchEngine.setImage" ID="OpenSearchEngine.setImage"></a> | |
| 370 <h4>OpenSearchEngine.setImage</h4> | |
| 371 <b>setImage</b>(<i>image</i>) | |
| 372 <p> | |
| 373 Public method to set the image of the engine. | |
| 374 </p><dl> | |
| 375 <dt><i>image</i></dt> | |
| 376 <dd> | |
| 377 image to be set (QImage) | |
| 378 </dd> | |
| 379 </dl><a NAME="OpenSearchEngine.setImageUrl" ID="OpenSearchEngine.setImageUrl"></a> | |
| 380 <h4>OpenSearchEngine.setImageUrl</h4> | |
| 381 <b>setImageUrl</b>(<i>imageUrl</i>) | |
| 382 <p> | |
| 383 Public method to set the engine image URL. | |
| 384 </p><dl> | |
| 385 <dt><i>description</i></dt> | |
| 386 <dd> | |
| 387 image URL of the engine (string) | |
| 388 </dd> | |
| 389 </dl><a NAME="OpenSearchEngine.setImageUrlAndLoad" ID="OpenSearchEngine.setImageUrlAndLoad"></a> | |
| 390 <h4>OpenSearchEngine.setImageUrlAndLoad</h4> | |
| 391 <b>setImageUrlAndLoad</b>(<i>imageUrl</i>) | |
| 392 <p> | |
| 393 Public method to set the engine image URL. | |
| 394 </p><dl> | |
| 395 <dt><i>description</i></dt> | |
| 396 <dd> | |
| 397 image URL of the engine (string) | |
| 398 </dd> | |
| 399 </dl><a NAME="OpenSearchEngine.setName" ID="OpenSearchEngine.setName"></a> | |
| 400 <h4>OpenSearchEngine.setName</h4> | |
| 401 <b>setName</b>(<i>name</i>) | |
| 402 <p> | |
| 403 Public method to set the engine name. | |
| 404 </p><dl> | |
| 405 <dt><i>name</i></dt> | |
| 406 <dd> | |
| 407 name of the engine (string) | |
| 408 </dd> | |
| 409 </dl><a NAME="OpenSearchEngine.setNetworkAccessManager" ID="OpenSearchEngine.setNetworkAccessManager"></a> | |
| 410 <h4>OpenSearchEngine.setNetworkAccessManager</h4> | |
| 411 <b>setNetworkAccessManager</b>(<i>networkAccessManager</i>) | |
| 412 <p> | |
| 413 Public method to set the reference to the network access manager. | |
| 414 </p><dl> | |
| 415 <dt><i>networkAccessManager</i></dt> | |
| 416 <dd> | |
| 417 reference to the network access manager | |
| 418 object (QNetworkAccessManager) | |
| 419 </dd> | |
| 420 </dl><a NAME="OpenSearchEngine.setSearchMethod" ID="OpenSearchEngine.setSearchMethod"></a> | |
| 421 <h4>OpenSearchEngine.setSearchMethod</h4> | |
| 422 <b>setSearchMethod</b>(<i>method</i>) | |
| 423 <p> | |
| 424 Public method to set the HTTP request method used to perform search requests. | |
| 425 </p><dl> | |
| 426 <dt><i>method</i></dt> | |
| 427 <dd> | |
| 428 HTTP request method (string) | |
| 429 </dd> | |
| 430 </dl><a NAME="OpenSearchEngine.setSearchParameters" ID="OpenSearchEngine.setSearchParameters"></a> | |
| 431 <h4>OpenSearchEngine.setSearchParameters</h4> | |
| 432 <b>setSearchParameters</b>(<i>searchParameters</i>) | |
| 433 <p> | |
| 434 Public method to set the engine search parameters. | |
| 435 </p><dl> | |
| 436 <dt><i>searchParameters</i></dt> | |
| 437 <dd> | |
| 438 search parameters of the engine (list of two tuples) | |
| 439 </dd> | |
| 440 </dl><a NAME="OpenSearchEngine.setSearchUrlTemplate" ID="OpenSearchEngine.setSearchUrlTemplate"></a> | |
| 441 <h4>OpenSearchEngine.setSearchUrlTemplate</h4> | |
| 442 <b>setSearchUrlTemplate</b>(<i>searchUrlTemplate</i>) | |
| 443 <p> | |
| 444 Public method to set the engine search URL template. | |
| 445 </p><dl> | |
| 446 <dt><i>searchUrlTemplate</i></dt> | |
| 447 <dd> | |
| 448 search URL template of the engine (string) | |
| 449 </dd> | |
| 450 </dl><a NAME="OpenSearchEngine.setSuggestionsMethod" ID="OpenSearchEngine.setSuggestionsMethod"></a> | |
| 451 <h4>OpenSearchEngine.setSuggestionsMethod</h4> | |
| 452 <b>setSuggestionsMethod</b>(<i>method</i>) | |
| 453 <p> | |
| 454 Public method to set the HTTP request method used to perform suggestions requests. | |
| 455 </p><dl> | |
| 456 <dt><i>method</i></dt> | |
| 457 <dd> | |
| 458 HTTP request method (string) | |
| 459 </dd> | |
| 460 </dl><a NAME="OpenSearchEngine.setSuggestionsParameters" ID="OpenSearchEngine.setSuggestionsParameters"></a> | |
| 461 <h4>OpenSearchEngine.setSuggestionsParameters</h4> | |
| 462 <b>setSuggestionsParameters</b>(<i>suggestionsParameters</i>) | |
| 463 <p> | |
| 464 Public method to set the engine suggestions parameters. | |
| 465 </p><dl> | |
| 466 <dt><i>suggestionsParameters</i></dt> | |
| 467 <dd> | |
| 468 suggestions parameters of the | |
| 469 engine (list of two tuples) | |
| 470 </dd> | |
| 471 </dl><a NAME="OpenSearchEngine.setSuggestionsUrlTemplate" ID="OpenSearchEngine.setSuggestionsUrlTemplate"></a> | |
| 472 <h4>OpenSearchEngine.setSuggestionsUrlTemplate</h4> | |
| 473 <b>setSuggestionsUrlTemplate</b>(<i>suggestionsUrlTemplate</i>) | |
| 474 <p> | |
| 475 Public method to set the engine suggestions URL template. | |
| 476 </p><dl> | |
| 477 <dt><i>suggestionsUrlTemplate</i></dt> | |
| 478 <dd> | |
| 479 suggestions URL template of the | |
| 480 engine (string) | |
| 481 </dd> | |
| 482 </dl><a NAME="OpenSearchEngine.suggestionsMethod" ID="OpenSearchEngine.suggestionsMethod"></a> | |
| 483 <h4>OpenSearchEngine.suggestionsMethod</h4> | |
| 484 <b>suggestionsMethod</b>(<i></i>) | |
| 485 <p> | |
| 486 Public method to get the HTTP request method used to perform suggestions requests. | |
| 487 </p><dl> | |
| 488 <dt>Returns:</dt> | |
| 489 <dd> | |
| 490 HTTP request method (string) | |
| 491 </dd> | |
| 492 </dl><a NAME="OpenSearchEngine.suggestionsParameters" ID="OpenSearchEngine.suggestionsParameters"></a> | |
| 493 <h4>OpenSearchEngine.suggestionsParameters</h4> | |
| 494 <b>suggestionsParameters</b>(<i></i>) | |
| 495 <p> | |
| 496 Public method to get the suggestions parameters of the engine. | |
| 497 </p><dl> | |
| 498 <dt>Returns:</dt> | |
| 499 <dd> | |
| 500 suggestions parameters of the engine (list of two tuples) | |
| 501 </dd> | |
| 502 </dl><a NAME="OpenSearchEngine.suggestionsUrl" ID="OpenSearchEngine.suggestionsUrl"></a> | |
| 503 <h4>OpenSearchEngine.suggestionsUrl</h4> | |
| 504 <b>suggestionsUrl</b>(<i>searchTerm</i>) | |
| 505 <p> | |
| 506 Public method to get a URL ready for suggestions. | |
| 507 </p><dl> | |
| 508 <dt><i>searchTerm</i></dt> | |
| 509 <dd> | |
| 510 term to search for (string) | |
| 511 </dd> | |
| 512 </dl><dl> | |
| 513 <dt>Returns:</dt> | |
| 514 <dd> | |
| 515 URL (QUrl) | |
| 516 </dd> | |
| 517 </dl><a NAME="OpenSearchEngine.suggestionsUrlTemplate" ID="OpenSearchEngine.suggestionsUrlTemplate"></a> | |
| 518 <h4>OpenSearchEngine.suggestionsUrlTemplate</h4> | |
| 519 <b>suggestionsUrlTemplate</b>(<i></i>) | |
| 520 <p> | |
| 521 Public method to get the search URL template of the engine. | |
| 522 </p><dl> | |
| 523 <dt>Returns:</dt> | |
| 524 <dd> | |
| 525 search URL template of the engine (string) | |
| 526 </dd> | |
| 527 </dl> | |
| 528 <div align="right"><a href="#top">Up</a></div> | |
| 529 <hr /> | |
| 530 </body></html> |
