godotengine/godot-docs-l10n
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs-l10n.git synced 2026-01-04 10:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
3.x
godot-docs-l10n/classes/es/class_itemlist.rst
Rémi Verschelde cf78697eea Add localized class reference as pre-generated RST files 
Currently including `zh_CN` and `es` which both have very high completion
ratios. Others will be added once they reach a significant percentage too.

These RST files will be used by godot-docs in place of its `classes` folder
after we sync with https://github.com/godotengine/godot-docs/pull/5458.

The update workflow is manual for now (example for `zh_CN`):

- Build `godotengine/godot` in the branch we currently track (now `3.x`)
- Run `godot --doctool -l zh_CN`
- Run `cd doc && make rst LANGARG=zh_CN`
- Copy `doc/_build/rst/*` to `classes/zh_CN/` here
- Make sure to have `classes/zh_CN/index.rst` copied from `docs/classes`
2021-12-21 16:07:55 +01:00

924 lines
50 KiB
ReStructuredText
Raw Permalink Blame History

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ItemList.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_ItemList:
ItemList
========
**Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_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 :ref:`ICON_MODE_TOP<class_ItemList_constant_ICON_MODE_TOP>` mode, but column's width is adjusted to fully fit its content by default. You need to set :ref:`fixed_column_width<class_ItemList_property_fixed_column_width>` greater than zero to wrap the text.
Propiedades
----------------------
+---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`allow_reselect<class_ItemList_property_allow_reselect>` | ``false`` |
+---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`allow_rmb_select<class_ItemList_property_allow_rmb_select>` | ``false`` |
+---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`auto_height<class_ItemList_property_auto_height>` | ``false`` |
+---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`fixed_column_width<class_ItemList_property_fixed_column_width>` | ``0`` |
+---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`fixed_icon_size<class_ItemList_property_fixed_icon_size>` | ``Vector2( 0, 0 )`` |
+---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | ``2`` (overrides :ref:`Control<class_Control_property_focus_mode>`) |
+---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`IconMode<enum_ItemList_IconMode>` | :ref:`icon_mode<class_ItemList_property_icon_mode>` | ``1`` |
+---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`icon_scale<class_ItemList_property_icon_scale>` | ``1.0`` |
+---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`max_columns<class_ItemList_property_max_columns>` | ``1`` |
+---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`max_text_lines<class_ItemList_property_max_text_lines>` | ``1`` |
+---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | rect_clip_content | ``true`` (overrides :ref:`Control<class_Control_property_rect_clip_content>`) |
+---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`same_column_width<class_ItemList_property_same_column_width>` | ``false`` |
+---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`SelectMode<enum_ItemList_SelectMode>` | :ref:`select_mode<class_ItemList_property_select_mode>` | ``0`` |
+---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+
Métodos
--------------
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_icon_item<class_ItemList_method_add_icon_item>` **(** :ref:`Texture<class_Texture>` icon, :ref:`bool<class_bool>` selectable=true **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_item<class_ItemList_method_add_item>` **(** :ref:`String<class_String>` text, :ref:`Texture<class_Texture>` icon=null, :ref:`bool<class_bool>` selectable=true **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_ItemList_method_clear>` **(** **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`ensure_current_is_visible<class_ItemList_method_ensure_current_is_visible>` **(** **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_item_at_position<class_ItemList_method_get_item_at_position>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`bool<class_bool>` exact=false **)** |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_item_count<class_ItemList_method_get_item_count>` **(** **)** |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`get_item_custom_bg_color<class_ItemList_method_get_item_custom_bg_color>` **(** :ref:`int<class_int>` idx **)** |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`get_item_custom_fg_color<class_ItemList_method_get_item_custom_fg_color>` **(** :ref:`int<class_int>` idx **)** |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`get_item_icon<class_ItemList_method_get_item_icon>` **(** :ref:`int<class_int>` idx **)** |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`get_item_icon_modulate<class_ItemList_method_get_item_icon_modulate>` **(** :ref:`int<class_int>` idx **)** |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`get_item_icon_region<class_ItemList_method_get_item_icon_region>` **(** :ref:`int<class_int>` idx **)** |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`get_item_metadata<class_ItemList_method_get_item_metadata>` **(** :ref:`int<class_int>` idx **)** |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_item_text<class_ItemList_method_get_item_text>` **(** :ref:`int<class_int>` idx **)** |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_item_tooltip<class_ItemList_method_get_item_tooltip>` **(** :ref:`int<class_int>` idx **)** |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`get_selected_items<class_ItemList_method_get_selected_items>` **(** **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`VScrollBar<class_VScrollBar>` | :ref:`get_v_scroll<class_ItemList_method_get_v_scroll>` **(** **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_anything_selected<class_ItemList_method_is_anything_selected>` **(** **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_disabled<class_ItemList_method_is_item_disabled>` **(** :ref:`int<class_int>` idx **)** |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_icon_transposed<class_ItemList_method_is_item_icon_transposed>` **(** :ref:`int<class_int>` idx **)** |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_selectable<class_ItemList_method_is_item_selectable>` **(** :ref:`int<class_int>` idx **)** |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_tooltip_enabled<class_ItemList_method_is_item_tooltip_enabled>` **(** :ref:`int<class_int>` idx **)** |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_selected<class_ItemList_method_is_selected>` **(** :ref:`int<class_int>` idx **)** |const| |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`move_item<class_ItemList_method_move_item>` **(** :ref:`int<class_int>` from_idx, :ref:`int<class_int>` to_idx **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_item<class_ItemList_method_remove_item>` **(** :ref:`int<class_int>` idx **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`select<class_ItemList_method_select>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` single=true **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_custom_bg_color<class_ItemList_method_set_item_custom_bg_color>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` custom_bg_color **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_custom_fg_color<class_ItemList_method_set_item_custom_fg_color>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` custom_fg_color **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_disabled<class_ItemList_method_set_item_disabled>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_icon<class_ItemList_method_set_item_icon>` **(** :ref:`int<class_int>` idx, :ref:`Texture<class_Texture>` icon **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_icon_modulate<class_ItemList_method_set_item_icon_modulate>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` modulate **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_icon_region<class_ItemList_method_set_item_icon_region>` **(** :ref:`int<class_int>` idx, :ref:`Rect2<class_Rect2>` rect **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_icon_transposed<class_ItemList_method_set_item_icon_transposed>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` transposed **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_metadata<class_ItemList_method_set_item_metadata>` **(** :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` metadata **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_selectable<class_ItemList_method_set_item_selectable>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` selectable **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_text<class_ItemList_method_set_item_text>` **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` text **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_tooltip<class_ItemList_method_set_item_tooltip>` **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` tooltip **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_tooltip_enabled<class_ItemList_method_set_item_tooltip_enabled>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sort_items_by_text<class_ItemList_method_sort_items_by_text>` **(** **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unselect<class_ItemList_method_unselect>` **(** :ref:`int<class_int>` idx **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unselect_all<class_ItemList_method_unselect_all>` **(** **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Propiedades del Theme
------------------------------------------
+---------------------------------+----------------------------------------------------------------------------+----------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color<class_ItemList_theme_color_font_color>` | ``Color( 0.63, 0.63, 0.63, 1 )`` |
+---------------------------------+----------------------------------------------------------------------------+----------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color_selected<class_ItemList_theme_color_font_color_selected>` | ``Color( 1, 1, 1, 1 )`` |
+---------------------------------+----------------------------------------------------------------------------+----------------------------------+
| :ref:`Color<class_Color>` | :ref:`guide_color<class_ItemList_theme_color_guide_color>` | ``Color( 0, 0, 0, 0.1 )`` |
+---------------------------------+----------------------------------------------------------------------------+----------------------------------+
| :ref:`int<class_int>` | :ref:`hseparation<class_ItemList_theme_constant_hseparation>` | ``4`` |
+---------------------------------+----------------------------------------------------------------------------+----------------------------------+
| :ref:`int<class_int>` | :ref:`icon_margin<class_ItemList_theme_constant_icon_margin>` | ``4`` |
+---------------------------------+----------------------------------------------------------------------------+----------------------------------+
| :ref:`int<class_int>` | :ref:`line_separation<class_ItemList_theme_constant_line_separation>` | ``2`` |
+---------------------------------+----------------------------------------------------------------------------+----------------------------------+
| :ref:`int<class_int>` | :ref:`vseparation<class_ItemList_theme_constant_vseparation>` | ``2`` |
+---------------------------------+----------------------------------------------------------------------------+----------------------------------+
| :ref:`Font<class_Font>` | :ref:`font<class_ItemList_theme_font_font>` | |
+---------------------------------+----------------------------------------------------------------------------+----------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`bg<class_ItemList_theme_style_bg>` | |
+---------------------------------+----------------------------------------------------------------------------+----------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`bg_focus<class_ItemList_theme_style_bg_focus>` | |
+---------------------------------+----------------------------------------------------------------------------+----------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`cursor<class_ItemList_theme_style_cursor>` | |
+---------------------------------+----------------------------------------------------------------------------+----------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`cursor_unfocused<class_ItemList_theme_style_cursor_unfocused>` | |
+---------------------------------+----------------------------------------------------------------------------+----------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`selected<class_ItemList_theme_style_selected>` | |
+---------------------------------+----------------------------------------------------------------------------+----------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`selected_focus<class_ItemList_theme_style_selected_focus>` | |
+---------------------------------+----------------------------------------------------------------------------+----------------------------------+
Señales
--------------
.. _class_ItemList_signal_item_activated:
- **item_activated** **(** :ref:`int<class_int>` index **)**
Triggered when specified list item is activated via double-clicking or by pressing Enter.
----
.. _class_ItemList_signal_item_rmb_selected:
- **item_rmb_selected** **(** :ref:`int<class_int>` index, :ref:`Vector2<class_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 :ref:`allow_rmb_select<class_ItemList_property_allow_rmb_select>` debe estar activada.
----
.. _class_ItemList_signal_item_selected:
- **item_selected** **(** :ref:`int<class_int>` index **)**
Se activa cuando se selecciona un elemento específico.
Para poder volver a seleccionar un elemento, se debe activar la opción :ref:`allow_reselect<class_ItemList_property_allow_reselect>`.
----
.. _class_ItemList_signal_multi_selected:
- **multi_selected** **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` selected **)**
Se activa cuando se altera una selección múltiple en una lista que permite la selección múltiple.
----
.. _class_ItemList_signal_nothing_selected:
- **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.
----
.. _class_ItemList_signal_rmb_clicked:
- **rmb_clicked** **(** :ref:`Vector2<class_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.
\ :ref:`allow_rmb_select<class_ItemList_property_allow_rmb_select>` debe estar activado.
Enumeraciones
--------------------------
.. _enum_ItemList_IconMode:
.. _class_ItemList_constant_ICON_MODE_TOP:
.. _class_ItemList_constant_ICON_MODE_LEFT:
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_ItemList_SelectMode:
.. _class_ItemList_constant_SELECT_SINGLE:
.. _class_ItemList_constant_SELECT_MULTI:
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
--------------------------------------------------------
.. _class_ItemList_property_allow_reselect:
- :ref:`bool<class_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.
----
.. _class_ItemList_property_allow_rmb_select:
- :ref:`bool<class_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.
----
.. _class_ItemList_property_auto_height:
- :ref:`bool<class_bool>` **auto_height**
+-----------+------------------------+
| *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.
----
.. _class_ItemList_property_fixed_column_width:
- :ref:`int<class_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.
----
.. _class_ItemList_property_fixed_icon_size:
- :ref:`Vector2<class_Vector2>` **fixed_icon_size**
+-----------+----------------------------+
| *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.
----
.. _class_ItemList_property_icon_mode:
- :ref:`IconMode<enum_ItemList_IconMode>` **icon_mode**
+-----------+----------------------+
| *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 :ref:`IconMode<enum_ItemList_IconMode>`.
----
.. _class_ItemList_property_icon_scale:
- :ref:`float<class_float>` **icon_scale**
+-----------+-----------------------+
| *Default* | ``1.0`` |
+-----------+-----------------------+
| *Setter* | set_icon_scale(value) |
+-----------+-----------------------+
| *Getter* | get_icon_scale() |
+-----------+-----------------------+
La escala de icono aplicada después de :ref:`fixed_icon_size<class_ItemList_property_fixed_icon_size>` y la transposición tiene efecto.
----
.. _class_ItemList_property_max_columns:
- :ref:`int<class_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.
----
.. _class_ItemList_property_max_text_lines:
- :ref:`int<class_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 :ref:`icon_mode<class_ItemList_property_icon_mode>` es :ref:`ICON_MODE_TOP<class_ItemList_constant_ICON_MODE_TOP>`. Para hacer la envoltura de texto, :ref:`fixed_column_width<class_ItemList_property_fixed_column_width>` debe ser mayor que cero.
----
.. _class_ItemList_property_same_column_width:
- :ref:`bool<class_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.
----
.. _class_ItemList_property_select_mode:
- :ref:`SelectMode<enum_ItemList_SelectMode>` **select_mode**
+-----------+------------------------+
| *Default* | ``0`` |
+-----------+------------------------+
| *Setter* | set_select_mode(value) |
+-----------+------------------------+
| *Getter* | get_select_mode() |
+-----------+------------------------+
Permite la selección de uno o varios elementos. Vea las constantes :ref:`SelectMode<enum_ItemList_SelectMode>`.
Descripciones de Métodos
------------------------------------------------
.. _class_ItemList_method_add_icon_item:
- void **add_icon_item** **(** :ref:`Texture<class_Texture>` icon, :ref:`bool<class_bool>` selectable=true **)**
Añade un elemento a la lista de elementos sin texto, sólo un icono.
----
.. _class_ItemList_method_add_item:
- void **add_item** **(** :ref:`String<class_String>` text, :ref:`Texture<class_Texture>` icon=null, :ref:`bool<class_bool>` selectable=true **)**
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.
----
.. _class_ItemList_method_clear:
- void **clear** **(** **)**
Elimina todos los elementos de la lista.
----
.. _class_ItemList_method_ensure_current_is_visible:
- 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.
----
.. _class_ItemList_method_get_item_at_position:
- :ref:`int<class_int>` **get_item_at_position** **(** :ref:`Vector2<class_Vector2>` position, :ref:`bool<class_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.
----
.. _class_ItemList_method_get_item_count:
- :ref:`int<class_int>` **get_item_count** **(** **)** |const|
Devuelve el número de elementos actualmente en la lista.
----
.. _class_ItemList_method_get_item_custom_bg_color:
- :ref:`Color<class_Color>` **get_item_custom_bg_color** **(** :ref:`int<class_int>` idx **)** |const|
Devuelve el color de fondo personalizado del elemento especificado por el índice ``idx``.
----
.. _class_ItemList_method_get_item_custom_fg_color:
- :ref:`Color<class_Color>` **get_item_custom_fg_color** **(** :ref:`int<class_int>` idx **)** |const|
Devuelve el color de primer plano personalizado del artículo especificado por el índice ``idx``.
----
.. _class_ItemList_method_get_item_icon:
- :ref:`Texture<class_Texture>` **get_item_icon** **(** :ref:`int<class_int>` idx **)** |const|
Devuelve el icono asociado al índice especificado.
----
.. _class_ItemList_method_get_item_icon_modulate:
- :ref:`Color<class_Color>` **get_item_icon_modulate** **(** :ref:`int<class_int>` idx **)** |const|
Devuelve un :ref:`Color<class_Color>` del icono de un elemento modulador en el índice especificado.
----
.. _class_ItemList_method_get_item_icon_region:
- :ref:`Rect2<class_Rect2>` **get_item_icon_region** **(** :ref:`int<class_int>` idx **)** |const|
Devuelve la región del icono del elemento utilizado. El icono completo será utilizado si la región no tiene área.
----
.. _class_ItemList_method_get_item_metadata:
- :ref:`Variant<class_Variant>` **get_item_metadata** **(** :ref:`int<class_int>` idx **)** |const|
Devuelve el valor de los metadatos del índice especificado.
----
.. _class_ItemList_method_get_item_text:
- :ref:`String<class_String>` **get_item_text** **(** :ref:`int<class_int>` idx **)** |const|
Devuelve el texto asociado al índice especificado.
----
.. _class_ItemList_method_get_item_tooltip:
- :ref:`String<class_String>` **get_item_tooltip** **(** :ref:`int<class_int>` idx **)** |const|
Devuelve la sugerencia de la herramienta asociada con el índice especificado.
----
.. _class_ItemList_method_get_selected_items:
- :ref:`PoolIntArray<class_PoolIntArray>` **get_selected_items** **(** **)**
Devuelve un array con los índices de los elementos seleccionados.
----
.. _class_ItemList_method_get_v_scroll:
- :ref:`VScrollBar<class_VScrollBar>` **get_v_scroll** **(** **)**
Returns the :ref:`Object<class_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 :ref:`CanvasItem.visible<class_CanvasItem_property_visible>` property.
----
.. _class_ItemList_method_is_anything_selected:
- :ref:`bool<class_bool>` **is_anything_selected** **(** **)**
Devuelve ``true`` si se seleccionan uno o más elementos.
----
.. _class_ItemList_method_is_item_disabled:
- :ref:`bool<class_bool>` **is_item_disabled** **(** :ref:`int<class_int>` idx **)** |const|
Devuelve ``true`` si el elemento del índice especificado está desactivado.
----
.. _class_ItemList_method_is_item_icon_transposed:
- :ref:`bool<class_bool>` **is_item_icon_transposed** **(** :ref:`int<class_int>` idx **)** |const|
Devuelve ``true`` si el icono del elemento se dibujará transpuesto, es decir, los ejes X e Y se intercambian.
----
.. _class_ItemList_method_is_item_selectable:
- :ref:`bool<class_bool>` **is_item_selectable** **(** :ref:`int<class_int>` idx **)** |const|
Devuelve ``true`` si el elemento en el índice especificado es seleccionable.
----
.. _class_ItemList_method_is_item_tooltip_enabled:
- :ref:`bool<class_bool>` **is_item_tooltip_enabled** **(** :ref:`int<class_int>` idx **)** |const|
Devuelve ``true`` si la sugerencia está habilitada para el índice del artículo especificado.
----
.. _class_ItemList_method_is_selected:
- :ref:`bool<class_bool>` **is_selected** **(** :ref:`int<class_int>` idx **)** |const|
Devuelve ``true`` si el elemento del índice especificado está actualmente seleccionado.
----
.. _class_ItemList_method_move_item:
- void **move_item** **(** :ref:`int<class_int>` from_idx, :ref:`int<class_int>` to_idx **)**
Mueve el elemento del índice ``from_idx`` a ``to_idx``.
----
.. _class_ItemList_method_remove_item:
- void **remove_item** **(** :ref:`int<class_int>` idx **)**
Elimina de la lista el elemento especificado por el índice ``idx``.
----
.. _class_ItemList_method_select:
- void **select** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` single=true **)**
Seleccione el elemento en el índice especificado.
\ **Nota:** Este método no dispara la señal de selección del elemento.
----
.. _class_ItemList_method_set_item_custom_bg_color:
- void **set_item_custom_bg_color** **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` custom_bg_color **)**
Sets the background color of the item specified by ``idx`` index to the specified :ref:`Color<class_Color>`.
----
.. _class_ItemList_method_set_item_custom_fg_color:
- void **set_item_custom_fg_color** **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` custom_fg_color **)**
Sets the foreground color of the item specified by ``idx`` index to the specified :ref:`Color<class_Color>`.
----
.. _class_ItemList_method_set_item_disabled:
- void **set_item_disabled** **(** :ref:`int<class_int>` idx, :ref:`bool<class_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).
----
.. _class_ItemList_method_set_item_icon:
- void **set_item_icon** **(** :ref:`int<class_int>` idx, :ref:`Texture<class_Texture>` icon **)**
Sets (or replaces) the icon's :ref:`Texture<class_Texture>` associated with the specified index.
----
.. _class_ItemList_method_set_item_icon_modulate:
- void **set_item_icon_modulate** **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` modulate **)**
Establece un :ref:`Color<class_Color>` modulador del elemento asociado al índice especificado.
----
.. _class_ItemList_method_set_item_icon_region:
- void **set_item_icon_region** **(** :ref:`int<class_int>` idx, :ref:`Rect2<class_Rect2>` rect **)**
Establece la región del icono del elemento utilizado. El icono completo se utilizará si la región no tiene área.
----
.. _class_ItemList_method_set_item_icon_transposed:
- void **set_item_icon_transposed** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` transposed **)**
Establece si el icono del elemento se dibujará transpuesto.
----
.. _class_ItemList_method_set_item_metadata:
- void **set_item_metadata** **(** :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` metadata **)**
Establece un valor (de cualquier tipo) que se almacenará con el elemento asociado al índice especificado.
----
.. _class_ItemList_method_set_item_selectable:
- void **set_item_selectable** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` selectable **)**
Permite o no la selección del elemento asociado al índice especificado.
----
.. _class_ItemList_method_set_item_text:
- void **set_item_text** **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` text **)**
Establece el texto del elemento asociado con el índice especificado.
----
.. _class_ItemList_method_set_item_tooltip:
- void **set_item_tooltip** **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` tooltip **)**
Establece la sugerencia para el elemento asociado con el índice especificado.
----
.. _class_ItemList_method_set_item_tooltip_enabled:
- void **set_item_tooltip_enabled** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)**
Establece si la sugerencia está habilitada para el índice de elementos especificados.
----
.. _class_ItemList_method_sort_items_by_text:
- void **sort_items_by_text** **(** **)**
Ordena los elementos de la lista por su texto.
----
.. _class_ItemList_method_unselect:
- void **unselect** **(** :ref:`int<class_int>` idx **)**
Asegura que no se seleccione el elemento asociado al índice especificado.
----
.. _class_ItemList_method_unselect_all:
- void **unselect_all** **(** **)**
Se asegura de que no haya elementos seleccionados.
Theme Property Descriptions
---------------------------
.. _class_ItemList_theme_color_font_color:
- :ref:`Color<class_Color>` **font_color**
+-----------+----------------------------------+
| *Default* | ``Color( 0.63, 0.63, 0.63, 1 )`` |
+-----------+----------------------------------+
:ref:`Color<class_Color>` del texto predeterminado del elemento.
----
.. _class_ItemList_theme_color_font_color_selected:
- :ref:`Color<class_Color>` **font_color_selected**
+-----------+-------------------------+
| *Default* | ``Color( 1, 1, 1, 1 )`` |
+-----------+-------------------------+
:ref:`Color<class_Color>` del texto utilizado cuando se selecciona el elemento.
----
.. _class_ItemList_theme_color_guide_color:
- :ref:`Color<class_Color>` **guide_color**
+-----------+---------------------------+
| *Default* | ``Color( 0, 0, 0, 0.1 )`` |
+-----------+---------------------------+
:ref:`Color<class_Color>` de la pauta. La pauta es una línea trazada entre cada fila de elementos.
----
.. _class_ItemList_theme_constant_hseparation:
- :ref:`int<class_int>` **hseparation**
+-----------+-------+
| *Default* | ``4`` |
+-----------+-------+
El espacio horizontal entre los elementos.
----
.. _class_ItemList_theme_constant_icon_margin:
- :ref:`int<class_int>` **icon_margin**
+-----------+-------+
| *Default* | ``4`` |
+-----------+-------+
El espacio entre el icono del elemento y el texto.
----
.. _class_ItemList_theme_constant_line_separation:
- :ref:`int<class_int>` **line_separation**
+-----------+-------+
| *Default* | ``2`` |
+-----------+-------+
El espacio vertical entre cada línea de texto.
----
.. _class_ItemList_theme_constant_vseparation:
- :ref:`int<class_int>` **vseparation**
+-----------+-------+
| *Default* | ``2`` |
+-----------+-------+
El espacio vertical entre los artículos.
----
.. _class_ItemList_theme_font_font:
- :ref:`Font<class_Font>` **font**
:ref:`Font<class_Font>` del texto del elemento.
----
.. _class_ItemList_theme_style_bg:
- :ref:`StyleBox<class_StyleBox>` **bg**
Por defecto, :ref:`StyleBox<class_StyleBox>` para la ``ItemList``, es decir, se utiliza cuando el control no está siendo enfocado.
----
.. _class_ItemList_theme_style_bg_focus:
- :ref:`StyleBox<class_StyleBox>` **bg_focus**
:ref:`StyleBox<class_StyleBox>` que se usa cuando se enfoca la ``ItemList``.
----
.. _class_ItemList_theme_style_cursor:
- :ref:`StyleBox<class_StyleBox>` **cursor**
:ref:`StyleBox<class_StyleBox>` usado para el cursor, cuando el ``ItemList`` está siendo enfocado.
----
.. _class_ItemList_theme_style_cursor_unfocused:
- :ref:`StyleBox<class_StyleBox>` **cursor_unfocused**
:ref:`StyleBox<class_StyleBox>` usado para el cursor, cuando el ``ItemList`` no está siendo enfocado.
----
.. _class_ItemList_theme_style_selected:
- :ref:`StyleBox<class_StyleBox>` **selected**
:ref:`StyleBox<class_StyleBox>` para los elementos seleccionados, utilizado cuando la ``ItemList`` no está siendo enfocada.
----
.. _class_ItemList_theme_style_selected_focus:
- :ref:`StyleBox<class_StyleBox>` **selected_focus**
:ref:`StyleBox<class_StyleBox>` para los elementos seleccionados, que se utiliza cuando se enfoca la ``ItemList``.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
Reference in New Issue View Git Blame Copy Permalink