class_buttonarray

ButtonArray

####Inherits: Control ####Category: Core

Brief Description

Array of Buttons.

Member Functions

• void add&#95button ( String text )
• void add&#95icon&#95button ( Object icon, String text="" )
• void set&#95button&#95text ( int button, String text )
• void set&#95button&#95icon ( int button, Object icon )
• String get&#95button&#95text ( int button ) const
• Object get&#95button&#95icon ( int button ) const
• int get&#95button&#95count ( ) const
• int get&#95selected ( ) const
• int get&#95hovered ( ) const
• void set&#95selected ( int button )
• void erase&#95button ( int button )
• void clear ( )

Signals

• button&#95selected ( int button )

Numeric Constants

• ALIGN_BEGIN = 0 - Align buttons at the begining.
• ALIGN_CENTER = 1 - Align buttons in the middle.
• ALIGN_END = 2 - Align buttons at the end.
• ALIGN_FILL = 3 - Spread the buttons, but keep them small.
• ALIGN_EXPAND_FILL = 4 - Spread the buttons, but expand them.

Description

Array of Buttons. A Button array is useful to have an array of buttons laid out vertically or horizontally. Only one can be selected. This is useful for joypad based interfaces and option menus.

Member Function Description

add_button

• void add&#95button ( String text )

Add a new button.

set_button_icon

• void set&#95button&#95icon ( int button, Object icon )

Set the icon of an existing button.

get_button_text

• String get&#95button&#95text ( int button ) const

Return the text of an existing button.

get_button_icon

• Object get&#95button&#95icon ( int button ) const

Return the icon of an existing button.

get_button_count

• int get&#95button&#95count ( ) const

Return the amount of buttons in the array.

get_selected

• int get&#95selected ( ) const

Return the currently selected button in the array.

get_hovered

• int get&#95hovered ( ) const

Return the currently hovered button in the array.

set_selected

• void set&#95selected ( int button )

Sekect a button in the array.

erase_button

• void erase&#95button ( int button )

Remove a button in the array, by index.

clear

• void clear ( )

Clear the button array.