feat: add tray.removeBalloon() (#19547)

electron · Aug 5, 2019 · ee674ac · ee674ac
1 parent 8f043bb
commit ee674ac
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 0 deletions.
diff --git a/docs/api/tray.md b/docs/api/tray.md
@@ -228,6 +228,10 @@ Returns `Boolean` - Whether double click events will be ignored.
 
 Displays a tray balloon.
 
+#### `tray.removeBalloon()` _Windows_
+
+Removes a tray balloon.
+
 #### `tray.popUpContextMenu([menu, position])` _macOS_ _Windows_
 
 * `menu` Menu (optional)

diff --git a/shell/browser/api/atom_api_tray.cc b/shell/browser/api/atom_api_tray.cc
@@ -175,6 +175,10 @@ void Tray::DisplayBalloon(mate::Arguments* args,
 #endif
 }
 
+void Tray::RemoveBalloon() {
+  tray_icon_->RemoveBalloon();
+}
+
 void Tray::PopUpContextMenu(mate::Arguments* args) {
   mate::Handle<Menu> menu;
   args->GetNext(&menu);
@@ -208,6 +212,7 @@ void Tray::BuildPrototype(v8::Isolate* isolate,
       .SetMethod("getIgnoreDoubleClickEvents",
                  &Tray::GetIgnoreDoubleClickEvents)
       .SetMethod("displayBalloon", &Tray::DisplayBalloon)
+      .SetMethod("removeBalloon", &Tray::RemoveBalloon)
       .SetMethod("popUpContextMenu", &Tray::PopUpContextMenu)
       .SetMethod("setContextMenu", &Tray::SetContextMenu)
       .SetMethod("getBounds", &Tray::GetBounds);

diff --git a/shell/browser/api/atom_api_tray.h b/shell/browser/api/atom_api_tray.h
@@ -73,6 +73,7 @@ class Tray : public mate::TrackableObject<Tray>, public TrayIconObserver {
   void SetIgnoreDoubleClickEvents(bool ignore);
   bool GetIgnoreDoubleClickEvents();
   void DisplayBalloon(mate::Arguments* args, const mate::Dictionary& options);
+  void RemoveBalloon();
   void PopUpContextMenu(mate::Arguments* args);
   void SetContextMenu(v8::Isolate* isolate, mate::Handle<Menu> menu);
   gfx::Rect GetBounds();

diff --git a/shell/browser/ui/tray_icon.cc b/shell/browser/ui/tray_icon.cc
@@ -16,6 +16,8 @@ void TrayIcon::DisplayBalloon(ImageType icon,
                               const base::string16& title,
                               const base::string16& contents) {}
 
+void TrayIcon::RemoveBalloon() {}
+
 void TrayIcon::PopUpContextMenu(const gfx::Point& pos,
                                 AtomMenuModel* menu_model) {}
 

diff --git a/shell/browser/ui/tray_icon.h b/shell/browser/ui/tray_icon.h
@@ -55,6 +55,9 @@ class TrayIcon {
                               const base::string16& title,
                               const base::string16& contents);
 
+  // Removes the notification balloon.
+  virtual void RemoveBalloon();
+
   // Popups the menu.
   virtual void PopUpContextMenu(const gfx::Point& pos,
                                 AtomMenuModel* menu_model);

diff --git a/shell/browser/ui/win/notify_icon.cc b/shell/browser/ui/win/notify_icon.cc
@@ -138,6 +138,16 @@ void NotifyIcon::DisplayBalloon(HICON icon,
     LOG(WARNING) << "Unable to create status tray balloon.";
 }
 
+void NotifyIcon::RemoveBalloon() {
+  NOTIFYICONDATA icon_data;
+  InitIconData(&icon_data);
+  icon_data.uFlags |= NIF_INFO;
+
+  BOOL result = Shell_NotifyIcon(NIM_MODIFY, &icon_data);
+  if (!result)
+    LOG(WARNING) << "Unable to remove status tray balloon.";
+}
+
 void NotifyIcon::PopUpContextMenu(const gfx::Point& pos,
                                   AtomMenuModel* menu_model) {
   // Returns if context menu isn't set.

diff --git a/shell/browser/ui/win/notify_icon.h b/shell/browser/ui/win/notify_icon.h
@@ -61,6 +61,7 @@ class NotifyIcon : public TrayIcon {
   void DisplayBalloon(HICON icon,
                       const base::string16& title,
                       const base::string16& contents) override;
+  void RemoveBalloon() override;
   void PopUpContextMenu(const gfx::Point& pos,
                         AtomMenuModel* menu_model) override;
   void SetContextMenu(AtomMenuModel* menu_model) override;