eric: comparison src/eric7/EricWidgets/EricMapWidget.py

-:e28b89693f37
+:299802979277
 def __init__(self, parent=None):
 """
 Constructor
-@param parent reference to the parent widget (QWidget)
+@param parent reference to the parent widget
+@type QWidget
 """
 super().__init__(parent)
 self.setAttribute(Qt.WidgetAttribute.WA_OpaquePaintEvent)
 self.__width = 14
 def setWidth(self, width):
 """
 Public method to set the widget width.
-@param width widget width (integer)
+@param width widget width
+@type int
 """
 if width != self.__width:
 self.__width = max(6, width)  # minimum width 6 pixels
 self.__updateControllerViewportWidth()
 self.update()
 def width(self):
 """
 Public method to get the widget's width.
-@return widget width (integer)
+@return widget width
+@rtype int
 """
 return self.__width
 def setMapPosition(self, onRight):
 """
 def setLineDimensions(self, border, height):
 """
 Public method to set the line (indicator) dimensions.
-@param border border width on each side in x-direction (integer)
+@param border border width on each side in x-direction
-@param height height of the line in pixels (integer)
+@type int
+@param height height of the line in pixels
+@type int
 """
 if border != self.__lineBorder or height != self.__lineHeight:
 self.__lineBorder = max(1, border)  # min border 1 pixel
 self.__lineHeight = max(1, height)  # min height 1 pixel
 self.update()
 def lineDimensions(self):
 """
 Public method to get the line (indicator) dimensions.
-@return tuple with border width (integer) and line height (integer)
+@return tuple with border width (integer) and line height
+@rtype int
 """
 return self.__lineBorder, self.__lineHeight
 def setEnabled(self, enable):
 """
 Public method to set the enabled state.
-@param enable flag indicating the enabled state (boolean)
+@param enable flag indicating the enabled state
+@type bool
 """
 if enable != self.__enabled:
 self.__enabled = enable
 self.setVisible(enable)
 self.__updateControllerViewportWidth()
 def isEnabled(self):
 """
 Public method to check the enabled state.
-@return flag indicating the enabled state (boolean)
+@return flag indicating the enabled state
+@rtype bool
 """
 return self.__enabled
 def setBackgroundColor(self, color):
 """
 Public method to set the widget background color.
-@param color color for the background (QColor)
+@param color color for the background
+@type QColor
 """
 if color != self.__backgroundColor:
 self.__backgroundColor = color
 self.__setSliderColor()
 self.update()
 def backgroundColor(self):
 """
 Public method to get the background color.
-@return background color (QColor)
+@return background color
+@rtype QColor
 """
 return QColor(self.__backgroundColor)
 def sizeHint(self):
 """
 Public method to give an indication about the preferred size.
-@return preferred size (QSize)
+@return preferred size
+@rtype QSize
 """
 return QSize(self.__width, 0)
 def paintEvent(self, event):
 """
 Protected method to handle a paint event.
-@param event paint event (QPaintEvent)
+@param event paint event
+@type QPaintEvent
 """
 # step 1: fill the whole painting area
 painter = QPainter(self)
 painter.fillRect(event.rect(), self.__backgroundColor)
 """
 Protected method for painting the widget's indicators.
 Note: This method should be implemented by subclasses.
-@param painter reference to the painter object (QPainter)
+@param painter reference to the painter object
+@type QPainter
 """
 pass
 def mousePressEvent(self, event):
 """
 Protected method to handle a mouse button press.
-@param event reference to the mouse event (QMouseEvent)
+@param event reference to the mouse event
+@type QMouseEvent
 """
 if event.button() == Qt.MouseButton.LeftButton and self._controller:
 vsb = self._controller.verticalScrollBar()
 value = self.position2Value(event.position().toPoint().y() - 1)
 vsb.setValue(int(value - 0.5 * vsb.pageStep()))  # center on page
 def mouseMoveEvent(self, event):
 """
 Protected method to handle a mouse moves.
-@param event reference to the mouse event (QMouseEvent)
+@param event reference to the mouse event
+@type QMouseEvent
 """
 if event.buttons() & Qt.MouseButton.LeftButton and self._controller:
 vsb = self._controller.verticalScrollBar()
 value = self.position2Value(event.position().toPoint().y() - 1)
 vsb.setValue(int(value - 0.5 * vsb.pageStep()))  # center on page
 def wheelEvent(self, event):
 """
 Protected slot handling mouse wheel events.
-@param event reference to the wheel event (QWheelEvent)
+@param event reference to the wheel event
+@type QWheelEvent
 """
 isVertical = event.angleDelta().x() == 0
 if (
 self._controller
 and event.modifiers() == Qt.KeyboardModifier.NoModifier
 def scaleFactor(self, slider=False):
 """
 Public method to determine the scrollbar's scale factor.
 @param slider flag indicating to calculate the result for the slider
-(boolean)
+@type bool
-@return scale factor (float)
+@return scale factor
+@rtype float
 """
 if self._controller:
 delta = 0 if slider else 2
 vsb = self._controller.verticalScrollBar()
 posHeight = vsb.height() - delta - 1
 def value2Position(self, value, slider=False):
 """
 Public method to convert a scrollbar value into a position.
-@param value value to convert (integer)
+@param value value to convert
+@type int
 @param slider flag indicating to calculate the result for the slider
-(boolean)
+@type bool
-@return position (integer)
+@return position
+@rtype int
 """
 if self._controller:
 offset = 0 if slider else 1
 vsb = self._controller.verticalScrollBar()
 return int((value - vsb.minimum()) * self.scaleFactor(slider) + offset)
 def position2Value(self, position, slider=False):
 """
 Public method to convert a position into a scrollbar value.
-@param position scrollbar position to convert (integer)
+@param position scrollbar position to convert
+@type int
 @param slider flag indicating to calculate the result for the slider
-(boolean)
-@return scrollbar value (integer)
+@type bool
+@return scrollbar value
+@rtype int
 """
 if self._controller:
 offset = 0 if slider else 1
 vsb = self._controller.verticalScrollBar()
 return vsb.minimum() + max(
 def generateIndicatorRect(self, position):
 """
 Public method to generate an indicator rectangle.
-@param position indicator position (integer)
+@param position indicator position
-@return indicator rectangle (QRect)
+@type int
+@return indicator rectangle
+@rtype QRect
 """
 return QRect(
 self.__lineBorder,
 position - self.__lineHeight // 2,
 self.__width - self.__lineBorder,
 def __generateSliderRange(self, scrollbar):
 """
 Private method to generate the slider rectangle.
-@param scrollbar reference to the vertical scrollbar (QScrollBar)
+@param scrollbar reference to the vertical scrollbar
-@return slider rectangle (QRect)
+@type QScrollBar
+@return slider rectangle
+@rtype QRect
 """
 pos1 = self.value2Position(scrollbar.value(), slider=True)
 pos2 = self.value2Position(
 scrollbar.value() + scrollbar.pageStep(), slider=True
 )

Mercurial Repositories > eric / file comparison

comparison: src/eric7/EricWidgets/EricMapWidget.py

src/eric7/EricWidgets/EricMapWidget.py