1/*
2 * Copyright (C) 2006 Apple Computer, Inc.
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[
22    ConstructorTemplate=Event
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    // FIXME: The following constants are defined in the specification but
29    // not yet supported (crbug.com/265446).
30    // const unsigned long DOM_KEY_LOCATION_MOBILE   = 0x04;
31    // const unsigned long DOM_KEY_LOCATION_JOYSTICK = 0x05;
32
33    [InitializedByEventConstructor] readonly attribute DOMString        keyIdentifier;
34    [InitializedByEventConstructor] readonly attribute unsigned long    location;
35    [ImplementedAs=location, DeprecateAs=KeyboardEventKeyLocation, InitializedByEventConstructor] readonly attribute unsigned long keyLocation; // Deprecated.
36    [InitializedByEventConstructor] readonly attribute boolean          ctrlKey;
37    [InitializedByEventConstructor] readonly attribute boolean          shiftKey;
38    [InitializedByEventConstructor] readonly attribute boolean          altKey;
39    [InitializedByEventConstructor] readonly attribute boolean          metaKey;
40    readonly attribute boolean          altGraphKey;
41
42    boolean getModifierState(DOMString keyArgument);
43
44    // FIXME: this does not match the version in the DOM spec.
45    void initKeyboardEvent([Default=Undefined] optional DOMString type,
46                           [Default=Undefined] optional boolean canBubble,
47                           [Default=Undefined] optional boolean cancelable,
48                           [Default=Undefined] optional Window view,
49                           [Default=Undefined] optional DOMString keyIdentifier,
50                           [Default=Undefined] optional unsigned long location,
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 boolean altGraphKey);
56};
57
58