feat: add visible-on-all-workspaces-changed event

codebytere · codebytere · commit c2521c570f0e · 2020-07-09T09:49:52.000-07:00
diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md
@@ -580,6 +580,15 @@ Returns:
 
 Emitted when the window is set or unset to show always on top of other windows.
 
+#### Event: 'visible-on-all-workspaces-changed'
+
+Returns:
+
+* `event` Event
+* `isVisibleOnAllWorkspaces` Boolean
+
+Emitted when a window is set or unset to be visible on all workspaces.
+
 #### Event: 'app-command' _Windows_ _Linux_
 
 Returns:
diff --git a/shell/browser/api/electron_api_base_window.cc b/shell/browser/api/electron_api_base_window.cc
@@ -280,6 +280,10 @@ void BaseWindow::OnWindowAlwaysOnTopChanged() {
   Emit("always-on-top-changed", IsAlwaysOnTop());
 }
 
+void BaseWindow::OnWindowVisibleOnAllWorkspacesChanged() {
+  Emit("visible-on-all-workspaces-changed", IsVisibleOnAllWorkspaces());
+}
+
 void BaseWindow::OnExecuteAppCommand(const std::string& command_name) {
   Emit("app-command", command_name);
 }
diff --git a/shell/browser/api/electron_api_base_window.h b/shell/browser/api/electron_api_base_window.h
@@ -78,6 +78,7 @@ class BaseWindow : public gin_helper::TrackableObject<BaseWindow>,
   void OnWindowEnterHtmlFullScreen() override;
   void OnWindowLeaveHtmlFullScreen() override;
   void OnWindowAlwaysOnTopChanged() override;
+  void OnWindowVisibleOnAllWorkspacesChanged() override;
   void OnExecuteAppCommand(const std::string& command_name) override;
   void OnTouchBarItemResult(const std::string& item_id,
                             const base::DictionaryValue& details) override;
diff --git a/shell/browser/native_window.cc b/shell/browser/native_window.cc
@@ -556,6 +556,11 @@ void NativeWindow::NotifyWindowAlwaysOnTopChanged() {
     observer.OnWindowAlwaysOnTopChanged();
 }
 
+void NativeWindow::NotifyWindowVisibleOnAllWorkspacesChanged() {
+  for (NativeWindowObserver& observer : observers_)
+    observer.OnWindowVisibleOnAllWorkspacesChanged();
+}
+
 void NativeWindow::NotifyWindowExecuteAppCommand(const std::string& command) {
   for (NativeWindowObserver& observer : observers_)
     observer.OnExecuteAppCommand(command);
diff --git a/shell/browser/native_window.h b/shell/browser/native_window.h
@@ -280,6 +280,7 @@ class NativeWindow : public base::SupportsUserData,
   void NotifyWindowEnterHtmlFullScreen();
   void NotifyWindowLeaveHtmlFullScreen();
   void NotifyWindowAlwaysOnTopChanged();
+  void NotifyWindowVisibleOnAllWorkspacesChanged();
   void NotifyWindowExecuteAppCommand(const std::string& command);
   void NotifyTouchBarItemInteraction(const std::string& item_id,
                                      const base::DictionaryValue& details);
diff --git a/shell/browser/native_window_mac.mm b/shell/browser/native_window_mac.mm
@@ -1353,6 +1353,8 @@ void ViewDidMoveToSuperview(NSView* self, SEL _cmd) {
 
 void NativeWindowMac::SetVisibleOnAllWorkspaces(bool visible) {
   SetCollectionBehavior(visible, NSWindowCollectionBehaviorCanJoinAllSpaces);
+
+  NativeWindow::NotifyWindowVisibleOnAllWorkspacesChanged();
 }
 
 bool NativeWindowMac::IsVisibleOnAllWorkspaces() {
diff --git a/shell/browser/native_window_observer.h b/shell/browser/native_window_observer.h
@@ -89,6 +89,7 @@ class NativeWindowObserver : public base::CheckedObserver {
   virtual void OnWindowEnterHtmlFullScreen() {}
   virtual void OnWindowLeaveHtmlFullScreen() {}
   virtual void OnWindowAlwaysOnTopChanged() {}
+  virtual void OnWindowVisibleOnAllWorkspacesChanged() {}
   virtual void OnTouchBarItemResult(const std::string& item_id,
                                     const base::DictionaryValue& details) {}
   virtual void OnNewWindowForTab() {}
diff --git a/shell/browser/native_window_views.cc b/shell/browser/native_window_views.cc
@@ -1145,6 +1145,8 @@ bool NativeWindowViews::IsMenuBarVisible() {
 
 void NativeWindowViews::SetVisibleOnAllWorkspaces(bool visible) {
   widget()->SetVisibleOnAllWorkspaces(visible);
+
+  NativeWindow::NotifyWindowVisibleOnAllWorkspacesChanged();
 }
 
 bool NativeWindowViews::IsVisibleOnAllWorkspaces() {
diff --git a/spec-main/api-browser-window-spec.ts b/spec-main/api-browser-window-spec.ts
@@ -3550,6 +3550,15 @@ describe('BrowserWindow module', () => {
           expect(w.isVisibleOnAllWorkspaces()).to.be.true();
         });
       });
+
+      ifit(process.platform !== 'win32')('emits an event when the visibleOnAllWorkspaces state changes', async () => {
+        const w = new BrowserWindow({ show: false });
+        const visibleOnAllWorkspacesEvent = emittedOnce(w, 'visible-on-all-workspaces-changed');
+        expect(w.visibleOnAllWorkspaces).to.be.false();
+        w.visibleOnAllWorkspaces = true;
+        const [, visibleOnAllWorkspaces] = await visibleOnAllWorkspacesEvent;
+        expect(visibleOnAllWorkspaces).to.be.true();
+      });
     });
 
     ifdescribe(process.platform === 'darwin')('documentEdited state', () => {

Original file line number	Diff line number	Diff line change
`@@ -280,6 +280,10 @@ void BaseWindow::OnWindowAlwaysOnTopChanged() {`
`280`	`280`	`Emit("always-on-top-changed", IsAlwaysOnTop());`
`281`	`281`	`}`
`282`	`282`
	`283`	`+void BaseWindow::OnWindowVisibleOnAllWorkspacesChanged() {`
	`284`	`+ Emit("visible-on-all-workspaces-changed", IsVisibleOnAllWorkspaces());`
	`285`	`+}`
	`286`	`+`
`283`	`287`	`void BaseWindow::OnExecuteAppCommand(const std::string& command_name) {`
`284`	`288`	`Emit("app-command", command_name);`
`285`	`289`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1353,6 +1353,8 @@ void ViewDidMoveToSuperview(NSView* self, SEL _cmd) {`
`1353`	`1353`
`1354`	`1354`	`void NativeWindowMac::SetVisibleOnAllWorkspaces(bool visible) {`
`1355`	`1355`	`SetCollectionBehavior(visible, NSWindowCollectionBehaviorCanJoinAllSpaces);`
	`1356`	`+`
	`1357`	`+ NativeWindow::NotifyWindowVisibleOnAllWorkspacesChanged();`
`1356`	`1358`	`}`
`1357`	`1359`
`1358`	`1360`	`bool NativeWindowMac::IsVisibleOnAllWorkspaces() {`
Original file line number	Diff line number	Diff line change
`@@ -1145,6 +1145,8 @@ bool NativeWindowViews::IsMenuBarVisible() {`
`1145`	`1145`
`1146`	`1146`	`void NativeWindowViews::SetVisibleOnAllWorkspaces(bool visible) {`
`1147`	`1147`	`widget()->SetVisibleOnAllWorkspaces(visible);`
	`1148`	`+`
	`1149`	`+ NativeWindow::NotifyWindowVisibleOnAllWorkspacesChanged();`
`1148`	`1150`	`}`
`1149`	`1151`
`1150`	`1152`	`bool NativeWindowViews::IsVisibleOnAllWorkspaces() {`