Merge pull request #193 from robotools/list2menu

move VanillaMenuBuilder and add support for List2 contextual menu

Author: typesupply

Lib/vanilla/vanillaList.py

@@ -6,6 +6,7 @@
 
 from vanilla.nsSubclasses import getNSSubclass
 from vanilla.vanillaBase import VanillaBaseObject, VanillaError, VanillaCallbackWrapper
+from vanilla.vanillaMenuBuilder import VanillaMenuBuilder
 
 
 class VanillaTableViewSubclass(NSTableView):
@@ -195,55 +196,6 @@ def init(self):
         return super().init()
 
 
-def VanillaMenuBuilder(sender, items, menu, resetCallbackWrapper=True):
-    """
-    Build a menu from a given set of items
-    Each items must be a dict with the following keys:
-
-    * **title** title of the menu item (required)
-    * **callback** callback when the menu item is clicked (optional)
-    * **items** a list of sub menu items, this will build a sub menu for the given menu item.
-    * **image** an image placed inside the menu item, must be a NSImage.
-    * **state** a menu item state: must be either 0, 1 or -1 (on, off or mixed).
-    * **enabled** enable the menu item, must be a bool.
-    """
-    if resetCallbackWrapper:
-        sender._menuItemCallbackWrappers = []
-    for item in items:
-        if isinstance(item, NSMenuItem):
-            menu.addItem_(item)
-        elif item == "----":
-            item = NSMenuItem.separatorItem()
-            menu.addItem_(item)
-        else:
-            title = item["title"]
-            callback = item.get("callback")
-            subItems = item.get("items")
-            image = item.get("image")
-            state = item.get("state")
-            enabled = item.get("enabled")
-
-            menuItem = NSMenuItem.alloc().initWithTitle_action_keyEquivalent_(title, "", "")
-            if callback:
-                wrapper = VanillaCallbackWrapper(callback)
-                sender._menuItemCallbackWrappers.append(wrapper)
-                menuItem.setTarget_(wrapper)
-                menuItem.setAction_("action:")
-            if subItems:
-                subMenu = NSMenu.alloc().init()
-                VanillaMenuBuilder(sender, subItems, subMenu, resetCallbackWrapper=False)
-                menuItem.setSubmenu_(subMenu)
-
-            if image is not None:
-                menuItem.setImage_(image)
-            if state is not None:
-                menuItem.setState_(state)
-            if enabled is not None:
-                menuItem.setEnabled_(enabled)
-
-            menu.addItem_(menuItem)
-
-
 class List(VanillaBaseObject):
 
     """

Lib/vanilla/vanillaList2.py

@@ -9,6 +9,8 @@
 from vanilla.vanillaBase import VanillaBaseObject, VanillaCallbackWrapper, osVersionCurrent, osVersion10_16
 from vanilla.vanillaScrollView import ScrollView
 from vanilla.dragAndDrop import DropTargetProtocolMixIn, dropOperationMap, makePasteboardItem
+from vanilla.vanillaMenuBuilder import VanillaMenuBuilder
+
 
 simpleDataTypes = (
     str,
@@ -313,6 +315,12 @@ def draggingExited_(self, draggingInfo):
     def canDragRowsWithIndexes_atPoint_(self, indexes, point):
         return self.vanillaWrapper()._validateRowsForDrag(indexes)
 
+    # contextual menu support
+
+    def menuForEvent_(self, event):
+        wrapper = self.vanillaWrapper()
+        return wrapper._menuForEvent(event)
+
 
 class List2(ScrollView, DropTargetProtocolMixIn):
 
@@ -395,7 +403,7 @@ class List2(ScrollView, DropTargetProtocolMixIn):
 
     **editCallback** Callback to be called after an item has been edited.
 
-    # **menuCallback** Callback to be called when a contextual menu is requested.
+    **menuCallback** Callback to be called when a contextual menu is requested.
 
     # **enableDelete** A boolean representing if items in the list can be deleted via the interface.
 
@@ -510,6 +518,7 @@ def __init__(self,
             selectionCallback=None,
             doubleClickCallback=None,
             editCallback=None,
+            menuCallback=None,
             allowsGroupRows=False,
             floatsGroupRows=False,
             groupRowCellClass=None,
@@ -544,6 +553,8 @@ def __init__(self,
             self._doubleClickTarget = VanillaCallbackWrapper(doubleClickCallback)
             self._tableView.setTarget_(self._doubleClickTarget)
             self._tableView.setDoubleAction_("action:")
+        # contextual menu
+        self._menuCallback = menuCallback
         # behavior attributes
         self._allowsSelection = allowsSelection
         self._tableView.setAllowsEmptySelection_(allowsEmptySelection)
@@ -870,6 +881,29 @@ def _getPasteboardDataForIndex(self, index):
             return None
         return makePasteboardItem(typesAndValues)
 
+    # contextual menu
+
+    def _menuForEvent(self, event):
+        # this method is called by the NSTableView subclass to request a contextual menu
+        # if there is a menuCallack convert a the incomming items to an nsmenu
+        if self._menuCallback is not None:
+            items = self._menuCallback(self)
+            # if the list is empty or None, dont do anything
+            if items:
+                menu = AppKit.NSMenu.alloc().init()
+                VanillaMenuBuilder(self, items, menu)
+                return menu
+        # if a menu is been set by setMenu
+        if self._menu is not None:
+            return self._menu
+        return None
+
+    _menu = None
+
+    def setMenu(self, items):
+        self._menu = menu = AppKit.NSMenu.alloc().init()
+        VanillaMenuBuilder(self, items, menu)
+
     # Drop
 
     _allowDropOnRow = None

Lib/vanilla/vanillaMenuBuilder.py

@@ -0,0 +1,52 @@
+from AppKit import NSMenuItem, NSMenu
+
+from vanilla.vanillaBase import VanillaCallbackWrapper
+
+
+def VanillaMenuBuilder(sender, items, menu, resetCallbackWrapper=True):
+    """
+    Build a menu from a given set of items
+    Each items must be a dict with the following keys:
+
+    * **title** title of the menu item (required)
+    * **callback** callback when the menu item is clicked (optional)
+    * **items** a list of sub menu items, this will build a sub menu for the given menu item.
+    * **image** an image placed inside the menu item, must be a NSImage.
+    * **state** a menu item state: must be either 0, 1 or -1 (on, off or mixed).
+    * **enabled** enable the menu item, must be a bool.
+    """
+    if resetCallbackWrapper:
+        sender._menuItemCallbackWrappers = []
+    for item in items:
+        if isinstance(item, NSMenuItem):
+            menu.addItem_(item)
+        elif item == "----":
+            item = NSMenuItem.separatorItem()
+            menu.addItem_(item)
+        else:
+            title = item["title"]
+            callback = item.get("callback")
+            subItems = item.get("items")
+            image = item.get("image")
+            state = item.get("state")
+            enabled = item.get("enabled")
+
+            menuItem = NSMenuItem.alloc().initWithTitle_action_keyEquivalent_(title, "", "")
+            if callback:
+                wrapper = VanillaCallbackWrapper(callback)
+                sender._menuItemCallbackWrappers.append(wrapper)
+                menuItem.setTarget_(wrapper)
+                menuItem.setAction_("action:")
+            if subItems:
+                subMenu = NSMenu.alloc().init()
+                VanillaMenuBuilder(sender, subItems, subMenu, resetCallbackWrapper=False)
+                menuItem.setSubmenu_(subMenu)
+
+            if image is not None:
+                menuItem.setImage_(image)
+            if state is not None:
+                menuItem.setState_(state)
+            if enabled is not None:
+                menuItem.setEnabled_(enabled)
+
+            menu.addItem_(menuItem)