--- a/Documentation/Source/eric5.Helpviewer.HelpIndexWidget.html Thu Jan 14 17:27:31 2010 +0000 +++ b/Documentation/Source/eric5.Helpviewer.HelpIndexWidget.html Thu Jan 14 18:35:52 2010 +0000 @@ -22,7 +22,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.Helpviewer.HelpIndexWidget</h1> <p> -Module implementing a window for showing the QtHelp index. +Module implementing a window for showing the QtHelp index. </p> <h3>Global Attributes</h3> <table> @@ -32,7 +32,7 @@ <table> <tr> <td><a href="#HelpIndexWidget">HelpIndexWidget</a></td> -<td>Class implementing a window for showing the QtHelp index.</td> +<td>Class implementing a window for showing the QtHelp index.</td> </tr> </table> <h3>Functions</h3> @@ -43,15 +43,15 @@ <a NAME="HelpIndexWidget" ID="HelpIndexWidget"></a> <h2>HelpIndexWidget</h2> <p> - Class implementing a window for showing the QtHelp index. + 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 +emitted when the ESC key was pressed </dd><dt>linkActivated(const QUrl&)</dt> <dd> -emitted when an index entry is activated +emitted when an index entry is activated </dd> </dl> <h3>Derived from</h3> @@ -64,87 +64,87 @@ <table> <tr> <td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td> -<td>Constructor</td> +<td>Constructor</td> </tr><tr> <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td> -<td>Private slot to enable the search edit.</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> +<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> +<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> +<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> +<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 + Constructor </p><dl> <dt><i>engine</i></dt> <dd> -reference to the help engine (QHelpEngine) +reference to the help engine (QHelpEngine) </dd><dt><i>mainWindow</i></dt> <dd> -reference to the main window object (QMainWindow) +reference to the main window object (QMainWindow) </dd><dt><i>parent</i></dt> <dd> -reference to the parent widget (QWidget) +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. + 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. + 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. + Private slot to filter the indices according to the given filter. </p><dl> <dt><i>filter</i></dt> <dd> -filter to be used (string) +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. + Public method called to filter the event queue. </p><dl> <dt><i>watched</i></dt> <dd> -the QObject being watched (QObject) +the QObject being watched (QObject) </dd><dt><i>event</i></dt> <dd> -the event that occurred (QEvent) +the event that occurred (QEvent) </dd> </dl><dl> <dt>Returns:</dt> <dd> -flag indicating whether the event was handled (boolean) +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. + Protected method handling focus in events. </p><dl> <dt><i>evt</i></dt> <dd> -reference to the focus event object (QFocusEvent) +reference to the focus event object (QFocusEvent) </dd> </dl> <div align="right"><a href="#top">Up</a></div>