blob: 0e4dce39b75b3fab0cc3f89576336c414bd07467 [file] [log] [blame]
// Copyright 2016 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.
#include <map>
#include <memory>
#include <vector>
#include "ash/ash_export.h"
#include "ash/system/palette/palette_ids.h"
#include "base/callback.h"
#include "base/macros.h"
#include "ui/gfx/vector_icon_types.h"
namespace aura {
class Window;
namespace gfx {
struct VectorIcon;
namespace views {
class View;
namespace ash {
enum class PaletteGroup;
enum class PaletteToolId;
class PaletteToolManager;
// A PaletteTool is a generalized action inside of the palette menu in the
// shelf. Only one tool per group is active at any given time. When the tool is
// active, it should be showing some specializied UI. The tool is no longer
// active if it completes its action, if the user selects another tool with the
// same group, or if the user just cancels the action from the palette.
class ASH_EXPORT PaletteTool {
class Delegate {
// Enable or disable a specific tool.
virtual void EnableTool(PaletteToolId tool_id) = 0;
virtual void DisableTool(PaletteToolId tool_id) = 0;
// Hide the entire palette. This should not change any tool state.
virtual void HidePalette() = 0;
// Hide the entire palette without showing a hide animation.
virtual void HidePaletteImmediately() = 0;
// Returns the root window.
virtual aura::Window* GetWindow() = 0;
// Record usage of each pen palette option.
virtual void RecordPaletteOptionsUsage(PaletteTrayOptions option,
PaletteInvocationMethod method) = 0;
// Record mode cancellation of pen palette.
virtual void RecordPaletteModeCancellation(PaletteModeCancelType type) = 0;
virtual ~Delegate() {}
// Adds all available PaletteTool instances to the tool_manager.
static void RegisterToolInstances(PaletteToolManager* tool_manager);
// |delegate| must outlive this tool instance.
explicit PaletteTool(Delegate* delegate);
virtual ~PaletteTool();
// The group this tool belongs to. Only one tool per group can be active at
// any given time.
virtual PaletteGroup GetGroup() const = 0;
// The unique identifier for this tool. This should be the only tool that ever
// has this ID.
virtual PaletteToolId GetToolId() const = 0;
// Called when the user activates the tool. Only one tool per group can be
// active at any given time.
virtual void OnEnable();
// Disable the tool, either because this tool called DisableSelf(), the
// user cancelled the tool, or the user activated another tool within the
// same group.
virtual void OnDisable();
// Create a view that will be used in the palette, or nullptr if this tool
// should not be displayed. The view is owned by the caller. OnViewDestroyed
// is called when the view has been deallocated by its owner.
virtual views::View* CreateView() = 0;
virtual void OnViewDestroyed() = 0;
// Returns an icon to use in the tray if this tool is active. Only one tool
// (per-group) should ever have an active icon at any given time.
virtual const gfx::VectorIcon& GetActiveTrayIcon() const;
// Enables/disables the tool.
bool enabled() const { return enabled_; }
Delegate* delegate() { return delegate_; }
bool enabled_ = false;
// Unowned pointer to the delegate. The delegate should outlive this instance.
Delegate* delegate_;
} // namespace ash