src/eric7/EricWidgets/EricSideBar.py

branch
eric7
changeset 10423
299802979277
parent 9876
800c539f8700
child 10439
21c28b0f9e41
--- a/src/eric7/EricWidgets/EricSideBar.py	Tue Dec 19 11:04:03 2023 +0100
+++ b/src/eric7/EricWidgets/EricSideBar.py	Tue Dec 19 19:57:08 2023 +0100
@@ -132,7 +132,8 @@
         """
         Public method to check the minimized state.
 
-        @return flag indicating the minimized state (boolean)
+        @return flag indicating the minimized state
+        @rtype bool
         """
         return self.__minimized
 
@@ -233,7 +234,8 @@
         """
         Public method to get the number of tabs.
 
-        @return number of tabs in the sidebar (integer)
+        @return number of tabs in the sidebar
+        @rtype int
         """
         return self.__iconBar.count()
 
@@ -241,7 +243,8 @@
         """
         Public method to get the index of the current tab.
 
-        @return index of the current tab (integer)
+        @return index of the current tab
+        @rtype int
         """
         return self.__stackedWidget.currentIndex()
 
@@ -249,7 +252,8 @@
         """
         Public slot to set the current index.
 
-        @param index the index to set as the current index (integer)
+        @param index the index to set as the current index
+        @type int
         """
         self.__iconBar.setCurrentIndex(index)
         self.__stackedWidget.setCurrentIndex(index)
@@ -260,7 +264,8 @@
         """
         Public method to get a reference to the current widget.
 
-        @return reference to the current widget (QWidget)
+        @return reference to the current widget
+        @rtype QWidget
         """
         return self.__stackedWidget.currentWidget()
 
@@ -269,7 +274,7 @@
         Public slot to set the current widget.
 
         @param widget reference to the widget to become the current widget
-            (QWidget)
+        @type QWidget
         """
         try:
             index = self.__stackedWidget.indexOf(widget)
@@ -284,8 +289,10 @@
         """
         Public method to get the index of the given widget.
 
-        @param widget reference to the widget to get the index of (QWidget)
-        @return index of the given widget (integer)
+        @param widget reference to the widget to get the index of
+        @type QWidget
+        @return index of the given widget
+        @rtype int
         """
         return self.__stackedWidget.indexOf(widget)
 
@@ -323,8 +330,10 @@
         """
         Public method to get a reference to the widget associated with a tab.
 
-        @param index index of the tab (integer)
-        @return reference to the widget (QWidget)
+        @param index index of the tab
+        @type int
+        @return reference to the widget
+        @rtype QWidget
         """
         return self.__stackedWidget.widget(index)
 
@@ -374,7 +383,8 @@
         """
         Public method to save the state of the sidebar.
 
-        @return saved state as a byte array (QByteArray)
+        @return saved state as a byte array
+        @rtype QByteArray
         """
         if not self.__bigSize.isValid():
             self.__bigSize = self.size()
@@ -398,8 +408,10 @@
         """
         Public method to restore the state of the sidebar.
 
-        @param state byte array containing the saved state (QByteArray)
-        @return flag indicating success (boolean)
+        @param state byte array containing the saved state
+        @type QByteArray
+        @return flag indicating success
+        @rtype bool
         """
         if not isinstance(state, str) or state == "":
             return False

eric ide

mercurial