/* * Copyright (C) 2001 Peter Kelly (pmk@post.com) * Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de) * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com) * Copyright (C) 2003, 2004, 2005, 2006, 2008 Apple Inc. All rights reserved. * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Library General Public License for more details. * * You should have received a copy of the GNU Library General Public License * along with this library; see the file COPYING.LIB. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, * Boston, MA 02110-1301, USA. * */ #ifndef THIRD_PARTY_BLINK_RENDERER_CORE_EVENTS_MOUSE_EVENT_H_ #define THIRD_PARTY_BLINK_RENDERER_CORE_EVENTS_MOUSE_EVENT_H_ #include #include "third_party/blink/renderer/core/core_export.h" #include "third_party/blink/renderer/core/dom/events/simulated_click_options.h" #include "third_party/blink/renderer/core/events/ui_event_with_key_state.h" #include "third_party/blink/renderer/platform/wtf/casting.h" #include "ui/base/mojom/menu_source_type.mojom-blink.h" namespace blink { class DataTransfer; class EventDispatcher; class LocalDOMWindow; class MouseEventInit; class WebPointerProperties; class CORE_EXPORT MouseEvent : public UIEventWithKeyState { DEFINE_WRAPPERTYPEINFO(); public: enum SyntheticEventType { // Real mouse input events or synthetic events that behave just like real // events kRealOrIndistinguishable, // Synthetic mouse events derived from touch input kFromTouch, // Synthetic mouse events generated without a position, for example those // generated from keyboard input. kPositionless, }; static MouseEvent* Create() { return MakeGarbageCollected(); } // TODO(mustaq): looks like we don't need so many variations of Create() here static MouseEvent* Create(const AtomicString& event_type, const MouseEventInit*, base::TimeTicks platform_time_stamp, SyntheticEventType, ui::mojom::blink::MenuSourceType); static MouseEvent* Create(ScriptState*, const AtomicString& event_type, const MouseEventInit*); MouseEvent(const AtomicString& type, const MouseEventInit*, base::TimeTicks platform_time_stamp = base::TimeTicks::Now(), SyntheticEventType = kRealOrIndistinguishable, ui::mojom::blink::MenuSourceType = ui::mojom::blink::MenuSourceType::kNone, LocalDOMWindow* fallback_dom_window = nullptr); MouseEvent(); static uint16_t WebInputEventModifiersToButtons(unsigned modifiers); static void SetCoordinatesFromWebPointerProperties( const WebPointerProperties&, const LocalDOMWindow*, MouseEventInit*); void initMouseEvent(ScriptState*, const AtomicString& type, bool bubbles, bool cancelable, AbstractView*, int detail, int screen_x, int screen_y, int client_x, int client_y, bool ctrl_key, bool alt_key, bool shift_key, bool meta_key, int16_t button, EventTarget* related_target, uint16_t buttons = 0); void InitCoordinatesForTesting(double screen_x, double screen_y, double client_x, double client_y); // WinIE uses 1,4,2 for left/middle/right but not for click (just for // mousedown/up, maybe others), but we will match the standard DOM. virtual int16_t button() const; // Returns true if `button()` is `WebPointerProperties::Button::kLeft`. bool IsLeftButton() const; // Returns true if `button()` can be used to trigger a link click. bool IsLinkClickButton() const; uint16_t buttons() const { return buttons_; } bool ButtonDown() const { return button_ != -1; } EventTarget* relatedTarget() const override { return related_target_.Get(); } void SetRelatedTarget(EventTarget* related_target) override { related_target_ = related_target; } SyntheticEventType GetSyntheticEventType() const { return synthetic_event_type_; } virtual Node* toElement() const; virtual Node* fromElement() const; virtual DataTransfer* dataTransfer() const { return nullptr; } bool FromTouch() const { return synthetic_event_type_ == kFromTouch; } const AtomicString& InterfaceName() const override; bool IsMouseEvent() const override; unsigned which() const override; int ClickCount() const { return detail(); } enum class PositionType { kPosition, // Positionless mouse events are used, for example, for 'click' events from // keyboard input. It's kind of surprising for a mouse event not to have a // position. kPositionless }; // Note that these values are adjusted to counter the effects of zoom, so that // values exposed via DOM APIs are invariant under zooming. virtual double screenX() const { return std::floor(screen_x_); } virtual double screenY() const { return std::floor(screen_y_); } virtual double clientX() const { return std::floor(client_x_); } virtual double clientY() const { return std::floor(client_y_); } int movementX() const { return movement_delta_.x(); } int movementY() const { return movement_delta_.y(); } int layerX(); int layerY(); virtual double offsetX() const; virtual double offsetY() const; virtual double pageX() const { return std::floor(page_x_); } virtual double pageY() const { return std::floor(page_y_); } double x() const { return clientX(); } double y() const { return clientY(); } bool HasPosition() const { return position_type_ == PositionType::kPosition; } ui::mojom::blink::MenuSourceType GetMenuSourceType() const { return menu_source_type_; } // Page point in layout coordinates (i.e. post-zoomed, page-relative // coords, usable with LayoutObject::absoluteToLocal) relative to view(), // i.e. the local frame. const gfx::PointF& AbsoluteLocation() const { return absolute_location_; } DispatchEventResult DispatchEvent(EventDispatcher&) override; void InitCoordinates(const double client_x, const double client_y, const LocalDOMWindow* fallback_dom_window = nullptr); void Trace(Visitor*) const override; protected: int16_t RawButton() const { return button_; } void ReceivedTarget() override; void ComputeRelativePosition(); // These values are exposed via DOM APIs and are invariant under zooming. double screen_x_ = 0; double screen_y_ = 0; double client_x_ = 0; double client_y_ = 0; double page_x_ = 0; double page_y_ = 0; double offset_x_ = 0; double offset_y_ = 0; bool has_cached_relative_position_ = false; private: void InitMouseEventInternal(const AtomicString& type, bool bubbles, bool cancelable, AbstractView*, int detail, double screen_x, double screen_y, double client_x, double client_y, WebInputEvent::Modifiers, int16_t button, EventTarget* related_target, InputDeviceCapabilities* source_capabilities, uint16_t buttons = 0); // Record metrics for layerX and layerY. void RecordLayerXYMetrics(); // These values are exposed via DOM APIs and are invariant under zooming. gfx::Point movement_delta_; gfx::PointF layer_location_; // In zoomed CSS pixels in FrameView content space. gfx::PointF absolute_location_; PositionType position_type_; int16_t button_; uint16_t buttons_; Member related_target_; SyntheticEventType synthetic_event_type_; // Only used for contextmenu events. ui::mojom::blink::MenuSourceType menu_source_type_; }; template <> struct DowncastTraits { static bool AllowFrom(const Event& event) { return event.IsMouseEvent(); } }; } // namespace blink #endif // THIRD_PARTY_BLINK_RENDERER_CORE_EVENTS_MOUSE_EVENT_H_