ItemList

Inherits: Control < CanvasItem < Node < Object

There is currently no description for this class. Please help us by contributing one!

Properties

bool	allow_reselect	`false`
bool	allow_rmb_select	`false`
bool	allow_search	`true`
bool	auto_height	`false`
bool	clip_contents	`true` (overrides Control)
int	fixed_column_width	`0`
Vector2i	fixed_icon_size	`Vector2i(0, 0)`
FocusMode	focus_mode	`2` (overrides Control)
IconMode	icon_mode	`1`
float	icon_scale	`1.0`
int	item_count	`0`
int	max_columns	`1`
int	max_text_lines	`1`
bool	same_column_width	`false`
SelectMode	select_mode	`0`
OverrunBehavior	text_overrun_behavior	`3`

Methods

int	add_icon_item ( Texture2D icon, bool selectable=true )
int	add_item ( String text, Texture2D icon=null, bool selectable=true )
void	clear ( )
void	deselect ( int idx )
void	deselect_all ( )
void	ensure_current_is_visible ( )
void	force_update_list_size ( )
int	get_item_at_position ( Vector2 position, bool exact=false ) const
Color	get_item_custom_bg_color ( int idx ) const
Color	get_item_custom_fg_color ( int idx ) const
Texture2D	get_item_icon ( int idx ) const
Color	get_item_icon_modulate ( int idx ) const
Rect2	get_item_icon_region ( int idx ) const
String	get_item_language ( int idx ) const
Variant	get_item_metadata ( int idx ) const
Rect2	get_item_rect ( int idx, bool expand=true ) const
String	get_item_text ( int idx ) const
TextDirection	get_item_text_direction ( int idx ) const
String	get_item_tooltip ( int idx ) const
PackedInt32Array	get_selected_items ( )
VScrollBar	get_v_scroll_bar ( )
bool	is_anything_selected ( )
bool	is_item_disabled ( int idx ) const
bool	is_item_icon_transposed ( int idx ) const
bool	is_item_selectable ( int idx ) const
bool	is_item_tooltip_enabled ( int idx ) const
bool	is_selected ( int idx ) const
void	move_item ( int from_idx, int to_idx )
void	remove_item ( int idx )
void	select ( int idx, bool single=true )
void	set_item_custom_bg_color ( int idx, Color custom_bg_color )
void	set_item_custom_fg_color ( int idx, Color custom_fg_color )
void	set_item_disabled ( int idx, bool disabled )
void	set_item_icon ( int idx, Texture2D icon )
void	set_item_icon_modulate ( int idx, Color modulate )
void	set_item_icon_region ( int idx, Rect2 rect )
void	set_item_icon_transposed ( int idx, bool transposed )
void	set_item_language ( int idx, String language )
void	set_item_metadata ( int idx, Variant metadata )
void	set_item_selectable ( int idx, bool selectable )
void	set_item_text ( int idx, String text )
void	set_item_text_direction ( int idx, TextDirection direction )
void	set_item_tooltip ( int idx, String tooltip )
void	set_item_tooltip_enabled ( int idx, bool enable )
void	sort_items_by_text ( )

Theme Properties

Color	font_color	`Color(0.65, 0.65, 0.65, 1)`
Color	font_hovered_color	`Color(0.95, 0.95, 0.95, 1)`
Color	font_outline_color	`Color(0, 0, 0, 1)`
Color	font_selected_color	`Color(1, 1, 1, 1)`
Color	guide_color	`Color(0.7, 0.7, 0.7, 0.25)`
int	h_separation	`4`
int	icon_margin	`4`
int	line_separation	`2`
int	outline_size	`0`
int	v_separation	`4`
Font	font
int	font_size
StyleBox	cursor
StyleBox	cursor_unfocused
StyleBox	focus
StyleBox	hovered
StyleBox	panel
StyleBox	selected
StyleBox	selected_focus

Signals

empty_clicked ( Vector2 at_position, int mouse_button_index )

There is currently no description for this signal. Please help us by contributing one!

item_activated ( int index )

There is currently no description for this signal. Please help us by contributing one!

item_clicked ( int index, Vector2 at_position, int mouse_button_index )

There is currently no description for this signal. Please help us by contributing one!

item_selected ( int index )

There is currently no description for this signal. Please help us by contributing one!

multi_selected ( int index, bool selected )

There is currently no description for this signal. Please help us by contributing one!

Enumerations

enum IconMode:

IconMode ICON_MODE_TOP = 0

There is currently no description for this enum. Please help us by contributing one!

IconMode ICON_MODE_LEFT = 1

There is currently no description for this enum. Please help us by contributing one!

enum SelectMode:

SelectMode SELECT_SINGLE = 0

There is currently no description for this enum. Please help us by contributing one!

SelectMode SELECT_MULTI = 1

There is currently no description for this enum. Please help us by contributing one!

Property Descriptions

bool allow_reselect = false

void set_allow_reselect ( bool value )
bool get_allow_reselect ( )

There is currently no description for this property. Please help us by contributing one!

bool allow_rmb_select = false

void set_allow_rmb_select ( bool value )
bool get_allow_rmb_select ( )

There is currently no description for this property. Please help us by contributing one!

bool allow_search = true

void set_allow_search ( bool value )
bool get_allow_search ( )

There is currently no description for this property. Please help us by contributing one!

bool auto_height = false

void set_auto_height ( bool value )
bool has_auto_height ( )

There is currently no description for this property. Please help us by contributing one!

int fixed_column_width = 0

void set_fixed_column_width ( int value )
int get_fixed_column_width ( )

There is currently no description for this property. Please help us by contributing one!

Vector2i fixed_icon_size = Vector2i(0, 0)

void set_fixed_icon_size ( Vector2i value )
Vector2i get_fixed_icon_size ( )

There is currently no description for this property. Please help us by contributing one!

IconMode icon_mode = 1

void set_icon_mode ( IconMode value )
IconMode get_icon_mode ( )

There is currently no description for this property. Please help us by contributing one!

float icon_scale = 1.0

void set_icon_scale ( float value )
float get_icon_scale ( )

There is currently no description for this property. Please help us by contributing one!

int item_count = 0

void set_item_count ( int value )
int get_item_count ( )

There is currently no description for this property. Please help us by contributing one!

int max_columns = 1

void set_max_columns ( int value )
int get_max_columns ( )

There is currently no description for this property. Please help us by contributing one!

int max_text_lines = 1

void set_max_text_lines ( int value )
int get_max_text_lines ( )

There is currently no description for this property. Please help us by contributing one!

bool same_column_width = false

void set_same_column_width ( bool value )
bool is_same_column_width ( )

There is currently no description for this property. Please help us by contributing one!

SelectMode select_mode = 0

void set_select_mode ( SelectMode value )
SelectMode get_select_mode ( )

There is currently no description for this property. Please help us by contributing one!

OverrunBehavior text_overrun_behavior = 3

void set_text_overrun_behavior ( OverrunBehavior value )
OverrunBehavior get_text_overrun_behavior ( )

There is currently no description for this property. Please help us by contributing one!