--- a/eric7/Documentation/Source/eric7.EricWidgets.EricSideBar.html Sun Sep 05 18:07:03 2021 +0200 +++ b/eric7/Documentation/Source/eric7.EricWidgets.EricSideBar.html Mon Sep 06 19:52:37 2021 +0200 @@ -78,20 +78,12 @@ <td>Constructor</td> </tr> <tr> -<td><a href="#EricSideBar.__appFocusChanged">__appFocusChanged</a></td> -<td>Private slot to handle a change of the focus.</td> +<td><a href="#EricSideBar.__currentIconChanged">__currentIconChanged</a></td> +<td>Private slot to handle a change of the current icon.</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> +<td><a href="#EricSideBar.__currentIconClicked">__currentIconClicked</a></td> +<td>Private slot to handle a click of the current icon.</td> </tr> <tr> <td><a href="#EricSideBar.__expandIt">__expandIt</a></td> @@ -126,20 +118,8 @@ <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> +<td><a href="#EricSideBar.iconBarColor">iconBarColor</a></td> +<td>Public method to get the icon bar color.</td> </tr> <tr> <td><a href="#EricSideBar.indexOf">indexOf</a></td> @@ -150,22 +130,10 @@ <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> @@ -198,8 +166,8 @@ <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> +<td><a href="#EricSideBar.setIconBarColor">setIconBarColor</a></td> +<td>Public method to set the icon bar color.</td> </tr> <tr> <td><a href="#EricSideBar.setOrientation">setOrientation</a></td> @@ -210,50 +178,6 @@ <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> @@ -266,7 +190,7 @@ <a NAME="EricSideBar.__init__" ID="EricSideBar.__init__"></a> <h4>EricSideBar (Constructor)</h4> -<b>EricSideBar</b>(<i>orientation=None, delay=200, parent=None</i>) +<b>EricSideBar</b>(<i>orientation=None, parent=None</i>) <p> Constructor @@ -277,62 +201,39 @@ <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>) +<a NAME="EricSideBar.__currentIconChanged" ID="EricSideBar.__currentIconChanged"></a> +<h4>EricSideBar.__currentIconChanged</h4> +<b>__currentIconChanged</b>(<i>index</i>) <p> - Private slot to handle a change of the focus. + Private slot to handle a change of the current icon. </p> <dl> -<dt><i>old</i></dt> +<dt><i>index</i> (int)</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) +index of the current icon </dd> </dl> -<a NAME="EricSideBar.__autoHideToggled" ID="EricSideBar.__autoHideToggled"></a> -<h4>EricSideBar.__autoHideToggled</h4> -<b>__autoHideToggled</b>(<i>checked</i>) +<a NAME="EricSideBar.__currentIconClicked" ID="EricSideBar.__currentIconClicked"></a> +<h4>EricSideBar.__currentIconClicked</h4> +<b>__currentIconClicked</b>(<i>index</i>) <p> - Private slot to handle the toggling of the autohide button. + Private slot to handle a click of the current icon. </p> <dl> -<dt><i>checked</i></dt> +<dt><i>index</i> (int)</dt> <dd> -flag indicating the checked state of the button - (boolean) +index of the clicked icon </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>) @@ -367,26 +268,24 @@ </dl> <a NAME="EricSideBar.addTab" ID="EricSideBar.addTab"></a> <h4>EricSideBar.addTab</h4> -<b>addTab</b>(<i>widget, iconOrLabel, label=None</i>) +<b>addTab</b>(<i>widget, icon, label=None</i>) <p> Public method to add a tab to the sidebar. </p> <dl> -<dt><i>widget</i></dt> +<dt><i>widget</i> (QWidget)</dt> <dd> -reference to the widget to add (QWidget) +reference to the widget to add </dd> -<dt><i>iconOrLabel</i></dt> +<dt><i>icon</i> (QIcon or QPixmap)</dt> <dd> -reference to the icon or the label text of the tab - (QIcon, string) +reference to the icon of the widget </dd> -<dt><i>label</i></dt> +<dt><i>label</i> (str)</dt> <dd> -the labeltext of the tab (string) (only to be - used, if the second parameter is a QIcon) +the label text of the widget </dd> </dl> <a NAME="EricSideBar.clear" ID="EricSideBar.clear"></a> @@ -435,65 +334,25 @@ 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>) +<a NAME="EricSideBar.iconBarColor" ID="EricSideBar.iconBarColor"></a> +<h4>EricSideBar.iconBarColor</h4> +<b>iconBarColor</b>(<i></i>) <p> - Public method to get the delay value for the expand/shrink delay in - milliseconds. + Public method to get the icon bar color. </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) +icon bar color </dd> </dl> <dl> -<dt>Return:</dt> +<dt>Return Type:</dt> <dd> -flag indicating, if the event was handled (boolean) +QColor </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>) @@ -516,43 +375,28 @@ </dl> <a NAME="EricSideBar.insertTab" ID="EricSideBar.insertTab"></a> <h4>EricSideBar.insertTab</h4> -<b>insertTab</b>(<i>index, widget, iconOrLabel, label=None</i>) +<b>insertTab</b>(<i>index, widget, icon, 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> +<dt><i>index</i> (int)</dt> <dd> -reference to the widget to insert (QWidget) +the index to insert the tab at </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> +<dt><i>widget</i> (QWidget)</dt> <dd> -the labeltext of the tab (string) (only to be - used, if the second parameter is a QIcon) +reference to the widget to insert </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> +<dt><i>icon</i> (QIcon or QPixmap)</dt> <dd> -flag indicating the state of auto hiding (boolean) +reference to the icon of the widget +</dd> +<dt><i>label</i> (str)</dt> +<dd> +the label text of the widget </dd> </dl> <a NAME="EricSideBar.isMinimized" ID="EricSideBar.isMinimized"></a> @@ -568,40 +412,6 @@ 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>) @@ -644,9 +454,9 @@ </p> <dl> -<dt><i>index</i></dt> +<dt><i>index</i> (int)</dt> <dd> -the index of the tab to remove (integer) +the index of the tab to remove </dd> </dl> <a NAME="EricSideBar.restoreState" ID="EricSideBar.restoreState"></a> @@ -711,20 +521,18 @@ (QWidget) </dd> </dl> -<a NAME="EricSideBar.setDelay" ID="EricSideBar.setDelay"></a> -<h4>EricSideBar.setDelay</h4> -<b>setDelay</b>(<i>delay</i>) +<a NAME="EricSideBar.setIconBarColor" ID="EricSideBar.setIconBarColor"></a> +<h4>EricSideBar.setIconBarColor</h4> +<b>setIconBarColor</b>(<i>color</i>) <p> - Public method to set the delay value for the expand/shrink delay in - milliseconds. + Public method to set the icon bar color. </p> <dl> -<dt><i>delay</i></dt> +<dt><i>color</i> (QColor)</dt> <dd> -value for the expand/shrink delay in milliseconds - (integer) +icon bar color </dd> </dl> <a NAME="EricSideBar.setOrientation" ID="EricSideBar.setOrientation"></a> @@ -755,195 +563,6 @@ 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>)