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 8372
e0227a7c850e
child 8422
bb5da74c1b3f
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.QtHelp.HelpIndexWidget</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.WebBrowser.QtHelp.HelpIndexWidget</h1>
24
25 <p>
26 Module implementing a window for showing the QtHelp index.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#HelpIndexWidget">HelpIndexWidget</a></td>
39 <td>Class implementing a window for showing the QtHelp index.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="HelpIndexWidget" ID="HelpIndexWidget"></a>
50 <h2>HelpIndexWidget</h2>
51
52 <p>
53 Class implementing a window for showing the QtHelp index.
54 </p>
55 <h3>Signals</h3>
56 <dl>
57
58 <dt>escapePressed()</dt>
59 <dd>
60 emitted when the ESC key was pressed
61 </dd>
62 <dt>newBackgroundTab(QUrl, str)</dt>
63 <dd>
64 emitted to open an entry in a
65 new background tab
66 </dd>
67 <dt>newTab(QUrl, str)</dt>
68 <dd>
69 emitted to open an entry in a new tab
70 </dd>
71 <dt>newWindow(QUrl, str)</dt>
72 <dd>
73 emitted to open an entry in a new window
74 </dd>
75 <dt>openUrl(QUrl, str)</dt>
76 <dd>
77 emitted to open an entry in the current tab
78 </dd>
79 </dl>
80 <h3>Derived from</h3>
81 QWidget
82 <h3>Class Attributes</h3>
83
84 <table>
85 <tr><td>None</td></tr>
86 </table>
87 <h3>Class Methods</h3>
88
89 <table>
90 <tr><td>None</td></tr>
91 </table>
92 <h3>Methods</h3>
93
94 <table>
95
96 <tr>
97 <td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td>
98 <td>Constructor</td>
99 </tr>
100 <tr>
101 <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td>
102 <td>Private slot to enable the search edit.</td>
103 </tr>
104 <tr>
105 <td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td>
106 <td>Private slot to enable the search edit.</td>
107 </tr>
108 <tr>
109 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td>
110 <td>Private slot to filter the indexes according to the given filter.</td>
111 </tr>
112 <tr>
113 <td><a href="#HelpIndexWidget.__linkActivated">__linkActivated</a></td>
114 <td>Private slot to handle the activation of a keyword entry.</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>
124 <tr>
125 <td><a href="#HelpIndexWidget.__showContextMenu">__showContextMenu</a></td>
126 <td>Private slot showing the context menu.</td>
127 </tr>
128 <tr>
129 <td><a href="#HelpIndexWidget.eventFilter">eventFilter</a></td>
130 <td>Public method called to filter the event queue.</td>
131 </tr>
132 <tr>
133 <td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td>
134 <td>Protected method handling focus in events.</td>
135 </tr>
136 </table>
137 <h3>Static Methods</h3>
138
139 <table>
140 <tr><td>None</td></tr>
141 </table>
142
143 <a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a>
144 <h4>HelpIndexWidget (Constructor)</h4>
145 <b>HelpIndexWidget</b>(<i>engine, parent=None</i>)
146
147 <p>
148 Constructor
149 </p>
150 <dl>
151
152 <dt><i>engine</i></dt>
153 <dd>
154 reference to the help engine (QHelpEngine)
155 </dd>
156 <dt><i>parent</i></dt>
157 <dd>
158 reference to the parent widget (QWidget)
159 </dd>
160 </dl>
161 <a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a>
162 <h4>HelpIndexWidget.__disableSearchEdit</h4>
163 <b>__disableSearchEdit</b>(<i></i>)
164
165 <p>
166 Private slot to enable the search edit.
167 </p>
168 <a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a>
169 <h4>HelpIndexWidget.__enableSearchEdit</h4>
170 <b>__enableSearchEdit</b>(<i></i>)
171
172 <p>
173 Private slot to enable the search edit.
174 </p>
175 <a NAME="HelpIndexWidget.__filterIndices" ID="HelpIndexWidget.__filterIndices"></a>
176 <h4>HelpIndexWidget.__filterIndices</h4>
177 <b>__filterIndices</b>(<i>indexFilter</i>)
178
179 <p>
180 Private slot to filter the indexes according to the given filter.
181 </p>
182 <dl>
183
184 <dt><i>indexFilter</i></dt>
185 <dd>
186 filter to be used (string)
187 </dd>
188 </dl>
189 <a NAME="HelpIndexWidget.__linkActivated" ID="HelpIndexWidget.__linkActivated"></a>
190 <h4>HelpIndexWidget.__linkActivated</h4>
191 <b>__linkActivated</b>(<i>url, keyword, modifiers=None</i>)
192
193 <p>
194 Private slot to handle the activation of a keyword entry.
195 </p>
196 <dl>
197
198 <dt><i>url</i> (QUrl)</dt>
199 <dd>
200 URL of the selected entry
201 </dd>
202 <dt><i>keyword</i> (str)</dt>
203 <dd>
204 keyword for the URL
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>
247 </dl>
248 <dl>
249 <dt>Return:</dt>
250 <dd>
251 selected link
252 </dd>
253 </dl>
254 <dl>
255 <dt>Return Type:</dt>
256 <dd>
257 QUrl
258 </dd>
259 </dl>
260 <a NAME="HelpIndexWidget.__showContextMenu" ID="HelpIndexWidget.__showContextMenu"></a>
261 <h4>HelpIndexWidget.__showContextMenu</h4>
262 <b>__showContextMenu</b>(<i>pos</i>)
263
264 <p>
265 Private slot showing the context menu.
266 </p>
267 <dl>
268
269 <dt><i>pos</i></dt>
270 <dd>
271 position to show the menu at (QPoint)
272 </dd>
273 </dl>
274 <a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a>
275 <h4>HelpIndexWidget.eventFilter</h4>
276 <b>eventFilter</b>(<i>watched, event</i>)
277
278 <p>
279 Public method called to filter the event queue.
280 </p>
281 <dl>
282
283 <dt><i>watched</i></dt>
284 <dd>
285 the QObject being watched (QObject)
286 </dd>
287 <dt><i>event</i></dt>
288 <dd>
289 the event that occurred (QEvent)
290 </dd>
291 </dl>
292 <dl>
293 <dt>Return:</dt>
294 <dd>
295 flag indicating whether the event was handled (boolean)
296 </dd>
297 </dl>
298 <a NAME="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a>
299 <h4>HelpIndexWidget.focusInEvent</h4>
300 <b>focusInEvent</b>(<i>evt</i>)
301
302 <p>
303 Protected method handling focus in events.
304 </p>
305 <dl>
306
307 <dt><i>evt</i></dt>
308 <dd>
309 reference to the focus event object (QFocusEvent)
310 </dd>
311 </dl>
312 <div align="right"><a href="#top">Up</a></div>
313 <hr />
314 </body></html>

Mercurial Repository: eric

eric ide

mercurial