ItemList

Inherits: Control < CanvasItem < Node < Object

Control que proporciona una lista de elementos (y/o iconos) seleccionables en una sola columna, u opcionalmente en varias columnas.

Descripción

This control provides a selectable list of items that may be in a single (or multiple columns) with option of text, icons, or both text and icon. Tooltips are supported and may be different for every item in the list.

Selectable items in the list may be selected or deselected and multiple selection may be enabled. Selection with right mouse button may also be enabled to allow use of popup context menus. Items may also be "activated" by double-clicking them or by pressing Enter.

Item text only supports single-line strings, newline characters (e.g. \n) in the string won't produce a newline. Text wrapping is enabled in ICON_MODE_TOP mode, but column's width is adjusted to fully fit its content by default. You need to set fixed_column_width greater than zero to wrap the text.

Métodos

void

add_icon_item ( Texture icon, bool selectable=true )

void

add_item ( String text, Texture icon=null, bool selectable=true )

void

clear ( )

void

ensure_current_is_visible ( )

int

get_item_at_position ( Vector2 position, bool exact=false ) const

int

get_item_count ( ) const

Color

get_item_custom_bg_color ( int idx ) const

Color

get_item_custom_fg_color ( int idx ) const

Texture

get_item_icon ( int idx ) const

Color

get_item_icon_modulate ( int idx ) const

Rect2

get_item_icon_region ( int idx ) const

Variant

get_item_metadata ( int idx ) const

String

get_item_text ( int idx ) const

String

get_item_tooltip ( int idx ) const

PoolIntArray

get_selected_items ( )

VScrollBar

get_v_scroll ( )

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, Texture 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_metadata ( int idx, Variant metadata )

void

set_item_selectable ( int idx, bool selectable )

void

set_item_text ( int idx, String text )

void

set_item_tooltip ( int idx, String tooltip )

void

set_item_tooltip_enabled ( int idx, bool enable )

void

sort_items_by_text ( )

void

unselect ( int idx )

void

unselect_all ( )

Señales

  • item_activated ( int index )

Triggered when specified list item is activated via double-clicking or by pressing Enter.


  • item_rmb_selected ( int index, Vector2 at_position )

Se activa cuando se ha seleccionado un elemento de la lista especificado mediante un clic del botón derecho del ratón.

La posición del clic también se proporciona para permitir la aparición de menús contextuales apropiados en la ubicación correcta.

La opción allow_rmb_select debe estar activada.


  • item_selected ( int index )

Se activa cuando se selecciona un elemento específico.

Para poder volver a seleccionar un elemento, se debe activar la opción allow_reselect.


  • multi_selected ( int index, bool selected )

Se activa cuando se altera una selección múltiple en una lista que permite la selección múltiple.


  • nothing_selected ( )

Se activa cuando se hace un clic con el botón izquierdo del ratón dentro del rectángulo de la lista pero en el espacio vacío.


  • rmb_clicked ( Vector2 at_position )

Se activa cuando se hace un clic con el botón derecho del ratón dentro del rectángulo de la lista pero en el espacio vacío.

allow_rmb_select debe estar activado.

Enumeraciones

enum IconMode:

  • ICON_MODE_TOP = 0 --- El icono se dibuja sobre el texto.

  • ICON_MODE_LEFT = 1 --- El icono se dibuja a la izquierda del texto.


enum SelectMode:

  • SELECT_SINGLE = 0 --- Sólo permite seleccionar un único elemento.

  • SELECT_MULTI = 1 --- Allows selecting multiple items by holding Ctrl or Shift.

Descripciones de Propiedades

  • bool allow_reselect

Default

false

Setter

set_allow_reselect(value)

Getter

get_allow_reselect()

Si true, el elemento actualmente seleccionado puede ser seleccionado de nuevo.


  • bool allow_rmb_select

Default

false

Setter

set_allow_rmb_select(value)

Getter

get_allow_rmb_select()

Si true, al hacer clic con el botón derecho del ratón se pueden seleccionar elementos.


Default

false

Setter

set_auto_height(value)

Getter

has_auto_height()

Si true, el control redimensionará automáticamente la altura para que se ajuste a su contenido.


  • int fixed_column_width

Default

0

Setter

set_fixed_column_width(value)

Getter

get_fixed_column_width()

El ancho de todas las columnas se ajustará.

Un valor de cero desactiva el ajuste, cada elemento tendrá una anchura igual a la de su contenido y las columnas tendrán una anchura desigual.


Default

Vector2( 0, 0 )

Setter

set_fixed_icon_size(value)

Getter

get_fixed_icon_size()

El tamaño de todos los iconos se ajustará.

Si el componente X o Y no es mayor que cero, el tamaño del icono no se verá afectado.


Default

1

Setter

set_icon_mode(value)

Getter

get_icon_mode()

La posición del icono, ya sea arriba o a la izquierda del texto. Vea las constantes IconMode.


Default

1.0

Setter

set_icon_scale(value)

Getter

get_icon_scale()

La escala de icono aplicada después de fixed_icon_size y la transposición tiene efecto.


  • int max_columns

Default

1

Setter

set_max_columns(value)

Getter

get_max_columns()

Columnas máximas que tendrá la lista.

Si es mayor que cero, el contenido se dividirá entre las columnas especificadas.

Un valor de cero significa que las columnas son ilimitadas, es decir, que todos los artículos se pondrán en la misma fila.


  • int max_text_lines

Default

1

Setter

set_max_text_lines(value)

Getter

get_max_text_lines()

Líneas de texto máximas permitidas en cada elemento. Se reservará espacio incluso cuando no haya suficientes líneas de texto para mostrar.

Nota: Esta propiedad sólo tiene efecto cuando icon_mode es ICON_MODE_TOP. Para hacer la envoltura de texto, fixed_column_width debe ser mayor que cero.


  • bool same_column_width

Default

false

Setter

set_same_column_width(value)

Getter

is_same_column_width()

Si todas las columnas tendrán el mismo ancho.

Si true, el ancho es igual al mayor ancho de todas las columnas.


Default

0

Setter

set_select_mode(value)

Getter

get_select_mode()

Permite la selección de uno o varios elementos. Vea las constantes SelectMode.

Descripciones de Métodos

  • void add_icon_item ( Texture icon, bool selectable=true )

Añade un elemento a la lista de elementos sin texto, sólo un icono.


Añade un elemento a la lista de elementos con un texto especificado. Especifique un icon, o utilice null como el icon para un elemento de la lista sin icono.

Si el elemento de la lista que se puede seleccionar es true, el elemento de la lista será seleccionable.


  • void clear ( )

Elimina todos los elementos de la lista.


  • void ensure_current_is_visible ( )

Asegúrese de que la selección actual sea visible, ajustando la posición del scroll según sea necesario.


  • int get_item_at_position ( Vector2 position, bool exact=false ) const

Devuelve el índice del artículo en la position dada.

Cuando no hay ningún elemento en ese punto, se devolverá -1 si exact es true, y de lo contrario se devolverá el índice de elemento más cercano.


  • int get_item_count ( ) const

Devuelve el número de elementos actualmente en la lista.


  • Color get_item_custom_bg_color ( int idx ) const

Devuelve el color de fondo personalizado del elemento especificado por el índice idx.


  • Color get_item_custom_fg_color ( int idx ) const

Devuelve el color de primer plano personalizado del artículo especificado por el índice idx.


Devuelve el icono asociado al índice especificado.


  • Color get_item_icon_modulate ( int idx ) const

Devuelve un Color del icono de un elemento modulador en el índice especificado.


  • Rect2 get_item_icon_region ( int idx ) const

Devuelve la región del icono del elemento utilizado. El icono completo será utilizado si la región no tiene área.


Devuelve el valor de los metadatos del índice especificado.


Devuelve el texto asociado al índice especificado.


Devuelve la sugerencia de la herramienta asociada con el índice especificado.


Devuelve un array con los índices de los elementos seleccionados.


Returns the Object ID associated with the list.

Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their CanvasItem.visible property.


  • bool is_anything_selected ( )

Devuelve true si se seleccionan uno o más elementos.


  • bool is_item_disabled ( int idx ) const

Devuelve true si el elemento del índice especificado está desactivado.


  • bool is_item_icon_transposed ( int idx ) const

Devuelve true si el icono del elemento se dibujará transpuesto, es decir, los ejes X e Y se intercambian.


  • bool is_item_selectable ( int idx ) const

Devuelve true si el elemento en el índice especificado es seleccionable.


  • bool is_item_tooltip_enabled ( int idx ) const

Devuelve true si la sugerencia está habilitada para el índice del artículo especificado.


  • bool is_selected ( int idx ) const

Devuelve true si el elemento del índice especificado está actualmente seleccionado.


  • void move_item ( int from_idx, int to_idx )

Mueve el elemento del índice from_idx a to_idx.


  • void remove_item ( int idx )

Elimina de la lista el elemento especificado por el índice idx.


  • void select ( int idx, bool single=true )

Seleccione el elemento en el índice especificado.

Nota: Este método no dispara la señal de selección del elemento.


  • void set_item_custom_bg_color ( int idx, Color custom_bg_color )

Sets the background color of the item specified by idx index to the specified Color.


  • void set_item_custom_fg_color ( int idx, Color custom_fg_color )

Sets the foreground color of the item specified by idx index to the specified Color.


  • void set_item_disabled ( int idx, bool disabled )

Disables (or enables) the item at the specified index.

Disabled items cannot be selected and do not trigger activation signals (when double-clicking or pressing Enter).


Sets (or replaces) the icon's Texture associated with the specified index.


  • void set_item_icon_modulate ( int idx, Color modulate )

Establece un Color modulador del elemento asociado al índice especificado.


  • void set_item_icon_region ( int idx, Rect2 rect )

Establece la región del icono del elemento utilizado. El icono completo se utilizará si la región no tiene área.


  • void set_item_icon_transposed ( int idx, bool transposed )

Establece si el icono del elemento se dibujará transpuesto.


  • void set_item_metadata ( int idx, Variant metadata )

Establece un valor (de cualquier tipo) que se almacenará con el elemento asociado al índice especificado.


  • void set_item_selectable ( int idx, bool selectable )

Permite o no la selección del elemento asociado al índice especificado.


  • void set_item_text ( int idx, String text )

Establece el texto del elemento asociado con el índice especificado.


  • void set_item_tooltip ( int idx, String tooltip )

Establece la sugerencia para el elemento asociado con el índice especificado.


  • void set_item_tooltip_enabled ( int idx, bool enable )

Establece si la sugerencia está habilitada para el índice de elementos especificados.


  • void sort_items_by_text ( )

Ordena los elementos de la lista por su texto.


  • void unselect ( int idx )

Asegura que no se seleccione el elemento asociado al índice especificado.


  • void unselect_all ( )

Se asegura de que no haya elementos seleccionados.

Theme Property Descriptions

Default

Color( 0.63, 0.63, 0.63, 1 )

Color del texto predeterminado del elemento.


  • Color font_color_selected

Default

Color( 1, 1, 1, 1 )

Color del texto utilizado cuando se selecciona el elemento.


Default

Color( 0, 0, 0, 0.1 )

Color de la pauta. La pauta es una línea trazada entre cada fila de elementos.


  • int hseparation

Default

4

El espacio horizontal entre los elementos.


  • int icon_margin

Default

4

El espacio entre el icono del elemento y el texto.


  • int line_separation

Default

2

El espacio vertical entre cada línea de texto.


  • int vseparation

Default

2

El espacio vertical entre los artículos.


Font del texto del elemento.


Por defecto, StyleBox para la ItemList, es decir, se utiliza cuando el control no está siendo enfocado.


StyleBox que se usa cuando se enfoca la ItemList.


StyleBox usado para el cursor, cuando el ItemList está siendo enfocado.


StyleBox usado para el cursor, cuando el ItemList no está siendo enfocado.


StyleBox para los elementos seleccionados, utilizado cuando la ItemList no está siendo enfocada.


StyleBox para los elementos seleccionados, que se utiliza cuando se enfoca la ItemList.