Documentation/Source/eric6.Helpviewer.HelpWindow.html

changeset 3673
e26d7d0c1088
child 4335
a25c157625c4
child 4373
54d6d7c772ea
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.HelpWindow</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Helpviewer.HelpWindow</h1>
23 <p>
24 Module implementing the helpviewer main window.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#HelpWindow">HelpWindow</a></td>
34 <td>Class implementing the web browser main window.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="HelpWindow" ID="HelpWindow"></a>
43 <h2>HelpWindow</h2>
44 <p>
45 Class implementing the web browser main window.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>helpClosed()</dt>
49 <dd>
50 emitted after the window was requested to close down
51 </dd><dt>zoomTextOnlyChanged(bool)</dt>
52 <dd>
53 emitted after the zoom text only setting
54 was changed
55 </dd>
56 </dl>
57 <h3>Derived from</h3>
58 E5MainWindow
59 <h3>Class Attributes</h3>
60 <table>
61 <tr><td>_adblockManager</td></tr><tr><td>_bookmarksManager</td></tr><tr><td>_cookieJar</td></tr><tr><td>_downloadManager</td></tr><tr><td>_feedsManager</td></tr><tr><td>_fromEric</td></tr><tr><td>_greaseMonkeyManager</td></tr><tr><td>_helpEngine</td></tr><tr><td>_historyManager</td></tr><tr><td>_networkAccessManager</td></tr><tr><td>_notification</td></tr><tr><td>_passwordManager</td></tr><tr><td>_personalInformationManager</td></tr><tr><td>_speedDial</td></tr><tr><td>_syncManager</td></tr><tr><td>_userAgentsManager</td></tr><tr><td>helpwindows</td></tr><tr><td>maxMenuFilePathLen</td></tr><tr><td>useQtHelp</td></tr>
62 </table>
63 <h3>Class Methods</h3>
64 <table>
65 <tr>
66 <td><a href="#HelpWindow.adBlockManager">adBlockManager</a></td>
67 <td>Class method to get a reference to the AdBlock manager.</td>
68 </tr><tr>
69 <td><a href="#HelpWindow.bookmarksManager">bookmarksManager</a></td>
70 <td>Class method to get a reference to the bookmarks manager.</td>
71 </tr><tr>
72 <td><a href="#HelpWindow.cookieJar">cookieJar</a></td>
73 <td>Class method to get a reference to the cookie jar.</td>
74 </tr><tr>
75 <td><a href="#HelpWindow.downloadManager">downloadManager</a></td>
76 <td>Class method to get a reference to the download manager.</td>
77 </tr><tr>
78 <td><a href="#HelpWindow.feedsManager">feedsManager</a></td>
79 <td>Class method to get a reference to the RSS feeds manager.</td>
80 </tr><tr>
81 <td><a href="#HelpWindow.greaseMonkeyManager">greaseMonkeyManager</a></td>
82 <td>Class method to get a reference to the GreaseMonkey manager.</td>
83 </tr><tr>
84 <td><a href="#HelpWindow.helpEngine">helpEngine</a></td>
85 <td>Class method to get a reference to the help engine.</td>
86 </tr><tr>
87 <td><a href="#HelpWindow.historyManager">historyManager</a></td>
88 <td>Class method to get a reference to the history manager.</td>
89 </tr><tr>
90 <td><a href="#HelpWindow.icon">icon</a></td>
91 <td>Class method to get the icon for an URL.</td>
92 </tr><tr>
93 <td><a href="#HelpWindow.mainWindow">mainWindow</a></td>
94 <td>Class method to get a reference to the main window.</td>
95 </tr><tr>
96 <td><a href="#HelpWindow.mainWindows">mainWindows</a></td>
97 <td>Class method to get references to all main windows.</td>
98 </tr><tr>
99 <td><a href="#HelpWindow.networkAccessManager">networkAccessManager</a></td>
100 <td>Class method to get a reference to the network access manager.</td>
101 </tr><tr>
102 <td><a href="#HelpWindow.notificationsEnabled">notificationsEnabled</a></td>
103 <td>Class method to check, if notifications are enabled.</td>
104 </tr><tr>
105 <td><a href="#HelpWindow.passwordManager">passwordManager</a></td>
106 <td>Class method to get a reference to the password manager.</td>
107 </tr><tr>
108 <td><a href="#HelpWindow.personalInformationManager">personalInformationManager</a></td>
109 <td>Class method to get a reference to the personal information manager.</td>
110 </tr><tr>
111 <td><a href="#HelpWindow.setUseQtHelp">setUseQtHelp</a></td>
112 <td>Class method to set the QtHelp usage.</td>
113 </tr><tr>
114 <td><a href="#HelpWindow.showNotification">showNotification</a></td>
115 <td>Class method to show a desktop notification.</td>
116 </tr><tr>
117 <td><a href="#HelpWindow.speedDial">speedDial</a></td>
118 <td>Class methdo to get a reference to the speed dial.</td>
119 </tr><tr>
120 <td><a href="#HelpWindow.syncManager">syncManager</a></td>
121 <td>Class method to get a reference to the data synchronization manager.</td>
122 </tr><tr>
123 <td><a href="#HelpWindow.userAgentsManager">userAgentsManager</a></td>
124 <td>Class method to get a reference to the user agents manager.</td>
125 </tr>
126 </table>
127 <h3>Methods</h3>
128 <table>
129 <tr>
130 <td><a href="#HelpWindow.__init__">HelpWindow</a></td>
131 <td>Constructor</td>
132 </tr><tr>
133 <td><a href="#HelpWindow.__about">__about</a></td>
134 <td>Private slot to show the about information.</td>
135 </tr><tr>
136 <td><a href="#HelpWindow.__aboutQt">__aboutQt</a></td>
137 <td>Private slot to show info about Qt.</td>
138 </tr><tr>
139 <td><a href="#HelpWindow.__aboutToShowSettingsMenu">__aboutToShowSettingsMenu</a></td>
140 <td>Private slot to show the Settings menu.</td>
141 </tr><tr>
142 <td><a href="#HelpWindow.__aboutToShowTextEncodingMenu">__aboutToShowTextEncodingMenu</a></td>
143 <td>Private slot to populate the text encoding menu.</td>
144 </tr><tr>
145 <td><a href="#HelpWindow.__activateCurrentBrowser">__activateCurrentBrowser</a></td>
146 <td>Private slot to activate the current browser.</td>
147 </tr><tr>
148 <td><a href="#HelpWindow.__activateDock">__activateDock</a></td>
149 <td>Private method to activate the dock widget of the given widget.</td>
150 </tr><tr>
151 <td><a href="#HelpWindow.__addBookmark">__addBookmark</a></td>
152 <td>Private slot called to add the displayed file to the bookmarks.</td>
153 </tr><tr>
154 <td><a href="#HelpWindow.__addBookmarkFolder">__addBookmarkFolder</a></td>
155 <td>Private slot to add a new bookmarks folder.</td>
156 </tr><tr>
157 <td><a href="#HelpWindow.__backward">__backward</a></td>
158 <td>Private slot called to handle the backward action.</td>
159 </tr><tr>
160 <td><a href="#HelpWindow.__browserClosed">__browserClosed</a></td>
161 <td>Private slot handling the closure of a browser tab.</td>
162 </tr><tr>
163 <td><a href="#HelpWindow.__clearIconsDatabase">__clearIconsDatabase</a></td>
164 <td>Private slot to clear the icons databse.</td>
165 </tr><tr>
166 <td><a href="#HelpWindow.__clearPrivateData">__clearPrivateData</a></td>
167 <td>Private slot to clear the private data.</td>
168 </tr><tr>
169 <td><a href="#HelpWindow.__closeAllWindows">__closeAllWindows</a></td>
170 <td>Private slot to close all windows.</td>
171 </tr><tr>
172 <td><a href="#HelpWindow.__closeNetworkMonitor">__closeNetworkMonitor</a></td>
173 <td>Private slot to close the network monitor dialog.</td>
174 </tr><tr>
175 <td><a href="#HelpWindow.__copy">__copy</a></td>
176 <td>Private slot called to handle the copy action.</td>
177 </tr><tr>
178 <td><a href="#HelpWindow.__currentChanged">__currentChanged</a></td>
179 <td>Private slot to handle the currentChanged signal.</td>
180 </tr><tr>
181 <td><a href="#HelpWindow.__del__">__del__</a></td>
182 <td>Special method called during object destruction.</td>
183 </tr><tr>
184 <td><a href="#HelpWindow.__docsInstalled">__docsInstalled</a></td>
185 <td>Private slot handling the end of documentation installation.</td>
186 </tr><tr>
187 <td><a href="#HelpWindow.__feedsManagerClosed">__feedsManagerClosed</a></td>
188 <td>Private slot to handle closing the feeds manager dialog.</td>
189 </tr><tr>
190 <td><a href="#HelpWindow.__filterQtHelpDocumentation">__filterQtHelpDocumentation</a></td>
191 <td>Private slot to filter the QtHelp documentation.</td>
192 </tr><tr>
193 <td><a href="#HelpWindow.__find">__find</a></td>
194 <td>Private slot to handle the find action.</td>
195 </tr><tr>
196 <td><a href="#HelpWindow.__forward">__forward</a></td>
197 <td>Private slot called to handle the forward action.</td>
198 </tr><tr>
199 <td><a href="#HelpWindow.__hideIndexWindow">__hideIndexWindow</a></td>
200 <td>Private method to hide the index window.</td>
201 </tr><tr>
202 <td><a href="#HelpWindow.__hideSearchWindow">__hideSearchWindow</a></td>
203 <td>Private method to hide the search window.</td>
204 </tr><tr>
205 <td><a href="#HelpWindow.__hideTocWindow">__hideTocWindow</a></td>
206 <td>Private method to hide the table of contents window.</td>
207 </tr><tr>
208 <td><a href="#HelpWindow.__home">__home</a></td>
209 <td>Private slot called to handle the home action.</td>
210 </tr><tr>
211 <td><a href="#HelpWindow.__indexingFinished">__indexingFinished</a></td>
212 <td>Private slot to handle the start of the indexing process.</td>
213 </tr><tr>
214 <td><a href="#HelpWindow.__indexingStarted">__indexingStarted</a></td>
215 <td>Private slot to handle the start of the indexing process.</td>
216 </tr><tr>
217 <td><a href="#HelpWindow.__initActions">__initActions</a></td>
218 <td>Private method to define the user interface actions.</td>
219 </tr><tr>
220 <td><a href="#HelpWindow.__initHelpDb">__initHelpDb</a></td>
221 <td>Private slot to initialize the documentation database.</td>
222 </tr><tr>
223 <td><a href="#HelpWindow.__initMenus">__initMenus</a></td>
224 <td>Private method to create the menus.</td>
225 </tr><tr>
226 <td><a href="#HelpWindow.__initToolbars">__initToolbars</a></td>
227 <td>Private method to create the toolbars.</td>
228 </tr><tr>
229 <td><a href="#HelpWindow.__initWebSettings">__initWebSettings</a></td>
230 <td>Private method to set the global web settings.</td>
231 </tr><tr>
232 <td><a href="#HelpWindow.__isFullScreen">__isFullScreen</a></td>
233 <td>Private method to determine, if the window is in full screen mode.</td>
234 </tr><tr>
235 <td><a href="#HelpWindow.__linkActivated">__linkActivated</a></td>
236 <td>Private slot to handle the selection of a link in the TOC window.</td>
237 </tr><tr>
238 <td><a href="#HelpWindow.__linksActivated">__linksActivated</a></td>
239 <td>Private slot to select a topic to be shown.</td>
240 </tr><tr>
241 <td><a href="#HelpWindow.__lookForNewDocumentation">__lookForNewDocumentation</a></td>
242 <td>Private slot to look for new documentation to be loaded into the help database.</td>
243 </tr><tr>
244 <td><a href="#HelpWindow.__manageQtHelpDocumentation">__manageQtHelpDocumentation</a></td>
245 <td>Private slot to manage the QtHelp documentation database.</td>
246 </tr><tr>
247 <td><a href="#HelpWindow.__manageQtHelpFilters">__manageQtHelpFilters</a></td>
248 <td>Private slot to manage the QtHelp filters.</td>
249 </tr><tr>
250 <td><a href="#HelpWindow.__navigationMenuActionTriggered">__navigationMenuActionTriggered</a></td>
251 <td>Private slot to go to the selected page.</td>
252 </tr><tr>
253 <td><a href="#HelpWindow.__nextTab">__nextTab</a></td>
254 <td>Private slot used to show the next tab.</td>
255 </tr><tr>
256 <td><a href="#HelpWindow.__openFile">__openFile</a></td>
257 <td>Private slot called to open a file.</td>
258 </tr><tr>
259 <td><a href="#HelpWindow.__openFileNewTab">__openFileNewTab</a></td>
260 <td>Private slot called to open a file in a new tab.</td>
261 </tr><tr>
262 <td><a href="#HelpWindow.__prevTab">__prevTab</a></td>
263 <td>Private slot used to show the previous tab.</td>
264 </tr><tr>
265 <td><a href="#HelpWindow.__privateBrowsing">__privateBrowsing</a></td>
266 <td>Private slot to switch private browsing.</td>
267 </tr><tr>
268 <td><a href="#HelpWindow.__reload">__reload</a></td>
269 <td>Private slot called to handle the reload action.</td>
270 </tr><tr>
271 <td><a href="#HelpWindow.__removeOldDocumentation">__removeOldDocumentation</a></td>
272 <td>Private slot to remove non-existing documentation from the help engine.</td>
273 </tr><tr>
274 <td><a href="#HelpWindow.__savePageAs">__savePageAs</a></td>
275 <td>Private slot to save the current page.</td>
276 </tr><tr>
277 <td><a href="#HelpWindow.__savePageScreen">__savePageScreen</a></td>
278 <td>Private slot to save the current page as a screen shot.</td>
279 </tr><tr>
280 <td><a href="#HelpWindow.__saveVisiblePageScreen">__saveVisiblePageScreen</a></td>
281 <td>Private slot to save the visible part of the current page as a screen shot.</td>
282 </tr><tr>
283 <td><a href="#HelpWindow.__searchForWord">__searchForWord</a></td>
284 <td>Private slot to search for a word.</td>
285 </tr><tr>
286 <td><a href="#HelpWindow.__setIconDatabasePath">__setIconDatabasePath</a></td>
287 <td>Private method to set the favicons path.</td>
288 </tr><tr>
289 <td><a href="#HelpWindow.__setTextEncoding">__setTextEncoding</a></td>
290 <td>Private slot to set the selected text encoding as the default for this session.</td>
291 </tr><tr>
292 <td><a href="#HelpWindow.__setupFilterCombo">__setupFilterCombo</a></td>
293 <td>Private slot to setup the filter combo box.</td>
294 </tr><tr>
295 <td><a href="#HelpWindow.__showAcceptedLanguages">__showAcceptedLanguages</a></td>
296 <td>Private slot to configure the accepted languages for web pages.</td>
297 </tr><tr>
298 <td><a href="#HelpWindow.__showAdBlockDialog">__showAdBlockDialog</a></td>
299 <td>Private slot to show the AdBlock configuration dialog.</td>
300 </tr><tr>
301 <td><a href="#HelpWindow.__showBackMenu">__showBackMenu</a></td>
302 <td>Private slot showing the backwards navigation menu.</td>
303 </tr><tr>
304 <td><a href="#HelpWindow.__showBookmarksDialog">__showBookmarksDialog</a></td>
305 <td>Private slot to show the bookmarks dialog.</td>
306 </tr><tr>
307 <td><a href="#HelpWindow.__showCertificatesDialog">__showCertificatesDialog</a></td>
308 <td>Private slot to show the certificates management dialog.</td>
309 </tr><tr>
310 <td><a href="#HelpWindow.__showClickToFlashDialog">__showClickToFlashDialog</a></td>
311 <td>Private slot to open the ClickToFlash whitelist configuration dialog.</td>
312 </tr><tr>
313 <td><a href="#HelpWindow.__showCookiesConfiguration">__showCookiesConfiguration</a></td>
314 <td>Private slot to configure the cookies handling.</td>
315 </tr><tr>
316 <td><a href="#HelpWindow.__showDownloadsWindow">__showDownloadsWindow</a></td>
317 <td>Private slot to show the downloads dialog.</td>
318 </tr><tr>
319 <td><a href="#HelpWindow.__showEnginesConfigurationDialog">__showEnginesConfigurationDialog</a></td>
320 <td>Private slot to show the search engines configuration dialog.</td>
321 </tr><tr>
322 <td><a href="#HelpWindow.__showFeedsManager">__showFeedsManager</a></td>
323 <td>Private slot to show the feeds manager dialog.</td>
324 </tr><tr>
325 <td><a href="#HelpWindow.__showForwardMenu">__showForwardMenu</a></td>
326 <td>Private slot showing the forwards navigation menu.</td>
327 </tr><tr>
328 <td><a href="#HelpWindow.__showGreaseMonkeyConfigDialog">__showGreaseMonkeyConfigDialog</a></td>
329 <td>Private slot to show the GreaseMonkey scripts configuration dialog.</td>
330 </tr><tr>
331 <td><a href="#HelpWindow.__showIndexWindow">__showIndexWindow</a></td>
332 <td>Private method to show the index window.</td>
333 </tr><tr>
334 <td><a href="#HelpWindow.__showInstallationError">__showInstallationError</a></td>
335 <td>Private slot to show installation errors.</td>
336 </tr><tr>
337 <td><a href="#HelpWindow.__showNetworkMonitor">__showNetworkMonitor</a></td>
338 <td>Private slot to show the network monitor dialog.</td>
339 </tr><tr>
340 <td><a href="#HelpWindow.__showOfflineStorageConfiguration">__showOfflineStorageConfiguration</a></td>
341 <td>Private slot to configure the offline storage.</td>
342 </tr><tr>
343 <td><a href="#HelpWindow.__showPageSource">__showPageSource</a></td>
344 <td>Private slot to show the source of the current page in an editor.</td>
345 </tr><tr>
346 <td><a href="#HelpWindow.__showPasswordsDialog">__showPasswordsDialog</a></td>
347 <td>Private slot to show the passwords management dialog.</td>
348 </tr><tr>
349 <td><a href="#HelpWindow.__showPersonalInformationDialog">__showPersonalInformationDialog</a></td>
350 <td>Private slot to show the Personal Information configuration dialog.</td>
351 </tr><tr>
352 <td><a href="#HelpWindow.__showPreferences">__showPreferences</a></td>
353 <td>Private slot to set the preferences.</td>
354 </tr><tr>
355 <td><a href="#HelpWindow.__showSearchWindow">__showSearchWindow</a></td>
356 <td>Private method to show the search window.</td>
357 </tr><tr>
358 <td><a href="#HelpWindow.__showSiteinfoDialog">__showSiteinfoDialog</a></td>
359 <td>Private slot to show the site info dialog.</td>
360 </tr><tr>
361 <td><a href="#HelpWindow.__showSyncDialog">__showSyncDialog</a></td>
362 <td>Private slot to show the synchronization dialog.</td>
363 </tr><tr>
364 <td><a href="#HelpWindow.__showTocWindow">__showTocWindow</a></td>
365 <td>Private method to show the table of contents window.</td>
366 </tr><tr>
367 <td><a href="#HelpWindow.__showUserAgentsDialog">__showUserAgentsDialog</a></td>
368 <td>Private slot to show the user agents management dialog.</td>
369 </tr><tr>
370 <td><a href="#HelpWindow.__stopLoading">__stopLoading</a></td>
371 <td>Private slot called to handle loading of the current page.</td>
372 </tr><tr>
373 <td><a href="#HelpWindow.__switchTab">__switchTab</a></td>
374 <td>Private slot used to switch between the current and the previous current tab.</td>
375 </tr><tr>
376 <td><a href="#HelpWindow.__syncTOC">__syncTOC</a></td>
377 <td>Private slot to synchronize the TOC with the currently shown page.</td>
378 </tr><tr>
379 <td><a href="#HelpWindow.__titleChanged">__titleChanged</a></td>
380 <td>Private slot called to handle a change of s browser's title.</td>
381 </tr><tr>
382 <td><a href="#HelpWindow.__userStyleSheet">__userStyleSheet</a></td>
383 <td>Private method to generate the user style sheet.</td>
384 </tr><tr>
385 <td><a href="#HelpWindow.__viewFullScreen">__viewFullScreen</a></td>
386 <td>Private slot called to toggle fullscreen mode.</td>
387 </tr><tr>
388 <td><a href="#HelpWindow.__virusTotalFileScanReport">__virusTotalFileScanReport</a></td>
389 <td>Private slot to initiate the display of the file scan report page.</td>
390 </tr><tr>
391 <td><a href="#HelpWindow.__virusTotalScanCurrentSite">__virusTotalScanCurrentSite</a></td>
392 <td>Private slot to ask VirusTotal for a scan of the URL of the current browser.</td>
393 </tr><tr>
394 <td><a href="#HelpWindow.__virusTotalSearch">__virusTotalSearch</a></td>
395 <td>Private slot to search VirusTotal for a given entry.</td>
396 </tr><tr>
397 <td><a href="#HelpWindow.__virusTotalSearchChanged">__virusTotalSearchChanged</a></td>
398 <td>Private slot to react upon changes of the VirusTotal search text.</td>
399 </tr><tr>
400 <td><a href="#HelpWindow.__virusTotalSubmitUrlError">__virusTotalSubmitUrlError</a></td>
401 <td>Private slot to handle an URL scan submission error.</td>
402 </tr><tr>
403 <td><a href="#HelpWindow.__virusTotalUrlScanReport">__virusTotalUrlScanReport</a></td>
404 <td>Private slot to initiate the display of the URL scan report page.</td>
405 </tr><tr>
406 <td><a href="#HelpWindow.__warning">__warning</a></td>
407 <td>Private slot handling warnings from the help engine.</td>
408 </tr><tr>
409 <td><a href="#HelpWindow.__whatsThis">__whatsThis</a></td>
410 <td>Private slot called in to enter Whats This mode.</td>
411 </tr><tr>
412 <td><a href="#HelpWindow.__zoomIn">__zoomIn</a></td>
413 <td>Private slot called to handle the zoom in action.</td>
414 </tr><tr>
415 <td><a href="#HelpWindow.__zoomOut">__zoomOut</a></td>
416 <td>Private slot called to handle the zoom out action.</td>
417 </tr><tr>
418 <td><a href="#HelpWindow.__zoomReset">__zoomReset</a></td>
419 <td>Private slot called to handle the zoom reset action.</td>
420 </tr><tr>
421 <td><a href="#HelpWindow.__zoomTextOnly">__zoomTextOnly</a></td>
422 <td>Private slot called to handle the zoom text only action.</td>
423 </tr><tr>
424 <td><a href="#HelpWindow.__zoomValueChanged">__zoomValueChanged</a></td>
425 <td>Private slot to handle value changes of the zoom widget.</td>
426 </tr><tr>
427 <td><a href="#HelpWindow.adBlockIcon">adBlockIcon</a></td>
428 <td>Public method to get a reference to the AdBlock icon.</td>
429 </tr><tr>
430 <td><a href="#HelpWindow.bookmarkAll">bookmarkAll</a></td>
431 <td>Public slot to bookmark all open tabs.</td>
432 </tr><tr>
433 <td><a href="#HelpWindow.browserAt">browserAt</a></td>
434 <td>Public method to get a reference to the help browser with the given index.</td>
435 </tr><tr>
436 <td><a href="#HelpWindow.browsers">browsers</a></td>
437 <td>Public method to get a list of references to all help browsers.</td>
438 </tr><tr>
439 <td><a href="#HelpWindow.closeEvent">closeEvent</a></td>
440 <td>Protected event handler for the close event.</td>
441 </tr><tr>
442 <td><a href="#HelpWindow.currentBrowser">currentBrowser</a></td>
443 <td>Public method to get a reference to the current help browser.</td>
444 </tr><tr>
445 <td><a href="#HelpWindow.eventKeyboardModifiers">eventKeyboardModifiers</a></td>
446 <td>Public method to get the last recorded keyboard modifiers.</td>
447 </tr><tr>
448 <td><a href="#HelpWindow.eventMouseButtons">eventMouseButtons</a></td>
449 <td>Public method to get the last recorded mouse buttons.</td>
450 </tr><tr>
451 <td><a href="#HelpWindow.getActions">getActions</a></td>
452 <td>Public method to get a list of all actions.</td>
453 </tr><tr>
454 <td><a href="#HelpWindow.getSourceFileList">getSourceFileList</a></td>
455 <td>Public method to get a list of all opened source files.</td>
456 </tr><tr>
457 <td><a href="#HelpWindow.keyPressEvent">keyPressEvent</a></td>
458 <td>Protected method to handle key presses.</td>
459 </tr><tr>
460 <td><a href="#HelpWindow.masterPasswordChanged">masterPasswordChanged</a></td>
461 <td>Public slot to handle the change of the master password.</td>
462 </tr><tr>
463 <td><a href="#HelpWindow.mousePressEvent">mousePressEvent</a></td>
464 <td>Protected method called by a mouse press event.</td>
465 </tr><tr>
466 <td><a href="#HelpWindow.newTab">newTab</a></td>
467 <td>Public slot called to open a new help window tab.</td>
468 </tr><tr>
469 <td><a href="#HelpWindow.newWindow">newWindow</a></td>
470 <td>Public slot called to open a new help browser dialog.</td>
471 </tr><tr>
472 <td><a href="#HelpWindow.openSearchManager">openSearchManager</a></td>
473 <td>Public method to get a reference to the opensearch manager object.</td>
474 </tr><tr>
475 <td><a href="#HelpWindow.openUrl">openUrl</a></td>
476 <td>Public slot to load a URL from the bookmarks menu or bookmarks toolbar in the current tab.</td>
477 </tr><tr>
478 <td><a href="#HelpWindow.openUrlNewTab">openUrlNewTab</a></td>
479 <td>Public slot to load a URL from the bookmarks menu or bookmarks toolbar in a new tab.</td>
480 </tr><tr>
481 <td><a href="#HelpWindow.preferencesChanged">preferencesChanged</a></td>
482 <td>Public slot to handle a change of preferences.</td>
483 </tr><tr>
484 <td><a href="#HelpWindow.previewer">previewer</a></td>
485 <td>Public method to get a reference to the previewer tab.</td>
486 </tr><tr>
487 <td><a href="#HelpWindow.reloadUserStyleSheet">reloadUserStyleSheet</a></td>
488 <td>Public method to reload the user style sheet.</td>
489 </tr><tr>
490 <td><a href="#HelpWindow.requestVirusTotalScan">requestVirusTotalScan</a></td>
491 <td>Public method to submit a request to scan an URL by VirusTotal.</td>
492 </tr><tr>
493 <td><a href="#HelpWindow.search">search</a></td>
494 <td>Public method to search for a word.</td>
495 </tr><tr>
496 <td><a href="#HelpWindow.searchEnginesAction">searchEnginesAction</a></td>
497 <td>Public method to get a reference to the search engines configuration action.</td>
498 </tr><tr>
499 <td><a href="#HelpWindow.setBackwardAvailable">setBackwardAvailable</a></td>
500 <td>Public slot called when backward references are available.</td>
501 </tr><tr>
502 <td><a href="#HelpWindow.setEventKeyboardModifiers">setEventKeyboardModifiers</a></td>
503 <td>Public method to record keyboard modifiers.</td>
504 </tr><tr>
505 <td><a href="#HelpWindow.setEventMouseButtons">setEventMouseButtons</a></td>
506 <td>Public method to record mouse buttons.</td>
507 </tr><tr>
508 <td><a href="#HelpWindow.setForwardAvailable">setForwardAvailable</a></td>
509 <td>Public slot called when forward references are available.</td>
510 </tr><tr>
511 <td><a href="#HelpWindow.setLoadingActions">setLoadingActions</a></td>
512 <td>Public slot to set the loading dependent actions.</td>
513 </tr><tr>
514 <td><a href="#HelpWindow.setPrivateMode">setPrivateMode</a></td>
515 <td>Public method to set the privacy mode.</td>
516 </tr><tr>
517 <td><a href="#HelpWindow.shutdown">shutdown</a></td>
518 <td>Public method to shut down the web browser.</td>
519 </tr>
520 </table>
521 <h3>Static Methods</h3>
522 <table>
523 <tr>
524 <td><a href="#HelpWindow.__getWebIcon">__getWebIcon</a></td>
525 <td>Private static method to fetch the icon for a URL.</td>
526 </tr>
527 </table>
528 <a NAME="HelpWindow.adBlockManager" ID="HelpWindow.adBlockManager"></a>
529 <h4>HelpWindow.adBlockManager (class method)</h4>
530 <b>adBlockManager</b>(<i></i>)
531 <p>
532 Class method to get a reference to the AdBlock manager.
533 </p><dl>
534 <dt>Returns:</dt>
535 <dd>
536 reference to the AdBlock manager (AdBlockManager)
537 </dd>
538 </dl><a NAME="HelpWindow.bookmarksManager" ID="HelpWindow.bookmarksManager"></a>
539 <h4>HelpWindow.bookmarksManager (class method)</h4>
540 <b>bookmarksManager</b>(<i></i>)
541 <p>
542 Class method to get a reference to the bookmarks manager.
543 </p><dl>
544 <dt>Returns:</dt>
545 <dd>
546 reference to the bookmarks manager (BookmarksManager)
547 </dd>
548 </dl><a NAME="HelpWindow.cookieJar" ID="HelpWindow.cookieJar"></a>
549 <h4>HelpWindow.cookieJar (class method)</h4>
550 <b>cookieJar</b>(<i></i>)
551 <p>
552 Class method to get a reference to the cookie jar.
553 </p><dl>
554 <dt>Returns:</dt>
555 <dd>
556 reference to the cookie jar (CookieJar)
557 </dd>
558 </dl><a NAME="HelpWindow.downloadManager" ID="HelpWindow.downloadManager"></a>
559 <h4>HelpWindow.downloadManager (class method)</h4>
560 <b>downloadManager</b>(<i></i>)
561 <p>
562 Class method to get a reference to the download manager.
563 </p><dl>
564 <dt>Returns:</dt>
565 <dd>
566 reference to the password manager (DownloadManager)
567 </dd>
568 </dl><a NAME="HelpWindow.feedsManager" ID="HelpWindow.feedsManager"></a>
569 <h4>HelpWindow.feedsManager (class method)</h4>
570 <b>feedsManager</b>(<i></i>)
571 <p>
572 Class method to get a reference to the RSS feeds manager.
573 </p><dl>
574 <dt>Returns:</dt>
575 <dd>
576 reference to the RSS feeds manager (FeedsManager)
577 </dd>
578 </dl><a NAME="HelpWindow.greaseMonkeyManager" ID="HelpWindow.greaseMonkeyManager"></a>
579 <h4>HelpWindow.greaseMonkeyManager (class method)</h4>
580 <b>greaseMonkeyManager</b>(<i></i>)
581 <p>
582 Class method to get a reference to the GreaseMonkey manager.
583 </p><dl>
584 <dt>Returns:</dt>
585 <dd>
586 reference to the GreaseMonkey manager (GreaseMonkeyManager)
587 </dd>
588 </dl><a NAME="HelpWindow.helpEngine" ID="HelpWindow.helpEngine"></a>
589 <h4>HelpWindow.helpEngine (class method)</h4>
590 <b>helpEngine</b>(<i></i>)
591 <p>
592 Class method to get a reference to the help engine.
593 </p><dl>
594 <dt>Returns:</dt>
595 <dd>
596 reference to the help engine (QHelpEngine)
597 </dd>
598 </dl><a NAME="HelpWindow.historyManager" ID="HelpWindow.historyManager"></a>
599 <h4>HelpWindow.historyManager (class method)</h4>
600 <b>historyManager</b>(<i></i>)
601 <p>
602 Class method to get a reference to the history manager.
603 </p><dl>
604 <dt>Returns:</dt>
605 <dd>
606 reference to the history manager (HistoryManager)
607 </dd>
608 </dl><a NAME="HelpWindow.icon" ID="HelpWindow.icon"></a>
609 <h4>HelpWindow.icon (class method)</h4>
610 <b>icon</b>(<i>url</i>)
611 <p>
612 Class method to get the icon for an URL.
613 </p><dl>
614 <dt><i>url</i></dt>
615 <dd>
616 URL to get icon for (QUrl)
617 </dd>
618 </dl><dl>
619 <dt>Returns:</dt>
620 <dd>
621 icon for the URL (QIcon)
622 </dd>
623 </dl><a NAME="HelpWindow.mainWindow" ID="HelpWindow.mainWindow"></a>
624 <h4>HelpWindow.mainWindow (class method)</h4>
625 <b>mainWindow</b>(<i></i>)
626 <p>
627 Class method to get a reference to the main window.
628 </p><dl>
629 <dt>Returns:</dt>
630 <dd>
631 reference to the main window (HelpWindow)
632 </dd>
633 </dl><a NAME="HelpWindow.mainWindows" ID="HelpWindow.mainWindows"></a>
634 <h4>HelpWindow.mainWindows (class method)</h4>
635 <b>mainWindows</b>(<i></i>)
636 <p>
637 Class method to get references to all main windows.
638 </p><dl>
639 <dt>Returns:</dt>
640 <dd>
641 references to all main window (list of HelpWindow)
642 </dd>
643 </dl><a NAME="HelpWindow.networkAccessManager" ID="HelpWindow.networkAccessManager"></a>
644 <h4>HelpWindow.networkAccessManager (class method)</h4>
645 <b>networkAccessManager</b>(<i></i>)
646 <p>
647 Class method to get a reference to the network access manager.
648 </p><dl>
649 <dt>Returns:</dt>
650 <dd>
651 reference to the network access manager (NetworkAccessManager)
652 </dd>
653 </dl><a NAME="HelpWindow.notificationsEnabled" ID="HelpWindow.notificationsEnabled"></a>
654 <h4>HelpWindow.notificationsEnabled (class method)</h4>
655 <b>notificationsEnabled</b>(<i></i>)
656 <p>
657 Class method to check, if notifications are enabled.
658 </p><dl>
659 <dt>Returns:</dt>
660 <dd>
661 flag indicating, if notifications are enabled (boolean)
662 </dd>
663 </dl><a NAME="HelpWindow.passwordManager" ID="HelpWindow.passwordManager"></a>
664 <h4>HelpWindow.passwordManager (class method)</h4>
665 <b>passwordManager</b>(<i></i>)
666 <p>
667 Class method to get a reference to the password manager.
668 </p><dl>
669 <dt>Returns:</dt>
670 <dd>
671 reference to the password manager (PasswordManager)
672 </dd>
673 </dl><a NAME="HelpWindow.personalInformationManager" ID="HelpWindow.personalInformationManager"></a>
674 <h4>HelpWindow.personalInformationManager (class method)</h4>
675 <b>personalInformationManager</b>(<i></i>)
676 <p>
677 Class method to get a reference to the personal information manager.
678 </p><dl>
679 <dt>Returns:</dt>
680 <dd>
681 reference to the personal information manager
682 (PersonalInformationManager)
683 </dd>
684 </dl><a NAME="HelpWindow.setUseQtHelp" ID="HelpWindow.setUseQtHelp"></a>
685 <h4>HelpWindow.setUseQtHelp (class method)</h4>
686 <b>setUseQtHelp</b>(<i>use</i>)
687 <p>
688 Class method to set the QtHelp usage.
689 </p><dl>
690 <dt><i>use</i></dt>
691 <dd>
692 flag indicating usage (boolean)
693 </dd>
694 </dl><a NAME="HelpWindow.showNotification" ID="HelpWindow.showNotification"></a>
695 <h4>HelpWindow.showNotification (class method)</h4>
696 <b>showNotification</b>(<i>icon, heading, text</i>)
697 <p>
698 Class method to show a desktop notification.
699 </p><dl>
700 <dt><i>icon</i></dt>
701 <dd>
702 icon to be shown in the notification (QPixmap)
703 </dd><dt><i>heading</i></dt>
704 <dd>
705 heading of the notification (string)
706 </dd><dt><i>text</i></dt>
707 <dd>
708 text of the notification (string)
709 </dd>
710 </dl><a NAME="HelpWindow.speedDial" ID="HelpWindow.speedDial"></a>
711 <h4>HelpWindow.speedDial (class method)</h4>
712 <b>speedDial</b>(<i></i>)
713 <p>
714 Class methdo to get a reference to the speed dial.
715 </p><dl>
716 <dt>Returns:</dt>
717 <dd>
718 reference to the speed dial (SpeedDial)
719 </dd>
720 </dl><a NAME="HelpWindow.syncManager" ID="HelpWindow.syncManager"></a>
721 <h4>HelpWindow.syncManager (class method)</h4>
722 <b>syncManager</b>(<i></i>)
723 <p>
724 Class method to get a reference to the data synchronization manager.
725 </p><dl>
726 <dt>Returns:</dt>
727 <dd>
728 reference to the data synchronization manager (SyncManager)
729 </dd>
730 </dl><a NAME="HelpWindow.userAgentsManager" ID="HelpWindow.userAgentsManager"></a>
731 <h4>HelpWindow.userAgentsManager (class method)</h4>
732 <b>userAgentsManager</b>(<i></i>)
733 <p>
734 Class method to get a reference to the user agents manager.
735 </p><dl>
736 <dt>Returns:</dt>
737 <dd>
738 reference to the user agents manager (UserAgentManager)
739 </dd>
740 </dl><a NAME="HelpWindow.__init__" ID="HelpWindow.__init__"></a>
741 <h4>HelpWindow (Constructor)</h4>
742 <b>HelpWindow</b>(<i>home, path, parent, name, fromEric=False, initShortcutsOnly=False, searchWord=None</i>)
743 <p>
744 Constructor
745 </p><dl>
746 <dt><i>home</i></dt>
747 <dd>
748 the URL to be shown (string)
749 </dd><dt><i>path</i></dt>
750 <dd>
751 the path of the working dir (usually '.') (string)
752 </dd><dt><i>parent</i></dt>
753 <dd>
754 parent widget of this window (QWidget)
755 </dd><dt><i>name</i></dt>
756 <dd>
757 name of this window (string)
758 </dd><dt><i>fromEric</i></dt>
759 <dd>
760 flag indicating whether it was called from within
761 eric6 (boolean)
762 </dd><dt><i>initShortcutsOnly=</i></dt>
763 <dd>
764 flag indicating to just initialize the
765 keyboard shortcuts (boolean)
766 </dd><dt><i>searchWord=</i></dt>
767 <dd>
768 word to search for (string)
769 </dd>
770 </dl><a NAME="HelpWindow.__about" ID="HelpWindow.__about"></a>
771 <h4>HelpWindow.__about</h4>
772 <b>__about</b>(<i></i>)
773 <p>
774 Private slot to show the about information.
775 </p><a NAME="HelpWindow.__aboutQt" ID="HelpWindow.__aboutQt"></a>
776 <h4>HelpWindow.__aboutQt</h4>
777 <b>__aboutQt</b>(<i></i>)
778 <p>
779 Private slot to show info about Qt.
780 </p><a NAME="HelpWindow.__aboutToShowSettingsMenu" ID="HelpWindow.__aboutToShowSettingsMenu"></a>
781 <h4>HelpWindow.__aboutToShowSettingsMenu</h4>
782 <b>__aboutToShowSettingsMenu</b>(<i></i>)
783 <p>
784 Private slot to show the Settings menu.
785 </p><a NAME="HelpWindow.__aboutToShowTextEncodingMenu" ID="HelpWindow.__aboutToShowTextEncodingMenu"></a>
786 <h4>HelpWindow.__aboutToShowTextEncodingMenu</h4>
787 <b>__aboutToShowTextEncodingMenu</b>(<i></i>)
788 <p>
789 Private slot to populate the text encoding menu.
790 </p><a NAME="HelpWindow.__activateCurrentBrowser" ID="HelpWindow.__activateCurrentBrowser"></a>
791 <h4>HelpWindow.__activateCurrentBrowser</h4>
792 <b>__activateCurrentBrowser</b>(<i></i>)
793 <p>
794 Private slot to activate the current browser.
795 </p><a NAME="HelpWindow.__activateDock" ID="HelpWindow.__activateDock"></a>
796 <h4>HelpWindow.__activateDock</h4>
797 <b>__activateDock</b>(<i>widget</i>)
798 <p>
799 Private method to activate the dock widget of the given widget.
800 </p><dl>
801 <dt><i>widget</i></dt>
802 <dd>
803 reference to the widget to be activated (QWidget)
804 </dd>
805 </dl><a NAME="HelpWindow.__addBookmark" ID="HelpWindow.__addBookmark"></a>
806 <h4>HelpWindow.__addBookmark</h4>
807 <b>__addBookmark</b>(<i></i>)
808 <p>
809 Private slot called to add the displayed file to the bookmarks.
810 </p><a NAME="HelpWindow.__addBookmarkFolder" ID="HelpWindow.__addBookmarkFolder"></a>
811 <h4>HelpWindow.__addBookmarkFolder</h4>
812 <b>__addBookmarkFolder</b>(<i></i>)
813 <p>
814 Private slot to add a new bookmarks folder.
815 </p><a NAME="HelpWindow.__backward" ID="HelpWindow.__backward"></a>
816 <h4>HelpWindow.__backward</h4>
817 <b>__backward</b>(<i></i>)
818 <p>
819 Private slot called to handle the backward action.
820 </p><a NAME="HelpWindow.__browserClosed" ID="HelpWindow.__browserClosed"></a>
821 <h4>HelpWindow.__browserClosed</h4>
822 <b>__browserClosed</b>(<i>browser</i>)
823 <p>
824 Private slot handling the closure of a browser tab.
825 </p><dl>
826 <dt><i>browser</i></dt>
827 <dd>
828 reference to the browser window (QWidget)
829 </dd>
830 </dl><a NAME="HelpWindow.__clearIconsDatabase" ID="HelpWindow.__clearIconsDatabase"></a>
831 <h4>HelpWindow.__clearIconsDatabase</h4>
832 <b>__clearIconsDatabase</b>(<i></i>)
833 <p>
834 Private slot to clear the icons databse.
835 </p><a NAME="HelpWindow.__clearPrivateData" ID="HelpWindow.__clearPrivateData"></a>
836 <h4>HelpWindow.__clearPrivateData</h4>
837 <b>__clearPrivateData</b>(<i></i>)
838 <p>
839 Private slot to clear the private data.
840 </p><a NAME="HelpWindow.__closeAllWindows" ID="HelpWindow.__closeAllWindows"></a>
841 <h4>HelpWindow.__closeAllWindows</h4>
842 <b>__closeAllWindows</b>(<i></i>)
843 <p>
844 Private slot to close all windows.
845 </p><a NAME="HelpWindow.__closeNetworkMonitor" ID="HelpWindow.__closeNetworkMonitor"></a>
846 <h4>HelpWindow.__closeNetworkMonitor</h4>
847 <b>__closeNetworkMonitor</b>(<i></i>)
848 <p>
849 Private slot to close the network monitor dialog.
850 </p><a NAME="HelpWindow.__copy" ID="HelpWindow.__copy"></a>
851 <h4>HelpWindow.__copy</h4>
852 <b>__copy</b>(<i></i>)
853 <p>
854 Private slot called to handle the copy action.
855 </p><a NAME="HelpWindow.__currentChanged" ID="HelpWindow.__currentChanged"></a>
856 <h4>HelpWindow.__currentChanged</h4>
857 <b>__currentChanged</b>(<i>index</i>)
858 <p>
859 Private slot to handle the currentChanged signal.
860 </p><dl>
861 <dt><i>index</i></dt>
862 <dd>
863 index of the current tab (integer)
864 </dd>
865 </dl><a NAME="HelpWindow.__del__" ID="HelpWindow.__del__"></a>
866 <h4>HelpWindow.__del__</h4>
867 <b>__del__</b>(<i></i>)
868 <p>
869 Special method called during object destruction.
870 </p><p>
871 Note: This empty variant seems to get rid of the Qt message
872 'Warning: QBasicTimer::start: QBasicTimer can only be used with
873 threads started with QThread'
874 </p><a NAME="HelpWindow.__docsInstalled" ID="HelpWindow.__docsInstalled"></a>
875 <h4>HelpWindow.__docsInstalled</h4>
876 <b>__docsInstalled</b>(<i>installed</i>)
877 <p>
878 Private slot handling the end of documentation installation.
879 </p><dl>
880 <dt><i>installed</i></dt>
881 <dd>
882 flag indicating that documents were installed
883 (boolean)
884 </dd>
885 </dl><a NAME="HelpWindow.__feedsManagerClosed" ID="HelpWindow.__feedsManagerClosed"></a>
886 <h4>HelpWindow.__feedsManagerClosed</h4>
887 <b>__feedsManagerClosed</b>(<i></i>)
888 <p>
889 Private slot to handle closing the feeds manager dialog.
890 </p><a NAME="HelpWindow.__filterQtHelpDocumentation" ID="HelpWindow.__filterQtHelpDocumentation"></a>
891 <h4>HelpWindow.__filterQtHelpDocumentation</h4>
892 <b>__filterQtHelpDocumentation</b>(<i>customFilter</i>)
893 <p>
894 Private slot to filter the QtHelp documentation.
895 </p><dl>
896 <dt><i>customFilter</i></dt>
897 <dd>
898 name of filter to be applied (string)
899 </dd>
900 </dl><a NAME="HelpWindow.__find" ID="HelpWindow.__find"></a>
901 <h4>HelpWindow.__find</h4>
902 <b>__find</b>(<i></i>)
903 <p>
904 Private slot to handle the find action.
905 </p><p>
906 It opens the search dialog in order to perform the various
907 search actions and to collect the various search info.
908 </p><a NAME="HelpWindow.__forward" ID="HelpWindow.__forward"></a>
909 <h4>HelpWindow.__forward</h4>
910 <b>__forward</b>(<i></i>)
911 <p>
912 Private slot called to handle the forward action.
913 </p><a NAME="HelpWindow.__hideIndexWindow" ID="HelpWindow.__hideIndexWindow"></a>
914 <h4>HelpWindow.__hideIndexWindow</h4>
915 <b>__hideIndexWindow</b>(<i></i>)
916 <p>
917 Private method to hide the index window.
918 </p><a NAME="HelpWindow.__hideSearchWindow" ID="HelpWindow.__hideSearchWindow"></a>
919 <h4>HelpWindow.__hideSearchWindow</h4>
920 <b>__hideSearchWindow</b>(<i></i>)
921 <p>
922 Private method to hide the search window.
923 </p><a NAME="HelpWindow.__hideTocWindow" ID="HelpWindow.__hideTocWindow"></a>
924 <h4>HelpWindow.__hideTocWindow</h4>
925 <b>__hideTocWindow</b>(<i></i>)
926 <p>
927 Private method to hide the table of contents window.
928 </p><a NAME="HelpWindow.__home" ID="HelpWindow.__home"></a>
929 <h4>HelpWindow.__home</h4>
930 <b>__home</b>(<i></i>)
931 <p>
932 Private slot called to handle the home action.
933 </p><a NAME="HelpWindow.__indexingFinished" ID="HelpWindow.__indexingFinished"></a>
934 <h4>HelpWindow.__indexingFinished</h4>
935 <b>__indexingFinished</b>(<i></i>)
936 <p>
937 Private slot to handle the start of the indexing process.
938 </p><a NAME="HelpWindow.__indexingStarted" ID="HelpWindow.__indexingStarted"></a>
939 <h4>HelpWindow.__indexingStarted</h4>
940 <b>__indexingStarted</b>(<i></i>)
941 <p>
942 Private slot to handle the start of the indexing process.
943 </p><a NAME="HelpWindow.__initActions" ID="HelpWindow.__initActions"></a>
944 <h4>HelpWindow.__initActions</h4>
945 <b>__initActions</b>(<i></i>)
946 <p>
947 Private method to define the user interface actions.
948 </p><a NAME="HelpWindow.__initHelpDb" ID="HelpWindow.__initHelpDb"></a>
949 <h4>HelpWindow.__initHelpDb</h4>
950 <b>__initHelpDb</b>(<i></i>)
951 <p>
952 Private slot to initialize the documentation database.
953 </p><a NAME="HelpWindow.__initMenus" ID="HelpWindow.__initMenus"></a>
954 <h4>HelpWindow.__initMenus</h4>
955 <b>__initMenus</b>(<i></i>)
956 <p>
957 Private method to create the menus.
958 </p><a NAME="HelpWindow.__initToolbars" ID="HelpWindow.__initToolbars"></a>
959 <h4>HelpWindow.__initToolbars</h4>
960 <b>__initToolbars</b>(<i></i>)
961 <p>
962 Private method to create the toolbars.
963 </p><a NAME="HelpWindow.__initWebSettings" ID="HelpWindow.__initWebSettings"></a>
964 <h4>HelpWindow.__initWebSettings</h4>
965 <b>__initWebSettings</b>(<i></i>)
966 <p>
967 Private method to set the global web settings.
968 </p><a NAME="HelpWindow.__isFullScreen" ID="HelpWindow.__isFullScreen"></a>
969 <h4>HelpWindow.__isFullScreen</h4>
970 <b>__isFullScreen</b>(<i></i>)
971 <p>
972 Private method to determine, if the window is in full screen mode.
973 </p><dl>
974 <dt>Returns:</dt>
975 <dd>
976 flag indicating full screen mode (boolean)
977 </dd>
978 </dl><a NAME="HelpWindow.__linkActivated" ID="HelpWindow.__linkActivated"></a>
979 <h4>HelpWindow.__linkActivated</h4>
980 <b>__linkActivated</b>(<i>url</i>)
981 <p>
982 Private slot to handle the selection of a link in the TOC window.
983 </p><dl>
984 <dt><i>url</i></dt>
985 <dd>
986 URL to be shown (QUrl)
987 </dd>
988 </dl><a NAME="HelpWindow.__linksActivated" ID="HelpWindow.__linksActivated"></a>
989 <h4>HelpWindow.__linksActivated</h4>
990 <b>__linksActivated</b>(<i>links, keyword</i>)
991 <p>
992 Private slot to select a topic to be shown.
993 </p><dl>
994 <dt><i>links</i></dt>
995 <dd>
996 dictionary with help topic as key (string) and
997 URL as value (QUrl)
998 </dd><dt><i>keyword</i></dt>
999 <dd>
1000 keyword for the link set (string)
1001 </dd>
1002 </dl><a NAME="HelpWindow.__lookForNewDocumentation" ID="HelpWindow.__lookForNewDocumentation"></a>
1003 <h4>HelpWindow.__lookForNewDocumentation</h4>
1004 <b>__lookForNewDocumentation</b>(<i></i>)
1005 <p>
1006 Private slot to look for new documentation to be loaded into the
1007 help database.
1008 </p><a NAME="HelpWindow.__manageQtHelpDocumentation" ID="HelpWindow.__manageQtHelpDocumentation"></a>
1009 <h4>HelpWindow.__manageQtHelpDocumentation</h4>
1010 <b>__manageQtHelpDocumentation</b>(<i></i>)
1011 <p>
1012 Private slot to manage the QtHelp documentation database.
1013 </p><a NAME="HelpWindow.__manageQtHelpFilters" ID="HelpWindow.__manageQtHelpFilters"></a>
1014 <h4>HelpWindow.__manageQtHelpFilters</h4>
1015 <b>__manageQtHelpFilters</b>(<i></i>)
1016 <p>
1017 Private slot to manage the QtHelp filters.
1018 </p><a NAME="HelpWindow.__navigationMenuActionTriggered" ID="HelpWindow.__navigationMenuActionTriggered"></a>
1019 <h4>HelpWindow.__navigationMenuActionTriggered</h4>
1020 <b>__navigationMenuActionTriggered</b>(<i>act</i>)
1021 <p>
1022 Private slot to go to the selected page.
1023 </p><dl>
1024 <dt><i>act</i></dt>
1025 <dd>
1026 reference to the action selected in the navigation menu
1027 (QAction)
1028 </dd>
1029 </dl><a NAME="HelpWindow.__nextTab" ID="HelpWindow.__nextTab"></a>
1030 <h4>HelpWindow.__nextTab</h4>
1031 <b>__nextTab</b>(<i></i>)
1032 <p>
1033 Private slot used to show the next tab.
1034 </p><a NAME="HelpWindow.__openFile" ID="HelpWindow.__openFile"></a>
1035 <h4>HelpWindow.__openFile</h4>
1036 <b>__openFile</b>(<i></i>)
1037 <p>
1038 Private slot called to open a file.
1039 </p><a NAME="HelpWindow.__openFileNewTab" ID="HelpWindow.__openFileNewTab"></a>
1040 <h4>HelpWindow.__openFileNewTab</h4>
1041 <b>__openFileNewTab</b>(<i></i>)
1042 <p>
1043 Private slot called to open a file in a new tab.
1044 </p><a NAME="HelpWindow.__prevTab" ID="HelpWindow.__prevTab"></a>
1045 <h4>HelpWindow.__prevTab</h4>
1046 <b>__prevTab</b>(<i></i>)
1047 <p>
1048 Private slot used to show the previous tab.
1049 </p><a NAME="HelpWindow.__privateBrowsing" ID="HelpWindow.__privateBrowsing"></a>
1050 <h4>HelpWindow.__privateBrowsing</h4>
1051 <b>__privateBrowsing</b>(<i></i>)
1052 <p>
1053 Private slot to switch private browsing.
1054 </p><a NAME="HelpWindow.__reload" ID="HelpWindow.__reload"></a>
1055 <h4>HelpWindow.__reload</h4>
1056 <b>__reload</b>(<i></i>)
1057 <p>
1058 Private slot called to handle the reload action.
1059 </p><a NAME="HelpWindow.__removeOldDocumentation" ID="HelpWindow.__removeOldDocumentation"></a>
1060 <h4>HelpWindow.__removeOldDocumentation</h4>
1061 <b>__removeOldDocumentation</b>(<i></i>)
1062 <p>
1063 Private slot to remove non-existing documentation from the help engine.
1064 </p><a NAME="HelpWindow.__savePageAs" ID="HelpWindow.__savePageAs"></a>
1065 <h4>HelpWindow.__savePageAs</h4>
1066 <b>__savePageAs</b>(<i></i>)
1067 <p>
1068 Private slot to save the current page.
1069 </p><a NAME="HelpWindow.__savePageScreen" ID="HelpWindow.__savePageScreen"></a>
1070 <h4>HelpWindow.__savePageScreen</h4>
1071 <b>__savePageScreen</b>(<i>visibleOnly=False</i>)
1072 <p>
1073 Private slot to save the current page as a screen shot.
1074 </p><dl>
1075 <dt><i>visibleOnly</i></dt>
1076 <dd>
1077 flag indicating to just save the visible part
1078 of the page (boolean)
1079 </dd>
1080 </dl><a NAME="HelpWindow.__saveVisiblePageScreen" ID="HelpWindow.__saveVisiblePageScreen"></a>
1081 <h4>HelpWindow.__saveVisiblePageScreen</h4>
1082 <b>__saveVisiblePageScreen</b>(<i></i>)
1083 <p>
1084 Private slot to save the visible part of the current page as a screen
1085 shot.
1086 </p><a NAME="HelpWindow.__searchForWord" ID="HelpWindow.__searchForWord"></a>
1087 <h4>HelpWindow.__searchForWord</h4>
1088 <b>__searchForWord</b>(<i></i>)
1089 <p>
1090 Private slot to search for a word.
1091 </p><a NAME="HelpWindow.__setIconDatabasePath" ID="HelpWindow.__setIconDatabasePath"></a>
1092 <h4>HelpWindow.__setIconDatabasePath</h4>
1093 <b>__setIconDatabasePath</b>(<i>enable=True</i>)
1094 <p>
1095 Private method to set the favicons path.
1096 </p><dl>
1097 <dt><i>enable</i></dt>
1098 <dd>
1099 flag indicating to enabled icon storage (boolean)
1100 </dd>
1101 </dl><a NAME="HelpWindow.__setTextEncoding" ID="HelpWindow.__setTextEncoding"></a>
1102 <h4>HelpWindow.__setTextEncoding</h4>
1103 <b>__setTextEncoding</b>(<i>act</i>)
1104 <p>
1105 Private slot to set the selected text encoding as the default for
1106 this session.
1107 </p><dl>
1108 <dt><i>act</i></dt>
1109 <dd>
1110 reference to the selected action (QAction)
1111 </dd>
1112 </dl><a NAME="HelpWindow.__setupFilterCombo" ID="HelpWindow.__setupFilterCombo"></a>
1113 <h4>HelpWindow.__setupFilterCombo</h4>
1114 <b>__setupFilterCombo</b>(<i></i>)
1115 <p>
1116 Private slot to setup the filter combo box.
1117 </p><a NAME="HelpWindow.__showAcceptedLanguages" ID="HelpWindow.__showAcceptedLanguages"></a>
1118 <h4>HelpWindow.__showAcceptedLanguages</h4>
1119 <b>__showAcceptedLanguages</b>(<i></i>)
1120 <p>
1121 Private slot to configure the accepted languages for web pages.
1122 </p><a NAME="HelpWindow.__showAdBlockDialog" ID="HelpWindow.__showAdBlockDialog"></a>
1123 <h4>HelpWindow.__showAdBlockDialog</h4>
1124 <b>__showAdBlockDialog</b>(<i></i>)
1125 <p>
1126 Private slot to show the AdBlock configuration dialog.
1127 </p><a NAME="HelpWindow.__showBackMenu" ID="HelpWindow.__showBackMenu"></a>
1128 <h4>HelpWindow.__showBackMenu</h4>
1129 <b>__showBackMenu</b>(<i></i>)
1130 <p>
1131 Private slot showing the backwards navigation menu.
1132 </p><a NAME="HelpWindow.__showBookmarksDialog" ID="HelpWindow.__showBookmarksDialog"></a>
1133 <h4>HelpWindow.__showBookmarksDialog</h4>
1134 <b>__showBookmarksDialog</b>(<i></i>)
1135 <p>
1136 Private slot to show the bookmarks dialog.
1137 </p><a NAME="HelpWindow.__showCertificatesDialog" ID="HelpWindow.__showCertificatesDialog"></a>
1138 <h4>HelpWindow.__showCertificatesDialog</h4>
1139 <b>__showCertificatesDialog</b>(<i></i>)
1140 <p>
1141 Private slot to show the certificates management dialog.
1142 </p><a NAME="HelpWindow.__showClickToFlashDialog" ID="HelpWindow.__showClickToFlashDialog"></a>
1143 <h4>HelpWindow.__showClickToFlashDialog</h4>
1144 <b>__showClickToFlashDialog</b>(<i></i>)
1145 <p>
1146 Private slot to open the ClickToFlash whitelist configuration dialog.
1147 </p><a NAME="HelpWindow.__showCookiesConfiguration" ID="HelpWindow.__showCookiesConfiguration"></a>
1148 <h4>HelpWindow.__showCookiesConfiguration</h4>
1149 <b>__showCookiesConfiguration</b>(<i></i>)
1150 <p>
1151 Private slot to configure the cookies handling.
1152 </p><a NAME="HelpWindow.__showDownloadsWindow" ID="HelpWindow.__showDownloadsWindow"></a>
1153 <h4>HelpWindow.__showDownloadsWindow</h4>
1154 <b>__showDownloadsWindow</b>(<i></i>)
1155 <p>
1156 Private slot to show the downloads dialog.
1157 </p><a NAME="HelpWindow.__showEnginesConfigurationDialog" ID="HelpWindow.__showEnginesConfigurationDialog"></a>
1158 <h4>HelpWindow.__showEnginesConfigurationDialog</h4>
1159 <b>__showEnginesConfigurationDialog</b>(<i></i>)
1160 <p>
1161 Private slot to show the search engines configuration dialog.
1162 </p><a NAME="HelpWindow.__showFeedsManager" ID="HelpWindow.__showFeedsManager"></a>
1163 <h4>HelpWindow.__showFeedsManager</h4>
1164 <b>__showFeedsManager</b>(<i></i>)
1165 <p>
1166 Private slot to show the feeds manager dialog.
1167 </p><a NAME="HelpWindow.__showForwardMenu" ID="HelpWindow.__showForwardMenu"></a>
1168 <h4>HelpWindow.__showForwardMenu</h4>
1169 <b>__showForwardMenu</b>(<i></i>)
1170 <p>
1171 Private slot showing the forwards navigation menu.
1172 </p><a NAME="HelpWindow.__showGreaseMonkeyConfigDialog" ID="HelpWindow.__showGreaseMonkeyConfigDialog"></a>
1173 <h4>HelpWindow.__showGreaseMonkeyConfigDialog</h4>
1174 <b>__showGreaseMonkeyConfigDialog</b>(<i></i>)
1175 <p>
1176 Private slot to show the GreaseMonkey scripts configuration dialog.
1177 </p><a NAME="HelpWindow.__showIndexWindow" ID="HelpWindow.__showIndexWindow"></a>
1178 <h4>HelpWindow.__showIndexWindow</h4>
1179 <b>__showIndexWindow</b>(<i></i>)
1180 <p>
1181 Private method to show the index window.
1182 </p><a NAME="HelpWindow.__showInstallationError" ID="HelpWindow.__showInstallationError"></a>
1183 <h4>HelpWindow.__showInstallationError</h4>
1184 <b>__showInstallationError</b>(<i>message</i>)
1185 <p>
1186 Private slot to show installation errors.
1187 </p><dl>
1188 <dt><i>message</i></dt>
1189 <dd>
1190 message to be shown (string)
1191 </dd>
1192 </dl><a NAME="HelpWindow.__showNetworkMonitor" ID="HelpWindow.__showNetworkMonitor"></a>
1193 <h4>HelpWindow.__showNetworkMonitor</h4>
1194 <b>__showNetworkMonitor</b>(<i></i>)
1195 <p>
1196 Private slot to show the network monitor dialog.
1197 </p><a NAME="HelpWindow.__showOfflineStorageConfiguration" ID="HelpWindow.__showOfflineStorageConfiguration"></a>
1198 <h4>HelpWindow.__showOfflineStorageConfiguration</h4>
1199 <b>__showOfflineStorageConfiguration</b>(<i></i>)
1200 <p>
1201 Private slot to configure the offline storage.
1202 </p><a NAME="HelpWindow.__showPageSource" ID="HelpWindow.__showPageSource"></a>
1203 <h4>HelpWindow.__showPageSource</h4>
1204 <b>__showPageSource</b>(<i></i>)
1205 <p>
1206 Private slot to show the source of the current page in an editor.
1207 </p><a NAME="HelpWindow.__showPasswordsDialog" ID="HelpWindow.__showPasswordsDialog"></a>
1208 <h4>HelpWindow.__showPasswordsDialog</h4>
1209 <b>__showPasswordsDialog</b>(<i></i>)
1210 <p>
1211 Private slot to show the passwords management dialog.
1212 </p><a NAME="HelpWindow.__showPersonalInformationDialog" ID="HelpWindow.__showPersonalInformationDialog"></a>
1213 <h4>HelpWindow.__showPersonalInformationDialog</h4>
1214 <b>__showPersonalInformationDialog</b>(<i></i>)
1215 <p>
1216 Private slot to show the Personal Information configuration dialog.
1217 </p><a NAME="HelpWindow.__showPreferences" ID="HelpWindow.__showPreferences"></a>
1218 <h4>HelpWindow.__showPreferences</h4>
1219 <b>__showPreferences</b>(<i></i>)
1220 <p>
1221 Private slot to set the preferences.
1222 </p><a NAME="HelpWindow.__showSearchWindow" ID="HelpWindow.__showSearchWindow"></a>
1223 <h4>HelpWindow.__showSearchWindow</h4>
1224 <b>__showSearchWindow</b>(<i></i>)
1225 <p>
1226 Private method to show the search window.
1227 </p><a NAME="HelpWindow.__showSiteinfoDialog" ID="HelpWindow.__showSiteinfoDialog"></a>
1228 <h4>HelpWindow.__showSiteinfoDialog</h4>
1229 <b>__showSiteinfoDialog</b>(<i></i>)
1230 <p>
1231 Private slot to show the site info dialog.
1232 </p><a NAME="HelpWindow.__showSyncDialog" ID="HelpWindow.__showSyncDialog"></a>
1233 <h4>HelpWindow.__showSyncDialog</h4>
1234 <b>__showSyncDialog</b>(<i></i>)
1235 <p>
1236 Private slot to show the synchronization dialog.
1237 </p><a NAME="HelpWindow.__showTocWindow" ID="HelpWindow.__showTocWindow"></a>
1238 <h4>HelpWindow.__showTocWindow</h4>
1239 <b>__showTocWindow</b>(<i></i>)
1240 <p>
1241 Private method to show the table of contents window.
1242 </p><a NAME="HelpWindow.__showUserAgentsDialog" ID="HelpWindow.__showUserAgentsDialog"></a>
1243 <h4>HelpWindow.__showUserAgentsDialog</h4>
1244 <b>__showUserAgentsDialog</b>(<i></i>)
1245 <p>
1246 Private slot to show the user agents management dialog.
1247 </p><a NAME="HelpWindow.__stopLoading" ID="HelpWindow.__stopLoading"></a>
1248 <h4>HelpWindow.__stopLoading</h4>
1249 <b>__stopLoading</b>(<i></i>)
1250 <p>
1251 Private slot called to handle loading of the current page.
1252 </p><a NAME="HelpWindow.__switchTab" ID="HelpWindow.__switchTab"></a>
1253 <h4>HelpWindow.__switchTab</h4>
1254 <b>__switchTab</b>(<i></i>)
1255 <p>
1256 Private slot used to switch between the current and the previous
1257 current tab.
1258 </p><a NAME="HelpWindow.__syncTOC" ID="HelpWindow.__syncTOC"></a>
1259 <h4>HelpWindow.__syncTOC</h4>
1260 <b>__syncTOC</b>(<i></i>)
1261 <p>
1262 Private slot to synchronize the TOC with the currently shown page.
1263 </p><a NAME="HelpWindow.__titleChanged" ID="HelpWindow.__titleChanged"></a>
1264 <h4>HelpWindow.__titleChanged</h4>
1265 <b>__titleChanged</b>(<i>browser, title</i>)
1266 <p>
1267 Private slot called to handle a change of s browser's title.
1268 </p><dl>
1269 <dt><i>browser</i></dt>
1270 <dd>
1271 reference to the browser (HelpBrowser)
1272 </dd><dt><i>title</i></dt>
1273 <dd>
1274 new title (string)
1275 </dd>
1276 </dl><a NAME="HelpWindow.__userStyleSheet" ID="HelpWindow.__userStyleSheet"></a>
1277 <h4>HelpWindow.__userStyleSheet</h4>
1278 <b>__userStyleSheet</b>(<i>styleSheetFile</i>)
1279 <p>
1280 Private method to generate the user style sheet.
1281 </p><dl>
1282 <dt><i>styleSheetFile</i></dt>
1283 <dd>
1284 name of the user style sheet file (string)
1285 </dd>
1286 </dl><dl>
1287 <dt>Returns:</dt>
1288 <dd>
1289 style sheet (QUrl)
1290 </dd>
1291 </dl><a NAME="HelpWindow.__viewFullScreen" ID="HelpWindow.__viewFullScreen"></a>
1292 <h4>HelpWindow.__viewFullScreen</h4>
1293 <b>__viewFullScreen</b>(<i></i>)
1294 <p>
1295 Private slot called to toggle fullscreen mode.
1296 </p><a NAME="HelpWindow.__virusTotalFileScanReport" ID="HelpWindow.__virusTotalFileScanReport"></a>
1297 <h4>HelpWindow.__virusTotalFileScanReport</h4>
1298 <b>__virusTotalFileScanReport</b>(<i>url</i>)
1299 <p>
1300 Private slot to initiate the display of the file scan report page.
1301 </p><dl>
1302 <dt><i>url</i></dt>
1303 <dd>
1304 URL of the file scan report page (string)
1305 </dd>
1306 </dl><a NAME="HelpWindow.__virusTotalScanCurrentSite" ID="HelpWindow.__virusTotalScanCurrentSite"></a>
1307 <h4>HelpWindow.__virusTotalScanCurrentSite</h4>
1308 <b>__virusTotalScanCurrentSite</b>(<i></i>)
1309 <p>
1310 Private slot to ask VirusTotal for a scan of the URL of the current
1311 browser.
1312 </p><a NAME="HelpWindow.__virusTotalSearch" ID="HelpWindow.__virusTotalSearch"></a>
1313 <h4>HelpWindow.__virusTotalSearch</h4>
1314 <b>__virusTotalSearch</b>(<i></i>)
1315 <p>
1316 Private slot to search VirusTotal for a given entry.
1317 </p><a NAME="HelpWindow.__virusTotalSearchChanged" ID="HelpWindow.__virusTotalSearchChanged"></a>
1318 <h4>HelpWindow.__virusTotalSearchChanged</h4>
1319 <b>__virusTotalSearchChanged</b>(<i>txt</i>)
1320 <p>
1321 Private slot to react upon changes of the VirusTotal search text.
1322 </p><dl>
1323 <dt><i>txt</i></dt>
1324 <dd>
1325 contents of the search (string)
1326 </dd>
1327 </dl><a NAME="HelpWindow.__virusTotalSubmitUrlError" ID="HelpWindow.__virusTotalSubmitUrlError"></a>
1328 <h4>HelpWindow.__virusTotalSubmitUrlError</h4>
1329 <b>__virusTotalSubmitUrlError</b>(<i>msg</i>)
1330 <p>
1331 Private slot to handle an URL scan submission error.
1332 </p><dl>
1333 <dt><i>msg</i></dt>
1334 <dd>
1335 error message (str)
1336 </dd>
1337 </dl><a NAME="HelpWindow.__virusTotalUrlScanReport" ID="HelpWindow.__virusTotalUrlScanReport"></a>
1338 <h4>HelpWindow.__virusTotalUrlScanReport</h4>
1339 <b>__virusTotalUrlScanReport</b>(<i>url</i>)
1340 <p>
1341 Private slot to initiate the display of the URL scan report page.
1342 </p><dl>
1343 <dt><i>url</i></dt>
1344 <dd>
1345 URL of the URL scan report page (string)
1346 </dd>
1347 </dl><a NAME="HelpWindow.__warning" ID="HelpWindow.__warning"></a>
1348 <h4>HelpWindow.__warning</h4>
1349 <b>__warning</b>(<i>msg</i>)
1350 <p>
1351 Private slot handling warnings from the help engine.
1352 </p><dl>
1353 <dt><i>msg</i></dt>
1354 <dd>
1355 message sent by the help engine (string)
1356 </dd>
1357 </dl><a NAME="HelpWindow.__whatsThis" ID="HelpWindow.__whatsThis"></a>
1358 <h4>HelpWindow.__whatsThis</h4>
1359 <b>__whatsThis</b>(<i></i>)
1360 <p>
1361 Private slot called in to enter Whats This mode.
1362 </p><a NAME="HelpWindow.__zoomIn" ID="HelpWindow.__zoomIn"></a>
1363 <h4>HelpWindow.__zoomIn</h4>
1364 <b>__zoomIn</b>(<i></i>)
1365 <p>
1366 Private slot called to handle the zoom in action.
1367 </p><a NAME="HelpWindow.__zoomOut" ID="HelpWindow.__zoomOut"></a>
1368 <h4>HelpWindow.__zoomOut</h4>
1369 <b>__zoomOut</b>(<i></i>)
1370 <p>
1371 Private slot called to handle the zoom out action.
1372 </p><a NAME="HelpWindow.__zoomReset" ID="HelpWindow.__zoomReset"></a>
1373 <h4>HelpWindow.__zoomReset</h4>
1374 <b>__zoomReset</b>(<i></i>)
1375 <p>
1376 Private slot called to handle the zoom reset action.
1377 </p><a NAME="HelpWindow.__zoomTextOnly" ID="HelpWindow.__zoomTextOnly"></a>
1378 <h4>HelpWindow.__zoomTextOnly</h4>
1379 <b>__zoomTextOnly</b>(<i>textOnly</i>)
1380 <p>
1381 Private slot called to handle the zoom text only action.
1382 </p><dl>
1383 <dt><i>textOnly</i></dt>
1384 <dd>
1385 flag indicating to zoom text only (boolean)
1386 </dd>
1387 </dl><a NAME="HelpWindow.__zoomValueChanged" ID="HelpWindow.__zoomValueChanged"></a>
1388 <h4>HelpWindow.__zoomValueChanged</h4>
1389 <b>__zoomValueChanged</b>(<i>value</i>)
1390 <p>
1391 Private slot to handle value changes of the zoom widget.
1392 </p><dl>
1393 <dt><i>value</i></dt>
1394 <dd>
1395 zoom value (integer)
1396 </dd>
1397 </dl><a NAME="HelpWindow.adBlockIcon" ID="HelpWindow.adBlockIcon"></a>
1398 <h4>HelpWindow.adBlockIcon</h4>
1399 <b>adBlockIcon</b>(<i></i>)
1400 <p>
1401 Public method to get a reference to the AdBlock icon.
1402 </p><dl>
1403 <dt>Returns:</dt>
1404 <dd>
1405 reference to the AdBlock icon (AdBlockIcon)
1406 </dd>
1407 </dl><a NAME="HelpWindow.bookmarkAll" ID="HelpWindow.bookmarkAll"></a>
1408 <h4>HelpWindow.bookmarkAll</h4>
1409 <b>bookmarkAll</b>(<i></i>)
1410 <p>
1411 Public slot to bookmark all open tabs.
1412 </p><a NAME="HelpWindow.browserAt" ID="HelpWindow.browserAt"></a>
1413 <h4>HelpWindow.browserAt</h4>
1414 <b>browserAt</b>(<i>index</i>)
1415 <p>
1416 Public method to get a reference to the help browser with the given
1417 index.
1418 </p><dl>
1419 <dt><i>index</i></dt>
1420 <dd>
1421 index of the browser to get (integer)
1422 </dd>
1423 </dl><dl>
1424 <dt>Returns:</dt>
1425 <dd>
1426 reference to the indexed help browser (HelpBrowser)
1427 </dd>
1428 </dl><a NAME="HelpWindow.browsers" ID="HelpWindow.browsers"></a>
1429 <h4>HelpWindow.browsers</h4>
1430 <b>browsers</b>(<i></i>)
1431 <p>
1432 Public method to get a list of references to all help browsers.
1433 </p><dl>
1434 <dt>Returns:</dt>
1435 <dd>
1436 list of references to help browsers (list of HelpBrowser)
1437 </dd>
1438 </dl><a NAME="HelpWindow.closeEvent" ID="HelpWindow.closeEvent"></a>
1439 <h4>HelpWindow.closeEvent</h4>
1440 <b>closeEvent</b>(<i>e</i>)
1441 <p>
1442 Protected event handler for the close event.
1443 </p><dl>
1444 <dt><i>e</i></dt>
1445 <dd>
1446 the close event (QCloseEvent)
1447 <br />This event is simply accepted after the history has been
1448 saved and all window references have been deleted.
1449 </dd>
1450 </dl><a NAME="HelpWindow.currentBrowser" ID="HelpWindow.currentBrowser"></a>
1451 <h4>HelpWindow.currentBrowser</h4>
1452 <b>currentBrowser</b>(<i></i>)
1453 <p>
1454 Public method to get a reference to the current help browser.
1455 </p><dl>
1456 <dt>Returns:</dt>
1457 <dd>
1458 reference to the current help browser (HelpBrowser)
1459 </dd>
1460 </dl><a NAME="HelpWindow.eventKeyboardModifiers" ID="HelpWindow.eventKeyboardModifiers"></a>
1461 <h4>HelpWindow.eventKeyboardModifiers</h4>
1462 <b>eventKeyboardModifiers</b>(<i></i>)
1463 <p>
1464 Public method to get the last recorded keyboard modifiers.
1465 </p><dl>
1466 <dt>Returns:</dt>
1467 <dd>
1468 keyboard modifiers (Qt.KeyboardModifiers)
1469 </dd>
1470 </dl><a NAME="HelpWindow.eventMouseButtons" ID="HelpWindow.eventMouseButtons"></a>
1471 <h4>HelpWindow.eventMouseButtons</h4>
1472 <b>eventMouseButtons</b>(<i></i>)
1473 <p>
1474 Public method to get the last recorded mouse buttons.
1475 </p><dl>
1476 <dt>Returns:</dt>
1477 <dd>
1478 mouse buttons (Qt.MouseButtons)
1479 </dd>
1480 </dl><a NAME="HelpWindow.getActions" ID="HelpWindow.getActions"></a>
1481 <h4>HelpWindow.getActions</h4>
1482 <b>getActions</b>(<i></i>)
1483 <p>
1484 Public method to get a list of all actions.
1485 </p><dl>
1486 <dt>Returns:</dt>
1487 <dd>
1488 list of all actions (list of E5Action)
1489 </dd>
1490 </dl><a NAME="HelpWindow.getSourceFileList" ID="HelpWindow.getSourceFileList"></a>
1491 <h4>HelpWindow.getSourceFileList</h4>
1492 <b>getSourceFileList</b>(<i></i>)
1493 <p>
1494 Public method to get a list of all opened source files.
1495 </p><dl>
1496 <dt>Returns:</dt>
1497 <dd>
1498 dictionary with tab id as key and host/namespace as value
1499 </dd>
1500 </dl><a NAME="HelpWindow.keyPressEvent" ID="HelpWindow.keyPressEvent"></a>
1501 <h4>HelpWindow.keyPressEvent</h4>
1502 <b>keyPressEvent</b>(<i>evt</i>)
1503 <p>
1504 Protected method to handle key presses.
1505 </p><dl>
1506 <dt><i>evt</i></dt>
1507 <dd>
1508 reference to the key press event (QKeyEvent)
1509 </dd>
1510 </dl><a NAME="HelpWindow.masterPasswordChanged" ID="HelpWindow.masterPasswordChanged"></a>
1511 <h4>HelpWindow.masterPasswordChanged</h4>
1512 <b>masterPasswordChanged</b>(<i>oldPassword, newPassword</i>)
1513 <p>
1514 Public slot to handle the change of the master password.
1515 </p><dl>
1516 <dt><i>oldPassword</i></dt>
1517 <dd>
1518 current master password (string)
1519 </dd><dt><i>newPassword</i></dt>
1520 <dd>
1521 new master password (string)
1522 </dd>
1523 </dl><a NAME="HelpWindow.mousePressEvent" ID="HelpWindow.mousePressEvent"></a>
1524 <h4>HelpWindow.mousePressEvent</h4>
1525 <b>mousePressEvent</b>(<i>evt</i>)
1526 <p>
1527 Protected method called by a mouse press event.
1528 </p><dl>
1529 <dt><i>evt</i></dt>
1530 <dd>
1531 reference to the mouse event (QMouseEvent)
1532 </dd>
1533 </dl><a NAME="HelpWindow.newTab" ID="HelpWindow.newTab"></a>
1534 <h4>HelpWindow.newTab</h4>
1535 <b>newTab</b>(<i>link=None, requestData=None, addNextTo=None</i>)
1536 <p>
1537 Public slot called to open a new help window tab.
1538 </p><dl>
1539 <dt><i>link</i></dt>
1540 <dd>
1541 file to be displayed in the new window (string or QUrl)
1542 </dd><dt><i>requestData</i></dt>
1543 <dd>
1544 tuple containing the request data (QNetworkRequest,
1545 QNetworkAccessManager.Operation, QByteArray)
1546 </dd><dt><i>addNextTo</i></dt>
1547 <dd>
1548 reference to the browser to open the tab after
1549 (HelpBrowser)
1550 </dd>
1551 </dl><a NAME="HelpWindow.newWindow" ID="HelpWindow.newWindow"></a>
1552 <h4>HelpWindow.newWindow</h4>
1553 <b>newWindow</b>(<i>link=None</i>)
1554 <p>
1555 Public slot called to open a new help browser dialog.
1556 </p><dl>
1557 <dt><i>link</i></dt>
1558 <dd>
1559 file to be displayed in the new window (string or QUrl)
1560 </dd>
1561 </dl><a NAME="HelpWindow.openSearchManager" ID="HelpWindow.openSearchManager"></a>
1562 <h4>HelpWindow.openSearchManager</h4>
1563 <b>openSearchManager</b>(<i></i>)
1564 <p>
1565 Public method to get a reference to the opensearch manager object.
1566 </p><dl>
1567 <dt>Returns:</dt>
1568 <dd>
1569 reference to the opensearch manager object (OpenSearchManager)
1570 </dd>
1571 </dl><a NAME="HelpWindow.openUrl" ID="HelpWindow.openUrl"></a>
1572 <h4>HelpWindow.openUrl</h4>
1573 <b>openUrl</b>(<i>url, title</i>)
1574 <p>
1575 Public slot to load a URL from the bookmarks menu or bookmarks toolbar
1576 in the current tab.
1577 </p><dl>
1578 <dt><i>url</i></dt>
1579 <dd>
1580 url to be opened (QUrl)
1581 </dd><dt><i>title</i></dt>
1582 <dd>
1583 title of the bookmark (string)
1584 </dd>
1585 </dl><a NAME="HelpWindow.openUrlNewTab" ID="HelpWindow.openUrlNewTab"></a>
1586 <h4>HelpWindow.openUrlNewTab</h4>
1587 <b>openUrlNewTab</b>(<i>url, title</i>)
1588 <p>
1589 Public slot to load a URL from the bookmarks menu or bookmarks toolbar
1590 in a new tab.
1591 </p><dl>
1592 <dt><i>url</i></dt>
1593 <dd>
1594 url to be opened (QUrl)
1595 </dd><dt><i>title</i></dt>
1596 <dd>
1597 title of the bookmark (string)
1598 </dd>
1599 </dl><a NAME="HelpWindow.preferencesChanged" ID="HelpWindow.preferencesChanged"></a>
1600 <h4>HelpWindow.preferencesChanged</h4>
1601 <b>preferencesChanged</b>(<i></i>)
1602 <p>
1603 Public slot to handle a change of preferences.
1604 </p><a NAME="HelpWindow.previewer" ID="HelpWindow.previewer"></a>
1605 <h4>HelpWindow.previewer</h4>
1606 <b>previewer</b>(<i></i>)
1607 <p>
1608 Public method to get a reference to the previewer tab.
1609 </p><dl>
1610 <dt>Returns:</dt>
1611 <dd>
1612 reference to the previewer tab (HelpBrowserWV)
1613 </dd>
1614 </dl><a NAME="HelpWindow.reloadUserStyleSheet" ID="HelpWindow.reloadUserStyleSheet"></a>
1615 <h4>HelpWindow.reloadUserStyleSheet</h4>
1616 <b>reloadUserStyleSheet</b>(<i></i>)
1617 <p>
1618 Public method to reload the user style sheet.
1619 </p><a NAME="HelpWindow.requestVirusTotalScan" ID="HelpWindow.requestVirusTotalScan"></a>
1620 <h4>HelpWindow.requestVirusTotalScan</h4>
1621 <b>requestVirusTotalScan</b>(<i>url</i>)
1622 <p>
1623 Public method to submit a request to scan an URL by VirusTotal.
1624 </p><dl>
1625 <dt><i>url</i></dt>
1626 <dd>
1627 URL to be scanned (QUrl)
1628 </dd>
1629 </dl><a NAME="HelpWindow.search" ID="HelpWindow.search"></a>
1630 <h4>HelpWindow.search</h4>
1631 <b>search</b>(<i>word</i>)
1632 <p>
1633 Public method to search for a word.
1634 </p><dl>
1635 <dt><i>word</i></dt>
1636 <dd>
1637 word to search for (string)
1638 </dd>
1639 </dl><a NAME="HelpWindow.searchEnginesAction" ID="HelpWindow.searchEnginesAction"></a>
1640 <h4>HelpWindow.searchEnginesAction</h4>
1641 <b>searchEnginesAction</b>(<i></i>)
1642 <p>
1643 Public method to get a reference to the search engines configuration
1644 action.
1645 </p><dl>
1646 <dt>Returns:</dt>
1647 <dd>
1648 reference to the search engines configuration action (QAction)
1649 </dd>
1650 </dl><a NAME="HelpWindow.setBackwardAvailable" ID="HelpWindow.setBackwardAvailable"></a>
1651 <h4>HelpWindow.setBackwardAvailable</h4>
1652 <b>setBackwardAvailable</b>(<i>b</i>)
1653 <p>
1654 Public slot called when backward references are available.
1655 </p><dl>
1656 <dt><i>b</i></dt>
1657 <dd>
1658 flag indicating availability of the backwards action (boolean)
1659 </dd>
1660 </dl><a NAME="HelpWindow.setEventKeyboardModifiers" ID="HelpWindow.setEventKeyboardModifiers"></a>
1661 <h4>HelpWindow.setEventKeyboardModifiers</h4>
1662 <b>setEventKeyboardModifiers</b>(<i>modifiers</i>)
1663 <p>
1664 Public method to record keyboard modifiers.
1665 </p><dl>
1666 <dt><i>modifiers</i></dt>
1667 <dd>
1668 keyboard modifiers to record (Qt.KeyboardModifiers)
1669 </dd>
1670 </dl><a NAME="HelpWindow.setEventMouseButtons" ID="HelpWindow.setEventMouseButtons"></a>
1671 <h4>HelpWindow.setEventMouseButtons</h4>
1672 <b>setEventMouseButtons</b>(<i>buttons</i>)
1673 <p>
1674 Public method to record mouse buttons.
1675 </p><dl>
1676 <dt><i>buttons</i></dt>
1677 <dd>
1678 mouse buttons to record (Qt.MouseButtons)
1679 </dd>
1680 </dl><a NAME="HelpWindow.setForwardAvailable" ID="HelpWindow.setForwardAvailable"></a>
1681 <h4>HelpWindow.setForwardAvailable</h4>
1682 <b>setForwardAvailable</b>(<i>b</i>)
1683 <p>
1684 Public slot called when forward references are available.
1685 </p><dl>
1686 <dt><i>b</i></dt>
1687 <dd>
1688 flag indicating the availability of the forwards action
1689 (boolean)
1690 </dd>
1691 </dl><a NAME="HelpWindow.setLoadingActions" ID="HelpWindow.setLoadingActions"></a>
1692 <h4>HelpWindow.setLoadingActions</h4>
1693 <b>setLoadingActions</b>(<i>b</i>)
1694 <p>
1695 Public slot to set the loading dependent actions.
1696 </p><dl>
1697 <dt><i>b</i></dt>
1698 <dd>
1699 flag indicating the loading state to consider (boolean)
1700 </dd>
1701 </dl><a NAME="HelpWindow.setPrivateMode" ID="HelpWindow.setPrivateMode"></a>
1702 <h4>HelpWindow.setPrivateMode</h4>
1703 <b>setPrivateMode</b>(<i>on</i>)
1704 <p>
1705 Public method to set the privacy mode.
1706 </p><dl>
1707 <dt><i>on</i></dt>
1708 <dd>
1709 flag indicating the privacy state (boolean)
1710 </dd>
1711 </dl><a NAME="HelpWindow.shutdown" ID="HelpWindow.shutdown"></a>
1712 <h4>HelpWindow.shutdown</h4>
1713 <b>shutdown</b>(<i></i>)
1714 <p>
1715 Public method to shut down the web browser.
1716 </p><dl>
1717 <dt>Returns:</dt>
1718 <dd>
1719 flag indicating successful shutdown (boolean)
1720 </dd>
1721 </dl><a NAME="HelpWindow.__getWebIcon" ID="HelpWindow.__getWebIcon"></a>
1722 <h4>HelpWindow.__getWebIcon (static)</h4>
1723 <b>__getWebIcon</b>(<i></i>)
1724 <p>
1725 Private static method to fetch the icon for a URL.
1726 </p><dl>
1727 <dt><i>url</i></dt>
1728 <dd>
1729 URL to get icon for (QUrl)
1730 </dd>
1731 </dl><dl>
1732 <dt>Returns:</dt>
1733 <dd>
1734 icon for the URL (QIcon)
1735 </dd>
1736 </dl>
1737 <div align="right"><a href="#top">Up</a></div>
1738 <hr />
1739 </body></html>

eric ide

mercurial