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