Documentation/Source/eric5.Helpviewer.HelpTabWidget.html

changeset 1694
648466a9451b
parent 1645
73904ca06d2d
child 2334
fc69ad77e18a
child 2374
f78ee0e8f96c
equal deleted inserted replaced
1693:9bb872e26a33 1694:648466a9451b
76 <table> 76 <table>
77 <tr> 77 <tr>
78 <td><a href="#HelpTabWidget.__init__">HelpTabWidget</a></td> 78 <td><a href="#HelpTabWidget.__init__">HelpTabWidget</a></td>
79 <td>Constructor</td> 79 <td>Constructor</td>
80 </tr><tr> 80 </tr><tr>
81 <td><a href="#HelpTabWidget.__aboutToShowClosedTabsMenu">__aboutToShowClosedTabsMenu</a></td>
82 <td>Private slot to populate the closed tabs menu.</td>
83 </tr><tr>
84 <td><a href="#HelpTabWidget.__closedTabAvailable">__closedTabAvailable</a></td>
85 <td>Private slot to handle changes of the availability of closed tabs.</td>
86 </tr><tr>
81 <td><a href="#HelpTabWidget.__currentChanged">__currentChanged</a></td> 87 <td><a href="#HelpTabWidget.__currentChanged">__currentChanged</a></td>
82 <td>Private slot to handle an index change.</td> 88 <td>Private slot to handle an index change.</td>
83 </tr><tr> 89 </tr><tr>
84 <td><a href="#HelpTabWidget.__elide">__elide</a></td> 90 <td><a href="#HelpTabWidget.__elide">__elide</a></td>
85 <td>Private method to elide some text.</td> 91 <td>Private method to elide some text.</td>
160 <td>Public method to get a reference to the browser with the given index.</td> 166 <td>Public method to get a reference to the browser with the given index.</td>
161 </tr><tr> 167 </tr><tr>
162 <td><a href="#HelpTabWidget.browsers">browsers</a></td> 168 <td><a href="#HelpTabWidget.browsers">browsers</a></td>
163 <td>Public method to get a list of references to all browsers.</td> 169 <td>Public method to get a list of references to all browsers.</td>
164 </tr><tr> 170 </tr><tr>
171 <td><a href="#HelpTabWidget.canRestoreClosedTab">canRestoreClosedTab</a></td>
172 <td>Public method to check, if closed tabs can be restored.</td>
173 </tr><tr>
174 <td><a href="#HelpTabWidget.clearClosedTabsList">clearClosedTabsList</a></td>
175 <td>Public slot to clear the list of closed tabs.</td>
176 </tr><tr>
165 <td><a href="#HelpTabWidget.closeAllBrowsers">closeAllBrowsers</a></td> 177 <td><a href="#HelpTabWidget.closeAllBrowsers">closeAllBrowsers</a></td>
166 <td>Public slot called to handle the close all action.</td> 178 <td>Public slot called to handle the close all action.</td>
167 </tr><tr> 179 </tr><tr>
168 <td><a href="#HelpTabWidget.closeBrowser">closeBrowser</a></td> 180 <td><a href="#HelpTabWidget.closeBrowser">closeBrowser</a></td>
169 <td>Public slot called to handle the close action.</td> 181 <td>Public slot called to handle the close action.</td>
170 </tr><tr> 182 </tr><tr>
171 <td><a href="#HelpTabWidget.closeBrowserAt">closeBrowserAt</a></td> 183 <td><a href="#HelpTabWidget.closeBrowserAt">closeBrowserAt</a></td>
172 <td>Public slot to close a browser based on it's index.</td> 184 <td>Public slot to close a browser based on it's index.</td>
173 </tr><tr> 185 </tr><tr>
186 <td><a href="#HelpTabWidget.closedTabsManager">closedTabsManager</a></td>
187 <td>Public slot to get a reference to the closed tabs manager.</td>
188 </tr><tr>
174 <td><a href="#HelpTabWidget.currentBrowser">currentBrowser</a></td> 189 <td><a href="#HelpTabWidget.currentBrowser">currentBrowser</a></td>
175 <td>Public method to get a reference to the current browser.</td> 190 <td>Public method to get a reference to the current browser.</td>
176 </tr><tr> 191 </tr><tr>
177 <td><a href="#HelpTabWidget.currentUrlBar">currentUrlBar</a></td> 192 <td><a href="#HelpTabWidget.currentUrlBar">currentUrlBar</a></td>
178 <td>Public method to get a reference to the current url bar.</td> 193 <td>Public method to get a reference to the current url bar.</td>
192 <td><a href="#HelpTabWidget.printBrowserPdf">printBrowserPdf</a></td> 207 <td><a href="#HelpTabWidget.printBrowserPdf">printBrowserPdf</a></td>
193 <td>Public slot called to print the displayed page to PDF.</td> 208 <td>Public slot called to print the displayed page to PDF.</td>
194 </tr><tr> 209 </tr><tr>
195 <td><a href="#HelpTabWidget.printPreviewBrowser">printPreviewBrowser</a></td> 210 <td><a href="#HelpTabWidget.printPreviewBrowser">printPreviewBrowser</a></td>
196 <td>Public slot called to show a print preview of the displayed file.</td> 211 <td>Public slot called to show a print preview of the displayed file.</td>
212 </tr><tr>
213 <td><a href="#HelpTabWidget.reloadAllBrowsers">reloadAllBrowsers</a></td>
214 <td>Public slot to reload all browsers.</td>
215 </tr><tr>
216 <td><a href="#HelpTabWidget.restoreAllClosedTabs">restoreAllClosedTabs</a></td>
217 <td>Public slot to restore all closed tabs.</td>
218 </tr><tr>
219 <td><a href="#HelpTabWidget.restoreClosedTab">restoreClosedTab</a></td>
220 <td>Public slot to restore the most recently closed tab.</td>
197 </tr><tr> 221 </tr><tr>
198 <td><a href="#HelpTabWidget.shallShutDown">shallShutDown</a></td> 222 <td><a href="#HelpTabWidget.shallShutDown">shallShutDown</a></td>
199 <td>Public method to check, if the application should be shut down.</td> 223 <td>Public method to check, if the application should be shut down.</td>
200 </tr><tr> 224 </tr><tr>
201 <td><a href="#HelpTabWidget.stackedUrlBar">stackedUrlBar</a></td> 225 <td><a href="#HelpTabWidget.stackedUrlBar">stackedUrlBar</a></td>
214 </p><dl> 238 </p><dl>
215 <dt><i>parent</i></dt> 239 <dt><i>parent</i></dt>
216 <dd> 240 <dd>
217 reference to the parent widget (QWidget) 241 reference to the parent widget (QWidget)
218 </dd> 242 </dd>
243 </dl><a NAME="HelpTabWidget.__aboutToShowClosedTabsMenu" ID="HelpTabWidget.__aboutToShowClosedTabsMenu"></a>
244 <h4>HelpTabWidget.__aboutToShowClosedTabsMenu</h4>
245 <b>__aboutToShowClosedTabsMenu</b>(<i></i>)
246 <p>
247 Private slot to populate the closed tabs menu.
248 </p><a NAME="HelpTabWidget.__closedTabAvailable" ID="HelpTabWidget.__closedTabAvailable"></a>
249 <h4>HelpTabWidget.__closedTabAvailable</h4>
250 <b>__closedTabAvailable</b>(<i>avail</i>)
251 <p>
252 Private slot to handle changes of the availability of closed tabs.
253 </p><dl>
254 <dt><i>avail</i></dt>
255 <dd>
256 flag indicating the availability of closed tabs (boolean)
257 </dd>
219 </dl><a NAME="HelpTabWidget.__currentChanged" ID="HelpTabWidget.__currentChanged"></a> 258 </dl><a NAME="HelpTabWidget.__currentChanged" ID="HelpTabWidget.__currentChanged"></a>
220 <h4>HelpTabWidget.__currentChanged</h4> 259 <h4>HelpTabWidget.__currentChanged</h4>
221 <b>__currentChanged</b>(<i>index</i>) 260 <b>__currentChanged</b>(<i>index</i>)
222 <p> 261 <p>
223 Private slot to handle an index change. 262 Private slot to handle an index change.
448 </p><dl> 487 </p><dl>
449 <dt>Returns:</dt> 488 <dt>Returns:</dt>
450 <dd> 489 <dd>
451 list of references to browsers (list of HelpBrowser) 490 list of references to browsers (list of HelpBrowser)
452 </dd> 491 </dd>
453 </dl><a NAME="HelpTabWidget.closeAllBrowsers" ID="HelpTabWidget.closeAllBrowsers"></a> 492 </dl><a NAME="HelpTabWidget.canRestoreClosedTab" ID="HelpTabWidget.canRestoreClosedTab"></a>
493 <h4>HelpTabWidget.canRestoreClosedTab</h4>
494 <b>canRestoreClosedTab</b>(<i></i>)
495 <p>
496 Public method to check, if closed tabs can be restored.
497 </p><dl>
498 <dt>Returns:</dt>
499 <dd>
500 flag indicating that closed tabs can be restored (boolean)
501 </dd>
502 </dl><a NAME="HelpTabWidget.clearClosedTabsList" ID="HelpTabWidget.clearClosedTabsList"></a>
503 <h4>HelpTabWidget.clearClosedTabsList</h4>
504 <b>clearClosedTabsList</b>(<i></i>)
505 <p>
506 Public slot to clear the list of closed tabs.
507 </p><a NAME="HelpTabWidget.closeAllBrowsers" ID="HelpTabWidget.closeAllBrowsers"></a>
454 <h4>HelpTabWidget.closeAllBrowsers</h4> 508 <h4>HelpTabWidget.closeAllBrowsers</h4>
455 <b>closeAllBrowsers</b>(<i></i>) 509 <b>closeAllBrowsers</b>(<i></i>)
456 <p> 510 <p>
457 Public slot called to handle the close all action. 511 Public slot called to handle the close all action.
458 </p><a NAME="HelpTabWidget.closeBrowser" ID="HelpTabWidget.closeBrowser"></a> 512 </p><a NAME="HelpTabWidget.closeBrowser" ID="HelpTabWidget.closeBrowser"></a>
468 </p><dl> 522 </p><dl>
469 <dt><i>index</i></dt> 523 <dt><i>index</i></dt>
470 <dd> 524 <dd>
471 index of browser to close (integer) 525 index of browser to close (integer)
472 </dd> 526 </dd>
527 </dl><a NAME="HelpTabWidget.closedTabsManager" ID="HelpTabWidget.closedTabsManager"></a>
528 <h4>HelpTabWidget.closedTabsManager</h4>
529 <b>closedTabsManager</b>(<i></i>)
530 <p>
531 Public slot to get a reference to the closed tabs manager.
532 </p><dl>
533 <dt>Returns:</dt>
534 <dd>
535 reference to the closed tabs manager (ClosedTabsManager)
536 </dd>
473 </dl><a NAME="HelpTabWidget.currentBrowser" ID="HelpTabWidget.currentBrowser"></a> 537 </dl><a NAME="HelpTabWidget.currentBrowser" ID="HelpTabWidget.currentBrowser"></a>
474 <h4>HelpTabWidget.currentBrowser</h4> 538 <h4>HelpTabWidget.currentBrowser</h4>
475 <b>currentBrowser</b>(<i></i>) 539 <b>currentBrowser</b>(<i></i>)
476 <p> 540 <p>
477 Public method to get a reference to the current browser. 541 Public method to get a reference to the current browser.
500 <dd> 564 <dd>
501 dictionary with tab id as key and host/namespace as value 565 dictionary with tab id as key and host/namespace as value
502 </dd> 566 </dd>
503 </dl><a NAME="HelpTabWidget.newBrowser" ID="HelpTabWidget.newBrowser"></a> 567 </dl><a NAME="HelpTabWidget.newBrowser" ID="HelpTabWidget.newBrowser"></a>
504 <h4>HelpTabWidget.newBrowser</h4> 568 <h4>HelpTabWidget.newBrowser</h4>
505 <b>newBrowser</b>(<i>link=None, requestData=None</i>) 569 <b>newBrowser</b>(<i>link=None, requestData=None, position=-1</i>)
506 <p> 570 <p>
507 Public method to create a new web browser tab. 571 Public method to create a new web browser tab.
508 </p><dl> 572 </p><dl>
509 <dt><i>link</i></dt> 573 <dt><i>link</i></dt>
510 <dd> 574 <dd>
511 link to be shown (string or QUrl) 575 link to be shown (string or QUrl)
512 </dd><dt><i>requestData</i></dt> 576 </dd><dt><i>requestData</i></dt>
513 <dd> 577 <dd>
514 tuple containing the request data (QNetworkRequest, 578 tuple containing the request data (QNetworkRequest,
515 QNetworkAccessManager.Operation, QByteArray) 579 QNetworkAccessManager.Operation, QByteArray)
580 </dd><dt><i>position=</i></dt>
581 <dd>
582 position to create the new tab at or -1 to add it to the end
583 (integer)
516 </dd> 584 </dd>
517 </dl><a NAME="HelpTabWidget.preferencesChanged" ID="HelpTabWidget.preferencesChanged"></a> 585 </dl><a NAME="HelpTabWidget.preferencesChanged" ID="HelpTabWidget.preferencesChanged"></a>
518 <h4>HelpTabWidget.preferencesChanged</h4> 586 <h4>HelpTabWidget.preferencesChanged</h4>
519 <b>preferencesChanged</b>(<i></i>) 587 <b>preferencesChanged</b>(<i></i>)
520 <p> 588 <p>
547 </p><dl> 615 </p><dl>
548 <dt><i>browser</i></dt> 616 <dt><i>browser</i></dt>
549 <dd> 617 <dd>
550 reference to the browser to be printed (HelpBrowserWV) 618 reference to the browser to be printed (HelpBrowserWV)
551 </dd> 619 </dd>
552 </dl><a NAME="HelpTabWidget.shallShutDown" ID="HelpTabWidget.shallShutDown"></a> 620 </dl><a NAME="HelpTabWidget.reloadAllBrowsers" ID="HelpTabWidget.reloadAllBrowsers"></a>
621 <h4>HelpTabWidget.reloadAllBrowsers</h4>
622 <b>reloadAllBrowsers</b>(<i></i>)
623 <p>
624 Public slot to reload all browsers.
625 </p><a NAME="HelpTabWidget.restoreAllClosedTabs" ID="HelpTabWidget.restoreAllClosedTabs"></a>
626 <h4>HelpTabWidget.restoreAllClosedTabs</h4>
627 <b>restoreAllClosedTabs</b>(<i></i>)
628 <p>
629 Public slot to restore all closed tabs.
630 </p><a NAME="HelpTabWidget.restoreClosedTab" ID="HelpTabWidget.restoreClosedTab"></a>
631 <h4>HelpTabWidget.restoreClosedTab</h4>
632 <b>restoreClosedTab</b>(<i></i>)
633 <p>
634 Public slot to restore the most recently closed tab.
635 </p><a NAME="HelpTabWidget.shallShutDown" ID="HelpTabWidget.shallShutDown"></a>
553 <h4>HelpTabWidget.shallShutDown</h4> 636 <h4>HelpTabWidget.shallShutDown</h4>
554 <b>shallShutDown</b>(<i></i>) 637 <b>shallShutDown</b>(<i></i>)
555 <p> 638 <p>
556 Public method to check, if the application should be shut down. 639 Public method to check, if the application should be shut down.
557 </p><dl> 640 </p><dl>

eric ide

mercurial