227 lines
9 KiB
ReStructuredText
227 lines
9 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ToolButton.xml.
|
|
|
|
.. _class_ToolButton:
|
|
|
|
ToolButton
|
|
==========
|
|
|
|
**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>`
|
|
|
|
Flat button helper class.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
This is a helper class to generate a flat :ref:`Button<class_Button>` (see :ref:`Button.flat<class_Button_property_flat>`), creating a **ToolButton** is equivalent to:
|
|
|
|
::
|
|
|
|
var btn = Button.new()
|
|
btn.flat = true
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------+------+----------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | flat | ``true`` (overrides :ref:`Button<class_Button_property_flat>`) |
|
|
+-------------------------+------+----------------------------------------------------------------+
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Theme Properties
|
|
----------------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+---------------------------------+------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color<class_ToolButton_theme_color_font_color>` | ``Color( 0.88, 0.88, 0.88, 1 )`` |
|
|
+---------------------------------+------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color_disabled<class_ToolButton_theme_color_font_color_disabled>` | ``Color( 0.9, 0.95, 1, 0.3 )`` |
|
|
+---------------------------------+------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color_focus<class_ToolButton_theme_color_font_color_focus>` | ``Color( 0.94, 0.94, 0.94, 1 )`` |
|
|
+---------------------------------+------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color_hover<class_ToolButton_theme_color_font_color_hover>` | ``Color( 0.94, 0.94, 0.94, 1 )`` |
|
|
+---------------------------------+------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color_pressed<class_ToolButton_theme_color_font_color_pressed>` | ``Color( 1, 1, 1, 1 )`` |
|
|
+---------------------------------+------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`hseparation<class_ToolButton_theme_constant_hseparation>` | ``3`` |
|
|
+---------------------------------+------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Font<class_Font>` | :ref:`font<class_ToolButton_theme_font_font>` | |
|
|
+---------------------------------+------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`disabled<class_ToolButton_theme_style_disabled>` | |
|
|
+---------------------------------+------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_ToolButton_theme_style_focus>` | |
|
|
+---------------------------------+------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_ToolButton_theme_style_hover>` | |
|
|
+---------------------------------+------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_ToolButton_theme_style_normal>` | |
|
|
+---------------------------------+------------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`pressed<class_ToolButton_theme_style_pressed>` | |
|
|
+---------------------------------+------------------------------------------------------------------------------+----------------------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Theme Property Descriptions
|
|
---------------------------
|
|
|
|
.. _class_ToolButton_theme_color_font_color:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Color<class_Color>` **font_color** = ``Color( 0.88, 0.88, 0.88, 1 )``
|
|
|
|
Default text :ref:`Color<class_Color>` of the **ToolButton**.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ToolButton_theme_color_font_color_disabled:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Color<class_Color>` **font_color_disabled** = ``Color( 0.9, 0.95, 1, 0.3 )``
|
|
|
|
Text :ref:`Color<class_Color>` used when the **ToolButton** is disabled.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ToolButton_theme_color_font_color_focus:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Color<class_Color>` **font_color_focus** = ``Color( 0.94, 0.94, 0.94, 1 )``
|
|
|
|
Text :ref:`Color<class_Color>` used when the **ToolButton** is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ToolButton_theme_color_font_color_hover:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Color<class_Color>` **font_color_hover** = ``Color( 0.94, 0.94, 0.94, 1 )``
|
|
|
|
Text :ref:`Color<class_Color>` used when the **ToolButton** is being hovered.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ToolButton_theme_color_font_color_pressed:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Color<class_Color>` **font_color_pressed** = ``Color( 1, 1, 1, 1 )``
|
|
|
|
Text :ref:`Color<class_Color>` used when the **ToolButton** is being pressed.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ToolButton_theme_constant_hseparation:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`int<class_int>` **hseparation** = ``3``
|
|
|
|
The horizontal space between **ToolButton**'s icon and text.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ToolButton_theme_font_font:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Font<class_Font>` **font**
|
|
|
|
:ref:`Font<class_Font>` of the **ToolButton**'s text.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ToolButton_theme_style_disabled:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **disabled**
|
|
|
|
:ref:`StyleBox<class_StyleBox>` used when the **ToolButton** is disabled.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ToolButton_theme_style_focus:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **focus**
|
|
|
|
:ref:`StyleBox<class_StyleBox>` used when the **ToolButton** is focused. It is displayed over the current :ref:`StyleBox<class_StyleBox>`, so using :ref:`StyleBoxEmpty<class_StyleBoxEmpty>` will just disable the focus visual effect.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ToolButton_theme_style_hover:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **hover**
|
|
|
|
:ref:`StyleBox<class_StyleBox>` used when the **ToolButton** is being hovered.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ToolButton_theme_style_normal:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **normal**
|
|
|
|
Default :ref:`StyleBox<class_StyleBox>` for the **ToolButton**.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ToolButton_theme_style_pressed:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **pressed**
|
|
|
|
:ref:`StyleBox<class_StyleBox>` used when the **ToolButton** is being 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.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|