Skip to content

class_buttonarray

Jump to bottom
reduz edited this page Feb 23, 2014 · 9 revisions

ButtonArray

Inherits: Control\n\n### Brief Description
Array of Buttons.

Member Functions

Signals

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_button" ( String text ) \ Add a new button. == set_button_icon ==
  • void set_button_icon" ( int button, Object icon ) \ Set the icon of an existing button. == get_button_text ==
  • String get_button_text" ( int button ) const \ Return the text of an existing button. == get_button_icon ==
  • Object get_button_icon" ( int button ) const \ Return the icon of an existing button. == get_button_count ==
  • int get_button_count" ( ) const \ Return the amount of buttons in the array. == get_selected ==
  • int get_selected" ( ) const \ Return the currently selected button in the array. == get_hovered ==
  • int get_hovered" ( ) const \ Return the currently hovered button in the array. == set_selected ==
  • void set_selected" ( int button ) \ Sekect a button in the array. == erase_button ==
  • void erase_button" ( int button ) \ Remove a button in the array, by index. == clear ==
  • void clear" ( ) \ Clear the button array.

Clone this wiki locally