chrome/browser/ui/website_settings/permission_bubble_view.h

   1 // Copyright 2014 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_WEBSITE_SETTINGS_PERMISSION_BUBBLE_VIEW_H_
   6 #define CHROME_BROWSER_UI_WEBSITE_SETTINGS_PERMISSION_BUBBLE_VIEW_H_
   7
   8 #include <vector>
   9
  10 class PermissionBubbleRequest;
  11 class PermissionBubbleManager;
  12
  13 // This class is the platform-independent interface through which the permission
  14 // bubble managers (which are one per tab) communicate to the UI surface.
  15 // When the visible tab changes, the UI code must provide an object of this type
  16 // to the manager for the visible tab.
  17 class PermissionBubbleView {
  18  public:
  19   // The delegate will receive events caused by user action which need to
  20   // be persisted in the per-tab UI state.
  21   class Delegate {
  22    public:
  23     virtual ~Delegate() {}
  24
  25     virtual void ToggleAccept(int index, bool new_value) = 0;
  26     virtual void Accept() = 0;
  27     virtual void Deny() = 0;
  28     virtual void Closing() = 0;
  29     virtual void SetView(PermissionBubbleView* view) = 0;
  30   };
  31
  32   virtual ~PermissionBubbleView() {}
  33
  34   // Sets the delegate which will receive UI events forwarded from the bubble.
  35   virtual void SetDelegate(Delegate* delegate) = 0;
  36
  37   // Causes the bubble to show up with the given contents. This method may be
  38   // called with mostly-identical contents to the existing contents. This can
  39   // happen, for instance, if a new permission is requested and
  40   // CanAcceptRequestUpdate() is true.
  41   // Important: the view must not store any of the request objects it receives
  42   // in this call.
  43   virtual void Show(
  44       const std::vector<PermissionBubbleRequest*>& requests,
  45       const std::vector<bool>& accept_state) = 0;
  46
  47   // Returns true if the view can accept a new Show() command to coalesce
  48   // requests. Currently the policy is that this should return true if the view
  49   // is being shown and the mouse is not over the view area (!IsMouseHovered).
  50   virtual bool CanAcceptRequestUpdate() = 0;
  51
  52   // Hides the permission bubble.
  53   virtual void Hide() = 0;
  54
  55   // Returns true if there is a bubble currently showing.
  56   virtual bool IsVisible() = 0;
  57 };
  58
  59 #endif  // CHROME_BROWSER_UI_WEBSITE_SETTINGS_PERMISSION_BUBBLE_VIEW_H_