Delete WebMetal implementation in favor of WebGPU
[WebKit-https.git] / Source / WebCore / dom / MouseEvent.idl
1 /*
2  * Copyright (C) 2006, 2007, 2015 Apple Inc. All rights reserved.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19
20 [
21     Constructor(DOMString type, optional MouseEventInit eventInitDict),
22     DoNotCheckConstants,
23 ] interface MouseEvent : UIEvent {
24     [Conditional=MOUSE_FORCE_EVENTS] const double WEBKIT_FORCE_AT_MOUSE_DOWN = 1;
25     [Conditional=MOUSE_FORCE_EVENTS] const double WEBKIT_FORCE_AT_FORCE_MOUSE_DOWN = 2;
26
27     readonly attribute long screenX;
28     readonly attribute long screenY;
29     readonly attribute long clientX;
30     readonly attribute long clientY;
31     readonly attribute boolean ctrlKey;
32     readonly attribute boolean shiftKey;
33     readonly attribute boolean altKey;
34     readonly attribute boolean metaKey;
35     readonly attribute unsigned short button;
36     readonly attribute unsigned short buttons;
37     readonly attribute EventTarget? relatedTarget;
38
39     boolean getModifierState(DOMString keyArg);
40
41     [Conditional=POINTER_LOCK] readonly attribute long movementX;
42     [Conditional=POINTER_LOCK] readonly attribute long movementY;
43     [Conditional=MOUSE_FORCE_EVENTS, ImplementedAs=force]readonly attribute double webkitForce;
44
45     // FIXME: Using "undefined" as default parameter value is wrong.
46     // FIXME: relatedTarget should be of type EventTarget? but we need to use any to support a quirk for iAd Producer (rdar://problem/30640101).
47     [CallWith=ExecState&ScriptExecutionContext, ImplementedAs=initMouseEventQuirk] void initMouseEvent(optional DOMString type = "undefined",
48         optional boolean canBubble = false, optional boolean cancelable = false,
49         optional WindowProxy? view = null, optional long detail = 0,
50         optional long screenX = 0, optional long screenY = 0, optional long clientX = 0, optional long clientY = 0,
51         optional boolean ctrlKey = false, optional boolean altKey = false, optional boolean shiftKey = false, optional boolean metaKey = false,
52         optional unsigned short button = 0, optional any relatedTarget = null);
53
54     readonly attribute long offsetX;
55     readonly attribute long offsetY;
56     readonly attribute long x;
57     readonly attribute long y;
58     readonly attribute Node? fromElement;
59     readonly attribute Node? toElement;
60     readonly attribute DataTransfer dataTransfer;
61 };