OLD | NEW |
| (Empty) |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | |
2 // Use of this source code is governed by a BSD-style license that can be | |
3 // found in the LICENSE file. | |
4 | |
5 #ifndef CHROMEOS_IME_IME_KEYBOARD_H_ | |
6 #define CHROMEOS_IME_IME_KEYBOARD_H_ | |
7 | |
8 #include <string> | |
9 #include <vector> | |
10 | |
11 #include "base/basictypes.h" | |
12 #include "base/observer_list.h" | |
13 #include "chromeos/chromeos_export.h" | |
14 | |
15 namespace chromeos { | |
16 namespace input_method { | |
17 | |
18 struct AutoRepeatRate { | |
19 AutoRepeatRate() : initial_delay_in_ms(0), repeat_interval_in_ms(0) {} | |
20 unsigned int initial_delay_in_ms; | |
21 unsigned int repeat_interval_in_ms; | |
22 }; | |
23 | |
24 enum ModifierKey { | |
25 kSearchKey = 0, // Customizable. | |
26 kControlKey, // Customizable. | |
27 kAltKey, // Customizable. | |
28 kVoidKey, | |
29 kCapsLockKey, | |
30 kEscapeKey, | |
31 // IMPORTANT: You should update kCustomizableKeys[] in .cc file, if you | |
32 // add a customizable key. | |
33 kNumModifierKeys, | |
34 }; | |
35 | |
36 class InputMethodUtil; | |
37 | |
38 class CHROMEOS_EXPORT ImeKeyboard { | |
39 public: | |
40 class Observer { | |
41 public: | |
42 // Called when the caps lock state has changed. | |
43 virtual void OnCapsLockChanged(bool enabled) = 0; | |
44 }; | |
45 | |
46 ImeKeyboard(); | |
47 virtual ~ImeKeyboard(); | |
48 // Adds/removes observer. | |
49 virtual void AddObserver(Observer* observer); | |
50 virtual void RemoveObserver(Observer* observer); | |
51 | |
52 // Sets the current keyboard layout to |layout_name|. This function does not | |
53 // change the current mapping of the modifier keys. Returns true on success. | |
54 virtual bool SetCurrentKeyboardLayoutByName( | |
55 const std::string& layout_name) = 0; | |
56 | |
57 // Sets the current keyboard layout again. We have to call the function every | |
58 // time when "XI_HierarchyChanged" XInput2 event is sent to Chrome. See | |
59 // xinput_hierarchy_changed_event_listener.h for details. | |
60 virtual bool ReapplyCurrentKeyboardLayout() = 0; | |
61 | |
62 // Updates keyboard LEDs on all keyboards. | |
63 // XKB asymmetrically propagates keyboard modifier indicator state changes to | |
64 // slave keyboards. If the state change is initiated from a client to the | |
65 // "core/master keyboard", XKB changes global state and pushes an indication | |
66 // change down to all keyboards. If the state change is initiated by one slave | |
67 // (physical) keyboard, it changes global state but only pushes an indicator | |
68 // state change down to that one keyboard. | |
69 // This function changes LEDs on all keyboards by explicitly updating the | |
70 // core/master keyboard. | |
71 virtual void ReapplyCurrentModifierLockStatus() = 0; | |
72 | |
73 // Disables the num lock. | |
74 virtual void DisableNumLock() = 0; | |
75 | |
76 // Sets the caps lock status to |enable_caps_lock|. Do not call the function | |
77 // from non-UI threads. | |
78 virtual void SetCapsLockEnabled(bool enable_caps_lock); | |
79 | |
80 // Returns true if caps lock is enabled. Do not call the function from non-UI | |
81 // threads. | |
82 virtual bool CapsLockIsEnabled(); | |
83 | |
84 // Returns true if the current layout supports ISO Level 5 shift. | |
85 virtual bool IsISOLevel5ShiftAvailable() const; | |
86 | |
87 // Returns true if the current layout supports alt gr. | |
88 virtual bool IsAltGrAvailable() const; | |
89 | |
90 // Turns on and off the auto-repeat of the keyboard. Returns true on success. | |
91 // Do not call the function from non-UI threads. | |
92 virtual bool SetAutoRepeatEnabled(bool enabled) = 0; | |
93 | |
94 // Sets the auto-repeat rate of the keyboard, initial delay in ms, and repeat | |
95 // interval in ms. Returns true on success. Do not call the function from | |
96 // non-UI threads. | |
97 virtual bool SetAutoRepeatRate(const AutoRepeatRate& rate) = 0; | |
98 | |
99 // Returns true if auto repeat is enabled. This function is protected: for | |
100 // testability. | |
101 static CHROMEOS_EXPORT bool GetAutoRepeatEnabledForTesting(); | |
102 | |
103 // On success, set current auto repeat rate on |out_rate| and returns true. | |
104 // Returns false otherwise. This function is protected: for testability. | |
105 static CHROMEOS_EXPORT bool GetAutoRepeatRateForTesting( | |
106 AutoRepeatRate* out_rate); | |
107 | |
108 // Returns false if |layout_name| contains a bad character. | |
109 static CHROMEOS_EXPORT bool CheckLayoutNameForTesting( | |
110 const std::string& layout_name); | |
111 | |
112 // Note: At this moment, classes other than InputMethodManager should not | |
113 // instantiate the ImeKeyboard class. | |
114 static ImeKeyboard* Create(); | |
115 | |
116 bool caps_lock_is_enabled_; | |
117 std::string last_layout_; | |
118 | |
119 private: | |
120 ObserverList<Observer> observers_; | |
121 }; | |
122 | |
123 } // namespace input_method | |
124 } // namespace chromeos | |
125 | |
126 #endif // CHROMEOS_IME_IME_KEYBOARD_H_ | |
OLD | NEW |