class_optionbutton

OptionButton

####Inherits: Button ####Category: Core

Brief Description

Button control that provides selectable options when pressed.

Member Functions

• void add&#95item ( String label, int id=-1 )
• void add&#95icon&#95item ( Texture texture, String label, int id )
• void set&#95item&#95text ( int idx, String text )
• void set&#95item&#95icon ( int idx, Texture texture )
• void set&#95item&#95disabled ( int idx, bool disabled )
• void set&#95item&#95ID ( int idx, int id )
• void set&#95item&#95metadata ( int idx, var metadata )
• String get&#95item&#95text ( int idx ) const
• Texture get&#95item&#95icon ( int idx ) const
• int get&#95item&#95ID ( int idx ) const
• void get&#95item&#95metadata ( int idx ) const
• bool is&#95item&#95disabled ( int idx ) const
• int get&#95item&#95count ( ) const
• void add&#95separator ( )
• void clear ( )
• void select ( int arg0 )
• int get&#95selected ( ) const
• int get&#95selected&#95ID ( ) const
• void get&#95selected&#95metadata ( ) const
• void remove&#95item ( int idx )

Signals

• item&#95selected ( int ID )

Description

OptionButton is a type button that provides a selectable list of items when pressed. The item selected becomes the "current" item and is displayed as the button text.

Member Function Description

add_item

• void add&#95item ( String label, int id=-1 )

Add an item, with text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end.

add_icon_item

• void add&#95icon&#95item ( Texture texture, String label, int id )

Add an item, with a "texture" icon, text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end.

set_item_text

• void set&#95item&#95text ( int idx, String text )

Set the text of an item at index "idx".

set_item_icon

• void set&#95item&#95icon ( int idx, Texture texture )

Set the icon of an item at index "idx".

set_item_ID

• void set&#95item&#95ID ( int idx, int id )

Set the ID of an item at index "idx".

get_item_text

• String get&#95item&#95text ( int idx ) const

Return the text of the item at index "idx".

get_item_icon

• Texture get&#95item&#95icon ( int idx ) const

Return the icon of the item at index "idx".

get_item_ID

• int get&#95item&#95ID ( int idx ) const

Return the ID of the item at index "idx".

get_item_count

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

Return the amount of items in the OptionButton.

add_separator

• void add&#95separator ( )

Add a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end.

clear

• void clear ( )

Clear all the items in the OptionButton.

select

• void select ( int arg0 )

Select an item by index and make it the current item.

get_selected

• int get&#95selected ( ) const

Return the current item index