feat: migrate custom macOS tray view to native one (electron#18981)

Micha Hanselmann · MarshallOfSound · commit 47a38daee20e · 2019-07-31T10:52:50.000-07:00
* restore stash revert some things work others dont tracking area for rescue manual popup restore drag n drop cleanup * fix: make tray not block main process (electron#18880) * fix: make tray not block main process * make AtomMenuModel refcounted * add support for ansi codes in title add remove TODOs * chore: use ScopedPumpMessagesInPrivateModes in tray (electron#18977) * chore: use ScopedPumpMessagesInPrivateModes in tray * revert refcounting of AtomMenuModel * Prefer WeakPtr for posting tasks to handle unexpected destruction * cleanup .h * cleanup .mm * add imports add missing include * fix: crash when tray popup called twice (electron#18999) * remove highlightMode and TODOs * remove unnecessary copy
diff --git a/docs/api/tray.md b/docs/api/tray.md
@@ -206,39 +206,6 @@ Sets the title displayed next to the tray icon in the status bar (Support ANSI c
 
 Returns `String` - the title displayed next to the tray icon in the status bar
 
-#### `tray.setHighlightMode(mode)` _macOS_
-
-* `mode` String - Highlight mode with one of the following values:
-  * `selection` - Highlight the tray icon when it is clicked and also when
-    its context menu is open. This is the default.
-  * `always` - Always highlight the tray icon.
-  * `never` - Never highlight the tray icon.
-
-Sets when the tray's icon background becomes highlighted (in blue).
-
-**[Deprecated](breaking-changes.md#tray)**
-
-**Note:** You can use `highlightMode` with a [`BrowserWindow`](browser-window.md)
-by toggling between `'never'` and `'always'` modes when the window visibility
-changes.
-
-```javascript
-const { BrowserWindow, Tray } = require('electron')
-
-const win = new BrowserWindow({ width: 800, height: 600 })
-const tray = new Tray('/path/to/my/icon')
-
-tray.on('click', () => {
-  win.isVisible() ? win.hide() : win.show()
-})
-win.on('show', () => {
-  tray.setHighlightMode('always')
-})
-win.on('hide', () => {
-  tray.setHighlightMode('never')
-})
-```
-
 #### `tray.setIgnoreDoubleClickEvents(ignore)` _macOS_
 
 * `ignore` Boolean
diff --git a/lib/browser/api/tray.js b/lib/browser/api/tray.js
@@ -6,7 +6,4 @@ const { Tray } = process.electronBinding('tray')
 
 Object.setPrototypeOf(Tray.prototype, EventEmitter.prototype)
 
-// Deprecations
-Tray.prototype.setHighlightMode = deprecate.removeFunction(Tray.prototype.setHighlightMode, 'setHighlightMode')
-
 module.exports = Tray
diff --git a/shell/browser/api/atom_api_tray.cc b/shell/browser/api/atom_api_tray.cc
@@ -18,34 +18,6 @@
 #include "shell/common/node_includes.h"
 #include "ui/gfx/image/image.h"
 
-namespace mate {
-
-template <>
-struct Converter<electron::TrayIcon::HighlightMode> {
-  static bool FromV8(v8::Isolate* isolate,
-                     v8::Local<v8::Value> val,
-                     electron::TrayIcon::HighlightMode* out) {
-    using HighlightMode = electron::TrayIcon::HighlightMode;
-    std::string mode;
-    if (ConvertFromV8(isolate, val, &mode)) {
-      if (mode == "always") {
-        *out = HighlightMode::ALWAYS;
-        return true;
-      }
-      if (mode == "selection") {
-        *out = HighlightMode::SELECTION;
-        return true;
-      }
-      if (mode == "never") {
-        *out = HighlightMode::NEVER;
-        return true;
-      }
-    }
-    return false;
-  }
-};
-}  // namespace mate
-
 namespace electron {
 
 namespace api {
@@ -169,10 +141,6 @@ std::string Tray::GetTitle() {
 #endif
 }
 
-void Tray::SetHighlightMode(TrayIcon::HighlightMode mode) {
-  tray_icon_->SetHighlightMode(mode);
-}
-
 void Tray::SetIgnoreDoubleClickEvents(bool ignore) {
 #if defined(OS_MACOSX)
   tray_icon_->SetIgnoreDoubleClickEvents(ignore);
@@ -235,7 +203,6 @@ void Tray::BuildPrototype(v8::Isolate* isolate,
       .SetMethod("setToolTip", &Tray::SetToolTip)
       .SetMethod("setTitle", &Tray::SetTitle)
       .SetMethod("getTitle", &Tray::GetTitle)
-      .SetMethod("setHighlightMode", &Tray::SetHighlightMode)
       .SetMethod("setIgnoreDoubleClickEvents",
                  &Tray::SetIgnoreDoubleClickEvents)
       .SetMethod("getIgnoreDoubleClickEvents",
diff --git a/shell/browser/api/atom_api_tray.h b/shell/browser/api/atom_api_tray.h
@@ -70,7 +70,6 @@ class Tray : public mate::TrackableObject<Tray>, public TrayIconObserver {
   void SetToolTip(const std::string& tool_tip);
   void SetTitle(const std::string& title);
   std::string GetTitle();
-  void SetHighlightMode(TrayIcon::HighlightMode mode);
   void SetIgnoreDoubleClickEvents(bool ignore);
   bool GetIgnoreDoubleClickEvents();
   void DisplayBalloon(mate::Arguments* args, const mate::Dictionary& options);
diff --git a/shell/browser/ui/tray_icon.cc b/shell/browser/ui/tray_icon.cc
@@ -12,8 +12,6 @@ TrayIcon::~TrayIcon() {}
 
 void TrayIcon::SetPressedImage(ImageType image) {}
 
-void TrayIcon::SetHighlightMode(TrayIcon::HighlightMode mode) {}
-
 void TrayIcon::DisplayBalloon(ImageType icon,
                               const base::string16& title,
                               const base::string16& contents) {}
diff --git a/shell/browser/ui/tray_icon.h b/shell/browser/ui/tray_icon.h
@@ -39,14 +39,6 @@ class TrayIcon {
   // status icon (e.g. Ubuntu Unity).
   virtual void SetToolTip(const std::string& tool_tip) = 0;
 
-  // Sets the status icon highlight mode. This only works on macOS.
-  enum class HighlightMode {
-    ALWAYS,    // Always highlight the tray icon
-    NEVER,     // Never highlight the tray icon
-    SELECTION  // Highlight the tray icon when clicked or the menu is opened
-  };
-  virtual void SetHighlightMode(HighlightMode mode);
-
 #if defined(OS_MACOSX)
   // Set/Get flag determining whether to ignore double click events.
   virtual void SetIgnoreDoubleClickEvents(bool ignore) = 0;
diff --git a/shell/browser/ui/tray_icon_cocoa.h b/shell/browser/ui/tray_icon_cocoa.h
@@ -17,7 +17,7 @@
 
 namespace electron {
 
-class TrayIconCocoa : public TrayIcon, public AtomMenuModel::Observer {
+class TrayIconCocoa : public TrayIcon {
  public:
   TrayIconCocoa();
   ~TrayIconCocoa() override;
@@ -27,7 +27,6 @@ class TrayIconCocoa : public TrayIcon, public AtomMenuModel::Observer {
   void SetToolTip(const std::string& tool_tip) override;
   void SetTitle(const std::string& title) override;
   std::string GetTitle() override;
-  void SetHighlightMode(TrayIcon::HighlightMode mode) override;
   void SetIgnoreDoubleClickEvents(bool ignore) override;
   bool GetIgnoreDoubleClickEvents() override;
   void PopUpOnUI(AtomMenuModel* menu_model);
@@ -36,20 +35,13 @@ class TrayIconCocoa : public TrayIcon, public AtomMenuModel::Observer {
   void SetContextMenu(AtomMenuModel* menu_model) override;
   gfx::Rect GetBounds() override;
 
- protected:
-  // AtomMenuModel::Observer:
-  void OnMenuWillClose() override;
-
  private:
-  // Atom custom view for NSStatusItem.
+  // Electron custom view for NSStatusItem.
   base::scoped_nsobject<StatusItemView> status_item_view_;
 
   // Status menu shown when right-clicking the system icon.
   base::scoped_nsobject<AtomMenuController> menu_;
 
-  // Used for unregistering observer.
-  AtomMenuModel* menu_model_ = nullptr;  // weak ref.
-
   base::WeakPtrFactory<TrayIconCocoa> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(TrayIconCocoa);
diff --git a/shell/browser/ui/tray_icon_cocoa.mm b/shell/browser/ui/tray_icon_cocoa.mm
