如何在 NSMenuItem 内绘制内联样式标签（或按钮）

Posted 2023-04-18

【中文标题】如何在 NSMenuItem 内绘制内联样式标签（或按钮）

【英文标题】：How to draw an inline style label (or button) inside NSMenuItem

【发布时间】：2014-12-20 07:40:12

【问题描述】：

当 App Store 有更新时，它会在菜单项中显示一个内联样式元素，如以下屏幕截图中的“1 new”：

我们可以看到这种菜单的另一个地方是 10.10 Yosemite 的分享菜单。当您安装任何添加新共享扩展的应用时，共享菜单中的“更多”项将显示“N new”，就像应用商店菜单一样。

“App Store...”项目看起来是普通的NSMenuItem。是否有一种简单的方法来实现这一点，或者是否有任何 API 支持它而不为菜单项设置自定义视图？

【问题讨论】：

+1。也在寻找答案。看起来您可以设置 NSView 以代替常规 NSMenuItem 标题显示。但这不是我所说的“简单”的方式。

@mileusna 我还没有从答案中尝试过 BonzaiThePenguin 的解决方案，这可能效果很好。

【参考方案1】：

“Cocoa”NSMenus 实际上完全建立在 Carbon 之上，因此虽然 Cocoa API 没有公开太多功能，但您可以深入到 Carbon 领域并获得更多功能。无论如何，这就是 Apple 所做的——Apple 菜单项是 IBCarbonMenuItem 的子类，如下所示：

/System/Library/Frameworks/Carbon.framework/Versions/A/Frameworks/HIToolbox.framework/Versions/A/Resources/English.lproj/StandardMenus.nib/objects.xib

不幸的是，64 位 Carbon API 似乎充满了错误和缺失的功能，与 32 位版本相比，安装工作绘图处理程序变得更加困难。这是我想出的一个hacky版本：

#import <Carbon/Carbon.h>

OSStatus eventHandler(EventHandlerCallRef inHandlerRef, EventRef inEvent, void *inUserData) 
  OSStatus ret = 0;

  if (GetEventClass(inEvent) == kEventClassMenu) 
    if (GetEventKind(inEvent) == kEventMenuDrawItem) 
      // draw the standard menu stuff
      ret = CallNextEventHandler(inHandlerRef, inEvent);

      MenuTrackingData tracking_data;
      GetMenuTrackingData(menuRef, &tracking_data);

      MenuItemIndex item_index;
      GetEventParameter(inEvent, kEventParamMenuItemIndex, typeMenuItemIndex, nil, sizeof(item_index), nil, &item_index);

      if (tracking_data.itemSelected == item_index) 
        HIRect item_rect;
        GetEventParameter(inEvent, kEventParamMenuItemBounds, typeHIRect, nil, sizeof(item_rect), nil, &item_rect);

        CGContextRef context;
        GetEventParameter(inEvent, kEventParamCGContextRef, typeCGContextRef, nil, sizeof(context), nil, &context);

        // first REMOVE a state from the graphics stack, instead of pushing onto the stack
        // this is to remove the clipping and translation values that are completely useless without the context height value
        extern void *CGContextCopyTopGState(CGContextRef);
        void *state = CGContextCopyTopGState(context);

        CGContextRestoreGState(context);

        // draw our content on top of the menu item
        CGContextSetRGBFillColor(context, 0.0, 0.0, 0.0, 0.5);
        CGContextFillRect(context, CGRectMake(0, item_rect.origin.y - tracking_data.virtualMenuTop, item_rect.size.width, item_rect.size.height));

        // and push a dummy graphics state onto the stack so the calling function can pop it again and be none the wiser
        CGContextSaveGState(context);
        extern void CGContextReplaceTopGState(CGContextRef, void *);
        CGContextReplaceTopGState(context, state);

        extern void CGGStateRelease(void *);
        CGGStateRelease(state);
      
    
  


- (void)beginTracking:(NSNotification *)notification 
  // install a Carbon event handler to custom draw in the menu
  if (menuRef == nil) 
    extern MenuRef _NSGetCarbonMenu(NSMenu *);
    extern EventTargetRef GetMenuEventTarget(MenuRef);

    menuRef = _NSGetCarbonMenu(menu);
    if (menuRef == nil) return;

    EventTypeSpec events[1];
    events[0].eventClass = kEventClassMenu;
    events[0].eventKind = kEventMenuDrawItem;

    InstallEventHandler(GetMenuEventTarget(menuRef), NewEventHandlerUPP(&eventHandler), GetEventTypeCount(events), events, nil, nil);
  

  if (menuRef != nil) 
    // set the kMenuItemAttrCustomDraw attrib on the menu item
    // this attribute is needed in order to receive the kMenuEventDrawItem event in the Carbon event handler
    extern OSStatus ChangeMenuItemAttributes(MenuRef, MenuItemIndex, MenuItemAttributes, MenuItemAttributes);
    ChangeMenuItemAttributes(menuRef, item_index, kMenuItemAttrCustomDraw, 0);
  


- (void)applicationDidFinishLaunching:(NSNotification *)aNotification 
  menu = [[NSMenu alloc] initWithTitle:@""];

  // register for the BeginTracking notification so we can install our Carbon event handler as soon as the menu is constructed
  [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(beginTracking:) name:NSMenuDidBeginTrackingNotification object:menu];

首先它注册一个 BeginTracking 通知，因为 _NSGetCarbonMenu 仅在菜单构建后返回一个有效句柄，并且在绘制菜单之前调用 BeginTracking。

然后它使用通知回调来获取 Carbon MenuRef 并将标准 Carbon 事件处理程序附加到菜单。

通常我们可以简单地获取kEventParamMenuContextHeight 事件参数并翻转 CGContextRef 并开始绘制，但该参数仅在 32 位模式下可用。 Apple 的文档建议在该值不可用时使用当前端口的高度，但这也仅在 32 位模式下可用。

所以既然给我们的图形状态是无用的，就从堆栈中弹出它，使用之前的图形状态。事实证明，这个新状态被转换为菜单的虚拟顶部，可以使用GetMenuTrackingData.virtualMenuTop 检索。 kEventParamVirtualMenuTop 的值在 64 位模式下也不正确，因此必须使用 GetMenuTrackingData。

这很老套和荒谬，但它比使用 setView 并重新实现整个菜单项行为要好。 OS X 上的菜单 API 有点一团糟。