16 |
16 |
17 a { color: #BA6D36; } |
17 a { color: #BA6D36; } |
18 |
18 |
19 </style> |
19 </style> |
20 </head> |
20 </head> |
21 <body><a NAME="top" ID="top"></a> |
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
22 <h1>eric6.E5Gui.E5SideBar</h1> |
23 <h1>eric6.E5Gui.E5SideBar</h1> |
|
24 |
23 <p> |
25 <p> |
24 Module implementing a sidebar class. |
26 Module implementing a sidebar class. |
25 </p> |
27 </p> |
26 <h3>Global Attributes</h3> |
28 <h3>Global Attributes</h3> |
|
29 |
27 <table> |
30 <table> |
28 <tr><td>None</td></tr> |
31 <tr><td>None</td></tr> |
29 </table> |
32 </table> |
30 <h3>Classes</h3> |
33 <h3>Classes</h3> |
|
34 |
31 <table> |
35 <table> |
|
36 |
32 <tr> |
37 <tr> |
33 <td><a href="#E5SideBar">E5SideBar</a></td> |
38 <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> |
39 <td>Class implementing a sidebar with a widget area, that is hidden or shown, if the current tab is clicked again.</td> |
35 </tr> |
40 </tr> |
36 </table> |
41 </table> |
37 <h3>Functions</h3> |
42 <h3>Functions</h3> |
|
43 |
38 <table> |
44 <table> |
39 <tr><td>None</td></tr> |
45 <tr><td>None</td></tr> |
40 </table> |
46 </table> |
41 <hr /><hr /> |
47 <hr /> |
|
48 <hr /> |
42 <a NAME="E5SideBar" ID="E5SideBar"></a> |
49 <a NAME="E5SideBar" ID="E5SideBar"></a> |
43 <h2>E5SideBar</h2> |
50 <h2>E5SideBar</h2> |
|
51 |
44 <p> |
52 <p> |
45 Class implementing a sidebar with a widget area, that is hidden or shown, |
53 Class implementing a sidebar with a widget area, that is hidden or shown, |
46 if the current tab is clicked again. |
54 if the current tab is clicked again. |
47 </p> |
55 </p> |
48 <h3>Derived from</h3> |
56 <h3>Derived from</h3> |
49 QWidget |
57 QWidget |
50 <h3>Class Attributes</h3> |
58 <h3>Class Attributes</h3> |
|
59 |
51 <table> |
60 <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> |
61 <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> |
62 </table> |
54 <h3>Class Methods</h3> |
63 <h3>Class Methods</h3> |
|
64 |
55 <table> |
65 <table> |
56 <tr><td>None</td></tr> |
66 <tr><td>None</td></tr> |
57 </table> |
67 </table> |
58 <h3>Methods</h3> |
68 <h3>Methods</h3> |
|
69 |
59 <table> |
70 <table> |
|
71 |
60 <tr> |
72 <tr> |
61 <td><a href="#E5SideBar.__init__">E5SideBar</a></td> |
73 <td><a href="#E5SideBar.__init__">E5SideBar</a></td> |
62 <td>Constructor</td> |
74 <td>Constructor</td> |
63 </tr><tr> |
75 </tr> |
|
76 <tr> |
64 <td><a href="#E5SideBar.__appFocusChanged">__appFocusChanged</a></td> |
77 <td><a href="#E5SideBar.__appFocusChanged">__appFocusChanged</a></td> |
65 <td>Private slot to handle a change of the focus.</td> |
78 <td>Private slot to handle a change of the focus.</td> |
66 </tr><tr> |
79 </tr> |
|
80 <tr> |
67 <td><a href="#E5SideBar.__autoHideToggled">__autoHideToggled</a></td> |
81 <td><a href="#E5SideBar.__autoHideToggled">__autoHideToggled</a></td> |
68 <td>Private slot to handle the toggling of the autohide button.</td> |
82 <td>Private slot to handle the toggling of the autohide button.</td> |
69 </tr><tr> |
83 </tr> |
|
84 <tr> |
70 <td><a href="#E5SideBar.__cancelDelayTimer">__cancelDelayTimer</a></td> |
85 <td><a href="#E5SideBar.__cancelDelayTimer">__cancelDelayTimer</a></td> |
71 <td>Private method to cancel the current delay timer.</td> |
86 <td>Private method to cancel the current delay timer.</td> |
72 </tr><tr> |
87 </tr> |
|
88 <tr> |
73 <td><a href="#E5SideBar.__delayedAction">__delayedAction</a></td> |
89 <td><a href="#E5SideBar.__delayedAction">__delayedAction</a></td> |
74 <td>Private slot to handle the firing of the delay timer.</td> |
90 <td>Private slot to handle the firing of the delay timer.</td> |
75 </tr><tr> |
91 </tr> |
|
92 <tr> |
76 <td><a href="#E5SideBar.__expandIt">__expandIt</a></td> |
93 <td><a href="#E5SideBar.__expandIt">__expandIt</a></td> |
77 <td>Private method to expand the sidebar.</td> |
94 <td>Private method to expand the sidebar.</td> |
78 </tr><tr> |
95 </tr> |
|
96 <tr> |
79 <td><a href="#E5SideBar.__shrinkIt">__shrinkIt</a></td> |
97 <td><a href="#E5SideBar.__shrinkIt">__shrinkIt</a></td> |
80 <td>Private method to shrink the sidebar.</td> |
98 <td>Private method to shrink the sidebar.</td> |
81 </tr><tr> |
99 </tr> |
|
100 <tr> |
82 <td><a href="#E5SideBar.__splitterMoved">__splitterMoved</a></td> |
101 <td><a href="#E5SideBar.__splitterMoved">__splitterMoved</a></td> |
83 <td>Private slot to react on splitter moves.</td> |
102 <td>Private slot to react on splitter moves.</td> |
84 </tr><tr> |
103 </tr> |
|
104 <tr> |
85 <td><a href="#E5SideBar.addTab">addTab</a></td> |
105 <td><a href="#E5SideBar.addTab">addTab</a></td> |
86 <td>Public method to add a tab to the sidebar.</td> |
106 <td>Public method to add a tab to the sidebar.</td> |
87 </tr><tr> |
107 </tr> |
|
108 <tr> |
88 <td><a href="#E5SideBar.clear">clear</a></td> |
109 <td><a href="#E5SideBar.clear">clear</a></td> |
89 <td>Public method to remove all tabs.</td> |
110 <td>Public method to remove all tabs.</td> |
90 </tr><tr> |
111 </tr> |
|
112 <tr> |
91 <td><a href="#E5SideBar.count">count</a></td> |
113 <td><a href="#E5SideBar.count">count</a></td> |
92 <td>Public method to get the number of tabs.</td> |
114 <td>Public method to get the number of tabs.</td> |
93 </tr><tr> |
115 </tr> |
|
116 <tr> |
94 <td><a href="#E5SideBar.currentIndex">currentIndex</a></td> |
117 <td><a href="#E5SideBar.currentIndex">currentIndex</a></td> |
95 <td>Public method to get the index of the current tab.</td> |
118 <td>Public method to get the index of the current tab.</td> |
96 </tr><tr> |
119 </tr> |
|
120 <tr> |
97 <td><a href="#E5SideBar.currentWidget">currentWidget</a></td> |
121 <td><a href="#E5SideBar.currentWidget">currentWidget</a></td> |
98 <td>Public method to get a reference to the current widget.</td> |
122 <td>Public method to get a reference to the current widget.</td> |
99 </tr><tr> |
123 </tr> |
|
124 <tr> |
100 <td><a href="#E5SideBar.delay">delay</a></td> |
125 <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> |
126 <td>Public method to get the delay value for the expand/shrink delay in milliseconds.</td> |
102 </tr><tr> |
127 </tr> |
|
128 <tr> |
103 <td><a href="#E5SideBar.enterEvent">enterEvent</a></td> |
129 <td><a href="#E5SideBar.enterEvent">enterEvent</a></td> |
104 <td>Protected method to handle the mouse entering this widget.</td> |
130 <td>Protected method to handle the mouse entering this widget.</td> |
105 </tr><tr> |
131 </tr> |
|
132 <tr> |
106 <td><a href="#E5SideBar.eventFilter">eventFilter</a></td> |
133 <td><a href="#E5SideBar.eventFilter">eventFilter</a></td> |
107 <td>Public method to handle some events for the tabbar.</td> |
134 <td>Public method to handle some events for the tabbar.</td> |
108 </tr><tr> |
135 </tr> |
|
136 <tr> |
109 <td><a href="#E5SideBar.expand">expand</a></td> |
137 <td><a href="#E5SideBar.expand">expand</a></td> |
110 <td>Public method to record a expand request.</td> |
138 <td>Public method to record a expand request.</td> |
111 </tr><tr> |
139 </tr> |
|
140 <tr> |
112 <td><a href="#E5SideBar.indexOf">indexOf</a></td> |
141 <td><a href="#E5SideBar.indexOf">indexOf</a></td> |
113 <td>Public method to get the index of the given widget.</td> |
142 <td>Public method to get the index of the given widget.</td> |
114 </tr><tr> |
143 </tr> |
|
144 <tr> |
115 <td><a href="#E5SideBar.insertTab">insertTab</a></td> |
145 <td><a href="#E5SideBar.insertTab">insertTab</a></td> |
116 <td>Public method to insert a tab into the sidebar.</td> |
146 <td>Public method to insert a tab into the sidebar.</td> |
117 </tr><tr> |
147 </tr> |
|
148 <tr> |
118 <td><a href="#E5SideBar.isAutoHiding">isAutoHiding</a></td> |
149 <td><a href="#E5SideBar.isAutoHiding">isAutoHiding</a></td> |
119 <td>Public method to check, if the auto hide function is active.</td> |
150 <td>Public method to check, if the auto hide function is active.</td> |
120 </tr><tr> |
151 </tr> |
|
152 <tr> |
121 <td><a href="#E5SideBar.isMinimized">isMinimized</a></td> |
153 <td><a href="#E5SideBar.isMinimized">isMinimized</a></td> |
122 <td>Public method to check the minimized state.</td> |
154 <td>Public method to check the minimized state.</td> |
123 </tr><tr> |
155 </tr> |
|
156 <tr> |
124 <td><a href="#E5SideBar.isTabEnabled">isTabEnabled</a></td> |
157 <td><a href="#E5SideBar.isTabEnabled">isTabEnabled</a></td> |
125 <td>Public method to check, if a tab is enabled.</td> |
158 <td>Public method to check, if a tab is enabled.</td> |
126 </tr><tr> |
159 </tr> |
|
160 <tr> |
127 <td><a href="#E5SideBar.leaveEvent">leaveEvent</a></td> |
161 <td><a href="#E5SideBar.leaveEvent">leaveEvent</a></td> |
128 <td>Protected method to handle the mouse leaving this widget.</td> |
162 <td>Protected method to handle the mouse leaving this widget.</td> |
129 </tr><tr> |
163 </tr> |
|
164 <tr> |
130 <td><a href="#E5SideBar.nextTab">nextTab</a></td> |
165 <td><a href="#E5SideBar.nextTab">nextTab</a></td> |
131 <td>Public slot used to show the next tab.</td> |
166 <td>Public slot used to show the next tab.</td> |
132 </tr><tr> |
167 </tr> |
|
168 <tr> |
133 <td><a href="#E5SideBar.orientation">orientation</a></td> |
169 <td><a href="#E5SideBar.orientation">orientation</a></td> |
134 <td>Public method to get the orientation of the sidebar.</td> |
170 <td>Public method to get the orientation of the sidebar.</td> |
135 </tr><tr> |
171 </tr> |
|
172 <tr> |
136 <td><a href="#E5SideBar.prevTab">prevTab</a></td> |
173 <td><a href="#E5SideBar.prevTab">prevTab</a></td> |
137 <td>Public slot used to show the previous tab.</td> |
174 <td>Public slot used to show the previous tab.</td> |
138 </tr><tr> |
175 </tr> |
|
176 <tr> |
139 <td><a href="#E5SideBar.removeTab">removeTab</a></td> |
177 <td><a href="#E5SideBar.removeTab">removeTab</a></td> |
140 <td>Public method to remove a tab.</td> |
178 <td>Public method to remove a tab.</td> |
141 </tr><tr> |
179 </tr> |
|
180 <tr> |
142 <td><a href="#E5SideBar.restoreState">restoreState</a></td> |
181 <td><a href="#E5SideBar.restoreState">restoreState</a></td> |
143 <td>Public method to restore the state of the sidebar.</td> |
182 <td>Public method to restore the state of the sidebar.</td> |
144 </tr><tr> |
183 </tr> |
|
184 <tr> |
145 <td><a href="#E5SideBar.saveState">saveState</a></td> |
185 <td><a href="#E5SideBar.saveState">saveState</a></td> |
146 <td>Public method to save the state of the sidebar.</td> |
186 <td>Public method to save the state of the sidebar.</td> |
147 </tr><tr> |
187 </tr> |
|
188 <tr> |
148 <td><a href="#E5SideBar.setCurrentIndex">setCurrentIndex</a></td> |
189 <td><a href="#E5SideBar.setCurrentIndex">setCurrentIndex</a></td> |
149 <td>Public slot to set the current index.</td> |
190 <td>Public slot to set the current index.</td> |
150 </tr><tr> |
191 </tr> |
|
192 <tr> |
151 <td><a href="#E5SideBar.setCurrentWidget">setCurrentWidget</a></td> |
193 <td><a href="#E5SideBar.setCurrentWidget">setCurrentWidget</a></td> |
152 <td>Public slot to set the current widget.</td> |
194 <td>Public slot to set the current widget.</td> |
153 </tr><tr> |
195 </tr> |
|
196 <tr> |
154 <td><a href="#E5SideBar.setDelay">setDelay</a></td> |
197 <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> |
198 <td>Public method to set the delay value for the expand/shrink delay in milliseconds.</td> |
156 </tr><tr> |
199 </tr> |
|
200 <tr> |
157 <td><a href="#E5SideBar.setOrientation">setOrientation</a></td> |
201 <td><a href="#E5SideBar.setOrientation">setOrientation</a></td> |
158 <td>Public method to set the orientation of the sidebar.</td> |
202 <td>Public method to set the orientation of the sidebar.</td> |
159 </tr><tr> |
203 </tr> |
|
204 <tr> |
160 <td><a href="#E5SideBar.setSplitter">setSplitter</a></td> |
205 <td><a href="#E5SideBar.setSplitter">setSplitter</a></td> |
161 <td>Public method to set the splitter managing the sidebar.</td> |
206 <td>Public method to set the splitter managing the sidebar.</td> |
162 </tr><tr> |
207 </tr> |
|
208 <tr> |
163 <td><a href="#E5SideBar.setTabEnabled">setTabEnabled</a></td> |
209 <td><a href="#E5SideBar.setTabEnabled">setTabEnabled</a></td> |
164 <td>Public method to set the enabled state of a tab.</td> |
210 <td>Public method to set the enabled state of a tab.</td> |
165 </tr><tr> |
211 </tr> |
|
212 <tr> |
166 <td><a href="#E5SideBar.setTabIcon">setTabIcon</a></td> |
213 <td><a href="#E5SideBar.setTabIcon">setTabIcon</a></td> |
167 <td>Public method to set the icon of a tab.</td> |
214 <td>Public method to set the icon of a tab.</td> |
168 </tr><tr> |
215 </tr> |
|
216 <tr> |
169 <td><a href="#E5SideBar.setTabText">setTabText</a></td> |
217 <td><a href="#E5SideBar.setTabText">setTabText</a></td> |
170 <td>Public method to set the text of a tab.</td> |
218 <td>Public method to set the text of a tab.</td> |
171 </tr><tr> |
219 </tr> |
|
220 <tr> |
172 <td><a href="#E5SideBar.setTabToolTip">setTabToolTip</a></td> |
221 <td><a href="#E5SideBar.setTabToolTip">setTabToolTip</a></td> |
173 <td>Public method to set the tooltip text of a tab.</td> |
222 <td>Public method to set the tooltip text of a tab.</td> |
174 </tr><tr> |
223 </tr> |
|
224 <tr> |
175 <td><a href="#E5SideBar.setTabWhatsThis">setTabWhatsThis</a></td> |
225 <td><a href="#E5SideBar.setTabWhatsThis">setTabWhatsThis</a></td> |
176 <td>Public method to set the WhatsThis text of a tab.</td> |
226 <td>Public method to set the WhatsThis text of a tab.</td> |
177 </tr><tr> |
227 </tr> |
|
228 <tr> |
178 <td><a href="#E5SideBar.shrink">shrink</a></td> |
229 <td><a href="#E5SideBar.shrink">shrink</a></td> |
179 <td>Public method to record a shrink request.</td> |
230 <td>Public method to record a shrink request.</td> |
180 </tr><tr> |
231 </tr> |
|
232 <tr> |
181 <td><a href="#E5SideBar.shutdown">shutdown</a></td> |
233 <td><a href="#E5SideBar.shutdown">shutdown</a></td> |
182 <td>Public method to shut down the object.</td> |
234 <td>Public method to shut down the object.</td> |
183 </tr><tr> |
235 </tr> |
|
236 <tr> |
184 <td><a href="#E5SideBar.tabIcon">tabIcon</a></td> |
237 <td><a href="#E5SideBar.tabIcon">tabIcon</a></td> |
185 <td>Public method to get the icon of a tab.</td> |
238 <td>Public method to get the icon of a tab.</td> |
186 </tr><tr> |
239 </tr> |
|
240 <tr> |
187 <td><a href="#E5SideBar.tabText">tabText</a></td> |
241 <td><a href="#E5SideBar.tabText">tabText</a></td> |
188 <td>Public method to get the text of a tab.</td> |
242 <td>Public method to get the text of a tab.</td> |
189 </tr><tr> |
243 </tr> |
|
244 <tr> |
190 <td><a href="#E5SideBar.tabToolTip">tabToolTip</a></td> |
245 <td><a href="#E5SideBar.tabToolTip">tabToolTip</a></td> |
191 <td>Public method to get the tooltip text of a tab.</td> |
246 <td>Public method to get the tooltip text of a tab.</td> |
192 </tr><tr> |
247 </tr> |
|
248 <tr> |
193 <td><a href="#E5SideBar.tabWhatsThis">tabWhatsThis</a></td> |
249 <td><a href="#E5SideBar.tabWhatsThis">tabWhatsThis</a></td> |
194 <td>Public method to get the WhatsThis text of a tab.</td> |
250 <td>Public method to get the WhatsThis text of a tab.</td> |
195 </tr><tr> |
251 </tr> |
|
252 <tr> |
196 <td><a href="#E5SideBar.widget">widget</a></td> |
253 <td><a href="#E5SideBar.widget">widget</a></td> |
197 <td>Public method to get a reference to the widget associated with a tab.</td> |
254 <td>Public method to get a reference to the widget associated with a tab.</td> |
198 </tr> |
255 </tr> |
199 </table> |
256 </table> |
200 <h3>Static Methods</h3> |
257 <h3>Static Methods</h3> |
|
258 |
201 <table> |
259 <table> |
202 <tr><td>None</td></tr> |
260 <tr><td>None</td></tr> |
203 </table> |
261 </table> |
|
262 |
204 <a NAME="E5SideBar.__init__" ID="E5SideBar.__init__"></a> |
263 <a NAME="E5SideBar.__init__" ID="E5SideBar.__init__"></a> |
205 <h4>E5SideBar (Constructor)</h4> |
264 <h4>E5SideBar (Constructor)</h4> |
206 <b>E5SideBar</b>(<i>orientation=None, delay=200, parent=None</i>) |
265 <b>E5SideBar</b>(<i>orientation=None, delay=200, parent=None</i>) |
|
266 |
207 <p> |
267 <p> |
208 Constructor |
268 Constructor |
209 </p><dl> |
269 </p> |
|
270 <dl> |
|
271 |
210 <dt><i>orientation</i></dt> |
272 <dt><i>orientation</i></dt> |
211 <dd> |
273 <dd> |
212 orientation of the sidebar widget (North, East, |
274 orientation of the sidebar widget (North, East, |
213 South, West) |
275 South, West) |
214 </dd><dt><i>delay</i></dt> |
276 </dd> |
|
277 <dt><i>delay</i></dt> |
215 <dd> |
278 <dd> |
216 value for the expand/shrink delay in milliseconds |
279 value for the expand/shrink delay in milliseconds |
217 (integer) |
280 (integer) |
218 </dd><dt><i>parent</i></dt> |
281 </dd> |
|
282 <dt><i>parent</i></dt> |
219 <dd> |
283 <dd> |
220 parent widget (QWidget) |
284 parent widget (QWidget) |
221 </dd> |
285 </dd> |
222 </dl><a NAME="E5SideBar.__appFocusChanged" ID="E5SideBar.__appFocusChanged"></a> |
286 </dl> |
|
287 <a NAME="E5SideBar.__appFocusChanged" ID="E5SideBar.__appFocusChanged"></a> |
223 <h4>E5SideBar.__appFocusChanged</h4> |
288 <h4>E5SideBar.__appFocusChanged</h4> |
224 <b>__appFocusChanged</b>(<i>old, now</i>) |
289 <b>__appFocusChanged</b>(<i>old, now</i>) |
|
290 |
225 <p> |
291 <p> |
226 Private slot to handle a change of the focus. |
292 Private slot to handle a change of the focus. |
227 </p><dl> |
293 </p> |
|
294 <dl> |
|
295 |
228 <dt><i>old</i></dt> |
296 <dt><i>old</i></dt> |
229 <dd> |
297 <dd> |
230 reference to the widget, that lost focus (QWidget or None) |
298 reference to the widget, that lost focus (QWidget or None) |
231 </dd><dt><i>now</i></dt> |
299 </dd> |
|
300 <dt><i>now</i></dt> |
232 <dd> |
301 <dd> |
233 reference to the widget having the focus (QWidget or None) |
302 reference to the widget having the focus (QWidget or None) |
234 </dd> |
303 </dd> |
235 </dl><a NAME="E5SideBar.__autoHideToggled" ID="E5SideBar.__autoHideToggled"></a> |
304 </dl> |
|
305 <a NAME="E5SideBar.__autoHideToggled" ID="E5SideBar.__autoHideToggled"></a> |
236 <h4>E5SideBar.__autoHideToggled</h4> |
306 <h4>E5SideBar.__autoHideToggled</h4> |
237 <b>__autoHideToggled</b>(<i>checked</i>) |
307 <b>__autoHideToggled</b>(<i>checked</i>) |
|
308 |
238 <p> |
309 <p> |
239 Private slot to handle the toggling of the autohide button. |
310 Private slot to handle the toggling of the autohide button. |
240 </p><dl> |
311 </p> |
|
312 <dl> |
|
313 |
241 <dt><i>checked</i></dt> |
314 <dt><i>checked</i></dt> |
242 <dd> |
315 <dd> |
243 flag indicating the checked state of the button |
316 flag indicating the checked state of the button |
244 (boolean) |
317 (boolean) |
245 </dd> |
318 </dd> |
246 </dl><a NAME="E5SideBar.__cancelDelayTimer" ID="E5SideBar.__cancelDelayTimer"></a> |
319 </dl> |
|
320 <a NAME="E5SideBar.__cancelDelayTimer" ID="E5SideBar.__cancelDelayTimer"></a> |
247 <h4>E5SideBar.__cancelDelayTimer</h4> |
321 <h4>E5SideBar.__cancelDelayTimer</h4> |
248 <b>__cancelDelayTimer</b>(<i></i>) |
322 <b>__cancelDelayTimer</b>(<i></i>) |
|
323 |
249 <p> |
324 <p> |
250 Private method to cancel the current delay timer. |
325 Private method to cancel the current delay timer. |
251 </p><a NAME="E5SideBar.__delayedAction" ID="E5SideBar.__delayedAction"></a> |
326 </p> |
|
327 <a NAME="E5SideBar.__delayedAction" ID="E5SideBar.__delayedAction"></a> |
252 <h4>E5SideBar.__delayedAction</h4> |
328 <h4>E5SideBar.__delayedAction</h4> |
253 <b>__delayedAction</b>(<i></i>) |
329 <b>__delayedAction</b>(<i></i>) |
|
330 |
254 <p> |
331 <p> |
255 Private slot to handle the firing of the delay timer. |
332 Private slot to handle the firing of the delay timer. |
256 </p><a NAME="E5SideBar.__expandIt" ID="E5SideBar.__expandIt"></a> |
333 </p> |
|
334 <a NAME="E5SideBar.__expandIt" ID="E5SideBar.__expandIt"></a> |
257 <h4>E5SideBar.__expandIt</h4> |
335 <h4>E5SideBar.__expandIt</h4> |
258 <b>__expandIt</b>(<i></i>) |
336 <b>__expandIt</b>(<i></i>) |
|
337 |
259 <p> |
338 <p> |
260 Private method to expand the sidebar. |
339 Private method to expand the sidebar. |
261 </p><a NAME="E5SideBar.__shrinkIt" ID="E5SideBar.__shrinkIt"></a> |
340 </p> |
|
341 <a NAME="E5SideBar.__shrinkIt" ID="E5SideBar.__shrinkIt"></a> |
262 <h4>E5SideBar.__shrinkIt</h4> |
342 <h4>E5SideBar.__shrinkIt</h4> |
263 <b>__shrinkIt</b>(<i></i>) |
343 <b>__shrinkIt</b>(<i></i>) |
|
344 |
264 <p> |
345 <p> |
265 Private method to shrink the sidebar. |
346 Private method to shrink the sidebar. |
266 </p><a NAME="E5SideBar.__splitterMoved" ID="E5SideBar.__splitterMoved"></a> |
347 </p> |
|
348 <a NAME="E5SideBar.__splitterMoved" ID="E5SideBar.__splitterMoved"></a> |
267 <h4>E5SideBar.__splitterMoved</h4> |
349 <h4>E5SideBar.__splitterMoved</h4> |
268 <b>__splitterMoved</b>(<i>pos, index</i>) |
350 <b>__splitterMoved</b>(<i>pos, index</i>) |
|
351 |
269 <p> |
352 <p> |
270 Private slot to react on splitter moves. |
353 Private slot to react on splitter moves. |
271 </p><dl> |
354 </p> |
|
355 <dl> |
|
356 |
272 <dt><i>pos</i></dt> |
357 <dt><i>pos</i></dt> |
273 <dd> |
358 <dd> |
274 new position of the splitter handle (integer) |
359 new position of the splitter handle (integer) |
275 </dd><dt><i>index</i></dt> |
360 </dd> |
|
361 <dt><i>index</i></dt> |
276 <dd> |
362 <dd> |
277 index of the splitter handle (integer) |
363 index of the splitter handle (integer) |
278 </dd> |
364 </dd> |
279 </dl><a NAME="E5SideBar.addTab" ID="E5SideBar.addTab"></a> |
365 </dl> |
|
366 <a NAME="E5SideBar.addTab" ID="E5SideBar.addTab"></a> |
280 <h4>E5SideBar.addTab</h4> |
367 <h4>E5SideBar.addTab</h4> |
281 <b>addTab</b>(<i>widget, iconOrLabel, label=None</i>) |
368 <b>addTab</b>(<i>widget, iconOrLabel, label=None</i>) |
|
369 |
282 <p> |
370 <p> |
283 Public method to add a tab to the sidebar. |
371 Public method to add a tab to the sidebar. |
284 </p><dl> |
372 </p> |
|
373 <dl> |
|
374 |
285 <dt><i>widget</i></dt> |
375 <dt><i>widget</i></dt> |
286 <dd> |
376 <dd> |
287 reference to the widget to add (QWidget) |
377 reference to the widget to add (QWidget) |
288 </dd><dt><i>iconOrLabel</i></dt> |
378 </dd> |
|
379 <dt><i>iconOrLabel</i></dt> |
289 <dd> |
380 <dd> |
290 reference to the icon or the label text of the tab |
381 reference to the icon or the label text of the tab |
291 (QIcon, string) |
382 (QIcon, string) |
292 </dd><dt><i>label</i></dt> |
383 </dd> |
|
384 <dt><i>label</i></dt> |
293 <dd> |
385 <dd> |
294 the labeltext of the tab (string) (only to be |
386 the labeltext of the tab (string) (only to be |
295 used, if the second parameter is a QIcon) |
387 used, if the second parameter is a QIcon) |
296 </dd> |
388 </dd> |
297 </dl><a NAME="E5SideBar.clear" ID="E5SideBar.clear"></a> |
389 </dl> |
|
390 <a NAME="E5SideBar.clear" ID="E5SideBar.clear"></a> |
298 <h4>E5SideBar.clear</h4> |
391 <h4>E5SideBar.clear</h4> |
299 <b>clear</b>(<i></i>) |
392 <b>clear</b>(<i></i>) |
|
393 |
300 <p> |
394 <p> |
301 Public method to remove all tabs. |
395 Public method to remove all tabs. |
302 </p><a NAME="E5SideBar.count" ID="E5SideBar.count"></a> |
396 </p> |
|
397 <a NAME="E5SideBar.count" ID="E5SideBar.count"></a> |
303 <h4>E5SideBar.count</h4> |
398 <h4>E5SideBar.count</h4> |
304 <b>count</b>(<i></i>) |
399 <b>count</b>(<i></i>) |
|
400 |
305 <p> |
401 <p> |
306 Public method to get the number of tabs. |
402 Public method to get the number of tabs. |
307 </p><dl> |
403 </p> |
|
404 <dl> |
308 <dt>Returns:</dt> |
405 <dt>Returns:</dt> |
309 <dd> |
406 <dd> |
310 number of tabs in the sidebar (integer) |
407 number of tabs in the sidebar (integer) |
311 </dd> |
408 </dd> |
312 </dl><a NAME="E5SideBar.currentIndex" ID="E5SideBar.currentIndex"></a> |
409 </dl> |
|
410 <a NAME="E5SideBar.currentIndex" ID="E5SideBar.currentIndex"></a> |
313 <h4>E5SideBar.currentIndex</h4> |
411 <h4>E5SideBar.currentIndex</h4> |
314 <b>currentIndex</b>(<i></i>) |
412 <b>currentIndex</b>(<i></i>) |
|
413 |
315 <p> |
414 <p> |
316 Public method to get the index of the current tab. |
415 Public method to get the index of the current tab. |
317 </p><dl> |
416 </p> |
|
417 <dl> |
318 <dt>Returns:</dt> |
418 <dt>Returns:</dt> |
319 <dd> |
419 <dd> |
320 index of the current tab (integer) |
420 index of the current tab (integer) |
321 </dd> |
421 </dd> |
322 </dl><a NAME="E5SideBar.currentWidget" ID="E5SideBar.currentWidget"></a> |
422 </dl> |
|
423 <a NAME="E5SideBar.currentWidget" ID="E5SideBar.currentWidget"></a> |
323 <h4>E5SideBar.currentWidget</h4> |
424 <h4>E5SideBar.currentWidget</h4> |
324 <b>currentWidget</b>(<i></i>) |
425 <b>currentWidget</b>(<i></i>) |
|
426 |
325 <p> |
427 <p> |
326 Public method to get a reference to the current widget. |
428 Public method to get a reference to the current widget. |
327 </p><dl> |
429 </p> |
|
430 <dl> |
328 <dt>Returns:</dt> |
431 <dt>Returns:</dt> |
329 <dd> |
432 <dd> |
330 reference to the current widget (QWidget) |
433 reference to the current widget (QWidget) |
331 </dd> |
434 </dd> |
332 </dl><a NAME="E5SideBar.delay" ID="E5SideBar.delay"></a> |
435 </dl> |
|
436 <a NAME="E5SideBar.delay" ID="E5SideBar.delay"></a> |
333 <h4>E5SideBar.delay</h4> |
437 <h4>E5SideBar.delay</h4> |
334 <b>delay</b>(<i></i>) |
438 <b>delay</b>(<i></i>) |
|
439 |
335 <p> |
440 <p> |
336 Public method to get the delay value for the expand/shrink delay in |
441 Public method to get the delay value for the expand/shrink delay in |
337 milliseconds. |
442 milliseconds. |
338 </p><dl> |
443 </p> |
|
444 <dl> |
339 <dt>Returns:</dt> |
445 <dt>Returns:</dt> |
340 <dd> |
446 <dd> |
341 value for the expand/shrink delay in milliseconds (integer) |
447 value for the expand/shrink delay in milliseconds (integer) |
342 </dd> |
448 </dd> |
343 </dl><a NAME="E5SideBar.enterEvent" ID="E5SideBar.enterEvent"></a> |
449 </dl> |
|
450 <a NAME="E5SideBar.enterEvent" ID="E5SideBar.enterEvent"></a> |
344 <h4>E5SideBar.enterEvent</h4> |
451 <h4>E5SideBar.enterEvent</h4> |
345 <b>enterEvent</b>(<i>event</i>) |
452 <b>enterEvent</b>(<i>event</i>) |
|
453 |
346 <p> |
454 <p> |
347 Protected method to handle the mouse entering this widget. |
455 Protected method to handle the mouse entering this widget. |
348 </p><dl> |
456 </p> |
|
457 <dl> |
|
458 |
349 <dt><i>event</i></dt> |
459 <dt><i>event</i></dt> |
350 <dd> |
460 <dd> |
351 reference to the event (QEvent) |
461 reference to the event (QEvent) |
352 </dd> |
462 </dd> |
353 </dl><a NAME="E5SideBar.eventFilter" ID="E5SideBar.eventFilter"></a> |
463 </dl> |
|
464 <a NAME="E5SideBar.eventFilter" ID="E5SideBar.eventFilter"></a> |
354 <h4>E5SideBar.eventFilter</h4> |
465 <h4>E5SideBar.eventFilter</h4> |
355 <b>eventFilter</b>(<i>obj, evt</i>) |
466 <b>eventFilter</b>(<i>obj, evt</i>) |
|
467 |
356 <p> |
468 <p> |
357 Public method to handle some events for the tabbar. |
469 Public method to handle some events for the tabbar. |
358 </p><dl> |
470 </p> |
|
471 <dl> |
|
472 |
359 <dt><i>obj</i></dt> |
473 <dt><i>obj</i></dt> |
360 <dd> |
474 <dd> |
361 reference to the object (QObject) |
475 reference to the object (QObject) |
362 </dd><dt><i>evt</i></dt> |
476 </dd> |
|
477 <dt><i>evt</i></dt> |
363 <dd> |
478 <dd> |
364 reference to the event object (QEvent) |
479 reference to the event object (QEvent) |
365 </dd> |
480 </dd> |
366 </dl><dl> |
481 </dl> |
|
482 <dl> |
367 <dt>Returns:</dt> |
483 <dt>Returns:</dt> |
368 <dd> |
484 <dd> |
369 flag indicating, if the event was handled (boolean) |
485 flag indicating, if the event was handled (boolean) |
370 </dd> |
486 </dd> |
371 </dl><a NAME="E5SideBar.expand" ID="E5SideBar.expand"></a> |
487 </dl> |
|
488 <a NAME="E5SideBar.expand" ID="E5SideBar.expand"></a> |
372 <h4>E5SideBar.expand</h4> |
489 <h4>E5SideBar.expand</h4> |
373 <b>expand</b>(<i></i>) |
490 <b>expand</b>(<i></i>) |
|
491 |
374 <p> |
492 <p> |
375 Public method to record a expand request. |
493 Public method to record a expand request. |
376 </p><a NAME="E5SideBar.indexOf" ID="E5SideBar.indexOf"></a> |
494 </p> |
|
495 <a NAME="E5SideBar.indexOf" ID="E5SideBar.indexOf"></a> |
377 <h4>E5SideBar.indexOf</h4> |
496 <h4>E5SideBar.indexOf</h4> |
378 <b>indexOf</b>(<i>widget</i>) |
497 <b>indexOf</b>(<i>widget</i>) |
|
498 |
379 <p> |
499 <p> |
380 Public method to get the index of the given widget. |
500 Public method to get the index of the given widget. |
381 </p><dl> |
501 </p> |
|
502 <dl> |
|
503 |
382 <dt><i>widget</i></dt> |
504 <dt><i>widget</i></dt> |
383 <dd> |
505 <dd> |
384 reference to the widget to get the index of (QWidget) |
506 reference to the widget to get the index of (QWidget) |
385 </dd> |
507 </dd> |
386 </dl><dl> |
508 </dl> |
|
509 <dl> |
387 <dt>Returns:</dt> |
510 <dt>Returns:</dt> |
388 <dd> |
511 <dd> |
389 index of the given widget (integer) |
512 index of the given widget (integer) |
390 </dd> |
513 </dd> |
391 </dl><a NAME="E5SideBar.insertTab" ID="E5SideBar.insertTab"></a> |
514 </dl> |
|
515 <a NAME="E5SideBar.insertTab" ID="E5SideBar.insertTab"></a> |
392 <h4>E5SideBar.insertTab</h4> |
516 <h4>E5SideBar.insertTab</h4> |
393 <b>insertTab</b>(<i>index, widget, iconOrLabel, label=None</i>) |
517 <b>insertTab</b>(<i>index, widget, iconOrLabel, label=None</i>) |
|
518 |
394 <p> |
519 <p> |
395 Public method to insert a tab into the sidebar. |
520 Public method to insert a tab into the sidebar. |
396 </p><dl> |
521 </p> |
|
522 <dl> |
|
523 |
397 <dt><i>index</i></dt> |
524 <dt><i>index</i></dt> |
398 <dd> |
525 <dd> |
399 the index to insert the tab at (integer) |
526 the index to insert the tab at (integer) |
400 </dd><dt><i>widget</i></dt> |
527 </dd> |
|
528 <dt><i>widget</i></dt> |
401 <dd> |
529 <dd> |
402 reference to the widget to insert (QWidget) |
530 reference to the widget to insert (QWidget) |
403 </dd><dt><i>iconOrLabel</i></dt> |
531 </dd> |
|
532 <dt><i>iconOrLabel</i></dt> |
404 <dd> |
533 <dd> |
405 reference to the icon or the labeltext of the tab |
534 reference to the icon or the labeltext of the tab |
406 (QIcon, string) |
535 (QIcon, string) |
407 </dd><dt><i>label</i></dt> |
536 </dd> |
|
537 <dt><i>label</i></dt> |
408 <dd> |
538 <dd> |
409 the labeltext of the tab (string) (only to be |
539 the labeltext of the tab (string) (only to be |
410 used, if the second parameter is a QIcon) |
540 used, if the second parameter is a QIcon) |
411 </dd> |
541 </dd> |
412 </dl><a NAME="E5SideBar.isAutoHiding" ID="E5SideBar.isAutoHiding"></a> |
542 </dl> |
|
543 <a NAME="E5SideBar.isAutoHiding" ID="E5SideBar.isAutoHiding"></a> |
413 <h4>E5SideBar.isAutoHiding</h4> |
544 <h4>E5SideBar.isAutoHiding</h4> |
414 <b>isAutoHiding</b>(<i></i>) |
545 <b>isAutoHiding</b>(<i></i>) |
|
546 |
415 <p> |
547 <p> |
416 Public method to check, if the auto hide function is active. |
548 Public method to check, if the auto hide function is active. |
417 </p><dl> |
549 </p> |
|
550 <dl> |
418 <dt>Returns:</dt> |
551 <dt>Returns:</dt> |
419 <dd> |
552 <dd> |
420 flag indicating the state of auto hiding (boolean) |
553 flag indicating the state of auto hiding (boolean) |
421 </dd> |
554 </dd> |
422 </dl><a NAME="E5SideBar.isMinimized" ID="E5SideBar.isMinimized"></a> |
555 </dl> |
|
556 <a NAME="E5SideBar.isMinimized" ID="E5SideBar.isMinimized"></a> |
423 <h4>E5SideBar.isMinimized</h4> |
557 <h4>E5SideBar.isMinimized</h4> |
424 <b>isMinimized</b>(<i></i>) |
558 <b>isMinimized</b>(<i></i>) |
|
559 |
425 <p> |
560 <p> |
426 Public method to check the minimized state. |
561 Public method to check the minimized state. |
427 </p><dl> |
562 </p> |
|
563 <dl> |
428 <dt>Returns:</dt> |
564 <dt>Returns:</dt> |
429 <dd> |
565 <dd> |
430 flag indicating the minimized state (boolean) |
566 flag indicating the minimized state (boolean) |
431 </dd> |
567 </dd> |
432 </dl><a NAME="E5SideBar.isTabEnabled" ID="E5SideBar.isTabEnabled"></a> |
568 </dl> |
|
569 <a NAME="E5SideBar.isTabEnabled" ID="E5SideBar.isTabEnabled"></a> |
433 <h4>E5SideBar.isTabEnabled</h4> |
570 <h4>E5SideBar.isTabEnabled</h4> |
434 <b>isTabEnabled</b>(<i>index</i>) |
571 <b>isTabEnabled</b>(<i>index</i>) |
|
572 |
435 <p> |
573 <p> |
436 Public method to check, if a tab is enabled. |
574 Public method to check, if a tab is enabled. |
437 </p><dl> |
575 </p> |
|
576 <dl> |
|
577 |
438 <dt><i>index</i></dt> |
578 <dt><i>index</i></dt> |
439 <dd> |
579 <dd> |
440 index of the tab to check (integer) |
580 index of the tab to check (integer) |
441 </dd> |
581 </dd> |
442 </dl><dl> |
582 </dl> |
|
583 <dl> |
443 <dt>Returns:</dt> |
584 <dt>Returns:</dt> |
444 <dd> |
585 <dd> |
445 flag indicating the enabled state (boolean) |
586 flag indicating the enabled state (boolean) |
446 </dd> |
587 </dd> |
447 </dl><a NAME="E5SideBar.leaveEvent" ID="E5SideBar.leaveEvent"></a> |
588 </dl> |
|
589 <a NAME="E5SideBar.leaveEvent" ID="E5SideBar.leaveEvent"></a> |
448 <h4>E5SideBar.leaveEvent</h4> |
590 <h4>E5SideBar.leaveEvent</h4> |
449 <b>leaveEvent</b>(<i>event</i>) |
591 <b>leaveEvent</b>(<i>event</i>) |
|
592 |
450 <p> |
593 <p> |
451 Protected method to handle the mouse leaving this widget. |
594 Protected method to handle the mouse leaving this widget. |
452 </p><dl> |
595 </p> |
|
596 <dl> |
|
597 |
453 <dt><i>event</i></dt> |
598 <dt><i>event</i></dt> |
454 <dd> |
599 <dd> |
455 reference to the event (QEvent) |
600 reference to the event (QEvent) |
456 </dd> |
601 </dd> |
457 </dl><a NAME="E5SideBar.nextTab" ID="E5SideBar.nextTab"></a> |
602 </dl> |
|
603 <a NAME="E5SideBar.nextTab" ID="E5SideBar.nextTab"></a> |
458 <h4>E5SideBar.nextTab</h4> |
604 <h4>E5SideBar.nextTab</h4> |
459 <b>nextTab</b>(<i></i>) |
605 <b>nextTab</b>(<i></i>) |
|
606 |
460 <p> |
607 <p> |
461 Public slot used to show the next tab. |
608 Public slot used to show the next tab. |
462 </p><a NAME="E5SideBar.orientation" ID="E5SideBar.orientation"></a> |
609 </p> |
|
610 <a NAME="E5SideBar.orientation" ID="E5SideBar.orientation"></a> |
463 <h4>E5SideBar.orientation</h4> |
611 <h4>E5SideBar.orientation</h4> |
464 <b>orientation</b>(<i></i>) |
612 <b>orientation</b>(<i></i>) |
|
613 |
465 <p> |
614 <p> |
466 Public method to get the orientation of the sidebar. |
615 Public method to get the orientation of the sidebar. |
467 </p><dl> |
616 </p> |
|
617 <dl> |
468 <dt>Returns:</dt> |
618 <dt>Returns:</dt> |
469 <dd> |
619 <dd> |
470 orientation of the sidebar (North, East, South, West) |
620 orientation of the sidebar (North, East, South, West) |
471 </dd> |
621 </dd> |
472 </dl><a NAME="E5SideBar.prevTab" ID="E5SideBar.prevTab"></a> |
622 </dl> |
|
623 <a NAME="E5SideBar.prevTab" ID="E5SideBar.prevTab"></a> |
473 <h4>E5SideBar.prevTab</h4> |
624 <h4>E5SideBar.prevTab</h4> |
474 <b>prevTab</b>(<i></i>) |
625 <b>prevTab</b>(<i></i>) |
|
626 |
475 <p> |
627 <p> |
476 Public slot used to show the previous tab. |
628 Public slot used to show the previous tab. |
477 </p><a NAME="E5SideBar.removeTab" ID="E5SideBar.removeTab"></a> |
629 </p> |
|
630 <a NAME="E5SideBar.removeTab" ID="E5SideBar.removeTab"></a> |
478 <h4>E5SideBar.removeTab</h4> |
631 <h4>E5SideBar.removeTab</h4> |
479 <b>removeTab</b>(<i>index</i>) |
632 <b>removeTab</b>(<i>index</i>) |
|
633 |
480 <p> |
634 <p> |
481 Public method to remove a tab. |
635 Public method to remove a tab. |
482 </p><dl> |
636 </p> |
|
637 <dl> |
|
638 |
483 <dt><i>index</i></dt> |
639 <dt><i>index</i></dt> |
484 <dd> |
640 <dd> |
485 the index of the tab to remove (integer) |
641 the index of the tab to remove (integer) |
486 </dd> |
642 </dd> |
487 </dl><a NAME="E5SideBar.restoreState" ID="E5SideBar.restoreState"></a> |
643 </dl> |
|
644 <a NAME="E5SideBar.restoreState" ID="E5SideBar.restoreState"></a> |
488 <h4>E5SideBar.restoreState</h4> |
645 <h4>E5SideBar.restoreState</h4> |
489 <b>restoreState</b>(<i>state</i>) |
646 <b>restoreState</b>(<i>state</i>) |
|
647 |
490 <p> |
648 <p> |
491 Public method to restore the state of the sidebar. |
649 Public method to restore the state of the sidebar. |
492 </p><dl> |
650 </p> |
|
651 <dl> |
|
652 |
493 <dt><i>state</i></dt> |
653 <dt><i>state</i></dt> |
494 <dd> |
654 <dd> |
495 byte array containing the saved state (QByteArray) |
655 byte array containing the saved state (QByteArray) |
496 </dd> |
656 </dd> |
497 </dl><dl> |
657 </dl> |
|
658 <dl> |
498 <dt>Returns:</dt> |
659 <dt>Returns:</dt> |
499 <dd> |
660 <dd> |
500 flag indicating success (boolean) |
661 flag indicating success (boolean) |
501 </dd> |
662 </dd> |
502 </dl><a NAME="E5SideBar.saveState" ID="E5SideBar.saveState"></a> |
663 </dl> |
|
664 <a NAME="E5SideBar.saveState" ID="E5SideBar.saveState"></a> |
503 <h4>E5SideBar.saveState</h4> |
665 <h4>E5SideBar.saveState</h4> |
504 <b>saveState</b>(<i></i>) |
666 <b>saveState</b>(<i></i>) |
|
667 |
505 <p> |
668 <p> |
506 Public method to save the state of the sidebar. |
669 Public method to save the state of the sidebar. |
507 </p><dl> |
670 </p> |
|
671 <dl> |
508 <dt>Returns:</dt> |
672 <dt>Returns:</dt> |
509 <dd> |
673 <dd> |
510 saved state as a byte array (QByteArray) |
674 saved state as a byte array (QByteArray) |
511 </dd> |
675 </dd> |
512 </dl><a NAME="E5SideBar.setCurrentIndex" ID="E5SideBar.setCurrentIndex"></a> |
676 </dl> |
|
677 <a NAME="E5SideBar.setCurrentIndex" ID="E5SideBar.setCurrentIndex"></a> |
513 <h4>E5SideBar.setCurrentIndex</h4> |
678 <h4>E5SideBar.setCurrentIndex</h4> |
514 <b>setCurrentIndex</b>(<i>index</i>) |
679 <b>setCurrentIndex</b>(<i>index</i>) |
|
680 |
515 <p> |
681 <p> |
516 Public slot to set the current index. |
682 Public slot to set the current index. |
517 </p><dl> |
683 </p> |
|
684 <dl> |
|
685 |
518 <dt><i>index</i></dt> |
686 <dt><i>index</i></dt> |
519 <dd> |
687 <dd> |
520 the index to set as the current index (integer) |
688 the index to set as the current index (integer) |
521 </dd> |
689 </dd> |
522 </dl><a NAME="E5SideBar.setCurrentWidget" ID="E5SideBar.setCurrentWidget"></a> |
690 </dl> |
|
691 <a NAME="E5SideBar.setCurrentWidget" ID="E5SideBar.setCurrentWidget"></a> |
523 <h4>E5SideBar.setCurrentWidget</h4> |
692 <h4>E5SideBar.setCurrentWidget</h4> |
524 <b>setCurrentWidget</b>(<i>widget</i>) |
693 <b>setCurrentWidget</b>(<i>widget</i>) |
|
694 |
525 <p> |
695 <p> |
526 Public slot to set the current widget. |
696 Public slot to set the current widget. |
527 </p><dl> |
697 </p> |
|
698 <dl> |
|
699 |
528 <dt><i>widget</i></dt> |
700 <dt><i>widget</i></dt> |
529 <dd> |
701 <dd> |
530 reference to the widget to become the current widget |
702 reference to the widget to become the current widget |
531 (QWidget) |
703 (QWidget) |
532 </dd> |
704 </dd> |
533 </dl><a NAME="E5SideBar.setDelay" ID="E5SideBar.setDelay"></a> |
705 </dl> |
|
706 <a NAME="E5SideBar.setDelay" ID="E5SideBar.setDelay"></a> |
534 <h4>E5SideBar.setDelay</h4> |
707 <h4>E5SideBar.setDelay</h4> |
535 <b>setDelay</b>(<i>delay</i>) |
708 <b>setDelay</b>(<i>delay</i>) |
|
709 |
536 <p> |
710 <p> |
537 Public method to set the delay value for the expand/shrink delay in |
711 Public method to set the delay value for the expand/shrink delay in |
538 milliseconds. |
712 milliseconds. |
539 </p><dl> |
713 </p> |
|
714 <dl> |
|
715 |
540 <dt><i>delay</i></dt> |
716 <dt><i>delay</i></dt> |
541 <dd> |
717 <dd> |
542 value for the expand/shrink delay in milliseconds |
718 value for the expand/shrink delay in milliseconds |
543 (integer) |
719 (integer) |
544 </dd> |
720 </dd> |
545 </dl><a NAME="E5SideBar.setOrientation" ID="E5SideBar.setOrientation"></a> |
721 </dl> |
|
722 <a NAME="E5SideBar.setOrientation" ID="E5SideBar.setOrientation"></a> |
546 <h4>E5SideBar.setOrientation</h4> |
723 <h4>E5SideBar.setOrientation</h4> |
547 <b>setOrientation</b>(<i>orient</i>) |
724 <b>setOrientation</b>(<i>orient</i>) |
|
725 |
548 <p> |
726 <p> |
549 Public method to set the orientation of the sidebar. |
727 Public method to set the orientation of the sidebar. |
550 </p><dl> |
728 </p> |
|
729 <dl> |
|
730 |
551 <dt><i>orient</i></dt> |
731 <dt><i>orient</i></dt> |
552 <dd> |
732 <dd> |
553 orientation of the sidebar (North, East, South, West) |
733 orientation of the sidebar (North, East, South, West) |
554 </dd> |
734 </dd> |
555 </dl><a NAME="E5SideBar.setSplitter" ID="E5SideBar.setSplitter"></a> |
735 </dl> |
|
736 <a NAME="E5SideBar.setSplitter" ID="E5SideBar.setSplitter"></a> |
556 <h4>E5SideBar.setSplitter</h4> |
737 <h4>E5SideBar.setSplitter</h4> |
557 <b>setSplitter</b>(<i>splitter</i>) |
738 <b>setSplitter</b>(<i>splitter</i>) |
|
739 |
558 <p> |
740 <p> |
559 Public method to set the splitter managing the sidebar. |
741 Public method to set the splitter managing the sidebar. |
560 </p><dl> |
742 </p> |
|
743 <dl> |
|
744 |
561 <dt><i>splitter</i></dt> |
745 <dt><i>splitter</i></dt> |
562 <dd> |
746 <dd> |
563 reference to the splitter (QSplitter) |
747 reference to the splitter (QSplitter) |
564 </dd> |
748 </dd> |
565 </dl><a NAME="E5SideBar.setTabEnabled" ID="E5SideBar.setTabEnabled"></a> |
749 </dl> |
|
750 <a NAME="E5SideBar.setTabEnabled" ID="E5SideBar.setTabEnabled"></a> |
566 <h4>E5SideBar.setTabEnabled</h4> |
751 <h4>E5SideBar.setTabEnabled</h4> |
567 <b>setTabEnabled</b>(<i>index, enabled</i>) |
752 <b>setTabEnabled</b>(<i>index, enabled</i>) |
|
753 |
568 <p> |
754 <p> |
569 Public method to set the enabled state of a tab. |
755 Public method to set the enabled state of a tab. |
570 </p><dl> |
756 </p> |
|
757 <dl> |
|
758 |
571 <dt><i>index</i></dt> |
759 <dt><i>index</i></dt> |
572 <dd> |
760 <dd> |
573 index of the tab to set (integer) |
761 index of the tab to set (integer) |
574 </dd><dt><i>enabled</i></dt> |
762 </dd> |
|
763 <dt><i>enabled</i></dt> |
575 <dd> |
764 <dd> |
576 enabled state to set (boolean) |
765 enabled state to set (boolean) |
577 </dd> |
766 </dd> |
578 </dl><a NAME="E5SideBar.setTabIcon" ID="E5SideBar.setTabIcon"></a> |
767 </dl> |
|
768 <a NAME="E5SideBar.setTabIcon" ID="E5SideBar.setTabIcon"></a> |
579 <h4>E5SideBar.setTabIcon</h4> |
769 <h4>E5SideBar.setTabIcon</h4> |
580 <b>setTabIcon</b>(<i>index, icon</i>) |
770 <b>setTabIcon</b>(<i>index, icon</i>) |
|
771 |
581 <p> |
772 <p> |
582 Public method to set the icon of a tab. |
773 Public method to set the icon of a tab. |
583 </p><dl> |
774 </p> |
|
775 <dl> |
|
776 |
584 <dt><i>index</i></dt> |
777 <dt><i>index</i></dt> |
585 <dd> |
778 <dd> |
586 index of the tab (integer) |
779 index of the tab (integer) |
587 </dd><dt><i>icon</i></dt> |
780 </dd> |
|
781 <dt><i>icon</i></dt> |
588 <dd> |
782 <dd> |
589 icon to be set (QIcon) |
783 icon to be set (QIcon) |
590 </dd> |
784 </dd> |
591 </dl><a NAME="E5SideBar.setTabText" ID="E5SideBar.setTabText"></a> |
785 </dl> |
|
786 <a NAME="E5SideBar.setTabText" ID="E5SideBar.setTabText"></a> |
592 <h4>E5SideBar.setTabText</h4> |
787 <h4>E5SideBar.setTabText</h4> |
593 <b>setTabText</b>(<i>index, text</i>) |
788 <b>setTabText</b>(<i>index, text</i>) |
|
789 |
594 <p> |
790 <p> |
595 Public method to set the text of a tab. |
791 Public method to set the text of a tab. |
596 </p><dl> |
792 </p> |
|
793 <dl> |
|
794 |
597 <dt><i>index</i></dt> |
795 <dt><i>index</i></dt> |
598 <dd> |
796 <dd> |
599 index of the tab (integer) |
797 index of the tab (integer) |
600 </dd><dt><i>text</i></dt> |
798 </dd> |
|
799 <dt><i>text</i></dt> |
601 <dd> |
800 <dd> |
602 text to set (string) |
801 text to set (string) |
603 </dd> |
802 </dd> |
604 </dl><a NAME="E5SideBar.setTabToolTip" ID="E5SideBar.setTabToolTip"></a> |
803 </dl> |
|
804 <a NAME="E5SideBar.setTabToolTip" ID="E5SideBar.setTabToolTip"></a> |
605 <h4>E5SideBar.setTabToolTip</h4> |
805 <h4>E5SideBar.setTabToolTip</h4> |
606 <b>setTabToolTip</b>(<i>index, tip</i>) |
806 <b>setTabToolTip</b>(<i>index, tip</i>) |
|
807 |
607 <p> |
808 <p> |
608 Public method to set the tooltip text of a tab. |
809 Public method to set the tooltip text of a tab. |
609 </p><dl> |
810 </p> |
|
811 <dl> |
|
812 |
610 <dt><i>index</i></dt> |
813 <dt><i>index</i></dt> |
611 <dd> |
814 <dd> |
612 index of the tab (integer) |
815 index of the tab (integer) |
613 </dd><dt><i>tip</i></dt> |
816 </dd> |
|
817 <dt><i>tip</i></dt> |
614 <dd> |
818 <dd> |
615 tooltip text to set (string) |
819 tooltip text to set (string) |
616 </dd> |
820 </dd> |
617 </dl><a NAME="E5SideBar.setTabWhatsThis" ID="E5SideBar.setTabWhatsThis"></a> |
821 </dl> |
|
822 <a NAME="E5SideBar.setTabWhatsThis" ID="E5SideBar.setTabWhatsThis"></a> |
618 <h4>E5SideBar.setTabWhatsThis</h4> |
823 <h4>E5SideBar.setTabWhatsThis</h4> |
619 <b>setTabWhatsThis</b>(<i>index, text</i>) |
824 <b>setTabWhatsThis</b>(<i>index, text</i>) |
|
825 |
620 <p> |
826 <p> |
621 Public method to set the WhatsThis text of a tab. |
827 Public method to set the WhatsThis text of a tab. |
622 </p><dl> |
828 </p> |
|
829 <dl> |
|
830 |
623 <dt><i>index</i></dt> |
831 <dt><i>index</i></dt> |
624 <dd> |
832 <dd> |
625 index of the tab (integer) |
833 index of the tab (integer) |
626 </dd><dt><i>text</i></dt> |
834 </dd> |
|
835 <dt><i>text</i></dt> |
627 <dd> |
836 <dd> |
628 WhatsThis text to set (string) |
837 WhatsThis text to set (string) |
629 </dd> |
838 </dd> |
630 </dl><a NAME="E5SideBar.shrink" ID="E5SideBar.shrink"></a> |
839 </dl> |
|
840 <a NAME="E5SideBar.shrink" ID="E5SideBar.shrink"></a> |
631 <h4>E5SideBar.shrink</h4> |
841 <h4>E5SideBar.shrink</h4> |
632 <b>shrink</b>(<i></i>) |
842 <b>shrink</b>(<i></i>) |
|
843 |
633 <p> |
844 <p> |
634 Public method to record a shrink request. |
845 Public method to record a shrink request. |
635 </p><a NAME="E5SideBar.shutdown" ID="E5SideBar.shutdown"></a> |
846 </p> |
|
847 <a NAME="E5SideBar.shutdown" ID="E5SideBar.shutdown"></a> |
636 <h4>E5SideBar.shutdown</h4> |
848 <h4>E5SideBar.shutdown</h4> |
637 <b>shutdown</b>(<i></i>) |
849 <b>shutdown</b>(<i></i>) |
|
850 |
638 <p> |
851 <p> |
639 Public method to shut down the object. |
852 Public method to shut down the object. |
640 </p><p> |
853 </p> |
|
854 <p> |
641 This method does some preparations so the object can be deleted |
855 This method does some preparations so the object can be deleted |
642 properly. It disconnects from the focusChanged signal in order to |
856 properly. It disconnects from the focusChanged signal in order to |
643 avoid trouble later on. |
857 avoid trouble later on. |
644 </p><a NAME="E5SideBar.tabIcon" ID="E5SideBar.tabIcon"></a> |
858 </p> |
|
859 <a NAME="E5SideBar.tabIcon" ID="E5SideBar.tabIcon"></a> |
645 <h4>E5SideBar.tabIcon</h4> |
860 <h4>E5SideBar.tabIcon</h4> |
646 <b>tabIcon</b>(<i>index</i>) |
861 <b>tabIcon</b>(<i>index</i>) |
|
862 |
647 <p> |
863 <p> |
648 Public method to get the icon of a tab. |
864 Public method to get the icon of a tab. |
649 </p><dl> |
865 </p> |
|
866 <dl> |
|
867 |
650 <dt><i>index</i></dt> |
868 <dt><i>index</i></dt> |
651 <dd> |
869 <dd> |
652 index of the tab (integer) |
870 index of the tab (integer) |
653 </dd> |
871 </dd> |
654 </dl><dl> |
872 </dl> |
|
873 <dl> |
655 <dt>Returns:</dt> |
874 <dt>Returns:</dt> |
656 <dd> |
875 <dd> |
657 icon of the tab (QIcon) |
876 icon of the tab (QIcon) |
658 </dd> |
877 </dd> |
659 </dl><a NAME="E5SideBar.tabText" ID="E5SideBar.tabText"></a> |
878 </dl> |
|
879 <a NAME="E5SideBar.tabText" ID="E5SideBar.tabText"></a> |
660 <h4>E5SideBar.tabText</h4> |
880 <h4>E5SideBar.tabText</h4> |
661 <b>tabText</b>(<i>index</i>) |
881 <b>tabText</b>(<i>index</i>) |
|
882 |
662 <p> |
883 <p> |
663 Public method to get the text of a tab. |
884 Public method to get the text of a tab. |
664 </p><dl> |
885 </p> |
|
886 <dl> |
|
887 |
665 <dt><i>index</i></dt> |
888 <dt><i>index</i></dt> |
666 <dd> |
889 <dd> |
667 index of the tab (integer) |
890 index of the tab (integer) |
668 </dd> |
891 </dd> |
669 </dl><dl> |
892 </dl> |
|
893 <dl> |
670 <dt>Returns:</dt> |
894 <dt>Returns:</dt> |
671 <dd> |
895 <dd> |
672 text of the tab (string) |
896 text of the tab (string) |
673 </dd> |
897 </dd> |
674 </dl><a NAME="E5SideBar.tabToolTip" ID="E5SideBar.tabToolTip"></a> |
898 </dl> |
|
899 <a NAME="E5SideBar.tabToolTip" ID="E5SideBar.tabToolTip"></a> |
675 <h4>E5SideBar.tabToolTip</h4> |
900 <h4>E5SideBar.tabToolTip</h4> |
676 <b>tabToolTip</b>(<i>index</i>) |
901 <b>tabToolTip</b>(<i>index</i>) |
|
902 |
677 <p> |
903 <p> |
678 Public method to get the tooltip text of a tab. |
904 Public method to get the tooltip text of a tab. |
679 </p><dl> |
905 </p> |
|
906 <dl> |
|
907 |
680 <dt><i>index</i></dt> |
908 <dt><i>index</i></dt> |
681 <dd> |
909 <dd> |
682 index of the tab (integer) |
910 index of the tab (integer) |
683 </dd> |
911 </dd> |
684 </dl><dl> |
912 </dl> |
|
913 <dl> |
685 <dt>Returns:</dt> |
914 <dt>Returns:</dt> |
686 <dd> |
915 <dd> |
687 tooltip text of the tab (string) |
916 tooltip text of the tab (string) |
688 </dd> |
917 </dd> |
689 </dl><a NAME="E5SideBar.tabWhatsThis" ID="E5SideBar.tabWhatsThis"></a> |
918 </dl> |
|
919 <a NAME="E5SideBar.tabWhatsThis" ID="E5SideBar.tabWhatsThis"></a> |
690 <h4>E5SideBar.tabWhatsThis</h4> |
920 <h4>E5SideBar.tabWhatsThis</h4> |
691 <b>tabWhatsThis</b>(<i>index</i>) |
921 <b>tabWhatsThis</b>(<i>index</i>) |
|
922 |
692 <p> |
923 <p> |
693 Public method to get the WhatsThis text of a tab. |
924 Public method to get the WhatsThis text of a tab. |
694 </p><dl> |
925 </p> |
|
926 <dl> |
|
927 |
695 <dt><i>index</i></dt> |
928 <dt><i>index</i></dt> |
696 <dd> |
929 <dd> |
697 index of the tab (integer) |
930 index of the tab (integer) |
698 </dd> |
931 </dd> |
699 </dl><dl> |
932 </dl> |
|
933 <dl> |
700 <dt>Returns:</dt> |
934 <dt>Returns:</dt> |
701 <dd> |
935 <dd> |
702 WhatsThis text of the tab (string) |
936 WhatsThis text of the tab (string) |
703 </dd> |
937 </dd> |
704 </dl><a NAME="E5SideBar.widget" ID="E5SideBar.widget"></a> |
938 </dl> |
|
939 <a NAME="E5SideBar.widget" ID="E5SideBar.widget"></a> |
705 <h4>E5SideBar.widget</h4> |
940 <h4>E5SideBar.widget</h4> |
706 <b>widget</b>(<i>index</i>) |
941 <b>widget</b>(<i>index</i>) |
|
942 |
707 <p> |
943 <p> |
708 Public method to get a reference to the widget associated with a tab. |
944 Public method to get a reference to the widget associated with a tab. |
709 </p><dl> |
945 </p> |
|
946 <dl> |
|
947 |
710 <dt><i>index</i></dt> |
948 <dt><i>index</i></dt> |
711 <dd> |
949 <dd> |
712 index of the tab (integer) |
950 index of the tab (integer) |
713 </dd> |
951 </dd> |
714 </dl><dl> |
952 </dl> |
|
953 <dl> |
715 <dt>Returns:</dt> |
954 <dt>Returns:</dt> |
716 <dd> |
955 <dd> |
717 reference to the widget (QWidget) |
956 reference to the widget (QWidget) |
718 </dd> |
957 </dd> |
719 </dl> |
958 </dl> |