UIMenu
[
Front page
] [
New
|
Page list
|
Search
|
Recent changes
|
Help
|
Log in
]
Start:
* Class: UIMenu
A UI widget displaying a menu with customizable options.~
It emit 'E_ITEM_FOCUSED' with data { id, index }~
It emit 'E_ITEM_UNFOCUSED'~
It emit 'E_ITEM_SELECTED' with data { id, index }~
It emit 'E_ITEM_UNSELECTED'~
It emit 'E_UNSELECTED'~
It emit 'E_CLOSED'~
- inherit from: UIWidget~
- parent of: UIMenuListView, UIMenuText~
** Constructors
- ''new UIMenu''(options): UIMenu~
-- ''options'': Various options for configuring the behav...
** Methods
- ''addWidget''(widget: UIWidget, index: number): void~
Add a UI widget item.~
-- ''widget'': The widget.~
-- ''index'': The position at which the widget should be ...
provided (default value is -1), the widget will be added ...
~
- ''clear''(): void~
Remove all widget items.~
~
- ''delete''(): void~
Free all resources.~
Warning: You need to call this method to free allocation ...
~
- ''focus''(focusIndex: MenuFocus): void~
Focus on.~
-- ''focusIndex'': If MenuFocus.AUTO then refocus the chi...
~
- ''focusWidget''(index: number, preventScroll: boolean, ...
Focus on widget item.~
It emit an 'E_ITEM_FOCUSED' event.~
-- ''index'': The index position of the widget.~
-- ''preventScroll'': Indicating whether to prevent scrol...
-- ''emit'': Determines whether an event should be emitte...
~
- ''getFocusedWidgetId''()~
Returns the ID of the focused widget, or null if there is...
~
- ''getFocusedWidgetIndex''(): number~
Returns the index position of the focused widget item, or...
~
- ''getSelectedWidgetId''()~
Returns the ID of the first selected widget, or null if n...
~
- ''getSelectedWidgetIds''()~
Returns a list of IDs of selected widget items.~
~
- ''getSelectedWidgetIndex''(): number~
Returns the index position of the first selected widget i...
~
- ''getSelectedWidgetIndexes''()~
Returns a list of index position of selected widget items.~
~
- ''getWidget''(index: number): UIWidget~
Returns the widget at the specified index.~
-- ''index'': The index position of the widget.~
~
- ''getWidgets''()~
Returns all widgets.~
~
- ''onAction''(actionId: string): void~
The onAction function.~
-- ''actionId''~
~
- ''removeWidget''(index: number): void~
Remove a UI widget item.~
-- ''index'': The position of the widget.~
~
- ''selectWidget''(index: number, emit: boolean): void~
Select a widget item.~
It emits an 'E_ITEM_SELECTED' event.~
-- ''index'': The index position of the widget.~
-- ''emit'': Determines whether an event should be emitte...
~
- ''setEnabledWidget''(index: number, enabled: boolean): ...
Set enabled flag of a widget item.~
-- ''index'': The index position of the widget.~
-- ''enabled'': Determines whether the widget should be e...
~
- ''setEnabledWidgets''(enabled: boolean): void~
Set the enabled flag of all widget items.~
-- ''enabled'': Determines whether the widgets should be ...
~
- ''unfocusWidget''(emit: boolean): void~
Focus off widget item (if exist).~
It emits an 'E_ITEM_UNFOCUSED' event.~
-- ''emit'': Determines whether an event should be emitte...
~
- ''unselectWidget''(index: number, emit: boolean): void~
Unselects a widget item.~
It emits an 'E_ITEM_UNSELECTED' event.~
-- ''index'': The index position of the widget.~
-- ''emit'': Determines whether an event should be emitte...
~
- ''unselectWidgets''(emit: boolean): void~
Unselect all widget items.~
It emits an 'E_UNSELECTED' event.~
-- ''emit'': Determines whether an event should be emitte...
~
- ''update''(ts: number): void~
The update function.~
-- ''ts'': The timestep.~
End:
* Class: UIMenu
A UI widget displaying a menu with customizable options.~
It emit 'E_ITEM_FOCUSED' with data { id, index }~
It emit 'E_ITEM_UNFOCUSED'~
It emit 'E_ITEM_SELECTED' with data { id, index }~
It emit 'E_ITEM_UNSELECTED'~
It emit 'E_UNSELECTED'~
It emit 'E_CLOSED'~
- inherit from: UIWidget~
- parent of: UIMenuListView, UIMenuText~
** Constructors
- ''new UIMenu''(options): UIMenu~
-- ''options'': Various options for configuring the behav...
** Methods
- ''addWidget''(widget: UIWidget, index: number): void~
Add a UI widget item.~
-- ''widget'': The widget.~
-- ''index'': The position at which the widget should be ...
provided (default value is -1), the widget will be added ...
~
- ''clear''(): void~
Remove all widget items.~
~
- ''delete''(): void~
Free all resources.~
Warning: You need to call this method to free allocation ...
~
- ''focus''(focusIndex: MenuFocus): void~
Focus on.~
-- ''focusIndex'': If MenuFocus.AUTO then refocus the chi...
~
- ''focusWidget''(index: number, preventScroll: boolean, ...
Focus on widget item.~
It emit an 'E_ITEM_FOCUSED' event.~
-- ''index'': The index position of the widget.~
-- ''preventScroll'': Indicating whether to prevent scrol...
-- ''emit'': Determines whether an event should be emitte...
~
- ''getFocusedWidgetId''()~
Returns the ID of the focused widget, or null if there is...
~
- ''getFocusedWidgetIndex''(): number~
Returns the index position of the focused widget item, or...
~
- ''getSelectedWidgetId''()~
Returns the ID of the first selected widget, or null if n...
~
- ''getSelectedWidgetIds''()~
Returns a list of IDs of selected widget items.~
~
- ''getSelectedWidgetIndex''(): number~
Returns the index position of the first selected widget i...
~
- ''getSelectedWidgetIndexes''()~
Returns a list of index position of selected widget items.~
~
- ''getWidget''(index: number): UIWidget~
Returns the widget at the specified index.~
-- ''index'': The index position of the widget.~
~
- ''getWidgets''()~
Returns all widgets.~
~
- ''onAction''(actionId: string): void~
The onAction function.~
-- ''actionId''~
~
- ''removeWidget''(index: number): void~
Remove a UI widget item.~
-- ''index'': The position of the widget.~
~
- ''selectWidget''(index: number, emit: boolean): void~
Select a widget item.~
It emits an 'E_ITEM_SELECTED' event.~
-- ''index'': The index position of the widget.~
-- ''emit'': Determines whether an event should be emitte...
~
- ''setEnabledWidget''(index: number, enabled: boolean): ...
Set enabled flag of a widget item.~
-- ''index'': The index position of the widget.~
-- ''enabled'': Determines whether the widget should be e...
~
- ''setEnabledWidgets''(enabled: boolean): void~
Set the enabled flag of all widget items.~
-- ''enabled'': Determines whether the widgets should be ...
~
- ''unfocusWidget''(emit: boolean): void~
Focus off widget item (if exist).~
It emits an 'E_ITEM_UNFOCUSED' event.~
-- ''emit'': Determines whether an event should be emitte...
~
- ''unselectWidget''(index: number, emit: boolean): void~
Unselects a widget item.~
It emits an 'E_ITEM_UNSELECTED' event.~
-- ''index'': The index position of the widget.~
-- ''emit'': Determines whether an event should be emitte...
~
- ''unselectWidgets''(emit: boolean): void~
Unselect all widget items.~
It emits an 'E_UNSELECTED' event.~
-- ''emit'': Determines whether an event should be emitte...
~
- ''update''(ts: number): void~
The update function.~
-- ''ts'': The timestep.~
Page: