--- a/src/eric7/Documentation/Source/eric7.EricWidgets.EricSideBar.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricSideBar.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<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>
@@ -29,36 +27,35 @@
<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>
@@ -168,19 +165,20 @@
<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, iconBarSize=EricIconBar.DefaultBarSize, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>orientation</i> (EricSideBarSide)</dt>
@@ -200,10 +198,10 @@
<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 current icon.
</p>
+
<dl>
<dt><i>index</i> (int)</dt>
@@ -214,31 +212,31 @@
<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.__shrinkOrExpandIt" ID="EricSideBar.__shrinkOrExpandIt"></a>
<h4>EricSideBar.__shrinkOrExpandIt</h4>
<b>__shrinkOrExpandIt</b>(<i></i>)
-
<p>
Private slot to shrink or expand the widget stack.
</p>
+
<a NAME="EricSideBar.addTab" ID="EricSideBar.addTab"></a>
<h4>EricSideBar.addTab</h4>
<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> (QWidget)</dt>
@@ -257,10 +255,10 @@
<a NAME="EricSideBar.barSize" ID="EricSideBar.barSize"></a>
<h4>EricSideBar.barSize</h4>
<b>barSize</b>(<i></i>)
-
<p>
Public method to get the icon bar size.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -277,17 +275,17 @@
<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>
@@ -303,10 +301,10 @@
<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>
@@ -322,10 +320,10 @@
<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>
@@ -341,10 +339,10 @@
<a NAME="EricSideBar.iconBarColor" ID="EricSideBar.iconBarColor"></a>
<h4>EricSideBar.iconBarColor</h4>
<b>iconBarColor</b>(<i></i>)
-
<p>
Public method to get the icon bar color.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -360,10 +358,10 @@
<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> (QWidget)</dt>
@@ -386,10 +384,10 @@
<a NAME="EricSideBar.insertTab" ID="EricSideBar.insertTab"></a>
<h4>EricSideBar.insertTab</h4>
<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> (int)</dt>
@@ -412,10 +410,10 @@
<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>
@@ -431,17 +429,17 @@
<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>
@@ -457,17 +455,17 @@
<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> (int)</dt>
@@ -478,10 +476,10 @@
<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> (QByteArray)</dt>
@@ -504,10 +502,10 @@
<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>
@@ -523,10 +521,10 @@
<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> (int)</dt>
@@ -537,10 +535,10 @@
<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> (QWidget)</dt>
@@ -551,10 +549,10 @@
<a NAME="EricSideBar.setIconBarColor" ID="EricSideBar.setIconBarColor"></a>
<h4>EricSideBar.setIconBarColor</h4>
<b>setIconBarColor</b>(<i>color</i>)
-
<p>
Public method to set the icon bar color.
</p>
+
<dl>
<dt><i>color</i> (QColor)</dt>
@@ -565,10 +563,10 @@
<a NAME="EricSideBar.setIconBarSize" ID="EricSideBar.setIconBarSize"></a>
<h4>EricSideBar.setIconBarSize</h4>
<b>setIconBarSize</b>(<i>barSize</i>)
-
<p>
Public method to set the icon bar size.
</p>
+
<dl>
<dt><i>barSize</i> (str)</dt>
@@ -580,10 +578,10 @@
<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>
@@ -594,10 +592,10 @@
<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> (int)</dt>
@@ -622,33 +620,36 @@
<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>
+<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>
-
+<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
+</body></html>
