xref: /external/webkit/Source/WebCore/dom/KeyboardEvent.idl

/*
 * Copyright (C) 2006 Apple Computer, Inc.
 * Copyright (C) 2006 Samuel Weinig <sam.weinig@gmail.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

module events {

    // Introduced in DOM Level 3:
    interface KeyboardEvent : UIEvent {

#if !defined(LANGUAGE_JAVASCRIPT) || !LANGUAGE_JAVASCRIPT
        // KeyLocationCode
        const unsigned long       KEY_LOCATION_STANDARD      = 0x00;
        const unsigned long       KEY_LOCATION_LEFT          = 0x01;
        const unsigned long       KEY_LOCATION_RIGHT         = 0x02;
        const unsigned long       KEY_LOCATION_NUMPAD        = 0x03;
#endif

        readonly attribute DOMString        keyIdentifier;
        readonly attribute unsigned long    keyLocation;
        readonly attribute boolean          ctrlKey;
        readonly attribute boolean          shiftKey;
        readonly attribute boolean          altKey;
        readonly attribute boolean          metaKey;
        readonly attribute boolean          altGraphKey;

#if !defined(LANGUAGE_JAVASCRIPT) || !LANGUAGE_JAVASCRIPT
        boolean getModifierState(in DOMString keyIdentifierArg);
#endif

        // FIXME: this does not match the version in the DOM spec.
        void initKeyboardEvent(in DOMString type,
                               in boolean canBubble,
                               in boolean cancelable,
                               in DOMWindow view,
                               in DOMString keyIdentifier,
                               in unsigned long keyLocation,
                               in boolean ctrlKey,
                               in boolean altKey,
                               in boolean shiftKey,
                               in boolean metaKey,
                               in boolean altGraphKey);

        // WebKit Extensions
#if !defined(LANGUAGE_JAVASCRIPT) || !LANGUAGE_JAVASCRIPT
        readonly attribute long             keyCode;
        readonly attribute long             charCode;

        void initKeyboardEvent(in DOMString type,
                               in boolean canBubble,
                               in boolean cancelable,
                               in DOMWindow view,
                               in DOMString keyIdentifier,
                               in unsigned long keyLocation,
                               in boolean ctrlKey,
                               in boolean altKey,
                               in boolean shiftKey,
                               in boolean metaKey);
#endif

    };

}