Lysa.ui  0.0
Lysa 3D Engine
lysa.ui Lua Namespace Reference

The lysa.ui sub-module — immediate-mode UI widgets and window management.

Enums & Constants

enum  Alignment
 Constants controlling how a widget is placed inside its parent's content area.
 
enum  ArrowOrientation
 Direction an Arrow points to.
 
enum  CheckState
 Check/toggle state constants for CheckWidget and ToggleButton.
 
enum  ColorPickerComponent
 Color component identifying a row of a ColorPicker.
 
enum  ColorPickerMode
 Color space displayed by a ColorPicker.
 
enum  LineStyle
 Orientation constants for Line widgets.
 
enum  ProgressBarDisplay
 Optional text display mode drawn over the progress bar.
 
enum  ProgressBarType
 Orientation constants for ProgressBar widgets.
 
enum  ResizeableBorder
 Bitmask constants for which borders of a Window can be dragged to resize it.
 
enum  ScrollBarButtonsPlacement
 End of the bar where the two buttons of a ScrollBar are placed.
 
enum  ScrollBarType
 Orientation constants for ScrollBar widgets.
 
enum  SliderType
 Orientation constants for Slider and ColorSlider widgets.
 
enum  SortOrder
 Direction of the sort of a column of a Table.
 
enum  SpinBoxButtonsPlacement
 Side of the text field of a SpinBox where the two buttons are placed.
 
enum  SpinButtonsOrientation
 Placement constants for the two buttons of a SpinButtons widget.
 
enum  SVGBounds
 Reference rectangle used to fit an SVG shape into an IconSVG.
 
enum  TabPlacement
 Position of a bar of tabs relatively to the content displayed by the tabs.
 
enum  TreeViewSelectionMode
 Selection behavior constants for TreeView widgets.
 
enum  WidgetType
 Integer constants identifying the concrete type of a widget.
 

Structures

struct  Arrow
 An arrow head drawn inside a square area centered in the widget rectangle.
 
struct  CheckWidget
 Base class for widgets with a binary checked/unchecked state (e.g. ToggleButton).
 
struct  Frame
 A bordered panel with a title string rendered in its top border.
 
struct  Line
 A thin separator line, either horizontal or vertical.
 
struct  Popup
 A widget placed at a fixed (x, y) position relative to its parent and always drawn on top of sibling widgets.
 
struct  TreeViewItem
 A single row in a TreeView, which can contain a child widget and be expanded or collapsed.
 
struct  UIEvent
 String event-type constants used when subscribing to widget events via EventManager.
 
struct  ValueSelect
 Base class for widgets that expose a numeric value within a bounded range.
 

Classes

class  Box
 A Panel with a visible border drawn around its edges.
 
class  Button
 A push button that fires the OnClick event when pressed and released by the user.
 
class  CheckBox
 A two-state box displaying a CheckMark when checked. Each click toggles the state and fires OnStateChange.
 
class  CheckMark
 A check mark drawn inside the widget rectangle, sized to fill it.
 
class  ColorPicker
 A color selector with a color wheel and one slider per component. Fires OnColorChange.
 
class  ColorPickerButton
 A button displaying a color, opening a ColorPicker dialog when clicked. Fires OnColorChange.
 
class  ColorSlider
 A Slider whose track is drawn with a gradient of colors.
 
class  ColorWheel
 A disc selecting the hue and the saturation of a color. Fires OnColorChange.
 
class  CrossMark
 A cross mark drawn inside the widget rectangle, sized to fill it. Opposite of a CheckMark.
 
class  DropDownList
 A button displaying the selected item of a list, opening a popup list when clicked. Fires OnSelectItem.
 
class  FoldableContainer
 A container folding and unfolding its content with a clickable title bar. Fires OnExpandItem with the content widget when the state changes.
 
class  Grid
 A grid of GridCell with per-row heights, per-column widths and spanning cells. A row or a column sized with zero shares the remaining space with the other automatically sized rows and columns.
 
class  GridCell
 A cell of a Grid, holding the widgets displayed at one position of the grid. The data displayed by a cell is never owned by the cell, store it in its user data.
 
class  HColorSlider
 A horizontal color gradient slider.
 
class  HLine
 A horizontal separator line widget.
 
class  HProgressBar
 A horizontal progress bar (fills left to right).
 
class  HScrollBar
 A horizontal scroll bar widget.
 
class  HSlider
 A horizontal slider, the value increases to the right.
 
class  Icon
 Base class for the widgets drawing a picture fitted into the widget rectangle.
 
class  IconImage
 A 2-D image fitted into the widget rectangle.
 
class  IconSVG
 An SVG shape fitted into the widget rectangle.
 
class  Image
 A widget that displays a GPU image with an optional color tint.
 
class  List
 Base class for all list-of-widgets widgets. Fires OnInsertItem, OnRemoveItem and OnSelectItem events.
 
class  ListBox
 A scrollable list of widgets with a selection highlight rectangle. Supports keyboard navigation.
 
class  Menu
 A vertical list of text items, optionally split into groups by separator lines. Fires OnSelectItem when an item is clicked.
 
class  Panel
 A rectangular widget that renders only a background fill; no border.
 
class  ProgressBar
 A rectangular progress bar widget that fills as its value increases.
 
class  RadioButton
 A two-state button drawn with two circles, the inner circle color changes with the state. Checking one radio button unchecks the other radio buttons sharing the same parent widget and the same group_index.
 
class  RichTextArea
 A read-only area displaying word-wrapped text marked up with BBCode. Supported tags : [b], [i], [u], [s], [color=...], [size=n], [url=target], [code], [left], [center], [right] and [br]. Fires OnClick when a link is clicked.
 
class  ScrollBar
 A scroll bar widget whose value represents a scroll position within [min, max].
 
class  ScrollBox
 A scrollable container with horizontal and vertical scroll bars. Add children via add_content.
 
class  Selection
 A selection highlight rectangle drawn behind the selected item of a ListBox.
 
class  Slider
 A value selected by dragging a grip along a track. Fires OnValueChange.
 
class  SpinBox
 An editable numeric value with two buttons incrementing and decrementing it. Fires OnValueChange.
 
class  Style
 The drawing backend of the widgets, configured with a map of name-value options.
 
class  TabBar
 A horizontal bar of tabs. Draws and selects the tabs, without managing the widgets they display. Fires OnSelectItem when a tab is selected.
 
class  TabContainer
 A container displaying one widget at a time, selected with a TabBar. Fires OnSelectItem with the displayed widget when a tab is selected.
 
class  Table
 A Grid with a row of column headers. Clicking a sortable header fires OnSortColumn, dragging the right border of a resizable header fires OnResizeColumn. The rows are never reordered by the table itself.
 
class  Text
 A single-line read-only text label.
 
class  TextEdit
 A single-line editable text input field. Fires OnTextChange and OnTextInput events.
 
class  ToggleButton
 A button that alternates between checked and unchecked states on each click. Fires OnStateChange on toggle.
 
class  TreeView
 A hierarchical list widget that displays items in an expandable/collapsible tree structure.
 
class  VColorSlider
 A vertical color gradient slider.
 
class  VLine
 A vertical separator line widget.
 
class  VProgressBar
 A vertical progress bar (fills bottom to top).
 
class  VScrollBar
 A vertical scroll bar widget.
 
class  VSlider
 A vertical slider, the value increases to the top.
 
class  Widget
 The base class for all UI widgets. Provides layout, input handling, and child management.
 
class  Window
 A UI window that owns a root Widget hierarchy and is managed by the WindowManager.
 
class  WindowManager
 The central manager for all UI windows attached to a rendering target.