1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
// 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.
#ifndef CHROME_BROWSER_EXTENSIONS_API_COMMANDS_COMMAND_SERVICE_H_
#define CHROME_BROWSER_EXTENSIONS_API_COMMANDS_COMMAND_SERVICE_H_
#pragma once
#include <string>
#include "base/basictypes.h"
#include "chrome/browser/profiles/profile_keyed_service.h"
#include "chrome/common/extensions/command.h"
#include "chrome/common/extensions/extension.h"
#include "content/public/browser/notification_details.h"
#include "content/public/browser/notification_observer.h"
#include "content/public/browser/notification_registrar.h"
#include "content/public/browser/notification_source.h"
class PrefService;
class Profile;
namespace base {
class DictionaryValue;
}
namespace ui {
class Accelerator;
}
namespace extensions {
// This service keeps track of preferences related to extension commands
// (assigning initial keybindings on install and removing them on deletion
// and answers questions related to which commands are active.
class CommandService : public ProfileKeyedService,
public content::NotificationObserver {
public:
// An enum specifying whether to fetch all extension commands or only active
// ones.
enum QueryType {
ALL,
ACTIVE_ONLY,
};
// Register prefs for keybinding.
static void RegisterUserPrefs(PrefService* user_prefs);
// Constructs a CommandService object for the given profile.
explicit CommandService(Profile* profile);
virtual ~CommandService();
// Gets the keybinding (if any) for the browser action of an extension given
// its |extension_id|. The function consults the master list to see if
// the keybinding is active. Returns NULL if the extension has no browser
// action. Returns NULL if the keybinding is not active and |type| requested
// is ACTIVE_ONLY.
const extensions::Command* GetBrowserActionCommand(
const std::string& extension_id, QueryType type);
// Gets the keybinding (if any) for the page action of an extension given
// its |extension_id|. The function consults the master list to see if
// the keybinding is active. Returns NULL if the extension has no page
// action. Returns NULL if the keybinding is not active and |type| requested
// is ACTIVE_ONLY.
const extensions::Command* GetPageActionCommand(
const std::string& extension_id, QueryType type);
// Gets the active keybinding (if any) for the named commands of an extension
// given its |extension_id|. The function consults the master list to see if
// the keybinding is active. Returns an empty map if the extension has no
// named commands or no active named commands when |type| requested is
// ACTIVE_ONLY.
extensions::CommandMap GetNamedCommands(
const std::string& extension_id, QueryType type);
// Checks to see if a keybinding |accelerator| for a given |command_name| in
// an extension with id |extension_id| is registered as active (by consulting
// the master list in |user_prefs|).
bool IsKeybindingActive(const ui::Accelerator& accelerator,
const std::string& extension_id,
const std::string& command_name) const;
// Records a keybinding |accelerator| as active for an extension with id
// |extension_id| and command with the name |command_name|. If
// |allow_overrides| is false, the keybinding must be free for the change to
// be recorded (as determined by the master list in |user_prefs|). If
// |allow_overwrites| is true, any previously recorded keybinding for this
// |accelerator| will be overwritten. Returns true if the change was
// successfully recorded.
bool AddKeybindingPref(const ui::Accelerator& accelerator,
std::string extension_id,
std::string command_name,
bool allow_overrides);
// Overridden from content::NotificationObserver.
virtual void Observe(int type,
const content::NotificationSource& source,
const content::NotificationDetails& details) OVERRIDE;
private:
// Assigns initial keybinding for a given |extension|'s page action, browser
// action and named commands. In each case, if the suggested keybinding is
// free, it will be taken by this extension. If not, that keybinding request
// is ignored. |user_pref| is the PrefService used to record the new
// keybinding assignment.
void AssignInitialKeybindings(const extensions::Extension* extension);
// Removes all keybindings for a given extension by its |extension_id|.
void RemoveKeybindingPrefs(std::string extension_id);
// The content notification registrar for listening to extension events.
content::NotificationRegistrar registrar_;
// A weak pointer to the profile we are associated with. Not owned by us.
Profile* profile_;
DISALLOW_COPY_AND_ASSIGN(CommandService);
};
} // namespace extensions
#endif // CHROME_BROWSER_EXTENSIONS_API_COMMANDS_COMMAND_SERVICE_H_
|
