Remove unused parameter.
[chromium-blink-merge.git] / ui / keyboard / keyboard_util.h
blobdc1c97b7b756b1441988f082987006faae42aea5
1 // Copyright (c) 2013 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.
5 #ifndef UI_KEYBOARD_KEYBOARD_UTIL_H_
6 #define UI_KEYBOARD_KEYBOARD_UTIL_H_
8 #include <string>
10 #include "base/strings/string16.h"
11 // TODO(beng): replace with forward decl once RootWindow is renamed.
12 #include "ui/aura/window.h"
13 #include "ui/keyboard/keyboard_export.h"
15 struct GritResourceMap;
17 namespace aura {
18 class WindowTreeHost;
21 class GURL;
23 namespace keyboard {
25 // Enumeration of swipe directions.
26 enum CursorMoveDirection {
27 kCursorMoveRight = 0x01,
28 kCursorMoveLeft = 0x02,
29 kCursorMoveUp = 0x04,
30 kCursorMoveDown = 0x08
33 // An enumeration of different keyboard control events that should be logged.
34 enum KeyboardControlEvent {
35 KEYBOARD_CONTROL_SHOW = 0,
36 KEYBOARD_CONTROL_HIDE_AUTO,
37 KEYBOARD_CONTROL_HIDE_USER,
38 KEYBOARD_CONTROL_MAX,
41 // An enumeration of keyboard overscroll override value.
42 enum KeyboardOverscrolOverride {
43 KEYBOARD_OVERSCROLL_OVERRIDE_DISABLED = 0,
44 KEYBOARD_OVERSCROLL_OVERRIDE_ENABLED,
45 KEYBOARD_OVERSCROLL_OVERRIDE_NONE,
48 // An enumeration of keyboard policy settings.
49 enum KeyboardShowOverride {
50 KEYBOARD_SHOW_OVERRIDE_DISABLED = 0,
51 KEYBOARD_SHOW_OVERRIDE_ENABLED,
52 KEYBOARD_SHOW_OVERRIDE_NONE,
55 // Gets the default keyboard bounds from |window_bounds|.
56 KEYBOARD_EXPORT gfx::Rect DefaultKeyboardBoundsFromWindowBounds(
57 const gfx::Rect& window_bounds);
59 // Gets the caculated keyboard bounds from |window_bounds|. The keyboard height
60 // is specified by |keyboard_height|.
61 KEYBOARD_EXPORT gfx::Rect KeyboardBoundsFromWindowBounds(
62 const gfx::Rect& window_bounds, int keyboard_height);
64 // Sets the state of the a11y onscreen keyboard.
65 KEYBOARD_EXPORT void SetAccessibilityKeyboardEnabled(bool enabled);
67 // Gets the state of the a11y onscreen keyboard.
68 KEYBOARD_EXPORT bool GetAccessibilityKeyboardEnabled();
70 // Sets the state of the touch onscreen keyboard.
71 KEYBOARD_EXPORT void SetTouchKeyboardEnabled(bool enabled);
73 // Gets the state of the touch onscreen keyboard.
74 KEYBOARD_EXPORT bool GetTouchKeyboardEnabled();
76 // Gets the default keyboard layout.
77 KEYBOARD_EXPORT std::string GetKeyboardLayout();
79 // Returns true if the virtual keyboard is enabled.
80 KEYBOARD_EXPORT bool IsKeyboardEnabled();
82 // Returns true if keyboard overscroll mode is enabled.
83 KEYBOARD_EXPORT bool IsKeyboardOverscrollEnabled();
85 // Sets temporary keyboard overscroll override.
86 KEYBOARD_EXPORT void SetKeyboardOverscrollOverride(
87 KeyboardOverscrolOverride override);
89 // Sets policy override on whether to show the keyboard.
90 KEYBOARD_EXPORT void SetKeyboardShowOverride(KeyboardShowOverride override);
92 // Returns true if an IME extension can specify a custom input view for the
93 // virtual keyboard window.
94 KEYBOARD_EXPORT bool IsInputViewEnabled();
96 // Returns true if experimental features are enabled for IME input-views.
97 KEYBOARD_EXPORT bool IsExperimentalInputViewEnabled();
99 // Returns true if gesture typing is enabled for virtual keyboard.
100 KEYBOARD_EXPORT bool IsGestureTypingEnabled();
102 // Returns true if gesture deletion is enabled for virtual keyboard.
103 KEYBOARD_EXPORT bool IsGestureDeletionEnabled();
105 // Returns true if gesture selection is enabled for virtual keyboard.
106 KEYBOARD_EXPORT bool IsGestureSelectionEnabled();
108 // Insert |text| into the active TextInputClient if there is one. Returns true
109 // if |text| was successfully inserted.
110 KEYBOARD_EXPORT bool InsertText(const base::string16& text);
112 // Move cursor when swipe on the virtualkeyboard. Returns true if cursor was
113 // successfully moved according to |swipe_direction|.
114 KEYBOARD_EXPORT bool MoveCursor(int swipe_direction,
115 int modifier_flags,
116 aura::WindowTreeHost* host);
118 // Sends a fabricated key event, where |type| is the event type, |key_value|
119 // is the unicode value of the character, |key_code| is the legacy key code
120 // value, |key_name| is the name of the key as defined in the DOM3 key event
121 // specification, and |modifier| indicates if any modifier keys are being
122 // virtually pressed. The event is dispatched to the active TextInputClient
123 // associated with |root_window|. The type may be "keydown" or "keyup".
124 KEYBOARD_EXPORT bool SendKeyEvent(std::string type,
125 int key_value,
126 int key_code,
127 std::string key_name,
128 int modifiers,
129 aura::WindowTreeHost* host);
131 // Marks that the keyboard load has started. This is used to measure the time it
132 // takes to fully load the keyboard. This should be called before
133 // MarkKeyboardLoadFinished.
134 KEYBOARD_EXPORT void MarkKeyboardLoadStarted();
136 // Marks that the keyboard load has ended. This finishes measuring that the
137 // keyboard is loaded.
138 KEYBOARD_EXPORT void MarkKeyboardLoadFinished();
140 // Get the list of keyboard resources. |size| is populated with the number of
141 // resources in the returned array.
142 KEYBOARD_EXPORT const GritResourceMap* GetKeyboardExtensionResources(
143 size_t* size);
145 // Sets the override content url.
146 // This is used by for input view for extension IMEs.
147 KEYBOARD_EXPORT void SetOverrideContentUrl(const GURL& url);
149 // Gets the override content url.
150 KEYBOARD_EXPORT const GURL& GetOverrideContentUrl();
152 // Logs the keyboard control event as a UMA stat.
153 void LogKeyboardControlEvent(KeyboardControlEvent event);
155 } // namespace keyboard
157 #endif // UI_KEYBOARD_KEYBOARD_UTIL_H_