feat: 'will-move' event for windows. (#14283)

* feat: 'will-resize' window event (Windows only) * documentation for 'will-move' event * comment and line break fix in docs
electron · Aug 28, 2018 · afdb6c5 · afdb6c5
1 parent f1fe485
commit afdb6c5
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 1 deletion.
diff --git a/atom/browser/api/atom_api_top_level_window.cc b/atom/browser/api/atom_api_top_level_window.cc
@@ -205,6 +205,13 @@ void TopLevelWindow::OnWindowResize() {
   Emit("resize");
 }
 
+void TopLevelWindow::OnWindowWillMove(const gfx::Rect& new_bounds,
+                                      bool* prevent_default) {
+  if (Emit("will-move", new_bounds)) {
+    *prevent_default = true;
+  }
+}
+
 void TopLevelWindow::OnWindowMove() {
   Emit("move");
 }

diff --git a/atom/browser/api/atom_api_top_level_window.h b/atom/browser/api/atom_api_top_level_window.h
@@ -63,6 +63,8 @@ class TopLevelWindow : public mate::TrackableObject<TopLevelWindow>,
   void OnWindowWillResize(const gfx::Rect& new_bounds,
                           bool* prevent_default) override;
   void OnWindowResize() override;
+  void OnWindowWillMove(const gfx::Rect& new_bounds,
+                        bool* prevent_default) override;
   void OnWindowMove() override;
   void OnWindowMoved() override;
   void OnWindowScrollTouchBegin() override;

diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc
@@ -468,6 +468,12 @@ void NativeWindow::NotifyWindowWillResize(const gfx::Rect& new_bounds,
     observer.OnWindowWillResize(new_bounds, prevent_default);
 }
 
+void NativeWindow::NotifyWindowWillMove(const gfx::Rect& new_bounds,
+                                        bool* prevent_default) {
+  for (NativeWindowObserver& observer : observers_)
+    observer.OnWindowWillMove(new_bounds, prevent_default);
+}
+
 void NativeWindow::NotifyWindowResize() {
   for (NativeWindowObserver& observer : observers_)
     observer.OnWindowResize();

diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h
@@ -241,6 +241,7 @@ class NativeWindow : public base::SupportsUserData,
   void NotifyWindowWillResize(const gfx::Rect& new_bounds,
                               bool* prevent_default);
   void NotifyWindowResize();
+  void NotifyWindowWillMove(const gfx::Rect& new_bounds, bool* prevent_default);
   void NotifyWindowMoved();
   void NotifyWindowScrollTouchBegin();
   void NotifyWindowScrollTouchEnd();

diff --git a/atom/browser/native_window_observer.h b/atom/browser/native_window_observer.h
@@ -70,6 +70,8 @@ class NativeWindowObserver {
   virtual void OnWindowWillResize(const gfx::Rect& new_bounds,
                                   bool* prevent_default) {}
   virtual void OnWindowResize() {}
+  virtual void OnWindowWillMove(const gfx::Rect& new_bounds,
+                                bool* prevent_default) {}
   virtual void OnWindowMove() {}
   virtual void OnWindowMoved() {}
   virtual void OnWindowScrollTouchBegin() {}

diff --git a/atom/browser/native_window_views_win.cc b/atom/browser/native_window_views_win.cc
@@ -207,9 +207,16 @@ bool NativeWindowViews::PreHandleMSG(UINT message,
       return false;
     }
     case WM_MOVING: {
-      if (!movable_)
+      bool prevent_default = false;
+      NotifyWindowWillMove(gfx::Rect(*reinterpret_cast<RECT*>(l_param)),
+                           &prevent_default);
+      if (!movable_ || prevent_default) {
         ::GetWindowRect(GetAcceleratedWidget(),
                         reinterpret_cast<RECT*>(l_param));
+        return true;  // Tells Windows that the Move is handled. If not true,
+                      // frameless windows can be moved using
+                      // -webkit-app-region: drag elements.
+      }
       return false;
     }
     case WM_MOVE: {

diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md
@@ -505,6 +505,17 @@ Note that this is only emitted when the window is being resized manually. Resizi
 
 Emitted after the window has been resized.
 
+#### Event: 'will-move' _Windows_
+
+Returns:
+
+* `event` Event
+* `newBounds` [`Rectangle`](structures/rectangle.md) - Location the window is being moved to.
+
+Emitted before the window is moved. Calling `event.preventDefault()` will prevent the window from being moved.
+
+Note that this is only emitted when the window is being resized manually. Resizing the window with `setBounds`/`setSize` will not emit this event.
+
 #### Event: 'move'
 
 Emitted when the window is being moved to a new position.