Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Helpviewer.HelpTabWidget.html

Documentation/Source/eric5.Helpviewer.HelpTabWidget.html

changeset 638
265c31231d9d
child 653
0540f3c52b46
equal deleted inserted replaced
637:4e4c729e86cf 638:265c31231d9d
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.Helpviewer.HelpTabWidget</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Helpviewer.HelpTabWidget</h1>
24 <p>
25 Module implementing the central widget showing the web pages.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#HelpTabWidget">HelpTabWidget</a></td>
35 <td>Class implementing the central widget showing the web pages.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="HelpTabWidget" ID="HelpTabWidget"></a>
44 <h2>HelpTabWidget</h2>
45 <p>
46 Class implementing the central widget showing the web pages.
47 </p>
48 <h3>Derived from</h3>
49 E5TabWidget
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>showMessage</td></tr><tr><td>sourceChanged</td></tr><tr><td>titleChanged</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#HelpTabWidget.__init__">HelpTabWidget</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#HelpTabWidget.__elide">__elide</a></td>
61 <td>Private method to elide some text.</td>
62 </tr><tr>
63 <td><a href="#HelpTabWidget.__iconChanged">__iconChanged</a></td>
64 <td>Private slot to handle the icon change.</td>
65 </tr><tr>
66 <td><a href="#HelpTabWidget.__initTabContextMenu">__initTabContextMenu</a></td>
67 <td>Private mezhod to create the tab context menu.</td>
68 </tr><tr>
69 <td><a href="#HelpTabWidget.__loadFinished">__loadFinished</a></td>
70 <td>Private method to handle the loadFinished signal.</td>
71 </tr><tr>
72 <td><a href="#HelpTabWidget.__loadStarted">__loadStarted</a></td>
73 <td>Private method to handle the loadStarted signal.</td>
74 </tr><tr>
75 <td><a href="#HelpTabWidget.__navigationMenuTriggered">__navigationMenuTriggered</a></td>
76 <td>Private slot called to handle the navigation button menu selection.</td>
77 </tr><tr>
78 <td><a href="#HelpTabWidget.__printPdfRequested">__printPdfRequested</a></td>
79 <td>Private slot to handle a print to PDF request.</td>
80 </tr><tr>
81 <td><a href="#HelpTabWidget.__printPreview">__printPreview</a></td>
82 <td>Private slot to generate a print preview.</td>
83 </tr><tr>
84 <td><a href="#HelpTabWidget.__printRequested">__printRequested</a></td>
85 <td>Private slot to handle a print request.</td>
86 </tr><tr>
87 <td><a href="#HelpTabWidget.__showContextMenu">__showContextMenu</a></td>
88 <td>Private slot to show the tab context menu.</td>
89 </tr><tr>
90 <td><a href="#HelpTabWidget.__showNavigationMenu">__showNavigationMenu</a></td>
91 <td>Private slot to show the navigation button menu.</td>
92 </tr><tr>
93 <td><a href="#HelpTabWidget.__sourceChanged">__sourceChanged</a></td>
94 <td>Private slot to handle a change of a browsers source.</td>
95 </tr><tr>
96 <td><a href="#HelpTabWidget.__tabContextMenuClone">__tabContextMenuClone</a></td>
97 <td>Private method to clone the selected tab.</td>
98 </tr><tr>
99 <td><a href="#HelpTabWidget.__tabContextMenuClose">__tabContextMenuClose</a></td>
100 <td>Private method to close the selected tab.</td>
101 </tr><tr>
102 <td><a href="#HelpTabWidget.__tabContextMenuCloseOthers">__tabContextMenuCloseOthers</a></td>
103 <td>Private slot to close all other tabs.</td>
104 </tr><tr>
105 <td><a href="#HelpTabWidget.__tabContextMenuMoveLeft">__tabContextMenuMoveLeft</a></td>
106 <td>Private method to move a tab one position to the left.</td>
107 </tr><tr>
108 <td><a href="#HelpTabWidget.__tabContextMenuMoveRight">__tabContextMenuMoveRight</a></td>
109 <td>Private method to move a tab one position to the right.</td>
110 </tr><tr>
111 <td><a href="#HelpTabWidget.__tabContextMenuPrint">__tabContextMenuPrint</a></td>
112 <td>Private method to print the selected tab.</td>
113 </tr><tr>
114 <td><a href="#HelpTabWidget.__tabContextMenuPrintPdf">__tabContextMenuPrintPdf</a></td>
115 <td>Private method to print the selected tab as PDF.</td>
116 </tr><tr>
117 <td><a href="#HelpTabWidget.__tabContextMenuPrintPreview">__tabContextMenuPrintPreview</a></td>
118 <td>Private method to show a print preview of the selected tab.</td>
119 </tr><tr>
120 <td><a href="#HelpTabWidget.__titleChanged">__titleChanged</a></td>
121 <td>Private slot to handle a change of a browsers title.</td>
122 </tr><tr>
123 <td><a href="#HelpTabWidget.__windowCloseRequested">__windowCloseRequested</a></td>
124 <td>Private slot to handle the windowCloseRequested signal of a browser.</td>
125 </tr><tr>
126 <td><a href="#HelpTabWidget.browserAt">browserAt</a></td>
127 <td>Public method to get a reference to the browser with the given index.</td>
128 </tr><tr>
129 <td><a href="#HelpTabWidget.browsers">browsers</a></td>
130 <td>Public method to get a list of references to all browsers.</td>
131 </tr><tr>
132 <td><a href="#HelpTabWidget.closeAllBrowsers">closeAllBrowsers</a></td>
133 <td>Public slot called to handle the close all action.</td>
134 </tr><tr>
135 <td><a href="#HelpTabWidget.closeBrowser">closeBrowser</a></td>
136 <td>Public slot called to handle the close action.</td>
137 </tr><tr>
138 <td><a href="#HelpTabWidget.closeBrowserAt">closeBrowserAt</a></td>
139 <td>Public slot to close a browser based on it's index.</td>
140 </tr><tr>
141 <td><a href="#HelpTabWidget.currentBrowser">currentBrowser</a></td>
142 <td>Public method to get a reference to the current browser.</td>
143 </tr><tr>
144 <td><a href="#HelpTabWidget.getSourceFileList">getSourceFileList</a></td>
145 <td>Public method to get a list of all opened source files.</td>
146 </tr><tr>
147 <td><a href="#HelpTabWidget.newBrowser">newBrowser</a></td>
148 <td>Public method to create a new web browser tab.</td>
149 </tr><tr>
150 <td><a href="#HelpTabWidget.preferencesChanged">preferencesChanged</a></td>
151 <td>Public slot to handle a change of preferences.</td>
152 </tr><tr>
153 <td><a href="#HelpTabWidget.printBrowser">printBrowser</a></td>
154 <td>Public slot called to print the displayed page.</td>
155 </tr><tr>
156 <td><a href="#HelpTabWidget.printBrowserPdf">printBrowserPdf</a></td>
157 <td>Public slot called to print the displayed page to PDF.</td>
158 </tr><tr>
159 <td><a href="#HelpTabWidget.printPreviewBrowser">printPreviewBrowser</a></td>
160 <td>Public slot called to show a print preview of the displayed file.</td>
161 </tr><tr>
162 <td><a href="#HelpTabWidget.shallShutDown">shallShutDown</a></td>
163 <td>Public method to check, if the application should be shut down.</td>
164 </tr>
165 </table>
166 <a NAME="HelpTabWidget.__init__" ID="HelpTabWidget.__init__"></a>
167 <h4>HelpTabWidget (Constructor)</h4>
168 <b>HelpTabWidget</b>(<i>parent</i>)
169 <p>
170 Constructor
171 </p><dl>
172 <dt><i>parent</i></dt>
173 <dd>
174 reference to the parent widget (QWidget)
175 </dd>
176 </dl><a NAME="HelpTabWidget.__elide" ID="HelpTabWidget.__elide"></a>
177 <h4>HelpTabWidget.__elide</h4>
178 <b>__elide</b>(<i>txt, mode = Qt.ElideRight, length = 40</i>)
179 <p>
180 Private method to elide some text.
181 </p><dl>
182 <dt><i>txt</i></dt>
183 <dd>
184 text to be elided (string)
185 </dd><dt><i>mode=</i></dt>
186 <dd>
187 elide mode (Qt.TextElideMode)
188 </dd><dt><i>length=</i></dt>
189 <dd>
190 amount of characters to be used (integer)
191 </dd>
192 </dl><dl>
193 <dt>Returns:</dt>
194 <dd>
195 the elided text (string)
196 </dd>
197 </dl><a NAME="HelpTabWidget.__iconChanged" ID="HelpTabWidget.__iconChanged"></a>
198 <h4>HelpTabWidget.__iconChanged</h4>
199 <b>__iconChanged</b>(<i></i>)
200 <p>
201 Private slot to handle the icon change.
202 </p><a NAME="HelpTabWidget.__initTabContextMenu" ID="HelpTabWidget.__initTabContextMenu"></a>
203 <h4>HelpTabWidget.__initTabContextMenu</h4>
204 <b>__initTabContextMenu</b>(<i></i>)
205 <p>
206 Private mezhod to create the tab context menu.
207 </p><a NAME="HelpTabWidget.__loadFinished" ID="HelpTabWidget.__loadFinished"></a>
208 <h4>HelpTabWidget.__loadFinished</h4>
209 <b>__loadFinished</b>(<i>ok</i>)
210 <p>
211 Private method to handle the loadFinished signal.
212 </p><dl>
213 <dt><i>ok</i></dt>
214 <dd>
215 flag indicating the result (boolean)
216 </dd>
217 </dl><a NAME="HelpTabWidget.__loadStarted" ID="HelpTabWidget.__loadStarted"></a>
218 <h4>HelpTabWidget.__loadStarted</h4>
219 <b>__loadStarted</b>(<i></i>)
220 <p>
221 Private method to handle the loadStarted signal.
222 </p><a NAME="HelpTabWidget.__navigationMenuTriggered" ID="HelpTabWidget.__navigationMenuTriggered"></a>
223 <h4>HelpTabWidget.__navigationMenuTriggered</h4>
224 <b>__navigationMenuTriggered</b>(<i>act</i>)
225 <p>
226 Private slot called to handle the navigation button menu selection.
227 </p><dl>
228 <dt><i>act</i></dt>
229 <dd>
230 reference to the selected action (QAction)
231 </dd>
232 </dl><a NAME="HelpTabWidget.__printPdfRequested" ID="HelpTabWidget.__printPdfRequested"></a>
233 <h4>HelpTabWidget.__printPdfRequested</h4>
234 <b>__printPdfRequested</b>(<i>frame</i>)
235 <p>
236 Private slot to handle a print to PDF request.
237 </p><dl>
238 <dt><i>frame</i></dt>
239 <dd>
240 reference to the frame to be printed (QWebFrame)
241 </dd>
242 </dl><a NAME="HelpTabWidget.__printPreview" ID="HelpTabWidget.__printPreview"></a>
243 <h4>HelpTabWidget.__printPreview</h4>
244 <b>__printPreview</b>(<i>printer</i>)
245 <p>
246 Private slot to generate a print preview.
247 </p><dl>
248 <dt><i>printer</i></dt>
249 <dd>
250 reference to the printer object (QPrinter)
251 </dd>
252 </dl><a NAME="HelpTabWidget.__printRequested" ID="HelpTabWidget.__printRequested"></a>
253 <h4>HelpTabWidget.__printRequested</h4>
254 <b>__printRequested</b>(<i>frame</i>)
255 <p>
256 Private slot to handle a print request.
257 </p><dl>
258 <dt><i>frame</i></dt>
259 <dd>
260 reference to the frame to be printed (QWebFrame)
261 </dd>
262 </dl><a NAME="HelpTabWidget.__showContextMenu" ID="HelpTabWidget.__showContextMenu"></a>
263 <h4>HelpTabWidget.__showContextMenu</h4>
264 <b>__showContextMenu</b>(<i>coord, index</i>)
265 <p>
266 Private slot to show the tab context menu.
267 </p><dl>
268 <dt><i>coord</i></dt>
269 <dd>
270 the position of the mouse pointer (QPoint)
271 </dd><dt><i>index</i></dt>
272 <dd>
273 index of the tab the menu is requested for (integer)
274 </dd>
275 </dl><a NAME="HelpTabWidget.__showNavigationMenu" ID="HelpTabWidget.__showNavigationMenu"></a>
276 <h4>HelpTabWidget.__showNavigationMenu</h4>
277 <b>__showNavigationMenu</b>(<i></i>)
278 <p>
279 Private slot to show the navigation button menu.
280 </p><a NAME="HelpTabWidget.__sourceChanged" ID="HelpTabWidget.__sourceChanged"></a>
281 <h4>HelpTabWidget.__sourceChanged</h4>
282 <b>__sourceChanged</b>(<i>url</i>)
283 <p>
284 Private slot to handle a change of a browsers source.
285 </p><dl>
286 <dt><i>url</i></dt>
287 <dd>
288 URL of the new site (QUrl)
289 </dd>
290 </dl><a NAME="HelpTabWidget.__tabContextMenuClone" ID="HelpTabWidget.__tabContextMenuClone"></a>
291 <h4>HelpTabWidget.__tabContextMenuClone</h4>
292 <b>__tabContextMenuClone</b>(<i></i>)
293 <p>
294 Private method to clone the selected tab.
295 </p><a NAME="HelpTabWidget.__tabContextMenuClose" ID="HelpTabWidget.__tabContextMenuClose"></a>
296 <h4>HelpTabWidget.__tabContextMenuClose</h4>
297 <b>__tabContextMenuClose</b>(<i></i>)
298 <p>
299 Private method to close the selected tab.
300 </p><a NAME="HelpTabWidget.__tabContextMenuCloseOthers" ID="HelpTabWidget.__tabContextMenuCloseOthers"></a>
301 <h4>HelpTabWidget.__tabContextMenuCloseOthers</h4>
302 <b>__tabContextMenuCloseOthers</b>(<i></i>)
303 <p>
304 Private slot to close all other tabs.
305 </p><a NAME="HelpTabWidget.__tabContextMenuMoveLeft" ID="HelpTabWidget.__tabContextMenuMoveLeft"></a>
306 <h4>HelpTabWidget.__tabContextMenuMoveLeft</h4>
307 <b>__tabContextMenuMoveLeft</b>(<i></i>)
308 <p>
309 Private method to move a tab one position to the left.
310 </p><a NAME="HelpTabWidget.__tabContextMenuMoveRight" ID="HelpTabWidget.__tabContextMenuMoveRight"></a>
311 <h4>HelpTabWidget.__tabContextMenuMoveRight</h4>
312 <b>__tabContextMenuMoveRight</b>(<i></i>)
313 <p>
314 Private method to move a tab one position to the right.
315 </p><a NAME="HelpTabWidget.__tabContextMenuPrint" ID="HelpTabWidget.__tabContextMenuPrint"></a>
316 <h4>HelpTabWidget.__tabContextMenuPrint</h4>
317 <b>__tabContextMenuPrint</b>(<i></i>)
318 <p>
319 Private method to print the selected tab.
320 </p><a NAME="HelpTabWidget.__tabContextMenuPrintPdf" ID="HelpTabWidget.__tabContextMenuPrintPdf"></a>
321 <h4>HelpTabWidget.__tabContextMenuPrintPdf</h4>
322 <b>__tabContextMenuPrintPdf</b>(<i></i>)
323 <p>
324 Private method to print the selected tab as PDF.
325 </p><a NAME="HelpTabWidget.__tabContextMenuPrintPreview" ID="HelpTabWidget.__tabContextMenuPrintPreview"></a>
326 <h4>HelpTabWidget.__tabContextMenuPrintPreview</h4>
327 <b>__tabContextMenuPrintPreview</b>(<i></i>)
328 <p>
329 Private method to show a print preview of the selected tab.
330 </p><a NAME="HelpTabWidget.__titleChanged" ID="HelpTabWidget.__titleChanged"></a>
331 <h4>HelpTabWidget.__titleChanged</h4>
332 <b>__titleChanged</b>(<i>title</i>)
333 <p>
334 Private slot to handle a change of a browsers title.
335 </p><dl>
336 <dt><i>title</i></dt>
337 <dd>
338 new title (string)
339 </dd>
340 </dl><a NAME="HelpTabWidget.__windowCloseRequested" ID="HelpTabWidget.__windowCloseRequested"></a>
341 <h4>HelpTabWidget.__windowCloseRequested</h4>
342 <b>__windowCloseRequested</b>(<i></i>)
343 <p>
344 Private slot to handle the windowCloseRequested signal of a browser.
345 </p><a NAME="HelpTabWidget.browserAt" ID="HelpTabWidget.browserAt"></a>
346 <h4>HelpTabWidget.browserAt</h4>
347 <b>browserAt</b>(<i>index</i>)
348 <p>
349 Public method to get a reference to the browser with the given index.
350 </p><dl>
351 <dt><i>index</i></dt>
352 <dd>
353 index of the browser to get (integer)
354 </dd>
355 </dl><dl>
356 <dt>Returns:</dt>
357 <dd>
358 reference to the indexed browser (HelpBrowser)
359 </dd>
360 </dl><a NAME="HelpTabWidget.browsers" ID="HelpTabWidget.browsers"></a>
361 <h4>HelpTabWidget.browsers</h4>
362 <b>browsers</b>(<i></i>)
363 <p>
364 Public method to get a list of references to all browsers.
365 </p><dl>
366 <dt>Returns:</dt>
367 <dd>
368 list of references to browsers (list of HelpBrowser)
369 </dd>
370 </dl><a NAME="HelpTabWidget.closeAllBrowsers" ID="HelpTabWidget.closeAllBrowsers"></a>
371 <h4>HelpTabWidget.closeAllBrowsers</h4>
372 <b>closeAllBrowsers</b>(<i></i>)
373 <p>
374 Public slot called to handle the close all action.
375 </p><a NAME="HelpTabWidget.closeBrowser" ID="HelpTabWidget.closeBrowser"></a>
376 <h4>HelpTabWidget.closeBrowser</h4>
377 <b>closeBrowser</b>(<i></i>)
378 <p>
379 Public slot called to handle the close action.
380 </p><a NAME="HelpTabWidget.closeBrowserAt" ID="HelpTabWidget.closeBrowserAt"></a>
381 <h4>HelpTabWidget.closeBrowserAt</h4>
382 <b>closeBrowserAt</b>(<i>index</i>)
383 <p>
384 Public slot to close a browser based on it's index.
385 </p><dl>
386 <dt><i>index</i></dt>
387 <dd>
388 index of browser to close (integer)
389 </dd>
390 </dl><a NAME="HelpTabWidget.currentBrowser" ID="HelpTabWidget.currentBrowser"></a>
391 <h4>HelpTabWidget.currentBrowser</h4>
392 <b>currentBrowser</b>(<i></i>)
393 <p>
394 Public method to get a reference to the current browser.
395 </p><dl>
396 <dt>Returns:</dt>
397 <dd>
398 reference to the current browser (HelpBrowser)
399 </dd>
400 </dl><a NAME="HelpTabWidget.getSourceFileList" ID="HelpTabWidget.getSourceFileList"></a>
401 <h4>HelpTabWidget.getSourceFileList</h4>
402 <b>getSourceFileList</b>(<i></i>)
403 <p>
404 Public method to get a list of all opened source files.
405 </p><dl>
406 <dt>Returns:</dt>
407 <dd>
408 dictionary with tab id as key and host/namespace as value
409 </dd>
410 </dl><a NAME="HelpTabWidget.newBrowser" ID="HelpTabWidget.newBrowser"></a>
411 <h4>HelpTabWidget.newBrowser</h4>
412 <b>newBrowser</b>(<i>link = None</i>)
413 <p>
414 Public method to create a new web browser tab.
415 </p><dl>
416 <dt><i>link</i></dt>
417 <dd>
418 link to be shown (string or QUrl)
419 </dd>
420 </dl><a NAME="HelpTabWidget.preferencesChanged" ID="HelpTabWidget.preferencesChanged"></a>
421 <h4>HelpTabWidget.preferencesChanged</h4>
422 <b>preferencesChanged</b>(<i></i>)
423 <p>
424 Public slot to handle a change of preferences.
425 </p><a NAME="HelpTabWidget.printBrowser" ID="HelpTabWidget.printBrowser"></a>
426 <h4>HelpTabWidget.printBrowser</h4>
427 <b>printBrowser</b>(<i>browser = None</i>)
428 <p>
429 Public slot called to print the displayed page.
430 </p><dl>
431 <dt><i>browser</i></dt>
432 <dd>
433 reference to the browser to be printed (HelpBrowser)
434 </dd>
435 </dl><a NAME="HelpTabWidget.printBrowserPdf" ID="HelpTabWidget.printBrowserPdf"></a>
436 <h4>HelpTabWidget.printBrowserPdf</h4>
437 <b>printBrowserPdf</b>(<i>browser = None</i>)
438 <p>
439 Public slot called to print the displayed page to PDF.
440 </p><dl>
441 <dt><i>browser</i></dt>
442 <dd>
443 reference to the browser to be printed (HelpBrowser)
444 </dd>
445 </dl><a NAME="HelpTabWidget.printPreviewBrowser" ID="HelpTabWidget.printPreviewBrowser"></a>
446 <h4>HelpTabWidget.printPreviewBrowser</h4>
447 <b>printPreviewBrowser</b>(<i>browser = None</i>)
448 <p>
449 Public slot called to show a print preview of the displayed file.
450 </p><dl>
451 <dt><i>browser</i></dt>
452 <dd>
453 reference to the browser to be printed (HelpBrowserWV)
454 </dd>
455 </dl><a NAME="HelpTabWidget.shallShutDown" ID="HelpTabWidget.shallShutDown"></a>
456 <h4>HelpTabWidget.shallShutDown</h4>
457 <b>shallShutDown</b>(<i></i>)
458 <p>
459 Public method to check, if the application should be shut down.
460 </p><dl>
461 <dt>Returns:</dt>
462 <dd>
463 flag indicating a shut down (boolean)
464 </dd>
465 </dl>
466 <div align="right"><a href="#top">Up</a></div>
467 <hr />
468 </body></html>

Mercurial Repository: eric

eric ide

mercurial