Home | History | Annotate | Download | only in events
      1 /*
      2  * Copyright (C) 2006 Apple Computer, Inc.
      3  * Copyright (C) 2006 Samuel Weinig <sam.weinig (at) 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 [
     22     EventConstructor,
     23 ] interface KeyboardEvent : UIEvent {
     24     const unsigned long DOM_KEY_LOCATION_STANDARD = 0x00;
     25     const unsigned long DOM_KEY_LOCATION_LEFT     = 0x01;
     26     const unsigned long DOM_KEY_LOCATION_RIGHT    = 0x02;
     27     const unsigned long DOM_KEY_LOCATION_NUMPAD   = 0x03;
     28 
     29     [InitializedByEventConstructor] readonly attribute DOMString        keyIdentifier;
     30     [InitializedByEventConstructor] readonly attribute unsigned long    location;
     31     [ImplementedAs=location, DeprecateAs=KeyboardEventKeyLocation, InitializedByEventConstructor] readonly attribute unsigned long keyLocation; // Deprecated.
     32     [InitializedByEventConstructor] readonly attribute boolean          ctrlKey;
     33     [InitializedByEventConstructor] readonly attribute boolean          shiftKey;
     34     [InitializedByEventConstructor] readonly attribute boolean          altKey;
     35     [InitializedByEventConstructor] readonly attribute boolean          metaKey;
     36     [InitializedByEventConstructor] readonly attribute boolean          repeat;
     37     readonly attribute boolean          altGraphKey;
     38 
     39     boolean getModifierState(DOMString keyArgument);
     40 
     41     // FIXME: this does not match the version in the DOM spec.
     42     void initKeyboardEvent([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 DOMString keyIdentifier,
     47                            [Default=Undefined] optional unsigned long location,
     48                            [Default=Undefined] optional boolean ctrlKey,
     49                            [Default=Undefined] optional boolean altKey,
     50                            [Default=Undefined] optional boolean shiftKey,
     51                            [Default=Undefined] optional boolean metaKey,
     52                            [Default=Undefined] optional boolean altGraphKey);
     53 };
     54 
     55