mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
264 lines
13 KiB
ReStructuredText
264 lines
13 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CheckButton.xml.
|
|
|
|
.. _class_CheckButton:
|
|
|
|
CheckButton
|
|
===========
|
|
|
|
**Inherits:** :ref:`Button<class_Button>` **<** :ref:`BaseButton<class_BaseButton>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
Checkable button. See also :ref:`CheckBox<class_CheckBox>`.
|
|
|
|
Description
|
|
-----------
|
|
|
|
CheckButton is a toggle button displayed as a check field. It's similar to :ref:`CheckBox<class_CheckBox>` in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckButton when toggling it has an **immediate** effect on something. For instance, it should be used if toggling it enables/disables a setting without requiring the user to press a confirmation button.
|
|
|
|
See also :ref:`BaseButton<class_BaseButton>` which contains common properties and methods associated with this node.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-----------------------------------------+-------------+-------------------------------------------------------------------------------+
|
|
| :ref:`TextAlign<enum_Button_TextAlign>` | align | ``0`` (overrides :ref:`Button<class_Button_property_align>`) |
|
|
+-----------------------------------------+-------------+-------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | toggle_mode | ``true`` (overrides :ref:`BaseButton<class_BaseButton_property_toggle_mode>`) |
|
|
+-----------------------------------------+-------------+-------------------------------------------------------------------------------+
|
|
|
|
Theme Properties
|
|
----------------
|
|
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color<class_CheckButton_theme_color_font_color>` | ``Color( 0.88, 0.88, 0.88, 1 )`` |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color_disabled<class_CheckButton_theme_color_font_color_disabled>` | ``Color( 0.9, 0.9, 0.9, 0.2 )`` |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color_focus<class_CheckButton_theme_color_font_color_focus>` | ``Color( 0.94, 0.94, 0.94, 1 )`` |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color_hover<class_CheckButton_theme_color_font_color_hover>` | ``Color( 0.94, 0.94, 0.94, 1 )`` |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color_hover_pressed<class_CheckButton_theme_color_font_color_hover_pressed>` | ``Color( 1, 1, 1, 1 )`` |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color_pressed<class_CheckButton_theme_color_font_color_pressed>` | ``Color( 1, 1, 1, 1 )`` |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`check_vadjust<class_CheckButton_theme_constant_check_vadjust>` | ``0`` |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`hseparation<class_CheckButton_theme_constant_hseparation>` | ``4`` |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Font<class_Font>` | :ref:`font<class_CheckButton_theme_font_font>` | |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Texture<class_Texture>` | :ref:`off<class_CheckButton_theme_icon_off>` | |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Texture<class_Texture>` | :ref:`off_disabled<class_CheckButton_theme_icon_off_disabled>` | |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Texture<class_Texture>` | :ref:`on<class_CheckButton_theme_icon_on>` | |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Texture<class_Texture>` | :ref:`on_disabled<class_CheckButton_theme_icon_on_disabled>` | |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`disabled<class_CheckButton_theme_style_disabled>` | |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_CheckButton_theme_style_focus>` | |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_CheckButton_theme_style_hover>` | |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover_pressed<class_CheckButton_theme_style_hover_pressed>` | |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_CheckButton_theme_style_normal>` | |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`pressed<class_CheckButton_theme_style_pressed>` | |
|
|
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
|
|
|
|
Theme Property Descriptions
|
|
---------------------------
|
|
|
|
.. _class_CheckButton_theme_color_font_color:
|
|
|
|
- :ref:`Color<class_Color>` **font_color**
|
|
|
|
+-----------+----------------------------------+
|
|
| *Default* | ``Color( 0.88, 0.88, 0.88, 1 )`` |
|
|
+-----------+----------------------------------+
|
|
|
|
The ``CheckButton`` text's font color.
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_color_font_color_disabled:
|
|
|
|
- :ref:`Color<class_Color>` **font_color_disabled**
|
|
|
|
+-----------+---------------------------------+
|
|
| *Default* | ``Color( 0.9, 0.9, 0.9, 0.2 )`` |
|
|
+-----------+---------------------------------+
|
|
|
|
The ``CheckButton`` text's font color when it's disabled.
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_color_font_color_focus:
|
|
|
|
- :ref:`Color<class_Color>` **font_color_focus**
|
|
|
|
+-----------+----------------------------------+
|
|
| *Default* | ``Color( 0.94, 0.94, 0.94, 1 )`` |
|
|
+-----------+----------------------------------+
|
|
|
|
The ``CheckButton`` text's font color when it's focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_color_font_color_hover:
|
|
|
|
- :ref:`Color<class_Color>` **font_color_hover**
|
|
|
|
+-----------+----------------------------------+
|
|
| *Default* | ``Color( 0.94, 0.94, 0.94, 1 )`` |
|
|
+-----------+----------------------------------+
|
|
|
|
The ``CheckButton`` text's font color when it's hovered.
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_color_font_color_hover_pressed:
|
|
|
|
- :ref:`Color<class_Color>` **font_color_hover_pressed**
|
|
|
|
+-----------+-------------------------+
|
|
| *Default* | ``Color( 1, 1, 1, 1 )`` |
|
|
+-----------+-------------------------+
|
|
|
|
The ``CheckButton`` text's font color when it's hovered and pressed.
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_color_font_color_pressed:
|
|
|
|
- :ref:`Color<class_Color>` **font_color_pressed**
|
|
|
|
+-----------+-------------------------+
|
|
| *Default* | ``Color( 1, 1, 1, 1 )`` |
|
|
+-----------+-------------------------+
|
|
|
|
The ``CheckButton`` text's font color when it's pressed.
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_constant_check_vadjust:
|
|
|
|
- :ref:`int<class_int>` **check_vadjust**
|
|
|
|
+-----------+-------+
|
|
| *Default* | ``0`` |
|
|
+-----------+-------+
|
|
|
|
The vertical offset used when rendering the toggle icons (in pixels).
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_constant_hseparation:
|
|
|
|
- :ref:`int<class_int>` **hseparation**
|
|
|
|
+-----------+-------+
|
|
| *Default* | ``4`` |
|
|
+-----------+-------+
|
|
|
|
The separation between the toggle icon and the text (in pixels).
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_font_font:
|
|
|
|
- :ref:`Font<class_Font>` **font**
|
|
|
|
The :ref:`Font<class_Font>` to use for the ``CheckButton`` text.
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_icon_off:
|
|
|
|
- :ref:`Texture<class_Texture>` **off**
|
|
|
|
The icon to display when the ``CheckButton`` is unchecked.
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_icon_off_disabled:
|
|
|
|
- :ref:`Texture<class_Texture>` **off_disabled**
|
|
|
|
The icon to display when the ``CheckButton`` is unchecked and disabled.
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_icon_on:
|
|
|
|
- :ref:`Texture<class_Texture>` **on**
|
|
|
|
The icon to display when the ``CheckButton`` is checked.
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_icon_on_disabled:
|
|
|
|
- :ref:`Texture<class_Texture>` **on_disabled**
|
|
|
|
The icon to display when the ``CheckButton`` is checked and disabled.
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_style_disabled:
|
|
|
|
- :ref:`StyleBox<class_StyleBox>` **disabled**
|
|
|
|
The :ref:`StyleBox<class_StyleBox>` to display as a background when the ``CheckButton`` is disabled.
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_style_focus:
|
|
|
|
- :ref:`StyleBox<class_StyleBox>` **focus**
|
|
|
|
The :ref:`StyleBox<class_StyleBox>` to display as a background when the ``CheckButton`` is focused.
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_style_hover:
|
|
|
|
- :ref:`StyleBox<class_StyleBox>` **hover**
|
|
|
|
The :ref:`StyleBox<class_StyleBox>` to display as a background when the ``CheckButton`` is hovered.
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_style_hover_pressed:
|
|
|
|
- :ref:`StyleBox<class_StyleBox>` **hover_pressed**
|
|
|
|
The :ref:`StyleBox<class_StyleBox>` to display as a background when the ``CheckButton`` is hovered and pressed.
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_style_normal:
|
|
|
|
- :ref:`StyleBox<class_StyleBox>` **normal**
|
|
|
|
The :ref:`StyleBox<class_StyleBox>` to display as a background.
|
|
|
|
----
|
|
|
|
.. _class_CheckButton_theme_style_pressed:
|
|
|
|
- :ref:`StyleBox<class_StyleBox>` **pressed**
|
|
|
|
The :ref:`StyleBox<class_StyleBox>` to display as a background when the ``CheckButton`` is pressed.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|