Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.E5Gui.E5SideBar.html

eric6/Documentation/Source/eric6.E5Gui.E5SideBar.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.E5Gui.E5SideBar</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><a NAME="top" ID="top"></a>
22 <h1>eric6.E5Gui.E5SideBar</h1>
23 <p>
24 Module implementing a sidebar class.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#E5SideBar">E5SideBar</a></td>
34 <td>Class implementing a sidebar with a widget area, that is hidden or shown, if the current tab is clicked again.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="E5SideBar" ID="E5SideBar"></a>
43 <h2>E5SideBar</h2>
44 <p>
45 Class implementing a sidebar with a widget area, that is hidden or shown,
46 if the current tab is clicked again.
47 </p>
48 <h3>Derived from</h3>
49 QWidget
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>East</td></tr><tr><td>North</td></tr><tr><td>South</td></tr><tr><td>Version</td></tr><tr><td>West</td></tr>
53 </table>
54 <h3>Class Methods</h3>
55 <table>
56 <tr><td>None</td></tr>
57 </table>
58 <h3>Methods</h3>
59 <table>
60 <tr>
61 <td><a href="#E5SideBar.__init__">E5SideBar</a></td>
62 <td>Constructor</td>
63 </tr><tr>
64 <td><a href="#E5SideBar.__appFocusChanged">__appFocusChanged</a></td>
65 <td>Private slot to handle a change of the focus.</td>
66 </tr><tr>
67 <td><a href="#E5SideBar.__autoHideToggled">__autoHideToggled</a></td>
68 <td>Private slot to handle the toggling of the autohide button.</td>
69 </tr><tr>
70 <td><a href="#E5SideBar.__cancelDelayTimer">__cancelDelayTimer</a></td>
71 <td>Private method to cancel the current delay timer.</td>
72 </tr><tr>
73 <td><a href="#E5SideBar.__delayedAction">__delayedAction</a></td>
74 <td>Private slot to handle the firing of the delay timer.</td>
75 </tr><tr>
76 <td><a href="#E5SideBar.__expandIt">__expandIt</a></td>
77 <td>Private method to expand the sidebar.</td>
78 </tr><tr>
79 <td><a href="#E5SideBar.__shrinkIt">__shrinkIt</a></td>
80 <td>Private method to shrink the sidebar.</td>
81 </tr><tr>
82 <td><a href="#E5SideBar.__splitterMoved">__splitterMoved</a></td>
83 <td>Private slot to react on splitter moves.</td>
84 </tr><tr>
85 <td><a href="#E5SideBar.addTab">addTab</a></td>
86 <td>Public method to add a tab to the sidebar.</td>
87 </tr><tr>
88 <td><a href="#E5SideBar.clear">clear</a></td>
89 <td>Public method to remove all tabs.</td>
90 </tr><tr>
91 <td><a href="#E5SideBar.count">count</a></td>
92 <td>Public method to get the number of tabs.</td>
93 </tr><tr>
94 <td><a href="#E5SideBar.currentIndex">currentIndex</a></td>
95 <td>Public method to get the index of the current tab.</td>
96 </tr><tr>
97 <td><a href="#E5SideBar.currentWidget">currentWidget</a></td>
98 <td>Public method to get a reference to the current widget.</td>
99 </tr><tr>
100 <td><a href="#E5SideBar.delay">delay</a></td>
101 <td>Public method to get the delay value for the expand/shrink delay in milliseconds.</td>
102 </tr><tr>
103 <td><a href="#E5SideBar.enterEvent">enterEvent</a></td>
104 <td>Protected method to handle the mouse entering this widget.</td>
105 </tr><tr>
106 <td><a href="#E5SideBar.eventFilter">eventFilter</a></td>
107 <td>Public method to handle some events for the tabbar.</td>
108 </tr><tr>
109 <td><a href="#E5SideBar.expand">expand</a></td>
110 <td>Public method to record a expand request.</td>
111 </tr><tr>
112 <td><a href="#E5SideBar.indexOf">indexOf</a></td>
113 <td>Public method to get the index of the given widget.</td>
114 </tr><tr>
115 <td><a href="#E5SideBar.insertTab">insertTab</a></td>
116 <td>Public method to insert a tab into the sidebar.</td>
117 </tr><tr>
118 <td><a href="#E5SideBar.isAutoHiding">isAutoHiding</a></td>
119 <td>Public method to check, if the auto hide function is active.</td>
120 </tr><tr>
121 <td><a href="#E5SideBar.isMinimized">isMinimized</a></td>
122 <td>Public method to check the minimized state.</td>
123 </tr><tr>
124 <td><a href="#E5SideBar.isTabEnabled">isTabEnabled</a></td>
125 <td>Public method to check, if a tab is enabled.</td>
126 </tr><tr>
127 <td><a href="#E5SideBar.leaveEvent">leaveEvent</a></td>
128 <td>Protected method to handle the mouse leaving this widget.</td>
129 </tr><tr>
130 <td><a href="#E5SideBar.nextTab">nextTab</a></td>
131 <td>Public slot used to show the next tab.</td>
132 </tr><tr>
133 <td><a href="#E5SideBar.orientation">orientation</a></td>
134 <td>Public method to get the orientation of the sidebar.</td>
135 </tr><tr>
136 <td><a href="#E5SideBar.prevTab">prevTab</a></td>
137 <td>Public slot used to show the previous tab.</td>
138 </tr><tr>
139 <td><a href="#E5SideBar.removeTab">removeTab</a></td>
140 <td>Public method to remove a tab.</td>
141 </tr><tr>
142 <td><a href="#E5SideBar.restoreState">restoreState</a></td>
143 <td>Public method to restore the state of the sidebar.</td>
144 </tr><tr>
145 <td><a href="#E5SideBar.saveState">saveState</a></td>
146 <td>Public method to save the state of the sidebar.</td>
147 </tr><tr>
148 <td><a href="#E5SideBar.setCurrentIndex">setCurrentIndex</a></td>
149 <td>Public slot to set the current index.</td>
150 </tr><tr>
151 <td><a href="#E5SideBar.setCurrentWidget">setCurrentWidget</a></td>
152 <td>Public slot to set the current widget.</td>
153 </tr><tr>
154 <td><a href="#E5SideBar.setDelay">setDelay</a></td>
155 <td>Public method to set the delay value for the expand/shrink delay in milliseconds.</td>
156 </tr><tr>
157 <td><a href="#E5SideBar.setOrientation">setOrientation</a></td>
158 <td>Public method to set the orientation of the sidebar.</td>
159 </tr><tr>
160 <td><a href="#E5SideBar.setSplitter">setSplitter</a></td>
161 <td>Public method to set the splitter managing the sidebar.</td>
162 </tr><tr>
163 <td><a href="#E5SideBar.setTabEnabled">setTabEnabled</a></td>
164 <td>Public method to set the enabled state of a tab.</td>
165 </tr><tr>
166 <td><a href="#E5SideBar.setTabIcon">setTabIcon</a></td>
167 <td>Public method to set the icon of a tab.</td>
168 </tr><tr>
169 <td><a href="#E5SideBar.setTabText">setTabText</a></td>
170 <td>Public method to set the text of a tab.</td>
171 </tr><tr>
172 <td><a href="#E5SideBar.setTabToolTip">setTabToolTip</a></td>
173 <td>Public method to set the tooltip text of a tab.</td>
174 </tr><tr>
175 <td><a href="#E5SideBar.setTabWhatsThis">setTabWhatsThis</a></td>
176 <td>Public method to set the WhatsThis text of a tab.</td>
177 </tr><tr>
178 <td><a href="#E5SideBar.shrink">shrink</a></td>
179 <td>Public method to record a shrink request.</td>
180 </tr><tr>
181 <td><a href="#E5SideBar.shutdown">shutdown</a></td>
182 <td>Public method to shut down the object.</td>
183 </tr><tr>
184 <td><a href="#E5SideBar.tabIcon">tabIcon</a></td>
185 <td>Public method to get the icon of a tab.</td>
186 </tr><tr>
187 <td><a href="#E5SideBar.tabText">tabText</a></td>
188 <td>Public method to get the text of a tab.</td>
189 </tr><tr>
190 <td><a href="#E5SideBar.tabToolTip">tabToolTip</a></td>
191 <td>Public method to get the tooltip text of a tab.</td>
192 </tr><tr>
193 <td><a href="#E5SideBar.tabWhatsThis">tabWhatsThis</a></td>
194 <td>Public method to get the WhatsThis text of a tab.</td>
195 </tr><tr>
196 <td><a href="#E5SideBar.widget">widget</a></td>
197 <td>Public method to get a reference to the widget associated with a tab.</td>
198 </tr>
199 </table>
200 <h3>Static Methods</h3>
201 <table>
202 <tr><td>None</td></tr>
203 </table>
204 <a NAME="E5SideBar.__init__" ID="E5SideBar.__init__"></a>
205 <h4>E5SideBar (Constructor)</h4>
206 <b>E5SideBar</b>(<i>orientation=None, delay=200, parent=None</i>)
207 <p>
208 Constructor
209 </p><dl>
210 <dt><i>orientation</i></dt>
211 <dd>
212 orientation of the sidebar widget (North, East,
213 South, West)
214 </dd><dt><i>delay</i></dt>
215 <dd>
216 value for the expand/shrink delay in milliseconds
217 (integer)
218 </dd><dt><i>parent</i></dt>
219 <dd>
220 parent widget (QWidget)
221 </dd>
222 </dl><a NAME="E5SideBar.__appFocusChanged" ID="E5SideBar.__appFocusChanged"></a>
223 <h4>E5SideBar.__appFocusChanged</h4>
224 <b>__appFocusChanged</b>(<i>old, now</i>)
225 <p>
226 Private slot to handle a change of the focus.
227 </p><dl>
228 <dt><i>old</i></dt>
229 <dd>
230 reference to the widget, that lost focus (QWidget or None)
231 </dd><dt><i>now</i></dt>
232 <dd>
233 reference to the widget having the focus (QWidget or None)
234 </dd>
235 </dl><a NAME="E5SideBar.__autoHideToggled" ID="E5SideBar.__autoHideToggled"></a>
236 <h4>E5SideBar.__autoHideToggled</h4>
237 <b>__autoHideToggled</b>(<i>checked</i>)
238 <p>
239 Private slot to handle the toggling of the autohide button.
240 </p><dl>
241 <dt><i>checked</i></dt>
242 <dd>
243 flag indicating the checked state of the button
244 (boolean)
245 </dd>
246 </dl><a NAME="E5SideBar.__cancelDelayTimer" ID="E5SideBar.__cancelDelayTimer"></a>
247 <h4>E5SideBar.__cancelDelayTimer</h4>
248 <b>__cancelDelayTimer</b>(<i></i>)
249 <p>
250 Private method to cancel the current delay timer.
251 </p><a NAME="E5SideBar.__delayedAction" ID="E5SideBar.__delayedAction"></a>
252 <h4>E5SideBar.__delayedAction</h4>
253 <b>__delayedAction</b>(<i></i>)
254 <p>
255 Private slot to handle the firing of the delay timer.
256 </p><a NAME="E5SideBar.__expandIt" ID="E5SideBar.__expandIt"></a>
257 <h4>E5SideBar.__expandIt</h4>
258 <b>__expandIt</b>(<i></i>)
259 <p>
260 Private method to expand the sidebar.
261 </p><a NAME="E5SideBar.__shrinkIt" ID="E5SideBar.__shrinkIt"></a>
262 <h4>E5SideBar.__shrinkIt</h4>
263 <b>__shrinkIt</b>(<i></i>)
264 <p>
265 Private method to shrink the sidebar.
266 </p><a NAME="E5SideBar.__splitterMoved" ID="E5SideBar.__splitterMoved"></a>
267 <h4>E5SideBar.__splitterMoved</h4>
268 <b>__splitterMoved</b>(<i>pos, index</i>)
269 <p>
270 Private slot to react on splitter moves.
271 </p><dl>
272 <dt><i>pos</i></dt>
273 <dd>
274 new position of the splitter handle (integer)
275 </dd><dt><i>index</i></dt>
276 <dd>
277 index of the splitter handle (integer)
278 </dd>
279 </dl><a NAME="E5SideBar.addTab" ID="E5SideBar.addTab"></a>
280 <h4>E5SideBar.addTab</h4>
281 <b>addTab</b>(<i>widget, iconOrLabel, label=None</i>)
282 <p>
283 Public method to add a tab to the sidebar.
284 </p><dl>
285 <dt><i>widget</i></dt>
286 <dd>
287 reference to the widget to add (QWidget)
288 </dd><dt><i>iconOrLabel</i></dt>
289 <dd>
290 reference to the icon or the label text of the tab
291 (QIcon, string)
292 </dd><dt><i>label</i></dt>
293 <dd>
294 the labeltext of the tab (string) (only to be
295 used, if the second parameter is a QIcon)
296 </dd>
297 </dl><a NAME="E5SideBar.clear" ID="E5SideBar.clear"></a>
298 <h4>E5SideBar.clear</h4>
299 <b>clear</b>(<i></i>)
300 <p>
301 Public method to remove all tabs.
302 </p><a NAME="E5SideBar.count" ID="E5SideBar.count"></a>
303 <h4>E5SideBar.count</h4>
304 <b>count</b>(<i></i>)
305 <p>
306 Public method to get the number of tabs.
307 </p><dl>
308 <dt>Returns:</dt>
309 <dd>
310 number of tabs in the sidebar (integer)
311 </dd>
312 </dl><a NAME="E5SideBar.currentIndex" ID="E5SideBar.currentIndex"></a>
313 <h4>E5SideBar.currentIndex</h4>
314 <b>currentIndex</b>(<i></i>)
315 <p>
316 Public method to get the index of the current tab.
317 </p><dl>
318 <dt>Returns:</dt>
319 <dd>
320 index of the current tab (integer)
321 </dd>
322 </dl><a NAME="E5SideBar.currentWidget" ID="E5SideBar.currentWidget"></a>
323 <h4>E5SideBar.currentWidget</h4>
324 <b>currentWidget</b>(<i></i>)
325 <p>
326 Public method to get a reference to the current widget.
327 </p><dl>
328 <dt>Returns:</dt>
329 <dd>
330 reference to the current widget (QWidget)
331 </dd>
332 </dl><a NAME="E5SideBar.delay" ID="E5SideBar.delay"></a>
333 <h4>E5SideBar.delay</h4>
334 <b>delay</b>(<i></i>)
335 <p>
336 Public method to get the delay value for the expand/shrink delay in
337 milliseconds.
338 </p><dl>
339 <dt>Returns:</dt>
340 <dd>
341 value for the expand/shrink delay in milliseconds (integer)
342 </dd>
343 </dl><a NAME="E5SideBar.enterEvent" ID="E5SideBar.enterEvent"></a>
344 <h4>E5SideBar.enterEvent</h4>
345 <b>enterEvent</b>(<i>event</i>)
346 <p>
347 Protected method to handle the mouse entering this widget.
348 </p><dl>
349 <dt><i>event</i></dt>
350 <dd>
351 reference to the event (QEvent)
352 </dd>
353 </dl><a NAME="E5SideBar.eventFilter" ID="E5SideBar.eventFilter"></a>
354 <h4>E5SideBar.eventFilter</h4>
355 <b>eventFilter</b>(<i>obj, evt</i>)
356 <p>
357 Public method to handle some events for the tabbar.
358 </p><dl>
359 <dt><i>obj</i></dt>
360 <dd>
361 reference to the object (QObject)
362 </dd><dt><i>evt</i></dt>
363 <dd>
364 reference to the event object (QEvent)
365 </dd>
366 </dl><dl>
367 <dt>Returns:</dt>
368 <dd>
369 flag indicating, if the event was handled (boolean)
370 </dd>
371 </dl><a NAME="E5SideBar.expand" ID="E5SideBar.expand"></a>
372 <h4>E5SideBar.expand</h4>
373 <b>expand</b>(<i></i>)
374 <p>
375 Public method to record a expand request.
376 </p><a NAME="E5SideBar.indexOf" ID="E5SideBar.indexOf"></a>
377 <h4>E5SideBar.indexOf</h4>
378 <b>indexOf</b>(<i>widget</i>)
379 <p>
380 Public method to get the index of the given widget.
381 </p><dl>
382 <dt><i>widget</i></dt>
383 <dd>
384 reference to the widget to get the index of (QWidget)
385 </dd>
386 </dl><dl>
387 <dt>Returns:</dt>
388 <dd>
389 index of the given widget (integer)
390 </dd>
391 </dl><a NAME="E5SideBar.insertTab" ID="E5SideBar.insertTab"></a>
392 <h4>E5SideBar.insertTab</h4>
393 <b>insertTab</b>(<i>index, widget, iconOrLabel, label=None</i>)
394 <p>
395 Public method to insert a tab into the sidebar.
396 </p><dl>
397 <dt><i>index</i></dt>
398 <dd>
399 the index to insert the tab at (integer)
400 </dd><dt><i>widget</i></dt>
401 <dd>
402 reference to the widget to insert (QWidget)
403 </dd><dt><i>iconOrLabel</i></dt>
404 <dd>
405 reference to the icon or the labeltext of the tab
406 (QIcon, string)
407 </dd><dt><i>label</i></dt>
408 <dd>
409 the labeltext of the tab (string) (only to be
410 used, if the second parameter is a QIcon)
411 </dd>
412 </dl><a NAME="E5SideBar.isAutoHiding" ID="E5SideBar.isAutoHiding"></a>
413 <h4>E5SideBar.isAutoHiding</h4>
414 <b>isAutoHiding</b>(<i></i>)
415 <p>
416 Public method to check, if the auto hide function is active.
417 </p><dl>
418 <dt>Returns:</dt>
419 <dd>
420 flag indicating the state of auto hiding (boolean)
421 </dd>
422 </dl><a NAME="E5SideBar.isMinimized" ID="E5SideBar.isMinimized"></a>
423 <h4>E5SideBar.isMinimized</h4>
424 <b>isMinimized</b>(<i></i>)
425 <p>
426 Public method to check the minimized state.
427 </p><dl>
428 <dt>Returns:</dt>
429 <dd>
430 flag indicating the minimized state (boolean)
431 </dd>
432 </dl><a NAME="E5SideBar.isTabEnabled" ID="E5SideBar.isTabEnabled"></a>
433 <h4>E5SideBar.isTabEnabled</h4>
434 <b>isTabEnabled</b>(<i>index</i>)
435 <p>
436 Public method to check, if a tab is enabled.
437 </p><dl>
438 <dt><i>index</i></dt>
439 <dd>
440 index of the tab to check (integer)
441 </dd>
442 </dl><dl>
443 <dt>Returns:</dt>
444 <dd>
445 flag indicating the enabled state (boolean)
446 </dd>
447 </dl><a NAME="E5SideBar.leaveEvent" ID="E5SideBar.leaveEvent"></a>
448 <h4>E5SideBar.leaveEvent</h4>
449 <b>leaveEvent</b>(<i>event</i>)
450 <p>
451 Protected method to handle the mouse leaving this widget.
452 </p><dl>
453 <dt><i>event</i></dt>
454 <dd>
455 reference to the event (QEvent)
456 </dd>
457 </dl><a NAME="E5SideBar.nextTab" ID="E5SideBar.nextTab"></a>
458 <h4>E5SideBar.nextTab</h4>
459 <b>nextTab</b>(<i></i>)
460 <p>
461 Public slot used to show the next tab.
462 </p><a NAME="E5SideBar.orientation" ID="E5SideBar.orientation"></a>
463 <h4>E5SideBar.orientation</h4>
464 <b>orientation</b>(<i></i>)
465 <p>
466 Public method to get the orientation of the sidebar.
467 </p><dl>
468 <dt>Returns:</dt>
469 <dd>
470 orientation of the sidebar (North, East, South, West)
471 </dd>
472 </dl><a NAME="E5SideBar.prevTab" ID="E5SideBar.prevTab"></a>
473 <h4>E5SideBar.prevTab</h4>
474 <b>prevTab</b>(<i></i>)
475 <p>
476 Public slot used to show the previous tab.
477 </p><a NAME="E5SideBar.removeTab" ID="E5SideBar.removeTab"></a>
478 <h4>E5SideBar.removeTab</h4>
479 <b>removeTab</b>(<i>index</i>)
480 <p>
481 Public method to remove a tab.
482 </p><dl>
483 <dt><i>index</i></dt>
484 <dd>
485 the index of the tab to remove (integer)
486 </dd>
487 </dl><a NAME="E5SideBar.restoreState" ID="E5SideBar.restoreState"></a>
488 <h4>E5SideBar.restoreState</h4>
489 <b>restoreState</b>(<i>state</i>)
490 <p>
491 Public method to restore the state of the sidebar.
492 </p><dl>
493 <dt><i>state</i></dt>
494 <dd>
495 byte array containing the saved state (QByteArray)
496 </dd>
497 </dl><dl>
498 <dt>Returns:</dt>
499 <dd>
500 flag indicating success (boolean)
501 </dd>
502 </dl><a NAME="E5SideBar.saveState" ID="E5SideBar.saveState"></a>
503 <h4>E5SideBar.saveState</h4>
504 <b>saveState</b>(<i></i>)
505 <p>
506 Public method to save the state of the sidebar.
507 </p><dl>
508 <dt>Returns:</dt>
509 <dd>
510 saved state as a byte array (QByteArray)
511 </dd>
512 </dl><a NAME="E5SideBar.setCurrentIndex" ID="E5SideBar.setCurrentIndex"></a>
513 <h4>E5SideBar.setCurrentIndex</h4>
514 <b>setCurrentIndex</b>(<i>index</i>)
515 <p>
516 Public slot to set the current index.
517 </p><dl>
518 <dt><i>index</i></dt>
519 <dd>
520 the index to set as the current index (integer)
521 </dd>
522 </dl><a NAME="E5SideBar.setCurrentWidget" ID="E5SideBar.setCurrentWidget"></a>
523 <h4>E5SideBar.setCurrentWidget</h4>
524 <b>setCurrentWidget</b>(<i>widget</i>)
525 <p>
526 Public slot to set the current widget.
527 </p><dl>
528 <dt><i>widget</i></dt>
529 <dd>
530 reference to the widget to become the current widget
531 (QWidget)
532 </dd>
533 </dl><a NAME="E5SideBar.setDelay" ID="E5SideBar.setDelay"></a>
534 <h4>E5SideBar.setDelay</h4>
535 <b>setDelay</b>(<i>delay</i>)
536 <p>
537 Public method to set the delay value for the expand/shrink delay in
538 milliseconds.
539 </p><dl>
540 <dt><i>delay</i></dt>
541 <dd>
542 value for the expand/shrink delay in milliseconds
543 (integer)
544 </dd>
545 </dl><a NAME="E5SideBar.setOrientation" ID="E5SideBar.setOrientation"></a>
546 <h4>E5SideBar.setOrientation</h4>
547 <b>setOrientation</b>(<i>orient</i>)
548 <p>
549 Public method to set the orientation of the sidebar.
550 </p><dl>
551 <dt><i>orient</i></dt>
552 <dd>
553 orientation of the sidebar (North, East, South, West)
554 </dd>
555 </dl><a NAME="E5SideBar.setSplitter" ID="E5SideBar.setSplitter"></a>
556 <h4>E5SideBar.setSplitter</h4>
557 <b>setSplitter</b>(<i>splitter</i>)
558 <p>
559 Public method to set the splitter managing the sidebar.
560 </p><dl>
561 <dt><i>splitter</i></dt>
562 <dd>
563 reference to the splitter (QSplitter)
564 </dd>
565 </dl><a NAME="E5SideBar.setTabEnabled" ID="E5SideBar.setTabEnabled"></a>
566 <h4>E5SideBar.setTabEnabled</h4>
567 <b>setTabEnabled</b>(<i>index, enabled</i>)
568 <p>
569 Public method to set the enabled state of a tab.
570 </p><dl>
571 <dt><i>index</i></dt>
572 <dd>
573 index of the tab to set (integer)
574 </dd><dt><i>enabled</i></dt>
575 <dd>
576 enabled state to set (boolean)
577 </dd>
578 </dl><a NAME="E5SideBar.setTabIcon" ID="E5SideBar.setTabIcon"></a>
579 <h4>E5SideBar.setTabIcon</h4>
580 <b>setTabIcon</b>(<i>index, icon</i>)
581 <p>
582 Public method to set the icon of a tab.
583 </p><dl>
584 <dt><i>index</i></dt>
585 <dd>
586 index of the tab (integer)
587 </dd><dt><i>icon</i></dt>
588 <dd>
589 icon to be set (QIcon)
590 </dd>
591 </dl><a NAME="E5SideBar.setTabText" ID="E5SideBar.setTabText"></a>
592 <h4>E5SideBar.setTabText</h4>
593 <b>setTabText</b>(<i>index, text</i>)
594 <p>
595 Public method to set the text of a tab.
596 </p><dl>
597 <dt><i>index</i></dt>
598 <dd>
599 index of the tab (integer)
600 </dd><dt><i>text</i></dt>
601 <dd>
602 text to set (string)
603 </dd>
604 </dl><a NAME="E5SideBar.setTabToolTip" ID="E5SideBar.setTabToolTip"></a>
605 <h4>E5SideBar.setTabToolTip</h4>
606 <b>setTabToolTip</b>(<i>index, tip</i>)
607 <p>
608 Public method to set the tooltip text of a tab.
609 </p><dl>
610 <dt><i>index</i></dt>
611 <dd>
612 index of the tab (integer)
613 </dd><dt><i>tip</i></dt>
614 <dd>
615 tooltip text to set (string)
616 </dd>
617 </dl><a NAME="E5SideBar.setTabWhatsThis" ID="E5SideBar.setTabWhatsThis"></a>
618 <h4>E5SideBar.setTabWhatsThis</h4>
619 <b>setTabWhatsThis</b>(<i>index, text</i>)
620 <p>
621 Public method to set the WhatsThis text of a tab.
622 </p><dl>
623 <dt><i>index</i></dt>
624 <dd>
625 index of the tab (integer)
626 </dd><dt><i>text</i></dt>
627 <dd>
628 WhatsThis text to set (string)
629 </dd>
630 </dl><a NAME="E5SideBar.shrink" ID="E5SideBar.shrink"></a>
631 <h4>E5SideBar.shrink</h4>
632 <b>shrink</b>(<i></i>)
633 <p>
634 Public method to record a shrink request.
635 </p><a NAME="E5SideBar.shutdown" ID="E5SideBar.shutdown"></a>
636 <h4>E5SideBar.shutdown</h4>
637 <b>shutdown</b>(<i></i>)
638 <p>
639 Public method to shut down the object.
640 </p><p>
641 This method does some preparations so the object can be deleted
642 properly. It disconnects from the focusChanged signal in order to
643 avoid trouble later on.
644 </p><a NAME="E5SideBar.tabIcon" ID="E5SideBar.tabIcon"></a>
645 <h4>E5SideBar.tabIcon</h4>
646 <b>tabIcon</b>(<i>index</i>)
647 <p>
648 Public method to get the icon of a tab.
649 </p><dl>
650 <dt><i>index</i></dt>
651 <dd>
652 index of the tab (integer)
653 </dd>
654 </dl><dl>
655 <dt>Returns:</dt>
656 <dd>
657 icon of the tab (QIcon)
658 </dd>
659 </dl><a NAME="E5SideBar.tabText" ID="E5SideBar.tabText"></a>
660 <h4>E5SideBar.tabText</h4>
661 <b>tabText</b>(<i>index</i>)
662 <p>
663 Public method to get the text of a tab.
664 </p><dl>
665 <dt><i>index</i></dt>
666 <dd>
667 index of the tab (integer)
668 </dd>
669 </dl><dl>
670 <dt>Returns:</dt>
671 <dd>
672 text of the tab (string)
673 </dd>
674 </dl><a NAME="E5SideBar.tabToolTip" ID="E5SideBar.tabToolTip"></a>
675 <h4>E5SideBar.tabToolTip</h4>
676 <b>tabToolTip</b>(<i>index</i>)
677 <p>
678 Public method to get the tooltip text of a tab.
679 </p><dl>
680 <dt><i>index</i></dt>
681 <dd>
682 index of the tab (integer)
683 </dd>
684 </dl><dl>
685 <dt>Returns:</dt>
686 <dd>
687 tooltip text of the tab (string)
688 </dd>
689 </dl><a NAME="E5SideBar.tabWhatsThis" ID="E5SideBar.tabWhatsThis"></a>
690 <h4>E5SideBar.tabWhatsThis</h4>
691 <b>tabWhatsThis</b>(<i>index</i>)
692 <p>
693 Public method to get the WhatsThis text of a tab.
694 </p><dl>
695 <dt><i>index</i></dt>
696 <dd>
697 index of the tab (integer)
698 </dd>
699 </dl><dl>
700 <dt>Returns:</dt>
701 <dd>
702 WhatsThis text of the tab (string)
703 </dd>
704 </dl><a NAME="E5SideBar.widget" ID="E5SideBar.widget"></a>
705 <h4>E5SideBar.widget</h4>
706 <b>widget</b>(<i>index</i>)
707 <p>
708 Public method to get a reference to the widget associated with a tab.
709 </p><dl>
710 <dt><i>index</i></dt>
711 <dd>
712 index of the tab (integer)
713 </dd>
714 </dl><dl>
715 <dt>Returns:</dt>
716 <dd>
717 reference to the widget (QWidget)
718 </dd>
719 </dl>
720 <div align="right"><a href="#top">Up</a></div>
721 <hr />
722 </body></html>

Mercurial Repository: eric

eric ide

mercurial