node widget docs setup

Author: jchanvfx

NodeGraphQt/base/node.py

@@ -11,9 +11,9 @@
 from NodeGraphQt.errors import PortRegistrationError
 from NodeGraphQt.qgraphics.node_backdrop import BackdropNodeItem
 from NodeGraphQt.qgraphics.node_base import NodeItem
-from NodeGraphQt.widgets.node_property import (NodeComboBox,
-                                               NodeLineEdit,
-                                               NodeCheckBox)
+from NodeGraphQt.widgets.node_widgets import (NodeComboBox,
+                                              NodeLineEdit,
+                                              NodeCheckBox)
 
 
 class classproperty(object):
@@ -453,7 +453,36 @@ def icon(self):
         """
         return self.model.icon
 
-    def add_combo_menu(self, name='', label='', items=None, tab=None):
+    def widgets(self):
+        """
+        Returns all embedded widgets from this node.
+
+        See Also:
+            :meth:`BaseNode.get_widget`,
+
+        Returns:
+            dict: embedded node widgets. {``property_name``: ``node_widget``}
+        """
+        return self.view.widgets
+
+    def get_widget(self, name):
+        """
+        Returns the embedded widget associated with the property name.
+
+        See Also:
+            :meth:`BaseNode.add_combo_menu`,
+            :meth:`BaseNode.add_text_input`,
+            :meth:`BaseNode.add_checkbox`,
+
+        Args:
+            name (str): node property name.
+
+        Returns:
+            NodeBaseWidget: embedded node widget.
+        """
+        return self.view.widgets.get(name)
+
+    def add_combo_menu(self, name, label='', items=None, tab=None):
         """
         Creates a custom property with the :meth:`NodeObject.create_property`
         function and embeds a :class:`PySide2.QtWidgets.QComboBox` widget
@@ -477,7 +506,7 @@ def add_combo_menu(self, name='', label='', items=None, tab=None):
         widget.value_changed.connect(lambda k, v: self.set_property(k, v))
         self.view.add_widget(widget)
 
-    def add_text_input(self, name='', label='', text='', tab=None):
+    def add_text_input(self, name, label='', text='', tab=None):
         """
         Creates a custom property with the :meth:`NodeObject.create_property`
         function and embeds a :class:`PySide2.QtWidgets.QLineEdit` widget
@@ -499,7 +528,7 @@ def add_text_input(self, name='', label='', text='', tab=None):
         widget.value_changed.connect(lambda k, v: self.set_property(k, v))
         self.view.add_widget(widget)
 
-    def add_checkbox(self, name='', label='', text='', state=False, tab=None):
+    def add_checkbox(self, name, label='', text='', state=False, tab=None):
         """
         Creates a custom property with the :meth:`NodeObject.create_property`
         function and embeds a :class:`PySide2.QtWidgets.QCheckBox` widget

NodeGraphQt/widgets/node_property.py renamed to NodeGraphQt/widgets/node_widgets.py

@@ -32,6 +32,12 @@ class NodeBaseWidget(QtWidgets.QGraphicsProxyWidget):
     """
 
     value_changed = QtCore.Signal(str, object)
+    """
+    Signal triggered when the ``value`` attribute has changed.
+
+    :parameters: str, object
+    :emits: property name, propety value
+    """
 
     def __init__(self, parent=None, name='widget', label=''):
         super(NodeBaseWidget, self).__init__(parent)
@@ -49,40 +55,89 @@ def setToolTip(self, tooltip):
 
     @property
     def widget(self):
+        """
+        Returns the embedded QWidget used in the node.
+
+        Returns:
+            QtWidgets.QWidget: nested QWidget
+        """
         raise NotImplementedError
 
     @property
     def value(self):
+        """
+        Returns the widgets current value.
+
+        Returns:
+            str: current property value.
+        """
         raise NotImplementedError
 
     @value.setter
     def value(self, text):
+        """
+        Sets the widgets current value.
+
+        Args:
+            text (str): new text value.
+        """
         raise NotImplementedError
 
     @property
     def label(self):
+        """
+        Returns the label text displayed above the embedded node widget.
+
+        Returns:
+            str: label text.
+        """
         return self._label
 
     @label.setter
     def label(self, label):
+        """
+        Sets the label text above the embedded widget.
+
+        Args:
+            label (str): new label ext.
+        """
         self._label = label
 
     @property
     def type_(self):
+        """
+        Returns the node widget type.
+
+        Returns:
+            str: widget type.
+        """
         return str(self.__class__.__name__)
 
     @property
     def node(self):
+        """
+        Returns the parent node object.
+
+        Returns:
+            NodeGraphQt.BaseNode: parent node.
+        """
         self.parentItem()
 
     @property
     def name(self):
+        """
+        Returns the parent node property name.
+
+        Returns:
+            str: property name.
+        """
         return self._name
 
 
 class NodeComboBox(NodeBaseWidget):
     """
-    ComboBox Node Widget.
+    ComboBox Node Widget inherits from:
+    :class:`NodeGraphQt.widgets.node_widgets.NodeBaseWidget`
     """
 
     def __init__(self, parent=None, name='', label='', items=None):
@@ -111,6 +166,12 @@ def widget(self):
 
     @property
     def value(self):
+        """
+        Returns the QComboBox current text.
+
+        Returns:
+            str: current property value.
+        """
         return str(self._combo.currentText())
 
     @value.setter
@@ -140,7 +201,8 @@ def clear(self):
 
 class NodeLineEdit(NodeBaseWidget):
     """
-    LineEdit Node Widget.
+    LineEdit Node Widget inherits from:
+    :class:`NodeGraphQt.widgets.node_widgets.NodeBaseWidget`
     """
 
     def __init__(self, parent=None, name='', label='', text=''):
@@ -166,6 +228,12 @@ def widget(self):
 
     @property
     def value(self):
+        """
+        Returns the QLineEdit current text.
+
+        Returns:
+            str: current property value.
+        """
         return str(self._ledit.text())
 
     @value.setter
@@ -177,7 +245,8 @@ def value(self, text=''):
 
 class NodeCheckBox(NodeBaseWidget):
     """
-    CheckBox Node Widget.
+    CheckBox Node Widget inherits from:
+    :class:`NodeGraphQt.widgets.node_widgets.NodeBaseWidget`
     """
 
     def __init__(self, parent=None, name='', label='', text='', state=False):
@@ -206,6 +275,12 @@ def widget(self):
 
     @property
     def value(self):
+        """
+        Returns the QCheckBox checked state.
+
+        Returns:
+            bool: current property value.
+        """
         return self._cbox.isChecked()
 
     @value.setter

docs/index.rst

@@ -20,6 +20,7 @@ GitHub Project: https://github.com/jchanvfx/NodeGraphQt
     nodes
     menu
     widgets
+    node_widgets
 
 .. toctree::
     :caption: Module Examples

docs/node_widgets.rst

@@ -0,0 +1,32 @@
+Node Widgets
+############
+
+Node widgets are widgets that are embedded in the :class:`NodeGraphQt.BaseNode` class.
+
+NodeBaseWidget
+**************
+
+.. autoclass:: NodeGraphQt.widgets.node_widgets.NodeBaseWidget
+    :members:
+    :exclude-members: setToolTip, widget, value
+
+NodeComboBox
+************
+
+.. autoclass:: NodeGraphQt.widgets.node_widgets.NodeComboBox
+    :members:
+    :exclude-members: widget, type_
+
+NodeLineEdit
+************
+
+.. autoclass:: NodeGraphQt.widgets.node_widgets.NodeLineEdit
+    :members:
+    :exclude-members: widget, type_
+
+NodeCheckBox
+************
+
+.. autoclass:: NodeGraphQt.widgets.node_widgets.NodeCheckBox
+    :members:
+    :exclude-members: widget, type_