wip menu refactor

Author: jchanvfx

NodeGraphQt/base/graph.py

@@ -348,21 +348,47 @@ def end_undo(self):
 
     def context_menu(self):
         """
-        Returns the node graph root context menu object.
+        Returns the main context menu from the node graph.
 
         Returns:
             Menu: context menu object.
         """
-        return Menu(self._viewer, self._viewer.context_menu())
+        return Menu(self._viewer, self._viewer.context_menus()['Main'])
 
-    def disable_context_menu(self, disabled=True):
+    def get_context_menu(self, name='Main'):
         """
-        Disable/Enable node graph context 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.
+
+        Args:
+            name (str): menu name.
+
+        Returns:
+            Menu: context menu object.
+        """
+        menus = self._viewer.context_menus()
+        if name not in menus:
+            return
+        return Menu(self._viewer, menus['Main'])
+
+    def disable_context_menu(self, disabled=True, name='Main'):
+        """
+        Disable/Enable the main context menu 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.
 
         Args:
             disabled (bool): true to enable context menu.
+            name (str): menu name. (default: Main)
         """
-        menu = self._viewer.context_menu()
+        menu = self._viewer.context_menus()[name]
         menu.setDisabled(disabled)
         menu.setVisible(not disabled)
 

NodeGraphQt/base/menu.py

@@ -2,6 +2,7 @@
 from distutils.version import LooseVersion
 
 from NodeGraphQt import QtGui, QtCore, QtWidgets
+from NodeGraphQt.errors import NodeMenuError
 from NodeGraphQt.widgets.stylesheet import STYLE_QMENU
 
 
@@ -31,6 +32,15 @@ def name(self):
         """
         return self.qmenu.title()
 
+    def set_name(self, name):
+        """
+        Set the name for the menu.
+
+        Args:
+            name (str): label name.
+        """
+        self.qmenu.setTitle(name)
+
     def get_menu(self, name):
         """
         Returns the child menu by name.
@@ -45,7 +55,7 @@ def get_menu(self, name):
             if action.menu() and action.menu().title() == name:
                 return Menu(self.__viewer, action.menu())
 
-    def get_command(self, name):
+    def get_action(self, name):
         """
         Returns the child menu command by name.
 
@@ -57,7 +67,7 @@ def get_command(self, name):
         """
         for action in self.qmenu.actions():
             if not action.menu() and action.text() == name:
-                return MenuCommand(self.__viewer, action)
+                return MenuAction(self.__viewer, action)
 
     def all_commands(self):
         """
@@ -78,66 +88,68 @@ def get_actions(menu):
         child_actions = get_actions(self.qmenu)
         return [MenuCommand(self.__viewer, a) for a in child_actions]
 
-    def add_menu(self, name):
+    def create_menu(self, name):
         """
-        Adds a child menu to the current menu.
+        Create a child menu to the current menu.
 
         Args:
             name (str): menu name.
 
         Returns:
             NodeGraphQt.Menu: the appended menu item.
         """
-        menu = QtWidgets.QMenu(name, self.qmenu)
-        menu.setStyleSheet(STYLE_QMENU)
+        menu = QtWidgets.QMenu(name, self.__viewer)
         self.qmenu.addMenu(menu)
         return Menu(self.__viewer, menu)
 
-    def add_command(self, name, func=None, shortcut=None):
+    def create_action(self, name):
         """
-        Adds a command to the menu.
+        Create a command to the menu.
 
         Args:
-            name (str): command name.
-            func (function): command function.
-            shortcut (str): function shotcut key.
+            name (NodeGraphQt.MenuCommand): menu command.
+
 
-        Returns:
-            NodeGraphQt.MenuCommand: the appended command.
         """
         action = QtWidgets.QAction(name, self.__viewer)
-        if LooseVersion(QtCore.qVersion()) >= LooseVersion('5.10'):
-            action.setShortcutVisibleInContextMenu(True)
-        if shortcut:
-            action.setShortcut(shortcut)
-        if func:
-            action.triggered.connect(func)
         qaction = self.qmenu.addAction(action)
-        return MenuCommand(self.__viewer, qaction)
+        return MenuAction(self.__viewer, qaction)
 
-    def add_separator(self):
+    def create_separator(self):
         """
-        Adds a separator to the menu.
+        Create a separator to the menu.
         """
         self.qmenu.addSeparator()
 
 
-class MenuCommand(object):
+class MenuAction(QtWidgets.QAction):
     """
     base class for a menu command.
     """
 
-    def __init__(self, viewer, qaction):
+    #: signal emits when the action has triggered in the node graph.
+    executed = QtCore.QSignal(object)
+
+    def __init__(self, parent=None, viewer=None, name=''):
+        super(MenuAction, self).__init__(parent)
         self.__viewer = viewer
-        self.__qaction = qaction
+        if LooseVersion(QtCore.qVersion()) >= LooseVersion('5.10'):
+            self.setShortcutVisibleInContextMenu(True)
+        self.setText(name)
+        self.triggered.connect(self._on_triggered)
 
     def __repr__(self):
         cls_name = self.__class__.__name__
         return 'NodeGraphQt.{}(\'{}\')'.format(cls_name, self.name())
 
-    @property
-    def qaction(self):
-        return self.__qaction
+    def _on_triggered(self):
+        menu = self.menu()
+        pos = self.mapToScene(menu.pos())
+
+        items = self.__viewer._items_near(pos)
+        
+
+        self.triggered.emit()
 
     def name(self):
         """
@@ -146,7 +158,16 @@ def name(self):
         Returns:
             str: label name.
         """
-        return self.qaction.text()
+        return self.text()
+
+    def set_name(self, name):
+        """
+        Set the name for the menu command.
+
+        Args:
+            name (str): label name.
+        """
+        self.setText(name)
 
     def set_shortcut(self, shortcut=None):
         """
@@ -157,9 +178,3 @@ def set_shortcut(self, shortcut=None):
         """
         shortcut = shortcut or QtGui.QKeySequence()
         self.qaction.setShortcut(shortcut)
-
-    def run_command(self):
-        """
-        execute the menu command.
-        """
-        self.qaction.trigger()

NodeGraphQt/errors.py

@@ -1,18 +1,6 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
-
-
-class NodePropertyError(Exception):
-    pass
-
-
-class NodeWidgetError(Exception):
-    pass
-
-
-class NodeRegistrationError(Exception):
-    pass
-
-
-class PortRegistrationError(Exception):
-    pass
+class NodePropertyError(Exception): pass
+class NodeWidgetError(Exception): pass
+class NodeRegistrationError(Exception): pass
+class PortRegistrationError(Exception): pass

NodeGraphQt/widgets/viewer.py

@@ -73,8 +73,6 @@ def __init__(self, parent=None):
         self.scene().addItem(self._SLICER_PIPE)
 
         self._undo_stack = QtWidgets.QUndoStack(self)
-        self._context_menu = QtWidgets.QMenu('main', self)
-        self._context_menu.setStyleSheet(STYLE_QMENU)
         self._search_widget = TabSearchWidget(self)
         self._search_widget.search_submitted.connect(self._on_search_submitted)
 
@@ -84,7 +82,13 @@ def __init__(self, parent=None):
         menu_bar.setNativeMenuBar(False)
         # shortcuts don't work with "setVisibility(False)".
         menu_bar.resize(0, 0)
-        menu_bar.addMenu(self._context_menu)
+
+        self._context_menus = {}
+        for name in ['Main', 'Node', 'Port']:
+            menu = QtWidgets.QMenu(name, self)
+            menu.setStyleSheet(STYLE_QMENU)
+            self._context_menus[name] = menu
+            menu_bar.addMenu(menu)
 
         self.acyclic = True
         self.LMB_state = False
@@ -155,8 +159,17 @@ def resizeEvent(self, event):
 
     def contextMenuEvent(self, event):
         self.RMB_state = False
-        if self._context_menu.isEnabled():
-            self._context_menu.exec_(event.globalPos())
+
+        pos = self.mapToScene(self._previous_pos)
+        items = self._items_near(pos)
+        ports = [i for i in items if isinstance(i, PortItem)]
+        nodes = [i for i in items if isinstance(i, AbstractNodeItem)]
+        if self._context_menus['Port'].isEnabled() and ports:
+            self._context_menus['Port'].exec_(event.globalPos())
+        elif self._context_menus['Node'].isEnabled() and nodes:
+            self._context_menus['Node'].exec_(event.globalPos())
+        elif self._context_menus['Main'].isEnabled():
+            self._context_menus['Main'].exec_(event.globalPos())
         else:
             return super(NodeViewer, self).contextMenuEvent(event)
 
@@ -591,8 +604,8 @@ def tab_search_toggle(self):
             self._search_widget.setVisible(state)
             self.clearFocus()
 
-    def context_menu(self):
-        return self._context_menu
+    def context_menus(self):
+        return self._context_menus
 
     def question_dialog(self, text, title='Node Graph'):
         dlg = QtWidgets.QMessageBox.question(

docs/_images/favicon.png

@@ -1,4 +1,4 @@
 {%- if display_toc %}
-  <h3><a href="{{ pathto(master_doc) }}">{{ _('Table of Contents FOO') }}</a></h3>
+  <h3><a href="{{ pathto(master_doc) }}">{{ _('Table of Contents') }}</a></h3>
   {{ toc }}
 {%- endif %}