Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerWidget.html
src/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerWidget.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10478
- de9106c55c3d
- child 10690
- fab36645aa7d
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.HelpViewer.HelpViewerWidget</h1> | 9 <h1>eric7.HelpViewer.HelpViewerWidget</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing an embedded viewer for QtHelp and local HTML files. | 11 Module implementing an embedded viewer for QtHelp and local HTML files. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>WEBENGINE_AVAILABLE</td></tr> | 16 <tr><td>WEBENGINE_AVAILABLE</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | |
| 21 <table> | 20 <table> |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#HelpViewerWidget">HelpViewerWidget</a></td> | 22 <td><a href="#HelpViewerWidget">HelpViewerWidget</a></td> |
| 25 <td>Class implementing an embedded viewer for QtHelp and local HTML files.</td> | 23 <td>Class implementing an embedded viewer for QtHelp and local HTML files.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | |
| 30 <table> | 28 <table> |
| 31 <tr><td>None</td></tr> | 29 <tr><td>None</td></tr> |
| 32 </table> | 30 </table> |
| 31 | |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="HelpViewerWidget" ID="HelpViewerWidget"></a> | 34 <a NAME="HelpViewerWidget" ID="HelpViewerWidget"></a> |
| 36 <h2>HelpViewerWidget</h2> | 35 <h2>HelpViewerWidget</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing an embedded viewer for QtHelp and local HTML files. | 37 Class implementing an embedded viewer for QtHelp and local HTML files. |
| 40 </p> | 38 </p> |
| 39 | |
| 41 <h3>Derived from</h3> | 40 <h3>Derived from</h3> |
| 42 QWidget | 41 QWidget |
| 43 <h3>Class Attributes</h3> | 42 <h3>Class Attributes</h3> |
| 44 | |
| 45 <table> | 43 <table> |
| 46 <tr><td>EmpytDocument_Dark</td></tr><tr><td>EmpytDocument_Light</td></tr><tr><td>MaxHistoryItems</td></tr> | 44 <tr><td>EmpytDocument_Dark</td></tr> |
| 45 <tr><td>EmpytDocument_Light</td></tr> | |
| 46 <tr><td>MaxHistoryItems</td></tr> | |
| 47 </table> | 47 </table> |
| 48 | |
| 48 <h3>Class Methods</h3> | 49 <h3>Class Methods</h3> |
| 49 | |
| 50 <table> | 50 <table> |
| 51 | |
| 52 <tr> | 51 <tr> |
| 53 <td><a href="#HelpViewerWidget.emptyDocument">emptyDocument</a></td> | 52 <td><a href="#HelpViewerWidget.emptyDocument">emptyDocument</a></td> |
| 54 <td>Class method to get the HTML code for an empty page.</td> | 53 <td>Class method to get the HTML code for an empty page.</td> |
| 55 </tr> | 54 </tr> |
| 56 </table> | 55 </table> |
| 56 | |
| 57 <h3>Methods</h3> | 57 <h3>Methods</h3> |
| 58 | |
| 59 <table> | 58 <table> |
| 60 | |
| 61 <tr> | 59 <tr> |
| 62 <td><a href="#HelpViewerWidget.__init__">HelpViewerWidget</a></td> | 60 <td><a href="#HelpViewerWidget.__init__">HelpViewerWidget</a></td> |
| 63 <td>Constructor</td> | 61 <td>Constructor</td> |
| 64 </tr> | 62 </tr> |
| 65 <tr> | 63 <tr> |
| 297 <tr> | 295 <tr> |
| 298 <td><a href="#HelpViewerWidget.webSettings">webSettings</a></td> | 296 <td><a href="#HelpViewerWidget.webSettings">webSettings</a></td> |
| 299 <td>Public method to get the web settings of the current profile.</td> | 297 <td>Public method to get the web settings of the current profile.</td> |
| 300 </tr> | 298 </tr> |
| 301 </table> | 299 </table> |
| 300 | |
| 302 <h3>Static Methods</h3> | 301 <h3>Static Methods</h3> |
| 303 | |
| 304 <table> | 302 <table> |
| 305 <tr><td>None</td></tr> | 303 <tr><td>None</td></tr> |
| 306 </table> | 304 </table> |
| 307 | 305 |
| 306 | |
| 308 <a NAME="HelpViewerWidget.emptyDocument" ID="HelpViewerWidget.emptyDocument"></a> | 307 <a NAME="HelpViewerWidget.emptyDocument" ID="HelpViewerWidget.emptyDocument"></a> |
| 309 <h4>HelpViewerWidget.emptyDocument (class method)</h4> | 308 <h4>HelpViewerWidget.emptyDocument (class method)</h4> |
| 310 <b>emptyDocument</b>(<i></i>) | 309 <b>emptyDocument</b>(<i></i>) |
| 311 | |
| 312 <p> | 310 <p> |
| 313 Class method to get the HTML code for an empty page. | 311 Class method to get the HTML code for an empty page. |
| 314 </p> | 312 </p> |
| 313 | |
| 315 <dl> | 314 <dl> |
| 316 <dt>Return:</dt> | 315 <dt>Return:</dt> |
| 317 <dd> | 316 <dd> |
| 318 HTML code for an empty page. | 317 HTML code for an empty page. |
| 319 </dd> | 318 </dd> |
| 325 </dd> | 324 </dd> |
| 326 </dl> | 325 </dl> |
| 327 <a NAME="HelpViewerWidget.__init__" ID="HelpViewerWidget.__init__"></a> | 326 <a NAME="HelpViewerWidget.__init__" ID="HelpViewerWidget.__init__"></a> |
| 328 <h4>HelpViewerWidget (Constructor)</h4> | 327 <h4>HelpViewerWidget (Constructor)</h4> |
| 329 <b>HelpViewerWidget</b>(<i>parent=None</i>) | 328 <b>HelpViewerWidget</b>(<i>parent=None</i>) |
| 330 | |
| 331 <p> | 329 <p> |
| 332 Constructor | 330 Constructor |
| 333 </p> | 331 </p> |
| 332 | |
| 334 <dl> | 333 <dl> |
| 335 | 334 |
| 336 <dt><i>parent</i> (QWidget (optional))</dt> | 335 <dt><i>parent</i> (QWidget (optional))</dt> |
| 337 <dd> | 336 <dd> |
| 338 reference to the parent widget (defaults to None) | 337 reference to the parent widget (defaults to None) |
| 339 </dd> | 338 </dd> |
| 340 </dl> | 339 </dl> |
| 341 <a NAME="HelpViewerWidget.__activateCurrentPage" ID="HelpViewerWidget.__activateCurrentPage"></a> | 340 <a NAME="HelpViewerWidget.__activateCurrentPage" ID="HelpViewerWidget.__activateCurrentPage"></a> |
| 342 <h4>HelpViewerWidget.__activateCurrentPage</h4> | 341 <h4>HelpViewerWidget.__activateCurrentPage</h4> |
| 343 <b>__activateCurrentPage</b>(<i></i>) | 342 <b>__activateCurrentPage</b>(<i></i>) |
| 344 | |
| 345 <p> | 343 <p> |
| 346 Private slot to activate the current page. | 344 Private slot to activate the current page. |
| 347 </p> | 345 </p> |
| 346 | |
| 348 <a NAME="HelpViewerWidget.__addNavigationButton" ID="HelpViewerWidget.__addNavigationButton"></a> | 347 <a NAME="HelpViewerWidget.__addNavigationButton" ID="HelpViewerWidget.__addNavigationButton"></a> |
| 349 <h4>HelpViewerWidget.__addNavigationButton</h4> | 348 <h4>HelpViewerWidget.__addNavigationButton</h4> |
| 350 <b>__addNavigationButton</b>(<i>iconName, toolTip</i>) | 349 <b>__addNavigationButton</b>(<i>iconName, toolTip</i>) |
| 351 | |
| 352 <p> | 350 <p> |
| 353 Private method to create and add a navigation button. | 351 Private method to create and add a navigation button. |
| 354 </p> | 352 </p> |
| 353 | |
| 355 <dl> | 354 <dl> |
| 356 | 355 |
| 357 <dt><i>iconName</i> (str)</dt> | 356 <dt><i>iconName</i> (str)</dt> |
| 358 <dd> | 357 <dd> |
| 359 name of the icon | 358 name of the icon |
| 376 </dd> | 375 </dd> |
| 377 </dl> | 376 </dl> |
| 378 <a NAME="HelpViewerWidget.__addNewPage" ID="HelpViewerWidget.__addNewPage"></a> | 377 <a NAME="HelpViewerWidget.__addNewPage" ID="HelpViewerWidget.__addNewPage"></a> |
| 379 <h4>HelpViewerWidget.__addNewPage</h4> | 378 <h4>HelpViewerWidget.__addNewPage</h4> |
| 380 <b>__addNewPage</b>(<i></i>) | 379 <b>__addNewPage</b>(<i></i>) |
| 381 | |
| 382 <p> | 380 <p> |
| 383 Private slot to add a new empty page. | 381 Private slot to add a new empty page. |
| 384 </p> | 382 </p> |
| 383 | |
| 385 <a NAME="HelpViewerWidget.__backward" ID="HelpViewerWidget.__backward"></a> | 384 <a NAME="HelpViewerWidget.__backward" ID="HelpViewerWidget.__backward"></a> |
| 386 <h4>HelpViewerWidget.__backward</h4> | 385 <h4>HelpViewerWidget.__backward</h4> |
| 387 <b>__backward</b>(<i></i>) | 386 <b>__backward</b>(<i></i>) |
| 388 | |
| 389 <p> | 387 <p> |
| 390 Private slot to move one page backward. | 388 Private slot to move one page backward. |
| 391 </p> | 389 </p> |
| 390 | |
| 392 <a NAME="HelpViewerWidget.__checkActionButtons" ID="HelpViewerWidget.__checkActionButtons"></a> | 391 <a NAME="HelpViewerWidget.__checkActionButtons" ID="HelpViewerWidget.__checkActionButtons"></a> |
| 393 <h4>HelpViewerWidget.__checkActionButtons</h4> | 392 <h4>HelpViewerWidget.__checkActionButtons</h4> |
| 394 <b>__checkActionButtons</b>(<i></i>) | 393 <b>__checkActionButtons</b>(<i></i>) |
| 395 | |
| 396 <p> | 394 <p> |
| 397 Private slot to set the enabled state of the action buttons. | 395 Private slot to set the enabled state of the action buttons. |
| 398 </p> | 396 </p> |
| 397 | |
| 399 <a NAME="HelpViewerWidget.__clearHistory" ID="HelpViewerWidget.__clearHistory"></a> | 398 <a NAME="HelpViewerWidget.__clearHistory" ID="HelpViewerWidget.__clearHistory"></a> |
| 400 <h4>HelpViewerWidget.__clearHistory</h4> | 399 <h4>HelpViewerWidget.__clearHistory</h4> |
| 401 <b>__clearHistory</b>(<i></i>) | 400 <b>__clearHistory</b>(<i></i>) |
| 402 | |
| 403 <p> | 401 <p> |
| 404 Private slot to clear the history of the current viewer. | 402 Private slot to clear the history of the current viewer. |
| 405 </p> | 403 </p> |
| 404 | |
| 406 <a NAME="HelpViewerWidget.__configureHelpDocumentation" ID="HelpViewerWidget.__configureHelpDocumentation"></a> | 405 <a NAME="HelpViewerWidget.__configureHelpDocumentation" ID="HelpViewerWidget.__configureHelpDocumentation"></a> |
| 407 <h4>HelpViewerWidget.__configureHelpDocumentation</h4> | 406 <h4>HelpViewerWidget.__configureHelpDocumentation</h4> |
| 408 <b>__configureHelpDocumentation</b>(<i></i>) | 407 <b>__configureHelpDocumentation</b>(<i></i>) |
| 409 | |
| 410 <p> | 408 <p> |
| 411 Private slot to open the Help Documentation configuration page. | 409 Private slot to open the Help Documentation configuration page. |
| 412 </p> | 410 </p> |
| 411 | |
| 413 <a NAME="HelpViewerWidget.__currentFilterChanged" ID="HelpViewerWidget.__currentFilterChanged"></a> | 412 <a NAME="HelpViewerWidget.__currentFilterChanged" ID="HelpViewerWidget.__currentFilterChanged"></a> |
| 414 <h4>HelpViewerWidget.__currentFilterChanged</h4> | 413 <h4>HelpViewerWidget.__currentFilterChanged</h4> |
| 415 <b>__currentFilterChanged</b>(<i>filter_</i>) | 414 <b>__currentFilterChanged</b>(<i>filter_</i>) |
| 416 | |
| 417 <p> | 415 <p> |
| 418 Private slot handling a change of the active QtHelp filter. | 416 Private slot handling a change of the active QtHelp filter. |
| 419 </p> | 417 </p> |
| 418 | |
| 420 <dl> | 419 <dl> |
| 421 | 420 |
| 422 <dt><i>filter_</i> (str)</dt> | 421 <dt><i>filter_</i> (str)</dt> |
| 423 <dd> | 422 <dd> |
| 424 filter name | 423 filter name |
| 425 </dd> | 424 </dd> |
| 426 </dl> | 425 </dl> |
| 427 <a NAME="HelpViewerWidget.__currentPageChanged" ID="HelpViewerWidget.__currentPageChanged"></a> | 426 <a NAME="HelpViewerWidget.__currentPageChanged" ID="HelpViewerWidget.__currentPageChanged"></a> |
| 428 <h4>HelpViewerWidget.__currentPageChanged</h4> | 427 <h4>HelpViewerWidget.__currentPageChanged</h4> |
| 429 <b>__currentPageChanged</b>(<i></i>) | 428 <b>__currentPageChanged</b>(<i></i>) |
| 430 | |
| 431 <p> | 429 <p> |
| 432 Private slot handling the selection of another page. | 430 Private slot handling the selection of another page. |
| 433 </p> | 431 </p> |
| 432 | |
| 434 <a NAME="HelpViewerWidget.__docsInstalled" ID="HelpViewerWidget.__docsInstalled"></a> | 433 <a NAME="HelpViewerWidget.__docsInstalled" ID="HelpViewerWidget.__docsInstalled"></a> |
| 435 <h4>HelpViewerWidget.__docsInstalled</h4> | 434 <h4>HelpViewerWidget.__docsInstalled</h4> |
| 436 <b>__docsInstalled</b>(<i>installed</i>) | 435 <b>__docsInstalled</b>(<i>installed</i>) |
| 437 | |
| 438 <p> | 436 <p> |
| 439 Private slot handling the end of documentation installation. | 437 Private slot handling the end of documentation installation. |
| 440 </p> | 438 </p> |
| 439 | |
| 441 <dl> | 440 <dl> |
| 442 | 441 |
| 443 <dt><i>installed</i> (bool)</dt> | 442 <dt><i>installed</i> (bool)</dt> |
| 444 <dd> | 443 <dd> |
| 445 flag indicating that documents were installed | 444 flag indicating that documents were installed |
| 446 </dd> | 445 </dd> |
| 447 </dl> | 446 </dl> |
| 448 <a NAME="HelpViewerWidget.__filterQtHelpDocumentation" ID="HelpViewerWidget.__filterQtHelpDocumentation"></a> | 447 <a NAME="HelpViewerWidget.__filterQtHelpDocumentation" ID="HelpViewerWidget.__filterQtHelpDocumentation"></a> |
| 449 <h4>HelpViewerWidget.__filterQtHelpDocumentation</h4> | 448 <h4>HelpViewerWidget.__filterQtHelpDocumentation</h4> |
| 450 <b>__filterQtHelpDocumentation</b>(<i>index</i>) | 449 <b>__filterQtHelpDocumentation</b>(<i>index</i>) |
| 451 | |
| 452 <p> | 450 <p> |
| 453 Private slot to filter the QtHelp documentation. | 451 Private slot to filter the QtHelp documentation. |
| 454 </p> | 452 </p> |
| 453 | |
| 455 <dl> | 454 <dl> |
| 456 | 455 |
| 457 <dt><i>index</i> (int)</dt> | 456 <dt><i>index</i> (int)</dt> |
| 458 <dd> | 457 <dd> |
| 459 index of the selected QtHelp documentation filter | 458 index of the selected QtHelp documentation filter |
| 460 </dd> | 459 </dd> |
| 461 </dl> | 460 </dl> |
| 462 <a NAME="HelpViewerWidget.__forward" ID="HelpViewerWidget.__forward"></a> | 461 <a NAME="HelpViewerWidget.__forward" ID="HelpViewerWidget.__forward"></a> |
| 463 <h4>HelpViewerWidget.__forward</h4> | 462 <h4>HelpViewerWidget.__forward</h4> |
| 464 <b>__forward</b>(<i></i>) | 463 <b>__forward</b>(<i></i>) |
| 465 | |
| 466 <p> | 464 <p> |
| 467 Private slot to move one page foreward. | 465 Private slot to move one page foreward. |
| 468 </p> | 466 </p> |
| 467 | |
| 469 <a NAME="HelpViewerWidget.__getQtHelpCollectionFileName" ID="HelpViewerWidget.__getQtHelpCollectionFileName"></a> | 468 <a NAME="HelpViewerWidget.__getQtHelpCollectionFileName" ID="HelpViewerWidget.__getQtHelpCollectionFileName"></a> |
| 470 <h4>HelpViewerWidget.__getQtHelpCollectionFileName</h4> | 469 <h4>HelpViewerWidget.__getQtHelpCollectionFileName</h4> |
| 471 <b>__getQtHelpCollectionFileName</b>(<i></i>) | 470 <b>__getQtHelpCollectionFileName</b>(<i></i>) |
| 472 | |
| 473 <p> | 471 <p> |
| 474 Private method to determine the name of the QtHelp collection file. | 472 Private method to determine the name of the QtHelp collection file. |
| 475 </p> | 473 </p> |
| 474 | |
| 476 <dl> | 475 <dl> |
| 477 <dt>Return:</dt> | 476 <dt>Return:</dt> |
| 478 <dd> | 477 <dd> |
| 479 path of the QtHelp collection file | 478 path of the QtHelp collection file |
| 480 </dd> | 479 </dd> |
| 486 </dd> | 485 </dd> |
| 487 </dl> | 486 </dl> |
| 488 <a NAME="HelpViewerWidget.__helpTopicSelected" ID="HelpViewerWidget.__helpTopicSelected"></a> | 487 <a NAME="HelpViewerWidget.__helpTopicSelected" ID="HelpViewerWidget.__helpTopicSelected"></a> |
| 489 <h4>HelpViewerWidget.__helpTopicSelected</h4> | 488 <h4>HelpViewerWidget.__helpTopicSelected</h4> |
| 490 <b>__helpTopicSelected</b>(<i></i>) | 489 <b>__helpTopicSelected</b>(<i></i>) |
| 491 | |
| 492 <p> | 490 <p> |
| 493 Private slot handling the selection of a new help topic. | 491 Private slot handling the selection of a new help topic. |
| 494 </p> | 492 </p> |
| 493 | |
| 495 <a NAME="HelpViewerWidget.__indexingFinished" ID="HelpViewerWidget.__indexingFinished"></a> | 494 <a NAME="HelpViewerWidget.__indexingFinished" ID="HelpViewerWidget.__indexingFinished"></a> |
| 496 <h4>HelpViewerWidget.__indexingFinished</h4> | 495 <h4>HelpViewerWidget.__indexingFinished</h4> |
| 497 <b>__indexingFinished</b>(<i></i>) | 496 <b>__indexingFinished</b>(<i></i>) |
| 498 | |
| 499 <p> | 497 <p> |
| 500 Private slot handling the end of the indexing process. | 498 Private slot handling the end of the indexing process. |
| 501 </p> | 499 </p> |
| 500 | |
| 502 <a NAME="HelpViewerWidget.__indexingStarted" ID="HelpViewerWidget.__indexingStarted"></a> | 501 <a NAME="HelpViewerWidget.__indexingStarted" ID="HelpViewerWidget.__indexingStarted"></a> |
| 503 <h4>HelpViewerWidget.__indexingStarted</h4> | 502 <h4>HelpViewerWidget.__indexingStarted</h4> |
| 504 <b>__indexingStarted</b>(<i></i>) | 503 <b>__indexingStarted</b>(<i></i>) |
| 505 | |
| 506 <p> | 504 <p> |
| 507 Private slot handling the start of the indexing process. | 505 Private slot handling the start of the indexing process. |
| 508 </p> | 506 </p> |
| 507 | |
| 509 <a NAME="HelpViewerWidget.__initActionsMenu" ID="HelpViewerWidget.__initActionsMenu"></a> | 508 <a NAME="HelpViewerWidget.__initActionsMenu" ID="HelpViewerWidget.__initActionsMenu"></a> |
| 510 <h4>HelpViewerWidget.__initActionsMenu</h4> | 509 <h4>HelpViewerWidget.__initActionsMenu</h4> |
| 511 <b>__initActionsMenu</b>(<i></i>) | 510 <b>__initActionsMenu</b>(<i></i>) |
| 512 | |
| 513 <p> | 511 <p> |
| 514 Private method to initialize the actions menu. | 512 Private method to initialize the actions menu. |
| 515 </p> | 513 </p> |
| 514 | |
| 516 <a NAME="HelpViewerWidget.__initFilterWidget" ID="HelpViewerWidget.__initFilterWidget"></a> | 515 <a NAME="HelpViewerWidget.__initFilterWidget" ID="HelpViewerWidget.__initFilterWidget"></a> |
| 517 <h4>HelpViewerWidget.__initFilterWidget</h4> | 516 <h4>HelpViewerWidget.__initFilterWidget</h4> |
| 518 <b>__initFilterWidget</b>(<i></i>) | 517 <b>__initFilterWidget</b>(<i></i>) |
| 519 | |
| 520 <p> | 518 <p> |
| 521 Private method to initialize the filter selection widget. | 519 Private method to initialize the filter selection widget. |
| 522 </p> | 520 </p> |
| 521 | |
| 523 <dl> | 522 <dl> |
| 524 <dt>Return:</dt> | 523 <dt>Return:</dt> |
| 525 <dd> | 524 <dd> |
| 526 reference to the generated widget | 525 reference to the generated widget |
| 527 </dd> | 526 </dd> |
| 533 </dd> | 532 </dd> |
| 534 </dl> | 533 </dl> |
| 535 <a NAME="HelpViewerWidget.__initHelpEngine" ID="HelpViewerWidget.__initHelpEngine"></a> | 534 <a NAME="HelpViewerWidget.__initHelpEngine" ID="HelpViewerWidget.__initHelpEngine"></a> |
| 536 <h4>HelpViewerWidget.__initHelpEngine</h4> | 535 <h4>HelpViewerWidget.__initHelpEngine</h4> |
| 537 <b>__initHelpEngine</b>(<i></i>) | 536 <b>__initHelpEngine</b>(<i></i>) |
| 538 | |
| 539 <p> | 537 <p> |
| 540 Private method to initialize the QtHelp related stuff. | 538 Private method to initialize the QtHelp related stuff. |
| 541 </p> | 539 </p> |
| 540 | |
| 542 <a NAME="HelpViewerWidget.__initIndexingProgress" ID="HelpViewerWidget.__initIndexingProgress"></a> | 541 <a NAME="HelpViewerWidget.__initIndexingProgress" ID="HelpViewerWidget.__initIndexingProgress"></a> |
| 543 <h4>HelpViewerWidget.__initIndexingProgress</h4> | 542 <h4>HelpViewerWidget.__initIndexingProgress</h4> |
| 544 <b>__initIndexingProgress</b>(<i></i>) | 543 <b>__initIndexingProgress</b>(<i></i>) |
| 545 | |
| 546 <p> | 544 <p> |
| 547 Private method to initialize the help documents indexing progress | 545 Private method to initialize the help documents indexing progress |
| 548 widget. | 546 widget. |
| 549 </p> | 547 </p> |
| 548 | |
| 550 <dl> | 549 <dl> |
| 551 <dt>Return:</dt> | 550 <dt>Return:</dt> |
| 552 <dd> | 551 <dd> |
| 553 reference to the generated widget | 552 reference to the generated widget |
| 554 </dd> | 553 </dd> |
| 560 </dd> | 559 </dd> |
| 561 </dl> | 560 </dl> |
| 562 <a NAME="HelpViewerWidget.__initQWebEngine" ID="HelpViewerWidget.__initQWebEngine"></a> | 561 <a NAME="HelpViewerWidget.__initQWebEngine" ID="HelpViewerWidget.__initQWebEngine"></a> |
| 563 <h4>HelpViewerWidget.__initQWebEngine</h4> | 562 <h4>HelpViewerWidget.__initQWebEngine</h4> |
| 564 <b>__initQWebEngine</b>(<i></i>) | 563 <b>__initQWebEngine</b>(<i></i>) |
| 565 | |
| 566 <p> | 564 <p> |
| 567 Private method to initialize global QWebEngine related objects. | 565 Private method to initialize global QWebEngine related objects. |
| 568 </p> | 566 </p> |
| 567 | |
| 569 <a NAME="HelpViewerWidget.__initQWebEngineSettings" ID="HelpViewerWidget.__initQWebEngineSettings"></a> | 568 <a NAME="HelpViewerWidget.__initQWebEngineSettings" ID="HelpViewerWidget.__initQWebEngineSettings"></a> |
| 570 <h4>HelpViewerWidget.__initQWebEngineSettings</h4> | 569 <h4>HelpViewerWidget.__initQWebEngineSettings</h4> |
| 571 <b>__initQWebEngineSettings</b>(<i></i>) | 570 <b>__initQWebEngineSettings</b>(<i></i>) |
| 572 | |
| 573 <p> | 571 <p> |
| 574 Private method to set the global web settings. | 572 Private method to set the global web settings. |
| 575 </p> | 573 </p> |
| 574 | |
| 576 <a NAME="HelpViewerWidget.__lookForNewDocumentation" ID="HelpViewerWidget.__lookForNewDocumentation"></a> | 575 <a NAME="HelpViewerWidget.__lookForNewDocumentation" ID="HelpViewerWidget.__lookForNewDocumentation"></a> |
| 577 <h4>HelpViewerWidget.__lookForNewDocumentation</h4> | 576 <h4>HelpViewerWidget.__lookForNewDocumentation</h4> |
| 578 <b>__lookForNewDocumentation</b>(<i></i>) | 577 <b>__lookForNewDocumentation</b>(<i></i>) |
| 579 | |
| 580 <p> | 578 <p> |
| 581 Private slot to look for new documentation to be loaded into the | 579 Private slot to look for new documentation to be loaded into the |
| 582 help database. | 580 help database. |
| 583 </p> | 581 </p> |
| 582 | |
| 584 <a NAME="HelpViewerWidget.__manageQtHelpDocuments" ID="HelpViewerWidget.__manageQtHelpDocuments"></a> | 583 <a NAME="HelpViewerWidget.__manageQtHelpDocuments" ID="HelpViewerWidget.__manageQtHelpDocuments"></a> |
| 585 <h4>HelpViewerWidget.__manageQtHelpDocuments</h4> | 584 <h4>HelpViewerWidget.__manageQtHelpDocuments</h4> |
| 586 <b>__manageQtHelpDocuments</b>(<i></i>) | 585 <b>__manageQtHelpDocuments</b>(<i></i>) |
| 587 | |
| 588 <p> | 586 <p> |
| 589 Private slot to manage the QtHelp documentation database. | 587 Private slot to manage the QtHelp documentation database. |
| 590 </p> | 588 </p> |
| 589 | |
| 591 <a NAME="HelpViewerWidget.__navigationMenuActionTriggered" ID="HelpViewerWidget.__navigationMenuActionTriggered"></a> | 590 <a NAME="HelpViewerWidget.__navigationMenuActionTriggered" ID="HelpViewerWidget.__navigationMenuActionTriggered"></a> |
| 592 <h4>HelpViewerWidget.__navigationMenuActionTriggered</h4> | 591 <h4>HelpViewerWidget.__navigationMenuActionTriggered</h4> |
| 593 <b>__navigationMenuActionTriggered</b>(<i>act</i>) | 592 <b>__navigationMenuActionTriggered</b>(<i>act</i>) |
| 594 | |
| 595 <p> | 593 <p> |
| 596 Private slot to go to the selected page. | 594 Private slot to go to the selected page. |
| 597 </p> | 595 </p> |
| 596 | |
| 598 <dl> | 597 <dl> |
| 599 | 598 |
| 600 <dt><i>act</i> (QAction)</dt> | 599 <dt><i>act</i> (QAction)</dt> |
| 601 <dd> | 600 <dd> |
| 602 reference to the action selected in the navigation menu | 601 reference to the action selected in the navigation menu |
| 603 </dd> | 602 </dd> |
| 604 </dl> | 603 </dl> |
| 605 <a NAME="HelpViewerWidget.__newViewer" ID="HelpViewerWidget.__newViewer"></a> | 604 <a NAME="HelpViewerWidget.__newViewer" ID="HelpViewerWidget.__newViewer"></a> |
| 606 <h4>HelpViewerWidget.__newViewer</h4> | 605 <h4>HelpViewerWidget.__newViewer</h4> |
| 607 <b>__newViewer</b>(<i></i>) | 606 <b>__newViewer</b>(<i></i>) |
| 608 | |
| 609 <p> | 607 <p> |
| 610 Private method to create a new help viewer. | 608 Private method to create a new help viewer. |
| 611 </p> | 609 </p> |
| 610 | |
| 612 <dl> | 611 <dl> |
| 613 <dt>Return:</dt> | 612 <dt>Return:</dt> |
| 614 <dd> | 613 <dd> |
| 615 tuple containing the reference to the created help viewer | 614 tuple containing the reference to the created help viewer |
| 616 object and its type | 615 object and its type |
| 623 </dd> | 622 </dd> |
| 624 </dl> | 623 </dl> |
| 625 <a NAME="HelpViewerWidget.__openFile" ID="HelpViewerWidget.__openFile"></a> | 624 <a NAME="HelpViewerWidget.__openFile" ID="HelpViewerWidget.__openFile"></a> |
| 626 <h4>HelpViewerWidget.__openFile</h4> | 625 <h4>HelpViewerWidget.__openFile</h4> |
| 627 <b>__openFile</b>(<i></i>) | 626 <b>__openFile</b>(<i></i>) |
| 628 | |
| 629 <p> | 627 <p> |
| 630 Private slot to open a local help file (*.html). | 628 Private slot to open a local help file (*.html). |
| 631 </p> | 629 </p> |
| 630 | |
| 632 <a NAME="HelpViewerWidget.__populateHelpSelector" ID="HelpViewerWidget.__populateHelpSelector"></a> | 631 <a NAME="HelpViewerWidget.__populateHelpSelector" ID="HelpViewerWidget.__populateHelpSelector"></a> |
| 633 <h4>HelpViewerWidget.__populateHelpSelector</h4> | 632 <h4>HelpViewerWidget.__populateHelpSelector</h4> |
| 634 <b>__populateHelpSelector</b>(<i></i>) | 633 <b>__populateHelpSelector</b>(<i></i>) |
| 635 | |
| 636 <p> | 634 <p> |
| 637 Private method to populate the help selection combo box. | 635 Private method to populate the help selection combo box. |
| 638 </p> | 636 </p> |
| 637 | |
| 639 <a NAME="HelpViewerWidget.__populateNavigationStack" ID="HelpViewerWidget.__populateNavigationStack"></a> | 638 <a NAME="HelpViewerWidget.__populateNavigationStack" ID="HelpViewerWidget.__populateNavigationStack"></a> |
| 640 <h4>HelpViewerWidget.__populateNavigationStack</h4> | 639 <h4>HelpViewerWidget.__populateNavigationStack</h4> |
| 641 <b>__populateNavigationStack</b>(<i></i>) | 640 <b>__populateNavigationStack</b>(<i></i>) |
| 642 | |
| 643 <p> | 641 <p> |
| 644 Private method to populate the stack of navigation widgets. | 642 Private method to populate the stack of navigation widgets. |
| 645 </p> | 643 </p> |
| 644 | |
| 646 <a NAME="HelpViewerWidget.__reload" ID="HelpViewerWidget.__reload"></a> | 645 <a NAME="HelpViewerWidget.__reload" ID="HelpViewerWidget.__reload"></a> |
| 647 <h4>HelpViewerWidget.__reload</h4> | 646 <h4>HelpViewerWidget.__reload</h4> |
| 648 <b>__reload</b>(<i></i>) | 647 <b>__reload</b>(<i></i>) |
| 649 | |
| 650 <p> | 648 <p> |
| 651 Private slot to reload the current page. | 649 Private slot to reload the current page. |
| 652 </p> | 650 </p> |
| 651 | |
| 653 <a NAME="HelpViewerWidget.__removeOldDocumentation" ID="HelpViewerWidget.__removeOldDocumentation"></a> | 652 <a NAME="HelpViewerWidget.__removeOldDocumentation" ID="HelpViewerWidget.__removeOldDocumentation"></a> |
| 654 <h4>HelpViewerWidget.__removeOldDocumentation</h4> | 653 <h4>HelpViewerWidget.__removeOldDocumentation</h4> |
| 655 <b>__removeOldDocumentation</b>(<i></i>) | 654 <b>__removeOldDocumentation</b>(<i></i>) |
| 656 | |
| 657 <p> | 655 <p> |
| 658 Private slot to remove non-existing documentation from the help engine. | 656 Private slot to remove non-existing documentation from the help engine. |
| 659 </p> | 657 </p> |
| 658 | |
| 660 <a NAME="HelpViewerWidget.__searchWidgetClosed" ID="HelpViewerWidget.__searchWidgetClosed"></a> | 659 <a NAME="HelpViewerWidget.__searchWidgetClosed" ID="HelpViewerWidget.__searchWidgetClosed"></a> |
| 661 <h4>HelpViewerWidget.__searchWidgetClosed</h4> | 660 <h4>HelpViewerWidget.__searchWidgetClosed</h4> |
| 662 <b>__searchWidgetClosed</b>(<i></i>) | 661 <b>__searchWidgetClosed</b>(<i></i>) |
| 663 | |
| 664 <p> | 662 <p> |
| 665 Private slot to handle the closing of the search widget. | 663 Private slot to handle the closing of the search widget. |
| 666 </p> | 664 </p> |
| 665 | |
| 667 <a NAME="HelpViewerWidget.__selectNavigationWidget" ID="HelpViewerWidget.__selectNavigationWidget"></a> | 666 <a NAME="HelpViewerWidget.__selectNavigationWidget" ID="HelpViewerWidget.__selectNavigationWidget"></a> |
| 668 <h4>HelpViewerWidget.__selectNavigationWidget</h4> | 667 <h4>HelpViewerWidget.__selectNavigationWidget</h4> |
| 669 <b>__selectNavigationWidget</b>(<i>button</i>) | 668 <b>__selectNavigationWidget</b>(<i>button</i>) |
| 670 | |
| 671 <p> | 669 <p> |
| 672 Private slot to select the navigation widget. | 670 Private slot to select the navigation widget. |
| 673 </p> | 671 </p> |
| 672 | |
| 674 <dl> | 673 <dl> |
| 675 | 674 |
| 676 <dt><i>button</i> (QAbstractButton)</dt> | 675 <dt><i>button</i> (QAbstractButton)</dt> |
| 677 <dd> | 676 <dd> |
| 678 reference to the clicked button | 677 reference to the clicked button |
| 679 </dd> | 678 </dd> |
| 680 </dl> | 679 </dl> |
| 681 <a NAME="HelpViewerWidget.__setupFilterCombo" ID="HelpViewerWidget.__setupFilterCombo"></a> | 680 <a NAME="HelpViewerWidget.__setupFilterCombo" ID="HelpViewerWidget.__setupFilterCombo"></a> |
| 682 <h4>HelpViewerWidget.__setupFilterCombo</h4> | 681 <h4>HelpViewerWidget.__setupFilterCombo</h4> |
| 683 <b>__setupFilterCombo</b>(<i></i>) | 682 <b>__setupFilterCombo</b>(<i></i>) |
| 684 | |
| 685 <p> | 683 <p> |
| 686 Private slot to setup the filter combo box. | 684 Private slot to setup the filter combo box. |
| 687 </p> | 685 </p> |
| 686 | |
| 688 <a NAME="HelpViewerWidget.__showBackMenu" ID="HelpViewerWidget.__showBackMenu"></a> | 687 <a NAME="HelpViewerWidget.__showBackMenu" ID="HelpViewerWidget.__showBackMenu"></a> |
| 689 <h4>HelpViewerWidget.__showBackMenu</h4> | 688 <h4>HelpViewerWidget.__showBackMenu</h4> |
| 690 <b>__showBackMenu</b>(<i></i>) | 689 <b>__showBackMenu</b>(<i></i>) |
| 691 | |
| 692 <p> | 690 <p> |
| 693 Private slot showing the backward navigation menu. | 691 Private slot showing the backward navigation menu. |
| 694 </p> | 692 </p> |
| 693 | |
| 695 <a NAME="HelpViewerWidget.__showForwardMenu" ID="HelpViewerWidget.__showForwardMenu"></a> | 694 <a NAME="HelpViewerWidget.__showForwardMenu" ID="HelpViewerWidget.__showForwardMenu"></a> |
| 696 <h4>HelpViewerWidget.__showForwardMenu</h4> | 695 <h4>HelpViewerWidget.__showForwardMenu</h4> |
| 697 <b>__showForwardMenu</b>(<i></i>) | 696 <b>__showForwardMenu</b>(<i></i>) |
| 698 | |
| 699 <p> | 697 <p> |
| 700 Private slot showing the forward navigation menu. | 698 Private slot showing the forward navigation menu. |
| 701 </p> | 699 </p> |
| 700 | |
| 702 <a NAME="HelpViewerWidget.__showInstallationError" ID="HelpViewerWidget.__showInstallationError"></a> | 701 <a NAME="HelpViewerWidget.__showInstallationError" ID="HelpViewerWidget.__showInstallationError"></a> |
| 703 <h4>HelpViewerWidget.__showInstallationError</h4> | 702 <h4>HelpViewerWidget.__showInstallationError</h4> |
| 704 <b>__showInstallationError</b>(<i>message</i>) | 703 <b>__showInstallationError</b>(<i>message</i>) |
| 705 | |
| 706 <p> | 704 <p> |
| 707 Private slot to show installation errors. | 705 Private slot to show installation errors. |
| 708 </p> | 706 </p> |
| 707 | |
| 709 <dl> | 708 <dl> |
| 710 | 709 |
| 711 <dt><i>message</i> (str)</dt> | 710 <dt><i>message</i> (str)</dt> |
| 712 <dd> | 711 <dd> |
| 713 message to be shown | 712 message to be shown |
| 714 </dd> | 713 </dd> |
| 715 </dl> | 714 </dl> |
| 716 <a NAME="HelpViewerWidget.__warning" ID="HelpViewerWidget.__warning"></a> | 715 <a NAME="HelpViewerWidget.__warning" ID="HelpViewerWidget.__warning"></a> |
| 717 <h4>HelpViewerWidget.__warning</h4> | 716 <h4>HelpViewerWidget.__warning</h4> |
| 718 <b>__warning</b>(<i>msg</i>) | 717 <b>__warning</b>(<i>msg</i>) |
| 719 | |
| 720 <p> | 718 <p> |
| 721 Private slot handling warnings of the help engine. | 719 Private slot handling warnings of the help engine. |
| 722 </p> | 720 </p> |
| 721 | |
| 723 <dl> | 722 <dl> |
| 724 | 723 |
| 725 <dt><i>msg</i> (str)</dt> | 724 <dt><i>msg</i> (str)</dt> |
| 726 <dd> | 725 <dd> |
| 727 message sent by the help engine | 726 message sent by the help engine |
| 728 </dd> | 727 </dd> |
| 729 </dl> | 728 </dl> |
| 730 <a NAME="HelpViewerWidget.__zoomIn" ID="HelpViewerWidget.__zoomIn"></a> | 729 <a NAME="HelpViewerWidget.__zoomIn" ID="HelpViewerWidget.__zoomIn"></a> |
| 731 <h4>HelpViewerWidget.__zoomIn</h4> | 730 <h4>HelpViewerWidget.__zoomIn</h4> |
| 732 <b>__zoomIn</b>(<i></i>) | 731 <b>__zoomIn</b>(<i></i>) |
| 733 | |
| 734 <p> | 732 <p> |
| 735 Private slot to zoom in. | 733 Private slot to zoom in. |
| 736 </p> | 734 </p> |
| 735 | |
| 737 <a NAME="HelpViewerWidget.__zoomOut" ID="HelpViewerWidget.__zoomOut"></a> | 736 <a NAME="HelpViewerWidget.__zoomOut" ID="HelpViewerWidget.__zoomOut"></a> |
| 738 <h4>HelpViewerWidget.__zoomOut</h4> | 737 <h4>HelpViewerWidget.__zoomOut</h4> |
| 739 <b>__zoomOut</b>(<i></i>) | 738 <b>__zoomOut</b>(<i></i>) |
| 740 | |
| 741 <p> | 739 <p> |
| 742 Private slot to zoom out. | 740 Private slot to zoom out. |
| 743 </p> | 741 </p> |
| 742 | |
| 744 <a NAME="HelpViewerWidget.__zoomReset" ID="HelpViewerWidget.__zoomReset"></a> | 743 <a NAME="HelpViewerWidget.__zoomReset" ID="HelpViewerWidget.__zoomReset"></a> |
| 745 <h4>HelpViewerWidget.__zoomReset</h4> | 744 <h4>HelpViewerWidget.__zoomReset</h4> |
| 746 <b>__zoomReset</b>(<i></i>) | 745 <b>__zoomReset</b>(<i></i>) |
| 747 | |
| 748 <p> | 746 <p> |
| 749 Private slot to reset the zoom level. | 747 Private slot to reset the zoom level. |
| 750 </p> | 748 </p> |
| 749 | |
| 751 <a NAME="HelpViewerWidget.activate" ID="HelpViewerWidget.activate"></a> | 750 <a NAME="HelpViewerWidget.activate" ID="HelpViewerWidget.activate"></a> |
| 752 <h4>HelpViewerWidget.activate</h4> | 751 <h4>HelpViewerWidget.activate</h4> |
| 753 <b>activate</b>(<i>searchWord=None, url=None</i>) | 752 <b>activate</b>(<i>searchWord=None, url=None</i>) |
| 754 | |
| 755 <p> | 753 <p> |
| 756 Public method to activate the widget and search for a given word. | 754 Public method to activate the widget and search for a given word. |
| 757 </p> | 755 </p> |
| 756 | |
| 758 <dl> | 757 <dl> |
| 759 | 758 |
| 760 <dt><i>searchWord</i> (str (optional))</dt> | 759 <dt><i>searchWord</i> (str (optional))</dt> |
| 761 <dd> | 760 <dd> |
| 762 word to search for (defaults to None) | 761 word to search for (defaults to None) |
| 767 </dd> | 766 </dd> |
| 768 </dl> | 767 </dl> |
| 769 <a NAME="HelpViewerWidget.addPage" ID="HelpViewerWidget.addPage"></a> | 768 <a NAME="HelpViewerWidget.addPage" ID="HelpViewerWidget.addPage"></a> |
| 770 <h4>HelpViewerWidget.addPage</h4> | 769 <h4>HelpViewerWidget.addPage</h4> |
| 771 <b>addPage</b>(<i>url=None, background=False</i>) | 770 <b>addPage</b>(<i>url=None, background=False</i>) |
| 772 | |
| 773 <p> | 771 <p> |
| 774 Public method to add a new help page with the given URL. | 772 Public method to add a new help page with the given URL. |
| 775 </p> | 773 </p> |
| 774 | |
| 776 <dl> | 775 <dl> |
| 777 | 776 |
| 778 <dt><i>url</i> (QUrl (optional))</dt> | 777 <dt><i>url</i> (QUrl (optional))</dt> |
| 779 <dd> | 778 <dd> |
| 780 requested URL (defaults to QUrl("about:blank")) | 779 requested URL (defaults to QUrl("about:blank")) |
| 798 </dd> | 797 </dd> |
| 799 </dl> | 798 </dl> |
| 800 <a NAME="HelpViewerWidget.bookmarkPage" ID="HelpViewerWidget.bookmarkPage"></a> | 799 <a NAME="HelpViewerWidget.bookmarkPage" ID="HelpViewerWidget.bookmarkPage"></a> |
| 801 <h4>HelpViewerWidget.bookmarkPage</h4> | 800 <h4>HelpViewerWidget.bookmarkPage</h4> |
| 802 <b>bookmarkPage</b>(<i>title, url</i>) | 801 <b>bookmarkPage</b>(<i>title, url</i>) |
| 803 | |
| 804 <p> | 802 <p> |
| 805 Public method to bookmark a page with the given data. | 803 Public method to bookmark a page with the given data. |
| 806 </p> | 804 </p> |
| 805 | |
| 807 <dl> | 806 <dl> |
| 808 | 807 |
| 809 <dt><i>title</i> (str)</dt> | 808 <dt><i>title</i> (str)</dt> |
| 810 <dd> | 809 <dd> |
| 811 title of the page | 810 title of the page |
| 816 </dd> | 815 </dd> |
| 817 </dl> | 816 </dl> |
| 818 <a NAME="HelpViewerWidget.closeAllPages" ID="HelpViewerWidget.closeAllPages"></a> | 817 <a NAME="HelpViewerWidget.closeAllPages" ID="HelpViewerWidget.closeAllPages"></a> |
| 819 <h4>HelpViewerWidget.closeAllPages</h4> | 818 <h4>HelpViewerWidget.closeAllPages</h4> |
| 820 <b>closeAllPages</b>(<i></i>) | 819 <b>closeAllPages</b>(<i></i>) |
| 821 | |
| 822 <p> | 820 <p> |
| 823 Public slot to close all pages. | 821 Public slot to close all pages. |
| 824 </p> | 822 </p> |
| 823 | |
| 825 <a NAME="HelpViewerWidget.closeCurrentPage" ID="HelpViewerWidget.closeCurrentPage"></a> | 824 <a NAME="HelpViewerWidget.closeCurrentPage" ID="HelpViewerWidget.closeCurrentPage"></a> |
| 826 <h4>HelpViewerWidget.closeCurrentPage</h4> | 825 <h4>HelpViewerWidget.closeCurrentPage</h4> |
| 827 <b>closeCurrentPage</b>(<i></i>) | 826 <b>closeCurrentPage</b>(<i></i>) |
| 828 | |
| 829 <p> | 827 <p> |
| 830 Public slot to close the current page. | 828 Public slot to close the current page. |
| 831 </p> | 829 </p> |
| 830 | |
| 832 <a NAME="HelpViewerWidget.closeOtherPages" ID="HelpViewerWidget.closeOtherPages"></a> | 831 <a NAME="HelpViewerWidget.closeOtherPages" ID="HelpViewerWidget.closeOtherPages"></a> |
| 833 <h4>HelpViewerWidget.closeOtherPages</h4> | 832 <h4>HelpViewerWidget.closeOtherPages</h4> |
| 834 <b>closeOtherPages</b>(<i></i>) | 833 <b>closeOtherPages</b>(<i></i>) |
| 835 | |
| 836 <p> | 834 <p> |
| 837 Public slot to close all other pages. | 835 Public slot to close all other pages. |
| 838 </p> | 836 </p> |
| 837 | |
| 839 <a NAME="HelpViewerWidget.currentViewer" ID="HelpViewerWidget.currentViewer"></a> | 838 <a NAME="HelpViewerWidget.currentViewer" ID="HelpViewerWidget.currentViewer"></a> |
| 840 <h4>HelpViewerWidget.currentViewer</h4> | 839 <h4>HelpViewerWidget.currentViewer</h4> |
| 841 <b>currentViewer</b>(<i></i>) | 840 <b>currentViewer</b>(<i></i>) |
| 842 | |
| 843 <p> | 841 <p> |
| 844 Public method to get the active viewer. | 842 Public method to get the active viewer. |
| 845 </p> | 843 </p> |
| 844 | |
| 846 <dl> | 845 <dl> |
| 847 <dt>Return:</dt> | 846 <dt>Return:</dt> |
| 848 <dd> | 847 <dd> |
| 849 reference to the active help viewer | 848 reference to the active help viewer |
| 850 </dd> | 849 </dd> |
| 856 </dd> | 855 </dd> |
| 857 </dl> | 856 </dl> |
| 858 <a NAME="HelpViewerWidget.openPagesCount" ID="HelpViewerWidget.openPagesCount"></a> | 857 <a NAME="HelpViewerWidget.openPagesCount" ID="HelpViewerWidget.openPagesCount"></a> |
| 859 <h4>HelpViewerWidget.openPagesCount</h4> | 858 <h4>HelpViewerWidget.openPagesCount</h4> |
| 860 <b>openPagesCount</b>(<i></i>) | 859 <b>openPagesCount</b>(<i></i>) |
| 861 | |
| 862 <p> | 860 <p> |
| 863 Public method to get the count of open pages. | 861 Public method to get the count of open pages. |
| 864 </p> | 862 </p> |
| 863 | |
| 865 <dl> | 864 <dl> |
| 866 <dt>Return:</dt> | 865 <dt>Return:</dt> |
| 867 <dd> | 866 <dd> |
| 868 count of open pages | 867 count of open pages |
| 869 </dd> | 868 </dd> |
| 875 </dd> | 874 </dd> |
| 876 </dl> | 875 </dl> |
| 877 <a NAME="HelpViewerWidget.openUrl" ID="HelpViewerWidget.openUrl"></a> | 876 <a NAME="HelpViewerWidget.openUrl" ID="HelpViewerWidget.openUrl"></a> |
| 878 <h4>HelpViewerWidget.openUrl</h4> | 877 <h4>HelpViewerWidget.openUrl</h4> |
| 879 <b>openUrl</b>(<i>url</i>) | 878 <b>openUrl</b>(<i>url</i>) |
| 880 | |
| 881 <p> | 879 <p> |
| 882 Public slot to load a URL in the current page. | 880 Public slot to load a URL in the current page. |
| 883 </p> | 881 </p> |
| 882 | |
| 884 <dl> | 883 <dl> |
| 885 | 884 |
| 886 <dt><i>url</i> (QUrl)</dt> | 885 <dt><i>url</i> (QUrl)</dt> |
| 887 <dd> | 886 <dd> |
| 888 URL to be opened | 887 URL to be opened |
| 889 </dd> | 888 </dd> |
| 890 </dl> | 889 </dl> |
| 891 <a NAME="HelpViewerWidget.openUrlNewBackgroundPage" ID="HelpViewerWidget.openUrlNewBackgroundPage"></a> | 890 <a NAME="HelpViewerWidget.openUrlNewBackgroundPage" ID="HelpViewerWidget.openUrlNewBackgroundPage"></a> |
| 892 <h4>HelpViewerWidget.openUrlNewBackgroundPage</h4> | 891 <h4>HelpViewerWidget.openUrlNewBackgroundPage</h4> |
| 893 <b>openUrlNewBackgroundPage</b>(<i>url</i>) | 892 <b>openUrlNewBackgroundPage</b>(<i>url</i>) |
| 894 | |
| 895 <p> | 893 <p> |
| 896 Public slot to load a URL in a new background page. | 894 Public slot to load a URL in a new background page. |
| 897 </p> | 895 </p> |
| 896 | |
| 898 <dl> | 897 <dl> |
| 899 | 898 |
| 900 <dt><i>url</i> (QUrl)</dt> | 899 <dt><i>url</i> (QUrl)</dt> |
| 901 <dd> | 900 <dd> |
| 902 URL to be opened | 901 URL to be opened |
| 903 </dd> | 902 </dd> |
| 904 </dl> | 903 </dl> |
| 905 <a NAME="HelpViewerWidget.openUrlNewPage" ID="HelpViewerWidget.openUrlNewPage"></a> | 904 <a NAME="HelpViewerWidget.openUrlNewPage" ID="HelpViewerWidget.openUrlNewPage"></a> |
| 906 <h4>HelpViewerWidget.openUrlNewPage</h4> | 905 <h4>HelpViewerWidget.openUrlNewPage</h4> |
| 907 <b>openUrlNewPage</b>(<i>url</i>) | 906 <b>openUrlNewPage</b>(<i>url</i>) |
| 908 | |
| 909 <p> | 907 <p> |
| 910 Public slot to load a URL in a new page. | 908 Public slot to load a URL in a new page. |
| 911 </p> | 909 </p> |
| 910 | |
| 912 <dl> | 911 <dl> |
| 913 | 912 |
| 914 <dt><i>url</i> (QUrl)</dt> | 913 <dt><i>url</i> (QUrl)</dt> |
| 915 <dd> | 914 <dd> |
| 916 URL to be opened | 915 URL to be opened |
| 917 </dd> | 916 </dd> |
| 918 </dl> | 917 </dl> |
| 919 <a NAME="HelpViewerWidget.searchNext" ID="HelpViewerWidget.searchNext"></a> | 918 <a NAME="HelpViewerWidget.searchNext" ID="HelpViewerWidget.searchNext"></a> |
| 920 <h4>HelpViewerWidget.searchNext</h4> | 919 <h4>HelpViewerWidget.searchNext</h4> |
| 921 <b>searchNext</b>(<i></i>) | 920 <b>searchNext</b>(<i></i>) |
| 922 | |
| 923 <p> | 921 <p> |
| 924 Public slot to find the next occurrence of the current search term. | 922 Public slot to find the next occurrence of the current search term. |
| 925 </p> | 923 </p> |
| 924 | |
| 926 <a NAME="HelpViewerWidget.searchPrev" ID="HelpViewerWidget.searchPrev"></a> | 925 <a NAME="HelpViewerWidget.searchPrev" ID="HelpViewerWidget.searchPrev"></a> |
| 927 <h4>HelpViewerWidget.searchPrev</h4> | 926 <h4>HelpViewerWidget.searchPrev</h4> |
| 928 <b>searchPrev</b>(<i></i>) | 927 <b>searchPrev</b>(<i></i>) |
| 929 | |
| 930 <p> | 928 <p> |
| 931 Public slot to find the previous occurrence of the current search term. | 929 Public slot to find the previous occurrence of the current search term. |
| 932 </p> | 930 </p> |
| 931 | |
| 933 <a NAME="HelpViewerWidget.searchQtHelp" ID="HelpViewerWidget.searchQtHelp"></a> | 932 <a NAME="HelpViewerWidget.searchQtHelp" ID="HelpViewerWidget.searchQtHelp"></a> |
| 934 <h4>HelpViewerWidget.searchQtHelp</h4> | 933 <h4>HelpViewerWidget.searchQtHelp</h4> |
| 935 <b>searchQtHelp</b>(<i>searchExpression</i>) | 934 <b>searchQtHelp</b>(<i>searchExpression</i>) |
| 936 | |
| 937 <p> | 935 <p> |
| 938 Public slot to search for a given search expression. | 936 Public slot to search for a given search expression. |
| 939 </p> | 937 </p> |
| 938 | |
| 940 <dl> | 939 <dl> |
| 941 | 940 |
| 942 <dt><i>searchExpression</i> (str)</dt> | 941 <dt><i>searchExpression</i> (str)</dt> |
| 943 <dd> | 942 <dd> |
| 944 expression to search for | 943 expression to search for |
| 945 </dd> | 944 </dd> |
| 946 </dl> | 945 </dl> |
| 947 <a NAME="HelpViewerWidget.showHideSearch" ID="HelpViewerWidget.showHideSearch"></a> | 946 <a NAME="HelpViewerWidget.showHideSearch" ID="HelpViewerWidget.showHideSearch"></a> |
| 948 <h4>HelpViewerWidget.showHideSearch</h4> | 947 <h4>HelpViewerWidget.showHideSearch</h4> |
| 949 <b>showHideSearch</b>(<i>visible</i>) | 948 <b>showHideSearch</b>(<i>visible</i>) |
| 950 | |
| 951 <p> | 949 <p> |
| 952 Public slot to show or hide the search widget. | 950 Public slot to show or hide the search widget. |
| 953 </p> | 951 </p> |
| 952 | |
| 954 <dl> | 953 <dl> |
| 955 | 954 |
| 956 <dt><i>visible</i> (bool)</dt> | 955 <dt><i>visible</i> (bool)</dt> |
| 957 <dd> | 956 <dd> |
| 958 flag indicating to show or hide the search widget | 957 flag indicating to show or hide the search widget |
| 959 </dd> | 958 </dd> |
| 960 </dl> | 959 </dl> |
| 961 <a NAME="HelpViewerWidget.shutdown" ID="HelpViewerWidget.shutdown"></a> | 960 <a NAME="HelpViewerWidget.shutdown" ID="HelpViewerWidget.shutdown"></a> |
| 962 <h4>HelpViewerWidget.shutdown</h4> | 961 <h4>HelpViewerWidget.shutdown</h4> |
| 963 <b>shutdown</b>(<i></i>) | 962 <b>shutdown</b>(<i></i>) |
| 964 | |
| 965 <p> | 963 <p> |
| 966 Public method to perform shut down actions. | 964 Public method to perform shut down actions. |
| 967 </p> | 965 </p> |
| 966 | |
| 968 <a NAME="HelpViewerWidget.webProfile" ID="HelpViewerWidget.webProfile"></a> | 967 <a NAME="HelpViewerWidget.webProfile" ID="HelpViewerWidget.webProfile"></a> |
| 969 <h4>HelpViewerWidget.webProfile</h4> | 968 <h4>HelpViewerWidget.webProfile</h4> |
| 970 <b>webProfile</b>(<i></i>) | 969 <b>webProfile</b>(<i></i>) |
| 971 | |
| 972 <p> | 970 <p> |
| 973 Public method to get a reference to the global web profile object. | 971 Public method to get a reference to the global web profile object. |
| 974 </p> | 972 </p> |
| 973 | |
| 975 <dl> | 974 <dl> |
| 976 <dt>Return:</dt> | 975 <dt>Return:</dt> |
| 977 <dd> | 976 <dd> |
| 978 reference to the global web profile object | 977 reference to the global web profile object |
| 979 </dd> | 978 </dd> |
| 985 </dd> | 984 </dd> |
| 986 </dl> | 985 </dl> |
| 987 <a NAME="HelpViewerWidget.webSettings" ID="HelpViewerWidget.webSettings"></a> | 986 <a NAME="HelpViewerWidget.webSettings" ID="HelpViewerWidget.webSettings"></a> |
| 988 <h4>HelpViewerWidget.webSettings</h4> | 987 <h4>HelpViewerWidget.webSettings</h4> |
| 989 <b>webSettings</b>(<i></i>) | 988 <b>webSettings</b>(<i></i>) |
| 990 | |
| 991 <p> | 989 <p> |
| 992 Public method to get the web settings of the current profile. | 990 Public method to get the web settings of the current profile. |
| 993 </p> | 991 </p> |
| 992 | |
| 994 <dl> | 993 <dl> |
| 995 <dt>Return:</dt> | 994 <dt>Return:</dt> |
| 996 <dd> | 995 <dd> |
| 997 web settings of the current profile | 996 web settings of the current profile |
| 998 </dd> | 997 </dd> |
