Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.WebBrowser.QtHelp.HelpIndexWidget.html

eric7/Documentation/Source/eric7.WebBrowser.QtHelp.HelpIndexWidget.html

branch
eric7
changeset 8422
bb5da74c1b3f
parent 8372
e0227a7c850e
child 8575
423c4db4101e
equal deleted inserted replaced
8421:cd4eee7f1d28 8422:bb5da74c1b3f
100 <tr> 100 <tr>
101 <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td> 101 <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td>
102 <td>Private slot to enable the search edit.</td> 102 <td>Private slot to enable the search edit.</td>
103 </tr> 103 </tr>
104 <tr> 104 <tr>
105 <td><a href="#HelpIndexWidget.__documentActivated">__documentActivated</a></td>
106 <td>Private slot to handle the activation of a keyword entry.</td>
107 </tr>
108 <tr>
109 <td><a href="#HelpIndexWidget.__documentsActivated">__documentsActivated</a></td>
110 <td>Private slot to handle the activation of an entry with multiple help documents.</td>
111 </tr>
112 <tr>
105 <td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td> 113 <td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td>
106 <td>Private slot to enable the search edit.</td> 114 <td>Private slot to enable the search edit.</td>
107 </tr> 115 </tr>
108 <tr> 116 <tr>
109 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td> 117 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td>
110 <td>Private slot to filter the indexes according to the given filter.</td> 118 <td>Private slot to filter the indexes according to the given filter.</td>
111 </tr> 119 </tr>
112 <tr> 120 <tr>
113 <td><a href="#HelpIndexWidget.__linkActivated">__linkActivated</a></td> 121 <td><a href="#HelpIndexWidget.__selectDocument">__selectDocument</a></td>
114 <td>Private slot to handle the activation of a keyword entry.</td> 122 <td>Private method to give the user a chance to select among the given documents.</td>
115 </tr>
116 <tr>
117 <td><a href="#HelpIndexWidget.__linksActivated">__linksActivated</a></td>
118 <td>Private slot to handle the activation of an entry with multiple links.</td>
119 </tr>
120 <tr>
121 <td><a href="#HelpIndexWidget.__selectLink">__selectLink</a></td>
122 <td>Private method to give the user a chance to select among the returned links.</td>
123 </tr> 123 </tr>
124 <tr> 124 <tr>
125 <td><a href="#HelpIndexWidget.__showContextMenu">__showContextMenu</a></td> 125 <td><a href="#HelpIndexWidget.__showContextMenu">__showContextMenu</a></td>
126 <td>Private slot showing the context menu.</td> 126 <td>Private slot showing the context menu.</td>
127 </tr> 127 </tr>
147 <p> 147 <p>
148 Constructor 148 Constructor
149 </p> 149 </p>
150 <dl> 150 <dl>
151 151
152 <dt><i>engine</i></dt> 152 <dt><i>engine</i> (QHelpEngine)</dt>
153 <dd> 153 <dd>
154 reference to the help engine (QHelpEngine) 154 reference to the help engine
155 </dd> 155 </dd>
156 <dt><i>parent</i></dt> 156 <dt><i>parent</i> (QWidget)</dt>
157 <dd> 157 <dd>
158 reference to the parent widget (QWidget) 158 reference to the parent widget
159 </dd> 159 </dd>
160 </dl> 160 </dl>
161 <a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a> 161 <a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a>
162 <h4>HelpIndexWidget.__disableSearchEdit</h4> 162 <h4>HelpIndexWidget.__disableSearchEdit</h4>
163 <b>__disableSearchEdit</b>(<i></i>) 163 <b>__disableSearchEdit</b>(<i></i>)
164 164
165 <p> 165 <p>
166 Private slot to enable the search edit. 166 Private slot to enable the search edit.
167 </p> 167 </p>
168 <a NAME="HelpIndexWidget.__documentActivated" ID="HelpIndexWidget.__documentActivated"></a>
169 <h4>HelpIndexWidget.__documentActivated</h4>
170 <b>__documentActivated</b>(<i>document, keyword, modifiers=None</i>)
171
172 <p>
173 Private slot to handle the activation of a keyword entry.
174 </p>
175 <dl>
176
177 <dt><i>document</i> (QHelpLink)</dt>
178 <dd>
179 reference to a data structure containing the
180 document info
181 </dd>
182 <dt><i>keyword</i> (str)</dt>
183 <dd>
184 keyword for the URL
185 </dd>
186 <dt><i>modifiers</i> (Qt.KeyboardModifiers or None)</dt>
187 <dd>
188 keyboard modifiers
189 </dd>
190 </dl>
191 <a NAME="HelpIndexWidget.__documentsActivated" ID="HelpIndexWidget.__documentsActivated"></a>
192 <h4>HelpIndexWidget.__documentsActivated</h4>
193 <b>__documentsActivated</b>(<i>documents, keyword</i>)
194
195 <p>
196 Private slot to handle the activation of an entry with multiple help
197 documents.
198 </p>
199 <dl>
200
201 <dt><i>documents</i> (list of QHelpLink)</dt>
202 <dd>
203 list of help document link data structures
204 </dd>
205 <dt><i>keyword</i> (str)</dt>
206 <dd>
207 keyword for the entry
208 </dd>
209 </dl>
168 <a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a> 210 <a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a>
169 <h4>HelpIndexWidget.__enableSearchEdit</h4> 211 <h4>HelpIndexWidget.__enableSearchEdit</h4>
170 <b>__enableSearchEdit</b>(<i></i>) 212 <b>__enableSearchEdit</b>(<i></i>)
171 213
172 <p> 214 <p>
179 <p> 221 <p>
180 Private slot to filter the indexes according to the given filter. 222 Private slot to filter the indexes according to the given filter.
181 </p> 223 </p>
182 <dl> 224 <dl>
183 225
184 <dt><i>indexFilter</i></dt> 226 <dt><i>indexFilter</i> (str)</dt>
185 <dd> 227 <dd>
186 filter to be used (string) 228 filter to be used
187 </dd> 229 </dd>
188 </dl> 230 </dl>
189 <a NAME="HelpIndexWidget.__linkActivated" ID="HelpIndexWidget.__linkActivated"></a> 231 <a NAME="HelpIndexWidget.__selectDocument" ID="HelpIndexWidget.__selectDocument"></a>
190 <h4>HelpIndexWidget.__linkActivated</h4> 232 <h4>HelpIndexWidget.__selectDocument</h4>
191 <b>__linkActivated</b>(<i>url, keyword, modifiers=None</i>) 233 <b>__selectDocument</b>(<i>documents, keyword</i>)
192 234
193 <p> 235 <p>
194 Private slot to handle the activation of a keyword entry. 236 Private method to give the user a chance to select among the
195 </p> 237 given documents.
196 <dl> 238 </p>
197 239 <dl>
198 <dt><i>url</i> (QUrl)</dt> 240
199 <dd> 241 <dt><i>documents</i> (list of QHelpLink)</dt>
200 URL of the selected entry 242 <dd>
243 list of help document link data structures
201 </dd> 244 </dd>
202 <dt><i>keyword</i> (str)</dt> 245 <dt><i>keyword</i> (str)</dt>
203 <dd> 246 <dd>
204 keyword for the URL 247 keyword for the documents
205 </dd>
206 <dt><i>modifiers</i> (Qt.KeyboardModifiers or None)</dt>
207 <dd>
208 keyboard modifiers
209 </dd>
210 </dl>
211 <a NAME="HelpIndexWidget.__linksActivated" ID="HelpIndexWidget.__linksActivated"></a>
212 <h4>HelpIndexWidget.__linksActivated</h4>
213 <b>__linksActivated</b>(<i>links, keyword</i>)
214
215 <p>
216 Private slot to handle the activation of an entry with multiple links.
217 </p>
218 <dl>
219
220 <dt><i>links</i> (dict of key:str and value:QUrl)</dt>
221 <dd>
222 dictionary containing the links
223 </dd>
224 <dt><i>keyword</i> (str)</dt>
225 <dd>
226 keyword for the entry
227 </dd>
228 </dl>
229 <a NAME="HelpIndexWidget.__selectLink" ID="HelpIndexWidget.__selectLink"></a>
230 <h4>HelpIndexWidget.__selectLink</h4>
231 <b>__selectLink</b>(<i>links, keyword</i>)
232
233 <p>
234 Private method to give the user a chance to select among the
235 returned links.
236 </p>
237 <dl>
238
239 <dt><i>links</i> (dictionary of str (key) and QUrl (value))</dt>
240 <dd>
241 dictionary of document title and URL to select from
242 </dd>
243 <dt><i>keyword</i> (str)</dt>
244 <dd>
245 keyword for the link set
246 </dd> 248 </dd>
247 </dl> 249 </dl>
248 <dl> 250 <dl>
249 <dt>Return:</dt> 251 <dt>Return:</dt>
250 <dd> 252 <dd>
251 selected link 253 selected document
252 </dd> 254 </dd>
253 </dl> 255 </dl>
254 <dl> 256 <dl>
255 <dt>Return Type:</dt> 257 <dt>Return Type:</dt>
256 <dd> 258 <dd>
257 QUrl 259 QHelpLink
258 </dd> 260 </dd>
259 </dl> 261 </dl>
260 <a NAME="HelpIndexWidget.__showContextMenu" ID="HelpIndexWidget.__showContextMenu"></a> 262 <a NAME="HelpIndexWidget.__showContextMenu" ID="HelpIndexWidget.__showContextMenu"></a>
261 <h4>HelpIndexWidget.__showContextMenu</h4> 263 <h4>HelpIndexWidget.__showContextMenu</h4>
262 <b>__showContextMenu</b>(<i>pos</i>) 264 <b>__showContextMenu</b>(<i>pos</i>)
264 <p> 266 <p>
265 Private slot showing the context menu. 267 Private slot showing the context menu.
266 </p> 268 </p>
267 <dl> 269 <dl>
268 270
269 <dt><i>pos</i></dt> 271 <dt><i>pos</i> (QPoint)</dt>
270 <dd> 272 <dd>
271 position to show the menu at (QPoint) 273 position to show the menu at
272 </dd> 274 </dd>
273 </dl> 275 </dl>
274 <a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a> 276 <a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a>
275 <h4>HelpIndexWidget.eventFilter</h4> 277 <h4>HelpIndexWidget.eventFilter</h4>
276 <b>eventFilter</b>(<i>watched, event</i>) 278 <b>eventFilter</b>(<i>watched, event</i>)
278 <p> 280 <p>
279 Public method called to filter the event queue. 281 Public method called to filter the event queue.
280 </p> 282 </p>
281 <dl> 283 <dl>
282 284
283 <dt><i>watched</i></dt> 285 <dt><i>watched</i> (QObject)</dt>
284 <dd> 286 <dd>
285 the QObject being watched (QObject) 287 the QObject being watched
286 </dd> 288 </dd>
287 <dt><i>event</i></dt> 289 <dt><i>event</i> (QEvent)</dt>
288 <dd> 290 <dd>
289 the event that occurred (QEvent) 291 the event that occurred
290 </dd> 292 </dd>
291 </dl> 293 </dl>
292 <dl> 294 <dl>
293 <dt>Return:</dt> 295 <dt>Return:</dt>
294 <dd> 296 <dd>
295 flag indicating whether the event was handled (boolean) 297 flag indicating whether the event was handled
298 </dd>
299 </dl>
300 <dl>
301 <dt>Return Type:</dt>
302 <dd>
303 bool
296 </dd> 304 </dd>
297 </dl> 305 </dl>
298 <a NAME="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a> 306 <a NAME="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a>
299 <h4>HelpIndexWidget.focusInEvent</h4> 307 <h4>HelpIndexWidget.focusInEvent</h4>
300 <b>focusInEvent</b>(<i>evt</i>) 308 <b>focusInEvent</b>(<i>evt</i>)
302 <p> 310 <p>
303 Protected method handling focus in events. 311 Protected method handling focus in events.
304 </p> 312 </p>
305 <dl> 313 <dl>
306 314
307 <dt><i>evt</i></dt> 315 <dt><i>evt</i> (QFocusEvent)</dt>
308 <dd> 316 <dd>
309 reference to the focus event object (QFocusEvent) 317 reference to the focus event object
310 </dd> 318 </dd>
311 </dl> 319 </dl>
312 <div align="right"><a href="#top">Up</a></div> 320 <div align="right"><a href="#top">Up</a></div>
313 <hr /> 321 <hr />
314 </body></html> 322 </body></html>

Mercurial Repository: eric

eric ide

mercurial