blob: 002d45ff7da8db55cf6217d52e1fde454428e3db [file] [log] [blame]
/*
* Copyright (C) 2004, 2005, 2006, 2009 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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 APPLE INC. ``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 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.
*/
#pragma once
#include "IntPoint.h"
#include "PlatformEvent.h"
#include "PointerID.h"
#include <wtf/WindowsExtras.h>
namespace WebCore {
const double ForceAtClick = 1;
const double ForceAtForceClick = 2;
// These button numbers match the ones used in the DOM API, 0 through 2, except for NoButton which isn't specified.
// We use -2 for NoButton because -1 is a valid value in the DOM API for Pointer Events for pointermove events that
// indicate that the pressed mouse button hasn't changed since the last event.
enum MouseButton : int8_t { LeftButton = 0, MiddleButton, RightButton, NoButton = -2 };
enum SyntheticClickType : int8_t { NoTap, OneFingerTap, TwoFingerTap };
class PlatformMouseEvent : public PlatformEvent {
public:
PlatformMouseEvent()
: PlatformEvent(PlatformEvent::MouseMoved)
{
}
PlatformMouseEvent(const IntPoint& position, const IntPoint& globalPosition, MouseButton button, PlatformEvent::Type type,
int clickCount, bool shiftKey, bool ctrlKey, bool altKey, bool metaKey, WallTime timestamp, double force, SyntheticClickType syntheticClickType, PointerID pointerId = mousePointerID)
: PlatformEvent(type, shiftKey, ctrlKey, altKey, metaKey, timestamp)
, m_button(button)
, m_syntheticClickType(syntheticClickType)
, m_position(position)
, m_globalPosition(globalPosition)
, m_force(force)
, m_pointerId(pointerId)
, m_clickCount(clickCount)
{
}
// This position is relative to the enclosing NSWindow in WebKit1, and is WKWebView-relative in WebKit2.
// Use ScrollView::windowToContents() to convert it to into the contents of a given view.
const IntPoint& position() const { return m_position; }
const IntPoint& globalPosition() const { return m_globalPosition; }
const IntPoint& movementDelta() const { return m_movementDelta; }
MouseButton button() const { return m_button; }
unsigned short buttons() const { return m_buttons; }
int clickCount() const { return m_clickCount; }
unsigned modifierFlags() const { return m_modifierFlags; }
double force() const { return m_force; }
SyntheticClickType syntheticClickType() const { return m_syntheticClickType; }
PointerID pointerId() const { return m_pointerId; }
const String& pointerType() const { return m_pointerType; }
#if PLATFORM(MAC)
int eventNumber() const { return m_eventNumber; }
int menuTypeForEvent() const { return m_menuTypeForEvent; }
#endif
#if PLATFORM(WIN)
PlatformMouseEvent(HWND, UINT, WPARAM, LPARAM, bool didActivateWebView = false);
void setClickCount(int count) { m_clickCount = count; }
bool didActivateWebView() const { return m_didActivateWebView; }
#endif
#if PLATFORM(GTK)
enum class IsTouch : bool { No, Yes };
bool isTouchEvent() const { return m_isTouchEvent == IsTouch::Yes; }
#endif
protected:
MouseButton m_button { NoButton };
SyntheticClickType m_syntheticClickType { NoTap };
IntPoint m_position;
IntPoint m_globalPosition;
IntPoint m_movementDelta;
double m_force { 0 };
PointerID m_pointerId { mousePointerID };
String m_pointerType { "mouse"_s };
int m_clickCount { 0 };
unsigned m_modifierFlags { 0 };
unsigned short m_buttons { 0 };
#if PLATFORM(MAC)
int m_eventNumber { 0 };
int m_menuTypeForEvent { 0 };
#elif PLATFORM(WIN)
bool m_didActivateWebView { false };
#elif PLATFORM(GTK)
IsTouch m_isTouchEvent { IsTouch::No };
#endif
};
#if COMPILER(MSVC)
// These functions are necessary to work around the fact that MSVC will not find a most-specific
// operator== to use after implicitly converting MouseButton to a short.
inline bool operator==(short a, MouseButton b)
{
return a == static_cast<short>(b);
}
inline bool operator!=(short a, MouseButton b)
{
return a != static_cast<short>(b);
}
#endif
} // namespace WebCore