--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Helpviewer.HelpSearchWidget.html Sat Jan 02 18:19:35 2010 +0000
@@ -0,0 +1,153 @@
+<?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.HelpSearchWidget</title>
+<style>
+b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n'
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.Helpviewer.HelpSearchWidget</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="#HelpSearchWidget">HelpSearchWidget</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="HelpSearchWidget" ID="HelpSearchWidget"></a>
+<h2>HelpSearchWidget</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 a search result 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="#HelpSearchWidget.__init__">HelpSearchWidget</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#HelpSearchWidget.__search">__search</a></td>
+<td>Private slot to perform a search of the database.</td>
+</tr><tr>
+<td><a href="#HelpSearchWidget.__searchingFinished">__searchingFinished</a></td>
+<td>Private slot to handle the end of the search.</td>
+</tr><tr>
+<td><a href="#HelpSearchWidget.__searchingStarted">__searchingStarted</a></td>
+<td>Private slot to handle the start of a search.</td>
+</tr><tr>
+<td><a href="#HelpSearchWidget.contextMenuEvent">contextMenuEvent</a></td>
+<td>Protected method handling context menu events.</td>
+</tr><tr>
+<td><a href="#HelpSearchWidget.eventFilter">eventFilter</a></td>
+<td>Public method called to filter the event queue.</td>
+</tr><tr>
+<td><a href="#HelpSearchWidget.keyPressEvent">keyPressEvent</a></td>
+<td>Protected method handling key press events.</td>
+</tr>
+</table>
+<a NAME="HelpSearchWidget.__init__" ID="HelpSearchWidget.__init__"></a>
+<h4>HelpSearchWidget (Constructor)</h4>
+<b>HelpSearchWidget</b>(<i>engine, mainWindow, parent = None</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>engine</i></dt>
+<dd>
+reference to the help search engine (QHelpSearchEngine)
+</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="HelpSearchWidget.__search" ID="HelpSearchWidget.__search"></a>
+<h4>HelpSearchWidget.__search</h4>
+<b>__search</b>(<i></i>)
+<p>
+ Private slot to perform a search of the database.
+</p><a NAME="HelpSearchWidget.__searchingFinished" ID="HelpSearchWidget.__searchingFinished"></a>
+<h4>HelpSearchWidget.__searchingFinished</h4>
+<b>__searchingFinished</b>(<i>hits</i>)
+<p>
+ Private slot to handle the end of the search.
+</p><dl>
+<dt><i>hits</i></dt>
+<dd>
+number of hits (integer) (unused)
+</dd>
+</dl><a NAME="HelpSearchWidget.__searchingStarted" ID="HelpSearchWidget.__searchingStarted"></a>
+<h4>HelpSearchWidget.__searchingStarted</h4>
+<b>__searchingStarted</b>(<i></i>)
+<p>
+ Private slot to handle the start of a search.
+</p><a NAME="HelpSearchWidget.contextMenuEvent" ID="HelpSearchWidget.contextMenuEvent"></a>
+<h4>HelpSearchWidget.contextMenuEvent</h4>
+<b>contextMenuEvent</b>(<i>evt</i>)
+<p>
+ Protected method handling context menu events.
+</p><dl>
+<dt><i>evt</i></dt>
+<dd>
+reference to the context menu event (QContextMenuEvent)
+</dd>
+</dl><a NAME="HelpSearchWidget.eventFilter" ID="HelpSearchWidget.eventFilter"></a>
+<h4>HelpSearchWidget.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="HelpSearchWidget.keyPressEvent" ID="HelpSearchWidget.keyPressEvent"></a>
+<h4>HelpSearchWidget.keyPressEvent</h4>
+<b>keyPressEvent</b>(<i>evt</i>)
+<p>
+ Protected method handling key press events.
+</p><dl>
+<dt><i>evt</i></dt>
+<dd>
+reference to the key press event (QKeyEvent)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
