15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef UI_VIEWS_MOUSE_WATCHER_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UI_VIEWS_MOUSE_WATCHER_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 10eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "base/time/time.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/gfx/insets.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/views/views_export.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace gfx { 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Point; 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace views { 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// MouseWatcherListener is notified when the mouse moves outside the host. 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class VIEWS_EXPORT MouseWatcherListener { 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void MouseMovedOutOfHost() = 0; 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~MouseWatcherListener(); 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The MouseWatcherHost determines what region is to be monitored. 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class VIEWS_EXPORT MouseWatcherHost { 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The MouseEventType can be used as a hint. 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum MouseEventType { 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The mouse moved within the window which was current when the MouseWatcher 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // was created. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MOUSE_MOVE, 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The mouse moved exited the window which was current when the MouseWatcher 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // was created. 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MOUSE_EXIT 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~MouseWatcherHost(); 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Return false when the mouse has moved outside the monitored region. 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool Contains(const gfx::Point& screen_point, 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MouseEventType type) = 0; 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// MouseWatcher is used to watch mouse movement and notify its listener when the 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// mouse moves outside the bounds of a MouseWatcherHost. 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class VIEWS_EXPORT MouseWatcher { 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates a new MouseWatcher. The |listener| will be notified when the |host| 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // determines that the mouse has moved outside its monitored region. 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |host| will be owned by the watcher and deleted upon completion. 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MouseWatcher(MouseWatcherHost* host, MouseWatcherListener* listener); 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~MouseWatcher(); 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets the amount to delay before notifying the listener when the mouse exits 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the host by way of going to another window. 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_notify_on_exit_time(base::TimeDelta time) { 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) notify_on_exit_time_ = time; 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Starts watching mouse movements. When the mouse moves outside the bounds of 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the host the listener is notified. |Start| may be invoked any number of 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // times. If the mouse moves outside the bounds of the host the listener is 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // notified and watcher stops watching events. 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Start(); 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Stops watching mouse events. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Stop(); 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class Observer; 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Are we currently observing events? 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_observing() const { return observer_.get() != NULL; } 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Notifies the listener and stops watching events. 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void NotifyListener(); 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Host we're listening for events over. 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<MouseWatcherHost> host_; 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Our listener. 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MouseWatcherListener* listener_; 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Does the actual work of listening for mouse events. 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<Observer> observer_; 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See description above setter. 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::TimeDelta notify_on_exit_time_; 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(MouseWatcher); 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace views 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // UI_VIEWS_MOUSE_WATCHER_H_ 101