chrome/browser/ui/exclusive_access/exclusive_access_bubble.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_UI_EXCLUSIVE_ACCESS_EXCLUSIVE_ACCESS_BUBBLE_H_
   6 #define CHROME_BROWSER_UI_EXCLUSIVE_ACCESS_EXCLUSIVE_ACCESS_BUBBLE_H_
   7
   8 #include "base/timer/timer.h"
   9 #include "chrome/browser/ui/exclusive_access/exclusive_access_bubble_type.h"
  10 #include "ui/gfx/animation/animation_delegate.h"
  11 #include "ui/gfx/geometry/point.h"
  12 #include "url/gurl.h"
  13
  14 class ExclusiveAccessManager;
  15
  16 namespace gfx {
  17 class Rect;
  18 }
  19
  20 // Bubble that informs the user when an exclusive access state is in effect and
  21 // as to how to exit out of the state. Currently there are two exclusive access
  22 // state, namely fullscreen and mouse lock.
  23 class ExclusiveAccessBubble : public gfx::AnimationDelegate {
  24  public:
  25   explicit ExclusiveAccessBubble(ExclusiveAccessManager* manager,
  26                                  const GURL& url,
  27                                  ExclusiveAccessBubbleType bubble_type);
  28   ~ExclusiveAccessBubble() override;
  29
  30  protected:
  31   static const int kPaddingPx;        // Amount of padding around the link
  32   static const int kInitialDelayMs;   // Initial time bubble remains onscreen
  33   static const int kIdleTimeMs;       // Time before mouse idle triggers hide
  34   static const int kPositionCheckHz;  // How fast to check the mouse position
  35   static const int kSlideInRegionHeightPx;
  36   // Height of region triggering
  37   // slide-in
  38   static const int kPopupTopPx;          // Space between the popup and the top
  39                                          // of the screen.
  40   static const int kSlideInDurationMs;   // Duration of slide-in animation
  41   static const int kSlideOutDurationMs;  // Duration of slide-out animation
  42
  43   // Returns the current desirable rect for the popup window.  If
  44   // |ignore_animation_state| is true this returns the rect assuming the popup
  45   // is fully onscreen.
  46   virtual gfx::Rect GetPopupRect(bool ignore_animation_state) const = 0;
  47   virtual gfx::Point GetCursorScreenPoint() = 0;
  48   virtual bool WindowContainsPoint(gfx::Point pos) = 0;
  49
  50   // Returns true if the window is active.
  51   virtual bool IsWindowActive() = 0;
  52
  53   // Hides the bubble.  This is a separate function so it can be called by a
  54   // timer.
  55   virtual void Hide() = 0;
  56
  57   // Shows the bubble.
  58   virtual void Show() = 0;
  59
  60   virtual bool IsAnimating() = 0;
  61
  62   // True if the mouse position can trigger sliding in the exit fullscreen
  63   // bubble when the bubble is hidden.
  64   virtual bool CanMouseTriggerSlideIn() const = 0;
  65
  66   void StartWatchingMouse();
  67   void StopWatchingMouse();
  68   bool IsWatchingMouse() const;
  69
  70   // Called repeatedly to get the current mouse position and animate the bubble
  71   // on or off the screen as appropriate.
  72   void CheckMousePosition();
  73
  74   void ExitExclusiveAccess();
  75   // Accepts the request. Can cause FullscreenExitBubble to be deleted.
  76   void Accept();
  77   // Denys the request. Can cause FullscreenExitBubble to be deleted.
  78   void Cancel();
  79
  80   // The following strings may change according to the content type and URL.
  81   base::string16 GetCurrentMessageText() const;
  82   base::string16 GetCurrentDenyButtonText() const;
  83   base::string16 GetCurrentAllowButtonText() const;
  84
  85   // The following strings never change.
  86   base::string16 GetInstructionText() const;
  87
  88   // The Manager associated with this bubble.
  89   ExclusiveAccessManager* const manager_;
  90
  91   // The host the bubble is for, can be empty.
  92   GURL url_;
  93
  94   // The type of the bubble; controls e.g. which buttons to show.
  95   ExclusiveAccessBubbleType bubble_type_;
  96
  97  private:
  98   // Timer to delay before allowing the bubble to hide after it's initially
  99   // shown.
 100   base::OneShotTimer<ExclusiveAccessBubble> initial_delay_;
 101
 102   // Timer to see how long the mouse has been idle.
 103   base::OneShotTimer<ExclusiveAccessBubble> idle_timeout_;
 104
 105   // Timer to poll the current mouse position.  We can't just listen for mouse
 106   // events without putting a non-empty HWND onscreen (or hooking Windows, which
 107   // has other problems), so instead we run a low-frequency poller to see if the
 108   // user has moved in or out of our show/hide regions.
 109   base::RepeatingTimer<ExclusiveAccessBubble> mouse_position_checker_;
 110
 111   // The most recently seen mouse position, in screen coordinates.  Used to see
 112   // if the mouse has moved since our last check.
 113   gfx::Point last_mouse_pos_;
 114
 115   DISALLOW_COPY_AND_ASSIGN(ExclusiveAccessBubble);
 116 };
 117
 118 #endif  // CHROME_BROWSER_UI_EXCLUSIVE_ACCESS_EXCLUSIVE_ACCESS_BUBBLE_H_