Class: QgsModelCommentGraphicItem

class qgis.gui.QgsModelCommentGraphicItem

Bases: QgsModelComponentGraphicItem

A graphic item representing a model comment in the model designer.

Warning

Not stable API

New in version 3.14.

QgsModelCommentGraphicItem(comment: QgsProcessingModelComment, parentItem: QgsModelComponentGraphicItem, model: QgsProcessingModelAlgorithm, parent: QGraphicsItem) Constructor for QgsModelCommentGraphicItem for the specified comment, with the specified parent item.

The model argument specifies the associated processing model. Ownership of model is not transferred, and it must exist for the lifetime of this object.

Ownership of output is transferred to the item.

Methods

canDeleteComponent

rtype

bool

childEvent

connectNotify

contextMenuEvent

param event

customEvent

deleteComponent

disconnectNotify

dragEnterEvent

dragLeaveEvent

dragMoveEvent

dropEvent

editComponent

event

fillColor

param state

focusInEvent

focusOutEvent

iconPicture

Returns a QPicture version of the item’s icon, if available.

iconPixmap

Returns a QPixmap version of the item’s icon, if available.

inputMethodEvent

inputMethodQuery

isSignalConnected

keyPressEvent

keyReleaseEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

parentComponentItem

Returns the parent model component item.

prepareGeometryChange

receivers

sceneEvent

sceneEventFilter

sender

senderSignalIndex

strokeColor

param state

strokeStyle

param state

textColor

param state

timerEvent

titleAlignment

Returns the title alignment

truncatedTextForItem

Truncates a text string so that it fits nicely within the item’s width, accounting for margins and interactive buttons.

updateButtonPositions

Updates the item’s button positions, based on the current item rect.

updateMicroFocus

updateStoredComponentPosition

param pos

wheelEvent

canDeleteComponent(self)bool
Return type

bool

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, event: QGraphicsSceneContextMenuEvent)
Parameters

event (QGraphicsSceneContextMenuEvent) –

customEvent(self, QEvent)
deleteComponent(self)
disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, QGraphicsSceneDragDropEvent)
dragLeaveEvent(self, QGraphicsSceneDragDropEvent)
dragMoveEvent(self, QGraphicsSceneDragDropEvent)
dropEvent(self, QGraphicsSceneDragDropEvent)
editComponent(self)
event(self, QEvent)bool
fillColor(self, state: QgsModelComponentGraphicItem.State)QColor
Parameters

state (QgsModelComponentGraphicItem.State) –

Return type

QColor

focusInEvent(self, QFocusEvent)
focusOutEvent(self, QFocusEvent)
iconPicture(self)QPicture

Returns a QPicture version of the item’s icon, if available.

iconPixmap(self)QPixmap

Returns a QPixmap version of the item’s icon, if available.

inputMethodEvent(self, QInputMethodEvent)
inputMethodQuery(self, Qt.InputMethodQuery)Any
isSignalConnected(self, QMetaMethod)bool
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
mouseMoveEvent(self, QGraphicsSceneMouseEvent)
mousePressEvent(self, QGraphicsSceneMouseEvent)
mouseReleaseEvent(self, QGraphicsSceneMouseEvent)
parentComponentItem(self)QgsModelComponentGraphicItem

Returns the parent model component item.

Return type

QgsModelComponentGraphicItem

prepareGeometryChange(self)
receivers(self, PYQT_SIGNAL)int
sceneEvent(self, QEvent)bool
sceneEventFilter(self, QGraphicsItem, QEvent)bool
sender(self)QObject
senderSignalIndex(self)int
strokeColor(self, state: QgsModelComponentGraphicItem.State)QColor
Parameters

state (QgsModelComponentGraphicItem.State) –

Return type

QColor

strokeStyle(self, state: QgsModelComponentGraphicItem.State)Qt.PenStyle
Parameters

state (QgsModelComponentGraphicItem.State) –

Return type

Qt.PenStyle

textColor(self, state: QgsModelComponentGraphicItem.State)QColor
Parameters

state (QgsModelComponentGraphicItem.State) –

Return type

QColor

timerEvent(self, QTimerEvent)
titleAlignment(self)Qt.Alignment

Returns the title alignment

truncatedTextForItem(self, text: str)str

Truncates a text string so that it fits nicely within the item’s width, accounting for margins and interactive buttons.

updateButtonPositions(self)

Updates the item’s button positions, based on the current item rect.

updateMicroFocus(self)
updateStoredComponentPosition(self, pos: Union[QPointF, QPoint], size: QSizeF)
Parameters
  • pos (Union[QPointF) –

  • size (QSizeF) –

wheelEvent(self, QGraphicsSceneWheelEvent)