7988:c4c17121eff8 | 7989:a21d673a8f99 |
---|---|
240 <dd> | 240 <dd> |
241 reference to an engine object (OpenSearchEngine) | 241 reference to an engine object (OpenSearchEngine) |
242 </dd> | 242 </dd> |
243 </dl> | 243 </dl> |
244 <dl> | 244 <dl> |
245 <dt>Returns:</dt> | 245 <dt>Return:</dt> |
246 <dd> | 246 <dd> |
247 flag indicating success (boolean) | 247 flag indicating success (boolean) |
248 </dd> | 248 </dd> |
249 </dl> | 249 </dl> |
250 <a NAME="OpenSearchManager.__addEngineByFile" ID="OpenSearchManager.__addEngineByFile"></a> | 250 <a NAME="OpenSearchManager.__addEngineByFile" ID="OpenSearchManager.__addEngineByFile"></a> |
261 name of a file containing the engine definition | 261 name of a file containing the engine definition |
262 (string) | 262 (string) |
263 </dd> | 263 </dd> |
264 </dl> | 264 </dl> |
265 <dl> | 265 <dl> |
266 <dt>Returns:</dt> | 266 <dt>Return:</dt> |
267 <dd> | 267 <dd> |
268 flag indicating success (boolean) | 268 flag indicating success (boolean) |
269 </dd> | 269 </dd> |
270 </dl> | 270 </dl> |
271 <a NAME="OpenSearchManager.__addEngineByUrl" ID="OpenSearchManager.__addEngineByUrl"></a> | 271 <a NAME="OpenSearchManager.__addEngineByUrl" ID="OpenSearchManager.__addEngineByUrl"></a> |
281 <dd> | 281 <dd> |
282 URL of the engine definition file (QUrl) | 282 URL of the engine definition file (QUrl) |
283 </dd> | 283 </dd> |
284 </dl> | 284 </dl> |
285 <dl> | 285 <dl> |
286 <dt>Returns:</dt> | 286 <dt>Return:</dt> |
287 <dd> | 287 <dd> |
288 flag indicating success (boolean) | 288 flag indicating success (boolean) |
289 </dd> | 289 </dd> |
290 </dl> | 290 </dl> |
291 <a NAME="OpenSearchManager.__confirmAddition" ID="OpenSearchManager.__confirmAddition"></a> | 291 <a NAME="OpenSearchManager.__confirmAddition" ID="OpenSearchManager.__confirmAddition"></a> |
301 <dd> | 301 <dd> |
302 reference to the engine to be added (OpenSearchEngine) | 302 reference to the engine to be added (OpenSearchEngine) |
303 </dd> | 303 </dd> |
304 </dl> | 304 </dl> |
305 <dl> | 305 <dl> |
306 <dt>Returns:</dt> | 306 <dt>Return:</dt> |
307 <dd> | 307 <dd> |
308 flag indicating the engine shall be added (boolean) | 308 flag indicating the engine shall be added (boolean) |
309 </dd> | 309 </dd> |
310 </dl> | 310 </dl> |
311 <a NAME="OpenSearchManager.__engineFromUrlAvailable" ID="OpenSearchManager.__engineFromUrlAvailable"></a> | 311 <a NAME="OpenSearchManager.__engineFromUrlAvailable" ID="OpenSearchManager.__engineFromUrlAvailable"></a> |
337 name of a file containing the engine definition (string) | 337 name of a file containing the engine definition (string) |
338 or reference to an engine object (OpenSearchEngine) | 338 or reference to an engine object (OpenSearchEngine) |
339 </dd> | 339 </dd> |
340 </dl> | 340 </dl> |
341 <dl> | 341 <dl> |
342 <dt>Returns:</dt> | 342 <dt>Return:</dt> |
343 <dd> | 343 <dd> |
344 flag indicating success (boolean) | 344 flag indicating success (boolean) |
345 </dd> | 345 </dd> |
346 </dl> | 346 </dl> |
347 <a NAME="OpenSearchManager.addEngineFromForm" ID="OpenSearchManager.addEngineFromForm"></a> | 347 <a NAME="OpenSearchManager.addEngineFromForm" ID="OpenSearchManager.addEngineFromForm"></a> |
369 | 369 |
370 <p> | 370 <p> |
371 Public method to get a list of all engine names. | 371 Public method to get a list of all engine names. |
372 </p> | 372 </p> |
373 <dl> | 373 <dl> |
374 <dt>Returns:</dt> | 374 <dt>Return:</dt> |
375 <dd> | 375 <dd> |
376 sorted list of all engine names (list of strings) | 376 sorted list of all engine names (list of strings) |
377 </dd> | 377 </dd> |
378 </dl> | 378 </dl> |
379 <a NAME="OpenSearchManager.close" ID="OpenSearchManager.close"></a> | 379 <a NAME="OpenSearchManager.close" ID="OpenSearchManager.close"></a> |
396 <dd> | 396 <dd> |
397 search string for keyword search (string) | 397 search string for keyword search (string) |
398 </dd> | 398 </dd> |
399 </dl> | 399 </dl> |
400 <dl> | 400 <dl> |
401 <dt>Returns:</dt> | 401 <dt>Return:</dt> |
402 <dd> | 402 <dd> |
403 search URL (QUrl) | 403 search URL (QUrl) |
404 </dd> | 404 </dd> |
405 </dl> | 405 </dl> |
406 <a NAME="OpenSearchManager.currentEngine" ID="OpenSearchManager.currentEngine"></a> | 406 <a NAME="OpenSearchManager.currentEngine" ID="OpenSearchManager.currentEngine"></a> |
409 | 409 |
410 <p> | 410 <p> |
411 Public method to get a reference to the current engine. | 411 Public method to get a reference to the current engine. |
412 </p> | 412 </p> |
413 <dl> | 413 <dl> |
414 <dt>Returns:</dt> | 414 <dt>Return:</dt> |
415 <dd> | 415 <dd> |
416 reference to the current engine (OpenSearchEngine) | 416 reference to the current engine (OpenSearchEngine) |
417 </dd> | 417 </dd> |
418 </dl> | 418 </dl> |
419 <a NAME="OpenSearchManager.currentEngineName" ID="OpenSearchManager.currentEngineName"></a> | 419 <a NAME="OpenSearchManager.currentEngineName" ID="OpenSearchManager.currentEngineName"></a> |
422 | 422 |
423 <p> | 423 <p> |
424 Public method to get the name of the current search engine. | 424 Public method to get the name of the current search engine. |
425 </p> | 425 </p> |
426 <dl> | 426 <dl> |
427 <dt>Returns:</dt> | 427 <dt>Return:</dt> |
428 <dd> | 428 <dd> |
429 name of the current search engine (string) | 429 name of the current search engine (string) |
430 </dd> | 430 </dd> |
431 </dl> | 431 </dl> |
432 <a NAME="OpenSearchManager.engine" ID="OpenSearchManager.engine"></a> | 432 <a NAME="OpenSearchManager.engine" ID="OpenSearchManager.engine"></a> |
442 <dd> | 442 <dd> |
443 name of the engine (string) | 443 name of the engine (string) |
444 </dd> | 444 </dd> |
445 </dl> | 445 </dl> |
446 <dl> | 446 <dl> |
447 <dt>Returns:</dt> | 447 <dt>Return:</dt> |
448 <dd> | 448 <dd> |
449 reference to the engine (OpenSearchEngine) | 449 reference to the engine (OpenSearchEngine) |
450 </dd> | 450 </dd> |
451 </dl> | 451 </dl> |
452 <a NAME="OpenSearchManager.engineExists" ID="OpenSearchManager.engineExists"></a> | 452 <a NAME="OpenSearchManager.engineExists" ID="OpenSearchManager.engineExists"></a> |
462 <dd> | 462 <dd> |
463 name of the engine (string) | 463 name of the engine (string) |
464 </dd> | 464 </dd> |
465 </dl> | 465 </dl> |
466 <dl> | 466 <dl> |
467 <dt>Returns:</dt> | 467 <dt>Return:</dt> |
468 <dd> | 468 <dd> |
469 flag indicating an existing engine (boolean) | 469 flag indicating an existing engine (boolean) |
470 </dd> | 470 </dd> |
471 </dl> | 471 </dl> |
472 <a NAME="OpenSearchManager.engineForKeyword" ID="OpenSearchManager.engineForKeyword"></a> | 472 <a NAME="OpenSearchManager.engineForKeyword" ID="OpenSearchManager.engineForKeyword"></a> |
482 <dd> | 482 <dd> |
483 keyword to get engine for (string) | 483 keyword to get engine for (string) |
484 </dd> | 484 </dd> |
485 </dl> | 485 </dl> |
486 <dl> | 486 <dl> |
487 <dt>Returns:</dt> | 487 <dt>Return:</dt> |
488 <dd> | 488 <dd> |
489 reference to the search engine object (OpenSearchEngine) | 489 reference to the search engine object (OpenSearchEngine) |
490 </dd> | 490 </dd> |
491 </dl> | 491 </dl> |
492 <a NAME="OpenSearchManager.enginesChanged" ID="OpenSearchManager.enginesChanged"></a> | 492 <a NAME="OpenSearchManager.enginesChanged" ID="OpenSearchManager.enginesChanged"></a> |
503 | 503 |
504 <p> | 504 <p> |
505 Public method to get the number of available engines. | 505 Public method to get the number of available engines. |
506 </p> | 506 </p> |
507 <dl> | 507 <dl> |
508 <dt>Returns:</dt> | 508 <dt>Return:</dt> |
509 <dd> | 509 <dd> |
510 number of engines (integer) | 510 number of engines (integer) |
511 </dd> | 511 </dd> |
512 </dl> | 512 </dl> |
513 <a NAME="OpenSearchManager.enginesDirectory" ID="OpenSearchManager.enginesDirectory"></a> | 513 <a NAME="OpenSearchManager.enginesDirectory" ID="OpenSearchManager.enginesDirectory"></a> |
517 <p> | 517 <p> |
518 Public method to determine the directory containing the search engine | 518 Public method to determine the directory containing the search engine |
519 descriptions. | 519 descriptions. |
520 </p> | 520 </p> |
521 <dl> | 521 <dl> |
522 <dt>Returns:</dt> | 522 <dt>Return:</dt> |
523 <dd> | 523 <dd> |
524 directory name (string) | 524 directory name (string) |
525 </dd> | 525 </dd> |
526 </dl> | 526 </dl> |
527 <a NAME="OpenSearchManager.generateEngineFileName" ID="OpenSearchManager.generateEngineFileName"></a> | 527 <a NAME="OpenSearchManager.generateEngineFileName" ID="OpenSearchManager.generateEngineFileName"></a> |
537 <dd> | 537 <dd> |
538 name of the engine (string) | 538 name of the engine (string) |
539 </dd> | 539 </dd> |
540 </dl> | 540 </dl> |
541 <dl> | 541 <dl> |
542 <dt>Returns:</dt> | 542 <dt>Return:</dt> |
543 <dd> | 543 <dd> |
544 valid engine file name (string) | 544 valid engine file name (string) |
545 </dd> | 545 </dd> |
546 </dl> | 546 </dl> |
547 <a NAME="OpenSearchManager.keywordsForEngine" ID="OpenSearchManager.keywordsForEngine"></a> | 547 <a NAME="OpenSearchManager.keywordsForEngine" ID="OpenSearchManager.keywordsForEngine"></a> |
557 <dd> | 557 <dd> |
558 reference to the search engine object (OpenSearchEngine) | 558 reference to the search engine object (OpenSearchEngine) |
559 </dd> | 559 </dd> |
560 </dl> | 560 </dl> |
561 <dl> | 561 <dl> |
562 <dt>Returns:</dt> | 562 <dt>Return:</dt> |
563 <dd> | 563 <dd> |
564 list of keywords (list of strings) | 564 list of keywords (list of strings) |
565 </dd> | 565 </dd> |
566 </dl> | 566 </dl> |
567 <a NAME="OpenSearchManager.load" ID="OpenSearchManager.load"></a> | 567 <a NAME="OpenSearchManager.load" ID="OpenSearchManager.load"></a> |
584 <dd> | 584 <dd> |
585 name of the directory to load the files from (string) | 585 name of the directory to load the files from (string) |
586 </dd> | 586 </dd> |
587 </dl> | 587 </dl> |
588 <dl> | 588 <dl> |
589 <dt>Returns:</dt> | 589 <dt>Return:</dt> |
590 <dd> | 590 <dd> |
591 flag indicating success (boolean) | 591 flag indicating success (boolean) |
592 </dd> | 592 </dd> |
593 </dl> | 593 </dl> |
594 <a NAME="OpenSearchManager.removeEngine" ID="OpenSearchManager.removeEngine"></a> | 594 <a NAME="OpenSearchManager.removeEngine" ID="OpenSearchManager.removeEngine"></a> |