node widget visibility undo logic #360

Author: jchanvfx

NodeGraphQt/base/commands.py

@@ -103,6 +103,33 @@ def redo(self):
         self.set_node_visible(self.visible)
 
 
+class NodeWidgetVisibleCmd(QtWidgets.QUndoCommand):
+    """
+    Node widget visibility command.
+
+    Args:
+        node (NodeGraphQt.NodeObject): node object.
+        name (str): node widget name.
+        visible (bool): initial visibility state.
+    """
+
+    def __init__(self, node, name, visible):
+        QtWidgets.QUndoCommand.__init__(self)
+        label = 'show' if visible else 'hide'
+        self.setText('{} node widget "{}"'.format(label, name))
+        self.view = node.view
+        self.node_widget = self.view.get_widget(name)
+        self.visible = visible
+
+    def undo(self):
+        self.node_widget.setVisible(not self.visible)
+        self.view.draw_node()
+
+    def redo(self):
+        self.node_widget.setVisible(self.visible)
+        self.view.draw_node()
+
+
 class NodeMovedCmd(QtWidgets.QUndoCommand):
     """
     Node moved command.

NodeGraphQt/nodes/base_node.py

@@ -1,18 +1,22 @@
 #!/usr/bin/python
 from collections import OrderedDict
 
-from NodeGraphQt.base.commands import NodeVisibleCmd
+from NodeGraphQt.base.commands import NodeVisibleCmd, NodeWidgetVisibleCmd
 from NodeGraphQt.base.node import NodeObject
 from NodeGraphQt.base.port import Port
 from NodeGraphQt.constants import NodePropWidgetEnum, PortTypeEnum
-from NodeGraphQt.errors import (PortError,
-                                PortRegistrationError,
-                                NodeWidgetError)
+from NodeGraphQt.errors import (
+    PortError,
+    PortRegistrationError,
+    NodeWidgetError
+)
 from NodeGraphQt.qgraphics.node_base import NodeItem
-from NodeGraphQt.widgets.node_widgets import (NodeBaseWidget,
-                                              NodeComboBox,
-                                              NodeLineEdit,
-                                              NodeCheckBox)
+from NodeGraphQt.widgets.node_widgets import (
+    NodeBaseWidget,
+    NodeCheckBox,
+    NodeComboBox,
+    NodeLineEdit
+)
 
 
 class BaseNode(NodeObject):
@@ -290,9 +294,6 @@ def hide_widget(self, name):
         """
         Hide an embedded node widget.
 
-        Warnings:
-            Undo is NOT yet supported for this function.
-
         Args:
             name (str): node property name for the widget.
 
@@ -301,20 +302,15 @@ def hide_widget(self, name):
             :meth:`BaseNode.show_widget`,
             :meth:`BaseNode.get_widget`
         """
-        # TODO: implement this logic to the undo stack.
         if not self.view.has_widget(name):
             return
-        widget = self.view.get_widget(name)
-        widget.hide()
-        self.view.draw_node()
+        undo_cmd = NodeWidgetVisibleCmd(self, name, visible=False)
+        self.graph.undo_stack().push(undo_cmd)
 
     def show_widget(self, name):
         """
         Show an embedded node widget.
 
-        Warnings:
-            Undo is NOT yet supported for this function.
-
         Args:
             name (str): node property name for the widget.
 
@@ -323,12 +319,10 @@ def show_widget(self, name):
             :meth:`BaseNode.hide_widget`,
             :meth:`BaseNode.get_widget`
         """
-        # TODO: implement this logic to the undo stack.
         if not self.view.has_widget(name):
             return
-        widget = self.view.get_widget(name)
-        widget.show()
-        self.view.draw_node()
+        undo_cmd = NodeWidgetVisibleCmd(self, name, visible=True)
+        self.graph.undo_stack().push(undo_cmd)
 
     def add_input(self, name='input', multi_input=False, display_name=True,
                   color=None, locked=False, painter_func=None):

NodeGraphQt/pkg_info.py

@@ -1,6 +1,6 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
-__version__ = '0.6.10'
+__version__ = '0.6.11'
 __status__ = 'Work in Progress'
 __license__ = 'MIT'
 

docs/custom_widgets.rst

@@ -5,7 +5,7 @@ Built-in Widgets
 
 | The ``NodeGraphQt`` framework comes included with a few custom widgets.
 
-**Classes:**
+**Widget Types:**
 
 .. autosummary::
     NodeGraphQt.PropertiesBinWidget

docs/index.rst

@@ -62,7 +62,7 @@ script or checkout the :ref:`General Overview` section.
     :hidden:
     :caption: Widgets
     :name: wdgtstoc
-    :maxdepth: 1
+    :maxdepth: 2
 
     custom_widgets
     node_widgets