command.h revision a1401311d1ab56c4ed0a474bd38c108f75cb0cd9
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CHROME_COMMON_EXTENSIONS_COMMAND_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHROME_COMMON_EXTENSIONS_COMMAND_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <map> 9868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#include <string> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#include "base/strings/string16.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/base/accelerators/accelerator.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base { 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class DictionaryValue; 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace extensions { 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Extension; 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace extensions { 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Command { 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Command(); 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Command(const std::string& command_name, 28a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) const base::string16& description, 294e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) const std::string& accelerator, 304e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) bool global); 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~Command(); 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The platform value for the Command. 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static std::string CommandPlatform(); 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Parse a string as an accelerator. If the accelerator is unparsable then 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // a generic ui::Accelerator object will be returns (with key_code Unknown). 3858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) static ui::Accelerator StringToAccelerator(const std::string& accelerator, 3958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) const std::string& command_name); 40a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) 41a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) // Returns the string representation of an accelerator without localizing the 42a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) // shortcut text (like accelerator::GetShortcutText() does). 43a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) static std::string AcceleratorToString(const ui::Accelerator& accelerator); 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 45a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) // Return true if the specified accelerator is one of the following multimedia 46a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) // keys: Next Track key, Previous Track key, Stop Media key, Play/Pause Media 47a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) // key, without any modifiers. 48a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) static bool IsMediaKey(const ui::Accelerator& accelerator); 49a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Parse the command. 512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool Parse(const base::DictionaryValue* command, 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& command_name, 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int index, 54a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) base::string16* error); 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Convert a Command object from |extension| to a DictionaryValue. 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |active| specifies whether the command is active or not. 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::DictionaryValue* ToValue( 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Extension* extension, bool active) const; 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Accessors: 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& command_name() const { return command_name_; } 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ui::Accelerator& accelerator() const { return accelerator_; } 64a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) const base::string16& description() const { return description_; } 654e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) bool global() const { return global_; } 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Setter: 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_accelerator(ui::Accelerator accelerator) { 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) accelerator_ = accelerator; 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 718bcbed890bc3ce4d7a057a8f32cab53fa534672eTorne (Richard Coles) void set_global(bool global) { 728bcbed890bc3ce4d7a057a8f32cab53fa534672eTorne (Richard Coles) global_ = global; 738bcbed890bc3ce4d7a057a8f32cab53fa534672eTorne (Richard Coles) } 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string command_name_; 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ui::Accelerator accelerator_; 78a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) base::string16 description_; 794e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) bool global_; 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A mapping of command name (std::string) to a command object. 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef std::map<std::string, Command> CommandMap; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace extensions 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_COMMON_EXTENSIONS_COMMAND_H_ 88