Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.QtHelpInterface.HelpIndexWidget.html

src/eric7/Documentation/Source/eric7.QtHelpInterface.HelpIndexWidget.html

branch
eric7
changeset 10479
856476537696
parent 9686
2eee7a645cba
child 10692
9becf9ca115c
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.QtHelpInterface.HelpIndexWidget</h1> 9 <h1>eric7.QtHelpInterface.HelpIndexWidget</h1>
10
11 <p> 10 <p>
12 Module implementing a window for showing the QtHelp index. 11 Module implementing a window for showing the QtHelp index.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#HelpIndexWidget">HelpIndexWidget</a></td> 22 <td><a href="#HelpIndexWidget">HelpIndexWidget</a></td>
25 <td>Class implementing a window for showing the QtHelp index.</td> 23 <td>Class implementing a window for showing the QtHelp index.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="HelpIndexWidget" ID="HelpIndexWidget"></a> 34 <a NAME="HelpIndexWidget" ID="HelpIndexWidget"></a>
36 <h2>HelpIndexWidget</h2> 35 <h2>HelpIndexWidget</h2>
37
38 <p> 36 <p>
39 Class implementing a window for showing the QtHelp index. 37 Class implementing a window for showing the QtHelp index.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>escapePressed()</dt> 43 <dt>escapePressed()</dt>
45 <dd> 44 <dd>
64 </dd> 63 </dd>
65 </dl> 64 </dl>
66 <h3>Derived from</h3> 65 <h3>Derived from</h3>
67 QWidget 66 QWidget
68 <h3>Class Attributes</h3> 67 <h3>Class Attributes</h3>
69 68 <table>
70 <table> 69 <tr><td>None</td></tr>
71 <tr><td>None</td></tr> 70 </table>
72 </table> 71
73 <h3>Class Methods</h3> 72 <h3>Class Methods</h3>
74 73 <table>
75 <table> 74 <tr><td>None</td></tr>
76 <tr><td>None</td></tr> 75 </table>
77 </table> 76
78 <h3>Methods</h3> 77 <h3>Methods</h3>
79 78 <table>
80 <table>
81
82 <tr> 79 <tr>
83 <td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td> 80 <td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td>
84 <td>Constructor</td> 81 <td>Constructor</td>
85 </tr> 82 </tr>
86 <tr> 83 <tr>
118 <tr> 115 <tr>
119 <td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td> 116 <td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td>
120 <td>Protected method handling focus in events.</td> 117 <td>Protected method handling focus in events.</td>
121 </tr> 118 </tr>
122 </table> 119 </table>
120
123 <h3>Static Methods</h3> 121 <h3>Static Methods</h3>
124 122 <table>
125 <table> 123 <tr><td>None</td></tr>
126 <tr><td>None</td></tr> 124 </table>
127 </table> 125
128 126
129 <a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a> 127 <a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a>
130 <h4>HelpIndexWidget (Constructor)</h4> 128 <h4>HelpIndexWidget (Constructor)</h4>
131 <b>HelpIndexWidget</b>(<i>engine, internal=False, parent=None</i>) 129 <b>HelpIndexWidget</b>(<i>engine, internal=False, parent=None</i>)
132
133 <p> 130 <p>
134 Constructor 131 Constructor
135 </p> 132 </p>
133
136 <dl> 134 <dl>
137 135
138 <dt><i>engine</i> (QHelpEngine)</dt> 136 <dt><i>engine</i> (QHelpEngine)</dt>
139 <dd> 137 <dd>
140 reference to the help engine 138 reference to the help engine
149 </dd> 147 </dd>
150 </dl> 148 </dl>
151 <a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a> 149 <a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a>
152 <h4>HelpIndexWidget.__disableSearchEdit</h4> 150 <h4>HelpIndexWidget.__disableSearchEdit</h4>
153 <b>__disableSearchEdit</b>(<i></i>) 151 <b>__disableSearchEdit</b>(<i></i>)
154
155 <p> 152 <p>
156 Private slot to enable the search edit. 153 Private slot to enable the search edit.
157 </p> 154 </p>
155
158 <a NAME="HelpIndexWidget.__documentActivated" ID="HelpIndexWidget.__documentActivated"></a> 156 <a NAME="HelpIndexWidget.__documentActivated" ID="HelpIndexWidget.__documentActivated"></a>
159 <h4>HelpIndexWidget.__documentActivated</h4> 157 <h4>HelpIndexWidget.__documentActivated</h4>
160 <b>__documentActivated</b>(<i>document, keyword, modifiers=None</i>) 158 <b>__documentActivated</b>(<i>document, keyword, modifiers=None</i>)
161
162 <p> 159 <p>
163 Private slot to handle the activation of a keyword entry. 160 Private slot to handle the activation of a keyword entry.
164 </p> 161 </p>
162
165 <dl> 163 <dl>
166 164
167 <dt><i>document</i> (QHelpLink)</dt> 165 <dt><i>document</i> (QHelpLink)</dt>
168 <dd> 166 <dd>
169 reference to a data structure containing the 167 reference to a data structure containing the
179 </dd> 177 </dd>
180 </dl> 178 </dl>
181 <a NAME="HelpIndexWidget.__documentsActivated" ID="HelpIndexWidget.__documentsActivated"></a> 179 <a NAME="HelpIndexWidget.__documentsActivated" ID="HelpIndexWidget.__documentsActivated"></a>
182 <h4>HelpIndexWidget.__documentsActivated</h4> 180 <h4>HelpIndexWidget.__documentsActivated</h4>
183 <b>__documentsActivated</b>(<i>documents, helpKeyword</i>) 181 <b>__documentsActivated</b>(<i>documents, helpKeyword</i>)
184
185 <p> 182 <p>
186 Private slot to handle the activation of an entry with multiple help 183 Private slot to handle the activation of an entry with multiple help
187 documents. 184 documents.
188 </p> 185 </p>
186
189 <dl> 187 <dl>
190 188
191 <dt><i>documents</i> (list of QHelpLink)</dt> 189 <dt><i>documents</i> (list of QHelpLink)</dt>
192 <dd> 190 <dd>
193 list of help document link data structures 191 list of help document link data structures
198 </dd> 196 </dd>
199 </dl> 197 </dl>
200 <a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a> 198 <a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a>
201 <h4>HelpIndexWidget.__enableSearchEdit</h4> 199 <h4>HelpIndexWidget.__enableSearchEdit</h4>
202 <b>__enableSearchEdit</b>(<i></i>) 200 <b>__enableSearchEdit</b>(<i></i>)
203
204 <p> 201 <p>
205 Private slot to enable the search edit. 202 Private slot to enable the search edit.
206 </p> 203 </p>
204
207 <a NAME="HelpIndexWidget.__filterIndices" ID="HelpIndexWidget.__filterIndices"></a> 205 <a NAME="HelpIndexWidget.__filterIndices" ID="HelpIndexWidget.__filterIndices"></a>
208 <h4>HelpIndexWidget.__filterIndices</h4> 206 <h4>HelpIndexWidget.__filterIndices</h4>
209 <b>__filterIndices</b>(<i>indexFilter</i>) 207 <b>__filterIndices</b>(<i>indexFilter</i>)
210
211 <p> 208 <p>
212 Private slot to filter the indexes according to the given filter. 209 Private slot to filter the indexes according to the given filter.
213 </p> 210 </p>
211
214 <dl> 212 <dl>
215 213
216 <dt><i>indexFilter</i> (str)</dt> 214 <dt><i>indexFilter</i> (str)</dt>
217 <dd> 215 <dd>
218 filter to be used 216 filter to be used
219 </dd> 217 </dd>
220 </dl> 218 </dl>
221 <a NAME="HelpIndexWidget.__selectDocument" ID="HelpIndexWidget.__selectDocument"></a> 219 <a NAME="HelpIndexWidget.__selectDocument" ID="HelpIndexWidget.__selectDocument"></a>
222 <h4>HelpIndexWidget.__selectDocument</h4> 220 <h4>HelpIndexWidget.__selectDocument</h4>
223 <b>__selectDocument</b>(<i>documents, helpKeyword</i>) 221 <b>__selectDocument</b>(<i>documents, helpKeyword</i>)
224
225 <p> 222 <p>
226 Private method to give the user a chance to select among the 223 Private method to give the user a chance to select among the
227 given documents. 224 given documents.
228 </p> 225 </p>
226
229 <dl> 227 <dl>
230 228
231 <dt><i>documents</i> (list of QHelpLink)</dt> 229 <dt><i>documents</i> (list of QHelpLink)</dt>
232 <dd> 230 <dd>
233 list of help document link data structures 231 list of help document link data structures
250 </dd> 248 </dd>
251 </dl> 249 </dl>
252 <a NAME="HelpIndexWidget.__showContextMenu" ID="HelpIndexWidget.__showContextMenu"></a> 250 <a NAME="HelpIndexWidget.__showContextMenu" ID="HelpIndexWidget.__showContextMenu"></a>
253 <h4>HelpIndexWidget.__showContextMenu</h4> 251 <h4>HelpIndexWidget.__showContextMenu</h4>
254 <b>__showContextMenu</b>(<i>pos</i>) 252 <b>__showContextMenu</b>(<i>pos</i>)
255
256 <p> 253 <p>
257 Private slot showing the context menu. 254 Private slot showing the context menu.
258 </p> 255 </p>
256
259 <dl> 257 <dl>
260 258
261 <dt><i>pos</i> (QPoint)</dt> 259 <dt><i>pos</i> (QPoint)</dt>
262 <dd> 260 <dd>
263 position to show the menu at 261 position to show the menu at
264 </dd> 262 </dd>
265 </dl> 263 </dl>
266 <a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a> 264 <a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a>
267 <h4>HelpIndexWidget.eventFilter</h4> 265 <h4>HelpIndexWidget.eventFilter</h4>
268 <b>eventFilter</b>(<i>watched, event</i>) 266 <b>eventFilter</b>(<i>watched, event</i>)
269
270 <p> 267 <p>
271 Public method called to filter the event queue. 268 Public method called to filter the event queue.
272 </p> 269 </p>
270
273 <dl> 271 <dl>
274 272
275 <dt><i>watched</i> (QObject)</dt> 273 <dt><i>watched</i> (QObject)</dt>
276 <dd> 274 <dd>
277 the QObject being watched 275 the QObject being watched
294 </dd> 292 </dd>
295 </dl> 293 </dl>
296 <a NAME="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a> 294 <a NAME="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a>
297 <h4>HelpIndexWidget.focusInEvent</h4> 295 <h4>HelpIndexWidget.focusInEvent</h4>
298 <b>focusInEvent</b>(<i>evt</i>) 296 <b>focusInEvent</b>(<i>evt</i>)
299
300 <p> 297 <p>
301 Protected method handling focus in events. 298 Protected method handling focus in events.
302 </p> 299 </p>
300
303 <dl> 301 <dl>
304 302
305 <dt><i>evt</i> (QFocusEvent)</dt> 303 <dt><i>evt</i> (QFocusEvent)</dt>
306 <dd> 304 <dd>
307 reference to the focus event object 305 reference to the focus event object

Mercurial Repository: eric

eric ide

mercurial