Add infrastructure for Chrome Actions

chrome/browser/ui/views/toolbar/browser_action_view.h

 // Copyright 2013 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 CHROME_BROWSER_UI_VIEWS_TOOLBAR_BROWSER_ACTION_VIEW_H_
 #define CHROME_BROWSER_UI_VIEWS_TOOLBAR_BROWSER_ACTION_VIEW_H_
 
-#include "chrome/browser/ui/views/extensions/extension_action_view_controller.h"
-#include "chrome/browser/ui/views/extensions/extension_action_view_delegate.h"
+#include "chrome/browser/ui/views/toolbar/toolbar_action_view_delegate.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 #include "ui/views/controls/button/menu_button.h"
 #include "ui/views/controls/button/menu_button_listener.h"
 #include "ui/views/drag_controller.h"
 #include "ui/views/view.h"
 
 class Browser;
 class ExtensionAction;
+class ExtensionActionViewController;
 
 namespace extensions {
 class Extension;
 }
 
 namespace gfx {
 class Image;
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // BrowserActionView
-// A wrapper around an ExtensionActionViewController to display an extension
+// A wrapper around a ToolbarActionViewController to display a toolbar action
 // action in the BrowserActionsContainer.
-// Despite its name, this class can handle either Browser Actions or Page
-// Actions.
+// Despite its name, this class can handle any type of toolbar action, including
+// extension actions (browser and page actions) and component actions.
 // TODO(devlin): Rename this and BrowserActionsContainer when more of the
 // toolbar redesign is done.
 class BrowserActionView : public views::MenuButton,
-                          public ExtensionActionViewDelegate,
+                          public ToolbarActionViewDelegate,
                           public views::ButtonListener,
                           public content::NotificationObserver {
  public:
   // Need DragController here because BrowserActionView could be
   // dragged/dropped.
   class Delegate : public views::DragController {
    public:
     // Returns the current web contents.
     virtual content::WebContents* GetCurrentWebContents() = 0;
 
@@ skipping 11 matching lines @@
     virtual views::MenuButton* GetOverflowReferenceView() = 0;
 
     // Sets the delegate's active popup owner to be |popup_owner|.
     virtual void SetPopupOwner(BrowserActionView* popup_owner) = 0;
 
     // Hides the active popup of the delegate, if one exists.
     virtual void HideActivePopup() = 0;
 
     // Returns the primary BrowserActionView associated with the given
     // |extension|.
-    virtual BrowserActionView* GetMainViewForExtension(
-        const extensions::Extension* extension) = 0;
+    virtual BrowserActionView* GetMainViewForAction(
+        BrowserActionView* view) = 0;
 
    protected:
     virtual ~Delegate() {}
   };
 
-  // The IconObserver will receive a notification when the button's icon has
-  // been updated.
-  class IconObserver {
-   public:
-    virtual void OnIconUpdated(const gfx::ImageSkia& icon) = 0;
-
-   protected:
-    virtual ~IconObserver() {}
-  };
-
-  BrowserActionView(const extensions::Extension* extension,
-                    ExtensionAction* extension_action,
+  BrowserActionView(scoped_ptr<ToolbarActionViewController> view_controller,
                     Browser* browser,
-                    BrowserActionView::Delegate* delegate);
+                    Delegate* delegate);
   virtual ~BrowserActionView();
 
-  const extensions::Extension* extension() const {
-    return view_controller_->extension();
-  }
-  ExtensionAction* extension_action() {
-    return view_controller_->extension_action();
-  }
-  ExtensionActionViewController* view_controller() {
-    return view_controller_.get();
-  }
-  void set_icon_observer(IconObserver* icon_observer) {
-    icon_observer_ = icon_observer;
-  }
-
   // Called to update the display to match the browser action's state.
   void UpdateState();
 
-  // Does this button's action have a popup?
-  bool IsPopup();
-
   // Overridden from views::View:
   virtual void GetAccessibleState(ui::AXViewState* state) override;
 
   // Overridden from views::ButtonListener:
   virtual void ButtonPressed(views::Button* sender,
                              const ui::Event& event) override;
 
   // Overridden from content::NotificationObserver:
   virtual void Observe(int type,
                        const content::NotificationSource& source,
                        const content::NotificationDetails& details) override;
 
   // MenuButton behavior overrides.  These methods all default to LabelButton
   // behavior unless this button is a popup.  In that case, it uses MenuButton
   // behavior.  MenuButton has the notion of a child popup being shown where the
   // button will stay in the pushed state until the "menu" (a popup in this
   // case) is dismissed.
   virtual bool Activate() override;
   virtual bool OnMousePressed(const ui::MouseEvent& event) override;
   virtual void OnMouseReleased(const ui::MouseEvent& event) override;
   virtual void OnMouseExited(const ui::MouseEvent& event) override;
   virtual bool OnKeyReleased(const ui::KeyEvent& event) override;
   virtual void OnGestureEvent(ui::GestureEvent* event) override;
   virtual scoped_ptr<views::LabelButtonBorder> CreateDefaultBorder() const
       override;
 
-  // Whether the browser action is enabled on this tab. Note that we cannot use
-  // the built-in views enabled/SetEnabled because disabled views do not
-  // receive drag events.
-  bool IsEnabled(int tab_id) const;
+  // ToolbarActionViewDelegate: (public because called by others).
+  virtual content::WebContents* GetCurrentWebContents() const override;
 
-  // Gets the icon of this button and its badge.
-  gfx::ImageSkia GetIconWithBadge();
+  // A convenience method to get the |view_controller_| as an
+  // ExtensionActionViewController. This will DCHECK if this isn't a view for
+  // an extension action.
+  ExtensionActionViewController* GetExtensionActionViewController();
+
+  ToolbarActionViewController* view_controller() {
+    return view_controller_.get();
+  }
+  Browser* browser() { return browser_; }
 
   // Returns button icon so it can be accessed during tests.
   gfx::ImageSkia GetIconForTest();
 
  private:
   // Overridden from views::View:
   virtual void ViewHierarchyChanged(
       const ViewHierarchyChangedDetails& details) override;
   virtual void OnDragDone() override;
   virtual gfx::Size GetPreferredSize() const override;
   virtual void PaintChildren(gfx::Canvas* canvas,
                              const views::CullSet& cull_set) override;
 
-  // ExtensionActionViewDelegate:
+  // ToolbarActionViewDelegate:
   virtual views::View* GetAsView() override;
   virtual bool IsShownInMenu() override;
   virtual views::FocusManager* GetFocusManagerForAccelerator() override;
   virtual views::Widget* GetParentForContextMenu() override;
-  virtual ExtensionActionViewController* GetPreferredPopupViewController()
+  virtual ToolbarActionViewController* GetPreferredPopupViewController()
       override;
   virtual views::View* GetReferenceViewForPopup() override;
   virtual views::MenuButton* GetContextMenuButton() override;
-  virtual content::WebContents* GetCurrentWebContents() override;
   virtual void HideActivePopup() override;
   virtual void OnIconUpdated() override;
   virtual void OnPopupShown(bool grant_tab_permissions) override;
   virtual void CleanupPopup() override;
 
   // A lock to keep the MenuButton pressed when a menu or popup is visible.
   // This needs to be destroyed after |view_controller_|, because
   // |view_controller_|'s destructor can call CleanupPopup(), which uses this
   // object.
   scoped_ptr<views::MenuButton::PressedLock> pressed_lock_;
 
-  // The controller for this ExtensionAction view.
-  scoped_ptr<ExtensionActionViewController> view_controller_;
+  // The controller for this toolbar action view.
+  scoped_ptr<ToolbarActionViewController> view_controller_;
+
+  // The associated browser.
+  Browser* browser_;
 
   // Delegate that usually represents a container for BrowserActionView.
-  BrowserActionView::Delegate* delegate_;
+  Delegate* delegate_;
 
   // Used to make sure we only register the command once.
-  bool called_registered_extension_command_;
+  bool called_register_command_;
 
   content::NotificationRegistrar registrar_;
 
-  // The observer that we need to notify when the icon of the button has been
-  // updated.
-  IconObserver* icon_observer_;
-
   DISALLOW_COPY_AND_ASSIGN(BrowserActionView);
 };
 
 #endif  // CHROME_BROWSER_UI_VIEWS_TOOLBAR_BROWSER_ACTION_VIEW_H_