Class: QgsModelGraphicsView

QGraphicsView subclass representing the model designer.

Warning

Not stable API

Added in version 3.14.

List of all members, including inherited members

Class Hierarchy

Base classes

QGraphicsView
QAbstractScrollArea
QFrame
QWidget
QObject
QPaintDevice

Enums

ClipboardOperation
PasteMode

Methods

abortCommand	Aborts pending undo command
beginCommand	Starts a single undo command
copyItems	Cuts or copies the a list of items, respecting the specified operation.
copySelectedItems	Cuts or copies the selected items, respecting the specified operation.
endCommand	Ends a single undo command
endMacroCommand	Ends a macro command, containing a group of interactions in the view.
modelScene	Returns the scene associated with the tool.
pasteItems	Pastes items from clipboard, using the specified mode.
setModelScene	Sets the related scene.
snapSelected	Snaps the selected items to the grid.
startMacroCommand	Starts a macro command, containing a group of interactions in the view.

Signals

algorithmDropped	Emitted when an algorithm is dropped onto the view.
commandAborted	Emitted when an undo command in the view was aborted.
commandBegun	Emitted when an undo command is started in the view.
commandEnded	Emitted when an undo command in the view has ended.
deleteSelectedItems	Emitted when the selected items should be deleted;
inputDropped	Emitted when an input parameter is dropped onto the view.
itemFocused	Emitted when an item is "focused" in the view, i.e. it becomes the active item and should have its properties displayed in any designer windows.
macroCommandEnded	Emitted when a macro command containing a group of interactions in the view has ended.
macroCommandStarted	Emitted when a macro command containing a group of interactions is started in the view.
willBeDeleted	Emitted in the destructor when the view is about to be deleted, but is still in a perfectly valid state.

class qgis.gui.QgsModelGraphicsView

Bases: QGraphicsView

__init__(parent: QWidget | None = None)

Constructor for QgsModelGraphicsView, with the specified parent widget.

Parameters:

parent (Optional[QWidget] = None)

ClipboardCopy = 1

ClipboardCut = 0

class ClipboardOperation(*values)

Bases: IntEnum

ClipboardCopy = 1

ClipboardCut = 0

class PasteMode(*values)

Bases: IntEnum

PasteModeCenter = 1

PasteModeCursor = 0

PasteModeInPlace = 2

PasteModeCenter = 1

PasteModeCursor = 0

PasteModeInPlace = 2

abortCommand(self)

Aborts pending undo command

Added in version 4.0.

signal algorithmDropped(algorithmId: str, pos: QPointF)

Emitted when an algorithm is dropped onto the view.

Parameters:

• algorithmId (str)

• pos (QPointF)

beginCommand(self, text: str | None)

Starts a single undo command

Parameters:

text (Optional[str])

signal commandAborted

Emitted when an undo command in the view was aborted.

Added in version 4.0.

signal commandBegun(text: str)

Emitted when an undo command is started in the view.

Parameters:

text (str)

signal commandEnded

Emitted when an undo command in the view has ended.

copyItems(self, items: Iterable[QgsModelComponentGraphicItem], operation: QgsModelGraphicsView.ClipboardOperation)

Cuts or copies the a list of items, respecting the specified operation.

See also

copySelectedItems()

See also

pasteItems()

Parameters:

• items (Iterable[QgsModelComponentGraphicItem])

• operation (QgsModelGraphicsView.ClipboardOperation)

copySelectedItems(self, operation: QgsModelGraphicsView.ClipboardOperation)

Cuts or copies the selected items, respecting the specified operation.

See also

copyItems()

See also

pasteItems()

Parameters:

operation (QgsModelGraphicsView.ClipboardOperation)

signal deleteSelectedItems

Emitted when the selected items should be deleted;

endCommand(self)

Ends a single undo command

endMacroCommand(self)

Ends a macro command, containing a group of interactions in the view.

signal inputDropped(inputId: str, pos: QPointF)

Emitted when an input parameter is dropped onto the view.

Parameters:

• inputId (str)

• pos (QPointF)

signal itemFocused(item: QgsModelComponentGraphicItem)

Emitted when an item is “focused” in the view, i.e. it becomes the active item and should have its properties displayed in any designer windows.

Parameters:

item (QgsModelComponentGraphicItem)

signal macroCommandEnded

Emitted when a macro command containing a group of interactions in the view has ended.

signal macroCommandStarted(text: str)

Emitted when a macro command containing a group of interactions is started in the view.

Parameters:

text (str)

modelScene(self) → QgsModelGraphicsScene | None

Returns the scene associated with the tool.

See also

view()

Return type:

Optional[QgsModelGraphicsScene]

pasteItems(self, mode: QgsModelGraphicsView.PasteMode)

Pastes items from clipboard, using the specified mode.

See also

copySelectedItems()

See also

hasItemsInClipboard()

Parameters:

mode (QgsModelGraphicsView.PasteMode)

setModelScene(self, scene: QgsModelGraphicsScene | None)

Sets the related scene.

Parameters:

scene (Optional[QgsModelGraphicsScene])

snapSelected(self)

Snaps the selected items to the grid.

startMacroCommand(self, text: str | None)

Starts a macro command, containing a group of interactions in the view.

Parameters:

text (Optional[str])

signal willBeDeleted

Emitted in the destructor when the view is about to be deleted, but is still in a perfectly valid state.