Scrollable list that contains Items. More...

Inheritance diagram for SimpleListMenu:

Public Member Functions
void	refresh ()
	Forces listView to refresh each of the contained `Items`. More...

Public Member Functions inherited from UiComponent
void	show (int time)
	Shows the UiComponent over `time` milliseconds. More...

void	hide (int time)
	Hides the UiComponent over `time` milliseconds. More...

Properties
real	listItemWidth
	Width of `Items` held in this SimpleListMenu. More...

real	listItemHeight
	Height of `Items` held in this SimpleListMenu. More...

ListView	listView
	ListView which holds the `Items` and provides scrolling functionality. More...

real	visibleItemCount
	Number of `Items` visible at any time. More...

Properties inherited from UiComponent
string	showState
	State transitioned to when show() is called. More...

string	hideState
	State transitioned to when hide() is called. More...

int	showDuration
	Time, in milliseconds, that the UiComponent takes to show. More...

int	hideDuration
	Time, in milliseconds, that the UiComponent takes to hide. More...

bool	showing
	Whether or not the UiComponent is shown or is transitioning to the showState. More...

bool	shouldGainFocus
	Whether or not the UiComponent should gain focus when shown. More...

Item	returnFocusTo
	Item that the component returns focus to if this UiComponent gained focus previously. More...

Properties inherited from KeyNavFocusArea
Item	focusUp
	`Item` to transfer focus to upon an "up" press. More...

Item	focusDown
	`Item` to transfer focus to upon an "down" press. More...

Item	focusLeft
	`Item` to transfer focus to upon an "left" press. More...

Item	focusRight
	`Item` to transfer focus to upon an "right" press. More...

bool	captureBackNavigation
	Whether or not the back button event is handled. More...

int	backNavigationMode
	Mode that determines what keys behave as back buttons. More...

Additional Inherited Members
Signals inherited from UiComponent
void	showCompleted ()
	Emitted when the UiComponent has completely shown. More...

void	hideCompleted ()
	Emitted when the UiComponent has completely hidden. More...

Signals inherited from KeyNavFocusArea
void	pressed ()
	Emitted when this area receives a button press. More...

void	released ()
	Emitted when this area receives a button release. More...

void	escaped ()
	Emitted when a back navigation event occurs. More...

Detailed Description

Scrollable list that contains Items.

Member Function Documentation

void SimpleListMenu::refresh ( )

Forces listView to refresh each of the contained Items.

This function looks for and invokes a refresh() function dynamically defined on each of the contained Items and invokes them as necessary.

real SimpleListMenu::listItemHeight

Height of Items held in this SimpleListMenu.

real SimpleListMenu::listItemWidth

Width of Items held in this SimpleListMenu.

ListView SimpleListMenu::listView

ListView which holds the Items and provides scrolling functionality.

Note: This is exposed to allow for the customization of properties on the ListView, most importantly listView.model.

real SimpleListMenu::visibleItemCount

Number of Items visible at any time.

Note: Fractions of Items may be visible while scrolling, but the total Item visible area should remain about the same.