Refactored MouseWatcher to allow regions other than Views to

ui/views/mouse_watcher.h

 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef UI_VIEWS_MOUSE_WATCHER_H_
 #define UI_VIEWS_MOUSE_WATCHER_H_
 #pragma once
 
 #include "base/basictypes.h"
 #include "base/memory/scoped_ptr.h"
 #include "ui/gfx/insets.h"
 #include "ui/views/views_export.h"
 
+namespace gfx {
+class Point;
+}
+
 namespace views {
 
-class View;
-
-// MouseWatcherListener is notified when the mouse moves outside the view.
+// MouseWatcherListener is notified when the mouse moves outside the host.
 class VIEWS_EXPORT MouseWatcherListener {
  public:
-  virtual void MouseMovedOutOfView() = 0;
+  virtual void MouseMovedOutOfHost() = 0;
 
  protected:
   virtual ~MouseWatcherListener();
 };
 
+// The MouseWatcherHost determines what region is to be monitored.
+class VIEWS_EXPORT MouseWatcherHost {
+ public:
+  // The MouseEventType can be used as a hint.
+  enum MouseEventType {
+    // The mouse moved within the window which was current when the MouseWatcher
+    // was created.
+    MOUSE_MOVE,
+    // The mouse moved exited the window which was current when the MouseWatcher
+    // was created.
+    MOUSE_EXITED
+  };
+
+  // Return false when the mouse has moved outside the monitored region.
+  virtual bool Contains(
+      const gfx::Point& screen_point, MouseEventType type) = 0;

[sky, 2012/02/06 16:03:34]

nit: when you wrap, each param should be on its own line.

[DaveMoore, 2012/02/06 17:10:16]

Done.

+  virtual ~MouseWatcherHost();
+

[sky, 2012/02/06 16:03:34]

nit: remove newline, and destructor before other methods.

[DaveMoore, 2012/02/06 17:10:16]

Done.

+};
+
 // MouseWatcher is used to watch mouse movement and notify its listener when the
-// mouse moves outside the bounds of a view.
+// mouse moves outside the bounds of a MouseWatcherHost.
 class VIEWS_EXPORT MouseWatcher {
  public:
-  // Creates a new MouseWatcher. |hot_zone_insets| is added to the bounds of
-  // the view to determine the active zone. For example, if
-  // |hot_zone_insets.bottom()| is 10, then the listener is not notified if
-  // the y coordinate is between the origin of the view and height of the view
-  // plus 10.
-  MouseWatcher(views::View* host,
-               MouseWatcherListener* listener,
-               const gfx::Insets& hot_zone_insets);
+  // Creates a new MouseWatcher. The |listener| will be notified when the |host|
+  // determines that the mouse has moved outside its monitored region.
+  // |host| will be owned by the watcher and deleted upon completion.
+  MouseWatcher(MouseWatcherHost* host, MouseWatcherListener* listener);
   ~MouseWatcher();
 
   // Sets the amount to delay before notifying the listener when the mouse exits
-  // the view by way of going to another window.
+  // the host by way of going to another window.
   void set_notify_on_exit_time_ms(int time) { notify_on_exit_time_ms_ = time; }
 
   // Starts watching mouse movements. When the mouse moves outside the bounds of
-  // the view the listener is notified. |Start| may be invoked any number of
-  // times. If the mouse moves outside the bounds of the view the listener is
+  // the host the listener is notified. |Start| may be invoked any number of
+  // times. If the mouse moves outside the bounds of the host the listener is
   // notified and watcher stops watching events.
   void Start();
 
   // Stops watching mouse events.
   void Stop();
 
  private:
   class Observer;
 
   // Are we currently observing events?
   bool is_observing() const { return observer_.get() != NULL; }
 
   // Notifies the listener and stops watching events.
   void NotifyListener();
 
-  // View we're listening for events over.
-  View* host_;
+  // Host we're listening for events over.
+  scoped_ptr<MouseWatcherHost> host_;
 
   // Our listener.
   MouseWatcherListener* listener_;
 
-  // Insets added to the bounds of the view.
-  const gfx::Insets hot_zone_insets_;
-
   // Does the actual work of listening for mouse events.
   scoped_ptr<Observer> observer_;
 
   // See description above setter.
   int notify_on_exit_time_ms_;
 
   DISALLOW_COPY_AND_ASSIGN(MouseWatcher);
 };
 
 }  // namespace views
 
 #endif  // UI_VIEWS_MOUSE_WATCHER_H_