Mercurial Repositories > eric / file comparison

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

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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7900
72b88fb20261
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.QtHelp.HelpIndexWidget</h1> 23 <h1>eric6.WebBrowser.QtHelp.HelpIndexWidget</h1>
24
23 <p> 25 <p>
24 Module implementing a window for showing the QtHelp index. 26 Module implementing a window for showing the QtHelp index.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#HelpIndexWidget">HelpIndexWidget</a></td> 38 <td><a href="#HelpIndexWidget">HelpIndexWidget</a></td>
34 <td>Class implementing a window for showing the QtHelp index.</td> 39 <td>Class implementing a window for showing the QtHelp index.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
39 <tr><td>None</td></tr> 44 <table>
40 </table> 45 <tr><td>None</td></tr>
41 <hr /><hr /> 46 </table>
47 <hr />
48 <hr />
42 <a NAME="HelpIndexWidget" ID="HelpIndexWidget"></a> 49 <a NAME="HelpIndexWidget" ID="HelpIndexWidget"></a>
43 <h2>HelpIndexWidget</h2> 50 <h2>HelpIndexWidget</h2>
51
44 <p> 52 <p>
45 Class implementing a window for showing the QtHelp index. 53 Class implementing a window for showing the QtHelp index.
46 </p><h3>Signals</h3> 54 </p>
47 <dl> 55 <h3>Signals</h3>
56 <dl>
57
48 <dt>escapePressed()</dt> 58 <dt>escapePressed()</dt>
49 <dd> 59 <dd>
50 emitted when the ESC key was pressed 60 emitted when the ESC key was pressed
51 </dd><dt>newBackgroundTab(QUrl, str)</dt> 61 </dd>
62 <dt>newBackgroundTab(QUrl, str)</dt>
52 <dd> 63 <dd>
53 emitted to open an entry in a 64 emitted to open an entry in a
54 new background tab 65 new background tab
55 </dd><dt>newTab(QUrl, str)</dt> 66 </dd>
67 <dt>newTab(QUrl, str)</dt>
56 <dd> 68 <dd>
57 emitted to open an entry in a new tab 69 emitted to open an entry in a new tab
58 </dd><dt>newWindow(QUrl, str)</dt> 70 </dd>
71 <dt>newWindow(QUrl, str)</dt>
59 <dd> 72 <dd>
60 emitted to open an entry in a new window 73 emitted to open an entry in a new window
61 </dd><dt>openUrl(QUrl, str)</dt> 74 </dd>
75 <dt>openUrl(QUrl, str)</dt>
62 <dd> 76 <dd>
63 emitted to open an entry in the current tab 77 emitted to open an entry in the current tab
64 </dd> 78 </dd>
65 </dl> 79 </dl>
66 <h3>Derived from</h3> 80 <h3>Derived from</h3>
67 QWidget 81 QWidget
68 <h3>Class Attributes</h3> 82 <h3>Class Attributes</h3>
83
69 <table> 84 <table>
70 <tr><td>None</td></tr> 85 <tr><td>None</td></tr>
71 </table> 86 </table>
72 <h3>Class Methods</h3> 87 <h3>Class Methods</h3>
88
73 <table> 89 <table>
74 <tr><td>None</td></tr> 90 <tr><td>None</td></tr>
75 </table> 91 </table>
76 <h3>Methods</h3> 92 <h3>Methods</h3>
77 <table> 93
94 <table>
95
78 <tr> 96 <tr>
79 <td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td> 97 <td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td>
80 <td>Constructor</td> 98 <td>Constructor</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td> 101 <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td>
83 <td>Private slot to enable the search edit.</td> 102 <td>Private slot to enable the search edit.</td>
84 </tr><tr> 103 </tr>
104 <tr>
85 <td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td> 105 <td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td>
86 <td>Private slot to enable the search edit.</td> 106 <td>Private slot to enable the search edit.</td>
87 </tr><tr> 107 </tr>
108 <tr>
88 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td> 109 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td>
89 <td>Private slot to filter the indexes according to the given filter.</td> 110 <td>Private slot to filter the indexes according to the given filter.</td>
90 </tr><tr> 111 </tr>
112 <tr>
91 <td><a href="#HelpIndexWidget.__linkActivated">__linkActivated</a></td> 113 <td><a href="#HelpIndexWidget.__linkActivated">__linkActivated</a></td>
92 <td>Private slot to handle the activation of a keyword entry.</td> 114 <td>Private slot to handle the activation of a keyword entry.</td>
93 </tr><tr> 115 </tr>
116 <tr>
94 <td><a href="#HelpIndexWidget.__linksActivated">__linksActivated</a></td> 117 <td><a href="#HelpIndexWidget.__linksActivated">__linksActivated</a></td>
95 <td>Private slot to handle the activation of an entry with multiple links.</td> 118 <td>Private slot to handle the activation of an entry with multiple links.</td>
96 </tr><tr> 119 </tr>
120 <tr>
97 <td><a href="#HelpIndexWidget.__selectLink">__selectLink</a></td> 121 <td><a href="#HelpIndexWidget.__selectLink">__selectLink</a></td>
98 <td>Private method to give the user a chance to select among the returned links.</td> 122 <td>Private method to give the user a chance to select among the returned links.</td>
99 </tr><tr> 123 </tr>
124 <tr>
100 <td><a href="#HelpIndexWidget.__showContextMenu">__showContextMenu</a></td> 125 <td><a href="#HelpIndexWidget.__showContextMenu">__showContextMenu</a></td>
101 <td>Private slot showing the context menu.</td> 126 <td>Private slot showing the context menu.</td>
102 </tr><tr> 127 </tr>
128 <tr>
103 <td><a href="#HelpIndexWidget.eventFilter">eventFilter</a></td> 129 <td><a href="#HelpIndexWidget.eventFilter">eventFilter</a></td>
104 <td>Public method called to filter the event queue.</td> 130 <td>Public method called to filter the event queue.</td>
105 </tr><tr> 131 </tr>
132 <tr>
106 <td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td> 133 <td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td>
107 <td>Protected method handling focus in events.</td> 134 <td>Protected method handling focus in events.</td>
108 </tr> 135 </tr>
109 </table> 136 </table>
110 <h3>Static Methods</h3> 137 <h3>Static Methods</h3>
111 <table> 138
112 <tr><td>None</td></tr> 139 <table>
113 </table> 140 <tr><td>None</td></tr>
141 </table>
142
114 <a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a> 143 <a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a>
115 <h4>HelpIndexWidget (Constructor)</h4> 144 <h4>HelpIndexWidget (Constructor)</h4>
116 <b>HelpIndexWidget</b>(<i>engine, parent=None</i>) 145 <b>HelpIndexWidget</b>(<i>engine, parent=None</i>)
146
117 <p> 147 <p>
118 Constructor 148 Constructor
119 </p><dl> 149 </p>
150 <dl>
151
120 <dt><i>engine</i></dt> 152 <dt><i>engine</i></dt>
121 <dd> 153 <dd>
122 reference to the help engine (QHelpEngine) 154 reference to the help engine (QHelpEngine)
123 </dd><dt><i>parent</i></dt> 155 </dd>
156 <dt><i>parent</i></dt>
124 <dd> 157 <dd>
125 reference to the parent widget (QWidget) 158 reference to the parent widget (QWidget)
126 </dd> 159 </dd>
127 </dl><a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a> 160 </dl>
161 <a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a>
128 <h4>HelpIndexWidget.__disableSearchEdit</h4> 162 <h4>HelpIndexWidget.__disableSearchEdit</h4>
129 <b>__disableSearchEdit</b>(<i></i>) 163 <b>__disableSearchEdit</b>(<i></i>)
164
130 <p> 165 <p>
131 Private slot to enable the search edit. 166 Private slot to enable the search edit.
132 </p><a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a> 167 </p>
168 <a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a>
133 <h4>HelpIndexWidget.__enableSearchEdit</h4> 169 <h4>HelpIndexWidget.__enableSearchEdit</h4>
134 <b>__enableSearchEdit</b>(<i></i>) 170 <b>__enableSearchEdit</b>(<i></i>)
171
135 <p> 172 <p>
136 Private slot to enable the search edit. 173 Private slot to enable the search edit.
137 </p><a NAME="HelpIndexWidget.__filterIndices" ID="HelpIndexWidget.__filterIndices"></a> 174 </p>
175 <a NAME="HelpIndexWidget.__filterIndices" ID="HelpIndexWidget.__filterIndices"></a>
138 <h4>HelpIndexWidget.__filterIndices</h4> 176 <h4>HelpIndexWidget.__filterIndices</h4>
139 <b>__filterIndices</b>(<i>indexFilter</i>) 177 <b>__filterIndices</b>(<i>indexFilter</i>)
178
140 <p> 179 <p>
141 Private slot to filter the indexes according to the given filter. 180 Private slot to filter the indexes according to the given filter.
142 </p><dl> 181 </p>
182 <dl>
183
143 <dt><i>indexFilter</i></dt> 184 <dt><i>indexFilter</i></dt>
144 <dd> 185 <dd>
145 filter to be used (string) 186 filter to be used (string)
146 </dd> 187 </dd>
147 </dl><a NAME="HelpIndexWidget.__linkActivated" ID="HelpIndexWidget.__linkActivated"></a> 188 </dl>
189 <a NAME="HelpIndexWidget.__linkActivated" ID="HelpIndexWidget.__linkActivated"></a>
148 <h4>HelpIndexWidget.__linkActivated</h4> 190 <h4>HelpIndexWidget.__linkActivated</h4>
149 <b>__linkActivated</b>(<i>url, keyword, modifiers=None</i>) 191 <b>__linkActivated</b>(<i>url, keyword, modifiers=None</i>)
192
150 <p> 193 <p>
151 Private slot to handle the activation of a keyword entry. 194 Private slot to handle the activation of a keyword entry.
152 </p><dl> 195 </p>
196 <dl>
197
153 <dt><i>url</i> (QUrl)</dt> 198 <dt><i>url</i> (QUrl)</dt>
154 <dd> 199 <dd>
155 URL of the selected entry 200 URL of the selected entry
156 </dd><dt><i>keyword</i> (str)</dt> 201 </dd>
202 <dt><i>keyword</i> (str)</dt>
157 <dd> 203 <dd>
158 keyword for the URL 204 keyword for the URL
159 </dd><dt><i>modifiers=</i> (Qt.KeyboardModifiers or None)</dt> 205 </dd>
206 <dt><i>modifiers=</i> (Qt.KeyboardModifiers or None)</dt>
160 <dd> 207 <dd>
161 keyboard modifiers 208 keyboard modifiers
162 </dd> 209 </dd>
163 </dl><a NAME="HelpIndexWidget.__linksActivated" ID="HelpIndexWidget.__linksActivated"></a> 210 </dl>
211 <a NAME="HelpIndexWidget.__linksActivated" ID="HelpIndexWidget.__linksActivated"></a>
164 <h4>HelpIndexWidget.__linksActivated</h4> 212 <h4>HelpIndexWidget.__linksActivated</h4>
165 <b>__linksActivated</b>(<i>links, keyword</i>) 213 <b>__linksActivated</b>(<i>links, keyword</i>)
214
166 <p> 215 <p>
167 Private slot to handle the activation of an entry with multiple links. 216 Private slot to handle the activation of an entry with multiple links.
168 </p><dl> 217 </p>
218 <dl>
219
169 <dt><i>links</i> (dict of key:str and value:QUrl)</dt> 220 <dt><i>links</i> (dict of key:str and value:QUrl)</dt>
170 <dd> 221 <dd>
171 dictionary containing the links 222 dictionary containing the links
172 </dd><dt><i>keyword</i> (str)</dt> 223 </dd>
224 <dt><i>keyword</i> (str)</dt>
173 <dd> 225 <dd>
174 keyword for the entry 226 keyword for the entry
175 </dd> 227 </dd>
176 </dl><a NAME="HelpIndexWidget.__selectLink" ID="HelpIndexWidget.__selectLink"></a> 228 </dl>
229 <a NAME="HelpIndexWidget.__selectLink" ID="HelpIndexWidget.__selectLink"></a>
177 <h4>HelpIndexWidget.__selectLink</h4> 230 <h4>HelpIndexWidget.__selectLink</h4>
178 <b>__selectLink</b>(<i>links, keyword</i>) 231 <b>__selectLink</b>(<i>links, keyword</i>)
232
179 <p> 233 <p>
180 Private method to give the user a chance to select among the 234 Private method to give the user a chance to select among the
181 returned links. 235 returned links.
182 </p><dl> 236 </p>
237 <dl>
238
183 <dt><i>links</i> (dictionary of str (key) and QUrl (value))</dt> 239 <dt><i>links</i> (dictionary of str (key) and QUrl (value))</dt>
184 <dd> 240 <dd>
185 dictionary of document title and URL to select from 241 dictionary of document title and URL to select from
186 </dd><dt><i>keyword</i> (str)</dt> 242 </dd>
243 <dt><i>keyword</i> (str)</dt>
187 <dd> 244 <dd>
188 keyword for the link set 245 keyword for the link set
189 </dd> 246 </dd>
190 </dl><dl> 247 </dl>
248 <dl>
191 <dt>Returns:</dt> 249 <dt>Returns:</dt>
192 <dd> 250 <dd>
193 selected link 251 selected link
194 </dd> 252 </dd>
195 </dl><dl> 253 </dl>
254 <dl>
196 <dt>Return Type:</dt> 255 <dt>Return Type:</dt>
197 <dd> 256 <dd>
198 QUrl 257 QUrl
199 </dd> 258 </dd>
200 </dl><a NAME="HelpIndexWidget.__showContextMenu" ID="HelpIndexWidget.__showContextMenu"></a> 259 </dl>
260 <a NAME="HelpIndexWidget.__showContextMenu" ID="HelpIndexWidget.__showContextMenu"></a>
201 <h4>HelpIndexWidget.__showContextMenu</h4> 261 <h4>HelpIndexWidget.__showContextMenu</h4>
202 <b>__showContextMenu</b>(<i>pos</i>) 262 <b>__showContextMenu</b>(<i>pos</i>)
263
203 <p> 264 <p>
204 Private slot showing the context menu. 265 Private slot showing the context menu.
205 </p><dl> 266 </p>
267 <dl>
268
206 <dt><i>pos</i></dt> 269 <dt><i>pos</i></dt>
207 <dd> 270 <dd>
208 position to show the menu at (QPoint) 271 position to show the menu at (QPoint)
209 </dd> 272 </dd>
210 </dl><a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a> 273 </dl>
274 <a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a>
211 <h4>HelpIndexWidget.eventFilter</h4> 275 <h4>HelpIndexWidget.eventFilter</h4>
212 <b>eventFilter</b>(<i>watched, event</i>) 276 <b>eventFilter</b>(<i>watched, event</i>)
277
213 <p> 278 <p>
214 Public method called to filter the event queue. 279 Public method called to filter the event queue.
215 </p><dl> 280 </p>
281 <dl>
282
216 <dt><i>watched</i></dt> 283 <dt><i>watched</i></dt>
217 <dd> 284 <dd>
218 the QObject being watched (QObject) 285 the QObject being watched (QObject)
219 </dd><dt><i>event</i></dt> 286 </dd>
287 <dt><i>event</i></dt>
220 <dd> 288 <dd>
221 the event that occurred (QEvent) 289 the event that occurred (QEvent)
222 </dd> 290 </dd>
223 </dl><dl> 291 </dl>
292 <dl>
224 <dt>Returns:</dt> 293 <dt>Returns:</dt>
225 <dd> 294 <dd>
226 flag indicating whether the event was handled (boolean) 295 flag indicating whether the event was handled (boolean)
227 </dd> 296 </dd>
228 </dl><a NAME="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a> 297 </dl>
298 <a NAME="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a>
229 <h4>HelpIndexWidget.focusInEvent</h4> 299 <h4>HelpIndexWidget.focusInEvent</h4>
230 <b>focusInEvent</b>(<i>evt</i>) 300 <b>focusInEvent</b>(<i>evt</i>)
301
231 <p> 302 <p>
232 Protected method handling focus in events. 303 Protected method handling focus in events.
233 </p><dl> 304 </p>
305 <dl>
306
234 <dt><i>evt</i></dt> 307 <dt><i>evt</i></dt>
235 <dd> 308 <dd>
236 reference to the focus event object (QFocusEvent) 309 reference to the focus event object (QFocusEvent)
237 </dd> 310 </dd>
238 </dl> 311 </dl>

Mercurial Repository: eric

eric ide

mercurial