third_party/WebKit/Source/core/events/TouchEvent.h

/*
 * Copyright 2008, The Android Open Source Project
 * Copyright (C) 2012 Research In Motion Limited. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef TouchEvent_h
#define TouchEvent_h

#include "core/CoreExport.h"
#include "core/dom/TouchList.h"
#include "core/events/EventDispatchMediator.h"
#include "core/events/MouseRelatedEvent.h"
#include "core/events/TouchEventInit.h"

namespace blink {

class CORE_EXPORT TouchEvent final : public UIEventWithKeyState {
  DEFINE_WRAPPERTYPEINFO();

 public:
  ~TouchEvent() override;

  // We only initialize sourceCapabilities when we create TouchEvent from
  // EventHandler, null if it is from JavaScript.
  static TouchEvent* create() { return new TouchEvent; }
  static TouchEvent* create(TouchList* touches,
                            TouchList* targetTouches,
                            TouchList* changedTouches,
                            const AtomicString& type,
                            AbstractView* view,
                            PlatformEvent::Modifiers modifiers,
                            bool cancelable,
                            bool causesScrollingIfUncanceled,
                            bool firstTouchMoveOrStart,
                            double platformTimeStamp) {
    return new TouchEvent(touches, targetTouches, changedTouches, type, view,
                          modifiers, cancelable, causesScrollingIfUncanceled,
                          firstTouchMoveOrStart, platformTimeStamp);
  }

  static TouchEvent* create(const AtomicString& type,
                            const TouchEventInit& initializer) {
    return new TouchEvent(type, initializer);
  }

  TouchList* touches() const { return m_touches.get(); }
  TouchList* targetTouches() const { return m_targetTouches.get(); }
  TouchList* changedTouches() const { return m_changedTouches.get(); }

  void setTouches(TouchList* touches) { m_touches = touches; }
  void setTargetTouches(TouchList* targetTouches) {
    m_targetTouches = targetTouches;
  }
  void setChangedTouches(TouchList* changedTouches) {
    m_changedTouches = changedTouches;
  }

  bool causesScrollingIfUncanceled() const {
    return m_causesScrollingIfUncanceled;
  }

  bool isTouchEvent() const override;

  const AtomicString& interfaceName() const override;

  void preventDefault() override;

  void doneDispatchingEventAtCurrentTarget() override;

  EventDispatchMediator* createMediator() override;

  DECLARE_VIRTUAL_TRACE();

 private:
  TouchEvent();
  TouchEvent(TouchList* touches,
             TouchList* targetTouches,
             TouchList* changedTouches,
             const AtomicString& type,
             AbstractView*,
             PlatformEvent::Modifiers,
             bool cancelable,
             bool causesScrollingIfUncanceled,
             bool firstTouchMoveOrStart,
             double platformTimeStamp);
  TouchEvent(const AtomicString&, const TouchEventInit&);

  Member<TouchList> m_touches;
  Member<TouchList> m_targetTouches;
  Member<TouchList> m_changedTouches;
  bool m_causesScrollingIfUncanceled;
  bool m_firstTouchMoveOrStart;
  bool m_defaultPreventedBeforeCurrentTarget;
};

class TouchEventDispatchMediator final : public EventDispatchMediator {
 public:
  static TouchEventDispatchMediator* create(TouchEvent*);

 private:
  explicit TouchEventDispatchMediator(TouchEvent*);
  TouchEvent& event() const;
  DispatchEventResult dispatchEvent(EventDispatcher&) const override;
};

DEFINE_EVENT_TYPE_CASTS(TouchEvent);

}  // namespace blink

#endif  // TouchEvent_h