`CRatingWidget`

Widgets · extends CWidget

An integer star rating. Hover previews a value; releasing the mouse commits it.

import { CRatingWidget } from "canvas-toolkit-lib";

Declared members

readonly valueChanged: CSignal<[number]>;

constructor(parent?: CWidget | null);

value(): number;

maximum(): number;

previewValue(): number;

isReadOnly(): boolean;

starSize(): number;

spacing(): number;

setValue(value: number): void;

Values are rounded down and clamped to 0..maximum. Non-finite inputs throw.

setMaximum(maximum: number): void;

Number of stars, normalized to an integer in 1..100.

setReadOnly(readOnly: boolean): void;

setStarSize(size: number): void;

Preferred star size in logical pixels, normalized to 8..128.

setSpacing(spacing: number): void;

Gap in logical pixels, normalized to 0..32.

sizeHint(): CSize;

starRect(index: number): CRect | null;

Returns the star's actual, possibly scaled rectangle, or null for an invalid index.

setGeometry(x: number, y: number, width: number, height: number): void;

setEnabled(enabled: boolean): void;

hide(): void;

protected mouseMoveEvent(event: CMouseEvent): void;

protected mouseEnterEvent(event: CMouseEvent): void;

protected mouseLeaveEvent(event: CMouseEvent): void;

protected mousePressEvent(event: CMouseEvent): void;

protected mouseReleaseEvent(event: CMouseEvent): void;

protected focusOutEvent(event: CFocusEvent): void;

protected keyPressEvent(event: CKeyEvent): void;

protected paintEvent(painter: CPainter): void;