--- a/Documentation/Source/eric5.Helpviewer.HelpSearchWidget.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Helpviewer.HelpSearchWidget.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Helpviewer.HelpSearchWidget</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; w&#105;&#110;&#100;&#111;w &#102;&#111;&#114; &#115;&#104;&#111;w&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#105;&#110;&#100;&#101;x.
+Module implementing a window for showing the QtHelp index.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#HelpSearchWidget">HelpSearchWidget</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; w&#105;&#110;&#100;&#111;w &#102;&#111;&#114; &#115;&#104;&#111;w&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#105;&#110;&#100;&#101;x.</td>
+<td>Class implementing a window for showing the QtHelp index.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,15 +43,15 @@
 <a NAME="HelpSearchWidget" ID="HelpSearchWidget"></a>
 <h2>HelpSearchWidget</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; w&#105;&#110;&#100;&#111;w &#102;&#111;&#114; &#115;&#104;&#111;w&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#105;&#110;&#100;&#101;x.
+    Class implementing a window for showing the QtHelp index.
 </p><h4>Signals</h4>
 <dl>
 <dt>escapePressed()</dt>
 <dd>
-&#101;&#109;&#105;&#116;&#116;&#101;&#100; w&#104;&#101;&#110; &#116;&#104;&#101; &#69;&#83;&#67; &#107;&#101;y w&#97;&#115; &#112;&#114;&#101;&#115;&#115;&#101;&#100;
+emitted when the ESC key was pressed
 </dd><dt>linkActivated(const QUrl&)</dt>
 <dd>
-&#101;&#109;&#105;&#116;&#116;&#101;&#100; w&#104;&#101;&#110; &#97; &#115;&#101;&#97;&#114;&#99;&#104; &#114;&#101;&#115;&#117;&#108;&#116; &#101;&#110;&#116;&#114;y &#105;&#115; &#97;&#99;&#116;&#105;v&#97;&#116;&#101;&#100;
+emitted when a search result entry is activated
 </dd>
 </dl>
 <h3>Derived from</h3>
@@ -64,100 +64,100 @@
 <table>
 <tr>
 <td><a href="#HelpSearchWidget.__init__">HelpSearchWidget</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#HelpSearchWidget.__search">__search</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#112;&#101;&#114;&#102;&#111;&#114;&#109; &#97; &#115;&#101;&#97;&#114;&#99;&#104; &#111;&#102; &#116;&#104;&#101; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;.</td>
+<td>Private slot to perform a search of the database.</td>
 </tr><tr>
 <td><a href="#HelpSearchWidget.__searchingFinished">__searchingFinished</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#101;&#110;&#100; &#111;&#102; &#116;&#104;&#101; &#115;&#101;&#97;&#114;&#99;&#104;.</td>
+<td>Private slot to handle the end of the search.</td>
 </tr><tr>
 <td><a href="#HelpSearchWidget.__searchingStarted">__searchingStarted</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#115;&#116;&#97;&#114;&#116; &#111;&#102; &#97; &#115;&#101;&#97;&#114;&#99;&#104;.</td>
+<td>Private slot to handle the start of a search.</td>
 </tr><tr>
 <td><a href="#HelpSearchWidget.contextMenuEvent">contextMenuEvent</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117; &#101;v&#101;&#110;&#116;&#115;.</td>
+<td>Protected method handling context menu events.</td>
 </tr><tr>
 <td><a href="#HelpSearchWidget.eventFilter">eventFilter</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#102;&#105;&#108;&#116;&#101;&#114; &#116;&#104;&#101; &#101;v&#101;&#110;&#116; &#113;&#117;&#101;&#117;&#101;.</td>
+<td>Public method called to filter the event queue.</td>
 </tr><tr>
 <td><a href="#HelpSearchWidget.keyPressEvent">keyPressEvent</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#107;&#101;y &#112;&#114;&#101;&#115;&#115; &#101;v&#101;&#110;&#116;&#115;.</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>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>engine</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#104;&#101;&#108;&#112; &#115;&#101;&#97;&#114;&#99;&#104; &#101;&#110;&#103;&#105;&#110;&#101; (&#81;&#72;&#101;&#108;&#112;&#83;&#101;&#97;&#114;&#99;&#104;&#69;&#110;&#103;&#105;&#110;&#101;)
+reference to the help search engine (QHelpSearchEngine)
 </dd><dt><i>mainWindow</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#109;&#97;&#105;&#110; w&#105;&#110;&#100;&#111;w &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#77;&#97;&#105;&#110;&#87;&#105;&#110;&#100;&#111;w)
+reference to the main window object (QMainWindow)
 </dd><dt><i>parent</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+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>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#112;&#101;&#114;&#102;&#111;&#114;&#109; &#97; &#115;&#101;&#97;&#114;&#99;&#104; &#111;&#102; &#116;&#104;&#101; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;.
+        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>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#101;&#110;&#100; &#111;&#102; &#116;&#104;&#101; &#115;&#101;&#97;&#114;&#99;&#104;.
+        Private slot to handle the end of the search.
 </p><dl>
 <dt><i>hits</i></dt>
 <dd>
-&#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#104;&#105;&#116;&#115; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;) (&#117;&#110;&#117;&#115;&#101;&#100;)
+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>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#115;&#116;&#97;&#114;&#116; &#111;&#102; &#97; &#115;&#101;&#97;&#114;&#99;&#104;.
+        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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117; &#101;v&#101;&#110;&#116;&#115;.
+        Protected method handling context menu events.
 </p><dl>
 <dt><i>evt</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117; &#101;v&#101;&#110;&#116; (&#81;&#67;&#111;&#110;&#116;&#101;x&#116;&#77;&#101;&#110;&#117;&#69;v&#101;&#110;&#116;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#102;&#105;&#108;&#116;&#101;&#114; &#116;&#104;&#101; &#101;v&#101;&#110;&#116; &#113;&#117;&#101;&#117;&#101;.
+        Public method called to filter the event queue.
 </p><dl>
 <dt><i>watched</i></dt>
 <dd>
-&#116;&#104;&#101; &#81;&#79;&#98;&#106;&#101;&#99;&#116; &#98;&#101;&#105;&#110;&#103; w&#97;&#116;&#99;&#104;&#101;&#100; (&#81;&#79;&#98;&#106;&#101;&#99;&#116;)
+the QObject being watched (QObject)
 </dd><dt><i>event</i></dt>
 <dd>
-&#116;&#104;&#101; &#101;v&#101;&#110;&#116; &#116;&#104;&#97;&#116; &#111;&#99;&#99;&#117;&#114;&#114;&#101;&#100; (&#81;&#69;v&#101;&#110;&#116;)
+the event that occurred (QEvent)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; w&#104;&#101;&#116;&#104;&#101;&#114; &#116;&#104;&#101; &#101;v&#101;&#110;&#116; w&#97;&#115; &#104;&#97;&#110;&#100;&#108;&#101;&#100; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#107;&#101;y &#112;&#114;&#101;&#115;&#115; &#101;v&#101;&#110;&#116;&#115;.
+        Protected method handling key press events.
 </p><dl>
 <dt><i>evt</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#107;&#101;y &#112;&#114;&#101;&#115;&#115; &#101;v&#101;&#110;&#116; (&#81;&#75;&#101;y&#69;v&#101;&#110;&#116;)
+reference to the key press event (QKeyEvent)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>