Interface CursorStateCollector

Cursor state collector for a single frame.

Widgets call request() during render to set cursor state. The final state is resolved via resolve() after rendering.

interface CursorStateCollector {
    request(req: CursorRequest): void;
    reset(): void;
    resolve(): | Readonly<
        {
            blink: boolean;
            shape: CursorShape;
            visible: boolean;
            x: number;
            y: number;
        },
    >
    | null;
}

Index

Methods

request reset resolve

Methods

request

request(req: CursorRequest): void
Request cursor to be shown at position with given appearance.
Parameters
- req: CursorRequest
Returns void
- Defined in core/src/cursor/cursorState.ts:46

reset

reset(): void
Reset for next frame.

Returns void
- Defined in core/src/cursor/cursorState.ts:52

resolve

resolve(): | Readonly<
    {
        blink: boolean;
        shape: CursorShape;
        visible: boolean;
        x: number;
        y: number;
    },
>
| null
Get the resolved cursor state after all widget requests.

Returns
    | Readonly<
        {
            blink: boolean;
            shape: CursorShape;
            visible: boolean;
            x: number;
            y: number;
        },
    >
    | null
- Defined in core/src/cursor/cursorState.ts:49

Interface CursorStateCollector

Index

Methods

Methods

request

Parameters

Returns void

reset

Returns void

resolve

Returns
    | Readonly<
        {
            blink: boolean;
            shape: CursorShape;
            visible: boolean;
            x: number;
            y: number;
        },
    >
    | null

Settings

On This Page

Interface CursorStateCollector

Index

Methods

Methods

request

Parameters

Returns void

reset

Returns void

resolve

Returns | Readonly< { blink: boolean; shape: CursorShape; visible: boolean; x: number; y: number; }, > | null

Settings

On This Page

Returns
| Readonly<
{
blink: boolean;
shape: CursorShape;
visible: boolean;
x: number;
y: number;
},
>
| null