widget/TouchEvents.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef mozilla_TouchEvents_h__
   7 #define mozilla_TouchEvents_h__
   8
   9 #include <stdint.h>
  10
  11 #include "mozilla/dom/Touch.h"
  12 #include "mozilla/MouseEvents.h"
  13 #include "nsAutoPtr.h"
  14 #include "nsIDOMSimpleGestureEvent.h"
  15 #include "nsTArray.h"
  16
  17 namespace mozilla {
  18
  19 /******************************************************************************
  20  * mozilla::WidgetGestureNotifyEvent
  21  *
  22  * This event is the first event generated when the user touches
  23  * the screen with a finger, and it's meant to decide what kind
  24  * of action we'll use for that touch interaction.
  25  *
  26  * The event is dispatched to the layout and based on what is underneath
  27  * the initial contact point it's then decided if we should pan
  28  * (finger scrolling) or drag the target element.
  29  ******************************************************************************/
  30
  31 class WidgetGestureNotifyEvent : public WidgetGUIEvent
  32 {
  33 public:
  34   virtual WidgetGestureNotifyEvent* AsGestureNotifyEvent() MOZ_OVERRIDE
  35   {
  36     return this;
  37   }
  38
  39   WidgetGestureNotifyEvent(bool aIsTrusted, uint32_t aMessage,
  40                            nsIWidget *aWidget)
  41     : WidgetGUIEvent(aIsTrusted, aMessage, aWidget, eGestureNotifyEventClass)
  42     , panDirection(ePanNone)
  43     , displayPanFeedback(false)
  44   {
  45   }
  46
  47   virtual WidgetEvent* Duplicate() const MOZ_OVERRIDE
  48   {
  49     // XXX Looks like this event is handled only in PostHandleEvent() of
  50     //     EventStateManager.  Therefore, it might be possible to handle this
  51     //     in PreHandleEvent() and not to dispatch as a DOM event into the DOM
  52     //     tree like ContentQueryEvent.  Then, this event doesn't need to
  53     //     support Duplicate().
  54     MOZ_ASSERT(mClass == eGestureNotifyEventClass,
  55                "Duplicate() must be overridden by sub class");
  56     // Not copying widget, it is a weak reference.
  57     WidgetGestureNotifyEvent* result =
  58       new WidgetGestureNotifyEvent(false, message, nullptr);
  59     result->AssignGestureNotifyEventData(*this, true);
  60     result->mFlags = mFlags;
  61     return result;
  62   }
  63
  64   enum ePanDirection
  65   {
  66     ePanNone,
  67     ePanVertical,
  68     ePanHorizontal,
  69     ePanBoth
  70   };
  71
  72   ePanDirection panDirection;
  73   bool displayPanFeedback;
  74
  75   void AssignGestureNotifyEventData(const WidgetGestureNotifyEvent& aEvent,
  76                                     bool aCopyTargets)
  77   {
  78     AssignGUIEventData(aEvent, aCopyTargets);
  79
  80     panDirection = aEvent.panDirection;
  81     displayPanFeedback = aEvent.displayPanFeedback;
  82   }
  83 };
  84
  85 /******************************************************************************
  86  * mozilla::WidgetTouchEvent
  87  ******************************************************************************/
  88
  89 class WidgetSimpleGestureEvent : public WidgetMouseEventBase
  90 {
  91 public:
  92   virtual WidgetSimpleGestureEvent* AsSimpleGestureEvent() MOZ_OVERRIDE
  93   {
  94     return this;
  95   }
  96
  97   WidgetSimpleGestureEvent(bool aIsTrusted, uint32_t aMessage,
  98                            nsIWidget* aWidget)
  99     : WidgetMouseEventBase(aIsTrusted, aMessage, aWidget,
 100                            eSimpleGestureEventClass)
 101     , allowedDirections(0)
 102     , direction(0)
 103     , delta(0.0)
 104     , clickCount(0)
 105   {
 106   }
 107
 108   WidgetSimpleGestureEvent(const WidgetSimpleGestureEvent& aOther)
 109     : WidgetMouseEventBase(aOther.mFlags.mIsTrusted, aOther.message,
 110                            aOther.widget, eSimpleGestureEventClass)
 111     , allowedDirections(aOther.allowedDirections)
 112     , direction(aOther.direction)
 113     , delta(aOther.delta)
 114     , clickCount(0)
 115   {
 116   }
 117
 118   virtual WidgetEvent* Duplicate() const MOZ_OVERRIDE
 119   {
 120     MOZ_ASSERT(mClass == eSimpleGestureEventClass,
 121                "Duplicate() must be overridden by sub class");
 122     // Not copying widget, it is a weak reference.
 123     WidgetSimpleGestureEvent* result =
 124       new WidgetSimpleGestureEvent(false, message, nullptr);
 125     result->AssignSimpleGestureEventData(*this, true);
 126     result->mFlags = mFlags;
 127     return result;
 128   }
 129
 130   // See nsIDOMSimpleGestureEvent for values
 131   uint32_t allowedDirections;
 132   // See nsIDOMSimpleGestureEvent for values
 133   uint32_t direction;
 134   // Delta for magnify and rotate events
 135   double delta;
 136   // The number of taps for tap events
 137   uint32_t clickCount;
 138
 139   // XXX Not tested by test_assign_event_data.html
 140   void AssignSimpleGestureEventData(const WidgetSimpleGestureEvent& aEvent,
 141                                     bool aCopyTargets)
 142   {
 143     AssignMouseEventBaseData(aEvent, aCopyTargets);
 144
 145     // allowedDirections isn't copied
 146     direction = aEvent.direction;
 147     delta = aEvent.delta;
 148     clickCount = aEvent.clickCount;
 149   }
 150 };
 151
 152 /******************************************************************************
 153  * mozilla::WidgetTouchEvent
 154  ******************************************************************************/
 155
 156 class WidgetTouchEvent : public WidgetInputEvent
 157 {
 158 public:
 159   typedef nsTArray<nsRefPtr<mozilla::dom::Touch>> TouchArray;
 160   typedef nsAutoTArray<nsRefPtr<mozilla::dom::Touch>, 10> AutoTouchArray;
 161
 162   virtual WidgetTouchEvent* AsTouchEvent() MOZ_OVERRIDE { return this; }
 163
 164   WidgetTouchEvent()
 165   {
 166   }
 167
 168   WidgetTouchEvent(const WidgetTouchEvent& aOther)
 169     : WidgetInputEvent(aOther.mFlags.mIsTrusted, aOther.message, aOther.widget,
 170                        eTouchEventClass)
 171   {
 172     modifiers = aOther.modifiers;
 173     time = aOther.time;
 174     timeStamp = aOther.timeStamp;
 175     touches.AppendElements(aOther.touches);
 176     mFlags.mCancelable = message != NS_TOUCH_CANCEL;
 177     MOZ_COUNT_CTOR(WidgetTouchEvent);
 178   }
 179
 180   WidgetTouchEvent(bool aIsTrusted, uint32_t aMessage, nsIWidget* aWidget)
 181     : WidgetInputEvent(aIsTrusted, aMessage, aWidget, eTouchEventClass)
 182   {
 183     MOZ_COUNT_CTOR(WidgetTouchEvent);
 184     mFlags.mCancelable = message != NS_TOUCH_CANCEL;
 185   }
 186
 187   virtual ~WidgetTouchEvent()
 188   {
 189     MOZ_COUNT_DTOR(WidgetTouchEvent);
 190   }
 191
 192   virtual WidgetEvent* Duplicate() const MOZ_OVERRIDE
 193   {
 194     MOZ_ASSERT(mClass == eTouchEventClass,
 195                "Duplicate() must be overridden by sub class");
 196     // Not copying widget, it is a weak reference.
 197     WidgetTouchEvent* result = new WidgetTouchEvent(false, message, nullptr);
 198     result->AssignTouchEventData(*this, true);
 199     result->mFlags = mFlags;
 200     return result;
 201   }
 202
 203   TouchArray touches;
 204
 205   void AssignTouchEventData(const WidgetTouchEvent& aEvent, bool aCopyTargets)
 206   {
 207     AssignInputEventData(aEvent, aCopyTargets);
 208
 209     // Assign*EventData() assume that they're called only new instance.
 210     MOZ_ASSERT(touches.IsEmpty());
 211     touches.AppendElements(aEvent.touches);
 212   }
 213 };
 214
 215 } // namespace mozilla
 216
 217 #endif // mozilla_TouchEvents_h__