Class ListSelector

Represents a list selector widget in the UI, allowing the user to navigate and select items.

Inheritance
object
Widget
ListSelector
Inherited Members
Namespace: Genesis.UI
Assembly: Genesis.dll
Syntax
public class ListSelector : Widget

Constructors

ListSelector(string, Vec3, Font)

Creates a new instance of the ListSelector class.

Declaration
public ListSelector(string name, Vec3 location, Font font)
Parameters
Type Name Description
string name

The name of the list selector.
Vec3 location

The location of the list selector.
Font font

The font used for rendering text in the list.

Properties

CenterText

Gets or sets a value indicating whether the text should be centered within each line.

Declaration
public bool CenterText { get; set; }
Property Value
Type Description
bool

Font

Gets or sets the font used for rendering text in the list.

Declaration
public Font Font { get; set; }
Property Value
Type Description
Font

FontSize

Gets or sets the font size used for rendering text in the list.

Declaration
public float FontSize { get; set; }
Property Value
Type Description
float

FontSpacing

Gets or sets the font spacing used for rendering text in the list.

Declaration
public float FontSpacing { get; set; }
Property Value
Type Description
float

IndexChangedBehavior

Gets or sets the behavior invoked when the selected index changes.

Declaration
public ListSelectorBehavior IndexChangedBehavior { get; set; }
Property Value
Type Description
ListSelectorBehavior

Items

Gets or sets the list of items in the selector.

Declaration
public List<ListItem> Items { get; set; }
Property Value
Type Description
List<ListItem>

LineHeight

Gets or sets the height of each line in the list.

Declaration
public float LineHeight { get; set; }
Property Value
Type Description
float

SelectedIndex

Gets or sets the index of the currently selected item.

Declaration
public int SelectedIndex { get; set; }
Property Value
Type Description
int

Methods

AddItem(ListItem)

Adds an item to the list selector.

Declaration
public void AddItem(ListItem item)
Parameters
Type Name Description
ListItem item

The item to add.

OnRender(Game, IRenderDevice, Scene, Canvas)

Renders the list selector on the screen.

Declaration
public override void OnRender(Game game, IRenderDevice renderDevice, Scene scene, Canvas canvas)
Parameters
Type Name Description
Game game

The game instance.
IRenderDevice renderDevice

The render device.
Scene scene

The scene instance.
Canvas canvas

The canvas containing the list selector.
Overrides

OnUpdate(Game, Scene, Canvas)

Updates the list selector.

Declaration
public override void OnUpdate(Game game, Scene scene, Canvas canvas)
Parameters
Type Name Description
Game game

The game instance.
Scene scene

The scene instance.
Canvas canvas

The canvas containing the list selector.
Overrides