blob: 586f978663a90c01d330ecdc1cf6b8802fab8d08 (
plain)
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
|
// Copyright 2014 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 COMPONENTS_RENDERER_CONTEXT_MENU_RENDER_VIEW_CONTEXT_MENU_OBSERVER_H_
#define COMPONENTS_RENDERER_CONTEXT_MENU_RENDER_VIEW_CONTEXT_MENU_OBSERVER_H_
namespace content {
struct ContextMenuParams;
}
// The interface used for implementing context-menu items. The following
// instruction describe how to implement a context-menu item with this
// interface.
//
// 1. Add command IDs for the context-menu items to 'chrome_command_ids.h'.
//
// #define IDC_MY_COMMAND 99999
//
// 2. Add strings for the context-menu items to 'generated_sources.grd'.
//
// <message name="IDS_MY_COMMAND" desc="...">
// My command
// </message>
//
// 3. Create a class that implements this interface. (It is a good idea to use
// the RenderViewContextMenuProxy interface to avoid accessing the
// RenderViewContextMenu class directly.)
//
// class MyMenuObserver : public RenderViewContextMenuObserver {
// public:
// MyMenuObserver(RenderViewContextMenuProxy* p);
// ~MyMenuObserver() override;
//
// void InitMenu(const content::ContextMenuParams& params) override;
// bool IsCommandIdSupported(int command_id) override;
// bool IsCommandIdEnabled(int command_id) override;
// void ExecuteCommand(int command_id) override;
//
// private:
// RenderViewContextMenuProxy* proxy_;
// }
//
// void MyMenuObserver::InitMenu(const content::ContextMenuParams& params) {
// proxy_->AddMenuItem(IDC_MY_COMMAND,...);
// }
//
// bool MyMenuObserver::IsCommandIdSupported(int command_id) {
// return command_id == IDC_MY_COMMAND;
// }
//
// bool MyMenuObserver::IsCommandIdEnabled(int command_id) {
// DCHECK(command_id == IDC_MY_COMMAND);
// return true;
// }
//
// void MyMenuObserver::ExecuteCommand(int command_id) {
// DCHECK(command_id == IDC_MY_COMMAND);
// }
//
// 4. Add this observer class to the RenderViewContextMenu class. (It is good
// to use scoped_ptr<> so Chrome can create its instances only when it needs.)
//
// class RenderViewContextMenu {
// ...
// private:
// scoped_ptr<MyMenuObserver> my_menu_observer_;
// };
//
// 5. Create its instance in InitMenu() and add it to the observer list of the
// RenderViewContextMenu class.
//
// void RenderViewContextMenu::InitMenu() {
// ...
// my_menu_observer_.reset(new MyMenuObserver(this));
// observers_.AddObserver(my_menu_observer_.get());
// }
//
//
class RenderViewContextMenuObserver {
public:
virtual ~RenderViewContextMenuObserver() {}
// Called when the RenderViewContextMenu class initializes a context menu. We
// usually call RenderViewContextMenuProxy::AddMenuItem() to add menu items
// in this function.
virtual void InitMenu(const content::ContextMenuParams& params) {}
// Called when the RenderViewContextMenu class asks whether an observer
// listens for the specified command ID. If this function returns true, the
// RenderViewContextMenu class calls IsCommandIdEnabled() or ExecuteCommand().
virtual bool IsCommandIdSupported(int command_id);
// Called when the RenderViewContextMenu class sets the initial status of the
// specified context-menu item. If we need to enable or disable a context-menu
// item while showing, use RenderViewContextMenuProxy::UpdateMenuItem().
virtual bool IsCommandIdChecked(int command_id);
virtual bool IsCommandIdEnabled(int command_id);
// Called when a user selects the specified context-menu item.
virtual void ExecuteCommand(int command_id) {}
// Called when a user closes the context menu without selecting any items.
virtual void OnMenuCancel() {}
};
#endif // COMPONENTS_RENDERER_CONTEXT_MENU_RENDER_VIEW_CONTEXT_MENU_OBSERVER_H_
|
