Mercurial Repositories > eric / file diff

diff: eric7/Documentation/Source/eric7.EricWidgets.EricSideBar.html

eric7/Documentation/Source/eric7.EricWidgets.EricSideBar.html

branch
eric7
changeset 8372
e0227a7c850e
child 8583
aac629a05f8b
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.EricWidgets.EricSideBar.html	Mon May 24 11:19:57 2021 +0200
@@ -0,0 +1,1001 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.EricWidgets.EricSideBar</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.EricWidgets.EricSideBar</h1>
+
+<p>
+Module implementing a sidebar class.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#EricSideBar">EricSideBar</a></td>
+<td>Class implementing a sidebar with a widget area, that is hidden or shown, if the current tab is clicked again.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBarSide">EricSideBarSide</a></td>
+<td>Class defining the sidebar sides.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="EricSideBar" ID="EricSideBar"></a>
+<h2>EricSideBar</h2>
+
+<p>
+    Class implementing a sidebar with a widget area, that is hidden or shown,
+    if the current tab is clicked again.
+</p>
+<h3>Derived from</h3>
+QWidget
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>Version</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#EricSideBar.__init__">EricSideBar</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.__appFocusChanged">__appFocusChanged</a></td>
+<td>Private slot to handle a change of the focus.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.__autoHideToggled">__autoHideToggled</a></td>
+<td>Private slot to handle the toggling of the autohide button.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.__cancelDelayTimer">__cancelDelayTimer</a></td>
+<td>Private method to cancel the current delay timer.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.__delayedAction">__delayedAction</a></td>
+<td>Private slot to handle the firing of the delay timer.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.__expandIt">__expandIt</a></td>
+<td>Private method to expand the sidebar.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.__shrinkIt">__shrinkIt</a></td>
+<td>Private method to shrink the sidebar.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.__splitterMoved">__splitterMoved</a></td>
+<td>Private slot to react on splitter moves.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.addTab">addTab</a></td>
+<td>Public method to add a tab to the sidebar.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.clear">clear</a></td>
+<td>Public method to remove all tabs.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.count">count</a></td>
+<td>Public method to get the number of tabs.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.currentIndex">currentIndex</a></td>
+<td>Public method to get the index of the current tab.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.currentWidget">currentWidget</a></td>
+<td>Public method to get a reference to the current widget.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.delay">delay</a></td>
+<td>Public method to get the delay value for the expand/shrink delay in milliseconds.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.enterEvent">enterEvent</a></td>
+<td>Protected method to handle the mouse entering this widget.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.eventFilter">eventFilter</a></td>
+<td>Public method to handle some events for the tabbar.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.expand">expand</a></td>
+<td>Public method to record a expand request.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.indexOf">indexOf</a></td>
+<td>Public method to get the index of the given widget.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.insertTab">insertTab</a></td>
+<td>Public method to insert a tab into the sidebar.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.isAutoHiding">isAutoHiding</a></td>
+<td>Public method to check, if the auto hide function is active.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.isMinimized">isMinimized</a></td>
+<td>Public method to check the minimized state.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.isTabEnabled">isTabEnabled</a></td>
+<td>Public method to check, if a tab is enabled.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.leaveEvent">leaveEvent</a></td>
+<td>Protected method to handle the mouse leaving this widget.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.nextTab">nextTab</a></td>
+<td>Public slot used to show the next tab.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.orientation">orientation</a></td>
+<td>Public method to get the orientation of the sidebar.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.prevTab">prevTab</a></td>
+<td>Public slot used to show the previous tab.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.removeTab">removeTab</a></td>
+<td>Public method to remove a tab.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.restoreState">restoreState</a></td>
+<td>Public method to restore the state of the sidebar.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.saveState">saveState</a></td>
+<td>Public method to save the state of the sidebar.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.setCurrentIndex">setCurrentIndex</a></td>
+<td>Public slot to set the current index.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.setCurrentWidget">setCurrentWidget</a></td>
+<td>Public slot to set the current widget.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.setDelay">setDelay</a></td>
+<td>Public method to set the delay value for the expand/shrink delay in milliseconds.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.setOrientation">setOrientation</a></td>
+<td>Public method to set the orientation of the sidebar.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.setSplitter">setSplitter</a></td>
+<td>Public method to set the splitter managing the sidebar.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.setTabEnabled">setTabEnabled</a></td>
+<td>Public method to set the enabled state of a tab.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.setTabIcon">setTabIcon</a></td>
+<td>Public method to set the icon of a tab.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.setTabText">setTabText</a></td>
+<td>Public method to set the text of a tab.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.setTabToolTip">setTabToolTip</a></td>
+<td>Public method to set the tooltip text of a tab.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.setTabWhatsThis">setTabWhatsThis</a></td>
+<td>Public method to set the WhatsThis text of a tab.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.shrink">shrink</a></td>
+<td>Public method to record a shrink request.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.shutdown">shutdown</a></td>
+<td>Public method to shut down the object.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.tabIcon">tabIcon</a></td>
+<td>Public method to get the icon of a tab.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.tabText">tabText</a></td>
+<td>Public method to get the text of a tab.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.tabToolTip">tabToolTip</a></td>
+<td>Public method to get the tooltip text of a tab.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.tabWhatsThis">tabWhatsThis</a></td>
+<td>Public method to get the WhatsThis text of a tab.</td>
+</tr>
+<tr>
+<td><a href="#EricSideBar.widget">widget</a></td>
+<td>Public method to get a reference to the widget associated with a tab.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="EricSideBar.__init__" ID="EricSideBar.__init__"></a>
+<h4>EricSideBar (Constructor)</h4>
+<b>EricSideBar</b>(<i>orientation=None, delay=200, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>orientation</i> (EricSideBarSide)</dt>
+<dd>
+orientation of the sidebar widget
+</dd>
+<dt><i>delay</i> (int)</dt>
+<dd>
+value for the expand/shrink delay in milliseconds
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+parent widget
+</dd>
+</dl>
+<a NAME="EricSideBar.__appFocusChanged" ID="EricSideBar.__appFocusChanged"></a>
+<h4>EricSideBar.__appFocusChanged</h4>
+<b>__appFocusChanged</b>(<i>old, now</i>)
+
+<p>
+        Private slot to handle a change of the focus.
+</p>
+<dl>
+
+<dt><i>old</i></dt>
+<dd>
+reference to the widget, that lost focus (QWidget or None)
+</dd>
+<dt><i>now</i></dt>
+<dd>
+reference to the widget having the focus (QWidget or None)
+</dd>
+</dl>
+<a NAME="EricSideBar.__autoHideToggled" ID="EricSideBar.__autoHideToggled"></a>
+<h4>EricSideBar.__autoHideToggled</h4>
+<b>__autoHideToggled</b>(<i>checked</i>)
+
+<p>
+        Private slot to handle the toggling of the autohide button.
+</p>
+<dl>
+
+<dt><i>checked</i></dt>
+<dd>
+flag indicating the checked state of the button
+            (boolean)
+</dd>
+</dl>
+<a NAME="EricSideBar.__cancelDelayTimer" ID="EricSideBar.__cancelDelayTimer"></a>
+<h4>EricSideBar.__cancelDelayTimer</h4>
+<b>__cancelDelayTimer</b>(<i></i>)
+
+<p>
+        Private method to cancel the current delay timer.
+</p>
+<a NAME="EricSideBar.__delayedAction" ID="EricSideBar.__delayedAction"></a>
+<h4>EricSideBar.__delayedAction</h4>
+<b>__delayedAction</b>(<i></i>)
+
+<p>
+        Private slot to handle the firing of the delay timer.
+</p>
+<a NAME="EricSideBar.__expandIt" ID="EricSideBar.__expandIt"></a>
+<h4>EricSideBar.__expandIt</h4>
+<b>__expandIt</b>(<i></i>)
+
+<p>
+        Private method to expand the sidebar.
+</p>
+<a NAME="EricSideBar.__shrinkIt" ID="EricSideBar.__shrinkIt"></a>
+<h4>EricSideBar.__shrinkIt</h4>
+<b>__shrinkIt</b>(<i></i>)
+
+<p>
+        Private method to shrink the sidebar.
+</p>
+<a NAME="EricSideBar.__splitterMoved" ID="EricSideBar.__splitterMoved"></a>
+<h4>EricSideBar.__splitterMoved</h4>
+<b>__splitterMoved</b>(<i>pos, index</i>)
+
+<p>
+        Private slot to react on splitter moves.
+</p>
+<dl>
+
+<dt><i>pos</i></dt>
+<dd>
+new position of the splitter handle (integer)
+</dd>
+<dt><i>index</i></dt>
+<dd>
+index of the splitter handle (integer)
+</dd>
+</dl>
+<a NAME="EricSideBar.addTab" ID="EricSideBar.addTab"></a>
+<h4>EricSideBar.addTab</h4>
+<b>addTab</b>(<i>widget, iconOrLabel, label=None</i>)
+
+<p>
+        Public method to add a tab to the sidebar.
+</p>
+<dl>
+
+<dt><i>widget</i></dt>
+<dd>
+reference to the widget to add (QWidget)
+</dd>
+<dt><i>iconOrLabel</i></dt>
+<dd>
+reference to the icon or the label text of the tab
+            (QIcon, string)
+</dd>
+<dt><i>label</i></dt>
+<dd>
+the labeltext of the tab (string) (only to be
+            used, if the second parameter is a QIcon)
+</dd>
+</dl>
+<a NAME="EricSideBar.clear" ID="EricSideBar.clear"></a>
+<h4>EricSideBar.clear</h4>
+<b>clear</b>(<i></i>)
+
+<p>
+        Public method to remove all tabs.
+</p>
+<a NAME="EricSideBar.count" ID="EricSideBar.count"></a>
+<h4>EricSideBar.count</h4>
+<b>count</b>(<i></i>)
+
+<p>
+        Public method to get the number of tabs.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+number of tabs in the sidebar (integer)
+</dd>
+</dl>
+<a NAME="EricSideBar.currentIndex" ID="EricSideBar.currentIndex"></a>
+<h4>EricSideBar.currentIndex</h4>
+<b>currentIndex</b>(<i></i>)
+
+<p>
+        Public method to get the index of the current tab.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+index of the current tab (integer)
+</dd>
+</dl>
+<a NAME="EricSideBar.currentWidget" ID="EricSideBar.currentWidget"></a>
+<h4>EricSideBar.currentWidget</h4>
+<b>currentWidget</b>(<i></i>)
+
+<p>
+        Public method to get a reference to the current widget.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the current widget (QWidget)
+</dd>
+</dl>
+<a NAME="EricSideBar.delay" ID="EricSideBar.delay"></a>
+<h4>EricSideBar.delay</h4>
+<b>delay</b>(<i></i>)
+
+<p>
+        Public method to get the delay value for the expand/shrink delay in
+        milliseconds.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+value for the expand/shrink delay in milliseconds (integer)
+</dd>
+</dl>
+<a NAME="EricSideBar.enterEvent" ID="EricSideBar.enterEvent"></a>
+<h4>EricSideBar.enterEvent</h4>
+<b>enterEvent</b>(<i>event</i>)
+
+<p>
+        Protected method to handle the mouse entering this widget.
+</p>
+<dl>
+
+<dt><i>event</i></dt>
+<dd>
+reference to the event (QEvent)
+</dd>
+</dl>
+<a NAME="EricSideBar.eventFilter" ID="EricSideBar.eventFilter"></a>
+<h4>EricSideBar.eventFilter</h4>
+<b>eventFilter</b>(<i>obj, evt</i>)
+
+<p>
+        Public method to handle some events for the tabbar.
+</p>
+<dl>
+
+<dt><i>obj</i></dt>
+<dd>
+reference to the object (QObject)
+</dd>
+<dt><i>evt</i></dt>
+<dd>
+reference to the event object (QEvent)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating, if the event was handled (boolean)
+</dd>
+</dl>
+<a NAME="EricSideBar.expand" ID="EricSideBar.expand"></a>
+<h4>EricSideBar.expand</h4>
+<b>expand</b>(<i></i>)
+
+<p>
+        Public method to record a expand request.
+</p>
+<a NAME="EricSideBar.indexOf" ID="EricSideBar.indexOf"></a>
+<h4>EricSideBar.indexOf</h4>
+<b>indexOf</b>(<i>widget</i>)
+
+<p>
+        Public method to get the index of the given widget.
+</p>
+<dl>
+
+<dt><i>widget</i></dt>
+<dd>
+reference to the widget to get the index of (QWidget)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+index of the given widget (integer)
+</dd>
+</dl>
+<a NAME="EricSideBar.insertTab" ID="EricSideBar.insertTab"></a>
+<h4>EricSideBar.insertTab</h4>
+<b>insertTab</b>(<i>index, widget, iconOrLabel, label=None</i>)
+
+<p>
+        Public method to insert a tab into the sidebar.
+</p>
+<dl>
+
+<dt><i>index</i></dt>
+<dd>
+the index to insert the tab at (integer)
+</dd>
+<dt><i>widget</i></dt>
+<dd>
+reference to the widget to insert (QWidget)
+</dd>
+<dt><i>iconOrLabel</i></dt>
+<dd>
+reference to the icon or the labeltext of the tab
+            (QIcon, string)
+</dd>
+<dt><i>label</i></dt>
+<dd>
+the labeltext of the tab (string) (only to be
+            used, if the second parameter is a QIcon)
+</dd>
+</dl>
+<a NAME="EricSideBar.isAutoHiding" ID="EricSideBar.isAutoHiding"></a>
+<h4>EricSideBar.isAutoHiding</h4>
+<b>isAutoHiding</b>(<i></i>)
+
+<p>
+        Public method to check, if the auto hide function is active.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating the state of auto hiding (boolean)
+</dd>
+</dl>
+<a NAME="EricSideBar.isMinimized" ID="EricSideBar.isMinimized"></a>
+<h4>EricSideBar.isMinimized</h4>
+<b>isMinimized</b>(<i></i>)
+
+<p>
+        Public method to check the minimized state.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating the minimized state (boolean)
+</dd>
+</dl>
+<a NAME="EricSideBar.isTabEnabled" ID="EricSideBar.isTabEnabled"></a>
+<h4>EricSideBar.isTabEnabled</h4>
+<b>isTabEnabled</b>(<i>index</i>)
+
+<p>
+        Public method to check, if a tab is enabled.
+</p>
+<dl>
+
+<dt><i>index</i></dt>
+<dd>
+index of the tab to check (integer)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating the enabled state (boolean)
+</dd>
+</dl>
+<a NAME="EricSideBar.leaveEvent" ID="EricSideBar.leaveEvent"></a>
+<h4>EricSideBar.leaveEvent</h4>
+<b>leaveEvent</b>(<i>event</i>)
+
+<p>
+        Protected method to handle the mouse leaving this widget.
+</p>
+<dl>
+
+<dt><i>event</i></dt>
+<dd>
+reference to the event (QEvent)
+</dd>
+</dl>
+<a NAME="EricSideBar.nextTab" ID="EricSideBar.nextTab"></a>
+<h4>EricSideBar.nextTab</h4>
+<b>nextTab</b>(<i></i>)
+
+<p>
+        Public slot used to show the next tab.
+</p>
+<a NAME="EricSideBar.orientation" ID="EricSideBar.orientation"></a>
+<h4>EricSideBar.orientation</h4>
+<b>orientation</b>(<i></i>)
+
+<p>
+        Public method to get the orientation of the sidebar.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+orientation of the sidebar
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+EricSideBarSide
+</dd>
+</dl>
+<a NAME="EricSideBar.prevTab" ID="EricSideBar.prevTab"></a>
+<h4>EricSideBar.prevTab</h4>
+<b>prevTab</b>(<i></i>)
+
+<p>
+        Public slot used to show the previous tab.
+</p>
+<a NAME="EricSideBar.removeTab" ID="EricSideBar.removeTab"></a>
+<h4>EricSideBar.removeTab</h4>
+<b>removeTab</b>(<i>index</i>)
+
+<p>
+        Public method to remove a tab.
+</p>
+<dl>
+
+<dt><i>index</i></dt>
+<dd>
+the index of the tab to remove (integer)
+</dd>
+</dl>
+<a NAME="EricSideBar.restoreState" ID="EricSideBar.restoreState"></a>
+<h4>EricSideBar.restoreState</h4>
+<b>restoreState</b>(<i>state</i>)
+
+<p>
+        Public method to restore the state of the sidebar.
+</p>
+<dl>
+
+<dt><i>state</i></dt>
+<dd>
+byte array containing the saved state (QByteArray)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating success (boolean)
+</dd>
+</dl>
+<a NAME="EricSideBar.saveState" ID="EricSideBar.saveState"></a>
+<h4>EricSideBar.saveState</h4>
+<b>saveState</b>(<i></i>)
+
+<p>
+        Public method to save the state of the sidebar.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+saved state as a byte array (QByteArray)
+</dd>
+</dl>
+<a NAME="EricSideBar.setCurrentIndex" ID="EricSideBar.setCurrentIndex"></a>
+<h4>EricSideBar.setCurrentIndex</h4>
+<b>setCurrentIndex</b>(<i>index</i>)
+
+<p>
+        Public slot to set the current index.
+</p>
+<dl>
+
+<dt><i>index</i></dt>
+<dd>
+the index to set as the current index (integer)
+</dd>
+</dl>
+<a NAME="EricSideBar.setCurrentWidget" ID="EricSideBar.setCurrentWidget"></a>
+<h4>EricSideBar.setCurrentWidget</h4>
+<b>setCurrentWidget</b>(<i>widget</i>)
+
+<p>
+        Public slot to set the current widget.
+</p>
+<dl>
+
+<dt><i>widget</i></dt>
+<dd>
+reference to the widget to become the current widget
+            (QWidget)
+</dd>
+</dl>
+<a NAME="EricSideBar.setDelay" ID="EricSideBar.setDelay"></a>
+<h4>EricSideBar.setDelay</h4>
+<b>setDelay</b>(<i>delay</i>)
+
+<p>
+        Public method to set the delay value for the expand/shrink delay in
+        milliseconds.
+</p>
+<dl>
+
+<dt><i>delay</i></dt>
+<dd>
+value for the expand/shrink delay in milliseconds
+            (integer)
+</dd>
+</dl>
+<a NAME="EricSideBar.setOrientation" ID="EricSideBar.setOrientation"></a>
+<h4>EricSideBar.setOrientation</h4>
+<b>setOrientation</b>(<i>orient</i>)
+
+<p>
+        Public method to set the orientation of the sidebar.
+</p>
+<dl>
+
+<dt><i>orient</i> (EricSideBarSide)</dt>
+<dd>
+orientation of the sidebar
+</dd>
+</dl>
+<a NAME="EricSideBar.setSplitter" ID="EricSideBar.setSplitter"></a>
+<h4>EricSideBar.setSplitter</h4>
+<b>setSplitter</b>(<i>splitter</i>)
+
+<p>
+        Public method to set the splitter managing the sidebar.
+</p>
+<dl>
+
+<dt><i>splitter</i></dt>
+<dd>
+reference to the splitter (QSplitter)
+</dd>
+</dl>
+<a NAME="EricSideBar.setTabEnabled" ID="EricSideBar.setTabEnabled"></a>
+<h4>EricSideBar.setTabEnabled</h4>
+<b>setTabEnabled</b>(<i>index, enabled</i>)
+
+<p>
+        Public method to set the enabled state of a tab.
+</p>
+<dl>
+
+<dt><i>index</i></dt>
+<dd>
+index of the tab to set (integer)
+</dd>
+<dt><i>enabled</i></dt>
+<dd>
+enabled state to set (boolean)
+</dd>
+</dl>
+<a NAME="EricSideBar.setTabIcon" ID="EricSideBar.setTabIcon"></a>
+<h4>EricSideBar.setTabIcon</h4>
+<b>setTabIcon</b>(<i>index, icon</i>)
+
+<p>
+        Public method to set the icon of a tab.
+</p>
+<dl>
+
+<dt><i>index</i></dt>
+<dd>
+index of the tab (integer)
+</dd>
+<dt><i>icon</i></dt>
+<dd>
+icon to be set (QIcon)
+</dd>
+</dl>
+<a NAME="EricSideBar.setTabText" ID="EricSideBar.setTabText"></a>
+<h4>EricSideBar.setTabText</h4>
+<b>setTabText</b>(<i>index, text</i>)
+
+<p>
+        Public method to set the text of a tab.
+</p>
+<dl>
+
+<dt><i>index</i></dt>
+<dd>
+index of the tab (integer)
+</dd>
+<dt><i>text</i></dt>
+<dd>
+text to set (string)
+</dd>
+</dl>
+<a NAME="EricSideBar.setTabToolTip" ID="EricSideBar.setTabToolTip"></a>
+<h4>EricSideBar.setTabToolTip</h4>
+<b>setTabToolTip</b>(<i>index, tip</i>)
+
+<p>
+        Public method to set the tooltip text of a tab.
+</p>
+<dl>
+
+<dt><i>index</i></dt>
+<dd>
+index of the tab (integer)
+</dd>
+<dt><i>tip</i></dt>
+<dd>
+tooltip text to set (string)
+</dd>
+</dl>
+<a NAME="EricSideBar.setTabWhatsThis" ID="EricSideBar.setTabWhatsThis"></a>
+<h4>EricSideBar.setTabWhatsThis</h4>
+<b>setTabWhatsThis</b>(<i>index, text</i>)
+
+<p>
+        Public method to set the WhatsThis text of a tab.
+</p>
+<dl>
+
+<dt><i>index</i></dt>
+<dd>
+index of the tab (integer)
+</dd>
+<dt><i>text</i></dt>
+<dd>
+WhatsThis text to set (string)
+</dd>
+</dl>
+<a NAME="EricSideBar.shrink" ID="EricSideBar.shrink"></a>
+<h4>EricSideBar.shrink</h4>
+<b>shrink</b>(<i></i>)
+
+<p>
+        Public method to record a shrink request.
+</p>
+<a NAME="EricSideBar.shutdown" ID="EricSideBar.shutdown"></a>
+<h4>EricSideBar.shutdown</h4>
+<b>shutdown</b>(<i></i>)
+
+<p>
+        Public method to shut down the object.
+</p>
+<p>
+        This method does some preparations so the object can be deleted
+        properly. It disconnects from the focusChanged signal in order to
+        avoid trouble later on.
+</p>
+<a NAME="EricSideBar.tabIcon" ID="EricSideBar.tabIcon"></a>
+<h4>EricSideBar.tabIcon</h4>
+<b>tabIcon</b>(<i>index</i>)
+
+<p>
+        Public method to get the icon of a tab.
+</p>
+<dl>
+
+<dt><i>index</i></dt>
+<dd>
+index of the tab (integer)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+icon of the tab (QIcon)
+</dd>
+</dl>
+<a NAME="EricSideBar.tabText" ID="EricSideBar.tabText"></a>
+<h4>EricSideBar.tabText</h4>
+<b>tabText</b>(<i>index</i>)
+
+<p>
+        Public method to get the text of a tab.
+</p>
+<dl>
+
+<dt><i>index</i></dt>
+<dd>
+index of the tab (integer)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+text of the tab (string)
+</dd>
+</dl>
+<a NAME="EricSideBar.tabToolTip" ID="EricSideBar.tabToolTip"></a>
+<h4>EricSideBar.tabToolTip</h4>
+<b>tabToolTip</b>(<i>index</i>)
+
+<p>
+        Public method to get the tooltip text of a tab.
+</p>
+<dl>
+
+<dt><i>index</i></dt>
+<dd>
+index of the tab (integer)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tooltip text of the tab (string)
+</dd>
+</dl>
+<a NAME="EricSideBar.tabWhatsThis" ID="EricSideBar.tabWhatsThis"></a>
+<h4>EricSideBar.tabWhatsThis</h4>
+<b>tabWhatsThis</b>(<i>index</i>)
+
+<p>
+        Public method to get the WhatsThis text of a tab.
+</p>
+<dl>
+
+<dt><i>index</i></dt>
+<dd>
+index of the tab (integer)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+WhatsThis text of the tab (string)
+</dd>
+</dl>
+<a NAME="EricSideBar.widget" ID="EricSideBar.widget"></a>
+<h4>EricSideBar.widget</h4>
+<b>widget</b>(<i>index</i>)
+
+<p>
+        Public method to get a reference to the widget associated with a tab.
+</p>
+<dl>
+
+<dt><i>index</i></dt>
+<dd>
+index of the tab (integer)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the widget (QWidget)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="EricSideBarSide" ID="EricSideBarSide"></a>
+<h2>EricSideBarSide</h2>
+
+<p>
+    Class defining the sidebar sides.
+</p>
+<h3>Derived from</h3>
+enum.Enum
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>EAST</td></tr><tr><td>NORTH</td></tr><tr><td>SOUTH</td></tr><tr><td>WEST</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

Mercurial Repository: eric

eric ide

mercurial