Menu for the OSX app launcher.

ui/app_list/cocoa/app_list_menu_cocoa.mm

+// Copyright 2013 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#import "ui/app_list/cocoa/app_list_menu_cocoa.h"
+
+#include "base/logging.h"
+#include "base/strings/sys_string_conversions.h"
+#include "grit/ui_resources.h"
+#include "ui/app_list/app_list_view_delegate.h"
+#include "ui/base/resource/resource_bundle.h"
+
+namespace {
+
+// Padding either side of the user indicator icon. This should be the same as
+// the horizontal padding OSX puts around menu items, to ensure layout is even.
+const CGFloat kIndicatorIconPadding = 2;
+
+}
+
+// A custom NSPopUpButtonCell that permits a hover image, and draws only an
+// image in its frame; no border, bezel or drop-down arrow.
+@interface AppListMenuCocoaCell : NSPopUpButtonCell {

[sail, 2013/05/31 01:20:16]

How about moving this to ui/base/cocoa and making it a HoverImageButton subclass
instead. Similar to MenuButton from Chrome.

[tapted, 2013/05/31 06:05:13]

I tried using HoverImageButton, and incorporating relevant bits from MenuButton
(code here:
https://codereview.chromium.org/15814009/diff2/1:4002/ui/app_list/cocoa/app_l...
). MenuButton in c/b/ui essentially "hacks" [sic] in parts of NSPopUpButton to
achieve its results, so it becomes a bit messy.

Ultimately, I couldn't figure out how to get HoverImageButton from ui/base to do
what's needed anyway. The problem is that the button comes "up" as soon as the
mouse button is released or leaves the button area, but we want it to stay
"down" until the menu is dismissed. Using NSPopUpButton directly rather than
hacking it in does this job nicely, while also dealing with the other menu-isms
like dragging to select an item.

Adapting NSPopUpButtonCell to handle hover currently feels like the lesser evil,
but maybe I've missed something..

[Robert Sesek, 2013/05/31 18:25:35]

I think this is because HoverButton isn't examining the -[NSButton state]. If it
did that to check if it's on the OnState rather than the mouseDown/Up flags it
currently sets, this may work.

+ @private
+  NSImage* hoverImage_;
+  BOOL hovered_;
+}
+
+@property(retain, nonatomic) NSImage* hoverImage;
+@property(assign, nonatomic) BOOL hovered;
+
+@end
+
+// The first item in the menu is the current user indicator. It shows a static
+// icon in the margin, the profile name, and the signed-in email address.
+@interface CurrentUserMenuItemView : NSView;

[sail, 2013/05/31 01:20:16]

Can we just use a normal menu item and set it's icon?

[tapted, 2013/05/31 06:05:13]

I gave this a go too, using an attributed string (code here:
https://codereview.chromium.org/16156004/diff2/1:2001/ui/app_list/cocoa/app_l...
). This is the closest I could get it:

http://i.imgur.com/WLOHBGp.png

I couldn't figure out a way to get the icon in the margin, or to line things up
in some other way. I tried setIndentationLevel: but it needs levels of ~1.5 or
"-1" to line up properly, which are not valid.

This custom view gets pretty close (ref: http://i.imgur.com/7nHVuOp.png ). The
views implementation is using a custom view as well, so this is at least
consistent.

However, the exercise did clue me in to a subtle font-rendering bug I had :)
(fixed in patchset 2; before the class rename/file move).

+
+- (id)initWithDelegate:(app_list::AppListViewDelegate*)delegate;
+
+- (NSTextField*)addLabelWithFrame:(NSRect)frame
+                        labelText:(const string16&)labelText;
+
+@end
+
+@implementation AppListMenuCocoa
+
++ (NSView*)makeCurrentUserView:(app_list::AppListViewDelegate*)delegate {
+  scoped_nsobject<CurrentUserMenuItemView> itemView(
+      [[CurrentUserMenuItemView alloc] initWithDelegate:delegate]);
+  return itemView.autorelease();
+}
+
++ (Class)cellClass {
+  return [AppListMenuCocoaCell class];
+}
+
+- (id)initWithFrame:(NSRect)frameRect {
+  if ((self = [super initWithFrame:frameRect
+                         pullsDown:YES])) {
+    trackingArea_.reset(
+        [[CrTrackingArea alloc] initWithRect:NSZeroRect
+                                     options:NSTrackingInVisibleRect |
+                                             NSTrackingMouseEnteredAndExited |
+                                             NSTrackingActiveInKeyWindow
+                                       owner:self
+                                    userInfo:nil]);
+    [self addTrackingArea:trackingArea_.get()];
+
+    [[self cell] setUsesItemFromMenu:NO];
+
+    ui::ResourceBundle& rb = ui::ResourceBundle::GetSharedInstance();
+    scoped_nsobject<NSMenuItem> buttonItem([[NSMenuItem alloc] init]);
+    [buttonItem setImage:rb.GetNativeImageNamed(
+        IDR_APP_LIST_TOOLS_NORMAL).AsNSImage()];
+    [[self cell] setMenuItem:buttonItem];
+
+    [[self cell] setAlternateImage:rb.GetNativeImageNamed(
+        IDR_APP_LIST_TOOLS_PRESSED).AsNSImage()];
+    [[self cell] setHoverImage:rb.GetNativeImageNamed(
+        IDR_APP_LIST_TOOLS_HOVER).AsNSImage()];
+  }
+  return self;
+}
+
+- (void)mouseEntered:(NSEvent*)theEvent {
+  [[self cell] setHovered:YES];
+  [self setNeedsDisplay:YES];
+}
+
+- (void)mouseExited:(NSEvent*)theEvent {
+  [[self cell] setHovered:NO];
+  [self setNeedsDisplay:YES];
+}
+
+@end
+
+@implementation AppListMenuCocoaCell
+
+@synthesize hoverImage = hoverImage_;
+@synthesize hovered = hovered_;
+
+- (void)drawWithFrame:(NSRect)cellFrame
+               inView:(NSView*)controlView {
+  NSImage* image = [self isHighlighted] ?
+      [self alternateImage] :
+      (hovered_ ? [self hoverImage] : [self image]);
+  [image drawInRect:cellFrame
+           fromRect:NSZeroRect
+          operation:NSCompositeSourceOver
+           fraction:1.0
+     respectFlipped:YES
+              hints:nil];
+}
+
+@end
+
+@implementation CurrentUserMenuItemView
+
+// Adds a text label in the custom view in the menu showing the current user.
+- (NSTextField*)addLabelWithFrame:(NSRect)frame
+                        labelText:(const string16&)labelText {
+  scoped_nsobject<NSTextField> label([[NSTextField alloc] initWithFrame:frame]);
+  [label setStringValue:base::SysUTF16ToNSString(labelText)];
+  [label setEditable:NO];
+  [label setBordered:NO];
+  [label sizeToFit];
+  [self addSubview:label];
+  return label.autorelease();
+}
+
+- (id)initWithDelegate:(app_list::AppListViewDelegate*)delegate {
+  DCHECK(delegate);
+  if ((self = [super initWithFrame:NSZeroRect])) {
+    scoped_nsobject<NSImageView> userIndicator(
+        [[NSImageView alloc] initWithFrame:NSZeroRect]);
+    NSImage* indicatorIcon = ui::ResourceBundle::GetSharedInstance().
+        GetNativeImageNamed(IDR_APP_LIST_USER_INDICATOR).AsNSImage();
+    [userIndicator setImage:indicatorIcon];
+    NSRect imageRect = NSZeroRect;
+    imageRect.size = [indicatorIcon size];
+    imageRect =
+        NSInsetRect(imageRect, -kIndicatorIconPadding, -kIndicatorIconPadding);
+
+    NSRect labelFrame = NSMakeRect(NSWidth(imageRect), 0, 0, 0);
+    NSTextField* emailField =
+        [self addLabelWithFrame:labelFrame
+                      labelText:delegate->GetCurrentUserEmail()];
+    [emailField setEnabled:NO];
+
+    labelFrame.origin.y = NSMaxY([emailField frame]);
+    NSTextField* userField =
+        [self addLabelWithFrame:labelFrame
+                      labelText:delegate->GetCurrentUserName()];
+
+    // Size the container view to fit, and ensure the longest label appears
+    // centered (if it is the longest item in the menu).
+    NSRect viewRect = NSUnionRect([emailField frame], [userField frame]);
+    viewRect.size.width += NSMinX(viewRect) - kIndicatorIconPadding;
+    viewRect = NSUnionRect(viewRect, imageRect);
+    [self setFrameSize:viewRect.size];
+
+    // Align the user indicator icon with the top of the view.
+    imageRect.origin.y = NSHeight(viewRect) - NSHeight(imageRect);
+    imageRect.origin.x = kIndicatorIconPadding;
+    [userIndicator setFrame:imageRect];
+    [self addSubview:userIndicator];
+  }
+  return self;
+}
+
+@end