Class: QgsModelParameterGraphicItem¶
- class qgis.gui.QgsModelParameterGraphicItem¶
Bases:
QgsModelComponentGraphicItem
A graphic item representing a model parameter (input) in the model designer.
Warning
Not stable API
New in version 3.14.
QgsModelParameterGraphicItem(parameter:
QgsProcessingModelParameter
, model:QgsProcessingModelAlgorithm
, parent: QGraphicsItem) Constructor forQgsModelParameterGraphicItem
for the specifiedparameter
, with the specifiedparent
item.The
model
argument specifies the associated processing model. Ownership ofmodel
is not transferred, and it must exist for the lifetime of this object.Ownership of
parameter
is transferred to the item.Methods
- rtype:
bool
- param event:
Called when the component should be edited.
- param state:
- rtype:
QPicture
Returns a QPixmap version of the item's icon, if available.
- param state:
Returns the stroke style to use while rendering the outline of the item.
- param state:
Returns the title alignment
Truncates a
text
string so that it fits nicely within the item's width, accounting for margins and interactive buttons.Updates the item's button positions, based on the current item rect.
- param pos:
- 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)¶
Called when the component should be edited.
The default implementation does nothing.
- 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 ¶
- Return type:
QPicture
- 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)¶
- 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 ¶
Returns the stroke style to use while rendering the outline of the item.
- 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: QPointF | QPoint, size: QSizeF)¶
- Parameters:
pos (Union[QPointF) –
size (QSizeF) –
- wheelEvent(self, QGraphicsSceneWheelEvent)¶