command.h revision 58537e28ecd584eab876aee8be7156509866d23a
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, 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string16& description, 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& accelerator); 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~Command(); 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The platform value for the Command. 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static std::string CommandPlatform(); 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Parse a string as an accelerator. If the accelerator is unparsable then 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // a generic ui::Accelerator object will be returns (with key_code Unknown). 3758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) static ui::Accelerator StringToAccelerator(const std::string& accelerator, 3858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) const std::string& command_name); 39a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) 40a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) // Returns the string representation of an accelerator without localizing the 41a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) // shortcut text (like accelerator::GetShortcutText() does). 42a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) static std::string AcceleratorToString(const ui::Accelerator& accelerator); 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Parse the command. 452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool Parse(const base::DictionaryValue* command, 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& command_name, 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int index, 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) string16* error); 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Convert a Command object from |extension| to a DictionaryValue. 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |active| specifies whether the command is active or not. 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::DictionaryValue* ToValue( 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Extension* extension, bool active) const; 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Accessors: 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& command_name() const { return command_name_; } 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ui::Accelerator& accelerator() const { return accelerator_; } 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string16& description() const { return description_; } 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Setter: 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_accelerator(ui::Accelerator accelerator) { 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) accelerator_ = accelerator; 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string command_name_; 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ui::Accelerator accelerator_; 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) string16 description_; 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A mapping of command name (std::string) to a command object. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef std::map<std::string, Command> CommandMap; 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace extensions 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_COMMON_EXTENSIONS_COMMAND_H_ 77