Source/WebCore/dom/MouseEvent.idl

/*
 * Copyright (C) 2006, 2007, 2015 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.
 */

[
    ConstructorConditional=DOM4_EVENTS_CONSTRUCTOR,
    ConstructorTemplate=Event,
    DoNotCheckConstants,
] interface MouseEvent : UIEvent {
#if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
    [Conditional=MOUSE_FORCE_EVENTS] const double WEBKIT_FORCE_AT_MOUSE_DOWN        = 1;
    [Conditional=MOUSE_FORCE_EVENTS] const double WEBKIT_FORCE_AT_FORCE_MOUSE_DOWN  = 2;
#endif

    [InitializedByEventConstructor] readonly attribute long             screenX;
    [InitializedByEventConstructor] readonly attribute long             screenY;
    [InitializedByEventConstructor] readonly attribute long             clientX;
    [InitializedByEventConstructor] readonly attribute long             clientY;
    [InitializedByEventConstructor] readonly attribute boolean          ctrlKey;
    [InitializedByEventConstructor] readonly attribute boolean          shiftKey;
    [InitializedByEventConstructor] readonly attribute boolean          altKey;
    [InitializedByEventConstructor] readonly attribute boolean          metaKey;
    [InitializedByEventConstructor] readonly attribute unsigned short   button;
    [InitializedByEventConstructor] readonly attribute EventTarget      relatedTarget;
    [Conditional=POINTER_LOCK]      readonly attribute long             movementX;
    [Conditional=POINTER_LOCK]      readonly attribute long             movementY;
#if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
    [Conditional=MOUSE_FORCE_EVENTS, ImplementedAs=force]readonly attribute double  webkitForce;
#endif
    
    // FIXME: Using "undefined" as default parameter value is wrong.
    [ObjCLegacyUnnamedParameters] void initMouseEvent(optional DOMString type = "undefined",
                                       optional boolean canBubble = false,
                                       optional boolean cancelable = false,
                                       optional DOMWindow? view = null,
                                       optional long detail = 0,
                                       optional long screenX = 0,
                                       optional long screenY = 0,
                                       optional long clientX = 0,
                                       optional long clientY = 0,
                                       optional boolean ctrlKey = false,
                                       optional boolean altKey = false,
                                       optional boolean shiftKey = false,
                                       optional boolean metaKey = false,
                                       optional unsigned short button = 0,
                                       optional EventTarget? relatedTarget = null);

    // extensions
    readonly attribute long             offsetX;
    readonly attribute long             offsetY;
    readonly attribute long             x;
    readonly attribute long             y;
    readonly attribute Node             fromElement;
    readonly attribute Node             toElement;

#if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
    readonly attribute DataTransfer     dataTransfer;
#endif
};