Key events are the type of events that allow a program to react to key presses. This interface declare the elements that conform the keywords to associate with a key press, including modifiers commonly used in a keyboard.

A present restriction on events is that events do not deliver any additional data besides their occurrence. That is the reason why a full extensive list of characters must be provided. For simplicity, key event identifiers are split into three parts: a sigil to start all key events, an optional modifier, and the event body separated by underscores. For example, if the sigil is 'K', two modifiers are 'SHIFT' and 'CTRL' and two event bodies are 'A' and 'B', six event identifiers are formed: 'K_A', 'K_SHIFT_A', 'K_CTRL_A', 'K_B', 'K_SHIFT_B', 'K_CTRL_B').

This interface is used as a component of the LangPrimitives interface.

interface KeyEventElements {
    KEYSIGIL: string;
    KeyEventBodies: {
        ArrowKeys: {
            DOWN: string;
            LEFT: string;
            RIGHT: string;
            UP: string;
        };
        CharKeys: {
            0: string;
            1: string;
            2: string;
            3: string;
            4: string;
            5: string;
            6: string;
            7: string;
            8: string;
            9: string;
            A: string;
            B: string;
            C: string;
            D: string;
            E: string;
            F: string;
            G: string;
            H: string;
            I: string;
            J: string;
            K: string;
            L: string;
            M: string;
            N: string;
            O: string;
            P: string;
            Q: string;
            R: string;
            S: string;
            T: string;
            U: string;
            V: string;
            W: string;
            X: string;
            Y: string;
            Z: string;
        };
        SpecialKeys: {
            BACKSPACE: string;
            DELETE: string;
            END: string;
            ESCAPE: string;
            F1: string;
            F10: string;
            F11: string;
            F12: string;
            F2: string;
            F3: string;
            F4: string;
            F5: string;
            F6: string;
            F7: string;
            F8: string;
            F9: string;
            HOME: string;
            INSERT: string;
            PAGEDOWN: string;
            PAGEUP: string;
            RETURN: string;
            SPACE: string;
            TAB: string;
        };
        SymbolKeys: {
            AMPERSAND: string;
            ASTERISK: string;
            AT: string;
            BACKSLASH: string;
            CARET: string;
            COLON: string;
            DOLLAR: string;
            DOUBLEQUOTE: string;
            EQUALS: string;
            EXCLAIM: string;
            GREATER: string;
            HASH: string;
            LEFTBRACE: string;
            LEFTBRACKET: string;
            LEFTPAREN: string;
            LESS: string;
            PERCENT: string;
            PLUS: string;
            QUESTION: string;
            QUOTE: string;
            RIGHTBRACE: string;
            RIGHTBRACKET: string;
            RIGHTPAREN: string;
            SEMICOLON: string;
            SLASH: string;
            UNDERSCORE: string;
        };
    };
    KeyModifiers: {
        ALT: string;
        ALTSHIFT: string;
        CTRL: string;
        CTRLALT: string;
        CTRLALTSHIFT: string;
        CTRLSHIFT: string;
        SHIFT: string;
    };
}

Properties

KEYSIGIL: string
KeyEventBodies: {
    ArrowKeys: {
        DOWN: string;
        LEFT: string;
        RIGHT: string;
        UP: string;
    };
    CharKeys: {
        0: string;
        1: string;
        2: string;
        3: string;
        4: string;
        5: string;
        6: string;
        7: string;
        8: string;
        9: string;
        A: string;
        B: string;
        C: string;
        D: string;
        E: string;
        F: string;
        G: string;
        H: string;
        I: string;
        J: string;
        K: string;
        L: string;
        M: string;
        N: string;
        O: string;
        P: string;
        Q: string;
        R: string;
        S: string;
        T: string;
        U: string;
        V: string;
        W: string;
        X: string;
        Y: string;
        Z: string;
    };
    SpecialKeys: {
        BACKSPACE: string;
        DELETE: string;
        END: string;
        ESCAPE: string;
        F1: string;
        F10: string;
        F11: string;
        F12: string;
        F2: string;
        F3: string;
        F4: string;
        F5: string;
        F6: string;
        F7: string;
        F8: string;
        F9: string;
        HOME: string;
        INSERT: string;
        PAGEDOWN: string;
        PAGEUP: string;
        RETURN: string;
        SPACE: string;
        TAB: string;
    };
    SymbolKeys: {
        AMPERSAND: string;
        ASTERISK: string;
        AT: string;
        BACKSLASH: string;
        CARET: string;
        COLON: string;
        DOLLAR: string;
        DOUBLEQUOTE: string;
        EQUALS: string;
        EXCLAIM: string;
        GREATER: string;
        HASH: string;
        LEFTBRACE: string;
        LEFTBRACKET: string;
        LEFTPAREN: string;
        LESS: string;
        PERCENT: string;
        PLUS: string;
        QUESTION: string;
        QUOTE: string;
        RIGHTBRACE: string;
        RIGHTBRACKET: string;
        RIGHTPAREN: string;
        SEMICOLON: string;
        SLASH: string;
        UNDERSCORE: string;
    };
}

Type declaration

  • ArrowKeys: {
        DOWN: string;
        LEFT: string;
        RIGHT: string;
        UP: string;
    }
    • DOWN: string
    • LEFT: string
    • RIGHT: string
    • UP: string
  • CharKeys: {
        0: string;
        1: string;
        2: string;
        3: string;
        4: string;
        5: string;
        6: string;
        7: string;
        8: string;
        9: string;
        A: string;
        B: string;
        C: string;
        D: string;
        E: string;
        F: string;
        G: string;
        H: string;
        I: string;
        J: string;
        K: string;
        L: string;
        M: string;
        N: string;
        O: string;
        P: string;
        Q: string;
        R: string;
        S: string;
        T: string;
        U: string;
        V: string;
        W: string;
        X: string;
        Y: string;
        Z: string;
    }
    • 0: string
    • 1: string
    • 2: string
    • 3: string
    • 4: string
    • 5: string
    • 6: string
    • 7: string
    • 8: string
    • 9: string
    • A: string
    • B: string
    • C: string
    • D: string
    • E: string
    • F: string
    • G: string
    • H: string
    • I: string
    • J: string
    • K: string
    • L: string
    • M: string
    • N: string
    • O: string
    • P: string
    • Q: string
    • R: string
    • S: string
    • T: string
    • U: string
    • V: string
    • W: string
    • X: string
    • Y: string
    • Z: string
  • SpecialKeys: {
        BACKSPACE: string;
        DELETE: string;
        END: string;
        ESCAPE: string;
        F1: string;
        F10: string;
        F11: string;
        F12: string;
        F2: string;
        F3: string;
        F4: string;
        F5: string;
        F6: string;
        F7: string;
        F8: string;
        F9: string;
        HOME: string;
        INSERT: string;
        PAGEDOWN: string;
        PAGEUP: string;
        RETURN: string;
        SPACE: string;
        TAB: string;
    }
    • BACKSPACE: string
    • DELETE: string
    • END: string
    • ESCAPE: string
    • F1: string
    • F10: string
    • F11: string
    • F12: string
    • F2: string
    • F3: string
    • F4: string
    • F5: string
    • F6: string
    • F7: string
    • F8: string
    • F9: string
    • HOME: string
    • INSERT: string
    • PAGEDOWN: string
    • PAGEUP: string
    • RETURN: string
    • SPACE: string
    • TAB: string
  • SymbolKeys: {
        AMPERSAND: string;
        ASTERISK: string;
        AT: string;
        BACKSLASH: string;
        CARET: string;
        COLON: string;
        DOLLAR: string;
        DOUBLEQUOTE: string;
        EQUALS: string;
        EXCLAIM: string;
        GREATER: string;
        HASH: string;
        LEFTBRACE: string;
        LEFTBRACKET: string;
        LEFTPAREN: string;
        LESS: string;
        PERCENT: string;
        PLUS: string;
        QUESTION: string;
        QUOTE: string;
        RIGHTBRACE: string;
        RIGHTBRACKET: string;
        RIGHTPAREN: string;
        SEMICOLON: string;
        SLASH: string;
        UNDERSCORE: string;
    }
    • AMPERSAND: string
    • ASTERISK: string
    • AT: string
    • BACKSLASH: string
    • CARET: string
    • COLON: string
    • DOLLAR: string
    • DOUBLEQUOTE: string
    • EQUALS: string
    • EXCLAIM: string
    • GREATER: string
    • HASH: string
    • LEFTBRACE: string
    • LEFTBRACKET: string
    • LEFTPAREN: string
    • LESS: string
    • PERCENT: string
    • PLUS: string
    • QUESTION: string
    • QUOTE: string
    • RIGHTBRACE: string
    • RIGHTBRACKET: string
    • RIGHTPAREN: string
    • SEMICOLON: string
    • SLASH: string
    • UNDERSCORE: string
KeyModifiers: {
    ALT: string;
    ALTSHIFT: string;
    CTRL: string;
    CTRLALT: string;
    CTRLALTSHIFT: string;
    CTRLSHIFT: string;
    SHIFT: string;
}

Type declaration

  • ALT: string
  • ALTSHIFT: string
  • CTRL: string
  • CTRLALT: string
  • CTRLALTSHIFT: string
  • CTRLSHIFT: string
  • SHIFT: string