--- a/src/eric7/EricWidgets/EricZoomWidget.py Tue Dec 19 11:04:03 2023 +0100
+++ b/src/eric7/EricWidgets/EricZoomWidget.py Tue Dec 19 19:57:08 2023 +0100
@@ -26,10 +26,14 @@
"""
Constructor
- @param outPix pixmap for the zoom out button (QPixmap)
- @param inPix pixmap for the zoom in button (QPixmap)
- @param resetPix pixmap for the zoom reset button (QPixmap)
- @param parent reference to the parent widget (QWidget)
+ @param outPix pixmap for the zoom out button
+ @type QPixmap
+ @param inPix pixmap for the zoom in button
+ @type QPixmap
+ @param resetPix pixmap for the zoom reset button
+ @type QPixmap
+ @param parent reference to the parent widget
+ @type QWidget
"""
super().__init__(parent)
self.setupUi(self)
@@ -58,7 +62,8 @@
"""
Private slot to handle changes of the zoom value.
- @param value value of the slider (integer)
+ @param value value of the slider
+ @type int
"""
if self.__mapped:
self.valueChanged.emit(self.__mapping[value])
@@ -69,7 +74,8 @@
"""
Public slot to set the value.
- @param value new zoom value (integer)
+ @param value new zoom value
+ @type int
"""
self.slider.setValue(self.__indexForValue(value))
@@ -77,7 +83,8 @@
"""
Public method to get the current value.
- @return current zoom value (integer)
+ @return current zoom value
+ @rtype int
"""
if self.__mapped:
return self.__mapping[self.slider.value()]
@@ -88,7 +95,8 @@
"""
Public method to set the minimum value.
- @param minimum new minimum value (integer)
+ @param minimum new minimum value
+ @type int
"""
if not self.__mapped:
self.slider.setMinimum(minimum)
@@ -98,7 +106,8 @@
"""
Public method to get the minimum value.
- @return minimum value (integer)
+ @return minimum value
+ @rtype int
"""
if self.__mapped:
return self.__mapping[0]
@@ -109,7 +118,8 @@
"""
Public method to set the maximum value.
- @param maximum new maximum value (integer)
+ @param maximum new maximum value
+ @type int
"""
if not self.__mapped:
self.slider.setMaximum(maximum)
@@ -119,7 +129,8 @@
"""
Public method to get the maximum value.
- @return maximum value (integer)
+ @return maximum value
+ @rtype int
"""
if self.__mapped:
return self.__mapping[-1]
@@ -130,7 +141,8 @@
"""
Public method to set the single step value.
- @param value value for the single step (integer)
+ @param value value for the single step
+ @type int
"""
self.slider.setSingleStep(value)
@@ -138,7 +150,8 @@
"""
Public method to get the single step value.
- @return single step value (integer)
+ @return single step value
+ @rtype int
"""
return self.slider.singleStep()
@@ -146,7 +159,8 @@
"""
Public method to set the page step value.
- @param value page step value (integer)
+ @param value page step value
+ @type int
"""
self.slider.setPageStep(value)
@@ -154,7 +168,8 @@
"""
Public method to get the page step value.
- @return page step value (integer)
+ @return page step value
+ @rtype int
"""
return self.slider.pageStep()
@@ -162,7 +177,8 @@
"""
Public method to set the default zoom value.
- @param value default zoom value (integer)
+ @param value default zoom value
+ @type int
"""
self.__default = self.__indexForValue(value)
@@ -170,7 +186,8 @@
"""
Public method to get the default zoom value.
- @return default zoom value (integer)
+ @return default zoom value
+ @rtype int
"""
if self.__mapped:
return self.__mapping[self.__default]
@@ -181,7 +198,8 @@
"""
Public method to set the percent mode of the widget.
- @param on flag indicating percent mode (boolean)
+ @param on flag indicating percent mode
+ @type bool
"""
self.__percent = on
self.__setValueLabelWidth()
@@ -190,7 +208,8 @@
"""
Public method to get the percent mode.
- @return flag indicating percent mode (boolean)
+ @return flag indicating percent mode
+ @rtype bool
"""
return self.__percent
@@ -203,10 +222,12 @@
default value is the value of the default zoom level. If
percent is given, the zoom level is shown as a percent value.
- @param mapping list of mapping values (list of integer)
- @param default index of the default value (integer)
+ @param mapping list of mapping values
+ @type list of int
+ @param default index of the default value
+ @type int
@param percent flag indicating to show zoom value in percent
- (boolean)
+ @type bool
"""
if mapping:
self.__mapping = mapping[:]
@@ -232,7 +253,7 @@
Public method to get the current mapping.
@return tuple of the mapping and the default index
- (list of integer, integer)
+ @rtype tuple of (list of integer, integer)
"""
return self.__mapping[:], self.__default
@@ -240,7 +261,8 @@
"""
Public method to check for a mapped zoom widget.
- @return flag indicating a mapped zoom widget (boolean)
+ @return flag indicating a mapped zoom widget
+ @rtype bool
"""
return self.__mapped
@@ -269,7 +291,8 @@
"""
Protected slot to handle changes of the slider value.
- @param value slider value (integer)
+ @param value slider value
+ @type int
"""
val = self.__mapping[value] if self.__mapped else value
fmtStr = "{0}%" if self.__percent else "{0}"
@@ -295,9 +318,11 @@
"""
Private method to get the nearest index for a given value.
- @param value value to get the index for (integer)
+ @param value value to get the index for
+ @type int
@return index into the mapping list or the unchanged value,
- if mapping is not set (integer)
+ if mapping is not set
+ @rtype int
"""
if self.__mapped:
try:
