Add infrastructure for Chrome Actions

chrome/browser/ui/toolbar/toolbar_action_view_controller.h

+// Copyright 2014 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_TOOLBAR_TOOLBAR_ACTION_VIEW_CONTROLLER_H_
+#define CHROME_BROWSER_UI_TOOLBAR_TOOLBAR_ACTION_VIEW_CONTROLLER_H_
+
+#include "base/strings/string16.h"
+#include "ui/gfx/image/image.h"
+
+namespace content {
+class WebContents;
+}
+
+namespace gfx {
+class Canvas;
+class Rect;
+}
+
+class ToolbarActionViewDelegate;
+
+// The basic controller class for an action that is shown on the toolbar -
+// an extension action (like browser actions) or a component action (like
+// chromecast).
+class ToolbarActionViewController {

[sky, 2014/10/20 22:51:09]

Would a better name for this be BrowserActionViewController as we generally use
browseraction to refer to these?

[Devlin, 2014/10/21 00:02:33]

Confusingly, not necessarily.  In a fairly short amount of time, this stuff went
from representing browser actions to representing browser/page actions (i.e.,
"extension actions") to now being on the way to represent extension actions and
component toolbar actions (i.e., "toolbar actions").  I haven't been able to
update all the various class references, and it's almost to the point where a
toolbar action could be called a Browser Action again. :)  I'm not sure if we do
that, though, since a BrowserAction is still a fairly extension-y term.

[Finnur, 2014/10/21 09:34:12]

Yeah, I'm with Devlin here. We need a name that encompasses Browser Actions,
Page Actions and these new Component Toolbar Actions and a Toolbar Action seems
to be general enough to represent all three.

On 2014/10/21 00:02:33, Devlin wrote:

+ public:
+  virtual ~ToolbarActionViewController() {}
+
+  // Returns the unique ID of this particular action. For extensions, this is
+  // the extension id; for component actions, this is the name of the component.
+  virtual const std::string& GetId() const = 0;
+
+  // Sets the view delegate, which can handle most of the front-end logic.
+  virtual void SetDelegate(ToolbarActionViewDelegate* delegate) = 0;
+
+  // Returns the icon to use for the given |web_contents|.
+  virtual gfx::Image GetIcon(content::WebContents* web_contents) = 0;
+
+  // Returns the icon and the badge, if any, for the current tab.
+  virtual gfx::ImageSkia GetIconWithBadge() = 0;
+
+  // Returns the accessible name to use for the given |web_contents|.
+  virtual base::string16 GetAccessibleName(content::WebContents* web_contents)
+      const = 0;
+
+  // Returns the tooltip to use for the given |web_contents|.
+  virtual base::string16 GetTooltip(content::WebContents* web_contents)
+      const = 0;
+
+  // Returns true if the action should be enabled on the given |web_contents|.
+  virtual bool IsEnabled(content::WebContents* web_contents) const = 0;
+
+  // Returns true if the action has a popup for the given |web_contents|.
+  virtual bool HasPopup(content::WebContents* web_contents) const = 0;
+
+  // Hides the current popup, if one is visible.
+  virtual void HidePopup() = 0;
+
+  // Returns the native view for the popup, if one is active.
+  virtual gfx::NativeView GetPopupNativeView() = 0;
+
+  // Returns true if a menu is currently running for the action.
+  virtual bool IsMenuRunning() const = 0;
+
+  // Returns true if this view can be dragged. This should only be true for
+  // extensions right now, since they are the only ones the model currently
+  // supports.
+  // TODO(devlin): Tweak the model so that it supports generic actions.
+  virtual bool CanDrag() const = 0;
+
+  // Executes the default action (which is typically showing the popup). If
+  // |by_user| is true, then this was through a direct user action (as oppposed
+  // to, e.g., an API call).
+  // Returns true if a popup is shown.
+  virtual bool ExecuteAction(bool by_user) = 0;
+
+  // Paints any extra parts of the image (e.g., a badge).
+  virtual void PaintExtra(gfx::Canvas* canvas,
+                          const gfx::Rect& bounds,
+                          content::WebContents* web_contents) const {
+  }
+
+  // Registers an accelerator. Called when the view is added to the hierarchy.
+  // Unregistering any commands is the responsibility of the controller.
+  virtual void RegisterCommand() {
+  }
+};
+
+#endif  // CHROME_BROWSER_UI_TOOLBAR_TOOLBAR_ACTION_VIEW_CONTROLLER_H_