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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
// Copyright 2008, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#ifndef CHROME_BROWSER_CONTROLLER_H__
#define CHROME_BROWSER_CONTROLLER_H__
#include <hash_map>
#include <vector>
#include "base/basictypes.h"
#include "chrome/views/button.h"
#include "chrome/views/controller.h"
class ButtonController;
///////////////////////////////////////////////////////////////////////////////
//
// CommandObserver interface
//
// A component of the View portion of the MVC pattern implements the
// CommandObserver interface to update itself when the state of its command
// changes.
//
///////////////////////////////////////////////////////////////////////////////
class CommandObserver {
public:
// Update the View because this command's enabled state has changed.
virtual void SetEnabled(bool enabled) = 0;
};
///////////////////////////////////////////////////////////////////////////////
//
// CommandHandler interface
//
// An object implementing the CommandHandler interface is responsible for
// actually executing specific commands.
//
// This object is also responsible for producing contextual labels if needed.
//
///////////////////////////////////////////////////////////////////////////////
class CommandHandler {
public:
// This method is called to give the command handler a chance to specify
// a contextual label for the provided command id. Returns true if a
// contextual label has been assigned or false if the default label should be
// used.
virtual bool GetContextualLabel(int id, std::wstring* out) const {
return false;
}
// Whether the specified command can be executed.
virtual bool IsCommandEnabled(int id) const { return true; }
// Execute a command, according to the command's state (currently binary!)
virtual void ExecuteCommand(int id) = 0;
};
typedef std::vector<CommandObserver*> CommandObserverList;
// A piece of data about a command - whether or not it is enabled, and a list
// of objects that observe the enabled state of this command.
struct Command {
bool enabled;
CommandObserverList* observers;
};
typedef stdext::hash_map<int, Command*> CommandMap;
///////////////////////////////////////////////////////////////////////////////
//
// Controller class
//
// This is the Controller portion of a MVC pattern. It handles dispatching
// commands, maintaining enabled state, and updating the UI as that state
// changes. The purpose of using MVC and a controller like this is to
// maintain a clear separation between rendering, control logic and various
// data sources so that code is more maintainable.
//
///////////////////////////////////////////////////////////////////////////////
class CommandController : public Controller {
public:
// The controller is constructed with an object implementing the
// CommandHandler interface, to which the Controller defers execution
// duties. This keeps the Controller fairly simple without requiring a
// lot of reworking of the command handlers. If there are significant
// groups of commands that require execution separated from this handler,
// then the Command object can be extended to provide a handler field that
// specifies a handler different to the default.
CommandController(CommandHandler* handler);
virtual ~CommandController();
// Add a button to the list of managed buttons. The button is synced with
// the provided command
void AddManagedButton(ChromeViews::Button* button, int command);
// Controller
virtual bool SupportsCommand(int id) const;
virtual bool IsCommandEnabled(int id) const;
virtual bool GetContextualLabel(int id, std::wstring* out) const;
virtual void ExecuteCommand(int id);
// Adds an observer to the state of a particular command. If the command does
// not exist, it is created, initialized to false.
void AddCommandObserver(int id, CommandObserver* observer);
// Removes an observer to the state of a particular command.
void RemoveCommandObserver(int id, CommandObserver* observer);
// Notify all observers of a particular command that the command has been
// enabled or disabled. If the command does not exist, it is created and
// initialized to |state|. This function is very lightweight if the command
// state has not changed.
void UpdateCommandEnabled(int id, bool state);
private:
///////////////////////////////////////////////////////////////////////////////
//
// ButtonController
//
// An adapter class to use ChromeViews buttons with our controller
//
///////////////////////////////////////////////////////////////////////////////
class ButtonController : public ChromeViews::BaseButton::ButtonListener,
public CommandObserver {
public:
ButtonController(ChromeViews::Button* b,
CommandController* controller,
int command)
: button_(b),
controller_(controller) {
controller_->AddCommandObserver(command, this);
button_->SetListener(this, command);
// The button's initial state should be the current command state.
button_->SetEnabled(controller_->IsCommandEnabled(command));
}
virtual void SetEnabled(bool enabled) {
button_->SetEnabled(enabled);
}
virtual void ButtonPressed(ChromeViews::BaseButton* sender) {
controller_->ExecuteCommand(sender->GetTag());
}
private:
ChromeViews::Button* button_;
CommandController* controller_;
};
// Get a Command node for a given command ID, creating an entry if it doesn't
// exist if desired.
Command* GetCommand(int id, bool create);
// This is the default handler for all command execution
CommandHandler* handler_;
// This is a map of command IDs to states and observer lists
CommandMap commands_;
// vector of ButtonController for managed buttons
std::vector<ButtonController*> managed_button_controllers_;
CommandController();
DISALLOW_EVIL_CONSTRUCTORS(CommandController);
};
#endif // CHROME_BROWSER_CONTROLLER_H__
|
