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    ConstructorConditional=DOM4_EVENTS_CONSTRUCTOR,
23    ConstructorTemplate=Event
24] interface KeyboardEvent : UIEvent {
25
26#if !defined(LANGUAGE_JAVASCRIPT) || !LANGUAGE_JAVASCRIPT
27    // KeyLocationCode
28    const unsigned long       KEY_LOCATION_STANDARD      = 0x00;
29    const unsigned long       KEY_LOCATION_LEFT          = 0x01;
30    const unsigned long       KEY_LOCATION_RIGHT         = 0x02;
31    const unsigned long       KEY_LOCATION_NUMPAD        = 0x03;
32#endif
33
34    [InitializedByEventConstructor] readonly attribute DOMString        keyIdentifier;
35    [InitializedByEventConstructor] readonly attribute unsigned long    keyLocation;
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#if !defined(LANGUAGE_JAVASCRIPT) || !LANGUAGE_JAVASCRIPT
43    boolean getModifierState([Default=Undefined] optional DOMString keyIdentifierArg);
44#endif
45
46    // FIXME: this does not match the version in the DOM spec.
47    void initKeyboardEvent([Default=Undefined] optional DOMString type,
48                           [Default=Undefined] optional boolean canBubble,
49                           [Default=Undefined] optional boolean cancelable,
50                           [Default=Undefined] optional DOMWindow view,
51                           [Default=Undefined] optional DOMString keyIdentifier,
52                           [Default=Undefined] optional unsigned long keyLocation,
53                           [Default=Undefined] optional boolean ctrlKey,
54                           [Default=Undefined] optional boolean altKey,
55                           [Default=Undefined] optional boolean shiftKey,
56                           [Default=Undefined] optional boolean metaKey,
57                           [Default=Undefined] optional boolean altGraphKey);
58
59    // WebKit Extensions
60#if !defined(LANGUAGE_JAVASCRIPT) || !LANGUAGE_JAVASCRIPT
61    readonly attribute long             keyCode;
62    readonly attribute long             charCode;
63
64    void initKeyboardEvent([Default=Undefined] optional DOMString type,
65                           [Default=Undefined] optional boolean canBubble,
66                           [Default=Undefined] optional boolean cancelable,
67                           [Default=Undefined] optional DOMWindow view,
68                           [Default=Undefined] optional DOMString keyIdentifier,
69                           [Default=Undefined] optional unsigned long keyLocation,
70                           [Default=Undefined] optional boolean ctrlKey,
71                           [Default=Undefined] optional boolean altKey,
72                           [Default=Undefined] optional boolean shiftKey,
73                           [Default=Undefined] optional boolean metaKey);
74#endif
75
76};
77
78