mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2025-12-31 09:49:22 +03:00
1635 lines
85 KiB
ReStructuredText
1635 lines
85 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. _class_ItemList:
|
|
|
|
ItemList
|
|
========
|
|
|
|
**Hereda:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
Una lista vertical de elementos seleccionables con una o varias columnas.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Descripción
|
|
----------------------
|
|
|
|
This control provides a vertical list of selectable items that may be in a single or in multiple columns, with each item having options for text and an 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 :kbd:`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 the 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.
|
|
|
|
All ``set_*`` methods allow negative item indices, i.e. ``-1`` to access the last item, ``-2`` to select the second-to-last item, and so on.
|
|
|
|
\ **Incremental search:** Like :ref:`PopupMenu<class_PopupMenu>` and :ref:`Tree<class_Tree>`, **ItemList** supports searching within the list while the control is focused. Press a key that matches the first letter of an item's name to select the first item starting with the given letter. After that point, there are two ways to perform incremental search: 1) Press the same key again before the timeout duration to select the next item starting with the same letter. 2) Press letter keys that match the rest of the word before the timeout duration to match to select the item in question directly. Both of these actions will be reset to the beginning of the list if the timeout duration has passed since the last keystroke was registered. You can adjust the timeout duration by changing :ref:`ProjectSettings.gui/timers/incremental_search_max_interval_msec<class_ProjectSettings_property_gui/timers/incremental_search_max_interval_msec>`.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Propiedades
|
|
----------------------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+
|
|
| :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:`allow_search<class_ItemList_property_allow_search>` | ``true`` |
|
|
+---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`auto_height<class_ItemList_property_auto_height>` | ``false`` |
|
|
+---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`auto_width<class_ItemList_property_auto_width>` | ``false`` |
|
|
+---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | clip_contents | ``true`` (overrides :ref:`Control<class_Control_property_clip_contents>`) |
|
|
+---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`fixed_column_width<class_ItemList_property_fixed_column_width>` | ``0`` |
|
|
+---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+
|
|
| :ref:`Vector2i<class_Vector2i>` | :ref:`fixed_icon_size<class_ItemList_property_fixed_icon_size>` | ``Vector2i(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:`item_count<class_ItemList_property_item_count>` | ``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>` | :ref:`same_column_width<class_ItemList_property_same_column_width>` | ``false`` |
|
|
+---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+
|
|
| :ref:`ScrollHintMode<enum_ItemList_ScrollHintMode>` | :ref:`scroll_hint_mode<class_ItemList_property_scroll_hint_mode>` | ``0`` |
|
|
+---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+
|
|
| :ref:`SelectMode<enum_ItemList_SelectMode>` | :ref:`select_mode<class_ItemList_property_select_mode>` | ``0`` |
|
|
+---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+
|
|
| :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` | :ref:`text_overrun_behavior<class_ItemList_property_text_overrun_behavior>` | ``3`` |
|
|
+---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`tile_scroll_hint<class_ItemList_property_tile_scroll_hint>` | ``false`` |
|
|
+---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`wraparound_items<class_ItemList_property_wraparound_items>` | ``true`` |
|
|
+---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Métodos
|
|
--------------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`add_icon_item<class_ItemList_method_add_icon_item>`\ (\ icon\: :ref:`Texture2D<class_Texture2D>`, selectable\: :ref:`bool<class_bool>` = true\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`add_item<class_ItemList_method_add_item>`\ (\ text\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>` = null, selectable\: :ref:`bool<class_bool>` = true\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`clear<class_ItemList_method_clear>`\ (\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`deselect<class_ItemList_method_deselect>`\ (\ idx\: :ref:`int<class_int>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`deselect_all<class_ItemList_method_deselect_all>`\ (\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`ensure_current_is_visible<class_ItemList_method_ensure_current_is_visible>`\ (\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`force_update_list_size<class_ItemList_method_force_update_list_size>`\ (\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`HScrollBar<class_HScrollBar>` | :ref:`get_h_scroll_bar<class_ItemList_method_get_h_scroll_bar>`\ (\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_item_at_position<class_ItemList_method_get_item_at_position>`\ (\ position\: :ref:`Vector2<class_Vector2>`, exact\: :ref:`bool<class_bool>` = false\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`AutoTranslateMode<enum_Node_AutoTranslateMode>` | :ref:`get_item_auto_translate_mode<class_ItemList_method_get_item_auto_translate_mode>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`get_item_custom_bg_color<class_ItemList_method_get_item_custom_bg_color>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`get_item_custom_fg_color<class_ItemList_method_get_item_custom_fg_color>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Texture2D<class_Texture2D>` | :ref:`get_item_icon<class_ItemList_method_get_item_icon>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`get_item_icon_modulate<class_ItemList_method_get_item_icon_modulate>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Rect2<class_Rect2>` | :ref:`get_item_icon_region<class_ItemList_method_get_item_icon_region>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`get_item_language<class_ItemList_method_get_item_language>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Variant<class_Variant>` | :ref:`get_item_metadata<class_ItemList_method_get_item_metadata>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Rect2<class_Rect2>` | :ref:`get_item_rect<class_ItemList_method_get_item_rect>`\ (\ idx\: :ref:`int<class_int>`, expand\: :ref:`bool<class_bool>` = true\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`get_item_text<class_ItemList_method_get_item_text>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`TextDirection<enum_Control_TextDirection>` | :ref:`get_item_text_direction<class_ItemList_method_get_item_text_direction>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`get_item_tooltip<class_ItemList_method_get_item_tooltip>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_selected_items<class_ItemList_method_get_selected_items>`\ (\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`VScrollBar<class_VScrollBar>` | :ref:`get_v_scroll_bar<class_ItemList_method_get_v_scroll_bar>`\ (\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :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>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_item_icon_transposed<class_ItemList_method_is_item_icon_transposed>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_item_selectable<class_ItemList_method_is_item_selectable>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_item_tooltip_enabled<class_ItemList_method_is_item_tooltip_enabled>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_selected<class_ItemList_method_is_selected>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`move_item<class_ItemList_method_move_item>`\ (\ from_idx\: :ref:`int<class_int>`, to_idx\: :ref:`int<class_int>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`remove_item<class_ItemList_method_remove_item>`\ (\ idx\: :ref:`int<class_int>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`select<class_ItemList_method_select>`\ (\ idx\: :ref:`int<class_int>`, single\: :ref:`bool<class_bool>` = true\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`set_item_auto_translate_mode<class_ItemList_method_set_item_auto_translate_mode>`\ (\ idx\: :ref:`int<class_int>`, mode\: :ref:`AutoTranslateMode<enum_Node_AutoTranslateMode>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`set_item_custom_bg_color<class_ItemList_method_set_item_custom_bg_color>`\ (\ idx\: :ref:`int<class_int>`, custom_bg_color\: :ref:`Color<class_Color>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`set_item_custom_fg_color<class_ItemList_method_set_item_custom_fg_color>`\ (\ idx\: :ref:`int<class_int>`, custom_fg_color\: :ref:`Color<class_Color>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`set_item_disabled<class_ItemList_method_set_item_disabled>`\ (\ idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`set_item_icon<class_ItemList_method_set_item_icon>`\ (\ idx\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`set_item_icon_modulate<class_ItemList_method_set_item_icon_modulate>`\ (\ idx\: :ref:`int<class_int>`, modulate\: :ref:`Color<class_Color>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`set_item_icon_region<class_ItemList_method_set_item_icon_region>`\ (\ idx\: :ref:`int<class_int>`, rect\: :ref:`Rect2<class_Rect2>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`set_item_icon_transposed<class_ItemList_method_set_item_icon_transposed>`\ (\ idx\: :ref:`int<class_int>`, transposed\: :ref:`bool<class_bool>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`set_item_language<class_ItemList_method_set_item_language>`\ (\ idx\: :ref:`int<class_int>`, language\: :ref:`String<class_String>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`set_item_metadata<class_ItemList_method_set_item_metadata>`\ (\ idx\: :ref:`int<class_int>`, metadata\: :ref:`Variant<class_Variant>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`set_item_selectable<class_ItemList_method_set_item_selectable>`\ (\ idx\: :ref:`int<class_int>`, selectable\: :ref:`bool<class_bool>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`set_item_text<class_ItemList_method_set_item_text>`\ (\ idx\: :ref:`int<class_int>`, text\: :ref:`String<class_String>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`set_item_text_direction<class_ItemList_method_set_item_text_direction>`\ (\ idx\: :ref:`int<class_int>`, direction\: :ref:`TextDirection<enum_Control_TextDirection>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`set_item_tooltip<class_ItemList_method_set_item_tooltip>`\ (\ idx\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`set_item_tooltip_enabled<class_ItemList_method_set_item_tooltip_enabled>`\ (\ idx\: :ref:`int<class_int>`, enable\: :ref:`bool<class_bool>`\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`sort_items_by_text<class_ItemList_method_sort_items_by_text>`\ (\ ) |
|
|
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Propiedades del Tema
|
|
----------------------------------------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color<class_ItemList_theme_color_font_color>` | ``Color(0.65, 0.65, 0.65, 1)`` |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_hovered_color<class_ItemList_theme_color_font_hovered_color>` | ``Color(0.95, 0.95, 0.95, 1)`` |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_hovered_selected_color<class_ItemList_theme_color_font_hovered_selected_color>` | ``Color(1, 1, 1, 1)`` |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_outline_color<class_ItemList_theme_color_font_outline_color>` | ``Color(0, 0, 0, 1)`` |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_selected_color<class_ItemList_theme_color_font_selected_color>` | ``Color(1, 1, 1, 1)`` |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`guide_color<class_ItemList_theme_color_guide_color>` | ``Color(0.7, 0.7, 0.7, 0.25)`` |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`h_separation<class_ItemList_theme_constant_h_separation>` | ``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:`outline_size<class_ItemList_theme_constant_outline_size>` | ``0`` |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`v_separation<class_ItemList_theme_constant_v_separation>` | ``4`` |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :ref:`Font<class_Font>` | :ref:`font<class_ItemList_theme_font_font>` | |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`font_size<class_ItemList_theme_font_size_font_size>` | |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :ref:`Texture2D<class_Texture2D>` | :ref:`scroll_hint<class_ItemList_theme_icon_scroll_hint>` | |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :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:`focus<class_ItemList_theme_style_focus>` | |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`hovered<class_ItemList_theme_style_hovered>` | |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`hovered_selected<class_ItemList_theme_style_hovered_selected>` | |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`hovered_selected_focus<class_ItemList_theme_style_hovered_selected_focus>` | |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`panel<class_ItemList_theme_style_panel>` | |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`selected<class_ItemList_theme_style_selected>` | |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`selected_focus<class_ItemList_theme_style_selected_focus>` | |
|
|
+-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Señales
|
|
--------------
|
|
|
|
.. _class_ItemList_signal_empty_clicked:
|
|
|
|
.. rst-class:: classref-signal
|
|
|
|
**empty_clicked**\ (\ at_position\: :ref:`Vector2<class_Vector2>`, mouse_button_index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_ItemList_signal_empty_clicked>`
|
|
|
|
Emitida cuando se produce cualquier clic del ratón dentro del rectángulo de la lista pero en un espacio vacío.
|
|
|
|
\ ``at_position`` es la posición del clic en el sistema de coordenadas local de este control.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_signal_item_activated:
|
|
|
|
.. rst-class:: classref-signal
|
|
|
|
**item_activated**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_ItemList_signal_item_activated>`
|
|
|
|
Emitida cuando el elemento de la lista especificado se activa haciendo doble clic o pulsando :kbd:`Enter`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_signal_item_clicked:
|
|
|
|
.. rst-class:: classref-signal
|
|
|
|
**item_clicked**\ (\ index\: :ref:`int<class_int>`, at_position\: :ref:`Vector2<class_Vector2>`, mouse_button_index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_ItemList_signal_item_clicked>`
|
|
|
|
Emitida cuando se ha hecho clic en un elemento de la lista especificado con cualquier botón del ratón.
|
|
|
|
\ ``at_position`` es la posición del clic en el sistema de coordenadas local de este control.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_signal_item_selected:
|
|
|
|
.. rst-class:: classref-signal
|
|
|
|
**item_selected**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_ItemList_signal_item_selected>`
|
|
|
|
Emitida cuando se selecciona un elemento especificado. Solo aplicable en el modo de selección única.
|
|
|
|
Se debe activar :ref:`allow_reselect<class_ItemList_property_allow_reselect>` para volver a seleccionar un elemento.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_signal_multi_selected:
|
|
|
|
.. rst-class:: classref-signal
|
|
|
|
**multi_selected**\ (\ index\: :ref:`int<class_int>`, selected\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_ItemList_signal_multi_selected>`
|
|
|
|
Emitida cuando se altera una selección múltiple en una lista que permite la selección múltiple.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumeraciones
|
|
--------------------------
|
|
|
|
.. _enum_ItemList_IconMode:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **IconMode**: :ref:`🔗<enum_ItemList_IconMode>`
|
|
|
|
.. _class_ItemList_constant_ICON_MODE_TOP:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`IconMode<enum_ItemList_IconMode>` **ICON_MODE_TOP** = ``0``
|
|
|
|
El icono se dibuja sobre el texto.
|
|
|
|
.. _class_ItemList_constant_ICON_MODE_LEFT:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`IconMode<enum_ItemList_IconMode>` **ICON_MODE_LEFT** = ``1``
|
|
|
|
El icono se dibuja a la izquierda del texto.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _enum_ItemList_SelectMode:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **SelectMode**: :ref:`🔗<enum_ItemList_SelectMode>`
|
|
|
|
.. _class_ItemList_constant_SELECT_SINGLE:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`SelectMode<enum_ItemList_SelectMode>` **SELECT_SINGLE** = ``0``
|
|
|
|
Sólo permite seleccionar un único elemento.
|
|
|
|
.. _class_ItemList_constant_SELECT_MULTI:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`SelectMode<enum_ItemList_SelectMode>` **SELECT_MULTI** = ``1``
|
|
|
|
Permite seleccionar varios elementos manteniendo pulsada la tecla :kbd:`Ctrl` o :kbd:`Shift`.
|
|
|
|
.. _class_ItemList_constant_SELECT_TOGGLE:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`SelectMode<enum_ItemList_SelectMode>` **SELECT_TOGGLE** = ``2``
|
|
|
|
Permite seleccionar varios elementos activándolos y desactivándolos.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _enum_ItemList_ScrollHintMode:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **ScrollHintMode**: :ref:`🔗<enum_ItemList_ScrollHintMode>`
|
|
|
|
.. _class_ItemList_constant_SCROLL_HINT_MODE_DISABLED:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ScrollHintMode<enum_ItemList_ScrollHintMode>` **SCROLL_HINT_MODE_DISABLED** = ``0``
|
|
|
|
Scroll hints will never be shown.
|
|
|
|
.. _class_ItemList_constant_SCROLL_HINT_MODE_BOTH:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ScrollHintMode<enum_ItemList_ScrollHintMode>` **SCROLL_HINT_MODE_BOTH** = ``1``
|
|
|
|
Scroll hints will be shown at the top and bottom.
|
|
|
|
.. _class_ItemList_constant_SCROLL_HINT_MODE_TOP:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ScrollHintMode<enum_ItemList_ScrollHintMode>` **SCROLL_HINT_MODE_TOP** = ``2``
|
|
|
|
Only the top scroll hint will be shown.
|
|
|
|
.. _class_ItemList_constant_SCROLL_HINT_MODE_BOTTOM:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ScrollHintMode<enum_ItemList_ScrollHintMode>` **SCROLL_HINT_MODE_BOTTOM** = ``3``
|
|
|
|
Only the bottom scroll hint will be shown.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Descripciones de Propiedades
|
|
--------------------------------------------------------
|
|
|
|
.. _class_ItemList_property_allow_reselect:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **allow_reselect** = ``false`` :ref:`🔗<class_ItemList_property_allow_reselect>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_allow_reselect**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **get_allow_reselect**\ (\ )
|
|
|
|
Si es ``true``, el elemento actualmente seleccionado puede ser seleccionado de nuevo.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_property_allow_rmb_select:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **allow_rmb_select** = ``false`` :ref:`🔗<class_ItemList_property_allow_rmb_select>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_allow_rmb_select**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **get_allow_rmb_select**\ (\ )
|
|
|
|
Si es ``true``, al hacer clic con el botón derecho del ratón se pueden seleccionar elementos.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_property_allow_search:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **allow_search** = ``true`` :ref:`🔗<class_ItemList_property_allow_search>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_allow_search**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **get_allow_search**\ (\ )
|
|
|
|
Si es ``true``, permite navegar por **ItemList** con las teclas de letras a través de la búsqueda incremental.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_property_auto_height:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **auto_height** = ``false`` :ref:`🔗<class_ItemList_property_auto_height>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_auto_height**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **has_auto_height**\ (\ )
|
|
|
|
Si es ``true``, el control redimensionará automáticamente la altura para que se ajuste a su contenido.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_property_auto_width:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **auto_width** = ``false`` :ref:`🔗<class_ItemList_property_auto_width>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_auto_width**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **has_auto_width**\ (\ )
|
|
|
|
Si es ``true``, el control redimensionará automáticamente el ancho para que se ajuste a su contenido.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_property_fixed_column_width:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **fixed_column_width** = ``0`` :ref:`🔗<class_ItemList_property_fixed_column_width>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_fixed_column_width**\ (\ value\: :ref:`int<class_int>`\ )
|
|
- :ref:`int<class_int>` **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.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_property_fixed_icon_size:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Vector2i<class_Vector2i>` **fixed_icon_size** = ``Vector2i(0, 0)`` :ref:`🔗<class_ItemList_property_fixed_icon_size>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_fixed_icon_size**\ (\ value\: :ref:`Vector2i<class_Vector2i>`\ )
|
|
- :ref:`Vector2i<class_Vector2i>` **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.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_property_icon_mode:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`IconMode<enum_ItemList_IconMode>` **icon_mode** = ``1`` :ref:`🔗<class_ItemList_property_icon_mode>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_icon_mode**\ (\ value\: :ref:`IconMode<enum_ItemList_IconMode>`\ )
|
|
- :ref:`IconMode<enum_ItemList_IconMode>` **get_icon_mode**\ (\ )
|
|
|
|
La posición del icono, ya sea arriba o a la izquierda del texto. Véase las constantes :ref:`IconMode<enum_ItemList_IconMode>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_property_icon_scale:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **icon_scale** = ``1.0`` :ref:`🔗<class_ItemList_property_icon_scale>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_icon_scale**\ (\ value\: :ref:`float<class_float>`\ )
|
|
- :ref:`float<class_float>` **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.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_property_item_count:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **item_count** = ``0`` :ref:`🔗<class_ItemList_property_item_count>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_item_count**\ (\ value\: :ref:`int<class_int>`\ )
|
|
- :ref:`int<class_int>` **get_item_count**\ (\ )
|
|
|
|
El número de elementos que hay actualmente en la lista.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_property_max_columns:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **max_columns** = ``1`` :ref:`🔗<class_ItemList_property_max_columns>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_max_columns**\ (\ value\: :ref:`int<class_int>`\ )
|
|
- :ref:`int<class_int>` **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.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_property_max_text_lines:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **max_text_lines** = ``1`` :ref:`🔗<class_ItemList_property_max_text_lines>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_max_text_lines**\ (\ value\: :ref:`int<class_int>`\ )
|
|
- :ref:`int<class_int>` **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.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_property_same_column_width:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **same_column_width** = ``false`` :ref:`🔗<class_ItemList_property_same_column_width>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_same_column_width**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **is_same_column_width**\ (\ )
|
|
|
|
Si todas las columnas tendrán el mismo ancho.
|
|
|
|
Si es ``true``, el ancho es igual al mayor ancho de todas las columnas.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_property_scroll_hint_mode:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`ScrollHintMode<enum_ItemList_ScrollHintMode>` **scroll_hint_mode** = ``0`` :ref:`🔗<class_ItemList_property_scroll_hint_mode>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_scroll_hint_mode**\ (\ value\: :ref:`ScrollHintMode<enum_ItemList_ScrollHintMode>`\ )
|
|
- :ref:`ScrollHintMode<enum_ItemList_ScrollHintMode>` **get_scroll_hint_mode**\ (\ )
|
|
|
|
The way which scroll hints (indicators that show that the content can still be scrolled in a certain direction) will be shown.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_property_select_mode:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`SelectMode<enum_ItemList_SelectMode>` **select_mode** = ``0`` :ref:`🔗<class_ItemList_property_select_mode>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_select_mode**\ (\ value\: :ref:`SelectMode<enum_ItemList_SelectMode>`\ )
|
|
- :ref:`SelectMode<enum_ItemList_SelectMode>` **get_select_mode**\ (\ )
|
|
|
|
Permite la selección de uno o varios elementos. Véase las constantes :ref:`SelectMode<enum_ItemList_SelectMode>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_property_text_overrun_behavior:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **text_overrun_behavior** = ``3`` :ref:`🔗<class_ItemList_property_text_overrun_behavior>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_text_overrun_behavior**\ (\ value\: :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>`\ )
|
|
- :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **get_text_overrun_behavior**\ (\ )
|
|
|
|
El comportamiento de recorte cuando el texto excede el rectángulo delimitador de un elemento.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_property_tile_scroll_hint:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **tile_scroll_hint** = ``false`` :ref:`🔗<class_ItemList_property_tile_scroll_hint>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_tile_scroll_hint**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **is_scroll_hint_tiled**\ (\ )
|
|
|
|
If ``true``, the scroll hint texture will be tiled instead of stretched. See :ref:`scroll_hint_mode<class_ItemList_property_scroll_hint_mode>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_property_wraparound_items:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **wraparound_items** = ``true`` :ref:`🔗<class_ItemList_property_wraparound_items>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_wraparound_items**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **has_wraparound_items**\ (\ )
|
|
|
|
Si es ``true``, el control moverá automáticamente los elementos a una nueva fila para que quepan en su contenido. Véase también :ref:`HFlowContainer<class_HFlowContainer>` para este comportamiento.
|
|
|
|
Si es ``false``, el control añadirá una barra de desplazamiento horizontal para hacer visibles todos los elementos.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Descripciones de Métodos
|
|
------------------------------------------------
|
|
|
|
.. _class_ItemList_method_add_icon_item:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`int<class_int>` **add_icon_item**\ (\ icon\: :ref:`Texture2D<class_Texture2D>`, selectable\: :ref:`bool<class_bool>` = true\ ) :ref:`🔗<class_ItemList_method_add_icon_item>`
|
|
|
|
Añade un elemento a la lista de elementos sin texto, solo un icono. Devuelve el índice del elemento añadido.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_add_item:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`int<class_int>` **add_item**\ (\ text\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>` = null, selectable\: :ref:`bool<class_bool>` = true\ ) :ref:`🔗<class_ItemList_method_add_item>`
|
|
|
|
Añade un elemento a la lista de elementos con el texto especificado. Devuelve el índice del elemento añadido.
|
|
|
|
Especifica un ``icon``, o usa ``null`` como ``icon`` para un elemento de la lista sin icono.
|
|
|
|
Si ``selectable`` es ``true``, el elemento de la lista será seleccionable.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_clear:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **clear**\ (\ ) :ref:`🔗<class_ItemList_method_clear>`
|
|
|
|
Elimina todos los elementos de la lista.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_deselect:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **deselect**\ (\ idx\: :ref:`int<class_int>`\ ) :ref:`🔗<class_ItemList_method_deselect>`
|
|
|
|
Asegura que no se seleccione el elemento asociado al índice especificado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_deselect_all:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **deselect_all**\ (\ ) :ref:`🔗<class_ItemList_method_deselect_all>`
|
|
|
|
Se asegura de que no haya elementos seleccionados.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_ensure_current_is_visible:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **ensure_current_is_visible**\ (\ ) :ref:`🔗<class_ItemList_method_ensure_current_is_visible>`
|
|
|
|
Asegúrate de que la selección actual sea visible, ajustando la posición del scroll según sea necesario.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_force_update_list_size:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **force_update_list_size**\ (\ ) :ref:`🔗<class_ItemList_method_force_update_list_size>`
|
|
|
|
Fuerza una actualización del tamaño de la lista según sus elementos. Esto sucede automáticamente cuando cambia el tamaño de los elementos, u otros ajustes relevantes como :ref:`auto_height<class_ItemList_property_auto_height>`. El método se puede utilizar para activar la actualización antes del siguiente pase de dibujo.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_get_h_scroll_bar:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`HScrollBar<class_HScrollBar>` **get_h_scroll_bar**\ (\ ) :ref:`🔗<class_ItemList_method_get_h_scroll_bar>`
|
|
|
|
Devuelve la barra de desplazamiento horizontal.
|
|
|
|
\ **Advertencia:** Este es un nodo interno requerido, eliminarlo y liberarlo puede provocar un fallo. Si deseas ocultarlo o alguno de sus hijos, utiliza su propiedad :ref:`CanvasItem.visible<class_CanvasItem_property_visible>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_get_item_at_position:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`int<class_int>` **get_item_at_position**\ (\ position\: :ref:`Vector2<class_Vector2>`, exact\: :ref:`bool<class_bool>` = false\ ) |const| :ref:`🔗<class_ItemList_method_get_item_at_position>`
|
|
|
|
Devuelve el índice del elemento en la ``position`` dada.
|
|
|
|
Cuando no hay ningún elemento en ese punto, se devolverá -1 si ``exact`` es ``true``, y si no, se devolverá el índice del elemento más cercano.
|
|
|
|
\ **Nota:** El valor devuelto no es fiable si se llama justo después de modificar el **ItemList**, antes de que se vuelva a dibujar en el siguiente fotograma.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_get_item_auto_translate_mode:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`AutoTranslateMode<enum_Node_AutoTranslateMode>` **get_item_auto_translate_mode**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ItemList_method_get_item_auto_translate_mode>`
|
|
|
|
Devuelve el modo de traducción automática del elemento.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_get_item_custom_bg_color:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`Color<class_Color>` **get_item_custom_bg_color**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ItemList_method_get_item_custom_bg_color>`
|
|
|
|
Devuelve el color de fondo personalizado del elemento especificado por el índice ``idx``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_get_item_custom_fg_color:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`Color<class_Color>` **get_item_custom_fg_color**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ItemList_method_get_item_custom_fg_color>`
|
|
|
|
Devuelve el color de primer plano personalizado del elemento especificado por el índice ``idx``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_get_item_icon:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`Texture2D<class_Texture2D>` **get_item_icon**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ItemList_method_get_item_icon>`
|
|
|
|
Devuelve el icono asociado al índice especificado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_get_item_icon_modulate:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`Color<class_Color>` **get_item_icon_modulate**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ItemList_method_get_item_icon_modulate>`
|
|
|
|
Devuelve un :ref:`Color<class_Color>` del icono de un elemento modulador en el índice especificado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_get_item_icon_region:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`Rect2<class_Rect2>` **get_item_icon_region**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ItemList_method_get_item_icon_region>`
|
|
|
|
Devuelve la región del icono del elemento utilizado. El icono completo será utilizado si la región no tiene área.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_get_item_language:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`String<class_String>` **get_item_language**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ItemList_method_get_item_language>`
|
|
|
|
Devuelve el código de idioma del texto del elemento.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_get_item_metadata:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`Variant<class_Variant>` **get_item_metadata**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ItemList_method_get_item_metadata>`
|
|
|
|
Devuelve el valor de los metadatos del índice especificado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_get_item_rect:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`Rect2<class_Rect2>` **get_item_rect**\ (\ idx\: :ref:`int<class_int>`, expand\: :ref:`bool<class_bool>` = true\ ) |const| :ref:`🔗<class_ItemList_method_get_item_rect>`
|
|
|
|
Devuelve la posición y el tamaño del elemento con el índice especificado, en el sistema de coordenadas del nodo **ItemList**. Si ``expand`` es ``true``, la última columna se expande para rellenar el resto de la fila.
|
|
|
|
\ **Nota:** El valor devuelto no es fiable si se llama justo después de modificar el **ItemList**, antes de que se redibuje en el siguiente fotograma.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_get_item_text:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`String<class_String>` **get_item_text**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ItemList_method_get_item_text>`
|
|
|
|
Devuelve el texto asociado al índice especificado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_get_item_text_direction:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`TextDirection<enum_Control_TextDirection>` **get_item_text_direction**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ItemList_method_get_item_text_direction>`
|
|
|
|
Devuelve la dirección de escritura base del texto del elemento.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_get_item_tooltip:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`String<class_String>` **get_item_tooltip**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ItemList_method_get_item_tooltip>`
|
|
|
|
Devuelve la sugerencia de la herramienta asociada con el índice especificado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_get_selected_items:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`PackedInt32Array<class_PackedInt32Array>` **get_selected_items**\ (\ ) :ref:`🔗<class_ItemList_method_get_selected_items>`
|
|
|
|
Devuelve un array con los índices de los elementos seleccionados.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_get_v_scroll_bar:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`VScrollBar<class_VScrollBar>` **get_v_scroll_bar**\ (\ ) :ref:`🔗<class_ItemList_method_get_v_scroll_bar>`
|
|
|
|
Devuelve la barra de desplazamiento vertical.
|
|
|
|
\ **Advertencia:** Este es un nodo interno requerido, eliminarlo y liberarlo puede causar un crasheo. Si deseas ocultarlo o a alguno de sus hijos, usa su propiedad :ref:`CanvasItem.visible<class_CanvasItem_property_visible>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_is_anything_selected:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`bool<class_bool>` **is_anything_selected**\ (\ ) :ref:`🔗<class_ItemList_method_is_anything_selected>`
|
|
|
|
Devuelve ``true`` si se seleccionan uno o más elementos.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_is_item_disabled:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`bool<class_bool>` **is_item_disabled**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ItemList_method_is_item_disabled>`
|
|
|
|
Devuelve ``true`` si el elemento del índice especificado está desactivado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_is_item_icon_transposed:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`bool<class_bool>` **is_item_icon_transposed**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ItemList_method_is_item_icon_transposed>`
|
|
|
|
Devuelve ``true`` si el icono del elemento se dibujará transpuesto, es decir, los ejes X e Y se intercambian.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_is_item_selectable:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`bool<class_bool>` **is_item_selectable**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ItemList_method_is_item_selectable>`
|
|
|
|
Devuelve ``true`` si el elemento en el índice especificado es seleccionable.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_is_item_tooltip_enabled:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`bool<class_bool>` **is_item_tooltip_enabled**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ItemList_method_is_item_tooltip_enabled>`
|
|
|
|
Devuelve ``true`` si la sugerencia está habilitada para el índice del artículo especificado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_is_selected:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`bool<class_bool>` **is_selected**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ItemList_method_is_selected>`
|
|
|
|
Devuelve ``true`` si el elemento del índice especificado está actualmente seleccionado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_move_item:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **move_item**\ (\ from_idx\: :ref:`int<class_int>`, to_idx\: :ref:`int<class_int>`\ ) :ref:`🔗<class_ItemList_method_move_item>`
|
|
|
|
Mueve el elemento del índice ``from_idx`` a ``to_idx``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_remove_item:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **remove_item**\ (\ idx\: :ref:`int<class_int>`\ ) :ref:`🔗<class_ItemList_method_remove_item>`
|
|
|
|
Elimina de la lista el elemento especificado por el índice ``idx``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_select:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **select**\ (\ idx\: :ref:`int<class_int>`, single\: :ref:`bool<class_bool>` = true\ ) :ref:`🔗<class_ItemList_method_select>`
|
|
|
|
Seleccione el elemento en el índice especificado.
|
|
|
|
\ **Nota:** Este método no dispara la señal de selección del elemento.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_set_item_auto_translate_mode:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **set_item_auto_translate_mode**\ (\ idx\: :ref:`int<class_int>`, mode\: :ref:`AutoTranslateMode<enum_Node_AutoTranslateMode>`\ ) :ref:`🔗<class_ItemList_method_set_item_auto_translate_mode>`
|
|
|
|
Establece el modo de autotraducción del elemento asociado con el índice especificado.
|
|
|
|
Por defecto, los elementos usan :ref:`Node.AUTO_TRANSLATE_MODE_INHERIT<class_Node_constant_AUTO_TRANSLATE_MODE_INHERIT>`, que utiliza el mismo modo de autotraducción que el propio **ItemList**.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_set_item_custom_bg_color:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **set_item_custom_bg_color**\ (\ idx\: :ref:`int<class_int>`, custom_bg_color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_ItemList_method_set_item_custom_bg_color>`
|
|
|
|
Establece el color de fondo del elemento especificado por el índice ``idx`` al :ref:`Color<class_Color>` especificado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_set_item_custom_fg_color:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **set_item_custom_fg_color**\ (\ idx\: :ref:`int<class_int>`, custom_fg_color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_ItemList_method_set_item_custom_fg_color>`
|
|
|
|
Establece el color de primer plano del elemento especificado por el índice ``idx`` al :ref:`Color<class_Color>` especificado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_set_item_disabled:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **set_item_disabled**\ (\ idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_ItemList_method_set_item_disabled>`
|
|
|
|
Desactiva (o activa) el elemento en el índice especificado.
|
|
|
|
Los elementos desactivados no pueden seleccionarse y no activan las señales de activación (cuando se hace doble clic o se pulsa :kbd:`Enter`).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_set_item_icon:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **set_item_icon**\ (\ idx\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ ) :ref:`🔗<class_ItemList_method_set_item_icon>`
|
|
|
|
Establece (o reemplaza) el icono :ref:`Texture2D<class_Texture2D>` asociado al índice especificado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_set_item_icon_modulate:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **set_item_icon_modulate**\ (\ idx\: :ref:`int<class_int>`, modulate\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_ItemList_method_set_item_icon_modulate>`
|
|
|
|
Establece un :ref:`Color<class_Color>` modulador del elemento asociado al índice especificado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_set_item_icon_region:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **set_item_icon_region**\ (\ idx\: :ref:`int<class_int>`, rect\: :ref:`Rect2<class_Rect2>`\ ) :ref:`🔗<class_ItemList_method_set_item_icon_region>`
|
|
|
|
Establece la región del icono del elemento utilizado. El icono completo se utilizará si la región no tiene área.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_set_item_icon_transposed:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **set_item_icon_transposed**\ (\ idx\: :ref:`int<class_int>`, transposed\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_ItemList_method_set_item_icon_transposed>`
|
|
|
|
Establece si el icono del elemento se dibujará transpuesto.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_set_item_language:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **set_item_language**\ (\ idx\: :ref:`int<class_int>`, language\: :ref:`String<class_String>`\ ) :ref:`🔗<class_ItemList_method_set_item_language>`
|
|
|
|
Sets the language code of the text for the item at the given index to ``language``. This is used for line-breaking and text shaping algorithms. If ``language`` is empty, the current locale is used.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_set_item_metadata:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **set_item_metadata**\ (\ idx\: :ref:`int<class_int>`, metadata\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_ItemList_method_set_item_metadata>`
|
|
|
|
Establece un valor (de cualquier tipo) que se almacenará con el elemento asociado al índice especificado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_set_item_selectable:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **set_item_selectable**\ (\ idx\: :ref:`int<class_int>`, selectable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_ItemList_method_set_item_selectable>`
|
|
|
|
Permite o no la selección del elemento asociado al índice especificado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_set_item_text:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **set_item_text**\ (\ idx\: :ref:`int<class_int>`, text\: :ref:`String<class_String>`\ ) :ref:`🔗<class_ItemList_method_set_item_text>`
|
|
|
|
Establece el texto del elemento asociado con el índice especificado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_set_item_text_direction:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **set_item_text_direction**\ (\ idx\: :ref:`int<class_int>`, direction\: :ref:`TextDirection<enum_Control_TextDirection>`\ ) :ref:`🔗<class_ItemList_method_set_item_text_direction>`
|
|
|
|
Establece la dirección de escritura base del texto del elemento.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_set_item_tooltip:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **set_item_tooltip**\ (\ idx\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) :ref:`🔗<class_ItemList_method_set_item_tooltip>`
|
|
|
|
Establece la sugerencia para el elemento asociado con el índice especificado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_set_item_tooltip_enabled:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **set_item_tooltip_enabled**\ (\ idx\: :ref:`int<class_int>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_ItemList_method_set_item_tooltip_enabled>`
|
|
|
|
Establece si la sugerencia está habilitada para el índice de elementos especificados.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_method_sort_items_by_text:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **sort_items_by_text**\ (\ ) :ref:`🔗<class_ItemList_method_sort_items_by_text>`
|
|
|
|
Ordena los elementos de la lista por su texto.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Descripciones de las propiedades del tema
|
|
----------------------------------------------------------------------------------
|
|
|
|
.. _class_ItemList_theme_color_font_color:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Color<class_Color>` **font_color** = ``Color(0.65, 0.65, 0.65, 1)`` :ref:`🔗<class_ItemList_theme_color_font_color>`
|
|
|
|
:ref:`Color<class_Color>` del texto predeterminado del elemento.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_color_font_hovered_color:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Color<class_Color>` **font_hovered_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗<class_ItemList_theme_color_font_hovered_color>`
|
|
|
|
:ref:`Color<class_Color>` del texto utilizado cuando el puntero está sobre el elemento, pero este no está seleccionado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_color_font_hovered_selected_color:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Color<class_Color>` **font_hovered_selected_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_ItemList_theme_color_font_hovered_selected_color>`
|
|
|
|
:ref:`Color<class_Color>` del texto utilizado cuando el puntero está sobre el elemento y este está seleccionado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_color_font_outline_color:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Color<class_Color>` **font_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗<class_ItemList_theme_color_font_outline_color>`
|
|
|
|
El tinte del contorno del texto del elemento.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_color_font_selected_color:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Color<class_Color>` **font_selected_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_ItemList_theme_color_font_selected_color>`
|
|
|
|
:ref:`Color<class_Color>` del texto utilizado cuando el elemento está seleccionado, pero el puntero no está sobre él.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_color_guide_color:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Color<class_Color>` **guide_color** = ``Color(0.7, 0.7, 0.7, 0.25)`` :ref:`🔗<class_ItemList_theme_color_guide_color>`
|
|
|
|
:ref:`Color<class_Color>` de la pauta. La pauta es una línea trazada entre cada fila de elementos.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_constant_h_separation:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`int<class_int>` **h_separation** = ``4`` :ref:`🔗<class_ItemList_theme_constant_h_separation>`
|
|
|
|
El espacio horizontal entre los elementos.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_constant_icon_margin:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`int<class_int>` **icon_margin** = ``4`` :ref:`🔗<class_ItemList_theme_constant_icon_margin>`
|
|
|
|
El espacio entre el icono del elemento y el texto.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_constant_line_separation:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`int<class_int>` **line_separation** = ``2`` :ref:`🔗<class_ItemList_theme_constant_line_separation>`
|
|
|
|
El espacio vertical entre cada línea de texto.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_constant_outline_size:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`int<class_int>` **outline_size** = ``0`` :ref:`🔗<class_ItemList_theme_constant_outline_size>`
|
|
|
|
El tamaño del contorno del texto del elemento.
|
|
|
|
\ **Nota:** Si se utiliza una fuente con :ref:`FontFile.multichannel_signed_distance_field<class_FontFile_property_multichannel_signed_distance_field>` activado, su :ref:`FontFile.msdf_pixel_range<class_FontFile_property_msdf_pixel_range>` debe establecerse en al menos el *doble* del valor de :ref:`outline_size<class_ItemList_theme_constant_outline_size>` para que la renderización del contorno se vea correcta. De lo contrario, el contorno puede parecer que se corta antes de lo previsto.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_constant_v_separation:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`int<class_int>` **v_separation** = ``4`` :ref:`🔗<class_ItemList_theme_constant_v_separation>`
|
|
|
|
El espacio vertical entre los artículos.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_font_font:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Font<class_Font>` **font** :ref:`🔗<class_ItemList_theme_font_font>`
|
|
|
|
:ref:`Font<class_Font>` del texto del elemento.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_font_size_font_size:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`int<class_int>` **font_size** :ref:`🔗<class_ItemList_theme_font_size_font_size>`
|
|
|
|
Tamaño de la fuente del texto del elemento.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_icon_scroll_hint:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Texture2D<class_Texture2D>` **scroll_hint** :ref:`🔗<class_ItemList_theme_icon_scroll_hint>`
|
|
|
|
The indicator that will be shown when the content can still be scrolled. See :ref:`scroll_hint_mode<class_ItemList_property_scroll_hint_mode>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_style_cursor:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **cursor** :ref:`🔗<class_ItemList_theme_style_cursor>`
|
|
|
|
:ref:`StyleBox<class_StyleBox>` usado para el cursor, cuando el **ItemList** está siendo enfocado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_style_cursor_unfocused:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **cursor_unfocused** :ref:`🔗<class_ItemList_theme_style_cursor_unfocused>`
|
|
|
|
:ref:`StyleBox<class_StyleBox>` usado para el cursor, cuando el **ItemList** no está siendo enfocado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_style_focus:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **focus** :ref:`🔗<class_ItemList_theme_style_focus>`
|
|
|
|
The focused style for the **ItemList**, drawn on top of everything.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_style_hovered:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **hovered** :ref:`🔗<class_ItemList_theme_style_hovered>`
|
|
|
|
:ref:`StyleBox<class_StyleBox>` para los elementos bajo el puntero, pero no seleccionados.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_style_hovered_selected:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **hovered_selected** :ref:`🔗<class_ItemList_theme_style_hovered_selected>`
|
|
|
|
:ref:`StyleBox<class_StyleBox>` para los elementos bajo el puntero y seleccionados, utilizado cuando el **ItemList** no está enfocado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_style_hovered_selected_focus:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **hovered_selected_focus** :ref:`🔗<class_ItemList_theme_style_hovered_selected_focus>`
|
|
|
|
:ref:`StyleBox<class_StyleBox>` para los elementos bajo el puntero y seleccionados, utilizado cuando el **ItemList** está enfocado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_style_panel:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **panel** :ref:`🔗<class_ItemList_theme_style_panel>`
|
|
|
|
El estilo de fondo para el **ItemList**.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_style_selected:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **selected** :ref:`🔗<class_ItemList_theme_style_selected>`
|
|
|
|
:ref:`StyleBox<class_StyleBox>` para los elementos seleccionados, utilizado cuando la **ItemList** no está siendo enfocada.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ItemList_theme_style_selected_focus:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **selected_focus** :ref:`🔗<class_ItemList_theme_style_selected_focus>`
|
|
|
|
:ref:`StyleBox<class_StyleBox>` para los elementos seleccionados, que se utiliza cuando se enfoca la **ItemList**.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (Normalmente, este método debería ser sobreescrito por el usuario para que tenga algún efecto.)`
|
|
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
|
|
.. |const| replace:: :abbr:`const (Este método no tiene efectos secundarios. No modifica ninguna de las variables miembro de la instancia.)`
|
|
.. |vararg| replace:: :abbr:`vararg (Este método permite agregar cualquier número de argumentos después de los descritos aquí.)`
|
|
.. |constructor| replace:: :abbr:`constructor (Este método se utiliza para construir un tipo.)`
|
|
.. |static| replace:: :abbr:`static (Este método no necesita una instancia para ser llamado, por lo que puede llamarse directamente utilizando el nombre de la clase.)`
|
|
.. |operator| replace:: :abbr:`operator (Este método describe un operador válido para usar con este tipo como operando izquierdo.)`
|
|
.. |bitfield| replace:: :abbr:`BitField (Este valor es un entero compuesto como una máscara de bits de las siguientes banderas.)`
|
|
.. |void| replace:: :abbr:`void (Sin valor de retorno.)`
|