Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.HelpViewer.HelpViewerWidget.html
eric7/Documentation/Source/eric7.HelpViewer.HelpViewerWidget.html
- branch
- eric7
- changeset 8752
- 3c1ea4dfb691
- child 8763
- a99f822a3da7
equal
deleted
inserted
replaced
| 8751:4a6c2ccd880f | 8752:3c1ea4dfb691 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.HelpViewer.HelpViewerWidget</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.HelpViewer.HelpViewerWidget</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing an embedded viewer for QtHelp and local HTML files. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#HelpViewerWidget">HelpViewerWidget</a></td> | |
| 25 <td>Class implementing an embedded viewer for QtHelp and local HTML files.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="HelpViewerWidget" ID="HelpViewerWidget"></a> | |
| 36 <h2>HelpViewerWidget</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing an embedded viewer for QtHelp and local HTML files. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QWidget | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>MaxHistoryItems</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#HelpViewerWidget.__init__">HelpViewerWidget</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#HelpViewerWidget.__activateCurrentPage">__activateCurrentPage</a></td> | |
| 63 <td>Private slot to activate the current page.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#HelpViewerWidget.__addNavigationButton">__addNavigationButton</a></td> | |
| 67 <td>Private method to create and add a navigation button.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#HelpViewerWidget.__addNewPage">__addNewPage</a></td> | |
| 71 <td>Private slot to add a new empty page.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#HelpViewerWidget.__backward">__backward</a></td> | |
| 75 <td>Private slot to move one page backward.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#HelpViewerWidget.__checkActionButtons">__checkActionButtons</a></td> | |
| 79 <td>Private slot to set the enabled state of the action buttons.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#HelpViewerWidget.__clearHistory">__clearHistory</a></td> | |
| 83 <td>Private slot to clear the history of the current viewer.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#HelpViewerWidget.__currentFilterChanged">__currentFilterChanged</a></td> | |
| 87 <td>Private slot handling a change of the active QtHelp filter.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#HelpViewerWidget.__currentPageChanged">__currentPageChanged</a></td> | |
| 91 <td>Private slot handling the selection of another page.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#HelpViewerWidget.__docsInstalled">__docsInstalled</a></td> | |
| 95 <td>Private slot handling the end of documentation installation.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#HelpViewerWidget.__filterQtHelpDocumentation">__filterQtHelpDocumentation</a></td> | |
| 99 <td>Private slot to filter the QtHelp documentation.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#HelpViewerWidget.__forward">__forward</a></td> | |
| 103 <td>Private slot to move one page foreward.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#HelpViewerWidget.__getQtHelpCollectionFileName">__getQtHelpCollectionFileName</a></td> | |
| 107 <td>Private method to determine the name of the QtHelp collection file.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#HelpViewerWidget.__helpTopicSelected">__helpTopicSelected</a></td> | |
| 111 <td>Private slot handling the selection of a new help topic.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#HelpViewerWidget.__indexingFinished">__indexingFinished</a></td> | |
| 115 <td>Private slot handling the end of the indexing process.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#HelpViewerWidget.__indexingStarted">__indexingStarted</a></td> | |
| 119 <td>Private slot handling the start of the indexing process.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#HelpViewerWidget.__initActionsMenu">__initActionsMenu</a></td> | |
| 123 <td>Private method to initialize the actions menu.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#HelpViewerWidget.__initFilterWidget">__initFilterWidget</a></td> | |
| 127 <td>Private method to initialize the filter selection widget.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#HelpViewerWidget.__initHelpEngine">__initHelpEngine</a></td> | |
| 131 <td>Private method to initialize the QtHelp related stuff.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#HelpViewerWidget.__initIndexingProgress">__initIndexingProgress</a></td> | |
| 135 <td>Private method to initialize the help documents indexing progress widget.</td> | |
| 136 </tr> | |
| 137 <tr> | |
| 138 <td><a href="#HelpViewerWidget.__initQWebEngine">__initQWebEngine</a></td> | |
| 139 <td>Private method to initialize global QWebEngine related objects.</td> | |
| 140 </tr> | |
| 141 <tr> | |
| 142 <td><a href="#HelpViewerWidget.__initQWebEngineSettings">__initQWebEngineSettings</a></td> | |
| 143 <td>Private method to set the global web settings.</td> | |
| 144 </tr> | |
| 145 <tr> | |
| 146 <td><a href="#HelpViewerWidget.__lookForNewDocumentation">__lookForNewDocumentation</a></td> | |
| 147 <td>Private slot to look for new documentation to be loaded into the help database.</td> | |
| 148 </tr> | |
| 149 <tr> | |
| 150 <td><a href="#HelpViewerWidget.__manageQtHelpDocuments">__manageQtHelpDocuments</a></td> | |
| 151 <td>Private slot to manage the QtHelp documentation database.</td> | |
| 152 </tr> | |
| 153 <tr> | |
| 154 <td><a href="#HelpViewerWidget.__navigationMenuActionTriggered">__navigationMenuActionTriggered</a></td> | |
| 155 <td>Private slot to go to the selected page.</td> | |
| 156 </tr> | |
| 157 <tr> | |
| 158 <td><a href="#HelpViewerWidget.__newViewer">__newViewer</a></td> | |
| 159 <td>Private method to create a new help viewer.</td> | |
| 160 </tr> | |
| 161 <tr> | |
| 162 <td><a href="#HelpViewerWidget.__openFile">__openFile</a></td> | |
| 163 <td>Private slot to open a local help file (*.html).</td> | |
| 164 </tr> | |
| 165 <tr> | |
| 166 <td><a href="#HelpViewerWidget.__populateHelpSelector">__populateHelpSelector</a></td> | |
| 167 <td>Private method to populate the help selection combo box.</td> | |
| 168 </tr> | |
| 169 <tr> | |
| 170 <td><a href="#HelpViewerWidget.__populateNavigationStack">__populateNavigationStack</a></td> | |
| 171 <td>Private method to populate the stack of navigation widgets.</td> | |
| 172 </tr> | |
| 173 <tr> | |
| 174 <td><a href="#HelpViewerWidget.__reload">__reload</a></td> | |
| 175 <td>Private slot to reload the current page.</td> | |
| 176 </tr> | |
| 177 <tr> | |
| 178 <td><a href="#HelpViewerWidget.__removeOldDocumentation">__removeOldDocumentation</a></td> | |
| 179 <td>Private slot to remove non-existing documentation from the help engine.</td> | |
| 180 </tr> | |
| 181 <tr> | |
| 182 <td><a href="#HelpViewerWidget.__searchWidgetClosed">__searchWidgetClosed</a></td> | |
| 183 <td>Private slot to handle the closing of the search widget.</td> | |
| 184 </tr> | |
| 185 <tr> | |
| 186 <td><a href="#HelpViewerWidget.__selectNavigationWidget">__selectNavigationWidget</a></td> | |
| 187 <td>Private slot to select the navigation widget.</td> | |
| 188 </tr> | |
| 189 <tr> | |
| 190 <td><a href="#HelpViewerWidget.__setupFilterCombo">__setupFilterCombo</a></td> | |
| 191 <td>Private slot to setup the filter combo box.</td> | |
| 192 </tr> | |
| 193 <tr> | |
| 194 <td><a href="#HelpViewerWidget.__showBackMenu">__showBackMenu</a></td> | |
| 195 <td>Private slot showing the backward navigation menu.</td> | |
| 196 </tr> | |
| 197 <tr> | |
| 198 <td><a href="#HelpViewerWidget.__showForwardMenu">__showForwardMenu</a></td> | |
| 199 <td>Private slot showing the forward navigation menu.</td> | |
| 200 </tr> | |
| 201 <tr> | |
| 202 <td><a href="#HelpViewerWidget.__showInstallationError">__showInstallationError</a></td> | |
| 203 <td>Private slot to show installation errors.</td> | |
| 204 </tr> | |
| 205 <tr> | |
| 206 <td><a href="#HelpViewerWidget.__warning">__warning</a></td> | |
| 207 <td>Private slot handling warnings of the help engine.</td> | |
| 208 </tr> | |
| 209 <tr> | |
| 210 <td><a href="#HelpViewerWidget.__zoomIn">__zoomIn</a></td> | |
| 211 <td>Private slot to zoom in.</td> | |
| 212 </tr> | |
| 213 <tr> | |
| 214 <td><a href="#HelpViewerWidget.__zoomOut">__zoomOut</a></td> | |
| 215 <td>Private slot to zoom out.</td> | |
| 216 </tr> | |
| 217 <tr> | |
| 218 <td><a href="#HelpViewerWidget.__zoomReset">__zoomReset</a></td> | |
| 219 <td>Private slot to reset the zoom level.</td> | |
| 220 </tr> | |
| 221 <tr> | |
| 222 <td><a href="#HelpViewerWidget.activate">activate</a></td> | |
| 223 <td>Public method to activate the widget and search for a given word.</td> | |
| 224 </tr> | |
| 225 <tr> | |
| 226 <td><a href="#HelpViewerWidget.addPage">addPage</a></td> | |
| 227 <td>Public method to add a new help page with the given URL.</td> | |
| 228 </tr> | |
| 229 <tr> | |
| 230 <td><a href="#HelpViewerWidget.closeAllPages">closeAllPages</a></td> | |
| 231 <td>Public slot to close all pages.</td> | |
| 232 </tr> | |
| 233 <tr> | |
| 234 <td><a href="#HelpViewerWidget.closeCurrentPage">closeCurrentPage</a></td> | |
| 235 <td>Public slot to close the current page.</td> | |
| 236 </tr> | |
| 237 <tr> | |
| 238 <td><a href="#HelpViewerWidget.closeOtherPages">closeOtherPages</a></td> | |
| 239 <td>Public slot to close all other pages.</td> | |
| 240 </tr> | |
| 241 <tr> | |
| 242 <td><a href="#HelpViewerWidget.currentViewer">currentViewer</a></td> | |
| 243 <td>Public method to get the active viewer.</td> | |
| 244 </tr> | |
| 245 <tr> | |
| 246 <td><a href="#HelpViewerWidget.openPagesCount">openPagesCount</a></td> | |
| 247 <td>Public method to get the count of open pages.</td> | |
| 248 </tr> | |
| 249 <tr> | |
| 250 <td><a href="#HelpViewerWidget.openUrl">openUrl</a></td> | |
| 251 <td>Public slot to load a URL in the current page.</td> | |
| 252 </tr> | |
| 253 <tr> | |
| 254 <td><a href="#HelpViewerWidget.openUrlNewBackgroundPage">openUrlNewBackgroundPage</a></td> | |
| 255 <td>Public slot to load a URL in a new background page.</td> | |
| 256 </tr> | |
| 257 <tr> | |
| 258 <td><a href="#HelpViewerWidget.openUrlNewPage">openUrlNewPage</a></td> | |
| 259 <td>Public slot to load a URL in a new page.</td> | |
| 260 </tr> | |
| 261 <tr> | |
| 262 <td><a href="#HelpViewerWidget.searchNext">searchNext</a></td> | |
| 263 <td>Public slot to find the next occurrence of the current search term.</td> | |
| 264 </tr> | |
| 265 <tr> | |
| 266 <td><a href="#HelpViewerWidget.searchPrev">searchPrev</a></td> | |
| 267 <td>Public slot to find the previous occurrence of the current search term.</td> | |
| 268 </tr> | |
| 269 <tr> | |
| 270 <td><a href="#HelpViewerWidget.searchQtHelp">searchQtHelp</a></td> | |
| 271 <td>Public slot to search for a given search expression.</td> | |
| 272 </tr> | |
| 273 <tr> | |
| 274 <td><a href="#HelpViewerWidget.showHideSearch">showHideSearch</a></td> | |
| 275 <td>Public slot to show or hide the search widget.</td> | |
| 276 </tr> | |
| 277 <tr> | |
| 278 <td><a href="#HelpViewerWidget.shutdown">shutdown</a></td> | |
| 279 <td>Public method to perform shut down actions.</td> | |
| 280 </tr> | |
| 281 <tr> | |
| 282 <td><a href="#HelpViewerWidget.webProfile">webProfile</a></td> | |
| 283 <td>Public method to get a reference to the global web profile object.</td> | |
| 284 </tr> | |
| 285 <tr> | |
| 286 <td><a href="#HelpViewerWidget.webSettings">webSettings</a></td> | |
| 287 <td>Public method to get the web settings of the current profile.</td> | |
| 288 </tr> | |
| 289 </table> | |
| 290 <h3>Static Methods</h3> | |
| 291 | |
| 292 <table> | |
| 293 <tr><td>None</td></tr> | |
| 294 </table> | |
| 295 | |
| 296 <a NAME="HelpViewerWidget.__init__" ID="HelpViewerWidget.__init__"></a> | |
| 297 <h4>HelpViewerWidget (Constructor)</h4> | |
| 298 <b>HelpViewerWidget</b>(<i>parent=None</i>) | |
| 299 | |
| 300 <p> | |
| 301 Constructor | |
| 302 </p> | |
| 303 <dl> | |
| 304 | |
| 305 <dt><i>parent</i> (QWidget (optional))</dt> | |
| 306 <dd> | |
| 307 reference to the parent widget (defaults to None) | |
| 308 </dd> | |
| 309 </dl> | |
| 310 <a NAME="HelpViewerWidget.__activateCurrentPage" ID="HelpViewerWidget.__activateCurrentPage"></a> | |
| 311 <h4>HelpViewerWidget.__activateCurrentPage</h4> | |
| 312 <b>__activateCurrentPage</b>(<i></i>) | |
| 313 | |
| 314 <p> | |
| 315 Private slot to activate the current page. | |
| 316 </p> | |
| 317 <a NAME="HelpViewerWidget.__addNavigationButton" ID="HelpViewerWidget.__addNavigationButton"></a> | |
| 318 <h4>HelpViewerWidget.__addNavigationButton</h4> | |
| 319 <b>__addNavigationButton</b>(<i>iconName, toolTip</i>) | |
| 320 | |
| 321 <p> | |
| 322 Private method to create and add a navigation button. | |
| 323 </p> | |
| 324 <dl> | |
| 325 | |
| 326 <dt><i>iconName</i> (str)</dt> | |
| 327 <dd> | |
| 328 name of the icon | |
| 329 </dd> | |
| 330 <dt><i>toolTip</i> (str)</dt> | |
| 331 <dd> | |
| 332 tooltip to be shown | |
| 333 </dd> | |
| 334 </dl> | |
| 335 <dl> | |
| 336 <dt>Return:</dt> | |
| 337 <dd> | |
| 338 reference to the created button | |
| 339 </dd> | |
| 340 </dl> | |
| 341 <dl> | |
| 342 <dt>Return Type:</dt> | |
| 343 <dd> | |
| 344 QToolButton | |
| 345 </dd> | |
| 346 </dl> | |
| 347 <a NAME="HelpViewerWidget.__addNewPage" ID="HelpViewerWidget.__addNewPage"></a> | |
| 348 <h4>HelpViewerWidget.__addNewPage</h4> | |
| 349 <b>__addNewPage</b>(<i></i>) | |
| 350 | |
| 351 <p> | |
| 352 Private slot to add a new empty page. | |
| 353 </p> | |
| 354 <a NAME="HelpViewerWidget.__backward" ID="HelpViewerWidget.__backward"></a> | |
| 355 <h4>HelpViewerWidget.__backward</h4> | |
| 356 <b>__backward</b>(<i></i>) | |
| 357 | |
| 358 <p> | |
| 359 Private slot to move one page backward. | |
| 360 </p> | |
| 361 <a NAME="HelpViewerWidget.__checkActionButtons" ID="HelpViewerWidget.__checkActionButtons"></a> | |
| 362 <h4>HelpViewerWidget.__checkActionButtons</h4> | |
| 363 <b>__checkActionButtons</b>(<i></i>) | |
| 364 | |
| 365 <p> | |
| 366 Private slot to set the enabled state of the action buttons. | |
| 367 </p> | |
| 368 <a NAME="HelpViewerWidget.__clearHistory" ID="HelpViewerWidget.__clearHistory"></a> | |
| 369 <h4>HelpViewerWidget.__clearHistory</h4> | |
| 370 <b>__clearHistory</b>(<i></i>) | |
| 371 | |
| 372 <p> | |
| 373 Private slot to clear the history of the current viewer. | |
| 374 </p> | |
| 375 <a NAME="HelpViewerWidget.__currentFilterChanged" ID="HelpViewerWidget.__currentFilterChanged"></a> | |
| 376 <h4>HelpViewerWidget.__currentFilterChanged</h4> | |
| 377 <b>__currentFilterChanged</b>(<i>filter_</i>) | |
| 378 | |
| 379 <p> | |
| 380 Private slot handling a change of the active QtHelp filter. | |
| 381 </p> | |
| 382 <dl> | |
| 383 | |
| 384 <dt><i>filter_</i> (str)</dt> | |
| 385 <dd> | |
| 386 filter name | |
| 387 </dd> | |
| 388 </dl> | |
| 389 <a NAME="HelpViewerWidget.__currentPageChanged" ID="HelpViewerWidget.__currentPageChanged"></a> | |
| 390 <h4>HelpViewerWidget.__currentPageChanged</h4> | |
| 391 <b>__currentPageChanged</b>(<i></i>) | |
| 392 | |
| 393 <p> | |
| 394 Private slot handling the selection of another page. | |
| 395 </p> | |
| 396 <a NAME="HelpViewerWidget.__docsInstalled" ID="HelpViewerWidget.__docsInstalled"></a> | |
| 397 <h4>HelpViewerWidget.__docsInstalled</h4> | |
| 398 <b>__docsInstalled</b>(<i>installed</i>) | |
| 399 | |
| 400 <p> | |
| 401 Private slot handling the end of documentation installation. | |
| 402 </p> | |
| 403 <dl> | |
| 404 | |
| 405 <dt><i>installed</i> (bool)</dt> | |
| 406 <dd> | |
| 407 flag indicating that documents were installed | |
| 408 </dd> | |
| 409 </dl> | |
| 410 <a NAME="HelpViewerWidget.__filterQtHelpDocumentation" ID="HelpViewerWidget.__filterQtHelpDocumentation"></a> | |
| 411 <h4>HelpViewerWidget.__filterQtHelpDocumentation</h4> | |
| 412 <b>__filterQtHelpDocumentation</b>(<i>index</i>) | |
| 413 | |
| 414 <p> | |
| 415 Private slot to filter the QtHelp documentation. | |
| 416 </p> | |
| 417 <dl> | |
| 418 | |
| 419 <dt><i>index</i> (int)</dt> | |
| 420 <dd> | |
| 421 index of the selected QtHelp documentation filter | |
| 422 </dd> | |
| 423 </dl> | |
| 424 <a NAME="HelpViewerWidget.__forward" ID="HelpViewerWidget.__forward"></a> | |
| 425 <h4>HelpViewerWidget.__forward</h4> | |
| 426 <b>__forward</b>(<i></i>) | |
| 427 | |
| 428 <p> | |
| 429 Private slot to move one page foreward. | |
| 430 </p> | |
| 431 <a NAME="HelpViewerWidget.__getQtHelpCollectionFileName" ID="HelpViewerWidget.__getQtHelpCollectionFileName"></a> | |
| 432 <h4>HelpViewerWidget.__getQtHelpCollectionFileName</h4> | |
| 433 <b>__getQtHelpCollectionFileName</b>(<i></i>) | |
| 434 | |
| 435 <p> | |
| 436 Private method to determine the name of the QtHelp collection file. | |
| 437 </p> | |
| 438 <dl> | |
| 439 <dt>Return:</dt> | |
| 440 <dd> | |
| 441 path of the QtHelp collection file | |
| 442 </dd> | |
| 443 </dl> | |
| 444 <dl> | |
| 445 <dt>Return Type:</dt> | |
| 446 <dd> | |
| 447 str | |
| 448 </dd> | |
| 449 </dl> | |
| 450 <a NAME="HelpViewerWidget.__helpTopicSelected" ID="HelpViewerWidget.__helpTopicSelected"></a> | |
| 451 <h4>HelpViewerWidget.__helpTopicSelected</h4> | |
| 452 <b>__helpTopicSelected</b>(<i></i>) | |
| 453 | |
| 454 <p> | |
| 455 Private slot handling the selection of a new help topic. | |
| 456 </p> | |
| 457 <a NAME="HelpViewerWidget.__indexingFinished" ID="HelpViewerWidget.__indexingFinished"></a> | |
| 458 <h4>HelpViewerWidget.__indexingFinished</h4> | |
| 459 <b>__indexingFinished</b>(<i></i>) | |
| 460 | |
| 461 <p> | |
| 462 Private slot handling the end of the indexing process. | |
| 463 </p> | |
| 464 <a NAME="HelpViewerWidget.__indexingStarted" ID="HelpViewerWidget.__indexingStarted"></a> | |
| 465 <h4>HelpViewerWidget.__indexingStarted</h4> | |
| 466 <b>__indexingStarted</b>(<i></i>) | |
| 467 | |
| 468 <p> | |
| 469 Private slot handling the start of the indexing process. | |
| 470 </p> | |
| 471 <a NAME="HelpViewerWidget.__initActionsMenu" ID="HelpViewerWidget.__initActionsMenu"></a> | |
| 472 <h4>HelpViewerWidget.__initActionsMenu</h4> | |
| 473 <b>__initActionsMenu</b>(<i></i>) | |
| 474 | |
| 475 <p> | |
| 476 Private method to initialize the actions menu. | |
| 477 </p> | |
| 478 <a NAME="HelpViewerWidget.__initFilterWidget" ID="HelpViewerWidget.__initFilterWidget"></a> | |
| 479 <h4>HelpViewerWidget.__initFilterWidget</h4> | |
| 480 <b>__initFilterWidget</b>(<i></i>) | |
| 481 | |
| 482 <p> | |
| 483 Private method to initialize the filter selection widget. | |
| 484 </p> | |
| 485 <dl> | |
| 486 <dt>Return:</dt> | |
| 487 <dd> | |
| 488 reference to the generated widget | |
| 489 </dd> | |
| 490 </dl> | |
| 491 <dl> | |
| 492 <dt>Return Type:</dt> | |
| 493 <dd> | |
| 494 QWidget | |
| 495 </dd> | |
| 496 </dl> | |
| 497 <a NAME="HelpViewerWidget.__initHelpEngine" ID="HelpViewerWidget.__initHelpEngine"></a> | |
| 498 <h4>HelpViewerWidget.__initHelpEngine</h4> | |
| 499 <b>__initHelpEngine</b>(<i></i>) | |
| 500 | |
| 501 <p> | |
| 502 Private method to initialize the QtHelp related stuff. | |
| 503 </p> | |
| 504 <a NAME="HelpViewerWidget.__initIndexingProgress" ID="HelpViewerWidget.__initIndexingProgress"></a> | |
| 505 <h4>HelpViewerWidget.__initIndexingProgress</h4> | |
| 506 <b>__initIndexingProgress</b>(<i></i>) | |
| 507 | |
| 508 <p> | |
| 509 Private method to initialize the help documents indexing progress | |
| 510 widget. | |
| 511 </p> | |
| 512 <dl> | |
| 513 <dt>Return:</dt> | |
| 514 <dd> | |
| 515 reference to the generated widget | |
| 516 </dd> | |
| 517 </dl> | |
| 518 <dl> | |
| 519 <dt>Return Type:</dt> | |
| 520 <dd> | |
| 521 QWidget | |
| 522 </dd> | |
| 523 </dl> | |
| 524 <a NAME="HelpViewerWidget.__initQWebEngine" ID="HelpViewerWidget.__initQWebEngine"></a> | |
| 525 <h4>HelpViewerWidget.__initQWebEngine</h4> | |
| 526 <b>__initQWebEngine</b>(<i></i>) | |
| 527 | |
| 528 <p> | |
| 529 Private method to initialize global QWebEngine related objects. | |
| 530 </p> | |
| 531 <a NAME="HelpViewerWidget.__initQWebEngineSettings" ID="HelpViewerWidget.__initQWebEngineSettings"></a> | |
| 532 <h4>HelpViewerWidget.__initQWebEngineSettings</h4> | |
| 533 <b>__initQWebEngineSettings</b>(<i></i>) | |
| 534 | |
| 535 <p> | |
| 536 Private method to set the global web settings. | |
| 537 </p> | |
| 538 <a NAME="HelpViewerWidget.__lookForNewDocumentation" ID="HelpViewerWidget.__lookForNewDocumentation"></a> | |
| 539 <h4>HelpViewerWidget.__lookForNewDocumentation</h4> | |
| 540 <b>__lookForNewDocumentation</b>(<i></i>) | |
| 541 | |
| 542 <p> | |
| 543 Private slot to look for new documentation to be loaded into the | |
| 544 help database. | |
| 545 </p> | |
| 546 <a NAME="HelpViewerWidget.__manageQtHelpDocuments" ID="HelpViewerWidget.__manageQtHelpDocuments"></a> | |
| 547 <h4>HelpViewerWidget.__manageQtHelpDocuments</h4> | |
| 548 <b>__manageQtHelpDocuments</b>(<i></i>) | |
| 549 | |
| 550 <p> | |
| 551 Private slot to manage the QtHelp documentation database. | |
| 552 </p> | |
| 553 <a NAME="HelpViewerWidget.__navigationMenuActionTriggered" ID="HelpViewerWidget.__navigationMenuActionTriggered"></a> | |
| 554 <h4>HelpViewerWidget.__navigationMenuActionTriggered</h4> | |
| 555 <b>__navigationMenuActionTriggered</b>(<i>act</i>) | |
| 556 | |
| 557 <p> | |
| 558 Private slot to go to the selected page. | |
| 559 </p> | |
| 560 <dl> | |
| 561 | |
| 562 <dt><i>act</i> (QAction)</dt> | |
| 563 <dd> | |
| 564 reference to the action selected in the navigation menu | |
| 565 </dd> | |
| 566 </dl> | |
| 567 <a NAME="HelpViewerWidget.__newViewer" ID="HelpViewerWidget.__newViewer"></a> | |
| 568 <h4>HelpViewerWidget.__newViewer</h4> | |
| 569 <b>__newViewer</b>(<i></i>) | |
| 570 | |
| 571 <p> | |
| 572 Private method to create a new help viewer. | |
| 573 </p> | |
| 574 <dl> | |
| 575 <dt>Return:</dt> | |
| 576 <dd> | |
| 577 tuple containing the reference to the created help viewer | |
| 578 object and its type | |
| 579 </dd> | |
| 580 </dl> | |
| 581 <dl> | |
| 582 <dt>Return Type:</dt> | |
| 583 <dd> | |
| 584 tuple of (HelpViewerImpl, EricTextEditType) | |
| 585 </dd> | |
| 586 </dl> | |
| 587 <a NAME="HelpViewerWidget.__openFile" ID="HelpViewerWidget.__openFile"></a> | |
| 588 <h4>HelpViewerWidget.__openFile</h4> | |
| 589 <b>__openFile</b>(<i></i>) | |
| 590 | |
| 591 <p> | |
| 592 Private slot to open a local help file (*.html). | |
| 593 </p> | |
| 594 <a NAME="HelpViewerWidget.__populateHelpSelector" ID="HelpViewerWidget.__populateHelpSelector"></a> | |
| 595 <h4>HelpViewerWidget.__populateHelpSelector</h4> | |
| 596 <b>__populateHelpSelector</b>(<i></i>) | |
| 597 | |
| 598 <p> | |
| 599 Private method to populate the help selection combo box. | |
| 600 </p> | |
| 601 <a NAME="HelpViewerWidget.__populateNavigationStack" ID="HelpViewerWidget.__populateNavigationStack"></a> | |
| 602 <h4>HelpViewerWidget.__populateNavigationStack</h4> | |
| 603 <b>__populateNavigationStack</b>(<i></i>) | |
| 604 | |
| 605 <p> | |
| 606 Private method to populate the stack of navigation widgets. | |
| 607 </p> | |
| 608 <a NAME="HelpViewerWidget.__reload" ID="HelpViewerWidget.__reload"></a> | |
| 609 <h4>HelpViewerWidget.__reload</h4> | |
| 610 <b>__reload</b>(<i></i>) | |
| 611 | |
| 612 <p> | |
| 613 Private slot to reload the current page. | |
| 614 </p> | |
| 615 <a NAME="HelpViewerWidget.__removeOldDocumentation" ID="HelpViewerWidget.__removeOldDocumentation"></a> | |
| 616 <h4>HelpViewerWidget.__removeOldDocumentation</h4> | |
| 617 <b>__removeOldDocumentation</b>(<i></i>) | |
| 618 | |
| 619 <p> | |
| 620 Private slot to remove non-existing documentation from the help engine. | |
| 621 </p> | |
| 622 <a NAME="HelpViewerWidget.__searchWidgetClosed" ID="HelpViewerWidget.__searchWidgetClosed"></a> | |
| 623 <h4>HelpViewerWidget.__searchWidgetClosed</h4> | |
| 624 <b>__searchWidgetClosed</b>(<i></i>) | |
| 625 | |
| 626 <p> | |
| 627 Private slot to handle the closing of the search widget. | |
| 628 </p> | |
| 629 <a NAME="HelpViewerWidget.__selectNavigationWidget" ID="HelpViewerWidget.__selectNavigationWidget"></a> | |
| 630 <h4>HelpViewerWidget.__selectNavigationWidget</h4> | |
| 631 <b>__selectNavigationWidget</b>(<i>button</i>) | |
| 632 | |
| 633 <p> | |
| 634 Private slot to select the navigation widget. | |
| 635 </p> | |
| 636 <dl> | |
| 637 | |
| 638 <dt><i>button</i> (QAbstractButton)</dt> | |
| 639 <dd> | |
| 640 reference to the clicked button | |
| 641 </dd> | |
| 642 </dl> | |
| 643 <a NAME="HelpViewerWidget.__setupFilterCombo" ID="HelpViewerWidget.__setupFilterCombo"></a> | |
| 644 <h4>HelpViewerWidget.__setupFilterCombo</h4> | |
| 645 <b>__setupFilterCombo</b>(<i></i>) | |
| 646 | |
| 647 <p> | |
| 648 Private slot to setup the filter combo box. | |
| 649 </p> | |
| 650 <a NAME="HelpViewerWidget.__showBackMenu" ID="HelpViewerWidget.__showBackMenu"></a> | |
| 651 <h4>HelpViewerWidget.__showBackMenu</h4> | |
| 652 <b>__showBackMenu</b>(<i></i>) | |
| 653 | |
| 654 <p> | |
| 655 Private slot showing the backward navigation menu. | |
| 656 </p> | |
| 657 <a NAME="HelpViewerWidget.__showForwardMenu" ID="HelpViewerWidget.__showForwardMenu"></a> | |
| 658 <h4>HelpViewerWidget.__showForwardMenu</h4> | |
| 659 <b>__showForwardMenu</b>(<i></i>) | |
| 660 | |
| 661 <p> | |
| 662 Private slot showing the forward navigation menu. | |
| 663 </p> | |
| 664 <a NAME="HelpViewerWidget.__showInstallationError" ID="HelpViewerWidget.__showInstallationError"></a> | |
| 665 <h4>HelpViewerWidget.__showInstallationError</h4> | |
| 666 <b>__showInstallationError</b>(<i>message</i>) | |
| 667 | |
| 668 <p> | |
| 669 Private slot to show installation errors. | |
| 670 </p> | |
| 671 <dl> | |
| 672 | |
| 673 <dt><i>message</i> (str)</dt> | |
| 674 <dd> | |
| 675 message to be shown | |
| 676 </dd> | |
| 677 </dl> | |
| 678 <a NAME="HelpViewerWidget.__warning" ID="HelpViewerWidget.__warning"></a> | |
| 679 <h4>HelpViewerWidget.__warning</h4> | |
| 680 <b>__warning</b>(<i>msg</i>) | |
| 681 | |
| 682 <p> | |
| 683 Private slot handling warnings of the help engine. | |
| 684 </p> | |
| 685 <dl> | |
| 686 | |
| 687 <dt><i>msg</i> (str)</dt> | |
| 688 <dd> | |
| 689 message sent by the help engine | |
| 690 </dd> | |
| 691 </dl> | |
| 692 <a NAME="HelpViewerWidget.__zoomIn" ID="HelpViewerWidget.__zoomIn"></a> | |
| 693 <h4>HelpViewerWidget.__zoomIn</h4> | |
| 694 <b>__zoomIn</b>(<i></i>) | |
| 695 | |
| 696 <p> | |
| 697 Private slot to zoom in. | |
| 698 </p> | |
| 699 <a NAME="HelpViewerWidget.__zoomOut" ID="HelpViewerWidget.__zoomOut"></a> | |
| 700 <h4>HelpViewerWidget.__zoomOut</h4> | |
| 701 <b>__zoomOut</b>(<i></i>) | |
| 702 | |
| 703 <p> | |
| 704 Private slot to zoom out. | |
| 705 </p> | |
| 706 <a NAME="HelpViewerWidget.__zoomReset" ID="HelpViewerWidget.__zoomReset"></a> | |
| 707 <h4>HelpViewerWidget.__zoomReset</h4> | |
| 708 <b>__zoomReset</b>(<i></i>) | |
| 709 | |
| 710 <p> | |
| 711 Private slot to reset the zoom level. | |
| 712 </p> | |
| 713 <a NAME="HelpViewerWidget.activate" ID="HelpViewerWidget.activate"></a> | |
| 714 <h4>HelpViewerWidget.activate</h4> | |
| 715 <b>activate</b>(<i>searchWord=None, url=None</i>) | |
| 716 | |
| 717 <p> | |
| 718 Public method to activate the widget and search for a given word. | |
| 719 </p> | |
| 720 <dl> | |
| 721 | |
| 722 <dt><i>searchWord</i> (str (optional))</dt> | |
| 723 <dd> | |
| 724 word to search for (defaults to None) | |
| 725 </dd> | |
| 726 <dt><i>url</i> (QUrl)</dt> | |
| 727 <dd> | |
| 728 URL to show in a new page | |
| 729 </dd> | |
| 730 </dl> | |
| 731 <a NAME="HelpViewerWidget.addPage" ID="HelpViewerWidget.addPage"></a> | |
| 732 <h4>HelpViewerWidget.addPage</h4> | |
| 733 <b>addPage</b>(<i>url=None, background=False</i>) | |
| 734 | |
| 735 <p> | |
| 736 Public method to add a new help page with the given URL. | |
| 737 </p> | |
| 738 <dl> | |
| 739 | |
| 740 <dt><i>url</i> (QUrl (optional))</dt> | |
| 741 <dd> | |
| 742 requested URL (defaults to QUrl("about:blank")) | |
| 743 </dd> | |
| 744 <dt><i>background</i> (bool (optional))</dt> | |
| 745 <dd> | |
| 746 flag indicating to open the page in the background | |
| 747 (defaults to False) | |
| 748 </dd> | |
| 749 </dl> | |
| 750 <dl> | |
| 751 <dt>Return:</dt> | |
| 752 <dd> | |
| 753 reference to the created page | |
| 754 </dd> | |
| 755 </dl> | |
| 756 <dl> | |
| 757 <dt>Return Type:</dt> | |
| 758 <dd> | |
| 759 HelpViewerImpl | |
| 760 </dd> | |
| 761 </dl> | |
| 762 <a NAME="HelpViewerWidget.closeAllPages" ID="HelpViewerWidget.closeAllPages"></a> | |
| 763 <h4>HelpViewerWidget.closeAllPages</h4> | |
| 764 <b>closeAllPages</b>(<i></i>) | |
| 765 | |
| 766 <p> | |
| 767 Public slot to close all pages. | |
| 768 </p> | |
| 769 <a NAME="HelpViewerWidget.closeCurrentPage" ID="HelpViewerWidget.closeCurrentPage"></a> | |
| 770 <h4>HelpViewerWidget.closeCurrentPage</h4> | |
| 771 <b>closeCurrentPage</b>(<i></i>) | |
| 772 | |
| 773 <p> | |
| 774 Public slot to close the current page. | |
| 775 </p> | |
| 776 <a NAME="HelpViewerWidget.closeOtherPages" ID="HelpViewerWidget.closeOtherPages"></a> | |
| 777 <h4>HelpViewerWidget.closeOtherPages</h4> | |
| 778 <b>closeOtherPages</b>(<i></i>) | |
| 779 | |
| 780 <p> | |
| 781 Public slot to close all other pages. | |
| 782 </p> | |
| 783 <a NAME="HelpViewerWidget.currentViewer" ID="HelpViewerWidget.currentViewer"></a> | |
| 784 <h4>HelpViewerWidget.currentViewer</h4> | |
| 785 <b>currentViewer</b>(<i></i>) | |
| 786 | |
| 787 <p> | |
| 788 Public method to get the active viewer. | |
| 789 </p> | |
| 790 <dl> | |
| 791 <dt>Return:</dt> | |
| 792 <dd> | |
| 793 reference to the active help viewer | |
| 794 </dd> | |
| 795 </dl> | |
| 796 <dl> | |
| 797 <dt>Return Type:</dt> | |
| 798 <dd> | |
| 799 HelpViewerImpl | |
| 800 </dd> | |
| 801 </dl> | |
| 802 <a NAME="HelpViewerWidget.openPagesCount" ID="HelpViewerWidget.openPagesCount"></a> | |
| 803 <h4>HelpViewerWidget.openPagesCount</h4> | |
| 804 <b>openPagesCount</b>(<i></i>) | |
| 805 | |
| 806 <p> | |
| 807 Public method to get the count of open pages. | |
| 808 </p> | |
| 809 <dl> | |
| 810 <dt>Return:</dt> | |
| 811 <dd> | |
| 812 count of open pages | |
| 813 </dd> | |
| 814 </dl> | |
| 815 <dl> | |
| 816 <dt>Return Type:</dt> | |
| 817 <dd> | |
| 818 int | |
| 819 </dd> | |
| 820 </dl> | |
| 821 <a NAME="HelpViewerWidget.openUrl" ID="HelpViewerWidget.openUrl"></a> | |
| 822 <h4>HelpViewerWidget.openUrl</h4> | |
| 823 <b>openUrl</b>(<i>url</i>) | |
| 824 | |
| 825 <p> | |
| 826 Public slot to load a URL in the current page. | |
| 827 </p> | |
| 828 <dl> | |
| 829 | |
| 830 <dt><i>url</i> (QUrl)</dt> | |
| 831 <dd> | |
| 832 URL to be opened | |
| 833 </dd> | |
| 834 </dl> | |
| 835 <a NAME="HelpViewerWidget.openUrlNewBackgroundPage" ID="HelpViewerWidget.openUrlNewBackgroundPage"></a> | |
| 836 <h4>HelpViewerWidget.openUrlNewBackgroundPage</h4> | |
| 837 <b>openUrlNewBackgroundPage</b>(<i>url</i>) | |
| 838 | |
| 839 <p> | |
| 840 Public slot to load a URL in a new background page. | |
| 841 </p> | |
| 842 <dl> | |
| 843 | |
| 844 <dt><i>url</i> (QUrl)</dt> | |
| 845 <dd> | |
| 846 URL to be opened | |
| 847 </dd> | |
| 848 </dl> | |
| 849 <a NAME="HelpViewerWidget.openUrlNewPage" ID="HelpViewerWidget.openUrlNewPage"></a> | |
| 850 <h4>HelpViewerWidget.openUrlNewPage</h4> | |
| 851 <b>openUrlNewPage</b>(<i>url</i>) | |
| 852 | |
| 853 <p> | |
| 854 Public slot to load a URL in a new page. | |
| 855 </p> | |
| 856 <dl> | |
| 857 | |
| 858 <dt><i>url</i> (QUrl)</dt> | |
| 859 <dd> | |
| 860 URL to be opened | |
| 861 </dd> | |
| 862 </dl> | |
| 863 <a NAME="HelpViewerWidget.searchNext" ID="HelpViewerWidget.searchNext"></a> | |
| 864 <h4>HelpViewerWidget.searchNext</h4> | |
| 865 <b>searchNext</b>(<i></i>) | |
| 866 | |
| 867 <p> | |
| 868 Public slot to find the next occurrence of the current search term. | |
| 869 </p> | |
| 870 <a NAME="HelpViewerWidget.searchPrev" ID="HelpViewerWidget.searchPrev"></a> | |
| 871 <h4>HelpViewerWidget.searchPrev</h4> | |
| 872 <b>searchPrev</b>(<i></i>) | |
| 873 | |
| 874 <p> | |
| 875 Public slot to find the previous occurrence of the current search term. | |
| 876 </p> | |
| 877 <a NAME="HelpViewerWidget.searchQtHelp" ID="HelpViewerWidget.searchQtHelp"></a> | |
| 878 <h4>HelpViewerWidget.searchQtHelp</h4> | |
| 879 <b>searchQtHelp</b>(<i>searchExpression</i>) | |
| 880 | |
| 881 <p> | |
| 882 Public slot to search for a given search expression. | |
| 883 </p> | |
| 884 <dl> | |
| 885 | |
| 886 <dt><i>searchExpression</i> (str)</dt> | |
| 887 <dd> | |
| 888 expression to search for | |
| 889 </dd> | |
| 890 </dl> | |
| 891 <a NAME="HelpViewerWidget.showHideSearch" ID="HelpViewerWidget.showHideSearch"></a> | |
| 892 <h4>HelpViewerWidget.showHideSearch</h4> | |
| 893 <b>showHideSearch</b>(<i>visible</i>) | |
| 894 | |
| 895 <p> | |
| 896 Public slot to show or hide the search widget. | |
| 897 </p> | |
| 898 <dl> | |
| 899 | |
| 900 <dt><i>visible</i> (bool)</dt> | |
| 901 <dd> | |
| 902 flag indicating to show or hide the search widget | |
| 903 </dd> | |
| 904 </dl> | |
| 905 <a NAME="HelpViewerWidget.shutdown" ID="HelpViewerWidget.shutdown"></a> | |
| 906 <h4>HelpViewerWidget.shutdown</h4> | |
| 907 <b>shutdown</b>(<i></i>) | |
| 908 | |
| 909 <p> | |
| 910 Public method to perform shut down actions. | |
| 911 </p> | |
| 912 <a NAME="HelpViewerWidget.webProfile" ID="HelpViewerWidget.webProfile"></a> | |
| 913 <h4>HelpViewerWidget.webProfile</h4> | |
| 914 <b>webProfile</b>(<i></i>) | |
| 915 | |
| 916 <p> | |
| 917 Public method to get a reference to the global web profile object. | |
| 918 </p> | |
| 919 <dl> | |
| 920 <dt>Return:</dt> | |
| 921 <dd> | |
| 922 reference to the global web profile object | |
| 923 </dd> | |
| 924 </dl> | |
| 925 <dl> | |
| 926 <dt>Return Type:</dt> | |
| 927 <dd> | |
| 928 QWebEngineProfile | |
| 929 </dd> | |
| 930 </dl> | |
| 931 <a NAME="HelpViewerWidget.webSettings" ID="HelpViewerWidget.webSettings"></a> | |
| 932 <h4>HelpViewerWidget.webSettings</h4> | |
| 933 <b>webSettings</b>(<i></i>) | |
| 934 | |
| 935 <p> | |
| 936 Public method to get the web settings of the current profile. | |
| 937 </p> | |
| 938 <dl> | |
| 939 <dt>Return:</dt> | |
| 940 <dd> | |
| 941 web settings of the current profile | |
| 942 </dd> | |
| 943 </dl> | |
| 944 <dl> | |
| 945 <dt>Return Type:</dt> | |
| 946 <dd> | |
| 947 QWebEngineSettings | |
| 948 </dd> | |
| 949 </dl> | |
| 950 <div align="right"><a href="#top">Up</a></div> | |
| 951 <hr /> | |
| 952 </body></html> |
