Editor Scripting API
    Preparing search index...

    Enumeration Key

    Enumeration of keyboard keys reported by KeyEvent and bound by Shortcut.

        // The Key enum names keyboard codes (Key_Space, Key_A..Z, Key_0..9, arrows, modifiers).
        // Use it as the key argument to UiTest.KeyEvent or to interpret incoming KeyEvents.
        const root = new Widget(parent);
        const layout = new BoxLayout();
        layout.setDirection(Direction.TopToBottom);
        root.layout = layout;

        const label = new Label(root);
        label.text = 'Press Space to trigger';
        layout.addWidgetWithStretch(label, 0, 0);

        const shortcut = new Shortcut(root, 'Space', ShortcutContext.WidgetShortcut);
        this.connections.push(
          shortcut.onActivated.connect(() => {
            label.text = `Key.Key_Space (${Key.Key_Space}) pressed`;
          }),
        );
    Index

    Enumeration Members

    Key_0 Key_1 Key_2 Key_3 Key_4 Key_5 Key_6 Key_7 Key_8 Key_9 Key_A Key_Alt Key_B Key_Backspace Key_C Key_Control Key_D Key_Delete Key_Down Key_E Key_Escape Key_F Key_G Key_H Key_I Key_J Key_K Key_L Key_Left Key_M Key_Meta Key_N Key_O Key_P Key_Q Key_R Key_Return Key_Right Key_S Key_Shift Key_Space Key_T Key_Tab Key_U Key_Up Key_V Key_W Key_X Key_Y Key_Z

    Enumeration Members

    Key_0: number

    The 0 number key.

    Key_1: number

    The 1 number key.

    Key_2: number

    The 2 number key.

    Key_3: number

    The 3 number key.

    Key_4: number

    The 4 number key.

    Key_5: number

    The 5 number key.

    Key_6: number

    The 6 number key.

    Key_7: number

    The 7 number key.

    Key_8: number

    The 8 number key.

    Key_9: number

    The 9 number key.

    Key_A: number

    The A letter key.

    Key_Alt: number

    The Alt/Option modifier key.

    Key_B: number

    The B letter key.

    Key_Backspace: number

    The Backspace key.

    Key_C: number

    The C letter key.

    Key_Control: number

    The Control modifier key.

    Key_D: number

    The D letter key.

    Key_Delete: number

    The Delete key.

    Key_Down: number

    The Down arrow key.

    Key_E: number

    The E letter key.

    Key_Escape: number

    The Escape key.

    Key_F: number

    The F letter key.

    Key_G: number

    The G letter key.

    Key_H: number

    The H letter key.

    Key_I: number

    The I letter key.

    Key_J: number

    The J letter key.

    Key_K: number

    The K letter key.

    Key_L: number

    The L letter key.

    Key_Left: number

    The Left arrow key.

    Key_M: number

    The M letter key.

    Key_Meta: number

    The Meta/Command modifier key.

    Key_N: number

    The N letter key.

    Key_O: number

    The O letter key.

    Key_P: number

    The P letter key.

    Key_Q: number

    The Q letter key.

    Key_R: number

    The R letter key.

    Key_Return: number

    The Return/Enter key.

    Key_Right: number

    The Right arrow key.

    Key_S: number

    The S letter key.

    Key_Shift: number

    The Shift modifier key.

    Key_Space: number

    The Space key.

    Key_T: number

    The T letter key.

    Key_Tab: number

    The Tab key.

    Key_U: number

    The U letter key.

    Key_Up: number

    The Up arrow key.

    Key_V: number

    The V letter key.

    Key_W: number

    The W letter key.

    Key_X: number

    The X letter key.

    Key_Y: number

    The Y letter key.

    Key_Z: number

    The Z letter key.

    Settings

    Member Visibility

    On This Page

    Enumeration Members