eric: comparison eric6/Graphics/UMLGraphicsView.py

-:809d5d5ac2ba
+:871b40c5a77a
 def __init__(self, scene, parent=None):
 """
 Constructor
-@param scene reference to the scene object (QGraphicsScene)
+@param scene reference to the scene object
-@param parent parent widget of the view (QWidget)
+@type QGraphicsScene
+@param parent parent widget of the view
+@type QWidget
 """
 E5GraphicsView.__init__(self, scene, parent)
 self.setObjectName("UMLGraphicsView")
 self.setViewportUpdateMode(
 QGraphicsView.ViewportUpdateMode.FullViewportUpdate)
 def __sceneChanged(self, areas):
 """
 Private slot called when the scene changes.
-@param areas list of rectangles that contain changes (list of QRectF)
+@param areas list of rectangles that contain changes
+@type list of QRectF
 """
 if len(self.scene().selectedItems()) > 0:
 self.deleteShapeAct.setEnabled(True)
 else:
 self.deleteShapeAct.setEnabled(False)
 def initToolBar(self):
 """
 Public method to populate a toolbar with our actions.
-@return the populated toolBar (QToolBar)
+@return the populated toolBar
+@rtype QToolBar
 """
 toolBar = QToolBar(self.tr("Graphics"), self)
 toolBar.setIconSize(UI.Config.ToolBarIconSize)
 toolBar.addAction(self.deleteShapeAct)
 toolBar.addSeparator()
 def filteredItems(self, items, itemType=UMLItem):
 """
 Public method to filter a list of items.
 @param items list of items as returned by the scene object
-(QGraphicsItem)
+@type QGraphicsItem
-@param itemType type to be filtered (class)
+@param itemType type to be filtered
-@return list of interesting collision items (QGraphicsItem)
+@type class
+@return list of interesting collision items
+@rtype QGraphicsItem
 """
 return [itm for itm in items if isinstance(itm, itemType)]
 def selectItems(self, items):
 """
 Public method to select the given items.
-@param items list of items to be selected (list of QGraphicsItemItem)
+@param items list of items to be selected
+@type list of QGraphicsItemItem
 """
 # step 1: deselect all items
 self.unselectItems()
 # step 2: select all given items
 def selectItem(self, item):
 """
 Public method to select an item.
-@param item item to be selected (QGraphicsItemItem)
+@param item item to be selected
+@type QGraphicsItemItem
 """
 if isinstance(item, UMLItem):
 item.setSelected(not item.isSelected())
 def __deleteShape(self):
 def autoAdjustSceneSize(self, limit=False):
 """
 Public method to adjust the scene size to the diagram size.
 @param limit flag indicating to limit the scene to the
-initial size (boolean)
+initial size
+@type bool
 """
 super().autoAdjustSceneSize(limit=limit)
 self.__checkSizeActions()
 def saveImage(self):
 def __printPreviewPrint(self, printer):
 """
 Private slot to generate a print preview.
-@param printer reference to the printer object (QPrinter)
+@param printer reference to the printer object
+@type QPrinter
 """
 super().printDiagram(printer, self.diagramName)
 def setDiagramName(self, name):
 """
 Public slot to set the diagram name.
-@param name diagram name (string)
+@param name diagram name
+@type str
 """
 self.diagramName = name
 def __alignShapes(self, alignment):
 """
 Private slot to align the selected shapes.
-@param alignment alignment type (Qt.AlignmentFlag)
+@param alignment alignment type
+@type Qt.AlignmentFlag
 """
 # step 1: get all selected items
 items = self.scene().selectedItems()
 if len(items) <= 1:
 return
 def __itemsBoundingRect(self, items):
 """
 Private method to calculate the bounding rectangle of the given items.
-@param items list of items to operate on (list of UMLItem)
+@param items list of items to operate on
-@return bounding rectangle (QRectF)
+@type list of UMLItem
+@return bounding rectangle
+@rtype QRectF
 """
 rect = self.scene().sceneRect()
 right = rect.left()
 bottom = rect.top()
 left = rect.right()
 def keyPressEvent(self, evt):
 """
 Protected method handling key press events.
-@param evt reference to the key event (QKeyEvent)
+@param evt reference to the key event
+@type QKeyEvent
 """
 key = evt.key()
 if key in [Qt.Key.Key_Up, Qt.Key.Key_Down, Qt.Key.Key_Left,
 Qt.Key.Key_Right]:
 items = self.filteredItems(self.scene().selectedItems())
 def wheelEvent(self, evt):
 """
 Protected method to handle wheel events.
-@param evt reference to the wheel event (QWheelEvent)
+@param evt reference to the wheel event
+@type QWheelEvent
 """
 if evt.modifiers() & Qt.KeyboardModifier.ControlModifier:
 delta = evt.angleDelta().y()
 if delta < 0:
 self.zoomOut()
 def event(self, evt):
 """
 Public method handling events.
-@param evt reference to the event (QEvent)
+@param evt reference to the event
-@return flag indicating, if the event was handled (boolean)
+@type QEvent
+@return flag indicating, if the event was handled
+@rtype bool
 """
 if evt.type() == QEvent.Type.Gesture:
 self.gestureEvent(evt)
 return True
 def gestureEvent(self, evt):
 """
 Protected method handling gesture events.
-@param evt reference to the gesture event (QGestureEvent
+@param evt reference to the gesture event
+@type QGestureEvent
 """
 pinch = evt.gesture(Qt.GestureType.PinchGesture)
 if pinch:
 if pinch.state() == Qt.GestureState.GestureStarted:
 pinch.setTotalScaleFactor(self.zoom() / 100.0)
 def getItemId(self):
 """
 Public method to get the ID to be assigned to an item.
-@return item ID (integer)
+@return item ID
+@rtype int
 """
 self.__itemId += 1
 return self.__itemId
 def findItem(self, itemId):
 """
 Public method to find an UML item based on the ID.
-@param itemId of the item to search for (integer)
+@param itemId of the item to search for
-@return item found (UMLItem) or None
+@type int
+@return item found or None
+@rtype UMLItem
 """
 for item in self.scene().items():
 try:
 if item.getId() == itemId:
 return item
 def findItemByName(self, name):
 """
 Public method to find an UML item based on its name.
-@param name name to look for (string)
+@param name name to look for
-@return item found (UMLItem) or None
+@type str
+@return item found or None
+@rtype UMLItem
 """
 for item in self.scene().items():
 try:
 if item.getName() == name:
 return item
 def getPersistenceData(self):
 """
 Public method to get a list of data to be persisted.
-@return list of data to be persisted (list of strings)
+@return list of data to be persisted
+@rtype list of str
 """
 lines = [
 "diagram_name: {0}".format(self.diagramName),
 ]
 def parsePersistenceData(self, version, data):
 """
 Public method to parse persisted data.
-@param version version of the data (string)
+@param version version of the data
-@param data persisted data to be parsed (list of string)
+@type str
+@param data persisted data to be parsed
+@type list of str
 @return tuple of flag indicating success (boolean) and faulty line
-number (integer)
+number
+@rtype int
 """
 umlItems = {}
 if not data[0].startswith("diagram_name:"):
 return False, 0

Mercurial Repositories > eric / file comparison

comparison: eric6/Graphics/UMLGraphicsView.py

eric6/Graphics/UMLGraphicsView.py