Chromium Code Reviews| Index: ash/common/system/chromeos/palette/palette_tool.h |
| diff --git a/ash/common/system/chromeos/palette/palette_tool.h b/ash/common/system/chromeos/palette/palette_tool.h |
| new file mode 100644 |
| index 0000000000000000000000000000000000000000..10a2db594a0550529dcdf3b7edee012e24c52b24 |
| --- /dev/null |
| +++ b/ash/common/system/chromeos/palette/palette_tool.h |
| @@ -0,0 +1,87 @@ |
| +// 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. |
| + |
| +#ifndef ASH_COMMON_SYSTEM_CHROMEOS_PALETTE_PALETTE_TOOL_H_ |
| +#define ASH_COMMON_SYSTEM_CHROMEOS_PALETTE_PALETTE_TOOL_H_ |
| + |
| +#include <map> |
| +#include <memory> |
| +#include <vector> |
| + |
| +#include "ash/ash_export.h" |
| +#include "base/callback.h" |
| +#include "base/macros.h" |
| + |
| +namespace views { |
| +class View; |
| +} |
| + |
| +namespace ash { |
| + |
| +class WmWindow; |
| + |
| +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 { |
| + public: |
| + using ToolAction = base::Callback<void(PaletteToolId)>; |
| + |
| + static void RegisterToolInstances(PaletteToolManager* tool_manager); |
| + |
| + PaletteTool(); |
| + virtual ~PaletteTool(); |
| + |
| + // Initialize the tool. It is assumed this is called from a PaletteToolManager |
| + // instance. |
| + void Initialize(WmWindow* window, |
| + const ToolAction& enable_tool, |
| + const ToolAction& disable_tool); |
| + |
| + // The group this tool belongs to. Only one tool per group can be active at |
| + // any given time. |
| + virtual PaletteGroup group() const = 0; |
|
oshima
2016/07/14 13:58:32
new line in between
jdufault
2016/07/18 20:39:58
Done.
|
| + // The unique identifier for this tool. This should be the only tool that ever |
| + // has this ID. |
| + virtual PaletteToolId tool_id() const = 0; |
| + |
| + // Called when the user activates the tool. Only one tool per group can be |
| + // active at any given time. |
| + virtual void OnEnable(); |
|
oshima
2016/07/14 13:58:32
new line in between
jdufault
2016/07/18 20:39:58
Done.
|
| + // 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. The view is owned by the |
| + // caller. ViewDestroyed is called when the view has been deallocated by its |
| + // owner. |
| + virtual views::View* CreateView() = 0; |
| + virtual void ViewDestroyed() = 0; |
|
oshima
2016/07/14 13:58:32
OnViewDestroyed() should be more consistent with t
jdufault
2016/07/18 20:39:57
Done.
|
| + |
| + protected: |
| + // Enables/disables the tool. |
| + bool enabled() const; |
| + void EnableSelf(); |
| + void DisableSelf(); |
| + |
| + // Window this tool is associated with. |
| + WmWindow* window() const; |
| + |
| + private: |
| + bool enabled_ = false; |
| + ToolAction enable_tool_; |
| + ToolAction disable_tool_; |
| + WmWindow* window_; |
| +}; |
| + |
| +} // namespace ash |
| + |
| +#endif // ASH_COMMON_SYSTEM_CHROMEOS_PALETTE_PALETTE_TOOL_H_ |