third_party/WebKit/Source/core/events/MouseEvent.idl

   1 /*
   2  * Copyright (C) 2006, 2007 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 // http://www.w3.org/TR/DOM-Level-3-Events/#interface-MouseEvent
  21
  22 [
  23     Constructor(DOMString type, optional MouseEventInit eventInitDict),
  24     ConstructorCallWith=ScriptState,
  25 ] interface MouseEvent : UIEvent {
  26     readonly attribute long             screenX;
  27     readonly attribute long             screenY;
  28     readonly attribute long             clientX;
  29     readonly attribute long             clientY;
  30     readonly attribute boolean          ctrlKey;
  31     readonly attribute boolean          shiftKey;
  32     readonly attribute boolean          altKey;
  33     readonly attribute boolean          metaKey;
  34     readonly attribute unsigned short   button;
  35     readonly attribute unsigned short   buttons;
  36     readonly attribute EventTarget?     relatedTarget;
  37     [MeasureAs=MouseEventMovementX] readonly attribute long             movementX;
  38     [MeasureAs=MouseEventMovementY] readonly attribute long             movementY;
  39     [MeasureAs=PrefixedMouseEventMovementX, ImplementedAs=movementX] readonly attribute long webkitMovementX;
  40     [MeasureAs=PrefixedMouseEventMovementY, ImplementedAs=movementY] readonly attribute long webkitMovementY;
  41
  42      [CallWith=ScriptState] void initMouseEvent([Default=Undefined] optional DOMString type,
  43                                        [Default=Undefined] optional boolean canBubble,
  44                                        [Default=Undefined] optional boolean cancelable,
  45                                        [Default=Undefined] optional Window view,
  46                                        [Default=Undefined] optional long detail,
  47                                        [Default=Undefined] optional long screenX,
  48                                        [Default=Undefined] optional long screenY,
  49                                        [Default=Undefined] optional long clientX,
  50                                        [Default=Undefined] optional long clientY,
  51                                        [Default=Undefined] optional boolean ctrlKey,
  52                                        [Default=Undefined] optional boolean altKey,
  53                                        [Default=Undefined] optional boolean shiftKey,
  54                                        [Default=Undefined] optional boolean metaKey,
  55                                        [Default=Undefined] optional unsigned short button,
  56                                        [Default=Undefined] optional EventTarget relatedTarget);
  57
  58     // Non-standard
  59     [MeasureAs=MouseEventOffsetX] readonly attribute long offsetX;
  60     [MeasureAs=MouseEventOffsetY] readonly attribute long offsetY;
  61     [MeasureAs=MouseEventX] readonly attribute long x;
  62     [MeasureAs=MouseEventY] readonly attribute long y;
  63     [MeasureAs=MouseEventFromElement] readonly attribute Node fromElement;
  64     [MeasureAs=MouseEventToElement] readonly attribute Node toElement;
  65     [MeasureAs=MouseEventWhich] readonly attribute long which;
  66
  67     // FIXME: this belongs on the DragEvent interface
  68     readonly attribute DataTransfer dataTransfer;
  69 };