Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.Helpviewer.HelpWindow.html

Documentation/Source/eric4.Helpviewer.HelpWindow.html

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

Mercurial Repository: eric

eric ide

mercurial