Move ShowPopup logic from BrowserActionsContainer to BrowserActionView

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 <string>
-
 #include "chrome/browser/extensions/extension_action_icon_factory.h"
 #include "chrome/browser/extensions/extension_context_menu_model.h"
+#include "chrome/browser/ui/views/extensions/extension_popup.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 #include "ui/views/context_menu_controller.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"
+#include "ui/views/widget/widget_observer.h"
 
 class Browser;
 class BrowserActionButton;
 class ExtensionAction;
 
 namespace extensions {
 class Extension;
+class ExtensionToolbarModel;
 }
 
 namespace gfx {
 class Image;
 }
 
 namespace views {
 class MenuItemView;
 class MenuRunner;
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // BrowserActionView
 // A single entry in the browser action container. This contains the actual
 // BrowserActionButton, as well as the logic to paint the badge.
 class BrowserActionView : public views::View {
  public:
   // Need DragController here because BrowserActionView could be
   // dragged/dropped.
-  class Delegate : public views::DragController,
-                   public ExtensionContextMenuModel::PopupDelegate {
+  class Delegate : public views::DragController {
    public:
     // Returns the current tab's ID, or -1 if there is no current tab.
     virtual int GetCurrentTabId() const = 0;
 
-    // Called when the user clicks on the browser action icon.
-    virtual void OnBrowserActionExecuted(BrowserActionButton* button) = 0;
-
     // Called when a browser action becomes visible/hidden.
     virtual void OnBrowserActionVisibilityChanged() = 0;
 
     // Whether the container for this button is shown inside a menu.
     virtual bool ShownInsideMenu() const = 0;
 
     // Notifies that a drag completed. Note this will only happen if the view
     // wasn't removed during the drag-and-drop process (i.e., not when there
     // was a move in the browser actions, since we re-create the views each
     // time we re-order the browser actions).
     virtual void OnBrowserActionViewDragDone() = 0;
 
+    // Returns the view of the browser actions overflow menu to use as a
+    // reference point for a popup when this view isn't visible.
+    virtual views::View* GetOverflowReferenceView() = 0;
+
+    // Sets the delegate's active popup owner to be |popup_owner|.
+    virtual void SetPopupOwner(BrowserActionButton* popup_owner) = 0;
+
+    // Hides the active popup of the delegate, if one exists.
+    virtual void HideActivePopup() = 0;
+
+    // Returns the Model backing the browser actions.
+    virtual extensions::ExtensionToolbarModel* GetModel() = 0;
+
    protected:
     virtual ~Delegate() {}
   };
 
   BrowserActionView(const extensions::Extension* extension,
                     Browser* browser,
                     Delegate* delegate);
   virtual ~BrowserActionView();
 
   BrowserActionButton* button() { return button_; }
@@ skipping 30 matching lines @@
 ////////////////////////////////////////////////////////////////////////////////
 // BrowserActionButton
 
 // The BrowserActionButton is a specialization of the MenuButton class.
 // It acts on a ExtensionAction, in this case a BrowserAction and handles
 // loading the image for the button asynchronously on the file thread.
 class BrowserActionButton : public views::MenuButton,
                             public views::ButtonListener,
                             public views::ContextMenuController,
                             public content::NotificationObserver,
-                            public ExtensionActionIconFactory::Observer {
+                            public ExtensionActionIconFactory::Observer,
+                            public views::WidgetObserver,
+                            public ExtensionContextMenuModel::PopupDelegate {
  public:
   // 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() {}
   };
@@ skipping 12 matching lines @@
     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?
   virtual bool IsPopup();
   virtual GURL GetPopupUrl();
 
+  // Show this extension's popup. If |grant_tab_permissions| is true, this will
+  // grant the extension active tab permissions. Only do this if this was done
+  // through a user action (and not, e.g., an API).

[Peter Kasting, 2014/07/26 02:33:20]

Tiny nit: Remove commas (slightly more readable)

[Devlin, 2014/07/29 19:07:14]

Done.

+  bool ShowPopup(ExtensionPopup::ShowAction show_action,
+                 bool grant_tab_permissions);
+
+  // Hides the popup, if one is open.
+  void HidePopup();
+
+  // Executes the browser action (also showing the popup, if one exists).

[Peter Kasting, 2014/07/26 02:33:20]

Nit: also showing -> and also shows?

[Devlin, 2014/07/29 19:07:14]

Done.

+  void ExecuteBrowserAction();
+
   // Overridden from views::View:
   virtual bool CanHandleAccelerators() const OVERRIDE;
   virtual void GetAccessibleState(ui::AXViewState* state) OVERRIDE;
 
   // Overridden from views::ButtonListener:
   virtual void ButtonPressed(views::Button* sender,
                              const ui::Event& event) OVERRIDE;
 
   // Overridden from views::ContextMenuController.
   virtual void ShowContextMenuForView(View* source,
@@ skipping 28 matching lines @@
   // Notifications when to set button state to pushed/not pushed (for when the
   // popup/context menu is hidden or shown by the container).
   void SetButtonPushed();
   void SetButtonNotPushed();
 
   // 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;
 
-  // Returns icon factory for the button.
+  // Accessors.
   ExtensionActionIconFactory& icon_factory() { return icon_factory_; }
+  ExtensionPopup* popup() { return popup_; }
 
   // Gets the icon of this button and its badge.
   gfx::ImageSkia GetIconWithBadge();
 
   // Returns button icon so it can be accessed during tests.
   gfx::ImageSkia GetIconForTest();
 
  protected:
   // Overridden from views::View:
   virtual void ViewHierarchyChanged(
       const ViewHierarchyChangedDetails& details) OVERRIDE;
   virtual void OnDragDone() OVERRIDE;
 
  private:
   virtual ~BrowserActionButton();
 
+  // ExtensionContextMenuModel::PopupDelegate:
+  virtual void InspectPopup(ExtensionAction* action) OVERRIDE;

[Peter Kasting, 2014/07/26 02:33:20]

It seems like we should make this public, so that
BrowserActionTestUtil::InspectPopup() can call it without having to do an ugly
cast.

[Devlin, 2014/07/29 19:07:14]

Yeah - I was torn.  I like hiding these when possible (because usually it means
you're doing something wrong if you need to call it directly) and I didn't
really wanna change that just for a testing method.  But... it is a *really*
ugly cast. ;)  Done.

+
+  // views::WidgetObserver:
+  virtual void OnWidgetDestroying(views::Widget* widget) OVERRIDE;
+
   // Register an extension command if the extension has an active one.
   void MaybeRegisterExtensionCommand();
 
   // Unregisters an extension command, if the extension has registered one and
   // it is active.
   void MaybeUnregisterExtensionCommand(bool only_if_active);
 
   // The Browser object this button is associated with.
   Browser* browser_;
 
@@ skipping 19 matching lines @@
 
   content::NotificationRegistrar registrar_;
 
   // The extension key binding accelerator this browser action is listening for
   // (to show the popup).
   scoped_ptr<ui::Accelerator> keybinding_;
 
   // Responsible for running the menu.
   scoped_ptr<views::MenuRunner> menu_runner_;
 
+  // The browser action's popup, if it is visible, NULL otherwise.

[Peter Kasting, 2014/07/26 02:33:20]

Tiny nit: Change second comma to a semicolon or period

[Devlin, 2014/07/29 19:07:14]

Done.

+  ExtensionPopup* popup_;
+
   // The observer that we need to notify when the icon of the button has been
   // updated.
   IconObserver* icon_observer_;
 
   friend class base::DeleteHelper<BrowserActionButton>;
 
   DISALLOW_COPY_AND_ASSIGN(BrowserActionButton);
 };
 
 #endif  // CHROME_BROWSER_UI_VIEWS_TOOLBAR_BROWSER_ACTION_VIEW_H_