renamed menu classes

Author: jchanvfx

NodeGraphQt/__init__.py

@@ -47,4 +47,4 @@
 from .base.graph import NodeGraph
 from .base.node import NodeObject, Node, Backdrop
 from .base.port import Port
-from .base.menu import ContextMenu, ContextMenuCommand
+from .base.menu import Menu, MenuCommand

NodeGraphQt/base/graph.py

@@ -10,7 +10,7 @@
                                        NodeRemovedCmd,
                                        NodeMovedCmd,
                                        PortConnectedCmd)
-from NodeGraphQt.base.menu import ContextMenu
+from NodeGraphQt.base.menu import Menu
 from NodeGraphQt.base.model import NodeGraphModel
 from NodeGraphQt.base.node import NodeObject
 from NodeGraphQt.base.port import Port
@@ -222,9 +222,9 @@ def context_menu(self):
         Returns the node graph root context menu object.
 
         Returns:
-            ContextMenu: context menu object.
+            Menu: context menu object.
         """
-        return ContextMenu(self._viewer, self._viewer.context_menu())
+        return Menu(self._viewer, self._viewer.context_menu())
 
     def acyclic(self):
         """

NodeGraphQt/base/menu.py

@@ -6,9 +6,9 @@
 from NodeGraphQt.widgets.stylesheet import STYLE_QMENU
 
 
-class ContextMenu(object):
+class Menu(object):
     """
-    base class for a context menu item.
+    base class for a menu item.
     """
 
     def __init__(self, viewer, qmenu):
@@ -25,7 +25,7 @@ def qmenu(self):
 
     def name(self):
         """
-        Returns the label for the menu.
+        Returns the name for the menu.
 
         Returns:
             str: label name.
@@ -34,38 +34,38 @@ def name(self):
 
     def get_menu(self, name):
         """
-        Returns the child context menu item by name.
+        Returns the child menu by name.
 
         Args:
             name (str): name of the menu.
 
         Returns:
-            NodeGraphQt.ContextMenu: menu item.
+            NodeGraphQt.Menu: menu item.
         """
         for action in self.qmenu.actions():
             if action.menu() and action.menu().title() == name:
-                return ContextMenu(self.__viewer, action.menu())
+                return Menu(self.__viewer, action.menu())
 
     def get_command(self, name):
         """
-        Returns the child menu command item by name.
+        Returns the child menu command by name.
 
         Args:
             name (str): name of the command.
 
         Returns:
-            NodeGraphQt.ContextMenuCommand: context menu command.
+            NodeGraphQt.MenuCommand: context menu command.
         """
         for action in self.qmenu.actions():
             if not action.menu() and action.text() == name:
-                return ContextMenuCommand(self.__viewer, action)
+                return MenuCommand(self.__viewer, action)
 
     def all_commands(self):
         """
         Returns all child and sub child commands from the current context menu.
 
         Returns:
-            list[NodeGraphQt.ContextMenuCommand]: list of commands.
+            list[NodeGraphQt.MenuCommand]: list of commands.
         """
         def get_actions(menu):
             actions = []
@@ -77,7 +77,7 @@ def get_actions(menu):
                     actions += get_actions(action.menu())
             return actions
         child_actions = get_actions(self.qmenu)
-        return [ContextMenuCommand(self.__viewer, a) for a in child_actions]
+        return [MenuCommand(self.__viewer, a) for a in child_actions]
 
     def add_menu(self, name):
         """
@@ -87,12 +87,12 @@ def add_menu(self, name):
             name (str): menu name.
 
         Returns:
-            NodeGraphQt.ContextMenu: the appended menu.
+            NodeGraphQt.Menu: the appended menu item.
         """
         menu = QtWidgets.QMenu(None, title=name)
         menu.setStyleSheet(STYLE_QMENU)
         self.qmenu.addMenu(menu)
-        return ContextMenu(self.__viewer, menu)
+        return Menu(self.__viewer, menu)
 
     def add_command(self, name, func=None, shortcut=None):
         """
@@ -101,10 +101,10 @@ def add_command(self, name, func=None, shortcut=None):
         Args:
             name (str): command name.
             func (function): command function.
-            shortcut (str): shotcut key.
+            shortcut (str): function shotcut key.
 
         Returns:
-            NodeGraphQt.ContextMenuCommand: the appended command.
+            NodeGraphQt.MenuCommand: the appended command.
         """
         action = QtWidgets.QAction(name, self.__viewer)
         if LooseVersion(QtCore.qVersion()) >= LooseVersion('5.10'):
@@ -114,7 +114,7 @@ def add_command(self, name, func=None, shortcut=None):
         if func:
             action.triggered.connect(func)
         qaction = self.qmenu.addAction(action, shortcut=shortcut)
-        return ContextMenuCommand(self.__viewer, qaction)
+        return MenuCommand(self.__viewer, qaction)
 
     def add_separator(self):
         """
@@ -123,9 +123,9 @@ def add_separator(self):
         self.qmenu.addSeparator()
 
 
-class ContextMenuCommand(object):
+class MenuCommand(object):
     """
-    base class for a context menu command.
+    base class for a menu command.
     """
 
     def __init__(self, viewer, qaction):
@@ -142,7 +142,7 @@ def qaction(self):
 
     def name(self):
         """
-        Returns the label for the menu command.
+        Returns the name for the menu command.
 
         Returns:
             str: label name.

docs/_static/ngqt.css

@@ -288,7 +288,7 @@ pre {
     line-height: 1.2em;
     border: 1px solid #C6C9CB;
     font-size: 1.1em;
-    margin: 1.5em 0 1.5em 0;
+    margin: 0.5em 0 0.5em 0;
     -webkit-box-shadow: 1px 1px 1px #d8d8d8;
     -moz-box-shadow: 1px 1px 1px #d8d8d8;
 }

docs/menu.rst

@@ -18,28 +18,34 @@ context menu some default menus and commands.
 Example
 =======
 
-Here's a example to adding a menu and command.
+Here's a example where we a menu with the name "Foo" to the node graphs context menu.
 
 .. code-block:: python
     :linenos:
 
     from NodeGraphQt import NodeGraph
 
-    # test function.
-    def my_test_func():
-        print('Hello World')
-
     # create node graph.
     graph = NodeGraph()
 
     # get the main context menu.
     root_menu = graph.context_menu()
 
-    # add "Foo" menu.
+    # add a menu called "Foo".
     foo_menu = root_menu.add_menu('Foo')
 
+and here we add a menu command with the name "Bar" to the "Foo" menu that will execute the ``my_test()`` method.
+
+.. code-block:: python
+    :linenos:
+    :lineno-start: 11
+
+    # test function.
+    def my_test():
+        print('Hello World')
+
     # add "Bar" command to the "Foo" menu.
-    foo_menu.add_command('Bar', my_test_func, 'Shift+t')
+    foo_menu.add_command('Bar', my_test, 'Shift+t')
 
 
 Menu
@@ -50,7 +56,7 @@ Node graph context menu.
 
 ----
 
-.. autoclass:: NodeGraphQt.ContextMenu
+.. autoclass:: NodeGraphQt.Menu
     :members:
 
 
@@ -61,5 +67,5 @@ Node graph context menu command.
 
 ----
 
-.. autoclass:: NodeGraphQt.ContextMenuCommand
+.. autoclass:: NodeGraphQt.MenuCommand
     :members: