Files
godot-docs/classes/class_toolbutton.rst
2020-09-15 15:09:00 +02:00

63 lines
3.4 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ToolButton.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _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.
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
Properties
----------
+-------------------------+------+------------------------------+
| :ref:`bool<class_bool>` | flat | ``true`` *(parent override)* |
+-------------------------+------+------------------------------+
Theme Properties
----------------
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled | |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+---------------------+------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.88, 0.88, 0.88, 1 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.95, 1, 0.3 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+---------------------+------------------------------+
| :ref:`int<class_int>` | hseparation | 3 |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | 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.)`