lazy-widgets
Version:
Typescript retained mode GUI for the HTML canvas API
29 lines (28 loc) • 1.25 kB
TypeScript
import { KeyboardDriver } from '../../drivers/KeyboardDriver.js';
import { Column } from '../Column.js';
import { VirtualKeyboardTemplate } from '../../core/VirtualKeyboardTemplate.js';
import type { Widget, WidgetProperties } from '../Widget.js';
import type { WidgetEvent } from '../../events/WidgetEvent.js';
import type { WidgetAutoXML } from '../../xml/WidgetAutoXML.js';
/**
* A virtual keyboard widget.
*
* Needs a {@link KeyboardDriver} so that key events can be queued.
*
* Equivalent to creating a {@link Column} of {@link VirtualKeyRow} with a shared
* {@link KeyContext}. Key rows will be created with SpaceBetween main alignment
* and Stretch cross alignment.
*
* Ignores all events except pointer events, so that the virtual keyboard never
* gets the keyboard or tab focus.
*
* @category Widget
*/
export declare class VirtualKeyboard extends Column {
static autoXML: WidgetAutoXML;
/**
* @param keyboardTemplate - By default, the virtual keyboard template is {@link defaultVirtualKeyboardTemplate}.
*/
constructor(keyboardDriver: KeyboardDriver, keyboardTemplate?: VirtualKeyboardTemplate, properties?: Readonly<WidgetProperties>);
protected handleEvent(event: WidgetEvent): Widget | null;
}