diff -r 4e4c729e86cf -r 265c31231d9d Documentation/Source/eric5.Helpviewer.HelpTabWidget.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Helpviewer.HelpTabWidget.html Sat Sep 25 20:25:16 2010 +0200
@@ -0,0 +1,468 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric5.Helpviewer.HelpTabWidget</title>
+<style>
+body {
+ background: #EDECE6;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.Helpviewer.HelpTabWidget</h1>
+<p>
+Module implementing the central widget showing the web pages.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#HelpTabWidget">HelpTabWidget</a></td>
+<td>Class implementing the central widget showing the web pages.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="HelpTabWidget" ID="HelpTabWidget"></a>
+<h2>HelpTabWidget</h2>
+<p>
+ Class implementing the central widget showing the web pages.
+</p>
+<h3>Derived from</h3>
+E5TabWidget
+<h3>Class Attributes</h3>
+<table>
+<tr><td>showMessage</td></tr><tr><td>sourceChanged</td></tr><tr><td>titleChanged</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#HelpTabWidget.__init__">HelpTabWidget</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__elide">__elide</a></td>
+<td>Private method to elide some text.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__iconChanged">__iconChanged</a></td>
+<td>Private slot to handle the icon change.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__initTabContextMenu">__initTabContextMenu</a></td>
+<td>Private mezhod to create the tab context menu.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__loadFinished">__loadFinished</a></td>
+<td>Private method to handle the loadFinished signal.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__loadStarted">__loadStarted</a></td>
+<td>Private method to handle the loadStarted signal.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__navigationMenuTriggered">__navigationMenuTriggered</a></td>
+<td>Private slot called to handle the navigation button menu selection.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__printPdfRequested">__printPdfRequested</a></td>
+<td>Private slot to handle a print to PDF request.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__printPreview">__printPreview</a></td>
+<td>Private slot to generate a print preview.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__printRequested">__printRequested</a></td>
+<td>Private slot to handle a print request.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__showContextMenu">__showContextMenu</a></td>
+<td>Private slot to show the tab context menu.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__showNavigationMenu">__showNavigationMenu</a></td>
+<td>Private slot to show the navigation button menu.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__sourceChanged">__sourceChanged</a></td>
+<td>Private slot to handle a change of a browsers source.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__tabContextMenuClone">__tabContextMenuClone</a></td>
+<td>Private method to clone the selected tab.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__tabContextMenuClose">__tabContextMenuClose</a></td>
+<td>Private method to close the selected tab.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__tabContextMenuCloseOthers">__tabContextMenuCloseOthers</a></td>
+<td>Private slot to close all other tabs.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__tabContextMenuMoveLeft">__tabContextMenuMoveLeft</a></td>
+<td>Private method to move a tab one position to the left.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__tabContextMenuMoveRight">__tabContextMenuMoveRight</a></td>
+<td>Private method to move a tab one position to the right.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__tabContextMenuPrint">__tabContextMenuPrint</a></td>
+<td>Private method to print the selected tab.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__tabContextMenuPrintPdf">__tabContextMenuPrintPdf</a></td>
+<td>Private method to print the selected tab as PDF.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__tabContextMenuPrintPreview">__tabContextMenuPrintPreview</a></td>
+<td>Private method to show a print preview of the selected tab.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__titleChanged">__titleChanged</a></td>
+<td>Private slot to handle a change of a browsers title.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.__windowCloseRequested">__windowCloseRequested</a></td>
+<td>Private slot to handle the windowCloseRequested signal of a browser.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.browserAt">browserAt</a></td>
+<td>Public method to get a reference to the browser with the given index.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.browsers">browsers</a></td>
+<td>Public method to get a list of references to all browsers.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.closeAllBrowsers">closeAllBrowsers</a></td>
+<td>Public slot called to handle the close all action.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.closeBrowser">closeBrowser</a></td>
+<td>Public slot called to handle the close action.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.closeBrowserAt">closeBrowserAt</a></td>
+<td>Public slot to close a browser based on it's index.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.currentBrowser">currentBrowser</a></td>
+<td>Public method to get a reference to the current browser.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.getSourceFileList">getSourceFileList</a></td>
+<td>Public method to get a list of all opened source files.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.newBrowser">newBrowser</a></td>
+<td>Public method to create a new web browser tab.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.preferencesChanged">preferencesChanged</a></td>
+<td>Public slot to handle a change of preferences.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.printBrowser">printBrowser</a></td>
+<td>Public slot called to print the displayed page.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.printBrowserPdf">printBrowserPdf</a></td>
+<td>Public slot called to print the displayed page to PDF.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.printPreviewBrowser">printPreviewBrowser</a></td>
+<td>Public slot called to show a print preview of the displayed file.</td>
+</tr><tr>
+<td><a href="#HelpTabWidget.shallShutDown">shallShutDown</a></td>
+<td>Public method to check, if the application should be shut down.</td>
+</tr>
+</table>
+<a NAME="HelpTabWidget.__init__" ID="HelpTabWidget.__init__"></a>
+<h4>HelpTabWidget (Constructor)</h4>
+<b>HelpTabWidget</b>(<i>parent</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="HelpTabWidget.__elide" ID="HelpTabWidget.__elide"></a>
+<h4>HelpTabWidget.__elide</h4>
+<b>__elide</b>(<i>txt, mode = Qt.ElideRight, length = 40</i>)
+<p>
+ Private method to elide some text.
+</p><dl>
+<dt><i>txt</i></dt>
+<dd>
+text to be elided (string)
+</dd><dt><i>mode=</i></dt>
+<dd>
+elide mode (Qt.TextElideMode)
+</dd><dt><i>length=</i></dt>
+<dd>
+amount of characters to be used (integer)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+the elided text (string)
+</dd>
+</dl><a NAME="HelpTabWidget.__iconChanged" ID="HelpTabWidget.__iconChanged"></a>
+<h4>HelpTabWidget.__iconChanged</h4>
+<b>__iconChanged</b>(<i></i>)
+<p>
+ Private slot to handle the icon change.
+</p><a NAME="HelpTabWidget.__initTabContextMenu" ID="HelpTabWidget.__initTabContextMenu"></a>
+<h4>HelpTabWidget.__initTabContextMenu</h4>
+<b>__initTabContextMenu</b>(<i></i>)
+<p>
+ Private mezhod to create the tab context menu.
+</p><a NAME="HelpTabWidget.__loadFinished" ID="HelpTabWidget.__loadFinished"></a>
+<h4>HelpTabWidget.__loadFinished</h4>
+<b>__loadFinished</b>(<i>ok</i>)
+<p>
+ Private method to handle the loadFinished signal.
+</p><dl>
+<dt><i>ok</i></dt>
+<dd>
+flag indicating the result (boolean)
+</dd>
+</dl><a NAME="HelpTabWidget.__loadStarted" ID="HelpTabWidget.__loadStarted"></a>
+<h4>HelpTabWidget.__loadStarted</h4>
+<b>__loadStarted</b>(<i></i>)
+<p>
+ Private method to handle the loadStarted signal.
+</p><a NAME="HelpTabWidget.__navigationMenuTriggered" ID="HelpTabWidget.__navigationMenuTriggered"></a>
+<h4>HelpTabWidget.__navigationMenuTriggered</h4>
+<b>__navigationMenuTriggered</b>(<i>act</i>)
+<p>
+ Private slot called to handle the navigation button menu selection.
+</p><dl>
+<dt><i>act</i></dt>
+<dd>
+reference to the selected action (QAction)
+</dd>
+</dl><a NAME="HelpTabWidget.__printPdfRequested" ID="HelpTabWidget.__printPdfRequested"></a>
+<h4>HelpTabWidget.__printPdfRequested</h4>
+<b>__printPdfRequested</b>(<i>frame</i>)
+<p>
+ Private slot to handle a print to PDF request.
+</p><dl>
+<dt><i>frame</i></dt>
+<dd>
+reference to the frame to be printed (QWebFrame)
+</dd>
+</dl><a NAME="HelpTabWidget.__printPreview" ID="HelpTabWidget.__printPreview"></a>
+<h4>HelpTabWidget.__printPreview</h4>
+<b>__printPreview</b>(<i>printer</i>)
+<p>
+ Private slot to generate a print preview.
+</p><dl>
+<dt><i>printer</i></dt>
+<dd>
+reference to the printer object (QPrinter)
+</dd>
+</dl><a NAME="HelpTabWidget.__printRequested" ID="HelpTabWidget.__printRequested"></a>
+<h4>HelpTabWidget.__printRequested</h4>
+<b>__printRequested</b>(<i>frame</i>)
+<p>
+ Private slot to handle a print request.
+</p><dl>
+<dt><i>frame</i></dt>
+<dd>
+reference to the frame to be printed (QWebFrame)
+</dd>
+</dl><a NAME="HelpTabWidget.__showContextMenu" ID="HelpTabWidget.__showContextMenu"></a>
+<h4>HelpTabWidget.__showContextMenu</h4>
+<b>__showContextMenu</b>(<i>coord, index</i>)
+<p>
+ Private slot to show the tab context menu.
+</p><dl>
+<dt><i>coord</i></dt>
+<dd>
+the position of the mouse pointer (QPoint)
+</dd><dt><i>index</i></dt>
+<dd>
+index of the tab the menu is requested for (integer)
+</dd>
+</dl><a NAME="HelpTabWidget.__showNavigationMenu" ID="HelpTabWidget.__showNavigationMenu"></a>
+<h4>HelpTabWidget.__showNavigationMenu</h4>
+<b>__showNavigationMenu</b>(<i></i>)
+<p>
+ Private slot to show the navigation button menu.
+</p><a NAME="HelpTabWidget.__sourceChanged" ID="HelpTabWidget.__sourceChanged"></a>
+<h4>HelpTabWidget.__sourceChanged</h4>
+<b>__sourceChanged</b>(<i>url</i>)
+<p>
+ Private slot to handle a change of a browsers source.
+</p><dl>
+<dt><i>url</i></dt>
+<dd>
+URL of the new site (QUrl)
+</dd>
+</dl><a NAME="HelpTabWidget.__tabContextMenuClone" ID="HelpTabWidget.__tabContextMenuClone"></a>
+<h4>HelpTabWidget.__tabContextMenuClone</h4>
+<b>__tabContextMenuClone</b>(<i></i>)
+<p>
+ Private method to clone the selected tab.
+</p><a NAME="HelpTabWidget.__tabContextMenuClose" ID="HelpTabWidget.__tabContextMenuClose"></a>
+<h4>HelpTabWidget.__tabContextMenuClose</h4>
+<b>__tabContextMenuClose</b>(<i></i>)
+<p>
+ Private method to close the selected tab.
+</p><a NAME="HelpTabWidget.__tabContextMenuCloseOthers" ID="HelpTabWidget.__tabContextMenuCloseOthers"></a>
+<h4>HelpTabWidget.__tabContextMenuCloseOthers</h4>
+<b>__tabContextMenuCloseOthers</b>(<i></i>)
+<p>
+ Private slot to close all other tabs.
+</p><a NAME="HelpTabWidget.__tabContextMenuMoveLeft" ID="HelpTabWidget.__tabContextMenuMoveLeft"></a>
+<h4>HelpTabWidget.__tabContextMenuMoveLeft</h4>
+<b>__tabContextMenuMoveLeft</b>(<i></i>)
+<p>
+ Private method to move a tab one position to the left.
+</p><a NAME="HelpTabWidget.__tabContextMenuMoveRight" ID="HelpTabWidget.__tabContextMenuMoveRight"></a>
+<h4>HelpTabWidget.__tabContextMenuMoveRight</h4>
+<b>__tabContextMenuMoveRight</b>(<i></i>)
+<p>
+ Private method to move a tab one position to the right.
+</p><a NAME="HelpTabWidget.__tabContextMenuPrint" ID="HelpTabWidget.__tabContextMenuPrint"></a>
+<h4>HelpTabWidget.__tabContextMenuPrint</h4>
+<b>__tabContextMenuPrint</b>(<i></i>)
+<p>
+ Private method to print the selected tab.
+</p><a NAME="HelpTabWidget.__tabContextMenuPrintPdf" ID="HelpTabWidget.__tabContextMenuPrintPdf"></a>
+<h4>HelpTabWidget.__tabContextMenuPrintPdf</h4>
+<b>__tabContextMenuPrintPdf</b>(<i></i>)
+<p>
+ Private method to print the selected tab as PDF.
+</p><a NAME="HelpTabWidget.__tabContextMenuPrintPreview" ID="HelpTabWidget.__tabContextMenuPrintPreview"></a>
+<h4>HelpTabWidget.__tabContextMenuPrintPreview</h4>
+<b>__tabContextMenuPrintPreview</b>(<i></i>)
+<p>
+ Private method to show a print preview of the selected tab.
+</p><a NAME="HelpTabWidget.__titleChanged" ID="HelpTabWidget.__titleChanged"></a>
+<h4>HelpTabWidget.__titleChanged</h4>
+<b>__titleChanged</b>(<i>title</i>)
+<p>
+ Private slot to handle a change of a browsers title.
+</p><dl>
+<dt><i>title</i></dt>
+<dd>
+new title (string)
+</dd>
+</dl><a NAME="HelpTabWidget.__windowCloseRequested" ID="HelpTabWidget.__windowCloseRequested"></a>
+<h4>HelpTabWidget.__windowCloseRequested</h4>
+<b>__windowCloseRequested</b>(<i></i>)
+<p>
+ Private slot to handle the windowCloseRequested signal of a browser.
+</p><a NAME="HelpTabWidget.browserAt" ID="HelpTabWidget.browserAt"></a>
+<h4>HelpTabWidget.browserAt</h4>
+<b>browserAt</b>(<i>index</i>)
+<p>
+ Public method to get a reference to the browser with the given index.
+</p><dl>
+<dt><i>index</i></dt>
+<dd>
+index of the browser to get (integer)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the indexed browser (HelpBrowser)
+</dd>
+</dl><a NAME="HelpTabWidget.browsers" ID="HelpTabWidget.browsers"></a>
+<h4>HelpTabWidget.browsers</h4>
+<b>browsers</b>(<i></i>)
+<p>
+ Public method to get a list of references to all browsers.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of references to browsers (list of HelpBrowser)
+</dd>
+</dl><a NAME="HelpTabWidget.closeAllBrowsers" ID="HelpTabWidget.closeAllBrowsers"></a>
+<h4>HelpTabWidget.closeAllBrowsers</h4>
+<b>closeAllBrowsers</b>(<i></i>)
+<p>
+ Public slot called to handle the close all action.
+</p><a NAME="HelpTabWidget.closeBrowser" ID="HelpTabWidget.closeBrowser"></a>
+<h4>HelpTabWidget.closeBrowser</h4>
+<b>closeBrowser</b>(<i></i>)
+<p>
+ Public slot called to handle the close action.
+</p><a NAME="HelpTabWidget.closeBrowserAt" ID="HelpTabWidget.closeBrowserAt"></a>
+<h4>HelpTabWidget.closeBrowserAt</h4>
+<b>closeBrowserAt</b>(<i>index</i>)
+<p>
+ Public slot to close a browser based on it's index.
+</p><dl>
+<dt><i>index</i></dt>
+<dd>
+index of browser to close (integer)
+</dd>
+</dl><a NAME="HelpTabWidget.currentBrowser" ID="HelpTabWidget.currentBrowser"></a>
+<h4>HelpTabWidget.currentBrowser</h4>
+<b>currentBrowser</b>(<i></i>)
+<p>
+ Public method to get a reference to the current browser.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the current browser (HelpBrowser)
+</dd>
+</dl><a NAME="HelpTabWidget.getSourceFileList" ID="HelpTabWidget.getSourceFileList"></a>
+<h4>HelpTabWidget.getSourceFileList</h4>
+<b>getSourceFileList</b>(<i></i>)
+<p>
+ Public method to get a list of all opened source files.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+dictionary with tab id as key and host/namespace as value
+</dd>
+</dl><a NAME="HelpTabWidget.newBrowser" ID="HelpTabWidget.newBrowser"></a>
+<h4>HelpTabWidget.newBrowser</h4>
+<b>newBrowser</b>(<i>link = None</i>)
+<p>
+ Public method to create a new web browser tab.
+</p><dl>
+<dt><i>link</i></dt>
+<dd>
+link to be shown (string or QUrl)
+</dd>
+</dl><a NAME="HelpTabWidget.preferencesChanged" ID="HelpTabWidget.preferencesChanged"></a>
+<h4>HelpTabWidget.preferencesChanged</h4>
+<b>preferencesChanged</b>(<i></i>)
+<p>
+ Public slot to handle a change of preferences.
+</p><a NAME="HelpTabWidget.printBrowser" ID="HelpTabWidget.printBrowser"></a>
+<h4>HelpTabWidget.printBrowser</h4>
+<b>printBrowser</b>(<i>browser = None</i>)
+<p>
+ Public slot called to print the displayed page.
+</p><dl>
+<dt><i>browser</i></dt>
+<dd>
+reference to the browser to be printed (HelpBrowser)
+</dd>
+</dl><a NAME="HelpTabWidget.printBrowserPdf" ID="HelpTabWidget.printBrowserPdf"></a>
+<h4>HelpTabWidget.printBrowserPdf</h4>
+<b>printBrowserPdf</b>(<i>browser = None</i>)
+<p>
+ Public slot called to print the displayed page to PDF.
+</p><dl>
+<dt><i>browser</i></dt>
+<dd>
+reference to the browser to be printed (HelpBrowser)
+</dd>
+</dl><a NAME="HelpTabWidget.printPreviewBrowser" ID="HelpTabWidget.printPreviewBrowser"></a>
+<h4>HelpTabWidget.printPreviewBrowser</h4>
+<b>printPreviewBrowser</b>(<i>browser = None</i>)
+<p>
+ Public slot called to show a print preview of the displayed file.
+</p><dl>
+<dt><i>browser</i></dt>
+<dd>
+reference to the browser to be printed (HelpBrowserWV)
+</dd>
+</dl><a NAME="HelpTabWidget.shallShutDown" ID="HelpTabWidget.shallShutDown"></a>
+<h4>HelpTabWidget.shallShutDown</h4>
+<b>shallShutDown</b>(<i></i>)
+<p>
+ Public method to check, if the application should be shut down.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating a shut down (boolean)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
