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
|
// Copyright (c) 2010 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_VIEWS_ACCESSIBILITY_EVENT_ROUTER_VIEWS_H_
#define CHROME_BROWSER_VIEWS_ACCESSIBILITY_EVENT_ROUTER_VIEWS_H_
#pragma once
#include <string>
#include "base/basictypes.h"
#include "base/gtest_prod_util.h"
#include "base/hash_tables.h"
#include "base/singleton.h"
#include "base/task.h"
#include "chrome/browser/accessibility_events.h"
#include "views/accessibility/accessibility_types.h"
class Profile;
namespace views {
class View;
}
// Allows us to use (View*) in a hash_map with gcc.
#if defined(COMPILER_GCC)
namespace __gnu_cxx {
template<>
struct hash<views::View*> {
size_t operator()(views::View* view) const {
return reinterpret_cast<size_t>(view);
}
};
} // namespace __gnu_cxx
#endif // defined(COMPILER_GCC)
// NOTE: This class is part of the Accessibility Extension API, which lets
// extensions receive accessibility events. It's distinct from code that
// implements platform accessibility APIs like MSAA or ATK.
//
// Singleton class that adds listeners to many views, then sends an
// accessibility notification whenever a relevant event occurs in an
// accessible view.
//
// Views are not accessible by default. When you register a root widget,
// that widget and all of its descendants will start sending accessibility
// event notifications. You can then override the default behavior for
// specific descendants using other methods.
//
// You can use Profile::PauseAccessibilityEvents to prevent a flurry
// of accessibility events when a window is being created or initialized.
class AccessibilityEventRouterViews {
public:
// Internal information about a particular view to override the
// information we get directly from the view.
struct ViewInfo {
ViewInfo() : ignore(false) {}
// If nonempty, will use this name instead of the view's label.
std::string name;
// If true, will ignore this widget and not send accessibility events.
bool ignore;
};
// Get the single instance of this class.
static AccessibilityEventRouterViews* GetInstance();
// Start sending accessibility events for this view and all of its
// descendants. Notifications will go to the specified profile.
// Returns true on success, false if "view" was already registered.
// It is the responsibility of the caller to call RemoveViewTree if
// this view is ever deleted; consider using AccessibleViewHelper.
bool AddViewTree(views::View* view, Profile* profile);
// Stop sending accessibility events for this view and all of its
// descendants.
void RemoveViewTree(views::View* view);
// Don't send any events for this view.
void IgnoreView(views::View* view);
// Use the following string as the name of this view, instead of the
// gtk label associated with the view.
void SetViewName(views::View* view, std::string name);
// Forget all information about this view.
void RemoveView(views::View* view);
// Handle an accessibility event generated by a view.
void HandleAccessibilityEvent(
views::View* view, AccessibilityTypes::Event event_type);
private:
AccessibilityEventRouterViews();
virtual ~AccessibilityEventRouterViews();
friend struct DefaultSingletonTraits<AccessibilityEventRouterViews>;
FRIEND_TEST_ALL_PREFIXES(AccessibilityEventRouterViewsTest,
TestFocusNotification);
// Given a view, determine if it's part of a view tree that's mapped to
// a profile and if so, if it's marked as accessible.
void FindView(views::View* view, Profile** profile, bool* is_accessible);
// Checks the type of the view and calls one of the more specific
// Send*Notification methods, below.
void DispatchAccessibilityNotification(
views::View* view, NotificationType type);
// Return the name of a view.
std::string GetViewName(views::View* view);
// Each of these methods constructs an AccessibilityControlInfo object
// and sends a notification of a specific accessibility event.
void SendButtonNotification(
views::View* view, NotificationType type, Profile* profile);
void SendLinkNotification(
views::View* view, NotificationType type, Profile* profile);
void SendMenuNotification(
views::View* view, NotificationType type, Profile* profile);
void SendMenuItemNotification(
views::View* view, NotificationType type, Profile* profile);
// Return true if it's an event on a menu.
bool IsMenuEvent(views::View* view, NotificationType type);
// Recursively explore all menu items of |menu| and return in |count|
// the total number of items, and in |index| the 0-based index of
// |item|, if found. Initialize |count| to zero before calling this
// method. |index| will be unchanged if the item is not found, so
// initialize it to -1 to detect this case.
void RecursiveGetMenuItemIndexAndCount(
views::View* menu, views::View* item, int* index, int* count);
// The set of all view tree roots; only descendants of these will generate
// accessibility notifications.
base::hash_map<views::View*, Profile*> view_tree_profile_map_;
// Extra information about specific views.
base::hash_map<views::View*, ViewInfo> view_info_map_;
// The profile associated with the most recent window event - used to
// figure out where to route a few events that can't be directly traced
// to a window with a profile (like menu events).
Profile* most_recent_profile_;
// Used to defer handling of some events until the next time
// through the event loop.
ScopedRunnableMethodFactory<AccessibilityEventRouterViews> method_factory_;
};
#endif // CHROME_BROWSER_VIEWS_ACCESSIBILITY_EVENT_ROUTER_VIEWS_H_
|
