Source/WebCore/dom/WheelEvent.idl

   1 /*
   2  * Copyright (C) 2006, 2007, 2010 Apple Inc. All rights reserved.
   3  * Copyright (C) 2006 Samuel Weinig <sam.weinig@gmail.com>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public License
  16  * along with this library; see the file COPYING.LIB.  If not, write to
  17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18  * Boston, MA 02110-1301, USA.
  19  */
  20
  21 module events {
  22
  23     // Based off http://dev.w3.org/2006/webapi/DOM-Level-3-Events/html/DOM3-Events.html#events-wheelevents
  24     interface WheelEvent : MouseEvent
  25     {
  26         readonly attribute long    wheelDelta;
  27         readonly attribute long    wheelDeltaX;
  28         readonly attribute long    wheelDeltaY;
  29
  30         // WebKit Extension
  31         readonly attribute boolean webkitDirectionInvertedFromDevice;
  32
  33 #if defined(LANGUAGE_OBJECTIVE_C) && LANGUAGE_OBJECTIVE_C
  34         readonly attribute boolean isHorizontal;
  35 #endif /* defined(LANGUAGE_OBJECTIVE_C) */
  36
  37 #if !defined(LANGUAGE_JAVASCRIPT) || !LANGUAGE_JAVASCRIPT
  38         void initWheelEvent(in [Optional=DefaultIsUndefined] long wheelDeltaX,
  39                             in [Optional=DefaultIsUndefined] long wheelDeltaY,
  40                             in [Optional=DefaultIsUndefined] DOMWindow view,
  41                             in [Optional=DefaultIsUndefined] long screenX,
  42                             in [Optional=DefaultIsUndefined] long screenY,
  43                             in [Optional=DefaultIsUndefined] long clientX,
  44                             in [Optional=DefaultIsUndefined] long clientY,
  45                             in [Optional=DefaultIsUndefined] boolean ctrlKey,
  46                             in [Optional=DefaultIsUndefined] boolean altKey,
  47                             in [Optional=DefaultIsUndefined] boolean shiftKey,
  48                             in [Optional=DefaultIsUndefined] boolean metaKey);
  49 #endif /* !defined(LANGUAGE_JAVASCRIPT) */
  50
  51 #if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
  52         void initWebKitWheelEvent(in [Optional=DefaultIsUndefined] long wheelDeltaX,
  53                                   in [Optional=DefaultIsUndefined] long wheelDeltaY,
  54                                   in [Optional=DefaultIsUndefined] DOMWindow view,
  55                                   in [Optional=DefaultIsUndefined] long screenX,
  56                                   in [Optional=DefaultIsUndefined] long screenY,
  57                                   in [Optional=DefaultIsUndefined] long clientX,
  58                                   in [Optional=DefaultIsUndefined] long clientY,
  59                                   in [Optional=DefaultIsUndefined] boolean ctrlKey,
  60                                   in [Optional=DefaultIsUndefined] boolean altKey,
  61                                   in [Optional=DefaultIsUndefined] boolean shiftKey,
  62                                   in [Optional=DefaultIsUndefined] boolean metaKey);
  63 #endif /* defined(LANGUAGE_JAVASCRIPT) */
  64     };
  65 }