diff -r bc6196164237 -r 0d9daebf5b8c Documentation/Source/eric4.Helpviewer.HelpIndexWidget.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric4.Helpviewer.HelpIndexWidget.html Mon Dec 28 16:18:43 2009 +0000
@@ -0,0 +1,152 @@
+<?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>eric4.Helpviewer.HelpIndexWidget</title>
+<style>
+body {
+ background:white;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #4FA4FF; }
+h2 { color: white; background: #4FA4FF; }
+h3 { color: white; background: #00557F; }
+h4 { color: white; background: #00557F; }
+
+a { color: #AA5500; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric4.Helpviewer.HelpIndexWidget</h1>
+<p>
+Module implementing a window for showing the QtHelp index.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#HelpIndexWidget">HelpIndexWidget</a></td>
+<td>Class implementing a window for showing the QtHelp index.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="HelpIndexWidget" ID="HelpIndexWidget"></a>
+<h2>HelpIndexWidget</h2>
+<p>
+ Class implementing a window for showing the QtHelp index.
+</p><h4>Signals</h4>
+<dl>
+<dt>escapePressed()</dt>
+<dd>
+emitted when the ESC key was pressed
+</dd><dt>linkActivated(const QUrl&)</dt>
+<dd>
+emitted when an index entry is activated
+</dd>
+</dl>
+<h3>Derived from</h3>
+QWidget
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td>
+<td>Private slot to enable the search edit.</td>
+</tr><tr>
+<td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td>
+<td>Private slot to enable the search edit.</td>
+</tr><tr>
+<td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td>
+<td>Private slot to filter the indices according to the given filter.</td>
+</tr><tr>
+<td><a href="#HelpIndexWidget.eventFilter">eventFilter</a></td>
+<td>Public method called to filter the event queue.</td>
+</tr><tr>
+<td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td>
+<td>Protected method handling focus in events.</td>
+</tr>
+</table>
+<a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a>
+<h4>HelpIndexWidget (Constructor)</h4>
+<b>HelpIndexWidget</b>(<i>engine, mainWindow, parent = None</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>engine</i></dt>
+<dd>
+reference to the help engine (QHelpEngine)
+</dd><dt><i>mainWindow</i></dt>
+<dd>
+reference to the main window object (QMainWindow)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a>
+<h4>HelpIndexWidget.__disableSearchEdit</h4>
+<b>__disableSearchEdit</b>(<i></i>)
+<p>
+ Private slot to enable the search edit.
+</p><a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a>
+<h4>HelpIndexWidget.__enableSearchEdit</h4>
+<b>__enableSearchEdit</b>(<i></i>)
+<p>
+ Private slot to enable the search edit.
+</p><a NAME="HelpIndexWidget.__filterIndices" ID="HelpIndexWidget.__filterIndices"></a>
+<h4>HelpIndexWidget.__filterIndices</h4>
+<b>__filterIndices</b>(<i>filter</i>)
+<p>
+ Private slot to filter the indices according to the given filter.
+</p><dl>
+<dt><i>filter</i></dt>
+<dd>
+filter to be used (string)
+</dd>
+</dl><a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a>
+<h4>HelpIndexWidget.eventFilter</h4>
+<b>eventFilter</b>(<i>watched, event</i>)
+<p>
+ Public method called to filter the event queue.
+</p><dl>
+<dt><i>watched</i></dt>
+<dd>
+the QObject being watched (QObject)
+</dd><dt><i>event</i></dt>
+<dd>
+the event that occurred (QEvent)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating whether the event was handled (boolean)
+</dd>
+</dl><a NAME="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a>
+<h4>HelpIndexWidget.focusInEvent</h4>
+<b>focusInEvent</b>(<i>evt</i>)
+<p>
+ Protected method handling focus in events.
+</p><dl>
+<dt><i>evt</i></dt>
+<dd>
+reference to the focus event object (QFocusEvent)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
