blob: 11a86fbfb4f6b5808de5dd454fd9357473ea27d1 [file] [log] [blame]
// 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.
#include <map>
#include <string>
#include "base/strings/string16.h"
#include "ui/base/accelerators/accelerator.h"
namespace base {
class DictionaryValue;
namespace extensions {
class Command {
enum class Type {
Command(const std::string& command_name,
const base::string16& description,
const std::string& accelerator,
bool global);
Command(const Command& other);
// The platform value for the Command.
static std::string CommandPlatform();
// Parse a string as an accelerator. If the accelerator is unparsable then
// a generic ui::Accelerator object will be returns (with key_code Unknown).
static ui::Accelerator StringToAccelerator(const std::string& accelerator,
const std::string& command_name);
// Returns the string representation of an accelerator without localizing the
// shortcut text (like accelerator::GetShortcutText() does).
static std::string AcceleratorToString(const ui::Accelerator& accelerator);
// Return true if the specified accelerator is one of the following multimedia
// keys: Next Track key, Previous Track key, Stop Media key, Play/Pause Media
// key, without any modifiers.
static bool IsMediaKey(const ui::Accelerator& accelerator);
// Parse the command.
bool Parse(const base::DictionaryValue* command,
const std::string& command_name,
int index,
base::string16* error);
// Accessors:
const std::string& command_name() const { return command_name_; }
const ui::Accelerator& accelerator() const { return accelerator_; }
const base::string16& description() const { return description_; }
bool global() const { return global_; }
Type type() const { return type_; }
// Setter:
void set_accelerator(const ui::Accelerator& accelerator) {
accelerator_ = accelerator;
void set_global(bool global) {
global_ = global;
std::string command_name_;
ui::Accelerator accelerator_;
base::string16 description_;
bool global_;
Type type_;
// A mapping of command name (std::string) to a command object.
typedef std::map<std::string, Command> CommandMap;
} // namespace extensions