:github_url: hide .. _class_CheckBox: CheckBox ======== **Hereda:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` Un botón que representa una elección binaria. .. rst-class:: classref-introduction-group Descripción ---------------------- **CheckBox** permite al usuario elegir una de solo dos opciones posibles. Es similar a :ref:`CheckButton` en funcionalidad, pero tiene una apariencia diferente. Para seguir los patrones de UX establecidos, se recomienda usar **CheckBox** cuando al alternarlo **no** tiene un efecto inmediato sobre algo. Por ejemplo, podría usarse cuando al alternarlo solo hará algo una vez que se presione un botón de confirmación. Véase también :ref:`BaseButton` que contiene propiedades y métodos comunes asociados con este nodo. Cuando :ref:`BaseButton.button_group` especifica un :ref:`ButtonGroup`, **CheckBox** cambia su apariencia a la de un botón de opción y usa las diversas propiedades de tema ``radio_*``. .. rst-class:: classref-reftable-group Propiedades ---------------------- .. table:: :widths: auto +-------------------------------------------------------------------+-------------+-------------------------------------------------------------------------------+ | :ref:`HorizontalAlignment` | alignment | ``0`` (overrides :ref:`Button`) | +-------------------------------------------------------------------+-------------+-------------------------------------------------------------------------------+ | :ref:`bool` | toggle_mode | ``true`` (overrides :ref:`BaseButton`) | +-------------------------------------------------------------------+-------------+-------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Propiedades del Tema ---------------------------------------- .. table:: :widths: auto +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`checkbox_checked_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`checkbox_unchecked_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`check_v_offset` | ``0`` | +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`checked` | | +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`checked_disabled` | | +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`radio_checked` | | +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`radio_checked_disabled` | | +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`radio_unchecked` | | +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`radio_unchecked_disabled` | | +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`unchecked` | | +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`unchecked_disabled` | | +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Descripciones de las propiedades del tema ---------------------------------------------------------------------------------- .. _class_CheckBox_theme_color_checkbox_checked_color: .. rst-class:: classref-themeproperty :ref:`Color` **checkbox_checked_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` El color del icono de marca cuando la casilla está presionada. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_color_checkbox_unchecked_color: .. rst-class:: classref-themeproperty :ref:`Color` **checkbox_unchecked_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` El color del icono sin marcar cuando la casilla de verificación no está presionada. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_constant_check_v_offset: .. rst-class:: classref-themeproperty :ref:`int` **check_v_offset** = ``0`` :ref:`🔗` El desplazamiento vertical utilizado al renderizar los check icons (en píxeles). .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_checked: .. rst-class:: classref-themeproperty :ref:`Texture2D` **checked** :ref:`🔗` El check icon que se muestra cuando se marca el **CheckBox**. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_checked_disabled: .. rst-class:: classref-themeproperty :ref:`Texture2D` **checked_disabled** :ref:`🔗` El icono de marca que se muestra cuando el **CheckBox** está marcado y desactivado. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_radio_checked: .. rst-class:: classref-themeproperty :ref:`Texture2D` **radio_checked** :ref:`🔗` El icono de marca que se muestra cuando el **CheckBox** está configurado como un botón de radio y está marcado. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_radio_checked_disabled: .. rst-class:: classref-themeproperty :ref:`Texture2D` **radio_checked_disabled** :ref:`🔗` El icono de marca que se muestra cuando el **CheckBox** está configurado como un botón de radio, está desactivado y desmarcado. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_radio_unchecked: .. rst-class:: classref-themeproperty :ref:`Texture2D` **radio_unchecked** :ref:`🔗` El icono de marca que se muestra cuando el **CheckBox** está configurado como un botón de radio y está desmarcado. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_radio_unchecked_disabled: .. rst-class:: classref-themeproperty :ref:`Texture2D` **radio_unchecked_disabled** :ref:`🔗` El icono de marca que se muestra cuando el **CheckBox** está configurado como un botón de radio, está desactivado y desmarcado. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_unchecked: .. rst-class:: classref-themeproperty :ref:`Texture2D` **unchecked** :ref:`🔗` El check icon que aparece cuando el **CheckBox** está deseleccionado. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_unchecked_disabled: .. rst-class:: classref-themeproperty :ref:`Texture2D` **unchecked_disabled** :ref:`🔗` El icono de marca que se muestra cuando el **CheckBox** está desmarcado y desactivado. .. |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.)`