ui/events/event_utils.h

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