final class UIRating

package smidr.widgets

extends UIComponent

@:build(openfl.utils._internal.AssetsMacro.initBinding())@:autoBuild(openfl.utils._internal.AssetsMacro.initBinding())

A star rating: a row of max stars, filled up to rating. Clicking or dragging sets the rating (with a live hover preview), unless readOnly. onChange fires with the new 1-based rating (0 when cleared by clicking the current single star). Uses the built-in STAR glyph.

Constructor

@:value({ rating : 0, max : 5 })new(max:Int = 5, rating:Int = 0, ?onChange:Int ‑> Void)

Parameters:

max

number of stars

rating

the initial rating

onChange

fired when the rating changes

Variables

@:value(-1)color:Int = -1

Filled-star colour, or -1 for the theme warning colour.

@:value(4)gap:Float = 4

Base (unscaled) gap between stars.

max:Int

Number of stars.

rating:Int

Current rating (0..max).

@:value(false)readOnly:Bool = false

Display only (no pointer interaction).

@:value(20)starSize:Float = 20

Base (unscaled) star size.

@:value(null)onChange:Int ‑> Void = null

Fired when the rating changes.

Methods

Inherited Variables

Defined by UIComponent

@:value(true)enabled:Bool = true

Disabled widgets ignore the pointer and typically render dimmed.

@:value(0)read onlyh:Float = 0

Layout height in UI units.

@:value(MouseCursor.BUTTON)hoverCursor:MouseCursor = MouseCursor.BUTTON

Native cursor while hovering (interactive widgets; null keeps the arrow).

@:value(false)read onlyhovered:Bool = false

true while the cursor is over this widget.

@:value(false)longPressable:Bool = false

Opts a subclass that overrides onRightPress (without setting onRightClick) into long-press-as-right-click on touch. Widgets with onRightClick set are included automatically.

@:value(null)onClick:() ‑> Void = null

Fired on a completed click (press + release on this widget). Requires an interactive widget.

@:value(null)onHover:() ‑> Void = null

Fired when the cursor first enters this widget (hover-driven descriptions/previews). Interactive widgets only.

@:value(null)onRightClick:() ‑> Void = null

Fired on a right mouse press over this widget (context menus). Only interactive widgets receive pointer events, so this never fires on passive widgets like UILabel/UIPanel — attach it to a UIButton (or another interactive widget) instead. On touch, a long-press fires the same path (see UIRoot.longPressMs).

@:value(false)read onlypressed:Bool = false

true while a press that started here is held.

@:value(null)tooltip:String = null

Optional tooltip text (already-localized or a fixed string).

@:value(null)tooltipShortcut:String = null

Optional right-aligned shortcut hint rendered in the tooltip.

@:value(0)read onlyw:Float = 0

Layout width in UI units (independent of DisplayObject's content-derived width).

Inherited Methods

Defined by UIComponent

invalidate():Void

Schedules a repaint for the next frame (cheap; deduplicated).

resize(width:Float, height:Float):Void

Sets the layout size and repaints when it changed.

Parameters:

width

the new layout width in UI units

height

the new layout height in UI units