Updating trunk VERSION from 2139.0 to 2140.0
[chromium-blink-merge.git] / ui / events / event_utils.h
blob312d580e0e6d4dde4261c3bb147d67217351ee06
1 // Copyright (c) 2012 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_EVENTS_EVENT_UTILS_H_
6 #define UI_EVENTS_EVENT_UTILS_H_
8 #include "base/event_types.h"
9 #include "base/memory/scoped_ptr.h"
10 #include "ui/events/event_constants.h"
11 #include "ui/events/keycodes/keyboard_codes.h"
12 #include "ui/gfx/display.h"
13 #include "ui/gfx/native_widget_types.h"
14 #include "ui/events/events_export.h"
16 #if defined(OS_WIN)
17 #include <windows.h>
18 #endif
20 namespace gfx {
21 class Point;
22 class Vector2d;
25 namespace base {
26 class TimeDelta;
29 namespace ui {
31 class Event;
32 class MouseEvent;
34 // Updates the list of devices for cached properties.
35 EVENTS_EXPORT void UpdateDeviceList();
37 // Returns a ui::Event wrapping a native event. Ownership of the returned value
38 // is transferred to the caller.
39 EVENTS_EXPORT scoped_ptr<Event> EventFromNative(
40 const base::NativeEvent& native_event);
42 // Get the EventType from a native event.
43 EVENTS_EXPORT EventType EventTypeFromNative(
44 const base::NativeEvent& native_event);
46 // Get the EventFlags from a native event.
47 EVENTS_EXPORT int EventFlagsFromNative(const base::NativeEvent& native_event);
49 // Get the timestamp from a native event.
50 EVENTS_EXPORT base::TimeDelta EventTimeFromNative(
51 const base::NativeEvent& native_event);
53 // Create a timestamp based on the current time.
54 EVENTS_EXPORT base::TimeDelta EventTimeForNow();
56 // Get the location from a native event. The coordinate system of the resultant
57 // |Point| has the origin at top-left of the "root window". The nature of
58 // this "root window" and how it maps to platform-specific drawing surfaces is
59 // defined in ui/aura/root_window.* and ui/aura/window_tree_host*.
60 // TODO(tdresser): Return gfx::PointF here. See crbug.com/337827.
61 EVENTS_EXPORT gfx::Point EventLocationFromNative(
62 const base::NativeEvent& native_event);
64 // Gets the location in native system coordinate space.
65 EVENTS_EXPORT gfx::Point EventSystemLocationFromNative(
66 const base::NativeEvent& native_event);
68 #if defined(USE_X11)
69 // Returns the 'real' button for an event. The button reported in slave events
70 // does not take into account any remapping (e.g. using xmodmap), while the
71 // button reported in master events do. This is a utility function to always
72 // return the mapped button.
73 EVENTS_EXPORT int EventButtonFromNative(const base::NativeEvent& native_event);
74 #endif
76 // Returns the KeyboardCode from a native event.
77 EVENTS_EXPORT KeyboardCode KeyboardCodeFromNative(
78 const base::NativeEvent& native_event);
80 // Returns the DOM KeyboardEvent code (physical location in the
81 // keyboard) from a native event. The ownership of the return value
82 // is NOT trasferred to the caller.
83 EVENTS_EXPORT const char* CodeFromNative(
84 const base::NativeEvent& native_event);
86 // Returns the platform related key code. For X11, it is xksym value.
87 EVENTS_EXPORT uint32 PlatformKeycodeFromNative(
88 const base::NativeEvent& native_event);
90 // Returns the windows key code. Note that this value is different from
91 // KeyboardCodeFromNative (there is a divergence between ui::KeyboardCode and
92 // windows key codes).
93 EVENTS_EXPORT uint32 WindowsKeycodeFromNative(
94 const base::NativeEvent& native_event);
96 // Returns the text generated by this keystroke. Used in the value we pass to
97 // blink.
98 EVENTS_EXPORT uint16 TextFromNative(const base::NativeEvent& native_event);
100 // Returns the unmodified text generated by this keystroke. Used in the value
101 // we pass to blink.
102 EVENTS_EXPORT uint16 UnmodifiedTextFromNative(
103 const base::NativeEvent& native_event);
105 #if defined(OS_LINUX)
106 // Returns a control character sequences from a |windows_key_code|.
107 EVENTS_EXPORT uint16 GetControlCharacterForKeycode(int windows_key_code,
108 bool shift);
109 #endif
111 // Returns true if the keyboard event is a character event rather than
112 // a keystroke event.
113 EVENTS_EXPORT bool IsCharFromNative(const base::NativeEvent& native_event);
115 // Returns the flags of the button that changed during a press/release.
116 EVENTS_EXPORT int GetChangedMouseButtonFlagsFromNative(
117 const base::NativeEvent& native_event);
119 // Gets the mouse wheel offsets from a native event.
120 EVENTS_EXPORT gfx::Vector2d GetMouseWheelOffset(
121 const base::NativeEvent& native_event);
123 // Returns a copy of |native_event|. Depending on the platform, this copy may
124 // need to be deleted with ReleaseCopiedNativeEvent().
125 base::NativeEvent CopyNativeEvent(
126 const base::NativeEvent& native_event);
128 // Delete a |native_event| previously created by CopyNativeEvent().
129 void ReleaseCopiedNativeEvent(
130 const base::NativeEvent& native_event);
132 // Gets the touch id from a native event.
133 EVENTS_EXPORT int GetTouchId(const base::NativeEvent& native_event);
135 // Increases the number of times |ClearTouchIdIfReleased| needs to be called on
136 // an event with a given touch id before it will actually be cleared.
137 EVENTS_EXPORT void IncrementTouchIdRefCount(
138 const base::NativeEvent& native_event);
140 // Clear the touch id from bookkeeping if it is a release/cancel event.
141 EVENTS_EXPORT void ClearTouchIdIfReleased(
142 const base::NativeEvent& native_event);
144 // Gets the radius along the X/Y axis from a native event. Default is 1.0.
145 EVENTS_EXPORT float GetTouchRadiusX(const base::NativeEvent& native_event);
146 EVENTS_EXPORT float GetTouchRadiusY(const base::NativeEvent& native_event);
148 // Gets the angle of the major axis away from the X axis. Default is 0.0.
149 EVENTS_EXPORT float GetTouchAngle(const base::NativeEvent& native_event);
151 // Gets the force from a native_event. Normalized to be [0, 1]. Default is 0.0.
152 EVENTS_EXPORT float GetTouchForce(const base::NativeEvent& native_event);
154 // Gets the fling velocity from a native event. is_cancel is set to true if
155 // this was a tap down, intended to stop an ongoing fling.
156 EVENTS_EXPORT bool GetFlingData(const base::NativeEvent& native_event,
157 float* vx,
158 float* vy,
159 float* vx_ordinal,
160 float* vy_ordinal,
161 bool* is_cancel);
163 // Returns whether this is a scroll event and optionally gets the amount to be
164 // scrolled. |x_offset|, |y_offset| and |finger_count| can be NULL.
165 EVENTS_EXPORT bool GetScrollOffsets(const base::NativeEvent& native_event,
166 float* x_offset,
167 float* y_offset,
168 float* x_offset_ordinal,
169 float* y_offset_ordinal,
170 int* finger_count);
172 // Returns whether natural scrolling should be used for touchpad.
173 EVENTS_EXPORT bool ShouldDefaultToNaturalScroll();
175 // Returns whether or not the internal display produces touch events.
176 EVENTS_EXPORT gfx::Display::TouchSupport GetInternalDisplayTouchSupport();
178 #if defined(OS_WIN)
179 EVENTS_EXPORT int GetModifiersFromACCEL(const ACCEL& accel);
180 EVENTS_EXPORT int GetModifiersFromKeyState();
182 // Returns true if |message| identifies a mouse event that was generated as the
183 // result of a touch event.
184 EVENTS_EXPORT bool IsMouseEventFromTouch(UINT message);
186 // Converts scan code and lParam each other. The scan code
187 // representing an extended key contains 0xE000 bits.
188 EVENTS_EXPORT uint16 GetScanCodeFromLParam(LPARAM lParam);
189 EVENTS_EXPORT LPARAM GetLParamFromScanCode(uint16 scan_code);
191 #endif
193 #if defined(USE_X11)
194 // Update the native X11 event to correspond to the new flags.
195 EVENTS_EXPORT void UpdateX11EventForFlags(Event* event);
196 // Update the native X11 event to correspond to the new button flags.
197 EVENTS_EXPORT void UpdateX11EventForChangedButtonFlags(MouseEvent* event);
198 #endif
200 // Registers a custom event type.
201 EVENTS_EXPORT int RegisterCustomEventType();
203 } // namespace ui
205 #endif // UI_EVENTS_EVENT_UTILS_H_