|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.HelpViewer.HelpViewerWidget</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.HelpViewer.HelpViewerWidget</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing an embedded viewer for QtHelp and local HTML files. |
|
13 </p> |
|
14 <h3>Global Attributes</h3> |
|
15 |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 |
|
21 <table> |
|
22 |
|
23 <tr> |
|
24 <td><a href="#HelpViewerWidget">HelpViewerWidget</a></td> |
|
25 <td>Class implementing an embedded viewer for QtHelp and local HTML files.</td> |
|
26 </tr> |
|
27 </table> |
|
28 <h3>Functions</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <hr /> |
|
34 <hr /> |
|
35 <a NAME="HelpViewerWidget" ID="HelpViewerWidget"></a> |
|
36 <h2>HelpViewerWidget</h2> |
|
37 |
|
38 <p> |
|
39 Class implementing an embedded viewer for QtHelp and local HTML files. |
|
40 </p> |
|
41 <h3>Derived from</h3> |
|
42 QWidget |
|
43 <h3>Class Attributes</h3> |
|
44 |
|
45 <table> |
|
46 <tr><td>EmpytDocument_Dark</td></tr><tr><td>EmpytDocument_Light</td></tr><tr><td>MaxHistoryItems</td></tr> |
|
47 </table> |
|
48 <h3>Class Methods</h3> |
|
49 |
|
50 <table> |
|
51 |
|
52 <tr> |
|
53 <td><a href="#HelpViewerWidget.emptyDocument">emptyDocument</a></td> |
|
54 <td>Class method to get the HTML code for an empty page.</td> |
|
55 </tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 |
|
59 <table> |
|
60 |
|
61 <tr> |
|
62 <td><a href="#HelpViewerWidget.__init__">HelpViewerWidget</a></td> |
|
63 <td>Constructor</td> |
|
64 </tr> |
|
65 <tr> |
|
66 <td><a href="#HelpViewerWidget.__activateCurrentPage">__activateCurrentPage</a></td> |
|
67 <td>Private slot to activate the current page.</td> |
|
68 </tr> |
|
69 <tr> |
|
70 <td><a href="#HelpViewerWidget.__addNavigationButton">__addNavigationButton</a></td> |
|
71 <td>Private method to create and add a navigation button.</td> |
|
72 </tr> |
|
73 <tr> |
|
74 <td><a href="#HelpViewerWidget.__addNewPage">__addNewPage</a></td> |
|
75 <td>Private slot to add a new empty page.</td> |
|
76 </tr> |
|
77 <tr> |
|
78 <td><a href="#HelpViewerWidget.__backward">__backward</a></td> |
|
79 <td>Private slot to move one page backward.</td> |
|
80 </tr> |
|
81 <tr> |
|
82 <td><a href="#HelpViewerWidget.__checkActionButtons">__checkActionButtons</a></td> |
|
83 <td>Private slot to set the enabled state of the action buttons.</td> |
|
84 </tr> |
|
85 <tr> |
|
86 <td><a href="#HelpViewerWidget.__clearHistory">__clearHistory</a></td> |
|
87 <td>Private slot to clear the history of the current viewer.</td> |
|
88 </tr> |
|
89 <tr> |
|
90 <td><a href="#HelpViewerWidget.__configureHelpDocumentation">__configureHelpDocumentation</a></td> |
|
91 <td>Private slot to open the Help Documentation configuration page.</td> |
|
92 </tr> |
|
93 <tr> |
|
94 <td><a href="#HelpViewerWidget.__currentFilterChanged">__currentFilterChanged</a></td> |
|
95 <td>Private slot handling a change of the active QtHelp filter.</td> |
|
96 </tr> |
|
97 <tr> |
|
98 <td><a href="#HelpViewerWidget.__currentPageChanged">__currentPageChanged</a></td> |
|
99 <td>Private slot handling the selection of another page.</td> |
|
100 </tr> |
|
101 <tr> |
|
102 <td><a href="#HelpViewerWidget.__docsInstalled">__docsInstalled</a></td> |
|
103 <td>Private slot handling the end of documentation installation.</td> |
|
104 </tr> |
|
105 <tr> |
|
106 <td><a href="#HelpViewerWidget.__filterQtHelpDocumentation">__filterQtHelpDocumentation</a></td> |
|
107 <td>Private slot to filter the QtHelp documentation.</td> |
|
108 </tr> |
|
109 <tr> |
|
110 <td><a href="#HelpViewerWidget.__forward">__forward</a></td> |
|
111 <td>Private slot to move one page foreward.</td> |
|
112 </tr> |
|
113 <tr> |
|
114 <td><a href="#HelpViewerWidget.__getQtHelpCollectionFileName">__getQtHelpCollectionFileName</a></td> |
|
115 <td>Private method to determine the name of the QtHelp collection file.</td> |
|
116 </tr> |
|
117 <tr> |
|
118 <td><a href="#HelpViewerWidget.__helpTopicSelected">__helpTopicSelected</a></td> |
|
119 <td>Private slot handling the selection of a new help topic.</td> |
|
120 </tr> |
|
121 <tr> |
|
122 <td><a href="#HelpViewerWidget.__indexingFinished">__indexingFinished</a></td> |
|
123 <td>Private slot handling the end of the indexing process.</td> |
|
124 </tr> |
|
125 <tr> |
|
126 <td><a href="#HelpViewerWidget.__indexingStarted">__indexingStarted</a></td> |
|
127 <td>Private slot handling the start of the indexing process.</td> |
|
128 </tr> |
|
129 <tr> |
|
130 <td><a href="#HelpViewerWidget.__initActionsMenu">__initActionsMenu</a></td> |
|
131 <td>Private method to initialize the actions menu.</td> |
|
132 </tr> |
|
133 <tr> |
|
134 <td><a href="#HelpViewerWidget.__initFilterWidget">__initFilterWidget</a></td> |
|
135 <td>Private method to initialize the filter selection widget.</td> |
|
136 </tr> |
|
137 <tr> |
|
138 <td><a href="#HelpViewerWidget.__initHelpEngine">__initHelpEngine</a></td> |
|
139 <td>Private method to initialize the QtHelp related stuff.</td> |
|
140 </tr> |
|
141 <tr> |
|
142 <td><a href="#HelpViewerWidget.__initIndexingProgress">__initIndexingProgress</a></td> |
|
143 <td>Private method to initialize the help documents indexing progress widget.</td> |
|
144 </tr> |
|
145 <tr> |
|
146 <td><a href="#HelpViewerWidget.__initQWebEngine">__initQWebEngine</a></td> |
|
147 <td>Private method to initialize global QWebEngine related objects.</td> |
|
148 </tr> |
|
149 <tr> |
|
150 <td><a href="#HelpViewerWidget.__initQWebEngineSettings">__initQWebEngineSettings</a></td> |
|
151 <td>Private method to set the global web settings.</td> |
|
152 </tr> |
|
153 <tr> |
|
154 <td><a href="#HelpViewerWidget.__lookForNewDocumentation">__lookForNewDocumentation</a></td> |
|
155 <td>Private slot to look for new documentation to be loaded into the help database.</td> |
|
156 </tr> |
|
157 <tr> |
|
158 <td><a href="#HelpViewerWidget.__manageQtHelpDocuments">__manageQtHelpDocuments</a></td> |
|
159 <td>Private slot to manage the QtHelp documentation database.</td> |
|
160 </tr> |
|
161 <tr> |
|
162 <td><a href="#HelpViewerWidget.__navigationMenuActionTriggered">__navigationMenuActionTriggered</a></td> |
|
163 <td>Private slot to go to the selected page.</td> |
|
164 </tr> |
|
165 <tr> |
|
166 <td><a href="#HelpViewerWidget.__newViewer">__newViewer</a></td> |
|
167 <td>Private method to create a new help viewer.</td> |
|
168 </tr> |
|
169 <tr> |
|
170 <td><a href="#HelpViewerWidget.__openFile">__openFile</a></td> |
|
171 <td>Private slot to open a local help file (*.html).</td> |
|
172 </tr> |
|
173 <tr> |
|
174 <td><a href="#HelpViewerWidget.__populateHelpSelector">__populateHelpSelector</a></td> |
|
175 <td>Private method to populate the help selection combo box.</td> |
|
176 </tr> |
|
177 <tr> |
|
178 <td><a href="#HelpViewerWidget.__populateNavigationStack">__populateNavigationStack</a></td> |
|
179 <td>Private method to populate the stack of navigation widgets.</td> |
|
180 </tr> |
|
181 <tr> |
|
182 <td><a href="#HelpViewerWidget.__reload">__reload</a></td> |
|
183 <td>Private slot to reload the current page.</td> |
|
184 </tr> |
|
185 <tr> |
|
186 <td><a href="#HelpViewerWidget.__removeOldDocumentation">__removeOldDocumentation</a></td> |
|
187 <td>Private slot to remove non-existing documentation from the help engine.</td> |
|
188 </tr> |
|
189 <tr> |
|
190 <td><a href="#HelpViewerWidget.__searchWidgetClosed">__searchWidgetClosed</a></td> |
|
191 <td>Private slot to handle the closing of the search widget.</td> |
|
192 </tr> |
|
193 <tr> |
|
194 <td><a href="#HelpViewerWidget.__selectNavigationWidget">__selectNavigationWidget</a></td> |
|
195 <td>Private slot to select the navigation widget.</td> |
|
196 </tr> |
|
197 <tr> |
|
198 <td><a href="#HelpViewerWidget.__setupFilterCombo">__setupFilterCombo</a></td> |
|
199 <td>Private slot to setup the filter combo box.</td> |
|
200 </tr> |
|
201 <tr> |
|
202 <td><a href="#HelpViewerWidget.__showBackMenu">__showBackMenu</a></td> |
|
203 <td>Private slot showing the backward navigation menu.</td> |
|
204 </tr> |
|
205 <tr> |
|
206 <td><a href="#HelpViewerWidget.__showForwardMenu">__showForwardMenu</a></td> |
|
207 <td>Private slot showing the forward navigation menu.</td> |
|
208 </tr> |
|
209 <tr> |
|
210 <td><a href="#HelpViewerWidget.__showInstallationError">__showInstallationError</a></td> |
|
211 <td>Private slot to show installation errors.</td> |
|
212 </tr> |
|
213 <tr> |
|
214 <td><a href="#HelpViewerWidget.__warning">__warning</a></td> |
|
215 <td>Private slot handling warnings of the help engine.</td> |
|
216 </tr> |
|
217 <tr> |
|
218 <td><a href="#HelpViewerWidget.__zoomIn">__zoomIn</a></td> |
|
219 <td>Private slot to zoom in.</td> |
|
220 </tr> |
|
221 <tr> |
|
222 <td><a href="#HelpViewerWidget.__zoomOut">__zoomOut</a></td> |
|
223 <td>Private slot to zoom out.</td> |
|
224 </tr> |
|
225 <tr> |
|
226 <td><a href="#HelpViewerWidget.__zoomReset">__zoomReset</a></td> |
|
227 <td>Private slot to reset the zoom level.</td> |
|
228 </tr> |
|
229 <tr> |
|
230 <td><a href="#HelpViewerWidget.activate">activate</a></td> |
|
231 <td>Public method to activate the widget and search for a given word.</td> |
|
232 </tr> |
|
233 <tr> |
|
234 <td><a href="#HelpViewerWidget.addPage">addPage</a></td> |
|
235 <td>Public method to add a new help page with the given URL.</td> |
|
236 </tr> |
|
237 <tr> |
|
238 <td><a href="#HelpViewerWidget.bookmarkPage">bookmarkPage</a></td> |
|
239 <td>Public method to bookmark a page with the given data.</td> |
|
240 </tr> |
|
241 <tr> |
|
242 <td><a href="#HelpViewerWidget.closeAllPages">closeAllPages</a></td> |
|
243 <td>Public slot to close all pages.</td> |
|
244 </tr> |
|
245 <tr> |
|
246 <td><a href="#HelpViewerWidget.closeCurrentPage">closeCurrentPage</a></td> |
|
247 <td>Public slot to close the current page.</td> |
|
248 </tr> |
|
249 <tr> |
|
250 <td><a href="#HelpViewerWidget.closeOtherPages">closeOtherPages</a></td> |
|
251 <td>Public slot to close all other pages.</td> |
|
252 </tr> |
|
253 <tr> |
|
254 <td><a href="#HelpViewerWidget.currentViewer">currentViewer</a></td> |
|
255 <td>Public method to get the active viewer.</td> |
|
256 </tr> |
|
257 <tr> |
|
258 <td><a href="#HelpViewerWidget.openPagesCount">openPagesCount</a></td> |
|
259 <td>Public method to get the count of open pages.</td> |
|
260 </tr> |
|
261 <tr> |
|
262 <td><a href="#HelpViewerWidget.openUrl">openUrl</a></td> |
|
263 <td>Public slot to load a URL in the current page.</td> |
|
264 </tr> |
|
265 <tr> |
|
266 <td><a href="#HelpViewerWidget.openUrlNewBackgroundPage">openUrlNewBackgroundPage</a></td> |
|
267 <td>Public slot to load a URL in a new background page.</td> |
|
268 </tr> |
|
269 <tr> |
|
270 <td><a href="#HelpViewerWidget.openUrlNewPage">openUrlNewPage</a></td> |
|
271 <td>Public slot to load a URL in a new page.</td> |
|
272 </tr> |
|
273 <tr> |
|
274 <td><a href="#HelpViewerWidget.searchNext">searchNext</a></td> |
|
275 <td>Public slot to find the next occurrence of the current search term.</td> |
|
276 </tr> |
|
277 <tr> |
|
278 <td><a href="#HelpViewerWidget.searchPrev">searchPrev</a></td> |
|
279 <td>Public slot to find the previous occurrence of the current search term.</td> |
|
280 </tr> |
|
281 <tr> |
|
282 <td><a href="#HelpViewerWidget.searchQtHelp">searchQtHelp</a></td> |
|
283 <td>Public slot to search for a given search expression.</td> |
|
284 </tr> |
|
285 <tr> |
|
286 <td><a href="#HelpViewerWidget.showHideSearch">showHideSearch</a></td> |
|
287 <td>Public slot to show or hide the search widget.</td> |
|
288 </tr> |
|
289 <tr> |
|
290 <td><a href="#HelpViewerWidget.shutdown">shutdown</a></td> |
|
291 <td>Public method to perform shut down actions.</td> |
|
292 </tr> |
|
293 <tr> |
|
294 <td><a href="#HelpViewerWidget.webProfile">webProfile</a></td> |
|
295 <td>Public method to get a reference to the global web profile object.</td> |
|
296 </tr> |
|
297 <tr> |
|
298 <td><a href="#HelpViewerWidget.webSettings">webSettings</a></td> |
|
299 <td>Public method to get the web settings of the current profile.</td> |
|
300 </tr> |
|
301 </table> |
|
302 <h3>Static Methods</h3> |
|
303 |
|
304 <table> |
|
305 <tr><td>None</td></tr> |
|
306 </table> |
|
307 |
|
308 <a NAME="HelpViewerWidget.emptyDocument" ID="HelpViewerWidget.emptyDocument"></a> |
|
309 <h4>HelpViewerWidget.emptyDocument (class method)</h4> |
|
310 <b>emptyDocument</b>(<i></i>) |
|
311 |
|
312 <p> |
|
313 Class method to get the HTML code for an empty page. |
|
314 </p> |
|
315 <dl> |
|
316 <dt>Return:</dt> |
|
317 <dd> |
|
318 HTML code for an empty page. |
|
319 </dd> |
|
320 </dl> |
|
321 <dl> |
|
322 <dt>Return Type:</dt> |
|
323 <dd> |
|
324 str |
|
325 </dd> |
|
326 </dl> |
|
327 <a NAME="HelpViewerWidget.__init__" ID="HelpViewerWidget.__init__"></a> |
|
328 <h4>HelpViewerWidget (Constructor)</h4> |
|
329 <b>HelpViewerWidget</b>(<i>parent=None</i>) |
|
330 |
|
331 <p> |
|
332 Constructor |
|
333 </p> |
|
334 <dl> |
|
335 |
|
336 <dt><i>parent</i> (QWidget (optional))</dt> |
|
337 <dd> |
|
338 reference to the parent widget (defaults to None) |
|
339 </dd> |
|
340 </dl> |
|
341 <a NAME="HelpViewerWidget.__activateCurrentPage" ID="HelpViewerWidget.__activateCurrentPage"></a> |
|
342 <h4>HelpViewerWidget.__activateCurrentPage</h4> |
|
343 <b>__activateCurrentPage</b>(<i></i>) |
|
344 |
|
345 <p> |
|
346 Private slot to activate the current page. |
|
347 </p> |
|
348 <a NAME="HelpViewerWidget.__addNavigationButton" ID="HelpViewerWidget.__addNavigationButton"></a> |
|
349 <h4>HelpViewerWidget.__addNavigationButton</h4> |
|
350 <b>__addNavigationButton</b>(<i>iconName, toolTip</i>) |
|
351 |
|
352 <p> |
|
353 Private method to create and add a navigation button. |
|
354 </p> |
|
355 <dl> |
|
356 |
|
357 <dt><i>iconName</i> (str)</dt> |
|
358 <dd> |
|
359 name of the icon |
|
360 </dd> |
|
361 <dt><i>toolTip</i> (str)</dt> |
|
362 <dd> |
|
363 tooltip to be shown |
|
364 </dd> |
|
365 </dl> |
|
366 <dl> |
|
367 <dt>Return:</dt> |
|
368 <dd> |
|
369 reference to the created button |
|
370 </dd> |
|
371 </dl> |
|
372 <dl> |
|
373 <dt>Return Type:</dt> |
|
374 <dd> |
|
375 QToolButton |
|
376 </dd> |
|
377 </dl> |
|
378 <a NAME="HelpViewerWidget.__addNewPage" ID="HelpViewerWidget.__addNewPage"></a> |
|
379 <h4>HelpViewerWidget.__addNewPage</h4> |
|
380 <b>__addNewPage</b>(<i></i>) |
|
381 |
|
382 <p> |
|
383 Private slot to add a new empty page. |
|
384 </p> |
|
385 <a NAME="HelpViewerWidget.__backward" ID="HelpViewerWidget.__backward"></a> |
|
386 <h4>HelpViewerWidget.__backward</h4> |
|
387 <b>__backward</b>(<i></i>) |
|
388 |
|
389 <p> |
|
390 Private slot to move one page backward. |
|
391 </p> |
|
392 <a NAME="HelpViewerWidget.__checkActionButtons" ID="HelpViewerWidget.__checkActionButtons"></a> |
|
393 <h4>HelpViewerWidget.__checkActionButtons</h4> |
|
394 <b>__checkActionButtons</b>(<i></i>) |
|
395 |
|
396 <p> |
|
397 Private slot to set the enabled state of the action buttons. |
|
398 </p> |
|
399 <a NAME="HelpViewerWidget.__clearHistory" ID="HelpViewerWidget.__clearHistory"></a> |
|
400 <h4>HelpViewerWidget.__clearHistory</h4> |
|
401 <b>__clearHistory</b>(<i></i>) |
|
402 |
|
403 <p> |
|
404 Private slot to clear the history of the current viewer. |
|
405 </p> |
|
406 <a NAME="HelpViewerWidget.__configureHelpDocumentation" ID="HelpViewerWidget.__configureHelpDocumentation"></a> |
|
407 <h4>HelpViewerWidget.__configureHelpDocumentation</h4> |
|
408 <b>__configureHelpDocumentation</b>(<i></i>) |
|
409 |
|
410 <p> |
|
411 Private slot to open the Help Documentation configuration page. |
|
412 </p> |
|
413 <a NAME="HelpViewerWidget.__currentFilterChanged" ID="HelpViewerWidget.__currentFilterChanged"></a> |
|
414 <h4>HelpViewerWidget.__currentFilterChanged</h4> |
|
415 <b>__currentFilterChanged</b>(<i>filter_</i>) |
|
416 |
|
417 <p> |
|
418 Private slot handling a change of the active QtHelp filter. |
|
419 </p> |
|
420 <dl> |
|
421 |
|
422 <dt><i>filter_</i> (str)</dt> |
|
423 <dd> |
|
424 filter name |
|
425 </dd> |
|
426 </dl> |
|
427 <a NAME="HelpViewerWidget.__currentPageChanged" ID="HelpViewerWidget.__currentPageChanged"></a> |
|
428 <h4>HelpViewerWidget.__currentPageChanged</h4> |
|
429 <b>__currentPageChanged</b>(<i></i>) |
|
430 |
|
431 <p> |
|
432 Private slot handling the selection of another page. |
|
433 </p> |
|
434 <a NAME="HelpViewerWidget.__docsInstalled" ID="HelpViewerWidget.__docsInstalled"></a> |
|
435 <h4>HelpViewerWidget.__docsInstalled</h4> |
|
436 <b>__docsInstalled</b>(<i>installed</i>) |
|
437 |
|
438 <p> |
|
439 Private slot handling the end of documentation installation. |
|
440 </p> |
|
441 <dl> |
|
442 |
|
443 <dt><i>installed</i> (bool)</dt> |
|
444 <dd> |
|
445 flag indicating that documents were installed |
|
446 </dd> |
|
447 </dl> |
|
448 <a NAME="HelpViewerWidget.__filterQtHelpDocumentation" ID="HelpViewerWidget.__filterQtHelpDocumentation"></a> |
|
449 <h4>HelpViewerWidget.__filterQtHelpDocumentation</h4> |
|
450 <b>__filterQtHelpDocumentation</b>(<i>index</i>) |
|
451 |
|
452 <p> |
|
453 Private slot to filter the QtHelp documentation. |
|
454 </p> |
|
455 <dl> |
|
456 |
|
457 <dt><i>index</i> (int)</dt> |
|
458 <dd> |
|
459 index of the selected QtHelp documentation filter |
|
460 </dd> |
|
461 </dl> |
|
462 <a NAME="HelpViewerWidget.__forward" ID="HelpViewerWidget.__forward"></a> |
|
463 <h4>HelpViewerWidget.__forward</h4> |
|
464 <b>__forward</b>(<i></i>) |
|
465 |
|
466 <p> |
|
467 Private slot to move one page foreward. |
|
468 </p> |
|
469 <a NAME="HelpViewerWidget.__getQtHelpCollectionFileName" ID="HelpViewerWidget.__getQtHelpCollectionFileName"></a> |
|
470 <h4>HelpViewerWidget.__getQtHelpCollectionFileName</h4> |
|
471 <b>__getQtHelpCollectionFileName</b>(<i></i>) |
|
472 |
|
473 <p> |
|
474 Private method to determine the name of the QtHelp collection file. |
|
475 </p> |
|
476 <dl> |
|
477 <dt>Return:</dt> |
|
478 <dd> |
|
479 path of the QtHelp collection file |
|
480 </dd> |
|
481 </dl> |
|
482 <dl> |
|
483 <dt>Return Type:</dt> |
|
484 <dd> |
|
485 str |
|
486 </dd> |
|
487 </dl> |
|
488 <a NAME="HelpViewerWidget.__helpTopicSelected" ID="HelpViewerWidget.__helpTopicSelected"></a> |
|
489 <h4>HelpViewerWidget.__helpTopicSelected</h4> |
|
490 <b>__helpTopicSelected</b>(<i></i>) |
|
491 |
|
492 <p> |
|
493 Private slot handling the selection of a new help topic. |
|
494 </p> |
|
495 <a NAME="HelpViewerWidget.__indexingFinished" ID="HelpViewerWidget.__indexingFinished"></a> |
|
496 <h4>HelpViewerWidget.__indexingFinished</h4> |
|
497 <b>__indexingFinished</b>(<i></i>) |
|
498 |
|
499 <p> |
|
500 Private slot handling the end of the indexing process. |
|
501 </p> |
|
502 <a NAME="HelpViewerWidget.__indexingStarted" ID="HelpViewerWidget.__indexingStarted"></a> |
|
503 <h4>HelpViewerWidget.__indexingStarted</h4> |
|
504 <b>__indexingStarted</b>(<i></i>) |
|
505 |
|
506 <p> |
|
507 Private slot handling the start of the indexing process. |
|
508 </p> |
|
509 <a NAME="HelpViewerWidget.__initActionsMenu" ID="HelpViewerWidget.__initActionsMenu"></a> |
|
510 <h4>HelpViewerWidget.__initActionsMenu</h4> |
|
511 <b>__initActionsMenu</b>(<i></i>) |
|
512 |
|
513 <p> |
|
514 Private method to initialize the actions menu. |
|
515 </p> |
|
516 <a NAME="HelpViewerWidget.__initFilterWidget" ID="HelpViewerWidget.__initFilterWidget"></a> |
|
517 <h4>HelpViewerWidget.__initFilterWidget</h4> |
|
518 <b>__initFilterWidget</b>(<i></i>) |
|
519 |
|
520 <p> |
|
521 Private method to initialize the filter selection widget. |
|
522 </p> |
|
523 <dl> |
|
524 <dt>Return:</dt> |
|
525 <dd> |
|
526 reference to the generated widget |
|
527 </dd> |
|
528 </dl> |
|
529 <dl> |
|
530 <dt>Return Type:</dt> |
|
531 <dd> |
|
532 QWidget |
|
533 </dd> |
|
534 </dl> |
|
535 <a NAME="HelpViewerWidget.__initHelpEngine" ID="HelpViewerWidget.__initHelpEngine"></a> |
|
536 <h4>HelpViewerWidget.__initHelpEngine</h4> |
|
537 <b>__initHelpEngine</b>(<i></i>) |
|
538 |
|
539 <p> |
|
540 Private method to initialize the QtHelp related stuff. |
|
541 </p> |
|
542 <a NAME="HelpViewerWidget.__initIndexingProgress" ID="HelpViewerWidget.__initIndexingProgress"></a> |
|
543 <h4>HelpViewerWidget.__initIndexingProgress</h4> |
|
544 <b>__initIndexingProgress</b>(<i></i>) |
|
545 |
|
546 <p> |
|
547 Private method to initialize the help documents indexing progress |
|
548 widget. |
|
549 </p> |
|
550 <dl> |
|
551 <dt>Return:</dt> |
|
552 <dd> |
|
553 reference to the generated widget |
|
554 </dd> |
|
555 </dl> |
|
556 <dl> |
|
557 <dt>Return Type:</dt> |
|
558 <dd> |
|
559 QWidget |
|
560 </dd> |
|
561 </dl> |
|
562 <a NAME="HelpViewerWidget.__initQWebEngine" ID="HelpViewerWidget.__initQWebEngine"></a> |
|
563 <h4>HelpViewerWidget.__initQWebEngine</h4> |
|
564 <b>__initQWebEngine</b>(<i></i>) |
|
565 |
|
566 <p> |
|
567 Private method to initialize global QWebEngine related objects. |
|
568 </p> |
|
569 <a NAME="HelpViewerWidget.__initQWebEngineSettings" ID="HelpViewerWidget.__initQWebEngineSettings"></a> |
|
570 <h4>HelpViewerWidget.__initQWebEngineSettings</h4> |
|
571 <b>__initQWebEngineSettings</b>(<i></i>) |
|
572 |
|
573 <p> |
|
574 Private method to set the global web settings. |
|
575 </p> |
|
576 <a NAME="HelpViewerWidget.__lookForNewDocumentation" ID="HelpViewerWidget.__lookForNewDocumentation"></a> |
|
577 <h4>HelpViewerWidget.__lookForNewDocumentation</h4> |
|
578 <b>__lookForNewDocumentation</b>(<i></i>) |
|
579 |
|
580 <p> |
|
581 Private slot to look for new documentation to be loaded into the |
|
582 help database. |
|
583 </p> |
|
584 <a NAME="HelpViewerWidget.__manageQtHelpDocuments" ID="HelpViewerWidget.__manageQtHelpDocuments"></a> |
|
585 <h4>HelpViewerWidget.__manageQtHelpDocuments</h4> |
|
586 <b>__manageQtHelpDocuments</b>(<i></i>) |
|
587 |
|
588 <p> |
|
589 Private slot to manage the QtHelp documentation database. |
|
590 </p> |
|
591 <a NAME="HelpViewerWidget.__navigationMenuActionTriggered" ID="HelpViewerWidget.__navigationMenuActionTriggered"></a> |
|
592 <h4>HelpViewerWidget.__navigationMenuActionTriggered</h4> |
|
593 <b>__navigationMenuActionTriggered</b>(<i>act</i>) |
|
594 |
|
595 <p> |
|
596 Private slot to go to the selected page. |
|
597 </p> |
|
598 <dl> |
|
599 |
|
600 <dt><i>act</i> (QAction)</dt> |
|
601 <dd> |
|
602 reference to the action selected in the navigation menu |
|
603 </dd> |
|
604 </dl> |
|
605 <a NAME="HelpViewerWidget.__newViewer" ID="HelpViewerWidget.__newViewer"></a> |
|
606 <h4>HelpViewerWidget.__newViewer</h4> |
|
607 <b>__newViewer</b>(<i></i>) |
|
608 |
|
609 <p> |
|
610 Private method to create a new help viewer. |
|
611 </p> |
|
612 <dl> |
|
613 <dt>Return:</dt> |
|
614 <dd> |
|
615 tuple containing the reference to the created help viewer |
|
616 object and its type |
|
617 </dd> |
|
618 </dl> |
|
619 <dl> |
|
620 <dt>Return Type:</dt> |
|
621 <dd> |
|
622 tuple of (HelpViewerImpl, EricTextEditType) |
|
623 </dd> |
|
624 </dl> |
|
625 <a NAME="HelpViewerWidget.__openFile" ID="HelpViewerWidget.__openFile"></a> |
|
626 <h4>HelpViewerWidget.__openFile</h4> |
|
627 <b>__openFile</b>(<i></i>) |
|
628 |
|
629 <p> |
|
630 Private slot to open a local help file (*.html). |
|
631 </p> |
|
632 <a NAME="HelpViewerWidget.__populateHelpSelector" ID="HelpViewerWidget.__populateHelpSelector"></a> |
|
633 <h4>HelpViewerWidget.__populateHelpSelector</h4> |
|
634 <b>__populateHelpSelector</b>(<i></i>) |
|
635 |
|
636 <p> |
|
637 Private method to populate the help selection combo box. |
|
638 </p> |
|
639 <a NAME="HelpViewerWidget.__populateNavigationStack" ID="HelpViewerWidget.__populateNavigationStack"></a> |
|
640 <h4>HelpViewerWidget.__populateNavigationStack</h4> |
|
641 <b>__populateNavigationStack</b>(<i></i>) |
|
642 |
|
643 <p> |
|
644 Private method to populate the stack of navigation widgets. |
|
645 </p> |
|
646 <a NAME="HelpViewerWidget.__reload" ID="HelpViewerWidget.__reload"></a> |
|
647 <h4>HelpViewerWidget.__reload</h4> |
|
648 <b>__reload</b>(<i></i>) |
|
649 |
|
650 <p> |
|
651 Private slot to reload the current page. |
|
652 </p> |
|
653 <a NAME="HelpViewerWidget.__removeOldDocumentation" ID="HelpViewerWidget.__removeOldDocumentation"></a> |
|
654 <h4>HelpViewerWidget.__removeOldDocumentation</h4> |
|
655 <b>__removeOldDocumentation</b>(<i></i>) |
|
656 |
|
657 <p> |
|
658 Private slot to remove non-existing documentation from the help engine. |
|
659 </p> |
|
660 <a NAME="HelpViewerWidget.__searchWidgetClosed" ID="HelpViewerWidget.__searchWidgetClosed"></a> |
|
661 <h4>HelpViewerWidget.__searchWidgetClosed</h4> |
|
662 <b>__searchWidgetClosed</b>(<i></i>) |
|
663 |
|
664 <p> |
|
665 Private slot to handle the closing of the search widget. |
|
666 </p> |
|
667 <a NAME="HelpViewerWidget.__selectNavigationWidget" ID="HelpViewerWidget.__selectNavigationWidget"></a> |
|
668 <h4>HelpViewerWidget.__selectNavigationWidget</h4> |
|
669 <b>__selectNavigationWidget</b>(<i>button</i>) |
|
670 |
|
671 <p> |
|
672 Private slot to select the navigation widget. |
|
673 </p> |
|
674 <dl> |
|
675 |
|
676 <dt><i>button</i> (QAbstractButton)</dt> |
|
677 <dd> |
|
678 reference to the clicked button |
|
679 </dd> |
|
680 </dl> |
|
681 <a NAME="HelpViewerWidget.__setupFilterCombo" ID="HelpViewerWidget.__setupFilterCombo"></a> |
|
682 <h4>HelpViewerWidget.__setupFilterCombo</h4> |
|
683 <b>__setupFilterCombo</b>(<i></i>) |
|
684 |
|
685 <p> |
|
686 Private slot to setup the filter combo box. |
|
687 </p> |
|
688 <a NAME="HelpViewerWidget.__showBackMenu" ID="HelpViewerWidget.__showBackMenu"></a> |
|
689 <h4>HelpViewerWidget.__showBackMenu</h4> |
|
690 <b>__showBackMenu</b>(<i></i>) |
|
691 |
|
692 <p> |
|
693 Private slot showing the backward navigation menu. |
|
694 </p> |
|
695 <a NAME="HelpViewerWidget.__showForwardMenu" ID="HelpViewerWidget.__showForwardMenu"></a> |
|
696 <h4>HelpViewerWidget.__showForwardMenu</h4> |
|
697 <b>__showForwardMenu</b>(<i></i>) |
|
698 |
|
699 <p> |
|
700 Private slot showing the forward navigation menu. |
|
701 </p> |
|
702 <a NAME="HelpViewerWidget.__showInstallationError" ID="HelpViewerWidget.__showInstallationError"></a> |
|
703 <h4>HelpViewerWidget.__showInstallationError</h4> |
|
704 <b>__showInstallationError</b>(<i>message</i>) |
|
705 |
|
706 <p> |
|
707 Private slot to show installation errors. |
|
708 </p> |
|
709 <dl> |
|
710 |
|
711 <dt><i>message</i> (str)</dt> |
|
712 <dd> |
|
713 message to be shown |
|
714 </dd> |
|
715 </dl> |
|
716 <a NAME="HelpViewerWidget.__warning" ID="HelpViewerWidget.__warning"></a> |
|
717 <h4>HelpViewerWidget.__warning</h4> |
|
718 <b>__warning</b>(<i>msg</i>) |
|
719 |
|
720 <p> |
|
721 Private slot handling warnings of the help engine. |
|
722 </p> |
|
723 <dl> |
|
724 |
|
725 <dt><i>msg</i> (str)</dt> |
|
726 <dd> |
|
727 message sent by the help engine |
|
728 </dd> |
|
729 </dl> |
|
730 <a NAME="HelpViewerWidget.__zoomIn" ID="HelpViewerWidget.__zoomIn"></a> |
|
731 <h4>HelpViewerWidget.__zoomIn</h4> |
|
732 <b>__zoomIn</b>(<i></i>) |
|
733 |
|
734 <p> |
|
735 Private slot to zoom in. |
|
736 </p> |
|
737 <a NAME="HelpViewerWidget.__zoomOut" ID="HelpViewerWidget.__zoomOut"></a> |
|
738 <h4>HelpViewerWidget.__zoomOut</h4> |
|
739 <b>__zoomOut</b>(<i></i>) |
|
740 |
|
741 <p> |
|
742 Private slot to zoom out. |
|
743 </p> |
|
744 <a NAME="HelpViewerWidget.__zoomReset" ID="HelpViewerWidget.__zoomReset"></a> |
|
745 <h4>HelpViewerWidget.__zoomReset</h4> |
|
746 <b>__zoomReset</b>(<i></i>) |
|
747 |
|
748 <p> |
|
749 Private slot to reset the zoom level. |
|
750 </p> |
|
751 <a NAME="HelpViewerWidget.activate" ID="HelpViewerWidget.activate"></a> |
|
752 <h4>HelpViewerWidget.activate</h4> |
|
753 <b>activate</b>(<i>searchWord=None, url=None</i>) |
|
754 |
|
755 <p> |
|
756 Public method to activate the widget and search for a given word. |
|
757 </p> |
|
758 <dl> |
|
759 |
|
760 <dt><i>searchWord</i> (str (optional))</dt> |
|
761 <dd> |
|
762 word to search for (defaults to None) |
|
763 </dd> |
|
764 <dt><i>url</i> (QUrl)</dt> |
|
765 <dd> |
|
766 URL to show in a new page |
|
767 </dd> |
|
768 </dl> |
|
769 <a NAME="HelpViewerWidget.addPage" ID="HelpViewerWidget.addPage"></a> |
|
770 <h4>HelpViewerWidget.addPage</h4> |
|
771 <b>addPage</b>(<i>url=None, background=False</i>) |
|
772 |
|
773 <p> |
|
774 Public method to add a new help page with the given URL. |
|
775 </p> |
|
776 <dl> |
|
777 |
|
778 <dt><i>url</i> (QUrl (optional))</dt> |
|
779 <dd> |
|
780 requested URL (defaults to QUrl("about:blank")) |
|
781 </dd> |
|
782 <dt><i>background</i> (bool (optional))</dt> |
|
783 <dd> |
|
784 flag indicating to open the page in the background |
|
785 (defaults to False) |
|
786 </dd> |
|
787 </dl> |
|
788 <dl> |
|
789 <dt>Return:</dt> |
|
790 <dd> |
|
791 reference to the created page |
|
792 </dd> |
|
793 </dl> |
|
794 <dl> |
|
795 <dt>Return Type:</dt> |
|
796 <dd> |
|
797 HelpViewerImpl |
|
798 </dd> |
|
799 </dl> |
|
800 <a NAME="HelpViewerWidget.bookmarkPage" ID="HelpViewerWidget.bookmarkPage"></a> |
|
801 <h4>HelpViewerWidget.bookmarkPage</h4> |
|
802 <b>bookmarkPage</b>(<i>title, url</i>) |
|
803 |
|
804 <p> |
|
805 Public method to bookmark a page with the given data. |
|
806 </p> |
|
807 <dl> |
|
808 |
|
809 <dt><i>title</i> (str)</dt> |
|
810 <dd> |
|
811 title of the page |
|
812 </dd> |
|
813 <dt><i>url</i> (QUrl)</dt> |
|
814 <dd> |
|
815 URL of the page |
|
816 </dd> |
|
817 </dl> |
|
818 <a NAME="HelpViewerWidget.closeAllPages" ID="HelpViewerWidget.closeAllPages"></a> |
|
819 <h4>HelpViewerWidget.closeAllPages</h4> |
|
820 <b>closeAllPages</b>(<i></i>) |
|
821 |
|
822 <p> |
|
823 Public slot to close all pages. |
|
824 </p> |
|
825 <a NAME="HelpViewerWidget.closeCurrentPage" ID="HelpViewerWidget.closeCurrentPage"></a> |
|
826 <h4>HelpViewerWidget.closeCurrentPage</h4> |
|
827 <b>closeCurrentPage</b>(<i></i>) |
|
828 |
|
829 <p> |
|
830 Public slot to close the current page. |
|
831 </p> |
|
832 <a NAME="HelpViewerWidget.closeOtherPages" ID="HelpViewerWidget.closeOtherPages"></a> |
|
833 <h4>HelpViewerWidget.closeOtherPages</h4> |
|
834 <b>closeOtherPages</b>(<i></i>) |
|
835 |
|
836 <p> |
|
837 Public slot to close all other pages. |
|
838 </p> |
|
839 <a NAME="HelpViewerWidget.currentViewer" ID="HelpViewerWidget.currentViewer"></a> |
|
840 <h4>HelpViewerWidget.currentViewer</h4> |
|
841 <b>currentViewer</b>(<i></i>) |
|
842 |
|
843 <p> |
|
844 Public method to get the active viewer. |
|
845 </p> |
|
846 <dl> |
|
847 <dt>Return:</dt> |
|
848 <dd> |
|
849 reference to the active help viewer |
|
850 </dd> |
|
851 </dl> |
|
852 <dl> |
|
853 <dt>Return Type:</dt> |
|
854 <dd> |
|
855 HelpViewerImpl |
|
856 </dd> |
|
857 </dl> |
|
858 <a NAME="HelpViewerWidget.openPagesCount" ID="HelpViewerWidget.openPagesCount"></a> |
|
859 <h4>HelpViewerWidget.openPagesCount</h4> |
|
860 <b>openPagesCount</b>(<i></i>) |
|
861 |
|
862 <p> |
|
863 Public method to get the count of open pages. |
|
864 </p> |
|
865 <dl> |
|
866 <dt>Return:</dt> |
|
867 <dd> |
|
868 count of open pages |
|
869 </dd> |
|
870 </dl> |
|
871 <dl> |
|
872 <dt>Return Type:</dt> |
|
873 <dd> |
|
874 int |
|
875 </dd> |
|
876 </dl> |
|
877 <a NAME="HelpViewerWidget.openUrl" ID="HelpViewerWidget.openUrl"></a> |
|
878 <h4>HelpViewerWidget.openUrl</h4> |
|
879 <b>openUrl</b>(<i>url</i>) |
|
880 |
|
881 <p> |
|
882 Public slot to load a URL in the current page. |
|
883 </p> |
|
884 <dl> |
|
885 |
|
886 <dt><i>url</i> (QUrl)</dt> |
|
887 <dd> |
|
888 URL to be opened |
|
889 </dd> |
|
890 </dl> |
|
891 <a NAME="HelpViewerWidget.openUrlNewBackgroundPage" ID="HelpViewerWidget.openUrlNewBackgroundPage"></a> |
|
892 <h4>HelpViewerWidget.openUrlNewBackgroundPage</h4> |
|
893 <b>openUrlNewBackgroundPage</b>(<i>url</i>) |
|
894 |
|
895 <p> |
|
896 Public slot to load a URL in a new background page. |
|
897 </p> |
|
898 <dl> |
|
899 |
|
900 <dt><i>url</i> (QUrl)</dt> |
|
901 <dd> |
|
902 URL to be opened |
|
903 </dd> |
|
904 </dl> |
|
905 <a NAME="HelpViewerWidget.openUrlNewPage" ID="HelpViewerWidget.openUrlNewPage"></a> |
|
906 <h4>HelpViewerWidget.openUrlNewPage</h4> |
|
907 <b>openUrlNewPage</b>(<i>url</i>) |
|
908 |
|
909 <p> |
|
910 Public slot to load a URL in a new page. |
|
911 </p> |
|
912 <dl> |
|
913 |
|
914 <dt><i>url</i> (QUrl)</dt> |
|
915 <dd> |
|
916 URL to be opened |
|
917 </dd> |
|
918 </dl> |
|
919 <a NAME="HelpViewerWidget.searchNext" ID="HelpViewerWidget.searchNext"></a> |
|
920 <h4>HelpViewerWidget.searchNext</h4> |
|
921 <b>searchNext</b>(<i></i>) |
|
922 |
|
923 <p> |
|
924 Public slot to find the next occurrence of the current search term. |
|
925 </p> |
|
926 <a NAME="HelpViewerWidget.searchPrev" ID="HelpViewerWidget.searchPrev"></a> |
|
927 <h4>HelpViewerWidget.searchPrev</h4> |
|
928 <b>searchPrev</b>(<i></i>) |
|
929 |
|
930 <p> |
|
931 Public slot to find the previous occurrence of the current search term. |
|
932 </p> |
|
933 <a NAME="HelpViewerWidget.searchQtHelp" ID="HelpViewerWidget.searchQtHelp"></a> |
|
934 <h4>HelpViewerWidget.searchQtHelp</h4> |
|
935 <b>searchQtHelp</b>(<i>searchExpression</i>) |
|
936 |
|
937 <p> |
|
938 Public slot to search for a given search expression. |
|
939 </p> |
|
940 <dl> |
|
941 |
|
942 <dt><i>searchExpression</i> (str)</dt> |
|
943 <dd> |
|
944 expression to search for |
|
945 </dd> |
|
946 </dl> |
|
947 <a NAME="HelpViewerWidget.showHideSearch" ID="HelpViewerWidget.showHideSearch"></a> |
|
948 <h4>HelpViewerWidget.showHideSearch</h4> |
|
949 <b>showHideSearch</b>(<i>visible</i>) |
|
950 |
|
951 <p> |
|
952 Public slot to show or hide the search widget. |
|
953 </p> |
|
954 <dl> |
|
955 |
|
956 <dt><i>visible</i> (bool)</dt> |
|
957 <dd> |
|
958 flag indicating to show or hide the search widget |
|
959 </dd> |
|
960 </dl> |
|
961 <a NAME="HelpViewerWidget.shutdown" ID="HelpViewerWidget.shutdown"></a> |
|
962 <h4>HelpViewerWidget.shutdown</h4> |
|
963 <b>shutdown</b>(<i></i>) |
|
964 |
|
965 <p> |
|
966 Public method to perform shut down actions. |
|
967 </p> |
|
968 <a NAME="HelpViewerWidget.webProfile" ID="HelpViewerWidget.webProfile"></a> |
|
969 <h4>HelpViewerWidget.webProfile</h4> |
|
970 <b>webProfile</b>(<i></i>) |
|
971 |
|
972 <p> |
|
973 Public method to get a reference to the global web profile object. |
|
974 </p> |
|
975 <dl> |
|
976 <dt>Return:</dt> |
|
977 <dd> |
|
978 reference to the global web profile object |
|
979 </dd> |
|
980 </dl> |
|
981 <dl> |
|
982 <dt>Return Type:</dt> |
|
983 <dd> |
|
984 QWebEngineProfile |
|
985 </dd> |
|
986 </dl> |
|
987 <a NAME="HelpViewerWidget.webSettings" ID="HelpViewerWidget.webSettings"></a> |
|
988 <h4>HelpViewerWidget.webSettings</h4> |
|
989 <b>webSettings</b>(<i></i>) |
|
990 |
|
991 <p> |
|
992 Public method to get the web settings of the current profile. |
|
993 </p> |
|
994 <dl> |
|
995 <dt>Return:</dt> |
|
996 <dd> |
|
997 web settings of the current profile |
|
998 </dd> |
|
999 </dl> |
|
1000 <dl> |
|
1001 <dt>Return Type:</dt> |
|
1002 <dd> |
|
1003 QWebEngineSettings |
|
1004 </dd> |
|
1005 </dl> |
|
1006 <div align="right"><a href="#top">Up</a></div> |
|
1007 <hr /> |
|
1008 </body></html> |