updated node widget docs

Author: jchanvfx

NodeGraphQt/widgets/node_widgets.py

@@ -28,7 +28,8 @@ def add_node_widget(self, widget):
 
 class NodeBaseWidget(QtWidgets.QGraphicsProxyWidget):
     """
-    Base Node Widget.
+    NodeBaseWidget is the main base class for all node widgets that is
+    embedded in a :class:`NodeGraphQt.BaseNode` object.
     """
 
     value_changed = QtCore.Signal(str, object)
@@ -136,8 +137,12 @@ def name(self):
 
 class NodeComboBox(NodeBaseWidget):
     """
-    ComboBox Node Widget inherits from:
-    :class:`NodeGraphQt.widgets.node_widgets.NodeBaseWidget`
+    NodeComboBox widget is subclassed from :class:`NodeBaseWidget`,
+    this widget is displayed as a ``QComboBox`` embedded in a node.
+
+    .. note::
+        `To embed a ``QComboBox`` in a node see func:`
+        :meth:`NodeGraphQt.BaseNode.add_combo_menu`
     """
 
     def __init__(self, parent=None, name='', label='', items=None):
@@ -167,10 +172,10 @@ def widget(self):
     @property
     def value(self):
         """
-        Returns the QComboBox current text.
+        Returns the widget current text.
 
         Returns:
-            str: current property value.
+            str: current text.
         """
         return str(self._combo.currentText())
 
@@ -201,8 +206,12 @@ def clear(self):
 
 class NodeLineEdit(NodeBaseWidget):
     """
-    LineEdit Node Widget inherits from:
-    :class:`NodeGraphQt.widgets.node_widgets.NodeBaseWidget`
+    NodeLineEdit widget is subclassed from :class:`NodeBaseWidget`,
+    this widget is displayed as a ``QLineEdit`` embedded in a node.
+
+    .. note::
+        `To embed a ``QLineEdit`` in a node see func:`
+        :meth:`NodeGraphQt.BaseNode.add_text_input`
     """
 
     def __init__(self, parent=None, name='', label='', text=''):
@@ -229,10 +238,10 @@ def widget(self):
     @property
     def value(self):
         """
-        Returns the QLineEdit current text.
+        Returns the widgets current text.
 
         Returns:
-            str: current property value.
+            str: current text.
         """
         return str(self._ledit.text())
 
@@ -245,8 +254,12 @@ def value(self, text=''):
 
 class NodeCheckBox(NodeBaseWidget):
     """
-    CheckBox Node Widget inherits from:
-    :class:`NodeGraphQt.widgets.node_widgets.NodeBaseWidget`
+    NodeCheckBox widget is subclassed from :class:`NodeBaseWidget`,
+    this widget is displayed as a ``QCheckBox`` embedded in a node.
+
+    .. note::
+        `To embed a ``QCheckBox`` in a node see func:`
+        :meth:`NodeGraphQt.BaseNode.add_checkbox`
     """
 
     def __init__(self, parent=None, name='', label='', text='', state=False):
@@ -279,10 +292,10 @@ def widget(self):
     @property
     def value(self):
         """
-        Returns the QCheckBox checked state.
+        Returns the widget checked state.
 
         Returns:
-            bool: current property value.
+            bool: checked state.
         """
         return self._cbox.isChecked()
 

docs/node_widgets.rst

@@ -1,14 +1,15 @@
 Node Widgets
 ############
 
-Node widgets are widgets that are embedded in the :class:`NodeGraphQt.BaseNode` class.
+Node widgets are widgets that are embedded in a :class:`NodeGraphQt.BaseNode`
+object displayed in the node graph.
 
 NodeBaseWidget
 **************
 
 .. autoclass:: NodeGraphQt.widgets.node_widgets.NodeBaseWidget
     :members:
-    :exclude-members: node, setToolTip, value, widget
+    :exclude-members: node, setToolTip, type_, value, widget
 
 NodeComboBox
 ************

docs/widgets.rst

@@ -1,12 +1,14 @@
 Widgets
 #######
 
+Custom widgets included in the NodeGraphQt module.
+
 
 Properties Bin
 **************
 
-The ``PropertiesBinWidget`` is a list widget for displaying and editing a
-nodes properties.
+The :class:`NodeGraphQt.PropertiesBinWidget` is a list widget for displaying
+and editing a nodes properties.
 
 .. image:: _images/prop_bin.png
     :width: 950px
@@ -34,8 +36,9 @@ example
 Nodes Tree
 **********
 
-The ``NodeTreeWidget`` is a widget for displaying all registered nodes from the
-node graph with this widget a user can create nodes by dragging and dropping.
+The :class:`NodeGraphQt.NodeTreeWidget` is a widget for displaying all
+registered nodes from the node graph with this widget a user can create nodes
+by dragging and dropping.
 
 .. image:: _images/nodes_tree.png
     :width: 300px
@@ -56,6 +59,6 @@ example
 
 ----
 
-.. autoclass:: NodeGraphQt.widgets.node_tree.NodeTreeWidget
+.. autoclass:: NodeGraphQt.NodeTreeWidget
     :members:
     :exclude-members: mimeData, set_node_factory, property_changed