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

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.

Parameters:

node (QgsProcessingToolboxModelNode) –

childEvent(self, QChildEvent)
children(self) List[QgsProcessingToolboxModelNode]

Returns a list of children belonging to the node.

Return type:

List[QgsProcessingToolboxModelNode]

connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
deleteChildren(self)

Deletes all child nodes from this node.

disconnectNotify(self, QMetaMethod)
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.

Parameters:

id (str) –

Return type:

QgsProcessingToolboxModelGroupNode

isSignalConnected(self, QMetaMethod) bool
nodeType(self) QgsProcessingToolboxModelNode.NodeType

Returns the node’s type.

Return type:

QgsProcessingToolboxModelNode.NodeType

parent(self) QgsProcessingToolboxModelNode

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

Return type:

QgsProcessingToolboxModelNode

receivers(self, PYQT_SIGNAL) int
sender(self) QObject
senderSignalIndex(self) int
takeChild(self, node: QgsProcessingToolboxModelNode) QgsProcessingToolboxModelNode

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

Parameters:

node (QgsProcessingToolboxModelNode) –

Return type:

QgsProcessingToolboxModelNode

timerEvent(self, QTimerEvent)