lazy-widgets/dist/events/KeyEvent.d.ts

Typescript retained mode GUI for the HTML canvas API

import { ModifierEvent } from './ModifierEvent.js';
import { FocusType } from '../core/FocusType.js';
import type { Widget } from '../widgets/Widget.js';
/**
 * A keyboard {@link ModifierEvent}. This is an abstract class and is
 * implemented in the child classes {@link KeyPressEvent} and
 * {@link KeyReleaseEvent}.
 *
 * Has a focus type of {@link FocusType.Keyboard} and needs focus.
 *
 * @category Event
 */
export declare abstract class KeyEvent extends ModifierEvent {
    readonly focusType: FocusType.Keyboard;
    readonly needsFocus: true;
    /**
     * This event's key. Uses the same values as the
     * {@link https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values | KeyboardEvent.key}
     * Web API.
     */
    readonly key: string;
    /**
     * Does this event original from a virtual keyboard? If true, then
     * {@link TabSelectEvent} events will not be dispatched when a Tab key press
     * is not caught.
     */
    readonly virtual: boolean;
    constructor(key: string, shift: boolean, ctrl: boolean, alt: boolean, virtual: boolean, target: Widget | null);
}