Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.HelpIndexWidget.html
Documentation/Source/eric5.Helpviewer.HelpIndexWidget.html
- changeset 58
- 37f0444c3479
- parent 21
- b88a0e6268bd
- child 113
- 33afff70d8ee
equal
deleted
inserted
replaced
| 57:81326a94fdca | 58:37f0444c3479 |
|---|---|
| 20 </style> | 20 </style> |
| 21 </head> | 21 </head> |
| 22 <body><a NAME="top" ID="top"></a> | 22 <body><a NAME="top" ID="top"></a> |
| 23 <h1>eric5.Helpviewer.HelpIndexWidget</h1> | 23 <h1>eric5.Helpviewer.HelpIndexWidget</h1> |
| 24 <p> | 24 <p> |
| 25 Module implementing a window for showing the QtHelp index. | 25 Module implementing a window for showing the QtHelp index. |
| 26 </p> | 26 </p> |
| 27 <h3>Global Attributes</h3> | 27 <h3>Global Attributes</h3> |
| 28 <table> | 28 <table> |
| 29 <tr><td>None</td></tr> | 29 <tr><td>None</td></tr> |
| 30 </table> | 30 </table> |
| 31 <h3>Classes</h3> | 31 <h3>Classes</h3> |
| 32 <table> | 32 <table> |
| 33 <tr> | 33 <tr> |
| 34 <td><a href="#HelpIndexWidget">HelpIndexWidget</a></td> | 34 <td><a href="#HelpIndexWidget">HelpIndexWidget</a></td> |
| 35 <td>Class implementing a window for showing the QtHelp index.</td> | 35 <td>Class implementing a window for showing the QtHelp index.</td> |
| 36 </tr> | 36 </tr> |
| 37 </table> | 37 </table> |
| 38 <h3>Functions</h3> | 38 <h3>Functions</h3> |
| 39 <table> | 39 <table> |
| 40 <tr><td>None</td></tr> | 40 <tr><td>None</td></tr> |
| 41 </table> | 41 </table> |
| 42 <hr /><hr /> | 42 <hr /><hr /> |
| 43 <a NAME="HelpIndexWidget" ID="HelpIndexWidget"></a> | 43 <a NAME="HelpIndexWidget" ID="HelpIndexWidget"></a> |
| 44 <h2>HelpIndexWidget</h2> | 44 <h2>HelpIndexWidget</h2> |
| 45 <p> | 45 <p> |
| 46 Class implementing a window for showing the QtHelp index. | 46 Class implementing a window for showing the QtHelp index. |
| 47 </p><h4>Signals</h4> | 47 </p><h4>Signals</h4> |
| 48 <dl> | 48 <dl> |
| 49 <dt>escapePressed()</dt> | 49 <dt>escapePressed()</dt> |
| 50 <dd> | 50 <dd> |
| 51 emitted when the ESC key was pressed | 51 emitted when the ESC key was pressed |
| 52 </dd><dt>linkActivated(const QUrl&)</dt> | 52 </dd><dt>linkActivated(const QUrl&)</dt> |
| 53 <dd> | 53 <dd> |
| 54 emitted when an index entry is activated | 54 emitted when an index entry is activated |
| 55 </dd> | 55 </dd> |
| 56 </dl> | 56 </dl> |
| 57 <h3>Derived from</h3> | 57 <h3>Derived from</h3> |
| 58 QWidget | 58 QWidget |
| 59 <h3>Class Attributes</h3> | 59 <h3>Class Attributes</h3> |
| 62 </table> | 62 </table> |
| 63 <h3>Methods</h3> | 63 <h3>Methods</h3> |
| 64 <table> | 64 <table> |
| 65 <tr> | 65 <tr> |
| 66 <td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td> | 66 <td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td> |
| 67 <td>Constructor</td> | 67 <td>Constructor</td> |
| 68 </tr><tr> | 68 </tr><tr> |
| 69 <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td> | 69 <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td> |
| 70 <td>Private slot to enable the search edit.</td> | 70 <td>Private slot to enable the search edit.</td> |
| 71 </tr><tr> | 71 </tr><tr> |
| 72 <td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td> | 72 <td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td> |
| 73 <td>Private slot to enable the search edit.</td> | 73 <td>Private slot to enable the search edit.</td> |
| 74 </tr><tr> | 74 </tr><tr> |
| 75 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td> | 75 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td> |
| 76 <td>Private slot to filter the indices according to the given filter.</td> | 76 <td>Private slot to filter the indices according to the given filter.</td> |
| 77 </tr><tr> | 77 </tr><tr> |
| 78 <td><a href="#HelpIndexWidget.eventFilter">eventFilter</a></td> | 78 <td><a href="#HelpIndexWidget.eventFilter">eventFilter</a></td> |
| 79 <td>Public method called to filter the event queue.</td> | 79 <td>Public method called to filter the event queue.</td> |
| 80 </tr><tr> | 80 </tr><tr> |
| 81 <td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td> | 81 <td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td> |
| 82 <td>Protected method handling focus in events.</td> | 82 <td>Protected method handling focus in events.</td> |
| 83 </tr> | 83 </tr> |
| 84 </table> | 84 </table> |
| 85 <a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a> | 85 <a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a> |
| 86 <h4>HelpIndexWidget (Constructor)</h4> | 86 <h4>HelpIndexWidget (Constructor)</h4> |
| 87 <b>HelpIndexWidget</b>(<i>engine, mainWindow, parent = None</i>) | 87 <b>HelpIndexWidget</b>(<i>engine, mainWindow, parent = None</i>) |
| 88 <p> | 88 <p> |
| 89 Constructor | 89 Constructor |
| 90 </p><dl> | 90 </p><dl> |
| 91 <dt><i>engine</i></dt> | 91 <dt><i>engine</i></dt> |
| 92 <dd> | 92 <dd> |
| 93 reference to the help engine (QHelpEngine) | 93 reference to the help engine (QHelpEngine) |
| 94 </dd><dt><i>mainWindow</i></dt> | 94 </dd><dt><i>mainWindow</i></dt> |
| 95 <dd> | 95 <dd> |
| 96 reference to the main window object (QMainWindow) | 96 reference to the main window object (QMainWindow) |
| 97 </dd><dt><i>parent</i></dt> | 97 </dd><dt><i>parent</i></dt> |
| 98 <dd> | 98 <dd> |
| 99 reference to the parent widget (QWidget) | 99 reference to the parent widget (QWidget) |
| 100 </dd> | 100 </dd> |
| 101 </dl><a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a> | 101 </dl><a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a> |
| 102 <h4>HelpIndexWidget.__disableSearchEdit</h4> | 102 <h4>HelpIndexWidget.__disableSearchEdit</h4> |
| 103 <b>__disableSearchEdit</b>(<i></i>) | 103 <b>__disableSearchEdit</b>(<i></i>) |
| 104 <p> | 104 <p> |
| 105 Private slot to enable the search edit. | 105 Private slot to enable the search edit. |
| 106 </p><a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a> | 106 </p><a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a> |
| 107 <h4>HelpIndexWidget.__enableSearchEdit</h4> | 107 <h4>HelpIndexWidget.__enableSearchEdit</h4> |
| 108 <b>__enableSearchEdit</b>(<i></i>) | 108 <b>__enableSearchEdit</b>(<i></i>) |
| 109 <p> | 109 <p> |
| 110 Private slot to enable the search edit. | 110 Private slot to enable the search edit. |
| 111 </p><a NAME="HelpIndexWidget.__filterIndices" ID="HelpIndexWidget.__filterIndices"></a> | 111 </p><a NAME="HelpIndexWidget.__filterIndices" ID="HelpIndexWidget.__filterIndices"></a> |
| 112 <h4>HelpIndexWidget.__filterIndices</h4> | 112 <h4>HelpIndexWidget.__filterIndices</h4> |
| 113 <b>__filterIndices</b>(<i>filter</i>) | 113 <b>__filterIndices</b>(<i>filter</i>) |
| 114 <p> | 114 <p> |
| 115 Private slot to filter the indices according to the given filter. | 115 Private slot to filter the indices according to the given filter. |
| 116 </p><dl> | 116 </p><dl> |
| 117 <dt><i>filter</i></dt> | 117 <dt><i>filter</i></dt> |
| 118 <dd> | 118 <dd> |
| 119 filter to be used (string) | 119 filter to be used (string) |
| 120 </dd> | 120 </dd> |
| 121 </dl><a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a> | 121 </dl><a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a> |
| 122 <h4>HelpIndexWidget.eventFilter</h4> | 122 <h4>HelpIndexWidget.eventFilter</h4> |
| 123 <b>eventFilter</b>(<i>watched, event</i>) | 123 <b>eventFilter</b>(<i>watched, event</i>) |
| 124 <p> | 124 <p> |
| 125 Public method called to filter the event queue. | 125 Public method called to filter the event queue. |
| 126 </p><dl> | 126 </p><dl> |
| 127 <dt><i>watched</i></dt> | 127 <dt><i>watched</i></dt> |
| 128 <dd> | 128 <dd> |
| 129 the QObject being watched (QObject) | 129 the QObject being watched (QObject) |
| 130 </dd><dt><i>event</i></dt> | 130 </dd><dt><i>event</i></dt> |
| 131 <dd> | 131 <dd> |
| 132 the event that occurred (QEvent) | 132 the event that occurred (QEvent) |
| 133 </dd> | 133 </dd> |
| 134 </dl><dl> | 134 </dl><dl> |
| 135 <dt>Returns:</dt> | 135 <dt>Returns:</dt> |
| 136 <dd> | 136 <dd> |
| 137 flag indicating whether the event was handled (boolean) | 137 flag indicating whether the event was handled (boolean) |
| 138 </dd> | 138 </dd> |
| 139 </dl><a NAME="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a> | 139 </dl><a NAME="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a> |
| 140 <h4>HelpIndexWidget.focusInEvent</h4> | 140 <h4>HelpIndexWidget.focusInEvent</h4> |
| 141 <b>focusInEvent</b>(<i>evt</i>) | 141 <b>focusInEvent</b>(<i>evt</i>) |
| 142 <p> | 142 <p> |
| 143 Protected method handling focus in events. | 143 Protected method handling focus in events. |
| 144 </p><dl> | 144 </p><dl> |
| 145 <dt><i>evt</i></dt> | 145 <dt><i>evt</i></dt> |
| 146 <dd> | 146 <dd> |
| 147 reference to the focus event object (QFocusEvent) | 147 reference to the focus event object (QFocusEvent) |
| 148 </dd> | 148 </dd> |
| 149 </dl> | 149 </dl> |
| 150 <div align="right"><a href="#top">Up</a></div> | 150 <div align="right"><a href="#top">Up</a></div> |
| 151 <hr /> | 151 <hr /> |
| 152 </body></html> | 152 </body></html> |
