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.
Propiedades¶
|
||
|
||
|
||
|
||
|
||
focus_mode |
|
|
|
||
|
||
|
||
|
||
rect_clip_content |
|
|
|
||
|
Métodos¶
Propiedades del Theme¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Señales¶
item_activated ( int index )
Triggered when specified list item is activated via double-clicking or by pressing Enter.
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.
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 |
|
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 |
|
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.
bool auto_height
Default |
|
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 |
|
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.
Vector2 fixed_icon_size
Default |
|
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.
IconMode icon_mode
Default |
|
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.
float icon_scale
Default |
|
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 |
|
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 |
|
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 |
|
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.
SelectMode select_mode
Default |
|
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¶
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.
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.
Devuelve el color de fondo personalizado del elemento especificado por el índice idx.
Devuelve el color de primer plano personalizado del artículo especificado por el índice idx.
Devuelve el icono asociado al índice especificado.
Devuelve un Color del icono de un elemento modulador en el índice especificado.
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.
PoolIntArray get_selected_items ( )
Devuelve un array con los índices de los elementos seleccionados.
VScrollBar get_v_scroll ( )
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.
Devuelve true si el elemento del índice especificado está desactivado.
Devuelve true si el icono del elemento se dibujará transpuesto, es decir, los ejes X e Y se intercambian.
Devuelve true si el elemento en el índice especificado es seleccionable.
Devuelve true si la sugerencia está habilitada para el índice del artículo especificado.
Devuelve true si el elemento del índice especificado está actualmente seleccionado.
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.
Seleccione el elemento en el índice especificado.
Nota: Este método no dispara la señal de selección del elemento.
Sets the background color of the item specified by idx index to the specified Color.
Sets the foreground color of the item specified by idx index to the specified Color.
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.
Establece un Color modulador del elemento asociado al índice especificado.
Establece la región del icono del elemento utilizado. El icono completo se utilizará si la región no tiene área.
Establece si el icono del elemento se dibujará transpuesto.
Establece un valor (de cualquier tipo) que se almacenará con el elemento asociado al índice especificado.
Permite o no la selección del elemento asociado al índice especificado.
Establece el texto del elemento asociado con el índice especificado.
Establece la sugerencia para el elemento asociado con el índice especificado.
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¶
Color font_color
Default |
|
Color del texto predeterminado del elemento.
Color font_color_selected
Default |
|
Color del texto utilizado cuando se selecciona el elemento.
Color guide_color
Default |
|
Color de la pauta. La pauta es una línea trazada entre cada fila de elementos.
int hseparation
Default |
|
El espacio horizontal entre los elementos.
int icon_margin
Default |
|
El espacio entre el icono del elemento y el texto.
int line_separation
Default |
|
El espacio vertical entre cada línea de texto.
int vseparation
Default |
|
El espacio vertical entre los artículos.
Font font
Font del texto del elemento.
StyleBox bg
Por defecto, StyleBox para la ItemList, es decir, se utiliza cuando el control no está siendo enfocado.
StyleBox bg_focus
StyleBox que se usa cuando se enfoca la ItemList.
StyleBox cursor
StyleBox usado para el cursor, cuando el ItemList está siendo enfocado.
StyleBox cursor_unfocused
StyleBox usado para el cursor, cuando el ItemList no está siendo enfocado.
StyleBox selected
StyleBox para los elementos seleccionados, utilizado cuando la ItemList no está siendo enfocada.
StyleBox selected_focus
StyleBox para los elementos seleccionados, que se utiliza cuando se enfoca la ItemList.