spark.graph_editor.ui.inspector_panel

spark.graph_editor.ui.inspector_panel#

Classes#

InspectorPanel

Dockable panel to show node configurations.

QNodeConfig

Constructs the UI to modify the SparkConfig associated with the a node.

QNodeIO

Constructs the UI to modify the SparkConfig associated with the a inputs and outpus.

InspectorIdleWidget

Constructs the UI shown when no valid node is selected.

NodeHeaderWidget

QWidget used for the name of nodes in the SparkGraphEditor's Inspector.

NodeNameWidget

QWidget used for the name of nodes in the SparkGraphEditor's Inspector.

TreeDisplay

Module Contents#

class spark.graph_editor.ui.inspector_panel.InspectorPanel(name='Inspector', **kwargs)[source]#

Bases: spark.graph_editor.widgets.dock_panel.QDockPanel

Dockable panel to show node configurations.

Parameters:

name (str)

broadcast_message[source]#
on_update[source]#
clear_selection()[source]#
on_selection_update(new_selection, previous_selection)[source]#

Event handler for graph selections.

Parameters:
Return type:

None

set_node(node)[source]#

Sets the node to be inspected. If the node is None, it clears the inspector.

Input:

node: The node to inspect, or None to clear.

Parameters:

node (spark.graph_editor.models.nodes.AbstractNode | None)

set_dirty_flag(value)[source]#
Parameters:

value (bool)

Return type:

None

update_node_metadata()[source]#
Return type:

None

on_error_message(message)[source]#
Parameters:

message (str)

Return type:

None

class spark.graph_editor.ui.inspector_panel.QNodeConfig(node, **kwargs)[source]#

Bases: PySide6.QtWidgets.QWidget

Constructs the UI to modify the SparkConfig associated with the a node.

Parameters:

node (spark.graph_editor.models.nodes.AbstractNode)

error_detected[source]#
on_update[source]#
content[source]#
addWidget(widget)[source]#

Add a widget to the central content widget’s layout.

Parameters:

widget (PySide6.QtWidgets.QWidget)

Return type:

None

name_update(node, name)[source]#
Parameters:
Return type:

None

on_inheritance_toggle(value, leaf)[source]#
Parameters:
Return type:

None

set_dirty_flag(value)[source]#
Parameters:

value (bool)

Return type:

None

class spark.graph_editor.ui.inspector_panel.QNodeIO(node, **kwargs)[source]#

Bases: PySide6.QtWidgets.QWidget

Constructs the UI to modify the SparkConfig associated with the a inputs and outpus.

Parameters:

node (spark.graph_editor.models.nodes.AbstractNode)

error_detected[source]#
on_update[source]#
content[source]#
addWidget(widget)[source]#

Add a widget to the central content widget’s layout.

Parameters:

widget (PySide6.QtWidgets.QWidget)

Return type:

None

name_update(node, name)[source]#
Parameters:
Return type:

None

set_dirty_flag(value)[source]#
Parameters:

value (bool)

Return type:

None

class spark.graph_editor.ui.inspector_panel.InspectorIdleWidget(message, **kwargs)[source]#

Bases: PySide6.QtWidgets.QWidget

Constructs the UI shown when no valid node is selected.

Parameters:

message (str)

class spark.graph_editor.ui.inspector_panel.NodeHeaderWidget(name, node_cls, config_tree=None, **kwargs)[source]#

Bases: spark.graph_editor.widgets.base.QInput

QWidget used for the name of nodes in the SparkGraphEditor’s Inspector.

Parameters:

  • name (str)

  • node_cls (str)

  • config_tree (str | None)

name_widget[source]#
class_label[source]#
sizeHint()[source]#
get_value()[source]#

Returns the widget value.

Return type:

str

set_value(value)[source]#

Sets the widget value.

Parameters:

value (str)

Return type:

None

class spark.graph_editor.ui.inspector_panel.NodeNameWidget(name, **kwargs)[source]#

Bases: spark.graph_editor.widgets.base.QInput

QWidget used for the name of nodes in the SparkGraphEditor’s Inspector.

Parameters:

name (str)

sizeHint()[source]#
get_value()[source]#

Returns the widget value.

Return type:

str

set_value(value)[source]#

Sets the widget value.

Parameters:

value (str)

Return type:

None

class spark.graph_editor.ui.inspector_panel.TreeDisplay(tree)[source]#

Bases: PySide6.QtWidgets.QPlainTextEdit

Parameters:

tree (str)

sizeHint()[source]#
Contents