Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.HelpWindow.html
Documentation/Source/eric5.Helpviewer.HelpWindow.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.HelpWindow</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.HelpWindow</h1> | |
| 12 <p> | |
| 13 Module implementing the helpviewer main window. | |
| 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="#HelpWindow">HelpWindow</a></td> | |
| 23 <td>Class implementing the web browser main window.</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="HelpWindow" ID="HelpWindow"></a> | |
| 32 <h2>HelpWindow</h2> | |
| 33 <p> | |
| 34 Class implementing the web browser main window. | |
| 35 </p><h4>Signals</h4> | |
| 36 <dl> | |
| 37 <dt>helpClosed()</dt> | |
| 38 <dd> | |
| 39 emitted after the window was requested to close down | |
| 40 </dd><dt>zoomTextOnlyChanged(bool)</dt> | |
| 41 <dd> | |
| 42 emitted after the zoom text only setting was | |
| 43 changed | |
| 44 </dd> | |
| 45 </dl> | |
| 46 <h3>Derived from</h3> | |
| 47 QMainWindow | |
| 48 <h3>Class Attributes</h3> | |
| 49 <table> | |
| 50 <tr><td>_adblockManager</td></tr><tr><td>_bookmarksManager</td></tr><tr><td>_cookieJar</td></tr><tr><td>_helpEngine</td></tr><tr><td>_historyManager</td></tr><tr><td>_networkAccessManager</td></tr><tr><td>_passwordManager</td></tr><tr><td>helpwindows</td></tr><tr><td>maxMenuFilePathLen</td></tr> | |
| 51 </table> | |
| 52 <h3>Methods</h3> | |
| 53 <table> | |
| 54 <tr> | |
| 55 <td><a href="#HelpWindow.__init__">HelpWindow</a></td> | |
| 56 <td>Constructor</td> | |
| 57 </tr><tr> | |
| 58 <td><a href="#HelpWindow.__about">__about</a></td> | |
| 59 <td>Private slot to show the about information.</td> | |
| 60 </tr><tr> | |
| 61 <td><a href="#HelpWindow.__aboutQt">__aboutQt</a></td> | |
| 62 <td>Private slot to show info about Qt.</td> | |
| 63 </tr><tr> | |
| 64 <td><a href="#HelpWindow.__activateCurrentBrowser">__activateCurrentBrowser</a></td> | |
| 65 <td>Private slot to activate the current browser.</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#HelpWindow.__activateDock">__activateDock</a></td> | |
| 68 <td>Private method to activate the dock widget of the given widget.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#HelpWindow.__addBookmark">__addBookmark</a></td> | |
| 71 <td>Private slot called to add the displayed file to the bookmarks.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#HelpWindow.__addBookmarkFolder">__addBookmarkFolder</a></td> | |
| 74 <td>Private slot to add a new bookmarks folder.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#HelpWindow.__backward">__backward</a></td> | |
| 77 <td>Private slot called to handle the backward action.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#HelpWindow.__bookmarkAll">__bookmarkAll</a></td> | |
| 80 <td>Private slot to bookmark all open tabs.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#HelpWindow.__clearIconsDatabase">__clearIconsDatabase</a></td> | |
| 83 <td>Private slot to clear the icons databse.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#HelpWindow.__clearPrivateData">__clearPrivateData</a></td> | |
| 86 <td>Private slot to clear the private data.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#HelpWindow.__close">__close</a></td> | |
| 89 <td>Private slot called to handle the close action.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#HelpWindow.__closeAll">__closeAll</a></td> | |
| 92 <td>Private slot called to handle the close all action.</td> | |
| 93 </tr><tr> | |
| 94 <td><a href="#HelpWindow.__closeAt">__closeAt</a></td> | |
| 95 <td>Private slot to close a window based on it's index.</td> | |
| 96 </tr><tr> | |
| 97 <td><a href="#HelpWindow.__closeNetworkMonitor">__closeNetworkMonitor</a></td> | |
| 98 <td>Private slot to close the network monitor dialog.</td> | |
| 99 </tr><tr> | |
| 100 <td><a href="#HelpWindow.__copy">__copy</a></td> | |
| 101 <td>Private slot called to handle the copy action.</td> | |
| 102 </tr><tr> | |
| 103 <td><a href="#HelpWindow.__currentChanged">__currentChanged</a></td> | |
| 104 <td>Private slot to handle the currentChanged signal.</td> | |
| 105 </tr><tr> | |
| 106 <td><a href="#HelpWindow.__docsInstalled">__docsInstalled</a></td> | |
| 107 <td>Private slot handling the end of documentation installation.</td> | |
| 108 </tr><tr> | |
| 109 <td><a href="#HelpWindow.__elide">__elide</a></td> | |
| 110 <td>Private method to elide some text.</td> | |
| 111 </tr><tr> | |
| 112 <td><a href="#HelpWindow.__filterQtHelpDocumentation">__filterQtHelpDocumentation</a></td> | |
| 113 <td>Private slot to filter the QtHelp documentation.</td> | |
| 114 </tr><tr> | |
| 115 <td><a href="#HelpWindow.__find">__find</a></td> | |
| 116 <td>Private slot to handle the find action.</td> | |
| 117 </tr><tr> | |
| 118 <td><a href="#HelpWindow.__forward">__forward</a></td> | |
| 119 <td>Private slot called to handle the forward action.</td> | |
| 120 </tr><tr> | |
| 121 <td><a href="#HelpWindow.__getWebIcon">__getWebIcon</a></td> | |
| 122 <td>Private static method to fetch the icon for a URL.</td> | |
| 123 </tr><tr> | |
| 124 <td><a href="#HelpWindow.__guessUrlFromPath">__guessUrlFromPath</a></td> | |
| 125 <td>Private method to guess an URL given a path string.</td> | |
| 126 </tr><tr> | |
| 127 <td><a href="#HelpWindow.__hideIndexWindow">__hideIndexWindow</a></td> | |
| 128 <td>Private method to hide the index window.</td> | |
| 129 </tr><tr> | |
| 130 <td><a href="#HelpWindow.__hideSearchWindow">__hideSearchWindow</a></td> | |
| 131 <td>Private method to hide the search window.</td> | |
| 132 </tr><tr> | |
| 133 <td><a href="#HelpWindow.__hideTocWindow">__hideTocWindow</a></td> | |
| 134 <td>Private method to hide the table of contents window.</td> | |
| 135 </tr><tr> | |
| 136 <td><a href="#HelpWindow.__home">__home</a></td> | |
| 137 <td>Private slot called to handle the home action.</td> | |
| 138 </tr><tr> | |
| 139 <td><a href="#HelpWindow.__indexingFinished">__indexingFinished</a></td> | |
| 140 <td>Private slot to handle the start of the indexing process.</td> | |
| 141 </tr><tr> | |
| 142 <td><a href="#HelpWindow.__indexingStarted">__indexingStarted</a></td> | |
| 143 <td>Private slot to handle the start of the indexing process.</td> | |
| 144 </tr><tr> | |
| 145 <td><a href="#HelpWindow.__initActions">__initActions</a></td> | |
| 146 <td>Private method to define the user interface actions.</td> | |
| 147 </tr><tr> | |
| 148 <td><a href="#HelpWindow.__initHelpDb">__initHelpDb</a></td> | |
| 149 <td>Private slot to initialize the documentation database.</td> | |
| 150 </tr><tr> | |
| 151 <td><a href="#HelpWindow.__initMenus">__initMenus</a></td> | |
| 152 <td>Private method to create the menus.</td> | |
| 153 </tr><tr> | |
| 154 <td><a href="#HelpWindow.__initTabContextMenu">__initTabContextMenu</a></td> | |
| 155 <td>Private mezhod to create the tab context menu.</td> | |
| 156 </tr><tr> | |
| 157 <td><a href="#HelpWindow.__initToolbars">__initToolbars</a></td> | |
| 158 <td>Private method to create the toolbars.</td> | |
| 159 </tr><tr> | |
| 160 <td><a href="#HelpWindow.__initWebSettings">__initWebSettings</a></td> | |
| 161 <td>Private method to set the global web settings.</td> | |
| 162 </tr><tr> | |
| 163 <td><a href="#HelpWindow.__isFullScreen">__isFullScreen</a></td> | |
| 164 <td>Private method to determine, if the window is in full screen mode.</td> | |
| 165 </tr><tr> | |
| 166 <td><a href="#HelpWindow.__linkActivated">__linkActivated</a></td> | |
| 167 <td>Private slot to handle the selection of a link in the TOC window.</td> | |
| 168 </tr><tr> | |
| 169 <td><a href="#HelpWindow.__linksActivated">__linksActivated</a></td> | |
| 170 <td>Private slot to select a topic to be shown.</td> | |
| 171 </tr><tr> | |
| 172 <td><a href="#HelpWindow.__lookForNewDocumentation">__lookForNewDocumentation</a></td> | |
| 173 <td>Private slot to look for new documentation to be loaded into the help database.</td> | |
| 174 </tr><tr> | |
| 175 <td><a href="#HelpWindow.__manageQtHelpDocumentation">__manageQtHelpDocumentation</a></td> | |
| 176 <td>Private slot to manage the QtHelp documentation database.</td> | |
| 177 </tr><tr> | |
| 178 <td><a href="#HelpWindow.__manageQtHelpFilters">__manageQtHelpFilters</a></td> | |
| 179 <td>Private slot to manage the QtHelp filters.</td> | |
| 180 </tr><tr> | |
| 181 <td><a href="#HelpWindow.__navigationMenuActionTriggered">__navigationMenuActionTriggered</a></td> | |
| 182 <td>Private slot to go to the selected page.</td> | |
| 183 </tr><tr> | |
| 184 <td><a href="#HelpWindow.__navigationMenuTriggered">__navigationMenuTriggered</a></td> | |
| 185 <td>Private slot called to handle the navigation button menu selection.</td> | |
| 186 </tr><tr> | |
| 187 <td><a href="#HelpWindow.__nextTab">__nextTab</a></td> | |
| 188 <td>Private slot used to show the next tab.</td> | |
| 189 </tr><tr> | |
| 190 <td><a href="#HelpWindow.__openFile">__openFile</a></td> | |
| 191 <td>Private slot called to open a file.</td> | |
| 192 </tr><tr> | |
| 193 <td><a href="#HelpWindow.__openFileNewTab">__openFileNewTab</a></td> | |
| 194 <td>Private slot called to open a file in a new tab.</td> | |
| 195 </tr><tr> | |
| 196 <td><a href="#HelpWindow.__openUrl">__openUrl</a></td> | |
| 197 <td>Private slot to load a URL from the bookmarks menu or bookmarks toolbar in the current tab.</td> | |
| 198 </tr><tr> | |
| 199 <td><a href="#HelpWindow.__openUrlNewTab">__openUrlNewTab</a></td> | |
| 200 <td>Private slot to load a URL from the bookmarks menu or bookmarks toolbar in a new tab.</td> | |
| 201 </tr><tr> | |
| 202 <td><a href="#HelpWindow.__pathEdited">__pathEdited</a></td> | |
| 203 <td>Private slot called, when a URL has been entered.</td> | |
| 204 </tr><tr> | |
| 205 <td><a href="#HelpWindow.__pathSelected">__pathSelected</a></td> | |
| 206 <td>Private slot called when a file is selected in the combobox.</td> | |
| 207 </tr><tr> | |
| 208 <td><a href="#HelpWindow.__prevTab">__prevTab</a></td> | |
| 209 <td>Private slot used to show the previous tab.</td> | |
| 210 </tr><tr> | |
| 211 <td><a href="#HelpWindow.__printFile">__printFile</a></td> | |
| 212 <td>Private slot called to print the displayed file.</td> | |
| 213 </tr><tr> | |
| 214 <td><a href="#HelpWindow.__printPreview">__printPreview</a></td> | |
| 215 <td>Public slot to generate a print preview.</td> | |
| 216 </tr><tr> | |
| 217 <td><a href="#HelpWindow.__printPreviewFile">__printPreviewFile</a></td> | |
| 218 <td>Private slot called to show a print preview of the displayed file.</td> | |
| 219 </tr><tr> | |
| 220 <td><a href="#HelpWindow.__printRequested">__printRequested</a></td> | |
| 221 <td>Private slot to handle a print request.</td> | |
| 222 </tr><tr> | |
| 223 <td><a href="#HelpWindow.__privateBrowsing">__privateBrowsing</a></td> | |
| 224 <td>Private slot to switch private browsing.</td> | |
| 225 </tr><tr> | |
| 226 <td><a href="#HelpWindow.__reload">__reload</a></td> | |
| 227 <td>Private slot called to handle the reload action.</td> | |
| 228 </tr><tr> | |
| 229 <td><a href="#HelpWindow.__savePageAs">__savePageAs</a></td> | |
| 230 <td>Private slot to save the current page.</td> | |
| 231 </tr><tr> | |
| 232 <td><a href="#HelpWindow.__searchForWord">__searchForWord</a></td> | |
| 233 <td>Private slot to search for a word.</td> | |
| 234 </tr><tr> | |
| 235 <td><a href="#HelpWindow.__setBackwardAvailable">__setBackwardAvailable</a></td> | |
| 236 <td>Private slot called when backward references are available.</td> | |
| 237 </tr><tr> | |
| 238 <td><a href="#HelpWindow.__setForwardAvailable">__setForwardAvailable</a></td> | |
| 239 <td>Private slot called when forward references are available.</td> | |
| 240 </tr><tr> | |
| 241 <td><a href="#HelpWindow.__setIconDatabasePath">__setIconDatabasePath</a></td> | |
| 242 <td>Private method to set the favicons path.</td> | |
| 243 </tr><tr> | |
| 244 <td><a href="#HelpWindow.__setLoadingActions">__setLoadingActions</a></td> | |
| 245 <td>Private slot to set the loading dependent actions.</td> | |
| 246 </tr><tr> | |
| 247 <td><a href="#HelpWindow.__setPathComboBackground">__setPathComboBackground</a></td> | |
| 248 <td>Private slot to change the path combo background to indicate save URLs.</td> | |
| 249 </tr><tr> | |
| 250 <td><a href="#HelpWindow.__setupFilterCombo">__setupFilterCombo</a></td> | |
| 251 <td>Private slot to setup the filter combo box.</td> | |
| 252 </tr><tr> | |
| 253 <td><a href="#HelpWindow.__showAcceptedLanguages">__showAcceptedLanguages</a></td> | |
| 254 <td>Private slot to configure the accepted languages for web pages.</td> | |
| 255 </tr><tr> | |
| 256 <td><a href="#HelpWindow.__showAdBlockDialog">__showAdBlockDialog</a></td> | |
| 257 <td>Private slot to show the AdBlock configuration dialog.</td> | |
| 258 </tr><tr> | |
| 259 <td><a href="#HelpWindow.__showBackMenu">__showBackMenu</a></td> | |
| 260 <td>Private slot showing the backwards navigation menu.</td> | |
| 261 </tr><tr> | |
| 262 <td><a href="#HelpWindow.__showBookmarksDialog">__showBookmarksDialog</a></td> | |
| 263 <td>Private slot to show the bookmarks dialog.</td> | |
| 264 </tr><tr> | |
| 265 <td><a href="#HelpWindow.__showContextMenu">__showContextMenu</a></td> | |
| 266 <td>Private slot to show the tab context menu.</td> | |
| 267 </tr><tr> | |
| 268 <td><a href="#HelpWindow.__showCookiesConfiguration">__showCookiesConfiguration</a></td> | |
| 269 <td>Private slot to configure the cookies handling.</td> | |
| 270 </tr><tr> | |
| 271 <td><a href="#HelpWindow.__showEnginesConfigurationDialog">__showEnginesConfigurationDialog</a></td> | |
| 272 <td>Private slot to show the search engines configuration dialog.</td> | |
| 273 </tr><tr> | |
| 274 <td><a href="#HelpWindow.__showForwardMenu">__showForwardMenu</a></td> | |
| 275 <td>Private slot showing the forwards navigation menu.</td> | |
| 276 </tr><tr> | |
| 277 <td><a href="#HelpWindow.__showHistoryMenu">__showHistoryMenu</a></td> | |
| 278 <td>Private slot called in order to show the history menu.</td> | |
| 279 </tr><tr> | |
| 280 <td><a href="#HelpWindow.__showIndexWindow">__showIndexWindow</a></td> | |
| 281 <td>Private method to show the index window.</td> | |
| 282 </tr><tr> | |
| 283 <td><a href="#HelpWindow.__showInstallationError">__showInstallationError</a></td> | |
| 284 <td>Private slot to show installation errors.</td> | |
| 285 </tr><tr> | |
| 286 <td><a href="#HelpWindow.__showNavigationMenu">__showNavigationMenu</a></td> | |
| 287 <td>Private slot to show the navigation button menu.</td> | |
| 288 </tr><tr> | |
| 289 <td><a href="#HelpWindow.__showNetworkMonitor">__showNetworkMonitor</a></td> | |
| 290 <td>Private slot to show the network monitor dialog.</td> | |
| 291 </tr><tr> | |
| 292 <td><a href="#HelpWindow.__showPageSource">__showPageSource</a></td> | |
| 293 <td>Private slot to show the source of the current page in an editor.</td> | |
| 294 </tr><tr> | |
| 295 <td><a href="#HelpWindow.__showPasswordsDialog">__showPasswordsDialog</a></td> | |
| 296 <td>Private slot to show the passwords management dialog.</td> | |
| 297 </tr><tr> | |
| 298 <td><a href="#HelpWindow.__showPreferences">__showPreferences</a></td> | |
| 299 <td>Private slot to set the preferences.</td> | |
| 300 </tr><tr> | |
| 301 <td><a href="#HelpWindow.__showSearchWindow">__showSearchWindow</a></td> | |
| 302 <td>Private method to show the search window.</td> | |
| 303 </tr><tr> | |
| 304 <td><a href="#HelpWindow.__showTocWindow">__showTocWindow</a></td> | |
| 305 <td>Private method to show the table of contents window.</td> | |
| 306 </tr><tr> | |
| 307 <td><a href="#HelpWindow.__sourceChanged">__sourceChanged</a></td> | |
| 308 <td>Private slot called when the displayed text of the combobox is changed.</td> | |
| 309 </tr><tr> | |
| 310 <td><a href="#HelpWindow.__stopLoading">__stopLoading</a></td> | |
| 311 <td>Private slot called to handle loading of the current page.</td> | |
| 312 </tr><tr> | |
| 313 <td><a href="#HelpWindow.__switchTab">__switchTab</a></td> | |
| 314 <td>Private slot used to switch between the current and the previous current tab.</td> | |
| 315 </tr><tr> | |
| 316 <td><a href="#HelpWindow.__syncTOC">__syncTOC</a></td> | |
| 317 <td>Private slot to synchronize the TOC with the currently shown page.</td> | |
| 318 </tr><tr> | |
| 319 <td><a href="#HelpWindow.__tabContextMenuClone">__tabContextMenuClone</a></td> | |
| 320 <td>Private method to clone the selected tab.</td> | |
| 321 </tr><tr> | |
| 322 <td><a href="#HelpWindow.__tabContextMenuClose">__tabContextMenuClose</a></td> | |
| 323 <td>Private method to close the selected tab.</td> | |
| 324 </tr><tr> | |
| 325 <td><a href="#HelpWindow.__tabContextMenuCloseOthers">__tabContextMenuCloseOthers</a></td> | |
| 326 <td>Private slot to close all other tabs.</td> | |
| 327 </tr><tr> | |
| 328 <td><a href="#HelpWindow.__tabContextMenuMoveLeft">__tabContextMenuMoveLeft</a></td> | |
| 329 <td>Private method to move a tab one position to the left.</td> | |
| 330 </tr><tr> | |
| 331 <td><a href="#HelpWindow.__tabContextMenuMoveRight">__tabContextMenuMoveRight</a></td> | |
| 332 <td>Private method to move a tab one position to the right.</td> | |
| 333 </tr><tr> | |
| 334 <td><a href="#HelpWindow.__tabContextMenuPrint">__tabContextMenuPrint</a></td> | |
| 335 <td>Private method to print the selected tab.</td> | |
| 336 </tr><tr> | |
| 337 <td><a href="#HelpWindow.__tabContextMenuPrintPreview">__tabContextMenuPrintPreview</a></td> | |
| 338 <td>Private method to show a print preview of the selected tab.</td> | |
| 339 </tr><tr> | |
| 340 <td><a href="#HelpWindow.__titleChanged">__titleChanged</a></td> | |
| 341 <td>Private slot called to handle a change of the current browsers title.</td> | |
| 342 </tr><tr> | |
| 343 <td><a href="#HelpWindow.__viewFullScreen">__viewFullScreen</a></td> | |
| 344 <td>Private slot called to toggle fullscreen mode.</td> | |
| 345 </tr><tr> | |
| 346 <td><a href="#HelpWindow.__warning">__warning</a></td> | |
| 347 <td>Private slot handling warnings from the help engine.</td> | |
| 348 </tr><tr> | |
| 349 <td><a href="#HelpWindow.__whatsThis">__whatsThis</a></td> | |
| 350 <td>Private slot called in to enter Whats This mode.</td> | |
| 351 </tr><tr> | |
| 352 <td><a href="#HelpWindow.__windowCloseRequested">__windowCloseRequested</a></td> | |
| 353 <td>Private slot to handle the windowCloseRequested signal of a browser.</td> | |
| 354 </tr><tr> | |
| 355 <td><a href="#HelpWindow.__zoomIn">__zoomIn</a></td> | |
| 356 <td>Private slot called to handle the zoom in action.</td> | |
| 357 </tr><tr> | |
| 358 <td><a href="#HelpWindow.__zoomOut">__zoomOut</a></td> | |
| 359 <td>Private slot called to handle the zoom out action.</td> | |
| 360 </tr><tr> | |
| 361 <td><a href="#HelpWindow.__zoomReset">__zoomReset</a></td> | |
| 362 <td>Private slot called to handle the zoom reset action.</td> | |
| 363 </tr><tr> | |
| 364 <td><a href="#HelpWindow.__zoomTextOnly">__zoomTextOnly</a></td> | |
| 365 <td>Private slot called to handle the zoom text only action.</td> | |
| 366 </tr><tr> | |
| 367 <td><a href="#HelpWindow.adblockManager">adblockManager</a></td> | |
| 368 <td>Class method to get a reference to the AdBlock manager.</td> | |
| 369 </tr><tr> | |
| 370 <td><a href="#HelpWindow.bookmarksManager">bookmarksManager</a></td> | |
| 371 <td>Class method to get a reference to the bookmarks manager.</td> | |
| 372 </tr><tr> | |
| 373 <td><a href="#HelpWindow.browsers">browsers</a></td> | |
| 374 <td>Public method to get a list of references to all help browsers.</td> | |
| 375 </tr><tr> | |
| 376 <td><a href="#HelpWindow.closeEvent">closeEvent</a></td> | |
| 377 <td>Private event handler for the close event.</td> | |
| 378 </tr><tr> | |
| 379 <td><a href="#HelpWindow.cookieJar">cookieJar</a></td> | |
| 380 <td>Class method to get a reference to the cookie jar.</td> | |
| 381 </tr><tr> | |
| 382 <td><a href="#HelpWindow.currentBrowser">currentBrowser</a></td> | |
| 383 <td>Public method to get a reference to the current help browser.</td> | |
| 384 </tr><tr> | |
| 385 <td><a href="#HelpWindow.getActions">getActions</a></td> | |
| 386 <td>Public method to get a list of all actions.</td> | |
| 387 </tr><tr> | |
| 388 <td><a href="#HelpWindow.getSourceFileList">getSourceFileList</a></td> | |
| 389 <td>Public method to get a list of all opened source files.</td> | |
| 390 </tr><tr> | |
| 391 <td><a href="#HelpWindow.helpEngine">helpEngine</a></td> | |
| 392 <td>Class method to get a reference to the help engine.</td> | |
| 393 </tr><tr> | |
| 394 <td><a href="#HelpWindow.historyManager">historyManager</a></td> | |
| 395 <td>Class method to get a reference to the history manager.</td> | |
| 396 </tr><tr> | |
| 397 <td><a href="#HelpWindow.icon">icon</a></td> | |
| 398 <td>Class method to get the icon for an URL.</td> | |
| 399 </tr><tr> | |
| 400 <td><a href="#HelpWindow.iconChanged">iconChanged</a></td> | |
| 401 <td>Public slot to change the icon shown to the left of the URL entry.</td> | |
| 402 </tr><tr> | |
| 403 <td><a href="#HelpWindow.networkAccessManager">networkAccessManager</a></td> | |
| 404 <td>Class method to get a reference to the network access manager.</td> | |
| 405 </tr><tr> | |
| 406 <td><a href="#HelpWindow.newBrowser">newBrowser</a></td> | |
| 407 <td>Public method to create a new help browser tab.</td> | |
| 408 </tr><tr> | |
| 409 <td><a href="#HelpWindow.newTab">newTab</a></td> | |
| 410 <td>Public slot called to open a new help window tab.</td> | |
| 411 </tr><tr> | |
| 412 <td><a href="#HelpWindow.newWindow">newWindow</a></td> | |
| 413 <td>Public slot called to open a new help browser dialog.</td> | |
| 414 </tr><tr> | |
| 415 <td><a href="#HelpWindow.passwordManager">passwordManager</a></td> | |
| 416 <td>Class method to get a reference to the password manager.</td> | |
| 417 </tr><tr> | |
| 418 <td><a href="#HelpWindow.preferencesChanged">preferencesChanged</a></td> | |
| 419 <td>Public slot to handle a change of preferences.</td> | |
| 420 </tr><tr> | |
| 421 <td><a href="#HelpWindow.progressBar">progressBar</a></td> | |
| 422 <td>Public method to get a reference to the load progress bar.</td> | |
| 423 </tr><tr> | |
| 424 <td><a href="#HelpWindow.resetLoading">resetLoading</a></td> | |
| 425 <td>Public method to reset the loading icon.</td> | |
| 426 </tr><tr> | |
| 427 <td><a href="#HelpWindow.search">search</a></td> | |
| 428 <td>Public method to search for a word.</td> | |
| 429 </tr><tr> | |
| 430 <td><a href="#HelpWindow.searchEnginesAction">searchEnginesAction</a></td> | |
| 431 <td>Public method to get a reference to the search engines configuration action.</td> | |
| 432 </tr><tr> | |
| 433 <td><a href="#HelpWindow.setLoading">setLoading</a></td> | |
| 434 <td>Public method to set the loading icon.</td> | |
| 435 </tr> | |
| 436 </table> | |
| 437 <a NAME="HelpWindow.__init__" ID="HelpWindow.__init__"></a> | |
| 438 <h4>HelpWindow (Constructor)</h4> | |
| 439 <b>HelpWindow</b>(<i>home, path, parent, name, fromEric = False, initShortcutsOnly = False, searchWord = None</i>) | |
| 440 <p> | |
| 441 Constructor | |
| 442 </p><dl> | |
| 443 <dt><i>home</i></dt> | |
| 444 <dd> | |
| 445 the URL to be shown (string) | |
| 446 </dd><dt><i>path</i></dt> | |
| 447 <dd> | |
| 448 the path of the working dir (usually '.') (string) | |
| 449 </dd><dt><i>parent</i></dt> | |
| 450 <dd> | |
| 451 parent widget of this window (QWidget) | |
| 452 </dd><dt><i>name</i></dt> | |
| 453 <dd> | |
| 454 name of this window (string) | |
| 455 </dd><dt><i>fromEric</i></dt> | |
| 456 <dd> | |
| 457 flag indicating whether it was called from within eric5 (boolean) | |
| 458 </dd><dt><i>initShortcutsOnly=</i></dt> | |
| 459 <dd> | |
| 460 flag indicating to just initialize the keyboard | |
| 461 shortcuts (boolean) | |
| 462 </dd><dt><i>searchWord=</i></dt> | |
| 463 <dd> | |
| 464 word to search for (string) | |
| 465 </dd> | |
| 466 </dl><a NAME="HelpWindow.__about" ID="HelpWindow.__about"></a> | |
| 467 <h4>HelpWindow.__about</h4> | |
| 468 <b>__about</b>(<i></i>) | |
| 469 <p> | |
| 470 Private slot to show the about information. | |
| 471 </p><a NAME="HelpWindow.__aboutQt" ID="HelpWindow.__aboutQt"></a> | |
| 472 <h4>HelpWindow.__aboutQt</h4> | |
| 473 <b>__aboutQt</b>(<i></i>) | |
| 474 <p> | |
| 475 Private slot to show info about Qt. | |
| 476 </p><a NAME="HelpWindow.__activateCurrentBrowser" ID="HelpWindow.__activateCurrentBrowser"></a> | |
| 477 <h4>HelpWindow.__activateCurrentBrowser</h4> | |
| 478 <b>__activateCurrentBrowser</b>(<i></i>) | |
| 479 <p> | |
| 480 Private slot to activate the current browser. | |
| 481 </p><a NAME="HelpWindow.__activateDock" ID="HelpWindow.__activateDock"></a> | |
| 482 <h4>HelpWindow.__activateDock</h4> | |
| 483 <b>__activateDock</b>(<i>widget</i>) | |
| 484 <p> | |
| 485 Private method to activate the dock widget of the given widget. | |
| 486 </p><dl> | |
| 487 <dt><i>widget</i></dt> | |
| 488 <dd> | |
| 489 reference to the widget to be activated (QWidget) | |
| 490 </dd> | |
| 491 </dl><a NAME="HelpWindow.__addBookmark" ID="HelpWindow.__addBookmark"></a> | |
| 492 <h4>HelpWindow.__addBookmark</h4> | |
| 493 <b>__addBookmark</b>(<i></i>) | |
| 494 <p> | |
| 495 Private slot called to add the displayed file to the bookmarks. | |
| 496 </p><a NAME="HelpWindow.__addBookmarkFolder" ID="HelpWindow.__addBookmarkFolder"></a> | |
| 497 <h4>HelpWindow.__addBookmarkFolder</h4> | |
| 498 <b>__addBookmarkFolder</b>(<i></i>) | |
| 499 <p> | |
| 500 Private slot to add a new bookmarks folder. | |
| 501 </p><a NAME="HelpWindow.__backward" ID="HelpWindow.__backward"></a> | |
| 502 <h4>HelpWindow.__backward</h4> | |
| 503 <b>__backward</b>(<i></i>) | |
| 504 <p> | |
| 505 Private slot called to handle the backward action. | |
| 506 </p><a NAME="HelpWindow.__bookmarkAll" ID="HelpWindow.__bookmarkAll"></a> | |
| 507 <h4>HelpWindow.__bookmarkAll</h4> | |
| 508 <b>__bookmarkAll</b>(<i></i>) | |
| 509 <p> | |
| 510 Private slot to bookmark all open tabs. | |
| 511 </p><a NAME="HelpWindow.__clearIconsDatabase" ID="HelpWindow.__clearIconsDatabase"></a> | |
| 512 <h4>HelpWindow.__clearIconsDatabase</h4> | |
| 513 <b>__clearIconsDatabase</b>(<i></i>) | |
| 514 <p> | |
| 515 Private slot to clear the icons databse. | |
| 516 </p><a NAME="HelpWindow.__clearPrivateData" ID="HelpWindow.__clearPrivateData"></a> | |
| 517 <h4>HelpWindow.__clearPrivateData</h4> | |
| 518 <b>__clearPrivateData</b>(<i></i>) | |
| 519 <p> | |
| 520 Private slot to clear the private data. | |
| 521 </p><a NAME="HelpWindow.__close" ID="HelpWindow.__close"></a> | |
| 522 <h4>HelpWindow.__close</h4> | |
| 523 <b>__close</b>(<i></i>) | |
| 524 <p> | |
| 525 Private slot called to handle the close action. | |
| 526 </p><a NAME="HelpWindow.__closeAll" ID="HelpWindow.__closeAll"></a> | |
| 527 <h4>HelpWindow.__closeAll</h4> | |
| 528 <b>__closeAll</b>(<i></i>) | |
| 529 <p> | |
| 530 Private slot called to handle the close all action. | |
| 531 </p><a NAME="HelpWindow.__closeAt" ID="HelpWindow.__closeAt"></a> | |
| 532 <h4>HelpWindow.__closeAt</h4> | |
| 533 <b>__closeAt</b>(<i>index</i>) | |
| 534 <p> | |
| 535 Private slot to close a window based on it's index. | |
| 536 </p><dl> | |
| 537 <dt><i>index</i></dt> | |
| 538 <dd> | |
| 539 index of window to close (integer) | |
| 540 </dd> | |
| 541 </dl><a NAME="HelpWindow.__closeNetworkMonitor" ID="HelpWindow.__closeNetworkMonitor"></a> | |
| 542 <h4>HelpWindow.__closeNetworkMonitor</h4> | |
| 543 <b>__closeNetworkMonitor</b>(<i></i>) | |
| 544 <p> | |
| 545 Private slot to close the network monitor dialog. | |
| 546 </p><a NAME="HelpWindow.__copy" ID="HelpWindow.__copy"></a> | |
| 547 <h4>HelpWindow.__copy</h4> | |
| 548 <b>__copy</b>(<i></i>) | |
| 549 <p> | |
| 550 Private slot called to handle the copy action. | |
| 551 </p><a NAME="HelpWindow.__currentChanged" ID="HelpWindow.__currentChanged"></a> | |
| 552 <h4>HelpWindow.__currentChanged</h4> | |
| 553 <b>__currentChanged</b>(<i>index</i>) | |
| 554 <p> | |
| 555 Private slot to handle the currentChanged signal. | |
| 556 </p><dl> | |
| 557 <dt><i>index</i></dt> | |
| 558 <dd> | |
| 559 index of the current tab (integer) | |
| 560 </dd> | |
| 561 </dl><a NAME="HelpWindow.__docsInstalled" ID="HelpWindow.__docsInstalled"></a> | |
| 562 <h4>HelpWindow.__docsInstalled</h4> | |
| 563 <b>__docsInstalled</b>(<i>installed</i>) | |
| 564 <p> | |
| 565 Private slot handling the end of documentation installation. | |
| 566 </p><dl> | |
| 567 <dt><i>installed</i></dt> | |
| 568 <dd> | |
| 569 flag indicating that documents were installed (boolean) | |
| 570 </dd> | |
| 571 </dl><a NAME="HelpWindow.__elide" ID="HelpWindow.__elide"></a> | |
| 572 <h4>HelpWindow.__elide</h4> | |
| 573 <b>__elide</b>(<i>txt, mode = Qt.ElideRight, length = 40</i>) | |
| 574 <p> | |
| 575 Private method to elide some text. | |
| 576 </p><dl> | |
| 577 <dt><i>txt</i></dt> | |
| 578 <dd> | |
| 579 text to be elided (string) | |
| 580 </dd><dt><i>mode=</i></dt> | |
| 581 <dd> | |
| 582 elide mode (Qt.TextElideMode) | |
| 583 </dd><dt><i>length=</i></dt> | |
| 584 <dd> | |
| 585 amount of characters to be used (integer) | |
| 586 </dd> | |
| 587 </dl><dl> | |
| 588 <dt>Returns:</dt> | |
| 589 <dd> | |
| 590 the elided text (string) | |
| 591 </dd> | |
| 592 </dl><a NAME="HelpWindow.__filterQtHelpDocumentation" ID="HelpWindow.__filterQtHelpDocumentation"></a> | |
| 593 <h4>HelpWindow.__filterQtHelpDocumentation</h4> | |
| 594 <b>__filterQtHelpDocumentation</b>(<i>customFilter</i>) | |
| 595 <p> | |
| 596 Private slot to filter the QtHelp documentation. | |
| 597 </p><dl> | |
| 598 <dt><i>customFilter</i></dt> | |
| 599 <dd> | |
| 600 name of filter to be applied (QString) | |
| 601 </dd> | |
| 602 </dl><a NAME="HelpWindow.__find" ID="HelpWindow.__find"></a> | |
| 603 <h4>HelpWindow.__find</h4> | |
| 604 <b>__find</b>(<i></i>) | |
| 605 <p> | |
| 606 Private slot to handle the find action. | |
| 607 </p><p> | |
| 608 It opens the search dialog in order to perform the various | |
| 609 search actions and to collect the various search info. | |
| 610 </p><a NAME="HelpWindow.__forward" ID="HelpWindow.__forward"></a> | |
| 611 <h4>HelpWindow.__forward</h4> | |
| 612 <b>__forward</b>(<i></i>) | |
| 613 <p> | |
| 614 Private slot called to handle the forward action. | |
| 615 </p><a NAME="HelpWindow.__getWebIcon" ID="HelpWindow.__getWebIcon"></a> | |
| 616 <h4>HelpWindow.__getWebIcon</h4> | |
| 617 <b>__getWebIcon</b>(<i></i>) | |
| 618 <p> | |
| 619 Private static method to fetch the icon for a URL. | |
| 620 </p><dl> | |
| 621 <dt><i>url</i></dt> | |
| 622 <dd> | |
| 623 URL to get icon for (QUrl) | |
| 624 </dd> | |
| 625 </dl><dl> | |
| 626 <dt>Returns:</dt> | |
| 627 <dd> | |
| 628 icon for the URL (QIcon) | |
| 629 </dd> | |
| 630 </dl><a NAME="HelpWindow.__guessUrlFromPath" ID="HelpWindow.__guessUrlFromPath"></a> | |
| 631 <h4>HelpWindow.__guessUrlFromPath</h4> | |
| 632 <b>__guessUrlFromPath</b>(<i>path</i>) | |
| 633 <p> | |
| 634 Private method to guess an URL given a path string. | |
| 635 </p><dl> | |
| 636 <dt><i>path</i></dt> | |
| 637 <dd> | |
| 638 path string to guess an URL for (string) | |
| 639 </dd> | |
| 640 </dl><dl> | |
| 641 <dt>Returns:</dt> | |
| 642 <dd> | |
| 643 guessed URL (QUrl) | |
| 644 </dd> | |
| 645 </dl><a NAME="HelpWindow.__hideIndexWindow" ID="HelpWindow.__hideIndexWindow"></a> | |
| 646 <h4>HelpWindow.__hideIndexWindow</h4> | |
| 647 <b>__hideIndexWindow</b>(<i></i>) | |
| 648 <p> | |
| 649 Private method to hide the index window. | |
| 650 </p><a NAME="HelpWindow.__hideSearchWindow" ID="HelpWindow.__hideSearchWindow"></a> | |
| 651 <h4>HelpWindow.__hideSearchWindow</h4> | |
| 652 <b>__hideSearchWindow</b>(<i></i>) | |
| 653 <p> | |
| 654 Private method to hide the search window. | |
| 655 </p><a NAME="HelpWindow.__hideTocWindow" ID="HelpWindow.__hideTocWindow"></a> | |
| 656 <h4>HelpWindow.__hideTocWindow</h4> | |
| 657 <b>__hideTocWindow</b>(<i></i>) | |
| 658 <p> | |
| 659 Private method to hide the table of contents window. | |
| 660 </p><a NAME="HelpWindow.__home" ID="HelpWindow.__home"></a> | |
| 661 <h4>HelpWindow.__home</h4> | |
| 662 <b>__home</b>(<i></i>) | |
| 663 <p> | |
| 664 Private slot called to handle the home action. | |
| 665 </p><a NAME="HelpWindow.__indexingFinished" ID="HelpWindow.__indexingFinished"></a> | |
| 666 <h4>HelpWindow.__indexingFinished</h4> | |
| 667 <b>__indexingFinished</b>(<i></i>) | |
| 668 <p> | |
| 669 Private slot to handle the start of the indexing process. | |
| 670 </p><a NAME="HelpWindow.__indexingStarted" ID="HelpWindow.__indexingStarted"></a> | |
| 671 <h4>HelpWindow.__indexingStarted</h4> | |
| 672 <b>__indexingStarted</b>(<i></i>) | |
| 673 <p> | |
| 674 Private slot to handle the start of the indexing process. | |
| 675 </p><a NAME="HelpWindow.__initActions" ID="HelpWindow.__initActions"></a> | |
| 676 <h4>HelpWindow.__initActions</h4> | |
| 677 <b>__initActions</b>(<i></i>) | |
| 678 <p> | |
| 679 Private method to define the user interface actions. | |
| 680 </p><a NAME="HelpWindow.__initHelpDb" ID="HelpWindow.__initHelpDb"></a> | |
| 681 <h4>HelpWindow.__initHelpDb</h4> | |
| 682 <b>__initHelpDb</b>(<i></i>) | |
| 683 <p> | |
| 684 Private slot to initialize the documentation database. | |
| 685 </p><a NAME="HelpWindow.__initMenus" ID="HelpWindow.__initMenus"></a> | |
| 686 <h4>HelpWindow.__initMenus</h4> | |
| 687 <b>__initMenus</b>(<i></i>) | |
| 688 <p> | |
| 689 Private method to create the menus. | |
| 690 </p><a NAME="HelpWindow.__initTabContextMenu" ID="HelpWindow.__initTabContextMenu"></a> | |
| 691 <h4>HelpWindow.__initTabContextMenu</h4> | |
| 692 <b>__initTabContextMenu</b>(<i></i>) | |
| 693 <p> | |
| 694 Private mezhod to create the tab context menu. | |
| 695 </p><a NAME="HelpWindow.__initToolbars" ID="HelpWindow.__initToolbars"></a> | |
| 696 <h4>HelpWindow.__initToolbars</h4> | |
| 697 <b>__initToolbars</b>(<i></i>) | |
| 698 <p> | |
| 699 Private method to create the toolbars. | |
| 700 </p><a NAME="HelpWindow.__initWebSettings" ID="HelpWindow.__initWebSettings"></a> | |
| 701 <h4>HelpWindow.__initWebSettings</h4> | |
| 702 <b>__initWebSettings</b>(<i></i>) | |
| 703 <p> | |
| 704 Private method to set the global web settings. | |
| 705 </p><a NAME="HelpWindow.__isFullScreen" ID="HelpWindow.__isFullScreen"></a> | |
| 706 <h4>HelpWindow.__isFullScreen</h4> | |
| 707 <b>__isFullScreen</b>(<i></i>) | |
| 708 <p> | |
| 709 Private method to determine, if the window is in full screen mode. | |
| 710 </p><dl> | |
| 711 <dt>Returns:</dt> | |
| 712 <dd> | |
| 713 flag indicating full screen mode (boolean) | |
| 714 </dd> | |
| 715 </dl><a NAME="HelpWindow.__linkActivated" ID="HelpWindow.__linkActivated"></a> | |
| 716 <h4>HelpWindow.__linkActivated</h4> | |
| 717 <b>__linkActivated</b>(<i>url</i>) | |
| 718 <p> | |
| 719 Private slot to handle the selection of a link in the TOC window. | |
| 720 </p><dl> | |
| 721 <dt><i>url</i></dt> | |
| 722 <dd> | |
| 723 URL to be shown (QUrl) | |
| 724 </dd> | |
| 725 </dl><a NAME="HelpWindow.__linksActivated" ID="HelpWindow.__linksActivated"></a> | |
| 726 <h4>HelpWindow.__linksActivated</h4> | |
| 727 <b>__linksActivated</b>(<i>links, keyword</i>) | |
| 728 <p> | |
| 729 Private slot to select a topic to be shown. | |
| 730 </p><dl> | |
| 731 <dt><i>links</i></dt> | |
| 732 <dd> | |
| 733 dictionary with help topic as key (string) and | |
| 734 URL as value (QUrl) | |
| 735 </dd><dt><i>keyword</i></dt> | |
| 736 <dd> | |
| 737 keyword for the link set (string) | |
| 738 </dd> | |
| 739 </dl><a NAME="HelpWindow.__lookForNewDocumentation" ID="HelpWindow.__lookForNewDocumentation"></a> | |
| 740 <h4>HelpWindow.__lookForNewDocumentation</h4> | |
| 741 <b>__lookForNewDocumentation</b>(<i></i>) | |
| 742 <p> | |
| 743 Private slot to look for new documentation to be loaded into the | |
| 744 help database. | |
| 745 </p><a NAME="HelpWindow.__manageQtHelpDocumentation" ID="HelpWindow.__manageQtHelpDocumentation"></a> | |
| 746 <h4>HelpWindow.__manageQtHelpDocumentation</h4> | |
| 747 <b>__manageQtHelpDocumentation</b>(<i></i>) | |
| 748 <p> | |
| 749 Private slot to manage the QtHelp documentation database. | |
| 750 </p><a NAME="HelpWindow.__manageQtHelpFilters" ID="HelpWindow.__manageQtHelpFilters"></a> | |
| 751 <h4>HelpWindow.__manageQtHelpFilters</h4> | |
| 752 <b>__manageQtHelpFilters</b>(<i></i>) | |
| 753 <p> | |
| 754 Private slot to manage the QtHelp filters. | |
| 755 </p><a NAME="HelpWindow.__navigationMenuActionTriggered" ID="HelpWindow.__navigationMenuActionTriggered"></a> | |
| 756 <h4>HelpWindow.__navigationMenuActionTriggered</h4> | |
| 757 <b>__navigationMenuActionTriggered</b>(<i>act</i>) | |
| 758 <p> | |
| 759 Private slot to go to the selected page. | |
| 760 </p><dl> | |
| 761 <dt><i>act</i></dt> | |
| 762 <dd> | |
| 763 reference to the action selected in the navigation menu (QAction) | |
| 764 </dd> | |
| 765 </dl><a NAME="HelpWindow.__navigationMenuTriggered" ID="HelpWindow.__navigationMenuTriggered"></a> | |
| 766 <h4>HelpWindow.__navigationMenuTriggered</h4> | |
| 767 <b>__navigationMenuTriggered</b>(<i>act</i>) | |
| 768 <p> | |
| 769 Private slot called to handle the navigation button menu selection. | |
| 770 </p><dl> | |
| 771 <dt><i>act</i></dt> | |
| 772 <dd> | |
| 773 reference to the selected action (QAction) | |
| 774 </dd> | |
| 775 </dl><a NAME="HelpWindow.__nextTab" ID="HelpWindow.__nextTab"></a> | |
| 776 <h4>HelpWindow.__nextTab</h4> | |
| 777 <b>__nextTab</b>(<i></i>) | |
| 778 <p> | |
| 779 Private slot used to show the next tab. | |
| 780 </p><a NAME="HelpWindow.__openFile" ID="HelpWindow.__openFile"></a> | |
| 781 <h4>HelpWindow.__openFile</h4> | |
| 782 <b>__openFile</b>(<i></i>) | |
| 783 <p> | |
| 784 Private slot called to open a file. | |
| 785 </p><a NAME="HelpWindow.__openFileNewTab" ID="HelpWindow.__openFileNewTab"></a> | |
| 786 <h4>HelpWindow.__openFileNewTab</h4> | |
| 787 <b>__openFileNewTab</b>(<i></i>) | |
| 788 <p> | |
| 789 Private slot called to open a file in a new tab. | |
| 790 </p><a NAME="HelpWindow.__openUrl" ID="HelpWindow.__openUrl"></a> | |
| 791 <h4>HelpWindow.__openUrl</h4> | |
| 792 <b>__openUrl</b>(<i>url, title</i>) | |
| 793 <p> | |
| 794 Private slot to load a URL from the bookmarks menu or bookmarks toolbar | |
| 795 in the current tab. | |
| 796 </p><dl> | |
| 797 <dt><i>url</i></dt> | |
| 798 <dd> | |
| 799 url to be opened (QUrl) | |
| 800 </dd><dt><i>title</i></dt> | |
| 801 <dd> | |
| 802 title of the bookmark (string) | |
| 803 </dd> | |
| 804 </dl><a NAME="HelpWindow.__openUrlNewTab" ID="HelpWindow.__openUrlNewTab"></a> | |
| 805 <h4>HelpWindow.__openUrlNewTab</h4> | |
| 806 <b>__openUrlNewTab</b>(<i>url, title</i>) | |
| 807 <p> | |
| 808 Private slot to load a URL from the bookmarks menu or bookmarks toolbar | |
| 809 in a new tab. | |
| 810 </p><dl> | |
| 811 <dt><i>url</i></dt> | |
| 812 <dd> | |
| 813 url to be opened (QUrl) | |
| 814 </dd><dt><i>title</i></dt> | |
| 815 <dd> | |
| 816 title of the bookmark (string) | |
| 817 </dd> | |
| 818 </dl><a NAME="HelpWindow.__pathEdited" ID="HelpWindow.__pathEdited"></a> | |
| 819 <h4>HelpWindow.__pathEdited</h4> | |
| 820 <b>__pathEdited</b>(<i></i>) | |
| 821 <p> | |
| 822 Private slot called, when a URL has been entered. | |
| 823 </p><a NAME="HelpWindow.__pathSelected" ID="HelpWindow.__pathSelected"></a> | |
| 824 <h4>HelpWindow.__pathSelected</h4> | |
| 825 <b>__pathSelected</b>(<i>path</i>) | |
| 826 <p> | |
| 827 Private slot called when a file is selected in the combobox. | |
| 828 </p><dl> | |
| 829 <dt><i>path</i></dt> | |
| 830 <dd> | |
| 831 path to be shown (string) | |
| 832 </dd> | |
| 833 </dl><a NAME="HelpWindow.__prevTab" ID="HelpWindow.__prevTab"></a> | |
| 834 <h4>HelpWindow.__prevTab</h4> | |
| 835 <b>__prevTab</b>(<i></i>) | |
| 836 <p> | |
| 837 Private slot used to show the previous tab. | |
| 838 </p><a NAME="HelpWindow.__printFile" ID="HelpWindow.__printFile"></a> | |
| 839 <h4>HelpWindow.__printFile</h4> | |
| 840 <b>__printFile</b>(<i>browser = None</i>) | |
| 841 <p> | |
| 842 Private slot called to print the displayed file. | |
| 843 </p><dl> | |
| 844 <dt><i>browser</i></dt> | |
| 845 <dd> | |
| 846 reference to the browser to be printed (HelpBrowserWV) | |
| 847 </dd> | |
| 848 </dl><a NAME="HelpWindow.__printPreview" ID="HelpWindow.__printPreview"></a> | |
| 849 <h4>HelpWindow.__printPreview</h4> | |
| 850 <b>__printPreview</b>(<i>printer</i>) | |
| 851 <p> | |
| 852 Public slot to generate a print preview. | |
| 853 </p><dl> | |
| 854 <dt><i>printer</i></dt> | |
| 855 <dd> | |
| 856 reference to the printer object (QPrinter) | |
| 857 </dd> | |
| 858 </dl><a NAME="HelpWindow.__printPreviewFile" ID="HelpWindow.__printPreviewFile"></a> | |
| 859 <h4>HelpWindow.__printPreviewFile</h4> | |
| 860 <b>__printPreviewFile</b>(<i>browser = None</i>) | |
| 861 <p> | |
| 862 Private slot called to show a print preview of the displayed file. | |
| 863 </p><dl> | |
| 864 <dt><i>browser</i></dt> | |
| 865 <dd> | |
| 866 reference to the browser to be printed (HelpBrowserWV) | |
| 867 </dd> | |
| 868 </dl><a NAME="HelpWindow.__printRequested" ID="HelpWindow.__printRequested"></a> | |
| 869 <h4>HelpWindow.__printRequested</h4> | |
| 870 <b>__printRequested</b>(<i>frame</i>) | |
| 871 <p> | |
| 872 Private slot to handle a print request. | |
| 873 </p><dl> | |
| 874 <dt><i>frame</i></dt> | |
| 875 <dd> | |
| 876 reference to the frame to be printed (QWebFrame) | |
| 877 </dd> | |
| 878 </dl><a NAME="HelpWindow.__privateBrowsing" ID="HelpWindow.__privateBrowsing"></a> | |
| 879 <h4>HelpWindow.__privateBrowsing</h4> | |
| 880 <b>__privateBrowsing</b>(<i></i>) | |
| 881 <p> | |
| 882 Private slot to switch private browsing. | |
| 883 </p><a NAME="HelpWindow.__reload" ID="HelpWindow.__reload"></a> | |
| 884 <h4>HelpWindow.__reload</h4> | |
| 885 <b>__reload</b>(<i></i>) | |
| 886 <p> | |
| 887 Private slot called to handle the reload action. | |
| 888 </p><a NAME="HelpWindow.__savePageAs" ID="HelpWindow.__savePageAs"></a> | |
| 889 <h4>HelpWindow.__savePageAs</h4> | |
| 890 <b>__savePageAs</b>(<i></i>) | |
| 891 <p> | |
| 892 Private slot to save the current page. | |
| 893 </p><a NAME="HelpWindow.__searchForWord" ID="HelpWindow.__searchForWord"></a> | |
| 894 <h4>HelpWindow.__searchForWord</h4> | |
| 895 <b>__searchForWord</b>(<i></i>) | |
| 896 <p> | |
| 897 Private slot to search for a word. | |
| 898 </p><a NAME="HelpWindow.__setBackwardAvailable" ID="HelpWindow.__setBackwardAvailable"></a> | |
| 899 <h4>HelpWindow.__setBackwardAvailable</h4> | |
| 900 <b>__setBackwardAvailable</b>(<i>b</i>) | |
| 901 <p> | |
| 902 Private slot called when backward references are available. | |
| 903 </p><dl> | |
| 904 <dt><i>b</i></dt> | |
| 905 <dd> | |
| 906 flag indicating availability of the backwards action (boolean) | |
| 907 </dd> | |
| 908 </dl><a NAME="HelpWindow.__setForwardAvailable" ID="HelpWindow.__setForwardAvailable"></a> | |
| 909 <h4>HelpWindow.__setForwardAvailable</h4> | |
| 910 <b>__setForwardAvailable</b>(<i>b</i>) | |
| 911 <p> | |
| 912 Private slot called when forward references are available. | |
| 913 </p><dl> | |
| 914 <dt><i>b</i></dt> | |
| 915 <dd> | |
| 916 flag indicating the availability of the forwards action (boolean) | |
| 917 </dd> | |
| 918 </dl><a NAME="HelpWindow.__setIconDatabasePath" ID="HelpWindow.__setIconDatabasePath"></a> | |
| 919 <h4>HelpWindow.__setIconDatabasePath</h4> | |
| 920 <b>__setIconDatabasePath</b>(<i>enable = True</i>) | |
| 921 <p> | |
| 922 Private method to set the favicons path. | |
| 923 </p><dl> | |
| 924 <dt><i>enable</i></dt> | |
| 925 <dd> | |
| 926 flag indicating to enabled icon storage (boolean) | |
| 927 </dd> | |
| 928 </dl><a NAME="HelpWindow.__setLoadingActions" ID="HelpWindow.__setLoadingActions"></a> | |
| 929 <h4>HelpWindow.__setLoadingActions</h4> | |
| 930 <b>__setLoadingActions</b>(<i>b</i>) | |
| 931 <p> | |
| 932 Private slot to set the loading dependent actions. | |
| 933 </p><dl> | |
| 934 <dt><i>b</i></dt> | |
| 935 <dd> | |
| 936 flag indicating the loading state to consider (boolean) | |
| 937 </dd> | |
| 938 </dl><a NAME="HelpWindow.__setPathComboBackground" ID="HelpWindow.__setPathComboBackground"></a> | |
| 939 <h4>HelpWindow.__setPathComboBackground</h4> | |
| 940 <b>__setPathComboBackground</b>(<i></i>) | |
| 941 <p> | |
| 942 Private slot to change the path combo background to indicate save URLs. | |
| 943 </p><a NAME="HelpWindow.__setupFilterCombo" ID="HelpWindow.__setupFilterCombo"></a> | |
| 944 <h4>HelpWindow.__setupFilterCombo</h4> | |
| 945 <b>__setupFilterCombo</b>(<i></i>) | |
| 946 <p> | |
| 947 Private slot to setup the filter combo box. | |
| 948 </p><a NAME="HelpWindow.__showAcceptedLanguages" ID="HelpWindow.__showAcceptedLanguages"></a> | |
| 949 <h4>HelpWindow.__showAcceptedLanguages</h4> | |
| 950 <b>__showAcceptedLanguages</b>(<i></i>) | |
| 951 <p> | |
| 952 Private slot to configure the accepted languages for web pages. | |
| 953 </p><a NAME="HelpWindow.__showAdBlockDialog" ID="HelpWindow.__showAdBlockDialog"></a> | |
| 954 <h4>HelpWindow.__showAdBlockDialog</h4> | |
| 955 <b>__showAdBlockDialog</b>(<i></i>) | |
| 956 <p> | |
| 957 Private slot to show the AdBlock configuration dialog. | |
| 958 </p><a NAME="HelpWindow.__showBackMenu" ID="HelpWindow.__showBackMenu"></a> | |
| 959 <h4>HelpWindow.__showBackMenu</h4> | |
| 960 <b>__showBackMenu</b>(<i></i>) | |
| 961 <p> | |
| 962 Private slot showing the backwards navigation menu. | |
| 963 </p><a NAME="HelpWindow.__showBookmarksDialog" ID="HelpWindow.__showBookmarksDialog"></a> | |
| 964 <h4>HelpWindow.__showBookmarksDialog</h4> | |
| 965 <b>__showBookmarksDialog</b>(<i></i>) | |
| 966 <p> | |
| 967 Private slot to show the bookmarks dialog. | |
| 968 </p><a NAME="HelpWindow.__showContextMenu" ID="HelpWindow.__showContextMenu"></a> | |
| 969 <h4>HelpWindow.__showContextMenu</h4> | |
| 970 <b>__showContextMenu</b>(<i>coord, index</i>) | |
| 971 <p> | |
| 972 Private slot to show the tab context menu. | |
| 973 </p><dl> | |
| 974 <dt><i>coord</i></dt> | |
| 975 <dd> | |
| 976 the position of the mouse pointer (QPoint) | |
| 977 </dd><dt><i>index</i></dt> | |
| 978 <dd> | |
| 979 index of the tab the menu is requested for (integer) | |
| 980 </dd> | |
| 981 </dl><a NAME="HelpWindow.__showCookiesConfiguration" ID="HelpWindow.__showCookiesConfiguration"></a> | |
| 982 <h4>HelpWindow.__showCookiesConfiguration</h4> | |
| 983 <b>__showCookiesConfiguration</b>(<i></i>) | |
| 984 <p> | |
| 985 Private slot to configure the cookies handling. | |
| 986 </p><a NAME="HelpWindow.__showEnginesConfigurationDialog" ID="HelpWindow.__showEnginesConfigurationDialog"></a> | |
| 987 <h4>HelpWindow.__showEnginesConfigurationDialog</h4> | |
| 988 <b>__showEnginesConfigurationDialog</b>(<i></i>) | |
| 989 <p> | |
| 990 Private slot to show the search engines configuration dialog. | |
| 991 </p><a NAME="HelpWindow.__showForwardMenu" ID="HelpWindow.__showForwardMenu"></a> | |
| 992 <h4>HelpWindow.__showForwardMenu</h4> | |
| 993 <b>__showForwardMenu</b>(<i></i>) | |
| 994 <p> | |
| 995 Private slot showing the forwards navigation menu. | |
| 996 </p><a NAME="HelpWindow.__showHistoryMenu" ID="HelpWindow.__showHistoryMenu"></a> | |
| 997 <h4>HelpWindow.__showHistoryMenu</h4> | |
| 998 <b>__showHistoryMenu</b>(<i></i>) | |
| 999 <p> | |
| 1000 Private slot called in order to show the history menu. | |
| 1001 </p><a NAME="HelpWindow.__showIndexWindow" ID="HelpWindow.__showIndexWindow"></a> | |
| 1002 <h4>HelpWindow.__showIndexWindow</h4> | |
| 1003 <b>__showIndexWindow</b>(<i></i>) | |
| 1004 <p> | |
| 1005 Private method to show the index window. | |
| 1006 </p><a NAME="HelpWindow.__showInstallationError" ID="HelpWindow.__showInstallationError"></a> | |
| 1007 <h4>HelpWindow.__showInstallationError</h4> | |
| 1008 <b>__showInstallationError</b>(<i>message</i>) | |
| 1009 <p> | |
| 1010 Private slot to show installation errors. | |
| 1011 </p><dl> | |
| 1012 <dt><i>message</i></dt> | |
| 1013 <dd> | |
| 1014 message to be shown (QString) | |
| 1015 </dd> | |
| 1016 </dl><a NAME="HelpWindow.__showNavigationMenu" ID="HelpWindow.__showNavigationMenu"></a> | |
| 1017 <h4>HelpWindow.__showNavigationMenu</h4> | |
| 1018 <b>__showNavigationMenu</b>(<i></i>) | |
| 1019 <p> | |
| 1020 Private slot to show the navigation button menu. | |
| 1021 </p><a NAME="HelpWindow.__showNetworkMonitor" ID="HelpWindow.__showNetworkMonitor"></a> | |
| 1022 <h4>HelpWindow.__showNetworkMonitor</h4> | |
| 1023 <b>__showNetworkMonitor</b>(<i></i>) | |
| 1024 <p> | |
| 1025 Private slot to show the network monitor dialog. | |
| 1026 </p><a NAME="HelpWindow.__showPageSource" ID="HelpWindow.__showPageSource"></a> | |
| 1027 <h4>HelpWindow.__showPageSource</h4> | |
| 1028 <b>__showPageSource</b>(<i></i>) | |
| 1029 <p> | |
| 1030 Private slot to show the source of the current page in an editor. | |
| 1031 </p><a NAME="HelpWindow.__showPasswordsDialog" ID="HelpWindow.__showPasswordsDialog"></a> | |
| 1032 <h4>HelpWindow.__showPasswordsDialog</h4> | |
| 1033 <b>__showPasswordsDialog</b>(<i></i>) | |
| 1034 <p> | |
| 1035 Private slot to show the passwords management dialog. | |
| 1036 </p><a NAME="HelpWindow.__showPreferences" ID="HelpWindow.__showPreferences"></a> | |
| 1037 <h4>HelpWindow.__showPreferences</h4> | |
| 1038 <b>__showPreferences</b>(<i></i>) | |
| 1039 <p> | |
| 1040 Private slot to set the preferences. | |
| 1041 </p><a NAME="HelpWindow.__showSearchWindow" ID="HelpWindow.__showSearchWindow"></a> | |
| 1042 <h4>HelpWindow.__showSearchWindow</h4> | |
| 1043 <b>__showSearchWindow</b>(<i></i>) | |
| 1044 <p> | |
| 1045 Private method to show the search window. | |
| 1046 </p><a NAME="HelpWindow.__showTocWindow" ID="HelpWindow.__showTocWindow"></a> | |
| 1047 <h4>HelpWindow.__showTocWindow</h4> | |
| 1048 <b>__showTocWindow</b>(<i></i>) | |
| 1049 <p> | |
| 1050 Private method to show the table of contents window. | |
| 1051 </p><a NAME="HelpWindow.__sourceChanged" ID="HelpWindow.__sourceChanged"></a> | |
| 1052 <h4>HelpWindow.__sourceChanged</h4> | |
| 1053 <b>__sourceChanged</b>(<i>url</i>) | |
| 1054 <p> | |
| 1055 Private slot called when the displayed text of the combobox is changed. | |
| 1056 </p><dl> | |
| 1057 <dt><i>url</i></dt> | |
| 1058 <dd> | |
| 1059 URL of the new site (QUrl) | |
| 1060 </dd> | |
| 1061 </dl><a NAME="HelpWindow.__stopLoading" ID="HelpWindow.__stopLoading"></a> | |
| 1062 <h4>HelpWindow.__stopLoading</h4> | |
| 1063 <b>__stopLoading</b>(<i></i>) | |
| 1064 <p> | |
| 1065 Private slot called to handle loading of the current page. | |
| 1066 </p><a NAME="HelpWindow.__switchTab" ID="HelpWindow.__switchTab"></a> | |
| 1067 <h4>HelpWindow.__switchTab</h4> | |
| 1068 <b>__switchTab</b>(<i></i>) | |
| 1069 <p> | |
| 1070 Private slot used to switch between the current and the previous current tab. | |
| 1071 </p><a NAME="HelpWindow.__syncTOC" ID="HelpWindow.__syncTOC"></a> | |
| 1072 <h4>HelpWindow.__syncTOC</h4> | |
| 1073 <b>__syncTOC</b>(<i></i>) | |
| 1074 <p> | |
| 1075 Private slot to synchronize the TOC with the currently shown page. | |
| 1076 </p><a NAME="HelpWindow.__tabContextMenuClone" ID="HelpWindow.__tabContextMenuClone"></a> | |
| 1077 <h4>HelpWindow.__tabContextMenuClone</h4> | |
| 1078 <b>__tabContextMenuClone</b>(<i></i>) | |
| 1079 <p> | |
| 1080 Private method to clone the selected tab. | |
| 1081 </p><a NAME="HelpWindow.__tabContextMenuClose" ID="HelpWindow.__tabContextMenuClose"></a> | |
| 1082 <h4>HelpWindow.__tabContextMenuClose</h4> | |
| 1083 <b>__tabContextMenuClose</b>(<i></i>) | |
| 1084 <p> | |
| 1085 Private method to close the selected tab. | |
| 1086 </p><a NAME="HelpWindow.__tabContextMenuCloseOthers" ID="HelpWindow.__tabContextMenuCloseOthers"></a> | |
| 1087 <h4>HelpWindow.__tabContextMenuCloseOthers</h4> | |
| 1088 <b>__tabContextMenuCloseOthers</b>(<i></i>) | |
| 1089 <p> | |
| 1090 Private slot to close all other tabs. | |
| 1091 </p><a NAME="HelpWindow.__tabContextMenuMoveLeft" ID="HelpWindow.__tabContextMenuMoveLeft"></a> | |
| 1092 <h4>HelpWindow.__tabContextMenuMoveLeft</h4> | |
| 1093 <b>__tabContextMenuMoveLeft</b>(<i></i>) | |
| 1094 <p> | |
| 1095 Private method to move a tab one position to the left. | |
| 1096 </p><a NAME="HelpWindow.__tabContextMenuMoveRight" ID="HelpWindow.__tabContextMenuMoveRight"></a> | |
| 1097 <h4>HelpWindow.__tabContextMenuMoveRight</h4> | |
| 1098 <b>__tabContextMenuMoveRight</b>(<i></i>) | |
| 1099 <p> | |
| 1100 Private method to move a tab one position to the right. | |
| 1101 </p><a NAME="HelpWindow.__tabContextMenuPrint" ID="HelpWindow.__tabContextMenuPrint"></a> | |
| 1102 <h4>HelpWindow.__tabContextMenuPrint</h4> | |
| 1103 <b>__tabContextMenuPrint</b>(<i></i>) | |
| 1104 <p> | |
| 1105 Private method to print the selected tab. | |
| 1106 </p><a NAME="HelpWindow.__tabContextMenuPrintPreview" ID="HelpWindow.__tabContextMenuPrintPreview"></a> | |
| 1107 <h4>HelpWindow.__tabContextMenuPrintPreview</h4> | |
| 1108 <b>__tabContextMenuPrintPreview</b>(<i></i>) | |
| 1109 <p> | |
| 1110 Private method to show a print preview of the selected tab. | |
| 1111 </p><a NAME="HelpWindow.__titleChanged" ID="HelpWindow.__titleChanged"></a> | |
| 1112 <h4>HelpWindow.__titleChanged</h4> | |
| 1113 <b>__titleChanged</b>(<i>title</i>) | |
| 1114 <p> | |
| 1115 Private slot called to handle a change of the current browsers title. | |
| 1116 </p><dl> | |
| 1117 <dt><i>title</i></dt> | |
| 1118 <dd> | |
| 1119 new title (string) | |
| 1120 </dd> | |
| 1121 </dl><a NAME="HelpWindow.__viewFullScreen" ID="HelpWindow.__viewFullScreen"></a> | |
| 1122 <h4>HelpWindow.__viewFullScreen</h4> | |
| 1123 <b>__viewFullScreen</b>(<i></i>) | |
| 1124 <p> | |
| 1125 Private slot called to toggle fullscreen mode. | |
| 1126 </p><a NAME="HelpWindow.__warning" ID="HelpWindow.__warning"></a> | |
| 1127 <h4>HelpWindow.__warning</h4> | |
| 1128 <b>__warning</b>(<i>msg</i>) | |
| 1129 <p> | |
| 1130 Private slot handling warnings from the help engine. | |
| 1131 </p><dl> | |
| 1132 <dt><i>msg</i></dt> | |
| 1133 <dd> | |
| 1134 message sent by the help engine (QString) | |
| 1135 </dd> | |
| 1136 </dl><a NAME="HelpWindow.__whatsThis" ID="HelpWindow.__whatsThis"></a> | |
| 1137 <h4>HelpWindow.__whatsThis</h4> | |
| 1138 <b>__whatsThis</b>(<i></i>) | |
| 1139 <p> | |
| 1140 Private slot called in to enter Whats This mode. | |
| 1141 </p><a NAME="HelpWindow.__windowCloseRequested" ID="HelpWindow.__windowCloseRequested"></a> | |
| 1142 <h4>HelpWindow.__windowCloseRequested</h4> | |
| 1143 <b>__windowCloseRequested</b>(<i></i>) | |
| 1144 <p> | |
| 1145 Private slot to handle the windowCloseRequested signal of a browser. | |
| 1146 </p><a NAME="HelpWindow.__zoomIn" ID="HelpWindow.__zoomIn"></a> | |
| 1147 <h4>HelpWindow.__zoomIn</h4> | |
| 1148 <b>__zoomIn</b>(<i></i>) | |
| 1149 <p> | |
| 1150 Private slot called to handle the zoom in action. | |
| 1151 </p><a NAME="HelpWindow.__zoomOut" ID="HelpWindow.__zoomOut"></a> | |
| 1152 <h4>HelpWindow.__zoomOut</h4> | |
| 1153 <b>__zoomOut</b>(<i></i>) | |
| 1154 <p> | |
| 1155 Private slot called to handle the zoom out action. | |
| 1156 </p><a NAME="HelpWindow.__zoomReset" ID="HelpWindow.__zoomReset"></a> | |
| 1157 <h4>HelpWindow.__zoomReset</h4> | |
| 1158 <b>__zoomReset</b>(<i></i>) | |
| 1159 <p> | |
| 1160 Private slot called to handle the zoom reset action. | |
| 1161 </p><a NAME="HelpWindow.__zoomTextOnly" ID="HelpWindow.__zoomTextOnly"></a> | |
| 1162 <h4>HelpWindow.__zoomTextOnly</h4> | |
| 1163 <b>__zoomTextOnly</b>(<i>textOnly</i>) | |
| 1164 <p> | |
| 1165 Private slot called to handle the zoom text only action. | |
| 1166 </p><dl> | |
| 1167 <dt><i>textOnly</i></dt> | |
| 1168 <dd> | |
| 1169 flag indicating to zoom text only (boolean) | |
| 1170 </dd> | |
| 1171 </dl><a NAME="HelpWindow.adblockManager" ID="HelpWindow.adblockManager"></a> | |
| 1172 <h4>HelpWindow.adblockManager</h4> | |
| 1173 <b>adblockManager</b>(<i></i>) | |
| 1174 <p> | |
| 1175 Class method to get a reference to the AdBlock manager. | |
| 1176 </p><dl> | |
| 1177 <dt>Returns:</dt> | |
| 1178 <dd> | |
| 1179 reference to the AdBlock manager (AdBlockManager) | |
| 1180 </dd> | |
| 1181 </dl><a NAME="HelpWindow.bookmarksManager" ID="HelpWindow.bookmarksManager"></a> | |
| 1182 <h4>HelpWindow.bookmarksManager</h4> | |
| 1183 <b>bookmarksManager</b>(<i></i>) | |
| 1184 <p> | |
| 1185 Class method to get a reference to the bookmarks manager. | |
| 1186 </p><dl> | |
| 1187 <dt>Returns:</dt> | |
| 1188 <dd> | |
| 1189 reference to the bookmarks manager (BookmarksManager) | |
| 1190 </dd> | |
| 1191 </dl><a NAME="HelpWindow.browsers" ID="HelpWindow.browsers"></a> | |
| 1192 <h4>HelpWindow.browsers</h4> | |
| 1193 <b>browsers</b>(<i></i>) | |
| 1194 <p> | |
| 1195 Public method to get a list of references to all help browsers. | |
| 1196 </p><dl> | |
| 1197 <dt>Returns:</dt> | |
| 1198 <dd> | |
| 1199 list of references to help browsers (list of HelpBrowser) | |
| 1200 </dd> | |
| 1201 </dl><a NAME="HelpWindow.closeEvent" ID="HelpWindow.closeEvent"></a> | |
| 1202 <h4>HelpWindow.closeEvent</h4> | |
| 1203 <b>closeEvent</b>(<i>e</i>) | |
| 1204 <p> | |
| 1205 Private event handler for the close event. | |
| 1206 </p><dl> | |
| 1207 <dt><i>e</i></dt> | |
| 1208 <dd> | |
| 1209 the close event (QCloseEvent) | |
| 1210 <br />This event is simply accepted after the history has been | |
| 1211 saved and all window references have been deleted. | |
| 1212 </dd> | |
| 1213 </dl><a NAME="HelpWindow.cookieJar" ID="HelpWindow.cookieJar"></a> | |
| 1214 <h4>HelpWindow.cookieJar</h4> | |
| 1215 <b>cookieJar</b>(<i></i>) | |
| 1216 <p> | |
| 1217 Class method to get a reference to the cookie jar. | |
| 1218 </p><dl> | |
| 1219 <dt>Returns:</dt> | |
| 1220 <dd> | |
| 1221 reference to the cookie jar (CookieJar) | |
| 1222 </dd> | |
| 1223 </dl><a NAME="HelpWindow.currentBrowser" ID="HelpWindow.currentBrowser"></a> | |
| 1224 <h4>HelpWindow.currentBrowser</h4> | |
| 1225 <b>currentBrowser</b>(<i></i>) | |
| 1226 <p> | |
| 1227 Public method to get a reference to the current help browser. | |
| 1228 </p><dl> | |
| 1229 <dt>Returns:</dt> | |
| 1230 <dd> | |
| 1231 reference to the current help browser (HelpBrowser) | |
| 1232 </dd> | |
| 1233 </dl><a NAME="HelpWindow.getActions" ID="HelpWindow.getActions"></a> | |
| 1234 <h4>HelpWindow.getActions</h4> | |
| 1235 <b>getActions</b>(<i></i>) | |
| 1236 <p> | |
| 1237 Public method to get a list of all actions. | |
| 1238 </p><dl> | |
| 1239 <dt>Returns:</dt> | |
| 1240 <dd> | |
| 1241 list of all actions (list of E4Action) | |
| 1242 </dd> | |
| 1243 </dl><a NAME="HelpWindow.getSourceFileList" ID="HelpWindow.getSourceFileList"></a> | |
| 1244 <h4>HelpWindow.getSourceFileList</h4> | |
| 1245 <b>getSourceFileList</b>(<i></i>) | |
| 1246 <p> | |
| 1247 Public method to get a list of all opened source files. | |
| 1248 </p><dl> | |
| 1249 <dt>Returns:</dt> | |
| 1250 <dd> | |
| 1251 dictionary with tab id as key and host/namespace as value | |
| 1252 </dd> | |
| 1253 </dl><a NAME="HelpWindow.helpEngine" ID="HelpWindow.helpEngine"></a> | |
| 1254 <h4>HelpWindow.helpEngine</h4> | |
| 1255 <b>helpEngine</b>(<i></i>) | |
| 1256 <p> | |
| 1257 Class method to get a reference to the help engine. | |
| 1258 </p><dl> | |
| 1259 <dt>Returns:</dt> | |
| 1260 <dd> | |
| 1261 reference to the help engine (QHelpEngine) | |
| 1262 </dd> | |
| 1263 </dl><a NAME="HelpWindow.historyManager" ID="HelpWindow.historyManager"></a> | |
| 1264 <h4>HelpWindow.historyManager</h4> | |
| 1265 <b>historyManager</b>(<i></i>) | |
| 1266 <p> | |
| 1267 Class method to get a reference to the history manager. | |
| 1268 </p><dl> | |
| 1269 <dt>Returns:</dt> | |
| 1270 <dd> | |
| 1271 reference to the history manager (HistoryManager) | |
| 1272 </dd> | |
| 1273 </dl><a NAME="HelpWindow.icon" ID="HelpWindow.icon"></a> | |
| 1274 <h4>HelpWindow.icon</h4> | |
| 1275 <b>icon</b>(<i>url</i>) | |
| 1276 <p> | |
| 1277 Class method to get the icon for an URL. | |
| 1278 </p><dl> | |
| 1279 <dt><i>url</i></dt> | |
| 1280 <dd> | |
| 1281 URL to get icon for (QUrl) | |
| 1282 </dd> | |
| 1283 </dl><dl> | |
| 1284 <dt>Returns:</dt> | |
| 1285 <dd> | |
| 1286 icon for the URL (QIcon) | |
| 1287 </dd> | |
| 1288 </dl><a NAME="HelpWindow.iconChanged" ID="HelpWindow.iconChanged"></a> | |
| 1289 <h4>HelpWindow.iconChanged</h4> | |
| 1290 <b>iconChanged</b>(<i>icon</i>) | |
| 1291 <p> | |
| 1292 Public slot to change the icon shown to the left of the URL entry. | |
| 1293 </p><dl> | |
| 1294 <dt><i>icon</i></dt> | |
| 1295 <dd> | |
| 1296 icon to be shown (QIcon) | |
| 1297 </dd> | |
| 1298 </dl><a NAME="HelpWindow.networkAccessManager" ID="HelpWindow.networkAccessManager"></a> | |
| 1299 <h4>HelpWindow.networkAccessManager</h4> | |
| 1300 <b>networkAccessManager</b>(<i></i>) | |
| 1301 <p> | |
| 1302 Class method to get a reference to the network access manager. | |
| 1303 </p><dl> | |
| 1304 <dt>Returns:</dt> | |
| 1305 <dd> | |
| 1306 reference to the network access manager (NetworkAccessManager) | |
| 1307 </dd> | |
| 1308 </dl><a NAME="HelpWindow.newBrowser" ID="HelpWindow.newBrowser"></a> | |
| 1309 <h4>HelpWindow.newBrowser</h4> | |
| 1310 <b>newBrowser</b>(<i>link</i>) | |
| 1311 <p> | |
| 1312 Public method to create a new help browser tab. | |
| 1313 </p><dl> | |
| 1314 <dt><i>link</i></dt> | |
| 1315 <dd> | |
| 1316 link to be shown (string) | |
| 1317 </dd> | |
| 1318 </dl><a NAME="HelpWindow.newTab" ID="HelpWindow.newTab"></a> | |
| 1319 <h4>HelpWindow.newTab</h4> | |
| 1320 <b>newTab</b>(<i>link = None</i>) | |
| 1321 <p> | |
| 1322 Public slot called to open a new help window tab. | |
| 1323 </p><dl> | |
| 1324 <dt><i>link</i></dt> | |
| 1325 <dd> | |
| 1326 file to be displayed in the new window (string or QUrl) | |
| 1327 </dd> | |
| 1328 </dl><a NAME="HelpWindow.newWindow" ID="HelpWindow.newWindow"></a> | |
| 1329 <h4>HelpWindow.newWindow</h4> | |
| 1330 <b>newWindow</b>(<i>link = None</i>) | |
| 1331 <p> | |
| 1332 Public slot called to open a new help browser dialog. | |
| 1333 </p><dl> | |
| 1334 <dt><i>link</i></dt> | |
| 1335 <dd> | |
| 1336 file to be displayed in the new window (string or QUrl) | |
| 1337 </dd> | |
| 1338 </dl><a NAME="HelpWindow.passwordManager" ID="HelpWindow.passwordManager"></a> | |
| 1339 <h4>HelpWindow.passwordManager</h4> | |
| 1340 <b>passwordManager</b>(<i></i>) | |
| 1341 <p> | |
| 1342 Class method to get a reference to the password manager. | |
| 1343 </p><dl> | |
| 1344 <dt>Returns:</dt> | |
| 1345 <dd> | |
| 1346 reference to the password manager (PasswordManager) | |
| 1347 </dd> | |
| 1348 </dl><a NAME="HelpWindow.preferencesChanged" ID="HelpWindow.preferencesChanged"></a> | |
| 1349 <h4>HelpWindow.preferencesChanged</h4> | |
| 1350 <b>preferencesChanged</b>(<i></i>) | |
| 1351 <p> | |
| 1352 Public slot to handle a change of preferences. | |
| 1353 </p><a NAME="HelpWindow.progressBar" ID="HelpWindow.progressBar"></a> | |
| 1354 <h4>HelpWindow.progressBar</h4> | |
| 1355 <b>progressBar</b>(<i></i>) | |
| 1356 <p> | |
| 1357 Public method to get a reference to the load progress bar. | |
| 1358 </p><dl> | |
| 1359 <dt>Returns:</dt> | |
| 1360 <dd> | |
| 1361 reference to the load progress bar (QProgressBar) | |
| 1362 </dd> | |
| 1363 </dl><a NAME="HelpWindow.resetLoading" ID="HelpWindow.resetLoading"></a> | |
| 1364 <h4>HelpWindow.resetLoading</h4> | |
| 1365 <b>resetLoading</b>(<i>widget</i>) | |
| 1366 <p> | |
| 1367 Public method to reset the loading icon. | |
| 1368 </p><dl> | |
| 1369 <dt><i>widget</i></dt> | |
| 1370 <dd> | |
| 1371 reference to the widget to reset the icon for (QWidget) | |
| 1372 </dd> | |
| 1373 </dl><a NAME="HelpWindow.search" ID="HelpWindow.search"></a> | |
| 1374 <h4>HelpWindow.search</h4> | |
| 1375 <b>search</b>(<i>word</i>) | |
| 1376 <p> | |
| 1377 Public method to search for a word. | |
| 1378 </p><dl> | |
| 1379 <dt><i>word</i></dt> | |
| 1380 <dd> | |
| 1381 word to search for (string) | |
| 1382 </dd> | |
| 1383 </dl><a NAME="HelpWindow.searchEnginesAction" ID="HelpWindow.searchEnginesAction"></a> | |
| 1384 <h4>HelpWindow.searchEnginesAction</h4> | |
| 1385 <b>searchEnginesAction</b>(<i></i>) | |
| 1386 <p> | |
| 1387 Public method to get a reference to the search engines configuration action. | |
| 1388 </p><dl> | |
| 1389 <dt>Returns:</dt> | |
| 1390 <dd> | |
| 1391 reference to the search engines configuration action (QAction) | |
| 1392 </dd> | |
| 1393 </dl><a NAME="HelpWindow.setLoading" ID="HelpWindow.setLoading"></a> | |
| 1394 <h4>HelpWindow.setLoading</h4> | |
| 1395 <b>setLoading</b>(<i>widget</i>) | |
| 1396 <p> | |
| 1397 Public method to set the loading icon. | |
| 1398 </p><dl> | |
| 1399 <dt><i>widget</i></dt> | |
| 1400 <dd> | |
| 1401 reference to the widget to set the icon for (QWidget) | |
| 1402 </dd> | |
| 1403 </dl> | |
| 1404 <div align="right"><a href="#top">Up</a></div> | |
| 1405 <hr /> | |
| 1406 </body></html> |
