41 <h3>Derived from</h3> |
41 <h3>Derived from</h3> |
42 QWidget |
42 QWidget |
43 <h3>Class Attributes</h3> |
43 <h3>Class Attributes</h3> |
44 |
44 |
45 <table> |
45 <table> |
46 <tr><td>MaxHistoryItems</td></tr> |
46 <tr><td>EmpytDocument_Dark</td></tr><tr><td>EmpytDocument_Light</td></tr><tr><td>MaxHistoryItems</td></tr> |
47 </table> |
47 </table> |
48 <h3>Class Methods</h3> |
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> |
49 |
303 |
50 <table> |
304 <table> |
51 <tr><td>None</td></tr> |
305 <tr><td>None</td></tr> |
52 </table> |
306 </table> |
53 <h3>Methods</h3> |
307 |
54 |
308 <a NAME="HelpViewerWidget.emptyDocument" ID="HelpViewerWidget.emptyDocument"></a> |
55 <table> |
309 <h4>HelpViewerWidget.emptyDocument (class method)</h4> |
56 |
310 <b>emptyDocument</b>(<i></i>) |
57 <tr> |
311 |
58 <td><a href="#HelpViewerWidget.__init__">HelpViewerWidget</a></td> |
312 <p> |
59 <td>Constructor</td> |
313 Class method to get the HTML code for an empty page. |
60 </tr> |
314 </p> |
61 <tr> |
315 <dl> |
62 <td><a href="#HelpViewerWidget.__activateCurrentPage">__activateCurrentPage</a></td> |
316 <dt>Return:</dt> |
63 <td>Private slot to activate the current page.</td> |
317 <dd> |
64 </tr> |
318 HTML code for an empty page. |
65 <tr> |
319 </dd> |
66 <td><a href="#HelpViewerWidget.__addNavigationButton">__addNavigationButton</a></td> |
320 </dl> |
67 <td>Private method to create and add a navigation button.</td> |
321 <dl> |
68 </tr> |
322 <dt>Return Type:</dt> |
69 <tr> |
323 <dd> |
70 <td><a href="#HelpViewerWidget.__addNewPage">__addNewPage</a></td> |
324 str |
71 <td>Private slot to add a new empty page.</td> |
325 </dd> |
72 </tr> |
326 </dl> |
73 <tr> |
|
74 <td><a href="#HelpViewerWidget.__backward">__backward</a></td> |
|
75 <td>Private slot to move one page backward.</td> |
|
76 </tr> |
|
77 <tr> |
|
78 <td><a href="#HelpViewerWidget.__checkActionButtons">__checkActionButtons</a></td> |
|
79 <td>Private slot to set the enabled state of the action buttons.</td> |
|
80 </tr> |
|
81 <tr> |
|
82 <td><a href="#HelpViewerWidget.__clearHistory">__clearHistory</a></td> |
|
83 <td>Private slot to clear the history of the current viewer.</td> |
|
84 </tr> |
|
85 <tr> |
|
86 <td><a href="#HelpViewerWidget.__configureHelpDocumentation">__configureHelpDocumentation</a></td> |
|
87 <td>Private slot to open the Help Documentation configuration page.</td> |
|
88 </tr> |
|
89 <tr> |
|
90 <td><a href="#HelpViewerWidget.__currentFilterChanged">__currentFilterChanged</a></td> |
|
91 <td>Private slot handling a change of the active QtHelp filter.</td> |
|
92 </tr> |
|
93 <tr> |
|
94 <td><a href="#HelpViewerWidget.__currentPageChanged">__currentPageChanged</a></td> |
|
95 <td>Private slot handling the selection of another page.</td> |
|
96 </tr> |
|
97 <tr> |
|
98 <td><a href="#HelpViewerWidget.__docsInstalled">__docsInstalled</a></td> |
|
99 <td>Private slot handling the end of documentation installation.</td> |
|
100 </tr> |
|
101 <tr> |
|
102 <td><a href="#HelpViewerWidget.__filterQtHelpDocumentation">__filterQtHelpDocumentation</a></td> |
|
103 <td>Private slot to filter the QtHelp documentation.</td> |
|
104 </tr> |
|
105 <tr> |
|
106 <td><a href="#HelpViewerWidget.__forward">__forward</a></td> |
|
107 <td>Private slot to move one page foreward.</td> |
|
108 </tr> |
|
109 <tr> |
|
110 <td><a href="#HelpViewerWidget.__getQtHelpCollectionFileName">__getQtHelpCollectionFileName</a></td> |
|
111 <td>Private method to determine the name of the QtHelp collection file.</td> |
|
112 </tr> |
|
113 <tr> |
|
114 <td><a href="#HelpViewerWidget.__helpTopicSelected">__helpTopicSelected</a></td> |
|
115 <td>Private slot handling the selection of a new help topic.</td> |
|
116 </tr> |
|
117 <tr> |
|
118 <td><a href="#HelpViewerWidget.__indexingFinished">__indexingFinished</a></td> |
|
119 <td>Private slot handling the end of the indexing process.</td> |
|
120 </tr> |
|
121 <tr> |
|
122 <td><a href="#HelpViewerWidget.__indexingStarted">__indexingStarted</a></td> |
|
123 <td>Private slot handling the start of the indexing process.</td> |
|
124 </tr> |
|
125 <tr> |
|
126 <td><a href="#HelpViewerWidget.__initActionsMenu">__initActionsMenu</a></td> |
|
127 <td>Private method to initialize the actions menu.</td> |
|
128 </tr> |
|
129 <tr> |
|
130 <td><a href="#HelpViewerWidget.__initFilterWidget">__initFilterWidget</a></td> |
|
131 <td>Private method to initialize the filter selection widget.</td> |
|
132 </tr> |
|
133 <tr> |
|
134 <td><a href="#HelpViewerWidget.__initHelpEngine">__initHelpEngine</a></td> |
|
135 <td>Private method to initialize the QtHelp related stuff.</td> |
|
136 </tr> |
|
137 <tr> |
|
138 <td><a href="#HelpViewerWidget.__initIndexingProgress">__initIndexingProgress</a></td> |
|
139 <td>Private method to initialize the help documents indexing progress widget.</td> |
|
140 </tr> |
|
141 <tr> |
|
142 <td><a href="#HelpViewerWidget.__initQWebEngine">__initQWebEngine</a></td> |
|
143 <td>Private method to initialize global QWebEngine related objects.</td> |
|
144 </tr> |
|
145 <tr> |
|
146 <td><a href="#HelpViewerWidget.__initQWebEngineSettings">__initQWebEngineSettings</a></td> |
|
147 <td>Private method to set the global web settings.</td> |
|
148 </tr> |
|
149 <tr> |
|
150 <td><a href="#HelpViewerWidget.__lookForNewDocumentation">__lookForNewDocumentation</a></td> |
|
151 <td>Private slot to look for new documentation to be loaded into the help database.</td> |
|
152 </tr> |
|
153 <tr> |
|
154 <td><a href="#HelpViewerWidget.__manageQtHelpDocuments">__manageQtHelpDocuments</a></td> |
|
155 <td>Private slot to manage the QtHelp documentation database.</td> |
|
156 </tr> |
|
157 <tr> |
|
158 <td><a href="#HelpViewerWidget.__navigationMenuActionTriggered">__navigationMenuActionTriggered</a></td> |
|
159 <td>Private slot to go to the selected page.</td> |
|
160 </tr> |
|
161 <tr> |
|
162 <td><a href="#HelpViewerWidget.__newViewer">__newViewer</a></td> |
|
163 <td>Private method to create a new help viewer.</td> |
|
164 </tr> |
|
165 <tr> |
|
166 <td><a href="#HelpViewerWidget.__openFile">__openFile</a></td> |
|
167 <td>Private slot to open a local help file (*.html).</td> |
|
168 </tr> |
|
169 <tr> |
|
170 <td><a href="#HelpViewerWidget.__populateHelpSelector">__populateHelpSelector</a></td> |
|
171 <td>Private method to populate the help selection combo box.</td> |
|
172 </tr> |
|
173 <tr> |
|
174 <td><a href="#HelpViewerWidget.__populateNavigationStack">__populateNavigationStack</a></td> |
|
175 <td>Private method to populate the stack of navigation widgets.</td> |
|
176 </tr> |
|
177 <tr> |
|
178 <td><a href="#HelpViewerWidget.__reload">__reload</a></td> |
|
179 <td>Private slot to reload the current page.</td> |
|
180 </tr> |
|
181 <tr> |
|
182 <td><a href="#HelpViewerWidget.__removeOldDocumentation">__removeOldDocumentation</a></td> |
|
183 <td>Private slot to remove non-existing documentation from the help engine.</td> |
|
184 </tr> |
|
185 <tr> |
|
186 <td><a href="#HelpViewerWidget.__searchWidgetClosed">__searchWidgetClosed</a></td> |
|
187 <td>Private slot to handle the closing of the search widget.</td> |
|
188 </tr> |
|
189 <tr> |
|
190 <td><a href="#HelpViewerWidget.__selectNavigationWidget">__selectNavigationWidget</a></td> |
|
191 <td>Private slot to select the navigation widget.</td> |
|
192 </tr> |
|
193 <tr> |
|
194 <td><a href="#HelpViewerWidget.__setupFilterCombo">__setupFilterCombo</a></td> |
|
195 <td>Private slot to setup the filter combo box.</td> |
|
196 </tr> |
|
197 <tr> |
|
198 <td><a href="#HelpViewerWidget.__showBackMenu">__showBackMenu</a></td> |
|
199 <td>Private slot showing the backward navigation menu.</td> |
|
200 </tr> |
|
201 <tr> |
|
202 <td><a href="#HelpViewerWidget.__showForwardMenu">__showForwardMenu</a></td> |
|
203 <td>Private slot showing the forward navigation menu.</td> |
|
204 </tr> |
|
205 <tr> |
|
206 <td><a href="#HelpViewerWidget.__showInstallationError">__showInstallationError</a></td> |
|
207 <td>Private slot to show installation errors.</td> |
|
208 </tr> |
|
209 <tr> |
|
210 <td><a href="#HelpViewerWidget.__warning">__warning</a></td> |
|
211 <td>Private slot handling warnings of the help engine.</td> |
|
212 </tr> |
|
213 <tr> |
|
214 <td><a href="#HelpViewerWidget.__zoomIn">__zoomIn</a></td> |
|
215 <td>Private slot to zoom in.</td> |
|
216 </tr> |
|
217 <tr> |
|
218 <td><a href="#HelpViewerWidget.__zoomOut">__zoomOut</a></td> |
|
219 <td>Private slot to zoom out.</td> |
|
220 </tr> |
|
221 <tr> |
|
222 <td><a href="#HelpViewerWidget.__zoomReset">__zoomReset</a></td> |
|
223 <td>Private slot to reset the zoom level.</td> |
|
224 </tr> |
|
225 <tr> |
|
226 <td><a href="#HelpViewerWidget.activate">activate</a></td> |
|
227 <td>Public method to activate the widget and search for a given word.</td> |
|
228 </tr> |
|
229 <tr> |
|
230 <td><a href="#HelpViewerWidget.addPage">addPage</a></td> |
|
231 <td>Public method to add a new help page with the given URL.</td> |
|
232 </tr> |
|
233 <tr> |
|
234 <td><a href="#HelpViewerWidget.bookmarkPage">bookmarkPage</a></td> |
|
235 <td>Public method to bookmark a page with the given data.</td> |
|
236 </tr> |
|
237 <tr> |
|
238 <td><a href="#HelpViewerWidget.closeAllPages">closeAllPages</a></td> |
|
239 <td>Public slot to close all pages.</td> |
|
240 </tr> |
|
241 <tr> |
|
242 <td><a href="#HelpViewerWidget.closeCurrentPage">closeCurrentPage</a></td> |
|
243 <td>Public slot to close the current page.</td> |
|
244 </tr> |
|
245 <tr> |
|
246 <td><a href="#HelpViewerWidget.closeOtherPages">closeOtherPages</a></td> |
|
247 <td>Public slot to close all other pages.</td> |
|
248 </tr> |
|
249 <tr> |
|
250 <td><a href="#HelpViewerWidget.currentViewer">currentViewer</a></td> |
|
251 <td>Public method to get the active viewer.</td> |
|
252 </tr> |
|
253 <tr> |
|
254 <td><a href="#HelpViewerWidget.openPagesCount">openPagesCount</a></td> |
|
255 <td>Public method to get the count of open pages.</td> |
|
256 </tr> |
|
257 <tr> |
|
258 <td><a href="#HelpViewerWidget.openUrl">openUrl</a></td> |
|
259 <td>Public slot to load a URL in the current page.</td> |
|
260 </tr> |
|
261 <tr> |
|
262 <td><a href="#HelpViewerWidget.openUrlNewBackgroundPage">openUrlNewBackgroundPage</a></td> |
|
263 <td>Public slot to load a URL in a new background page.</td> |
|
264 </tr> |
|
265 <tr> |
|
266 <td><a href="#HelpViewerWidget.openUrlNewPage">openUrlNewPage</a></td> |
|
267 <td>Public slot to load a URL in a new page.</td> |
|
268 </tr> |
|
269 <tr> |
|
270 <td><a href="#HelpViewerWidget.searchNext">searchNext</a></td> |
|
271 <td>Public slot to find the next occurrence of the current search term.</td> |
|
272 </tr> |
|
273 <tr> |
|
274 <td><a href="#HelpViewerWidget.searchPrev">searchPrev</a></td> |
|
275 <td>Public slot to find the previous occurrence of the current search term.</td> |
|
276 </tr> |
|
277 <tr> |
|
278 <td><a href="#HelpViewerWidget.searchQtHelp">searchQtHelp</a></td> |
|
279 <td>Public slot to search for a given search expression.</td> |
|
280 </tr> |
|
281 <tr> |
|
282 <td><a href="#HelpViewerWidget.showHideSearch">showHideSearch</a></td> |
|
283 <td>Public slot to show or hide the search widget.</td> |
|
284 </tr> |
|
285 <tr> |
|
286 <td><a href="#HelpViewerWidget.shutdown">shutdown</a></td> |
|
287 <td>Public method to perform shut down actions.</td> |
|
288 </tr> |
|
289 <tr> |
|
290 <td><a href="#HelpViewerWidget.webProfile">webProfile</a></td> |
|
291 <td>Public method to get a reference to the global web profile object.</td> |
|
292 </tr> |
|
293 <tr> |
|
294 <td><a href="#HelpViewerWidget.webSettings">webSettings</a></td> |
|
295 <td>Public method to get the web settings of the current profile.</td> |
|
296 </tr> |
|
297 </table> |
|
298 <h3>Static Methods</h3> |
|
299 |
|
300 <table> |
|
301 <tr><td>None</td></tr> |
|
302 </table> |
|
303 |
|
304 <a NAME="HelpViewerWidget.__init__" ID="HelpViewerWidget.__init__"></a> |
327 <a NAME="HelpViewerWidget.__init__" ID="HelpViewerWidget.__init__"></a> |
305 <h4>HelpViewerWidget (Constructor)</h4> |
328 <h4>HelpViewerWidget (Constructor)</h4> |
306 <b>HelpViewerWidget</b>(<i>parent=None</i>) |
329 <b>HelpViewerWidget</b>(<i>parent=None</i>) |
307 |
330 |
308 <p> |
331 <p> |