wip node context menu and doc updates

Author: jchanvfx

NodeGraphQt/__init__.py

@@ -80,22 +80,34 @@ def __init__(self):
           '"NodeGraphQt.vendor.Qt ({})"'.format(qtpy_ver))
 
 from .base.graph import NodeGraph
-from .base.menu import Menu, MenuCommand
+from .base.menu import NodesMenu, NodeGraphMenu, NodeGraphCommand
 from .base.node import NodeObject, BaseNode, BackdropNode
 from .base.port import Port
 from .pkg_info import __version__ as VERSION
 from .pkg_info import __license__ as LICENSE
 
 # functions
-from .base.actions import setup_context_menu
+from .base.utils import setup_context_menu
 
 # widgets
 from .widgets.node_tree import NodeTreeWidget
 from .widgets.properties_bin import PropertiesBinWidget
 
 __version__ = VERSION
 __all__ = [
-    'BackdropNode', 'BaseNode', 'LICENSE', 'Menu', 'MenuCommand', 'NodeGraph',
-    'NodeObject', 'NodeTreeWidget', 'Port', 'PropertiesBinWidget', 'VERSION',
-    'constants', 'setup_context_menu'
+    'BackdropNode',
+    'BaseNode',
+    'LICENSE',
+    'NodeGraph',
+    'NodeGraphCommand',
+    'NodeGraphMenu',
+    'NodeObject',
+    'NodeTreeWidget',
+    'NodesMenu',
+    'Port',
+    'PropertiesBinWidget',
+    'VERSION',
+    'constants',
+    'setup_context_menu'
 ]
+

NodeGraphQt/base/graph.py

@@ -10,7 +10,7 @@
                                        NodeMovedCmd,
                                        PortConnectedCmd)
 from NodeGraphQt.base.factory import NodeFactory
-from NodeGraphQt.base.menu import Menu
+from NodeGraphQt.base.menu import NodeGraphMenu, NodesMenu
 from NodeGraphQt.base.model import NodeGraphModel
 from NodeGraphQt.base.node import NodeObject
 from NodeGraphQt.base.port import Port
@@ -393,47 +393,73 @@ def context_menu(self):
         """
         Returns the main context menu from the node graph.
 
+        Note:
+            This is a convenience function to
+            :meth:`NodeGraphQt.NodeGraph.get_context_menu`
+            with the arg ``menu="graph"``
+
         Returns:
-            Menu: context menu object.
+            NodeGraphQt.NodeGraphMenu: context menu object.
+        """
+        return self.get_context_menu('graph')
+
+    def context_nodes_menu(self):
         """
-        return Menu(self._viewer, self._viewer.context_menus()['Main'])
+        Returns the main context menu for the nodes.
 
-    def get_context_menu(self, name='Main'):
+        Note:
+            This is a convenience function to
+            :meth:`NodeGraphQt.NodeGraph.get_context_menu`
+            with the arg ``menu="nodes"``
+
+        Returns:
+            NodeGraphQt.NodesMenu: context menu object.
+        """
+        return self.get_context_menu('nodes')
+
+    def get_context_menu(self, menu):
         """
         Returns the context menu specified by the name.
 
         Menu types:
-            "Main" - context menu from the node graph.
-            "Node" - context menu from a Node.
-            "Port" - context menu from a Port.
+            "graph" - context menu from the node graph.
+            "nodes" - context menu for the nodes.
 
         Args:
-            name (str): menu name.
+            menu (str): menu name.
 
         Returns:
-            Menu: context menu object.
+            NodeGraphMenu or NodesMenu: context menu object.
         """
         menus = self._viewer.context_menus()
-        if name not in menus:
-            return
-        return Menu(self._viewer, menus['Main'])
+        if menus.get(menu):
+            if menu == 'graph':
+                return NodeGraphMenu(self, menus[menu])
+            elif menu == 'nodes':
+                return NodesMenu(self, menus[menu])
 
-    def disable_context_menu(self, disabled=True, name='Main'):
+    def disable_context_menu(self, disabled=True, name='all'):
         """
-        Disable/Enable the main context menu from the node graph.
+        Disable/Enable context menus from the node graph.
 
-        Menu types:
-            "Main" - context menu from the node graph.
-            "Node" - context menu from a Node.
-            "Port" - context menu from a Port.
+        Menu Types:
+            - ``"all"`` all context menus from the node graph.
+            - ``"graph"`` context menu from the node graph.
+            - ``"nodes"`` context menu for the nodes.
 
         Args:
             disabled (bool): true to enable context menu.
-            name (str): menu name. (default: Main)
+            name (str): menu name. (default: ``"all"``)
         """
-        menu = self._viewer.context_menus()[name]
-        menu.setDisabled(disabled)
-        menu.setVisible(not disabled)
+        if name == 'all':
+            for k, menu in self._viewer.context_menus().items():
+                menu.setDisabled(disabled)
+                menu.setVisible(not disabled)
+            return
+        menus = self._viewer.context_menus()
+        if menus.get(name):
+            menus[name].setDisabled(disabled)
+            menus[name].setVisible(not disabled)
 
     def acyclic(self):
         """