Subgroup: Processing

Class: QgsProcessingToolboxModelNode

class qgis.gui.QgsProcessingToolboxModelNode

Bases: PyQt5.QtCore.QObject

Abstract base class for nodes contained within a QgsProcessingToolboxModel.

Warning

Not part of stable API and may change in future QGIS releases.

New in version 3.4: Methods

addChildNode Adds a child node to this node, transferring ownership of the node to this node.
childEvent
children Returns a list of children belonging to the node.
connectNotify
customEvent
deleteChildren Deletes all child nodes from this node.
disconnectNotify
getChildGroupNode Tries to find a child node belonging to this node, which corresponds to a group node with the given group id.
isSignalConnected
nodeType Returns the node’s type.
parent Returns the node’s parent.
receivers
sender
senderSignalIndex
takeChild Removes the specified node from this node’s children, and gives ownership back to the caller.
timerEvent

Signals

Attributes

NodeAlgorithm
NodeGroup
NodeProvider
NodeRecent
NodeAlgorithm = 2
NodeGroup = 1
NodeProvider = 0
NodeRecent = 3
class NodeType

Bases: int

addChildNode(self, node: QgsProcessingToolboxModelNode)

Adds a child node to this node, transferring ownership of the node to this node.

childEvent()
children(self) → object

Returns a list of children belonging to the node.

connectNotify()
customEvent()
deleteChildren(self)

Deletes all child nodes from this node.

disconnectNotify()
getChildGroupNode(self, id: str) → QgsProcessingToolboxModelGroupNode

Tries to find a child node belonging to this node, which corresponds to a group node with the given group id. Returns None if no matching child group node was found.

isSignalConnected()
nodeType(self) → QgsProcessingToolboxModelNode.NodeType

Returns the node’s type.

parent(self) → QgsProcessingToolboxModelNode

Returns the node’s parent. If the node’s parent is a null pointer, then the node is a root node.

receivers()
sender()
senderSignalIndex()
takeChild(self, node: QgsProcessingToolboxModelNode) → QgsProcessingToolboxModelNode

Removes the specified node from this node’s children, and gives ownership back to the caller.

timerEvent()