eric6/Documentation/Source/eric6.Helpviewer.HelpTabWidget.html

branch
maintenance
changeset 7286
7eb04391adf7
parent 7226
babe80d84a3e
parent 7285
1ff497f33f31
child 7287
1c17f2191bdd
equal deleted inserted replaced
7226:babe80d84a3e 7286:7eb04391adf7
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.HelpTabWidget</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.HelpTabWidget</h1>
23 <p>
24 Module implementing the central widget showing the web pages.
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="#HelpTabWidget">HelpTabWidget</a></td>
34 <td>Class implementing the central widget showing the web pages.</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="HelpTabWidget" ID="HelpTabWidget"></a>
43 <h2>HelpTabWidget</h2>
44 <p>
45 Class implementing the central widget showing the web pages.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>browserClosed(QWidget)</dt>
49 <dd>
50 emitted after a browser was closed
51 </dd><dt>browserZoomValueChanged(int)</dt>
52 <dd>
53 emitted to signal a change of the
54 current browser's zoom level
55 </dd><dt>showMessage(str)</dt>
56 <dd>
57 emitted to show a message in the main window
58 status bar
59 </dd><dt>sourceChanged(HelpBrowser, QUrl)</dt>
60 <dd>
61 emitted after the URL of a browser
62 has changed
63 </dd><dt>titleChanged(HelpBrowser, str)</dt>
64 <dd>
65 emitted after the title of a browser
66 has changed
67 </dd>
68 </dl>
69 <h3>Derived from</h3>
70 E5TabWidget
71 <h3>Class Attributes</h3>
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75 <h3>Class Methods</h3>
76 <table>
77 <tr><td>None</td></tr>
78 </table>
79 <h3>Methods</h3>
80 <table>
81 <tr>
82 <td><a href="#HelpTabWidget.__init__">HelpTabWidget</a></td>
83 <td>Constructor</td>
84 </tr><tr>
85 <td><a href="#HelpTabWidget.__aboutToShowClosedTabsMenu">__aboutToShowClosedTabsMenu</a></td>
86 <td>Private slot to populate the closed tabs menu.</td>
87 </tr><tr>
88 <td><a href="#HelpTabWidget.__closedTabAvailable">__closedTabAvailable</a></td>
89 <td>Private slot to handle changes of the availability of closed tabs.</td>
90 </tr><tr>
91 <td><a href="#HelpTabWidget.__currentChanged">__currentChanged</a></td>
92 <td>Private slot to handle an index change.</td>
93 </tr><tr>
94 <td><a href="#HelpTabWidget.__elide">__elide</a></td>
95 <td>Private method to elide some text.</td>
96 </tr><tr>
97 <td><a href="#HelpTabWidget.__guessUrlFromPath">__guessUrlFromPath</a></td>
98 <td>Private method to guess an URL given a path string.</td>
99 </tr><tr>
100 <td><a href="#HelpTabWidget.__iconChanged">__iconChanged</a></td>
101 <td>Private slot to handle the icon change.</td>
102 </tr><tr>
103 <td><a href="#HelpTabWidget.__initTabContextMenu">__initTabContextMenu</a></td>
104 <td>Private method to create the tab context menu.</td>
105 </tr><tr>
106 <td><a href="#HelpTabWidget.__lineEditReturnPressed">__lineEditReturnPressed</a></td>
107 <td>Private slot to handle the entering of an URL.</td>
108 </tr><tr>
109 <td><a href="#HelpTabWidget.__loadFinished">__loadFinished</a></td>
110 <td>Private method to handle the loadFinished signal.</td>
111 </tr><tr>
112 <td><a href="#HelpTabWidget.__loadStarted">__loadStarted</a></td>
113 <td>Private method to handle the loadStarted signal.</td>
114 </tr><tr>
115 <td><a href="#HelpTabWidget.__navigationMenuTriggered">__navigationMenuTriggered</a></td>
116 <td>Private slot called to handle the navigation button menu selection.</td>
117 </tr><tr>
118 <td><a href="#HelpTabWidget.__newBrowser">__newBrowser</a></td>
119 <td>Private slot to open a new browser tab.</td>
120 </tr><tr>
121 <td><a href="#HelpTabWidget.__pathSelected">__pathSelected</a></td>
122 <td>Private slot called when a URL is selected from the completer.</td>
123 </tr><tr>
124 <td><a href="#HelpTabWidget.__printPdfRequested">__printPdfRequested</a></td>
125 <td>Private slot to handle a print to PDF request.</td>
126 </tr><tr>
127 <td><a href="#HelpTabWidget.__printPreview">__printPreview</a></td>
128 <td>Private slot to generate a print preview.</td>
129 </tr><tr>
130 <td><a href="#HelpTabWidget.__printRequested">__printRequested</a></td>
131 <td>Private slot to handle a print request.</td>
132 </tr><tr>
133 <td><a href="#HelpTabWidget.__showContextMenu">__showContextMenu</a></td>
134 <td>Private slot to show the tab context menu.</td>
135 </tr><tr>
136 <td><a href="#HelpTabWidget.__showNavigationMenu">__showNavigationMenu</a></td>
137 <td>Private slot to show the navigation button menu.</td>
138 </tr><tr>
139 <td><a href="#HelpTabWidget.__sourceChanged">__sourceChanged</a></td>
140 <td>Private slot to handle a change of a browsers source.</td>
141 </tr><tr>
142 <td><a href="#HelpTabWidget.__tabContextMenuClone">__tabContextMenuClone</a></td>
143 <td>Private method to clone the selected tab.</td>
144 </tr><tr>
145 <td><a href="#HelpTabWidget.__tabContextMenuClose">__tabContextMenuClose</a></td>
146 <td>Private method to close the selected tab.</td>
147 </tr><tr>
148 <td><a href="#HelpTabWidget.__tabContextMenuCloseOthers">__tabContextMenuCloseOthers</a></td>
149 <td>Private slot to close all other tabs.</td>
150 </tr><tr>
151 <td><a href="#HelpTabWidget.__tabContextMenuMoveLeft">__tabContextMenuMoveLeft</a></td>
152 <td>Private method to move a tab one position to the left.</td>
153 </tr><tr>
154 <td><a href="#HelpTabWidget.__tabContextMenuMoveRight">__tabContextMenuMoveRight</a></td>
155 <td>Private method to move a tab one position to the right.</td>
156 </tr><tr>
157 <td><a href="#HelpTabWidget.__tabContextMenuPrint">__tabContextMenuPrint</a></td>
158 <td>Private method to print the selected tab.</td>
159 </tr><tr>
160 <td><a href="#HelpTabWidget.__tabContextMenuPrintPdf">__tabContextMenuPrintPdf</a></td>
161 <td>Private method to print the selected tab as PDF.</td>
162 </tr><tr>
163 <td><a href="#HelpTabWidget.__tabContextMenuPrintPreview">__tabContextMenuPrintPreview</a></td>
164 <td>Private method to show a print preview of the selected tab.</td>
165 </tr><tr>
166 <td><a href="#HelpTabWidget.__titleChanged">__titleChanged</a></td>
167 <td>Private slot to handle a change of a browsers title.</td>
168 </tr><tr>
169 <td><a href="#HelpTabWidget.__windowCloseRequested">__windowCloseRequested</a></td>
170 <td>Private slot to handle the windowCloseRequested signal of a browser.</td>
171 </tr><tr>
172 <td><a href="#HelpTabWidget.browserAt">browserAt</a></td>
173 <td>Public method to get a reference to the browser with the given index.</td>
174 </tr><tr>
175 <td><a href="#HelpTabWidget.browsers">browsers</a></td>
176 <td>Public method to get a list of references to all browsers.</td>
177 </tr><tr>
178 <td><a href="#HelpTabWidget.canRestoreClosedTab">canRestoreClosedTab</a></td>
179 <td>Public method to check, if closed tabs can be restored.</td>
180 </tr><tr>
181 <td><a href="#HelpTabWidget.clearClosedTabsList">clearClosedTabsList</a></td>
182 <td>Public slot to clear the list of closed tabs.</td>
183 </tr><tr>
184 <td><a href="#HelpTabWidget.closeAllBrowsers">closeAllBrowsers</a></td>
185 <td>Public slot called to handle the close all action.</td>
186 </tr><tr>
187 <td><a href="#HelpTabWidget.closeBrowser">closeBrowser</a></td>
188 <td>Public slot called to handle the close action.</td>
189 </tr><tr>
190 <td><a href="#HelpTabWidget.closeBrowserAt">closeBrowserAt</a></td>
191 <td>Public slot to close a browser based on its index.</td>
192 </tr><tr>
193 <td><a href="#HelpTabWidget.closedTabsManager">closedTabsManager</a></td>
194 <td>Public slot to get a reference to the closed tabs manager.</td>
195 </tr><tr>
196 <td><a href="#HelpTabWidget.currentBrowser">currentBrowser</a></td>
197 <td>Public method to get a reference to the current browser.</td>
198 </tr><tr>
199 <td><a href="#HelpTabWidget.currentUrlBar">currentUrlBar</a></td>
200 <td>Public method to get a reference to the current url bar.</td>
201 </tr><tr>
202 <td><a href="#HelpTabWidget.getSourceFileList">getSourceFileList</a></td>
203 <td>Public method to get a list of all opened source files.</td>
204 </tr><tr>
205 <td><a href="#HelpTabWidget.newBrowser">newBrowser</a></td>
206 <td>Public method to create a new web browser tab.</td>
207 </tr><tr>
208 <td><a href="#HelpTabWidget.newBrowserAfter">newBrowserAfter</a></td>
209 <td>Public method to create a new web browser tab after a given one.</td>
210 </tr><tr>
211 <td><a href="#HelpTabWidget.preferencesChanged">preferencesChanged</a></td>
212 <td>Public slot to handle a change of preferences.</td>
213 </tr><tr>
214 <td><a href="#HelpTabWidget.printBrowser">printBrowser</a></td>
215 <td>Public slot called to print the displayed page.</td>
216 </tr><tr>
217 <td><a href="#HelpTabWidget.printBrowserPdf">printBrowserPdf</a></td>
218 <td>Public slot called to print the displayed page to PDF.</td>
219 </tr><tr>
220 <td><a href="#HelpTabWidget.printPreviewBrowser">printPreviewBrowser</a></td>
221 <td>Public slot called to show a print preview of the displayed file.</td>
222 </tr><tr>
223 <td><a href="#HelpTabWidget.reloadAllBrowsers">reloadAllBrowsers</a></td>
224 <td>Public slot to reload all browsers.</td>
225 </tr><tr>
226 <td><a href="#HelpTabWidget.restoreAllClosedTabs">restoreAllClosedTabs</a></td>
227 <td>Public slot to restore all closed tabs.</td>
228 </tr><tr>
229 <td><a href="#HelpTabWidget.restoreClosedTab">restoreClosedTab</a></td>
230 <td>Public slot to restore the most recently closed tab.</td>
231 </tr><tr>
232 <td><a href="#HelpTabWidget.shallShutDown">shallShutDown</a></td>
233 <td>Public method to check, if the application should be shut down.</td>
234 </tr><tr>
235 <td><a href="#HelpTabWidget.stackedUrlBar">stackedUrlBar</a></td>
236 <td>Public method to get a reference to the stacked url bar.</td>
237 </tr>
238 </table>
239 <h3>Static Methods</h3>
240 <table>
241 <tr><td>None</td></tr>
242 </table>
243 <a NAME="HelpTabWidget.__init__" ID="HelpTabWidget.__init__"></a>
244 <h4>HelpTabWidget (Constructor)</h4>
245 <b>HelpTabWidget</b>(<i>parent</i>)
246 <p>
247 Constructor
248 </p><dl>
249 <dt><i>parent</i></dt>
250 <dd>
251 reference to the parent widget (QWidget)
252 </dd>
253 </dl><a NAME="HelpTabWidget.__aboutToShowClosedTabsMenu" ID="HelpTabWidget.__aboutToShowClosedTabsMenu"></a>
254 <h4>HelpTabWidget.__aboutToShowClosedTabsMenu</h4>
255 <b>__aboutToShowClosedTabsMenu</b>(<i></i>)
256 <p>
257 Private slot to populate the closed tabs menu.
258 </p><a NAME="HelpTabWidget.__closedTabAvailable" ID="HelpTabWidget.__closedTabAvailable"></a>
259 <h4>HelpTabWidget.__closedTabAvailable</h4>
260 <b>__closedTabAvailable</b>(<i>avail</i>)
261 <p>
262 Private slot to handle changes of the availability of closed tabs.
263 </p><dl>
264 <dt><i>avail</i></dt>
265 <dd>
266 flag indicating the availability of closed tabs (boolean)
267 </dd>
268 </dl><a NAME="HelpTabWidget.__currentChanged" ID="HelpTabWidget.__currentChanged"></a>
269 <h4>HelpTabWidget.__currentChanged</h4>
270 <b>__currentChanged</b>(<i>index</i>)
271 <p>
272 Private slot to handle an index change.
273 </p><dl>
274 <dt><i>index</i></dt>
275 <dd>
276 new index (integer)
277 </dd>
278 </dl><a NAME="HelpTabWidget.__elide" ID="HelpTabWidget.__elide"></a>
279 <h4>HelpTabWidget.__elide</h4>
280 <b>__elide</b>(<i>txt, mode=Qt.ElideRight, length=40</i>)
281 <p>
282 Private method to elide some text.
283 </p><dl>
284 <dt><i>txt</i></dt>
285 <dd>
286 text to be elided (string)
287 </dd><dt><i>mode=</i></dt>
288 <dd>
289 elide mode (Qt.TextElideMode)
290 </dd><dt><i>length=</i></dt>
291 <dd>
292 amount of characters to be used (integer)
293 </dd>
294 </dl><dl>
295 <dt>Returns:</dt>
296 <dd>
297 the elided text (string)
298 </dd>
299 </dl><a NAME="HelpTabWidget.__guessUrlFromPath" ID="HelpTabWidget.__guessUrlFromPath"></a>
300 <h4>HelpTabWidget.__guessUrlFromPath</h4>
301 <b>__guessUrlFromPath</b>(<i>path</i>)
302 <p>
303 Private method to guess an URL given a path string.
304 </p><dl>
305 <dt><i>path</i></dt>
306 <dd>
307 path string to guess an URL for (string)
308 </dd>
309 </dl><dl>
310 <dt>Returns:</dt>
311 <dd>
312 guessed URL (QUrl)
313 </dd>
314 </dl><a NAME="HelpTabWidget.__iconChanged" ID="HelpTabWidget.__iconChanged"></a>
315 <h4>HelpTabWidget.__iconChanged</h4>
316 <b>__iconChanged</b>(<i>browser</i>)
317 <p>
318 Private slot to handle the icon change.
319 </p><dl>
320 <dt><i>browser</i> (HelpBrowser)</dt>
321 <dd>
322 reference to the web browser
323 </dd>
324 </dl><a NAME="HelpTabWidget.__initTabContextMenu" ID="HelpTabWidget.__initTabContextMenu"></a>
325 <h4>HelpTabWidget.__initTabContextMenu</h4>
326 <b>__initTabContextMenu</b>(<i></i>)
327 <p>
328 Private method to create the tab context menu.
329 </p><a NAME="HelpTabWidget.__lineEditReturnPressed" ID="HelpTabWidget.__lineEditReturnPressed"></a>
330 <h4>HelpTabWidget.__lineEditReturnPressed</h4>
331 <b>__lineEditReturnPressed</b>(<i>edit</i>)
332 <p>
333 Private slot to handle the entering of an URL.
334 </p><dl>
335 <dt><i>edit</i> (UrlBar)</dt>
336 <dd>
337 reference to the line edit
338 </dd>
339 </dl><a NAME="HelpTabWidget.__loadFinished" ID="HelpTabWidget.__loadFinished"></a>
340 <h4>HelpTabWidget.__loadFinished</h4>
341 <b>__loadFinished</b>(<i>ok</i>)
342 <p>
343 Private method to handle the loadFinished signal.
344 </p><dl>
345 <dt><i>ok</i> (bool)</dt>
346 <dd>
347 flag indicating the result
348 </dd>
349 </dl><a NAME="HelpTabWidget.__loadStarted" ID="HelpTabWidget.__loadStarted"></a>
350 <h4>HelpTabWidget.__loadStarted</h4>
351 <b>__loadStarted</b>(<i>browser</i>)
352 <p>
353 Private method to handle the loadStarted signal.
354 </p><dl>
355 <dt><i>browser</i> (HelpBrowser)</dt>
356 <dd>
357 reference to the web browser
358 </dd>
359 </dl><a NAME="HelpTabWidget.__navigationMenuTriggered" ID="HelpTabWidget.__navigationMenuTriggered"></a>
360 <h4>HelpTabWidget.__navigationMenuTriggered</h4>
361 <b>__navigationMenuTriggered</b>(<i>act</i>)
362 <p>
363 Private slot called to handle the navigation button menu selection.
364 </p><dl>
365 <dt><i>act</i></dt>
366 <dd>
367 reference to the selected action (QAction)
368 </dd>
369 </dl><a NAME="HelpTabWidget.__newBrowser" ID="HelpTabWidget.__newBrowser"></a>
370 <h4>HelpTabWidget.__newBrowser</h4>
371 <b>__newBrowser</b>(<i></i>)
372 <p>
373 Private slot to open a new browser tab.
374 </p><a NAME="HelpTabWidget.__pathSelected" ID="HelpTabWidget.__pathSelected"></a>
375 <h4>HelpTabWidget.__pathSelected</h4>
376 <b>__pathSelected</b>(<i>path</i>)
377 <p>
378 Private slot called when a URL is selected from the completer.
379 </p><dl>
380 <dt><i>path</i></dt>
381 <dd>
382 path to be shown (string)
383 </dd>
384 </dl><a NAME="HelpTabWidget.__printPdfRequested" ID="HelpTabWidget.__printPdfRequested"></a>
385 <h4>HelpTabWidget.__printPdfRequested</h4>
386 <b>__printPdfRequested</b>(<i>frame</i>)
387 <p>
388 Private slot to handle a print to PDF request.
389 </p><dl>
390 <dt><i>frame</i></dt>
391 <dd>
392 reference to the frame to be printed (QWebFrame)
393 </dd>
394 </dl><a NAME="HelpTabWidget.__printPreview" ID="HelpTabWidget.__printPreview"></a>
395 <h4>HelpTabWidget.__printPreview</h4>
396 <b>__printPreview</b>(<i>printer</i>)
397 <p>
398 Private slot to generate a print preview.
399 </p><dl>
400 <dt><i>printer</i></dt>
401 <dd>
402 reference to the printer object (QPrinter)
403 </dd>
404 </dl><a NAME="HelpTabWidget.__printRequested" ID="HelpTabWidget.__printRequested"></a>
405 <h4>HelpTabWidget.__printRequested</h4>
406 <b>__printRequested</b>(<i>frame</i>)
407 <p>
408 Private slot to handle a print request.
409 </p><dl>
410 <dt><i>frame</i></dt>
411 <dd>
412 reference to the frame to be printed (QWebFrame)
413 </dd>
414 </dl><a NAME="HelpTabWidget.__showContextMenu" ID="HelpTabWidget.__showContextMenu"></a>
415 <h4>HelpTabWidget.__showContextMenu</h4>
416 <b>__showContextMenu</b>(<i>coord, index</i>)
417 <p>
418 Private slot to show the tab context menu.
419 </p><dl>
420 <dt><i>coord</i></dt>
421 <dd>
422 the position of the mouse pointer (QPoint)
423 </dd><dt><i>index</i></dt>
424 <dd>
425 index of the tab the menu is requested for (integer)
426 </dd>
427 </dl><a NAME="HelpTabWidget.__showNavigationMenu" ID="HelpTabWidget.__showNavigationMenu"></a>
428 <h4>HelpTabWidget.__showNavigationMenu</h4>
429 <b>__showNavigationMenu</b>(<i></i>)
430 <p>
431 Private slot to show the navigation button menu.
432 </p><a NAME="HelpTabWidget.__sourceChanged" ID="HelpTabWidget.__sourceChanged"></a>
433 <h4>HelpTabWidget.__sourceChanged</h4>
434 <b>__sourceChanged</b>(<i>url, browser</i>)
435 <p>
436 Private slot to handle a change of a browsers source.
437 </p><dl>
438 <dt><i>url</i> (QUrl)</dt>
439 <dd>
440 URL of the new site
441 </dd><dt><i>browser</i> (HelpBrowser)</dt>
442 <dd>
443 reference to the web browser
444 </dd>
445 </dl><a NAME="HelpTabWidget.__tabContextMenuClone" ID="HelpTabWidget.__tabContextMenuClone"></a>
446 <h4>HelpTabWidget.__tabContextMenuClone</h4>
447 <b>__tabContextMenuClone</b>(<i></i>)
448 <p>
449 Private method to clone the selected tab.
450 </p><a NAME="HelpTabWidget.__tabContextMenuClose" ID="HelpTabWidget.__tabContextMenuClose"></a>
451 <h4>HelpTabWidget.__tabContextMenuClose</h4>
452 <b>__tabContextMenuClose</b>(<i></i>)
453 <p>
454 Private method to close the selected tab.
455 </p><a NAME="HelpTabWidget.__tabContextMenuCloseOthers" ID="HelpTabWidget.__tabContextMenuCloseOthers"></a>
456 <h4>HelpTabWidget.__tabContextMenuCloseOthers</h4>
457 <b>__tabContextMenuCloseOthers</b>(<i></i>)
458 <p>
459 Private slot to close all other tabs.
460 </p><a NAME="HelpTabWidget.__tabContextMenuMoveLeft" ID="HelpTabWidget.__tabContextMenuMoveLeft"></a>
461 <h4>HelpTabWidget.__tabContextMenuMoveLeft</h4>
462 <b>__tabContextMenuMoveLeft</b>(<i></i>)
463 <p>
464 Private method to move a tab one position to the left.
465 </p><a NAME="HelpTabWidget.__tabContextMenuMoveRight" ID="HelpTabWidget.__tabContextMenuMoveRight"></a>
466 <h4>HelpTabWidget.__tabContextMenuMoveRight</h4>
467 <b>__tabContextMenuMoveRight</b>(<i></i>)
468 <p>
469 Private method to move a tab one position to the right.
470 </p><a NAME="HelpTabWidget.__tabContextMenuPrint" ID="HelpTabWidget.__tabContextMenuPrint"></a>
471 <h4>HelpTabWidget.__tabContextMenuPrint</h4>
472 <b>__tabContextMenuPrint</b>(<i></i>)
473 <p>
474 Private method to print the selected tab.
475 </p><a NAME="HelpTabWidget.__tabContextMenuPrintPdf" ID="HelpTabWidget.__tabContextMenuPrintPdf"></a>
476 <h4>HelpTabWidget.__tabContextMenuPrintPdf</h4>
477 <b>__tabContextMenuPrintPdf</b>(<i></i>)
478 <p>
479 Private method to print the selected tab as PDF.
480 </p><a NAME="HelpTabWidget.__tabContextMenuPrintPreview" ID="HelpTabWidget.__tabContextMenuPrintPreview"></a>
481 <h4>HelpTabWidget.__tabContextMenuPrintPreview</h4>
482 <b>__tabContextMenuPrintPreview</b>(<i></i>)
483 <p>
484 Private method to show a print preview of the selected tab.
485 </p><a NAME="HelpTabWidget.__titleChanged" ID="HelpTabWidget.__titleChanged"></a>
486 <h4>HelpTabWidget.__titleChanged</h4>
487 <b>__titleChanged</b>(<i>title, browser</i>)
488 <p>
489 Private slot to handle a change of a browsers title.
490 </p><dl>
491 <dt><i>title</i> (str)</dt>
492 <dd>
493 new title
494 </dd><dt><i>browser</i> (HelpBrowser)</dt>
495 <dd>
496 reference to the web browser
497 </dd>
498 </dl><a NAME="HelpTabWidget.__windowCloseRequested" ID="HelpTabWidget.__windowCloseRequested"></a>
499 <h4>HelpTabWidget.__windowCloseRequested</h4>
500 <b>__windowCloseRequested</b>(<i>page</i>)
501 <p>
502 Private slot to handle the windowCloseRequested signal of a browser.
503 </p><dl>
504 <dt><i>page</i> (HelpWebPage)</dt>
505 <dd>
506 reference to the web page
507 </dd>
508 </dl><a NAME="HelpTabWidget.browserAt" ID="HelpTabWidget.browserAt"></a>
509 <h4>HelpTabWidget.browserAt</h4>
510 <b>browserAt</b>(<i>index</i>)
511 <p>
512 Public method to get a reference to the browser with the given index.
513 </p><dl>
514 <dt><i>index</i></dt>
515 <dd>
516 index of the browser to get (integer)
517 </dd>
518 </dl><dl>
519 <dt>Returns:</dt>
520 <dd>
521 reference to the indexed browser (HelpBrowser)
522 </dd>
523 </dl><a NAME="HelpTabWidget.browsers" ID="HelpTabWidget.browsers"></a>
524 <h4>HelpTabWidget.browsers</h4>
525 <b>browsers</b>(<i></i>)
526 <p>
527 Public method to get a list of references to all browsers.
528 </p><dl>
529 <dt>Returns:</dt>
530 <dd>
531 list of references to browsers (list of HelpBrowser)
532 </dd>
533 </dl><a NAME="HelpTabWidget.canRestoreClosedTab" ID="HelpTabWidget.canRestoreClosedTab"></a>
534 <h4>HelpTabWidget.canRestoreClosedTab</h4>
535 <b>canRestoreClosedTab</b>(<i></i>)
536 <p>
537 Public method to check, if closed tabs can be restored.
538 </p><dl>
539 <dt>Returns:</dt>
540 <dd>
541 flag indicating that closed tabs can be restored (boolean)
542 </dd>
543 </dl><a NAME="HelpTabWidget.clearClosedTabsList" ID="HelpTabWidget.clearClosedTabsList"></a>
544 <h4>HelpTabWidget.clearClosedTabsList</h4>
545 <b>clearClosedTabsList</b>(<i></i>)
546 <p>
547 Public slot to clear the list of closed tabs.
548 </p><a NAME="HelpTabWidget.closeAllBrowsers" ID="HelpTabWidget.closeAllBrowsers"></a>
549 <h4>HelpTabWidget.closeAllBrowsers</h4>
550 <b>closeAllBrowsers</b>(<i></i>)
551 <p>
552 Public slot called to handle the close all action.
553 </p><a NAME="HelpTabWidget.closeBrowser" ID="HelpTabWidget.closeBrowser"></a>
554 <h4>HelpTabWidget.closeBrowser</h4>
555 <b>closeBrowser</b>(<i></i>)
556 <p>
557 Public slot called to handle the close action.
558 </p><a NAME="HelpTabWidget.closeBrowserAt" ID="HelpTabWidget.closeBrowserAt"></a>
559 <h4>HelpTabWidget.closeBrowserAt</h4>
560 <b>closeBrowserAt</b>(<i>index</i>)
561 <p>
562 Public slot to close a browser based on its index.
563 </p><dl>
564 <dt><i>index</i></dt>
565 <dd>
566 index of browser to close (integer)
567 </dd>
568 </dl><a NAME="HelpTabWidget.closedTabsManager" ID="HelpTabWidget.closedTabsManager"></a>
569 <h4>HelpTabWidget.closedTabsManager</h4>
570 <b>closedTabsManager</b>(<i></i>)
571 <p>
572 Public slot to get a reference to the closed tabs manager.
573 </p><dl>
574 <dt>Returns:</dt>
575 <dd>
576 reference to the closed tabs manager (ClosedTabsManager)
577 </dd>
578 </dl><a NAME="HelpTabWidget.currentBrowser" ID="HelpTabWidget.currentBrowser"></a>
579 <h4>HelpTabWidget.currentBrowser</h4>
580 <b>currentBrowser</b>(<i></i>)
581 <p>
582 Public method to get a reference to the current browser.
583 </p><dl>
584 <dt>Returns:</dt>
585 <dd>
586 reference to the current browser (HelpBrowser)
587 </dd>
588 </dl><a NAME="HelpTabWidget.currentUrlBar" ID="HelpTabWidget.currentUrlBar"></a>
589 <h4>HelpTabWidget.currentUrlBar</h4>
590 <b>currentUrlBar</b>(<i></i>)
591 <p>
592 Public method to get a reference to the current url bar.
593 </p><dl>
594 <dt>Returns:</dt>
595 <dd>
596 reference to the current url bar (UrlBar)
597 </dd>
598 </dl><a NAME="HelpTabWidget.getSourceFileList" ID="HelpTabWidget.getSourceFileList"></a>
599 <h4>HelpTabWidget.getSourceFileList</h4>
600 <b>getSourceFileList</b>(<i></i>)
601 <p>
602 Public method to get a list of all opened source files.
603 </p><dl>
604 <dt>Returns:</dt>
605 <dd>
606 dictionary with tab id as key and host/namespace as value
607 </dd>
608 </dl><a NAME="HelpTabWidget.newBrowser" ID="HelpTabWidget.newBrowser"></a>
609 <h4>HelpTabWidget.newBrowser</h4>
610 <b>newBrowser</b>(<i>link=None, requestData=None, position=-1</i>)
611 <p>
612 Public method to create a new web browser tab.
613 </p><dl>
614 <dt><i>link</i></dt>
615 <dd>
616 link to be shown (string or QUrl)
617 </dd><dt><i>requestData</i></dt>
618 <dd>
619 tuple containing the request data (QNetworkRequest,
620 QNetworkAccessManager.Operation, QByteArray)
621 </dd><dt><i>position=</i></dt>
622 <dd>
623 position to create the new tab at or -1 to add it
624 to the end (integer)
625 </dd>
626 </dl><a NAME="HelpTabWidget.newBrowserAfter" ID="HelpTabWidget.newBrowserAfter"></a>
627 <h4>HelpTabWidget.newBrowserAfter</h4>
628 <b>newBrowserAfter</b>(<i>browser, link=None, requestData=None</i>)
629 <p>
630 Public method to create a new web browser tab after a given one.
631 </p><dl>
632 <dt><i>browser</i></dt>
633 <dd>
634 reference to the browser to add after (HelpBrowser)
635 </dd><dt><i>link</i></dt>
636 <dd>
637 link to be shown (string or QUrl)
638 </dd><dt><i>requestData</i></dt>
639 <dd>
640 tuple containing the request data (QNetworkRequest,
641 QNetworkAccessManager.Operation, QByteArray)
642 </dd>
643 </dl><a NAME="HelpTabWidget.preferencesChanged" ID="HelpTabWidget.preferencesChanged"></a>
644 <h4>HelpTabWidget.preferencesChanged</h4>
645 <b>preferencesChanged</b>(<i></i>)
646 <p>
647 Public slot to handle a change of preferences.
648 </p><a NAME="HelpTabWidget.printBrowser" ID="HelpTabWidget.printBrowser"></a>
649 <h4>HelpTabWidget.printBrowser</h4>
650 <b>printBrowser</b>(<i>browser=None</i>)
651 <p>
652 Public slot called to print the displayed page.
653 </p><dl>
654 <dt><i>browser</i></dt>
655 <dd>
656 reference to the browser to be printed (HelpBrowser)
657 </dd>
658 </dl><a NAME="HelpTabWidget.printBrowserPdf" ID="HelpTabWidget.printBrowserPdf"></a>
659 <h4>HelpTabWidget.printBrowserPdf</h4>
660 <b>printBrowserPdf</b>(<i>browser=None</i>)
661 <p>
662 Public slot called to print the displayed page to PDF.
663 </p><dl>
664 <dt><i>browser</i></dt>
665 <dd>
666 reference to the browser to be printed (HelpBrowser)
667 </dd>
668 </dl><a NAME="HelpTabWidget.printPreviewBrowser" ID="HelpTabWidget.printPreviewBrowser"></a>
669 <h4>HelpTabWidget.printPreviewBrowser</h4>
670 <b>printPreviewBrowser</b>(<i>browser=None</i>)
671 <p>
672 Public slot called to show a print preview of the displayed file.
673 </p><dl>
674 <dt><i>browser</i></dt>
675 <dd>
676 reference to the browser to be printed (HelpBrowserWV)
677 </dd>
678 </dl><a NAME="HelpTabWidget.reloadAllBrowsers" ID="HelpTabWidget.reloadAllBrowsers"></a>
679 <h4>HelpTabWidget.reloadAllBrowsers</h4>
680 <b>reloadAllBrowsers</b>(<i></i>)
681 <p>
682 Public slot to reload all browsers.
683 </p><a NAME="HelpTabWidget.restoreAllClosedTabs" ID="HelpTabWidget.restoreAllClosedTabs"></a>
684 <h4>HelpTabWidget.restoreAllClosedTabs</h4>
685 <b>restoreAllClosedTabs</b>(<i></i>)
686 <p>
687 Public slot to restore all closed tabs.
688 </p><a NAME="HelpTabWidget.restoreClosedTab" ID="HelpTabWidget.restoreClosedTab"></a>
689 <h4>HelpTabWidget.restoreClosedTab</h4>
690 <b>restoreClosedTab</b>(<i>act</i>)
691 <p>
692 Public slot to restore the most recently closed tab.
693 </p><dl>
694 <dt><i>act</i> (QAction)</dt>
695 <dd>
696 reference to the action that triggered
697 </dd>
698 </dl><a NAME="HelpTabWidget.shallShutDown" ID="HelpTabWidget.shallShutDown"></a>
699 <h4>HelpTabWidget.shallShutDown</h4>
700 <b>shallShutDown</b>(<i></i>)
701 <p>
702 Public method to check, if the application should be shut down.
703 </p><dl>
704 <dt>Returns:</dt>
705 <dd>
706 flag indicating a shut down (boolean)
707 </dd>
708 </dl><a NAME="HelpTabWidget.stackedUrlBar" ID="HelpTabWidget.stackedUrlBar"></a>
709 <h4>HelpTabWidget.stackedUrlBar</h4>
710 <b>stackedUrlBar</b>(<i></i>)
711 <p>
712 Public method to get a reference to the stacked url bar.
713 </p><dl>
714 <dt>Returns:</dt>
715 <dd>
716 reference to the stacked url bar (StackedUrlBar)
717 </dd>
718 </dl>
719 <div align="right"><a href="#top">Up</a></div>
720 <hr />
721 </body></html>

eric ide

mercurial