Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.E5Gui.E5SideBar.html
Documentation/Source/eric5.E5Gui.E5SideBar.html
- changeset 55
- b5c84934de9c
- child 58
- 37f0444c3479
equal
deleted
inserted
replaced
| 54:31463df17fd5 | 55:b5c84934de9c |
|---|---|
| 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.E5Gui.E5SideBar</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.E5Gui.E5SideBar</h1> | |
| 24 <p> | |
| 25 Module implementing a sidebar class. | |
| 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="#E5SideBar">E5SideBar</a></td> | |
| 35 <td>Class implementing a sidebar with a widget area, that is hidden or shown, if the current tab is clicked again.</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="E5SideBar" ID="E5SideBar"></a> | |
| 44 <h2>E5SideBar</h2> | |
| 45 <p> | |
| 46 Class implementing a sidebar with a widget area, that is hidden or shown, if the | |
| 47 current tab is clicked again. | |
| 48 </p> | |
| 49 <h3>Derived from</h3> | |
| 50 QWidget | |
| 51 <h3>Class Attributes</h3> | |
| 52 <table> | |
| 53 <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> | |
| 54 </table> | |
| 55 <h3>Methods</h3> | |
| 56 <table> | |
| 57 <tr> | |
| 58 <td><a href="#E5SideBar.__init__">E5SideBar</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr><tr> | |
| 61 <td><a href="#E5SideBar.__appFocusChanged">__appFocusChanged</a></td> | |
| 62 <td>Private slot to handle a change of the focus.</td> | |
| 63 </tr><tr> | |
| 64 <td><a href="#E5SideBar.__autoHideToggled">__autoHideToggled</a></td> | |
| 65 <td>Private slot to handle the toggling of the autohide button.</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#E5SideBar.addTab">addTab</a></td> | |
| 68 <td>Public method to add a tab to the sidebar.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#E5SideBar.clear">clear</a></td> | |
| 71 <td>Public method to remove all tabs.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#E5SideBar.count">count</a></td> | |
| 74 <td>Public method to get the number of tabs.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#E5SideBar.currentIndex">currentIndex</a></td> | |
| 77 <td>Public method to get the index of the current tab.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#E5SideBar.currentWidget">currentWidget</a></td> | |
| 80 <td>Public method to get a reference to the current widget.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#E5SideBar.enterEvent">enterEvent</a></td> | |
| 83 <td>Protected method to handle the mouse entering this widget.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#E5SideBar.eventFilter">eventFilter</a></td> | |
| 86 <td>Protected method to handle some events for the tabbar.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#E5SideBar.expand">expand</a></td> | |
| 89 <td>Public method to expand the sidebar.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#E5SideBar.indexOf">indexOf</a></td> | |
| 92 <td>Public method to get the index of the given widget.</td> | |
| 93 </tr><tr> | |
| 94 <td><a href="#E5SideBar.insertTab">insertTab</a></td> | |
| 95 <td>Public method to insert a tab into the sidebar.</td> | |
| 96 </tr><tr> | |
| 97 <td><a href="#E5SideBar.isAutoHiding">isAutoHiding</a></td> | |
| 98 <td>Public method to check, if the auto hide function is active.</td> | |
| 99 </tr><tr> | |
| 100 <td><a href="#E5SideBar.isMinimized">isMinimized</a></td> | |
| 101 <td>Public method to check the minimized state.</td> | |
| 102 </tr><tr> | |
| 103 <td><a href="#E5SideBar.isTabEnabled">isTabEnabled</a></td> | |
| 104 <td>Public method to check, if a tab is enabled.</td> | |
| 105 </tr><tr> | |
| 106 <td><a href="#E5SideBar.leaveEvent">leaveEvent</a></td> | |
| 107 <td>Protected method to handle the mouse leaving this widget.</td> | |
| 108 </tr><tr> | |
| 109 <td><a href="#E5SideBar.nextTab">nextTab</a></td> | |
| 110 <td>Public slot used to show the next tab.</td> | |
| 111 </tr><tr> | |
| 112 <td><a href="#E5SideBar.orientation">orientation</a></td> | |
| 113 <td>Public method to get the orientation of the sidebar.</td> | |
| 114 </tr><tr> | |
| 115 <td><a href="#E5SideBar.prevTab">prevTab</a></td> | |
| 116 <td>Public slot used to show the previous tab.</td> | |
| 117 </tr><tr> | |
| 118 <td><a href="#E5SideBar.removeTab">removeTab</a></td> | |
| 119 <td>Public method to remove a tab.</td> | |
| 120 </tr><tr> | |
| 121 <td><a href="#E5SideBar.restoreState">restoreState</a></td> | |
| 122 <td>Public method to restore the state of the sidebar.</td> | |
| 123 </tr><tr> | |
| 124 <td><a href="#E5SideBar.saveState">saveState</a></td> | |
| 125 <td>Public method to save the state of the sidebar.</td> | |
| 126 </tr><tr> | |
| 127 <td><a href="#E5SideBar.setCurrentIndex">setCurrentIndex</a></td> | |
| 128 <td>Public slot to set the current index.</td> | |
| 129 </tr><tr> | |
| 130 <td><a href="#E5SideBar.setCurrentWidget">setCurrentWidget</a></td> | |
| 131 <td>Public slot to set the current widget.</td> | |
| 132 </tr><tr> | |
| 133 <td><a href="#E5SideBar.setOrientation">setOrientation</a></td> | |
| 134 <td>Public method to set the orientation of the sidebar.</td> | |
| 135 </tr><tr> | |
| 136 <td><a href="#E5SideBar.setSplitter">setSplitter</a></td> | |
| 137 <td>Public method to set the splitter managing the sidebar.</td> | |
| 138 </tr><tr> | |
| 139 <td><a href="#E5SideBar.setTabEnabled">setTabEnabled</a></td> | |
| 140 <td>Public method to set the enabled state of a tab.</td> | |
| 141 </tr><tr> | |
| 142 <td><a href="#E5SideBar.setTabIcon">setTabIcon</a></td> | |
| 143 <td>Public method to set the icon of a tab.</td> | |
| 144 </tr><tr> | |
| 145 <td><a href="#E5SideBar.setTabText">setTabText</a></td> | |
| 146 <td>Public method to set the text of a tab.</td> | |
| 147 </tr><tr> | |
| 148 <td><a href="#E5SideBar.setTabToolTip">setTabToolTip</a></td> | |
| 149 <td>Public method to set the tooltip text of a tab.</td> | |
| 150 </tr><tr> | |
| 151 <td><a href="#E5SideBar.setTabWhatsThis">setTabWhatsThis</a></td> | |
| 152 <td>Public method to set the WhatsThis text of a tab.</td> | |
| 153 </tr><tr> | |
| 154 <td><a href="#E5SideBar.shrink">shrink</a></td> | |
| 155 <td>Public method to shrink the sidebar.</td> | |
| 156 </tr><tr> | |
| 157 <td><a href="#E5SideBar.tabIcon">tabIcon</a></td> | |
| 158 <td>Public method to get the icon of a tab.</td> | |
| 159 </tr><tr> | |
| 160 <td><a href="#E5SideBar.tabText">tabText</a></td> | |
| 161 <td>Public method to get the text of a tab.</td> | |
| 162 </tr><tr> | |
| 163 <td><a href="#E5SideBar.tabToolTip">tabToolTip</a></td> | |
| 164 <td>Public method to get the tooltip text of a tab.</td> | |
| 165 </tr><tr> | |
| 166 <td><a href="#E5SideBar.tabWhatsThis">tabWhatsThis</a></td> | |
| 167 <td>Public method to get the WhatsThis text of a tab.</td> | |
| 168 </tr><tr> | |
| 169 <td><a href="#E5SideBar.widget">widget</a></td> | |
| 170 <td>Public method to get a reference to the widget associated with a tab.</td> | |
| 171 </tr> | |
| 172 </table> | |
| 173 <a NAME="E5SideBar.__init__" ID="E5SideBar.__init__"></a> | |
| 174 <h4>E5SideBar (Constructor)</h4> | |
| 175 <b>E5SideBar</b>(<i>orientation = None, parent = None</i>) | |
| 176 <p> | |
| 177 Constructor | |
| 178 </p><dl> | |
| 179 <dt><i>orientation</i></dt> | |
| 180 <dd> | |
| 181 orientation of the sidebar widget (North, East, South, West) | |
| 182 </dd><dt><i>parent</i></dt> | |
| 183 <dd> | |
| 184 parent widget (QWidget) | |
| 185 </dd> | |
| 186 </dl><a NAME="E5SideBar.__appFocusChanged" ID="E5SideBar.__appFocusChanged"></a> | |
| 187 <h4>E5SideBar.__appFocusChanged</h4> | |
| 188 <b>__appFocusChanged</b>(<i>old, now</i>) | |
| 189 <p> | |
| 190 Private slot to handle a change of the focus. | |
| 191 </p><dl> | |
| 192 <dt><i>old</i></dt> | |
| 193 <dd> | |
| 194 reference to the widget, that lost focus (QWidget or None) | |
| 195 </dd><dt><i>now</i></dt> | |
| 196 <dd> | |
| 197 reference to the widget having the focus (QWidget or None) | |
| 198 </dd> | |
| 199 </dl><a NAME="E5SideBar.__autoHideToggled" ID="E5SideBar.__autoHideToggled"></a> | |
| 200 <h4>E5SideBar.__autoHideToggled</h4> | |
| 201 <b>__autoHideToggled</b>(<i>checked</i>) | |
| 202 <p> | |
| 203 Private slot to handle the toggling of the autohide button. | |
| 204 </p><dl> | |
| 205 <dt><i>checked</i></dt> | |
| 206 <dd> | |
| 207 flag indicating the checked state of the button (boolean) | |
| 208 </dd> | |
| 209 </dl><a NAME="E5SideBar.addTab" ID="E5SideBar.addTab"></a> | |
| 210 <h4>E5SideBar.addTab</h4> | |
| 211 <b>addTab</b>(<i>widget, iconOrLabel, label = None</i>) | |
| 212 <p> | |
| 213 Public method to add a tab to the sidebar. | |
| 214 </p><dl> | |
| 215 <dt><i>widget</i></dt> | |
| 216 <dd> | |
| 217 reference to the widget to add (QWidget) | |
| 218 </dd><dt><i>iconOrLabel</i></dt> | |
| 219 <dd> | |
| 220 reference to the icon or the labeltext of the tab | |
| 221 (QIcon, string) | |
| 222 </dd><dt><i>label</i></dt> | |
| 223 <dd> | |
| 224 the labeltext of the tab (string) (only to be | |
| 225 used, if the second parameter is a QIcon) | |
| 226 </dd> | |
| 227 </dl><a NAME="E5SideBar.clear" ID="E5SideBar.clear"></a> | |
| 228 <h4>E5SideBar.clear</h4> | |
| 229 <b>clear</b>(<i></i>) | |
| 230 <p> | |
| 231 Public method to remove all tabs. | |
| 232 </p><a NAME="E5SideBar.count" ID="E5SideBar.count"></a> | |
| 233 <h4>E5SideBar.count</h4> | |
| 234 <b>count</b>(<i></i>) | |
| 235 <p> | |
| 236 Public method to get the number of tabs. | |
| 237 </p><dl> | |
| 238 <dt>Returns:</dt> | |
| 239 <dd> | |
| 240 number of tabs in the sidebar (integer) | |
| 241 </dd> | |
| 242 </dl><a NAME="E5SideBar.currentIndex" ID="E5SideBar.currentIndex"></a> | |
| 243 <h4>E5SideBar.currentIndex</h4> | |
| 244 <b>currentIndex</b>(<i></i>) | |
| 245 <p> | |
| 246 Public method to get the index of the current tab. | |
| 247 </p><dl> | |
| 248 <dt>Returns:</dt> | |
| 249 <dd> | |
| 250 index of the current tab (integer) | |
| 251 </dd> | |
| 252 </dl><a NAME="E5SideBar.currentWidget" ID="E5SideBar.currentWidget"></a> | |
| 253 <h4>E5SideBar.currentWidget</h4> | |
| 254 <b>currentWidget</b>(<i></i>) | |
| 255 <p> | |
| 256 Public method to get a reference to the current widget. | |
| 257 </p><dl> | |
| 258 <dt>Returns:</dt> | |
| 259 <dd> | |
| 260 reference to the current widget (QWidget) | |
| 261 </dd> | |
| 262 </dl><a NAME="E5SideBar.enterEvent" ID="E5SideBar.enterEvent"></a> | |
| 263 <h4>E5SideBar.enterEvent</h4> | |
| 264 <b>enterEvent</b>(<i>event</i>) | |
| 265 <p> | |
| 266 Protected method to handle the mouse entering this widget. | |
| 267 </p><dl> | |
| 268 <dt><i>event</i></dt> | |
| 269 <dd> | |
| 270 reference to the event (QEvent) | |
| 271 </dd> | |
| 272 </dl><a NAME="E5SideBar.eventFilter" ID="E5SideBar.eventFilter"></a> | |
| 273 <h4>E5SideBar.eventFilter</h4> | |
| 274 <b>eventFilter</b>(<i>obj, evt</i>) | |
| 275 <p> | |
| 276 Protected method to handle some events for the tabbar. | |
| 277 </p><dl> | |
| 278 <dt><i>obj</i></dt> | |
| 279 <dd> | |
| 280 reference to the object (QObject) | |
| 281 </dd><dt><i>evt</i></dt> | |
| 282 <dd> | |
| 283 reference to the event object (QEvent) | |
| 284 </dd> | |
| 285 </dl><dl> | |
| 286 <dt>Returns:</dt> | |
| 287 <dd> | |
| 288 flag indicating, if the event was handled (boolean) | |
| 289 </dd> | |
| 290 </dl><a NAME="E5SideBar.expand" ID="E5SideBar.expand"></a> | |
| 291 <h4>E5SideBar.expand</h4> | |
| 292 <b>expand</b>(<i></i>) | |
| 293 <p> | |
| 294 Public method to expand the sidebar. | |
| 295 </p><a NAME="E5SideBar.indexOf" ID="E5SideBar.indexOf"></a> | |
| 296 <h4>E5SideBar.indexOf</h4> | |
| 297 <b>indexOf</b>(<i>widget</i>) | |
| 298 <p> | |
| 299 Public method to get the index of the given widget. | |
| 300 </p><dl> | |
| 301 <dt><i>widget</i></dt> | |
| 302 <dd> | |
| 303 reference to the widget to get the index of (QWidget) | |
| 304 </dd> | |
| 305 </dl><dl> | |
| 306 <dt>Returns:</dt> | |
| 307 <dd> | |
| 308 index of the given widget (integer) | |
| 309 </dd> | |
| 310 </dl><a NAME="E5SideBar.insertTab" ID="E5SideBar.insertTab"></a> | |
| 311 <h4>E5SideBar.insertTab</h4> | |
| 312 <b>insertTab</b>(<i>index, widget, iconOrLabel, label = None</i>) | |
| 313 <p> | |
| 314 Public method to insert a tab into the sidebar. | |
| 315 </p><dl> | |
| 316 <dt><i>index</i></dt> | |
| 317 <dd> | |
| 318 the index to insert the tab at (integer) | |
| 319 </dd><dt><i>widget</i></dt> | |
| 320 <dd> | |
| 321 reference to the widget to insert (QWidget) | |
| 322 </dd><dt><i>iconOrLabel</i></dt> | |
| 323 <dd> | |
| 324 reference to the icon or the labeltext of the tab | |
| 325 (QIcon, string) | |
| 326 </dd><dt><i>label</i></dt> | |
| 327 <dd> | |
| 328 the labeltext of the tab (string) (only to be | |
| 329 used, if the second parameter is a QIcon) | |
| 330 </dd> | |
| 331 </dl><a NAME="E5SideBar.isAutoHiding" ID="E5SideBar.isAutoHiding"></a> | |
| 332 <h4>E5SideBar.isAutoHiding</h4> | |
| 333 <b>isAutoHiding</b>(<i></i>) | |
| 334 <p> | |
| 335 Public method to check, if the auto hide function is active. | |
| 336 </p><dl> | |
| 337 <dt>Returns:</dt> | |
| 338 <dd> | |
| 339 flag indicating the state of auto hiding (boolean) | |
| 340 </dd> | |
| 341 </dl><a NAME="E5SideBar.isMinimized" ID="E5SideBar.isMinimized"></a> | |
| 342 <h4>E5SideBar.isMinimized</h4> | |
| 343 <b>isMinimized</b>(<i></i>) | |
| 344 <p> | |
| 345 Public method to check the minimized state. | |
| 346 </p><dl> | |
| 347 <dt>Returns:</dt> | |
| 348 <dd> | |
| 349 flag indicating the minimized state (boolean) | |
| 350 </dd> | |
| 351 </dl><a NAME="E5SideBar.isTabEnabled" ID="E5SideBar.isTabEnabled"></a> | |
| 352 <h4>E5SideBar.isTabEnabled</h4> | |
| 353 <b>isTabEnabled</b>(<i>index</i>) | |
| 354 <p> | |
| 355 Public method to check, if a tab is enabled. | |
| 356 </p><dl> | |
| 357 <dt><i>index</i></dt> | |
| 358 <dd> | |
| 359 index of the tab to check (integer) | |
| 360 </dd> | |
| 361 </dl><dl> | |
| 362 <dt>Returns:</dt> | |
| 363 <dd> | |
| 364 flag indicating the enabled state (boolean) | |
| 365 </dd> | |
| 366 </dl><a NAME="E5SideBar.leaveEvent" ID="E5SideBar.leaveEvent"></a> | |
| 367 <h4>E5SideBar.leaveEvent</h4> | |
| 368 <b>leaveEvent</b>(<i>event</i>) | |
| 369 <p> | |
| 370 Protected method to handle the mouse leaving this widget. | |
| 371 </p><dl> | |
| 372 <dt><i>event</i></dt> | |
| 373 <dd> | |
| 374 reference to the event (QEvent) | |
| 375 </dd> | |
| 376 </dl><a NAME="E5SideBar.nextTab" ID="E5SideBar.nextTab"></a> | |
| 377 <h4>E5SideBar.nextTab</h4> | |
| 378 <b>nextTab</b>(<i></i>) | |
| 379 <p> | |
| 380 Public slot used to show the next tab. | |
| 381 </p><a NAME="E5SideBar.orientation" ID="E5SideBar.orientation"></a> | |
| 382 <h4>E5SideBar.orientation</h4> | |
| 383 <b>orientation</b>(<i></i>) | |
| 384 <p> | |
| 385 Public method to get the orientation of the sidebar. | |
| 386 </p><dl> | |
| 387 <dt>Returns:</dt> | |
| 388 <dd> | |
| 389 orientation of the sidebar (North, East, South, West) | |
| 390 </dd> | |
| 391 </dl><a NAME="E5SideBar.prevTab" ID="E5SideBar.prevTab"></a> | |
| 392 <h4>E5SideBar.prevTab</h4> | |
| 393 <b>prevTab</b>(<i></i>) | |
| 394 <p> | |
| 395 Public slot used to show the previous tab. | |
| 396 </p><a NAME="E5SideBar.removeTab" ID="E5SideBar.removeTab"></a> | |
| 397 <h4>E5SideBar.removeTab</h4> | |
| 398 <b>removeTab</b>(<i>index</i>) | |
| 399 <p> | |
| 400 Public method to remove a tab. | |
| 401 </p><dl> | |
| 402 <dt><i>index</i></dt> | |
| 403 <dd> | |
| 404 the index of the tab to remove (integer) | |
| 405 </dd> | |
| 406 </dl><a NAME="E5SideBar.restoreState" ID="E5SideBar.restoreState"></a> | |
| 407 <h4>E5SideBar.restoreState</h4> | |
| 408 <b>restoreState</b>(<i>state</i>) | |
| 409 <p> | |
| 410 Public method to restore the state of the sidebar. | |
| 411 </p><dl> | |
| 412 <dt><i>state</i></dt> | |
| 413 <dd> | |
| 414 byte array containing the saved state (QByteArray) | |
| 415 </dd> | |
| 416 </dl><dl> | |
| 417 <dt>Returns:</dt> | |
| 418 <dd> | |
| 419 flag indicating success (boolean) | |
| 420 </dd> | |
| 421 </dl><a NAME="E5SideBar.saveState" ID="E5SideBar.saveState"></a> | |
| 422 <h4>E5SideBar.saveState</h4> | |
| 423 <b>saveState</b>(<i></i>) | |
| 424 <p> | |
| 425 Public method to save the state of the sidebar. | |
| 426 </p><dl> | |
| 427 <dt>Returns:</dt> | |
| 428 <dd> | |
| 429 saved state as a byte array (QByteArray) | |
| 430 </dd> | |
| 431 </dl><a NAME="E5SideBar.setCurrentIndex" ID="E5SideBar.setCurrentIndex"></a> | |
| 432 <h4>E5SideBar.setCurrentIndex</h4> | |
| 433 <b>setCurrentIndex</b>(<i>index</i>) | |
| 434 <p> | |
| 435 Public slot to set the current index. | |
| 436 </p><dl> | |
| 437 <dt><i>index</i></dt> | |
| 438 <dd> | |
| 439 the index to set as the current index (integer) | |
| 440 </dd> | |
| 441 </dl><a NAME="E5SideBar.setCurrentWidget" ID="E5SideBar.setCurrentWidget"></a> | |
| 442 <h4>E5SideBar.setCurrentWidget</h4> | |
| 443 <b>setCurrentWidget</b>(<i>widget</i>) | |
| 444 <p> | |
| 445 Public slot to set the current widget. | |
| 446 </p><dl> | |
| 447 <dt><i>widget</i></dt> | |
| 448 <dd> | |
| 449 reference to the widget to become the current widget (QWidget) | |
| 450 </dd> | |
| 451 </dl><a NAME="E5SideBar.setOrientation" ID="E5SideBar.setOrientation"></a> | |
| 452 <h4>E5SideBar.setOrientation</h4> | |
| 453 <b>setOrientation</b>(<i>orient</i>) | |
| 454 <p> | |
| 455 Public method to set the orientation of the sidebar. | |
| 456 </p><dl> | |
| 457 <dt><i>orient</i></dt> | |
| 458 <dd> | |
| 459 orientation of the sidebar (North, East, South, West) | |
| 460 </dd> | |
| 461 </dl><a NAME="E5SideBar.setSplitter" ID="E5SideBar.setSplitter"></a> | |
| 462 <h4>E5SideBar.setSplitter</h4> | |
| 463 <b>setSplitter</b>(<i>splitter</i>) | |
| 464 <p> | |
| 465 Public method to set the splitter managing the sidebar. | |
| 466 </p><dl> | |
| 467 <dt><i>splitter</i></dt> | |
| 468 <dd> | |
| 469 reference to the splitter (QSplitter) | |
| 470 </dd> | |
| 471 </dl><a NAME="E5SideBar.setTabEnabled" ID="E5SideBar.setTabEnabled"></a> | |
| 472 <h4>E5SideBar.setTabEnabled</h4> | |
| 473 <b>setTabEnabled</b>(<i>index, enabled</i>) | |
| 474 <p> | |
| 475 Public method to set the enabled state of a tab. | |
| 476 </p><dl> | |
| 477 <dt><i>index</i></dt> | |
| 478 <dd> | |
| 479 index of the tab to set (integer) | |
| 480 </dd><dt><i>enabled</i></dt> | |
| 481 <dd> | |
| 482 enabled state to set (boolean) | |
| 483 </dd> | |
| 484 </dl><a NAME="E5SideBar.setTabIcon" ID="E5SideBar.setTabIcon"></a> | |
| 485 <h4>E5SideBar.setTabIcon</h4> | |
| 486 <b>setTabIcon</b>(<i>index, icon</i>) | |
| 487 <p> | |
| 488 Public method to set the icon of a tab. | |
| 489 </p><dl> | |
| 490 <dt><i>index</i></dt> | |
| 491 <dd> | |
| 492 index of the tab (integer) | |
| 493 </dd><dt><i>icon</i></dt> | |
| 494 <dd> | |
| 495 icon to be set (QIcon) | |
| 496 </dd> | |
| 497 </dl><a NAME="E5SideBar.setTabText" ID="E5SideBar.setTabText"></a> | |
| 498 <h4>E5SideBar.setTabText</h4> | |
| 499 <b>setTabText</b>(<i>index, text</i>) | |
| 500 <p> | |
| 501 Public method to set the text of a tab. | |
| 502 </p><dl> | |
| 503 <dt><i>index</i></dt> | |
| 504 <dd> | |
| 505 index of the tab (integer) | |
| 506 </dd><dt><i>text</i></dt> | |
| 507 <dd> | |
| 508 text to set (string) | |
| 509 </dd> | |
| 510 </dl><a NAME="E5SideBar.setTabToolTip" ID="E5SideBar.setTabToolTip"></a> | |
| 511 <h4>E5SideBar.setTabToolTip</h4> | |
| 512 <b>setTabToolTip</b>(<i>index, tip</i>) | |
| 513 <p> | |
| 514 Public method to set the tooltip text of a tab. | |
| 515 </p><dl> | |
| 516 <dt><i>index</i></dt> | |
| 517 <dd> | |
| 518 index of the tab (integer) | |
| 519 </dd><dt><i>tooltip</i></dt> | |
| 520 <dd> | |
| 521 text text to set (string) | |
| 522 </dd> | |
| 523 </dl><a NAME="E5SideBar.setTabWhatsThis" ID="E5SideBar.setTabWhatsThis"></a> | |
| 524 <h4>E5SideBar.setTabWhatsThis</h4> | |
| 525 <b>setTabWhatsThis</b>(<i>index, text</i>) | |
| 526 <p> | |
| 527 Public method to set the WhatsThis text of a tab. | |
| 528 </p><dl> | |
| 529 <dt><i>index</i></dt> | |
| 530 <dd> | |
| 531 index of the tab (integer) | |
| 532 </dd><dt><i>WhatsThis</i></dt> | |
| 533 <dd> | |
| 534 text text to set (string) | |
| 535 </dd> | |
| 536 </dl><a NAME="E5SideBar.shrink" ID="E5SideBar.shrink"></a> | |
| 537 <h4>E5SideBar.shrink</h4> | |
| 538 <b>shrink</b>(<i></i>) | |
| 539 <p> | |
| 540 Public method to shrink the sidebar. | |
| 541 </p><a NAME="E5SideBar.tabIcon" ID="E5SideBar.tabIcon"></a> | |
| 542 <h4>E5SideBar.tabIcon</h4> | |
| 543 <b>tabIcon</b>(<i>index</i>) | |
| 544 <p> | |
| 545 Public method to get the icon of a tab. | |
| 546 </p><dl> | |
| 547 <dt><i>index</i></dt> | |
| 548 <dd> | |
| 549 index of the tab (integer) | |
| 550 </dd> | |
| 551 </dl><dl> | |
| 552 <dt>Returns:</dt> | |
| 553 <dd> | |
| 554 icon of the tab (QIcon) | |
| 555 </dd> | |
| 556 </dl><a NAME="E5SideBar.tabText" ID="E5SideBar.tabText"></a> | |
| 557 <h4>E5SideBar.tabText</h4> | |
| 558 <b>tabText</b>(<i>index</i>) | |
| 559 <p> | |
| 560 Public method to get the text of a tab. | |
| 561 </p><dl> | |
| 562 <dt><i>index</i></dt> | |
| 563 <dd> | |
| 564 index of the tab (integer) | |
| 565 </dd> | |
| 566 </dl><dl> | |
| 567 <dt>Returns:</dt> | |
| 568 <dd> | |
| 569 text of the tab (string) | |
| 570 </dd> | |
| 571 </dl><a NAME="E5SideBar.tabToolTip" ID="E5SideBar.tabToolTip"></a> | |
| 572 <h4>E5SideBar.tabToolTip</h4> | |
| 573 <b>tabToolTip</b>(<i>index</i>) | |
| 574 <p> | |
| 575 Public method to get the tooltip text of a tab. | |
| 576 </p><dl> | |
| 577 <dt><i>index</i></dt> | |
| 578 <dd> | |
| 579 index of the tab (integer) | |
| 580 </dd> | |
| 581 </dl><dl> | |
| 582 <dt>Returns:</dt> | |
| 583 <dd> | |
| 584 tooltip text of the tab (string) | |
| 585 </dd> | |
| 586 </dl><a NAME="E5SideBar.tabWhatsThis" ID="E5SideBar.tabWhatsThis"></a> | |
| 587 <h4>E5SideBar.tabWhatsThis</h4> | |
| 588 <b>tabWhatsThis</b>(<i>index</i>) | |
| 589 <p> | |
| 590 Public method to get the WhatsThis text of a tab. | |
| 591 </p><dl> | |
| 592 <dt><i>index</i></dt> | |
| 593 <dd> | |
| 594 index of the tab (integer) | |
| 595 </dd> | |
| 596 </dl><dl> | |
| 597 <dt>Returns:</dt> | |
| 598 <dd> | |
| 599 WhatsThis text of the tab (string) | |
| 600 </dd> | |
| 601 </dl><a NAME="E5SideBar.widget" ID="E5SideBar.widget"></a> | |
| 602 <h4>E5SideBar.widget</h4> | |
| 603 <b>widget</b>(<i>index</i>) | |
| 604 <p> | |
| 605 Public method to get a reference to the widget associated with a tab. | |
| 606 </p><dl> | |
| 607 <dt><i>index</i></dt> | |
| 608 <dd> | |
| 609 index of the tab (integer) | |
| 610 </dd> | |
| 611 </dl><dl> | |
| 612 <dt>Returns:</dt> | |
| 613 <dd> | |
| 614 reference to the widget (QWidget) | |
| 615 </dd> | |
| 616 </dl> | |
| 617 <div align="right"><a href="#top">Up</a></div> | |
| 618 <hr /> | |
| 619 </body></html> |
