dom/events/TouchEvent.h

   1 /* vim: set shiftwidth=2 tabstop=8 autoindent cindent expandtab: */
   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 #ifndef mozilla_dom_TouchEvent_h_
   6 #define mozilla_dom_TouchEvent_h_
   7
   8 #include "mozilla/dom/Touch.h"
   9 #include "mozilla/dom/TouchEventBinding.h"
  10 #include "mozilla/dom/UIEvent.h"
  11 #include "mozilla/Attributes.h"
  12 #include "mozilla/EventForwards.h"
  13 #include "mozilla/TouchEvents.h"
  14 #include "nsJSEnvironment.h"
  15 #include "nsWrapperCache.h"
  16
  17 class nsAString;
  18
  19 namespace mozilla {
  20 namespace dom {
  21
  22 class TouchList MOZ_FINAL : public nsISupports
  23                           , public nsWrapperCache
  24 {
  25 public:
  26   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  27   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(TouchList)
  28
  29   TouchList(nsISupports* aParent)
  30     : mParent(aParent)
  31   {
  32     SetIsDOMBinding();
  33     nsJSContext::LikelyShortLivingObjectCreated();
  34   }
  35   TouchList(nsISupports* aParent,
  36             const WidgetTouchEvent::TouchArray& aTouches)
  37     : mParent(aParent)
  38     , mPoints(aTouches)
  39   {
  40     SetIsDOMBinding();
  41     nsJSContext::LikelyShortLivingObjectCreated();
  42   }
  43
  44   void Append(Touch* aPoint)
  45   {
  46     mPoints.AppendElement(aPoint);
  47   }
  48
  49   virtual JSObject* WrapObject(JSContext* aCx) MOZ_OVERRIDE;
  50
  51   nsISupports* GetParentObject() const
  52   {
  53     return mParent;
  54   }
  55
  56   static bool PrefEnabled(JSContext* aCx = nullptr,
  57                           JSObject* aGlobal = nullptr);
  58
  59   uint32_t Length() const
  60   {
  61     return mPoints.Length();
  62   }
  63   Touch* Item(uint32_t aIndex) const
  64   {
  65     return mPoints.SafeElementAt(aIndex);
  66   }
  67   Touch* IndexedGetter(uint32_t aIndex, bool& aFound) const
  68   {
  69     aFound = aIndex < mPoints.Length();
  70     if (!aFound) {
  71       return nullptr;
  72     }
  73     return mPoints[aIndex];
  74   }
  75   Touch* IdentifiedTouch(int32_t aIdentifier) const;
  76
  77 protected:
  78   ~TouchList() {}
  79
  80   nsCOMPtr<nsISupports> mParent;
  81   WidgetTouchEvent::TouchArray mPoints;
  82 };
  83
  84 class TouchEvent : public UIEvent
  85 {
  86 public:
  87   TouchEvent(EventTarget* aOwner,
  88              nsPresContext* aPresContext,
  89              WidgetTouchEvent* aEvent);
  90
  91   NS_DECL_ISUPPORTS_INHERITED
  92   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(TouchEvent, UIEvent)
  93
  94   virtual JSObject* WrapObject(JSContext* aCx) MOZ_OVERRIDE
  95   {
  96     return TouchEventBinding::Wrap(aCx, this);
  97   }
  98
  99   TouchList* Touches();
 100   TouchList* TargetTouches();
 101   TouchList* ChangedTouches();
 102
 103   bool AltKey();
 104   bool MetaKey();
 105   bool CtrlKey();
 106   bool ShiftKey();
 107
 108   void InitTouchEvent(const nsAString& aType,
 109                       bool aCanBubble,
 110                       bool aCancelable,
 111                       nsIDOMWindow* aView,
 112                       int32_t aDetail,
 113                       bool aCtrlKey,
 114                       bool aAltKey,
 115                       bool aShiftKey,
 116                       bool aMetaKey,
 117                       TouchList* aTouches,
 118                       TouchList* aTargetTouches,
 119                       TouchList* aChangedTouches,
 120                       ErrorResult& aRv);
 121
 122   static bool PrefEnabled(JSContext* aCx = nullptr,
 123                           JSObject* aGlobal = nullptr);
 124
 125 protected:
 126   ~TouchEvent() {}
 127
 128   nsRefPtr<TouchList> mTouches;
 129   nsRefPtr<TouchList> mTargetTouches;
 130   nsRefPtr<TouchList> mChangedTouches;
 131 };
 132
 133 } // namespace dom
 134 } // namespace mozilla
 135
 136 #endif // mozilla_dom_TouchEvent_h_