Skip to main content
Version: 2.6.0

Class: UIItemSelector

The UIItemSelector class represents a versatile item selection component for UI systems. It displays a grid of selectable items, supports callback functions for item selection, and optionally displays item names during hold events.

The source file for this class is located in os/ui/UIComponents/UIItemSelector.h.

Constructor​

UIItemSelector​

UIItemSelector(Dimension dimension, Color color, T* output, uint16_t count, T* items, string* names = nullptr, std::function<void(T)> callback = nullptr);

Creates a new item selector UI component.

Template Parameter:

  • T: The data type of the selectable items.

Parameters:

  • dimension (Dimension): The grid size of the item selector.
  • color Color: The color for the selector.
  • output (T*): Pointer to the variable that will store the selected item.
  • count (uint16_t): The number of items in the selector.
  • items (T*): Pointer to the array of items.
  • names (string*, optional): Pointer to an array of item names. Defaults to nullptr.
  • callback (std::function<void(T)>, optional): A callback function invoked when an item is selected. Defaults to nullptr.

Methods​

GetColor​

virtual Color GetColor();

Retrieves the color of the selector.

Returns:

  • Color: The color of the selector.

SetColor​

void SetColor(Color color);

Sets the color of the selector.

Parameters:

  • color Color: The new color for the selector.

GetSize​

virtual Dimension GetSize();

Calculates the dimensions of the selector grid. Override this method to provide custom dimensions.

Returns:

  • Dimension: The dimensions (width and height) of the selector.

Render​

virtual bool Render(Point origin);

Renders the selector grid, highlighting the selected item and dimming unselected items. Override this method to customize the rendering behavior.

Parameters:

  • origin (Point): The top-left corner of the rendering area.

Returns:

  • bool: true if rendering was successful.

KeyEvent​

virtual bool KeyEvent(Point xy, KeyInfo* keyInfo);

Handles key events for selecting items and optionally displaying their names. Override this method to customize the item selection behavior.

Parameters:

  • xy (Point): The position of the event relative to the selector grid.
  • keyInfo (KeyInfo*): Information about the key event.

Behavior:

  • Pressed: Selects the item at the event position and invokes the callback, if defined.
  • Released: Selects the item and invokes the callback if names is provided.
  • Hold: Displays the item's name in a scrolling text format if names is defined.

Returns:

  • bool: true if the event was handled, false otherwise.

Comments