refactored node widgets module and cleanup.

Author: jchanvfx

NodeGraphQt/__init__.py

@@ -98,13 +98,15 @@ def __init__(self):
 from .widgets.node_tree import NodeTreeWidget
 from .widgets.properties_bin import PropertiesBinWidget
 from .widgets.node_publish_widget import NodePublishWidget
+from .widgets.node_widgets import NodeBaseWidget
 
 
 __version__ = VERSION
 __all__ = [
     'BackdropNode',
     'BaseNode',
     'LICENSE',
+    'NodeBaseWidget',
     'NodeGraph',
     'NodeGraphCommand',
     'NodeGraphMenu',

NodeGraphQt/base/node.py

@@ -4,6 +4,7 @@
 from .port import Port
 from .utils import update_node_down_stream
 from ..constants import (NODE_PROP,
+                         NODE_PROP_QLABEL,
                          NODE_PROP_QLINEEDIT,
                          NODE_PROP_QTEXTEDIT,
                          NODE_PROP_QCOMBO,
@@ -15,7 +16,7 @@
                          NODE_LAYOUT_VERTICAL,
                          NODE_LAYOUT_HORIZONTAL,
                          NODE_LAYOUT_DIRECTION)
-from ..errors import PortRegistrationError,NodeWidgetError
+from ..errors import PortRegistrationError, NodeWidgetError
 from ..qgraphics.node_backdrop import BackdropNodeItem
 from ..qgraphics.node_base import NodeItem, NodeItemVertical
 from ..widgets.node_widgets import (NodeBaseWidget,
@@ -628,28 +629,31 @@ def get_widget(self, name):
         """
         return self.view.widgets.get(name)
 
-    def add_custom_widget(self, name, widget=None, widget_type=NODE_PROP,
-                          tab=None):
+    def add_custom_widget(self, widget, widget_type=NODE_PROP_QLABEL, tab=None):
         """
         Add a custom node widget into the node.
 
+        see example :ref:`Embedding Custom Widgets`.
+
         Note:
             The ``value_changed`` signal from the added node widget is wired
             up to the :meth:`NodeObject.set_property` function.
 
         Args:
-            name (str): name for the custom property.
-            widget (NodeBaseWidget): custom node widget.
+            widget_cls (NodeBaseWidget): node widget class object.
             widget_type: widget flag to display in the
-                :class:`NodeGraphQt.PropertiesBinWidget`.
+                :class:`NodeGraphQt.PropertiesBinWidget` (default: QLabel).
             tab (str): name of the widget tab to display in.
         """
         if not isinstance(widget, NodeBaseWidget):
             raise NodeWidgetError(
                 '\'widget\' must be an instance of a NodeBaseWidget')
-        self.create_property(
-            name, widget.value, widget_type=widget_type, tab=tab)
+        self.create_property(widget.get_name(),
+                             widget.get_value(),
+                             widget_type=widget_type,
+                             tab=tab)
         widget.value_changed.connect(lambda k, v: self.set_property(k, v))
+        widget._node = self
         self.view.add_widget(widget)
 
     def add_combo_menu(self, name, label='', items=None, tab=None):

NodeGraphQt/qgraphics/node_base.py

@@ -608,7 +608,7 @@ def height(self, height=0.0):
     def disabled(self, state=False):
         AbstractNodeItem.disabled.fset(self, state)
         for n, w in self._widgets.items():
-            w.widget.setDisabled(state)
+            w.get_custom_widget().setDisabled(state)
         self._tooltip_disable(state)
         self._x_item.setVisible(state)
 
@@ -800,7 +800,7 @@ def widgets(self):
         return self._widgets.copy()
 
     def add_widget(self, widget):
-        self._widgets[widget.name] = widget
+        self._widgets[widget.get_name()] = widget
 
     def get_widget(self, name):
         widget = self._widgets.get(name)