[OSX] Add iconIsTemplate property to MenuItem API objects

mrfabbri · mrfabbri · commit 0b3fda020606 · 2014-12-09T16:46:52.000+01:00
Add boolean property (defaults to `true`) `iconsIsTemplate` to `MenuItem` objects to allow for proper display of icons in Mac OS X (Yosemite) Dark Menus. When `iconsIsTemplate` is set to true, the `icon` is treated as a "template" and the system automatically ensures proper styling according to the various states of the menu item (e.g. dark menu, light menu, etc.). Template images should consist only of black and clear colours and can use the alpha channel in the image to adjust the opacity of black content. See [Dark Menus in AppKit Release Notes for OS X v10.10](https://developer.apple.com/library/mac/releasenotes/AppKit/RN-AppKit/#10_10DarkMenus) and [`NSImage setTemplate:`](https://developer.apple.com/library/mac/documentation/Cocoa/Reference/ApplicationKit/Classes/NSImage_Class/index.html#//apple_ref/occ/instm/NSImage/setTemplate:). On Linux and Windows setting the property has no effect. FIX nwjs#2773
diff --git a/src/api/menuitem/menuitem.cc b/src/api/menuitem/menuitem.cc
@@ -50,6 +50,10 @@ void MenuItem::Call(const std::string& method,
     std::string icon;
     arguments.GetString(0, &icon);
     SetIcon(icon);
+  } else if (method == "SetIconIsTemplate") {
+    bool isTemplate;
+    arguments.GetBoolean(0, &isTemplate);
+    SetIconIsTemplate(isTemplate);
   } else if (method == "SetTooltip") {
     std::string tooltip;
     arguments.GetString(0, &tooltip);
diff --git a/src/api/menuitem/menuitem.h b/src/api/menuitem/menuitem.h
@@ -82,11 +82,15 @@ class MenuItem : public Base {
   void SetChecked(bool checked);
   void SetSubmenu(Menu* sub_menu);
 
+  // Template icon works only on Mac OS X
+  void SetIconIsTemplate(bool isTemplate);
+
 #if defined(OS_MACOSX)
   std::string type_;
 
   NSMenuItem* menu_item_;
   MenuItemDelegate* delegate_;
+  bool iconIsTemplate;
 
 #elif defined(OS_WIN) || defined(OS_LINUX)
   friend class MenuDelegate;
diff --git a/src/api/menuitem/menuitem.js b/src/api/menuitem/menuitem.js
@@ -46,6 +46,11 @@ function MenuItem(option) {
       option.icon = nw.getAbsolutePath(option.icon);
     }
 
+    if (option.hasOwnProperty('iconIsTemplate'))
+      option.iconIsTemplate = Boolean(option.iconIsTemplate);
+    else
+      option.iconIsTemplate = true;
+
     if (option.hasOwnProperty('tooltip'))
       option.tooltip = String(option.tooltip);
 
@@ -116,6 +121,14 @@ MenuItem.prototype.__defineSetter__('icon', function(val) {
   this.handleSetter('icon', 'SetIcon', String, real_path);
 });
 
+MenuItem.prototype.__defineGetter__('iconIsTemplate', function() {
+  return this.handleGetter('iconIsTemplate');
+});
+
+MenuItem.prototype.__defineSetter__('iconIsTemplate', function(val) {
+  this.handleSetter('iconIsTemplate', 'SetIconIsTemplate', Boolean, val);
+});
+
 MenuItem.prototype.__defineGetter__('tooltip', function() {
   return this.handleGetter('tooltip');
 });
diff --git a/src/api/menuitem/menuitem_gtk.cc b/src/api/menuitem/menuitem_gtk.cc
@@ -124,6 +124,9 @@ void MenuItem::SetIcon(const std::string& icon) {
   }
 }
 
+void MenuItem::SetIconIsTemplate(bool isTemplate) {
+}
+
 void MenuItem::SetTooltip(const std::string& tooltip) {
   gtk_widget_set_tooltip_text(menu_item_, tooltip.c_str());
 }
diff --git a/src/api/menuitem/menuitem_mac.mm b/src/api/menuitem/menuitem_mac.mm
@@ -71,6 +71,10 @@
     if (option.GetBoolean("enabled", &enabled))
       SetEnabled(enabled);
 
+    bool isTemplate;
+    if (option.GetBoolean("iconIsTemplate", &isTemplate))
+      SetIconIsTemplate(isTemplate);
+
     std::string icon;
     if (option.GetString("icon", &icon) && !icon.empty())
       SetIcon(icon);
@@ -131,13 +135,20 @@
   if (!icon.empty()) {
     NSImage* image = [[NSImage alloc]
          initWithContentsOfFile:[NSString stringWithUTF8String:icon.c_str()]];
+    [image setTemplate:iconIsTemplate];
     [menu_item_ setImage:image];
     [image release];
   } else {
     [menu_item_ setImage:nil];
   }
 }
 
+void MenuItem::SetIconIsTemplate(bool isTemplate) {
+  iconIsTemplate = isTemplate;
+  if ([menu_item_ image] != nil)
+    [[menu_item_ image] setTemplate:isTemplate];
+}
+
 void MenuItem::SetTooltip(const std::string& tooltip) {
   [menu_item_ setToolTip:[NSString stringWithUTF8String:tooltip.c_str()]];
 }
diff --git a/src/api/menuitem/menuitem_views.cc b/src/api/menuitem/menuitem_views.cc
@@ -134,6 +134,9 @@ void MenuItem::SetIcon(const std::string& icon) {
   package->GetImage(base::FilePath::FromUTF8Unsafe(icon), &icon_);
 }
 
+void MenuItem::SetIconIsTemplate(bool isTemplate) {
+}
+
 void MenuItem::SetTooltip(const std::string& tooltip) {
   tooltip_ = base::UTF8ToUTF16(tooltip);
   if (menu_)

Original file line number	Diff line number	Diff line change
`@@ -124,6 +124,9 @@ void MenuItem::SetIcon(const std::string& icon) {`
`124`	`124`	`}`
`125`	`125`	`}`
`126`	`126`
	`127`	`+void MenuItem::SetIconIsTemplate(bool isTemplate) {`
	`128`	`+}`
	`129`	`+`
`127`	`130`	`void MenuItem::SetTooltip(const std::string& tooltip) {`
`128`	`131`	`gtk_widget_set_tooltip_text(menu_item_, tooltip.c_str());`
`129`	`132`	`}`
Original file line number	Diff line number	Diff line change
`@@ -134,6 +134,9 @@ void MenuItem::SetIcon(const std::string& icon) {`
`134`	`134`	`package->GetImage(base::FilePath::FromUTF8Unsafe(icon), &icon_);`
`135`	`135`	`}`
`136`	`136`
	`137`	`+void MenuItem::SetIconIsTemplate(bool isTemplate) {`
	`138`	`+}`
	`139`	`+`
`137`	`140`	`void MenuItem::SetTooltip(const std::string& tooltip) {`
`138`	`141`	`tooltip_ = base::UTF8ToUTF16(tooltip);`
`139`	`142`	`if (menu_)`