--- a/Documentation/Source/eric5.Helpviewer.HelpWindow.html Sat Aug 20 16:28:25 2011 +0200
+++ b/Documentation/Source/eric5.Helpviewer.HelpWindow.html Sat Aug 20 16:30:49 2011 +0200
@@ -44,7 +44,7 @@
<h2>HelpWindow</h2>
<p>
Class implementing the web browser main window.
-</p><h4>Signals</h4>
+</p><h3>Signals</h3>
<dl>
<dt>helpClosed()</dt>
<dd>
@@ -61,12 +61,43 @@
<table>
<tr><td>_adblockManager</td></tr><tr><td>_bookmarksManager</td></tr><tr><td>_cookieJar</td></tr><tr><td>_downloadManager</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>
</table>
+<h3>Class Methods</h3>
+<table>
+<tr>
+<td><a href="#HelpWindow.adblockManager">adblockManager</a></td>
+<td>Class method to get a reference to the AdBlock manager.</td>
+</tr><tr>
+<td><a href="#HelpWindow.bookmarksManager">bookmarksManager</a></td>
+<td>Class method to get a reference to the bookmarks manager.</td>
+</tr><tr>
+<td><a href="#HelpWindow.cookieJar">cookieJar</a></td>
+<td>Class method to get a reference to the cookie jar.</td>
+</tr><tr>
+<td><a href="#HelpWindow.downloadManager">downloadManager</a></td>
+<td>Class method to get a reference to the download manager.</td>
+</tr><tr>
+<td><a href="#HelpWindow.helpEngine">helpEngine</a></td>
+<td>Class method to get a reference to the help engine.</td>
+</tr><tr>
+<td><a href="#HelpWindow.historyManager">historyManager</a></td>
+<td>Class method to get a reference to the history manager.</td>
+</tr><tr>
+<td><a href="#HelpWindow.icon">icon</a></td>
+<td>Class method to get the icon for an URL.</td>
+</tr><tr>
+<td><a href="#HelpWindow.mainWindow">mainWindow</a></td>
+<td>Class method to get a reference to the main window.</td>
+</tr><tr>
+<td><a href="#HelpWindow.networkAccessManager">networkAccessManager</a></td>
+<td>Class method to get a reference to the network access manager.</td>
+</tr><tr>
+<td><a href="#HelpWindow.passwordManager">passwordManager</a></td>
+<td>Class method to get a reference to the password manager.</td>
+</tr>
+</table>
<h3>Methods</h3>
<table>
<tr>
-<td><a href="#HelpWindow.__init__">HelpWindow</a></td>
-<td>Constructor</td>
-</tr><tr>
<td><a href="#HelpWindow.__about">__about</a></td>
<td>Private slot to show the about information.</td>
</tr><tr>
@@ -121,9 +152,6 @@
<td><a href="#HelpWindow.__forward">__forward</a></td>
<td>Private slot called to handle the forward action.</td>
</tr><tr>
-<td><a href="#HelpWindow.__getWebIcon">__getWebIcon</a></td>
-<td>Private static method to fetch the icon for a URL.</td>
-</tr><tr>
<td><a href="#HelpWindow.__hideIndexWindow">__hideIndexWindow</a></td>
<td>Private method to hide the index window.</td>
</tr><tr>
@@ -319,15 +347,9 @@
<td><a href="#HelpWindow.__zoomTextOnly">__zoomTextOnly</a></td>
<td>Private slot called to handle the zoom text only action.</td>
</tr><tr>
-<td><a href="#HelpWindow.adblockManager">adblockManager</a></td>
-<td>Class method to get a reference to the AdBlock manager.</td>
-</tr><tr>
<td><a href="#HelpWindow.bookmarkAll">bookmarkAll</a></td>
<td>Public slot to bookmark all open tabs.</td>
</tr><tr>
-<td><a href="#HelpWindow.bookmarksManager">bookmarksManager</a></td>
-<td>Class method to get a reference to the bookmarks manager.</td>
-</tr><tr>
<td><a href="#HelpWindow.browserAt">browserAt</a></td>
<td>Public method to get a reference to the help browser with the given index.</td>
</tr><tr>
@@ -337,15 +359,9 @@
<td><a href="#HelpWindow.closeEvent">closeEvent</a></td>
<td>Private event handler for the close event.</td>
</tr><tr>
-<td><a href="#HelpWindow.cookieJar">cookieJar</a></td>
-<td>Class method to get a reference to the cookie jar.</td>
-</tr><tr>
<td><a href="#HelpWindow.currentBrowser">currentBrowser</a></td>
<td>Public method to get a reference to the current help browser.</td>
</tr><tr>
-<td><a href="#HelpWindow.downloadManager">downloadManager</a></td>
-<td>Class method to get a reference to the download manager.</td>
-</tr><tr>
<td><a href="#HelpWindow.eventKeyboardModifiers">eventKeyboardModifiers</a></td>
<td>Public method to get the last recorded keyboard modifiers.</td>
</tr><tr>
@@ -358,27 +374,12 @@
<td><a href="#HelpWindow.getSourceFileList">getSourceFileList</a></td>
<td>Public method to get a list of all opened source files.</td>
</tr><tr>
-<td><a href="#HelpWindow.helpEngine">helpEngine</a></td>
-<td>Class method to get a reference to the help engine.</td>
-</tr><tr>
-<td><a href="#HelpWindow.historyManager">historyManager</a></td>
-<td>Class method to get a reference to the history manager.</td>
-</tr><tr>
-<td><a href="#HelpWindow.icon">icon</a></td>
-<td>Class method to get the icon for an URL.</td>
-</tr><tr>
-<td><a href="#HelpWindow.mainWindow">mainWindow</a></td>
-<td>Class method to get a reference to the main window.</td>
-</tr><tr>
<td><a href="#HelpWindow.masterPasswordChanged">masterPasswordChanged</a></td>
<td>Public slot to handle the change of the master password.</td>
</tr><tr>
<td><a href="#HelpWindow.mousePressEvent">mousePressEvent</a></td>
<td>Protected method called by a mouse press event.</td>
</tr><tr>
-<td><a href="#HelpWindow.networkAccessManager">networkAccessManager</a></td>
-<td>Class method to get a reference to the network access manager.</td>
-</tr><tr>
<td><a href="#HelpWindow.newTab">newTab</a></td>
<td>Public slot called to open a new help window tab.</td>
</tr><tr>
@@ -394,9 +395,6 @@
<td><a href="#HelpWindow.openUrlNewTab">openUrlNewTab</a></td>
<td>Public slot to load a URL from the bookmarks menu or bookmarks toolbar in a new tab.</td>
</tr><tr>
-<td><a href="#HelpWindow.passwordManager">passwordManager</a></td>
-<td>Class method to get a reference to the password manager.</td>
-</tr><tr>
<td><a href="#HelpWindow.preferencesChanged">preferencesChanged</a></td>
<td>Public slot to handle a change of preferences.</td>
</tr><tr>
@@ -431,7 +429,119 @@
<td>Public method to set the privacy mode.</td>
</tr>
</table>
-<a NAME="HelpWindow.__init__" ID="HelpWindow.__init__"></a>
+<h3>Static Methods</h3>
+<table>
+<tr>
+<td><a href="#HelpWindow.__getWebIcon">__getWebIcon</a></td>
+<td>Private static method to fetch the icon for a URL.</td>
+</tr>
+</table>
+<a NAME="HelpWindow.adblockManager" ID="HelpWindow.adblockManager"></a>
+<h4>HelpWindow.adblockManager (class method)</h4>
+<b>adblockManager</b>(<i></i>)
+<p>
+ Class method to get a reference to the AdBlock manager.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the AdBlock manager (AdBlockManager)
+</dd>
+</dl><a NAME="HelpWindow.bookmarksManager" ID="HelpWindow.bookmarksManager"></a>
+<h4>HelpWindow.bookmarksManager (class method)</h4>
+<b>bookmarksManager</b>(<i></i>)
+<p>
+ Class method to get a reference to the bookmarks manager.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the bookmarks manager (BookmarksManager)
+</dd>
+</dl><a NAME="HelpWindow.cookieJar" ID="HelpWindow.cookieJar"></a>
+<h4>HelpWindow.cookieJar (class method)</h4>
+<b>cookieJar</b>(<i></i>)
+<p>
+ Class method to get a reference to the cookie jar.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the cookie jar (CookieJar)
+</dd>
+</dl><a NAME="HelpWindow.downloadManager" ID="HelpWindow.downloadManager"></a>
+<h4>HelpWindow.downloadManager (class method)</h4>
+<b>downloadManager</b>(<i></i>)
+<p>
+ Class method to get a reference to the download manager.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the password manager (DownloadManager)
+</dd>
+</dl><a NAME="HelpWindow.helpEngine" ID="HelpWindow.helpEngine"></a>
+<h4>HelpWindow.helpEngine (class method)</h4>
+<b>helpEngine</b>(<i></i>)
+<p>
+ Class method to get a reference to the help engine.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the help engine (QHelpEngine)
+</dd>
+</dl><a NAME="HelpWindow.historyManager" ID="HelpWindow.historyManager"></a>
+<h4>HelpWindow.historyManager (class method)</h4>
+<b>historyManager</b>(<i></i>)
+<p>
+ Class method to get a reference to the history manager.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the history manager (HistoryManager)
+</dd>
+</dl><a NAME="HelpWindow.icon" ID="HelpWindow.icon"></a>
+<h4>HelpWindow.icon (class method)</h4>
+<b>icon</b>(<i>url</i>)
+<p>
+ Class method to get the icon for an URL.
+</p><dl>
+<dt><i>url</i></dt>
+<dd>
+URL to get icon for (QUrl)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+icon for the URL (QIcon)
+</dd>
+</dl><a NAME="HelpWindow.mainWindow" ID="HelpWindow.mainWindow"></a>
+<h4>HelpWindow.mainWindow (class method)</h4>
+<b>mainWindow</b>(<i></i>)
+<p>
+ Class method to get a reference to the main window.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the main window (HelpWindow)
+</dd>
+</dl><a NAME="HelpWindow.networkAccessManager" ID="HelpWindow.networkAccessManager"></a>
+<h4>HelpWindow.networkAccessManager (class method)</h4>
+<b>networkAccessManager</b>(<i></i>)
+<p>
+ Class method to get a reference to the network access manager.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the network access manager (NetworkAccessManager)
+</dd>
+</dl><a NAME="HelpWindow.passwordManager" ID="HelpWindow.passwordManager"></a>
+<h4>HelpWindow.passwordManager (class method)</h4>
+<b>passwordManager</b>(<i></i>)
+<p>
+ Class method to get a reference to the password manager.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the password manager (PasswordManager)
+</dd>
+</dl><a NAME="HelpWindow.__init__" ID="HelpWindow.__init__"></a>
<h4>HelpWindow (Constructor)</h4>
<b>HelpWindow</b>(<i>home, path, parent, name, fromEric=False, initShortcutsOnly=False, searchWord=None</i>)
<p>
@@ -578,22 +688,7 @@
<b>__forward</b>(<i></i>)
<p>
Private slot called to handle the forward action.
-</p><a NAME="HelpWindow.__getWebIcon" ID="HelpWindow.__getWebIcon"></a>
-<h4>HelpWindow.__getWebIcon</h4>
-<b>__getWebIcon</b>(<i></i>)
-<p>
- Private static method to fetch the icon for a URL.
-</p><dl>
-<dt><i>url</i></dt>
-<dd>
-URL to get icon for (QUrl)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-icon for the URL (QIcon)
-</dd>
-</dl><a NAME="HelpWindow.__hideIndexWindow" ID="HelpWindow.__hideIndexWindow"></a>
+</p><a NAME="HelpWindow.__hideIndexWindow" ID="HelpWindow.__hideIndexWindow"></a>
<h4>HelpWindow.__hideIndexWindow</h4>
<b>__hideIndexWindow</b>(<i></i>)
<p>
@@ -994,32 +1089,12 @@
<dd>
flag indicating to zoom text only (boolean)
</dd>
-</dl><a NAME="HelpWindow.adblockManager" ID="HelpWindow.adblockManager"></a>
-<h4>HelpWindow.adblockManager</h4>
-<b>adblockManager</b>(<i></i>)
-<p>
- Class method to get a reference to the AdBlock manager.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-reference to the AdBlock manager (AdBlockManager)
-</dd>
</dl><a NAME="HelpWindow.bookmarkAll" ID="HelpWindow.bookmarkAll"></a>
<h4>HelpWindow.bookmarkAll</h4>
<b>bookmarkAll</b>(<i></i>)
<p>
Public slot to bookmark all open tabs.
-</p><a NAME="HelpWindow.bookmarksManager" ID="HelpWindow.bookmarksManager"></a>
-<h4>HelpWindow.bookmarksManager</h4>
-<b>bookmarksManager</b>(<i></i>)
-<p>
- Class method to get a reference to the bookmarks manager.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-reference to the bookmarks manager (BookmarksManager)
-</dd>
-</dl><a NAME="HelpWindow.browserAt" ID="HelpWindow.browserAt"></a>
+</p><a NAME="HelpWindow.browserAt" ID="HelpWindow.browserAt"></a>
<h4>HelpWindow.browserAt</h4>
<b>browserAt</b>(<i>index</i>)
<p>
@@ -1056,16 +1131,6 @@
<br />This event is simply accepted after the history has been
saved and all window references have been deleted.
</dd>
-</dl><a NAME="HelpWindow.cookieJar" ID="HelpWindow.cookieJar"></a>
-<h4>HelpWindow.cookieJar</h4>
-<b>cookieJar</b>(<i></i>)
-<p>
- Class method to get a reference to the cookie jar.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-reference to the cookie jar (CookieJar)
-</dd>
</dl><a NAME="HelpWindow.currentBrowser" ID="HelpWindow.currentBrowser"></a>
<h4>HelpWindow.currentBrowser</h4>
<b>currentBrowser</b>(<i></i>)
@@ -1076,16 +1141,6 @@
<dd>
reference to the current help browser (HelpBrowser)
</dd>
-</dl><a NAME="HelpWindow.downloadManager" ID="HelpWindow.downloadManager"></a>
-<h4>HelpWindow.downloadManager</h4>
-<b>downloadManager</b>(<i></i>)
-<p>
- Class method to get a reference to the download manager.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-reference to the password manager (DownloadManager)
-</dd>
</dl><a NAME="HelpWindow.eventKeyboardModifiers" ID="HelpWindow.eventKeyboardModifiers"></a>
<h4>HelpWindow.eventKeyboardModifiers</h4>
<b>eventKeyboardModifiers</b>(<i></i>)
@@ -1126,51 +1181,6 @@
<dd>
dictionary with tab id as key and host/namespace as value
</dd>
-</dl><a NAME="HelpWindow.helpEngine" ID="HelpWindow.helpEngine"></a>
-<h4>HelpWindow.helpEngine</h4>
-<b>helpEngine</b>(<i></i>)
-<p>
- Class method to get a reference to the help engine.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-reference to the help engine (QHelpEngine)
-</dd>
-</dl><a NAME="HelpWindow.historyManager" ID="HelpWindow.historyManager"></a>
-<h4>HelpWindow.historyManager</h4>
-<b>historyManager</b>(<i></i>)
-<p>
- Class method to get a reference to the history manager.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-reference to the history manager (HistoryManager)
-</dd>
-</dl><a NAME="HelpWindow.icon" ID="HelpWindow.icon"></a>
-<h4>HelpWindow.icon</h4>
-<b>icon</b>(<i>url</i>)
-<p>
- Class method to get the icon for an URL.
-</p><dl>
-<dt><i>url</i></dt>
-<dd>
-URL to get icon for (QUrl)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-icon for the URL (QIcon)
-</dd>
-</dl><a NAME="HelpWindow.mainWindow" ID="HelpWindow.mainWindow"></a>
-<h4>HelpWindow.mainWindow</h4>
-<b>mainWindow</b>(<i></i>)
-<p>
- Class method to get a reference to the main window.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-reference to the main window (HelpWindow)
-</dd>
</dl><a NAME="HelpWindow.masterPasswordChanged" ID="HelpWindow.masterPasswordChanged"></a>
<h4>HelpWindow.masterPasswordChanged</h4>
<b>masterPasswordChanged</b>(<i>oldPassword, newPassword</i>)
@@ -1194,16 +1204,6 @@
<dd>
reference to the mouse event (QMouseEvent)
</dd>
-</dl><a NAME="HelpWindow.networkAccessManager" ID="HelpWindow.networkAccessManager"></a>
-<h4>HelpWindow.networkAccessManager</h4>
-<b>networkAccessManager</b>(<i></i>)
-<p>
- Class method to get a reference to the network access manager.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-reference to the network access manager (NetworkAccessManager)
-</dd>
</dl><a NAME="HelpWindow.newTab" ID="HelpWindow.newTab"></a>
<h4>HelpWindow.newTab</h4>
<b>newTab</b>(<i>link=None, requestData=None</i>)
@@ -1266,16 +1266,6 @@
<dd>
title of the bookmark (string)
</dd>
-</dl><a NAME="HelpWindow.passwordManager" ID="HelpWindow.passwordManager"></a>
-<h4>HelpWindow.passwordManager</h4>
-<b>passwordManager</b>(<i></i>)
-<p>
- Class method to get a reference to the password manager.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-reference to the password manager (PasswordManager)
-</dd>
</dl><a NAME="HelpWindow.preferencesChanged" ID="HelpWindow.preferencesChanged"></a>
<h4>HelpWindow.preferencesChanged</h4>
<b>preferencesChanged</b>(<i></i>)
@@ -1381,6 +1371,21 @@
<dd>
flag indicating the privacy state (boolean)
</dd>
+</dl><a NAME="HelpWindow.__getWebIcon" ID="HelpWindow.__getWebIcon"></a>
+<h4>HelpWindow.__getWebIcon (static)</h4>
+<b>__getWebIcon</b>(<i></i>)
+<p>
+ Private static method to fetch the icon for a URL.
+</p><dl>
+<dt><i>url</i></dt>
+<dd>
+URL to get icon for (QUrl)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+icon for the URL (QIcon)
+</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
