OLD | NEW |
1 // Copyright 2016 The Chromium Authors. All rights reserved. | 1 // Copyright 2016 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef CONTENT_BROWSER_RENDERER_HOST_TEXT_INPUT_MANAGER_H__ | 5 #ifndef CONTENT_BROWSER_RENDERER_HOST_TEXT_INPUT_MANAGER_H__ |
6 #define CONTENT_BROWSER_RENDERER_HOST_TEXT_INPUT_MANAGER_H__ | 6 #define CONTENT_BROWSER_RENDERER_HOST_TEXT_INPUT_MANAGER_H__ |
7 | 7 |
8 #include <unordered_map> | 8 #include <unordered_map> |
9 | 9 |
10 #include "base/observer_list.h" | 10 #include "base/observer_list.h" |
11 #include "content/common/content_export.h" | 11 #include "content/common/content_export.h" |
12 #include "content/common/text_input_state.h" | 12 #include "content/common/text_input_state.h" |
13 | 13 |
14 namespace content { | 14 namespace content { |
15 | 15 |
16 class RenderWidgetHostImpl; | |
17 class RenderWidgetHostView; | 16 class RenderWidgetHostView; |
18 class RenderWidgetHostViewBase; | 17 class RenderWidgetHostViewBase; |
19 class WebContents; | 18 class WebContents; |
20 | 19 |
21 // A class which receives updates of TextInputState from multiple sources and | 20 // A class which receives updates of TextInputState from multiple sources and |
22 // decides what the new TextInputState is. It also notifies the observers when | 21 // decides what the new TextInputState is. It also notifies the observers when |
23 // text input state is updated. | 22 // text input state is updated. |
24 class CONTENT_EXPORT TextInputManager { | 23 class CONTENT_EXPORT TextInputManager { |
25 public: | 24 public: |
26 // The tab's top-level RWHV should be an observer of TextInputManager to get | 25 // The tab's top-level RWHV should be an observer of TextInputManager to get |
27 // notifications about changes in TextInputState or other IME related state | 26 // notifications about changes in TextInputState or other IME related state |
28 // for child frames. | 27 // for child frames. |
29 class CONTENT_EXPORT Observer { | 28 class CONTENT_EXPORT Observer { |
30 public: | 29 public: |
31 // Called when a view has called UpdateTextInputState on TextInputManager. | 30 // Called when a view has called UpdateTextInputState on TextInputManager. |
32 // If the call has led to a change in TextInputState, |did_update_state| is | 31 // If the call has led to a change in TextInputState, |did_update_state| is |
33 // true. In some plaforms, we need this update even when the state has not | 32 // true. In some plaforms, we need this update even when the state has not |
34 // changed (e.g., Aura for updating IME). | 33 // changed (e.g., Aura for updating IME). |
35 virtual void OnUpdateTextInputStateCalled( | 34 virtual void OnUpdateTextInputStateCalled( |
36 TextInputManager* text_input_manager, | 35 TextInputManager* text_input_manager, |
37 RenderWidgetHostViewBase* updated_view, | 36 RenderWidgetHostViewBase* updated_view, |
38 bool did_update_state) {} | 37 bool did_update_state) {} |
39 }; | 38 }; |
40 | 39 |
41 TextInputManager(); | 40 TextInputManager(); |
42 ~TextInputManager(); | 41 ~TextInputManager(); |
43 | 42 |
44 // --------------------------------------------------------------------------- | 43 // Returns the currently active view (i.e., the RWHV with a focused <input> |
45 // The following methods can be used to obtain information about IME-related | 44 // element), or nullptr if none exist. The |active_view_| cannot have a |
46 // state for the active RenderWidget. | 45 // |TextInputState.type| of ui::TEXT_INPUT_TYPE_NONE. |
47 | 46 RenderWidgetHostViewBase* GetActiveView() const; |
48 // Returns the currently active widget, i.e., the RWH which is associated with | |
49 // |active_view_|. | |
50 RenderWidgetHostImpl* GetActiveWidget() const; | |
51 | 47 |
52 // Returns the TextInputState corresponding to |active_view_|. | 48 // Returns the TextInputState corresponding to |active_view_|. |
53 // Users of this method should not hold on to the pointer as it might become | 49 // Users of this method should not hold on to the pointer as it might become |
54 // dangling if the TextInputManager or |active_view_| might go away. | 50 // dangling if the TextInputManager or |active_view_| might go away. |
55 const TextInputState* GetTextInputState(); | 51 const TextInputState* GetTextInputState(); |
56 | 52 |
57 // --------------------------------------------------------------------------- | |
58 // The following methods are called by RWHVs on the tab to update their IME- | |
59 // related state. | |
60 | |
61 // Updates the TextInputState for |view|. | 53 // Updates the TextInputState for |view|. |
62 void UpdateTextInputState(RenderWidgetHostViewBase* view, | 54 void UpdateTextInputState(RenderWidgetHostViewBase* view, |
63 const TextInputState& state); | 55 const TextInputState& state); |
64 | 56 |
65 // Registers the given |view| for tracking its TextInputState. This is called | 57 // Registers the given |view| for tracking its TextInputState. This is called |
66 // by any view which has updates in its TextInputState (whether tab's RWHV or | 58 // by any view which has updates in its TextInputState (whether tab's RWHV or |
67 // that of a child frame). The |view| must unregister itself before being | 59 // that of a child frame). The |view| must unregister itself before being |
68 // destroyed (i.e., call TextInputManager::Unregister). | 60 // destroyed (i.e., call TextInputManager::Unregister). |
69 void Register(RenderWidgetHostViewBase* view); | 61 void Register(RenderWidgetHostViewBase* view); |
70 | 62 |
71 // Clears the TextInputState from the |view|. If |view == active_view_|, this | 63 // Clears the TextInputState from the |view|. If |view == active_view_|, this |
72 // call will lead to a TextInputState update since the TextInputState.type | 64 // call will lead to a TextInputState update since the TextInputState.type |
73 // should be reset to none. | 65 // should be reset to none. |
74 void Unregister(RenderWidgetHostViewBase* view); | 66 void Unregister(RenderWidgetHostViewBase* view); |
75 | 67 |
76 // Returns true if |view| is already registered. | 68 // Returns true if |view| is already registered. |
77 bool IsRegistered(RenderWidgetHostViewBase* view) const; | 69 bool IsRegistered(RenderWidgetHostViewBase* view) const; |
78 | 70 |
79 // Add and remove observers for notifications regarding updates in the | 71 // Add and remove observers for notifications regarding updates in the |
80 // TextInputState. Clients must be sure to remove themselves before they go | 72 // TextInputState. Clients must be sure to remove themselves before they go |
81 // away. | 73 // away. |
82 // Only the tab's RWHV should observer TextInputManager. In tests, however, | 74 // Only the tab's RWHV should observer TextInputManager. In tests, however, |
83 // in addition to the tab's RWHV, one or more test observers might observe | 75 // in addition to the tab's RWHV, one or more test observers might observe |
84 // TextInputManager. | 76 // TextInputManager. |
85 void AddObserver(Observer* observer); | 77 void AddObserver(Observer* observer); |
86 void RemoveObserver(Observer* observer); | 78 void RemoveObserver(Observer* observer); |
87 | 79 |
88 RenderWidgetHostViewBase* active_view_for_testing() { return active_view_; } | |
89 | |
90 private: | 80 private: |
91 friend bool GetTextInputTypeForView(WebContents* web_contents, | 81 friend bool GetTextInputTypeForView(WebContents* web_contents, |
92 RenderWidgetHostView* view, | 82 RenderWidgetHostView* view, |
93 ui::TextInputType* type); | 83 ui::TextInputType* type); |
94 | 84 |
95 void NotifyObserversAboutInputStateUpdate(RenderWidgetHostViewBase* view, | 85 void NotifyObserversAboutInputStateUpdate(RenderWidgetHostViewBase* view, |
96 bool did_update_state); | 86 bool did_update_state); |
97 | 87 |
98 // The view with active text input state, i.e., a focused <input> element. | 88 // The view with active text input state. |
99 // It will be nullptr if no such view exists. Note that the active view | |
100 // cannot have a |TextInputState.type| of ui::TEXT_INPUT_TYPE_NONE. | |
101 RenderWidgetHostViewBase* active_view_; | 89 RenderWidgetHostViewBase* active_view_; |
102 | 90 |
103 std::unordered_map<RenderWidgetHostViewBase*, TextInputState> | 91 std::unordered_map<RenderWidgetHostViewBase*, TextInputState> |
104 text_input_state_map_; | 92 text_input_state_map_; |
105 | 93 |
106 base::ObserverList<Observer> observer_list_; | 94 base::ObserverList<Observer> observer_list_; |
107 | 95 |
108 DISALLOW_COPY_AND_ASSIGN(TextInputManager); | 96 DISALLOW_COPY_AND_ASSIGN(TextInputManager); |
109 }; | 97 }; |
110 } | 98 } |
111 | 99 |
112 #endif // CONTENT_BROWSER_RENDERER_HOST_TEXT_INPUT_MANAGER_H__ | 100 #endif // CONTENT_BROWSER_RENDERER_HOST_TEXT_INPUT_MANAGER_H__ |
OLD | NEW |