Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.WebBrowser.WebBrowserTabWidget.html

eric6/Documentation/Source/eric6.WebBrowser.WebBrowserTabWidget.html

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

Mercurial Repository: eric

eric ide

mercurial