Action box menu

chrome/browser/ui/views/browser_action_view.h

 // Copyright (c) 2012 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_BROWSER_ACTION_VIEW_H_
 #define CHROME_BROWSER_UI_VIEWS_BROWSER_ACTION_VIEW_H_
 
 #include <string>
 
 #include "chrome/browser/extensions/image_loading_tracker.h"
 #include "content/public/browser/notification_observer.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"
 
-class BrowserActionsContainer;
+class Browser;
+class BrowserActionButton;
 class ExtensionAction;
 
+namespace extensions {
+class Extension;
+}
+
 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 DragControler here because BrowserActionView could be dragged/dropped.

[Peter Kasting, 2012/08/03 23:17:42]

Nit: DragControler -> DragController

[yefimt, 2012/08/07 00:47:06]

Done.

+  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;
+
+    // Returns relative position of a button inside BrowserActionView.
+    virtual gfx::Point GetViewContentOffset() const = 0;
+
+    virtual bool NeedToShowMultipleIconStates() const { return true; }

[Peter Kasting, 2012/08/03 23:17:42]

Nit: Never define virtuals inline.

[yefimt, 2012/08/07 00:47:06]

Done.

+    virtual bool NeedToShowTooltip() const { return true; }
+
+   protected:
+    Delegate() {}

[Peter Kasting, 2012/08/03 23:17:42]

Nit: Omit this constructor for interface classes -- the pure virtual methods
already guarantee no one can instantiate this directly.

[yefimt, 2012/08/07 00:47:06]

Done.

+    virtual ~Delegate() {}
+  };
+
+  BrowserActionView(const extensions::Extension* extension,
+                    Browser* browser,
+                    Delegate* delegate);
+  virtual ~BrowserActionView();
+
+  BrowserActionButton* button() { return button_; }
+
+  // Allocates a canvas object on the heap and draws into it the icon for the
+  // view as well as the badge (if any). Caller is responsible for deleting the
+  // returned object.
+  gfx::Canvas* GetIconWithBadge();
+
+  // Overridden from views::View:
+  virtual void Layout() OVERRIDE;
+  virtual void GetAccessibleState(ui::AccessibleViewState* state) OVERRIDE;
+  virtual gfx::Size GetPreferredSize() OVERRIDE;
+
+ protected:
+  // Overridden from views::View to paint the badge on top of children.
+  virtual void PaintChildren(gfx::Canvas* canvas) OVERRIDE;
+  virtual void ViewHierarchyChanged(bool is_add,
+                                    View* parent,
+                                    View* child) OVERRIDE;
+
+ private:
+  // The Browser object this view is associated with.
+  Browser* browser_;
+
+  // Usually a container for this view.
+  Delegate* delegate_;
+
+  // The button this view contains.
+  BrowserActionButton* button_;
+
+  // Extension this view associated with.
+  const extensions::Extension* extension_;
+
+  DISALLOW_COPY_AND_ASSIGN(BrowserActionView);
+};
+
+////////////////////////////////////////////////////////////////////////////////
 // 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 ImageLoadingTracker::Observer,
                             public content::NotificationObserver {
  public:
   BrowserActionButton(const extensions::Extension* extension,
-                      BrowserActionsContainer* panel);
+                      Browser* browser_,
+                      BrowserActionView::Delegate* delegate);
 
   // Call this instead of delete.
   void Destroy();
 
   ExtensionAction* browser_action() const { return browser_action_; }
   const extensions::Extension* extension() { return extension_; }
 
   // Called to update the display to match the browser action's state.
   void UpdateState();
 
@@ skipping 28 matching lines @@
   // MenuButton behavior overrides.  These methods all default to TextButton
   // 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 views::MouseEvent& event) OVERRIDE;
   virtual void OnMouseReleased(const views::MouseEvent& event) OVERRIDE;
   virtual void OnMouseExited(const views::MouseEvent& event) OVERRIDE;
   virtual bool OnKeyReleased(const views::KeyEvent& event) OVERRIDE;
+  virtual void ShowContextMenu(const gfx::Point& p,

[Peter Kasting, 2012/08/03 23:17:42]

I just double-checked the file in svn here (
http://src.chromium.org/viewvc/chrome/trunk/src/chrome/browser/ui/views/brows...
) and it really doesn't have this function.

I also think we don't need this override.  The default implementation in view.cc
already calls over to ShowContextMenuForView(), which should work fine.  So I
think you can just omit this function entirely, and eliminate
ShowContextMenuImpl() by inlining its contents in ShowContextMenuForView().

[yefimt, 2012/08/07 00:47:06]

You are right it was removed in Revision 147178.

+                               bool is_mouse_gesture) OVERRIDE;
 
   // Overridden from ui::AcceleratorTarget.
   virtual bool AcceleratorPressed(const ui::Accelerator& accelerator) OVERRIDE;
 
   // 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
@@ skipping 10 matching lines @@
  private:
   virtual ~BrowserActionButton();
 
   // 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);
 
+  // Returns tooltip for the button.
+  string16 GetName();
+
+  void ShowContextMenuImpl();
+
+  // The Browser object this button is associated with.
+  Browser* browser_;
+
   // The browser action this view represents. The ExtensionAction is not owned
   // by this class.
   ExtensionAction* browser_action_;
 
   // The extension associated with the browser action we're displaying.
   const extensions::Extension* extension_;
 
   // The object that is waiting for the image loading to complete
   // asynchronously.
   ImageLoadingTracker tracker_;
 
   // The default icon for our browser action. This might be non-empty if the
   // browser action had a value for default_icon in the manifest.
   SkBitmap default_icon_;
 
-  // The browser action shelf.
-  BrowserActionsContainer* panel_;
+  // Delegate that usually represents a container for BrowserActionView.
+  BrowserActionView::Delegate* delegate_;
 
   // The context menu.  This member is non-NULL only when the menu is shown.
   views::MenuItemView* context_menu_;
 
   content::NotificationRegistrar registrar_;
 
-  // The extension keybinding accelerator this browser action is listening for
+  // 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_;
+
   friend class base::DeleteHelper<BrowserActionButton>;
 
   DISALLOW_COPY_AND_ASSIGN(BrowserActionButton);
 };
 
-
-////////////////////////////////////////////////////////////////////////////////
-// BrowserActionView
-// A single section 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:
-  BrowserActionView(const extensions::Extension* extension,
-                    BrowserActionsContainer* panel);
-  virtual ~BrowserActionView();
-
-  BrowserActionButton* button() { return button_; }
-
-  // Allocates a canvas object on the heap and draws into it the icon for the
-  // view as well as the badge (if any). Caller is responsible for deleting the
-  // returned object.
-  gfx::Canvas* GetIconWithBadge();
-
-  // Overridden from views::View:
-  virtual void Layout() OVERRIDE;
-  virtual void GetAccessibleState(ui::AccessibleViewState* state) OVERRIDE;
-
- protected:
-  // Overridden from views::View to paint the badge on top of children.
-  virtual void PaintChildren(gfx::Canvas* canvas) OVERRIDE;
-
- private:
-  // The container for this view.
-  BrowserActionsContainer* panel_;
-
-  // The button this view contains.
-  BrowserActionButton* button_;
-
-  DISALLOW_COPY_AND_ASSIGN(BrowserActionView);
-};
-
 #endif  // CHROME_BROWSER_UI_VIEWS_BROWSER_ACTION_VIEW_H_