Files
godot-docs/classes/class_toolbutton.rst
T

56 lines
3.1 KiB
ReStructuredText

.. 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>`
**Category:** Core
Brief Description
-----------------
Flat button helper class.
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.878431, 0.878431, 0.878431, 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.941176, 0.941176, 0.941176, 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 | |
+---------------------------------+---------------------+------------------------------------------+
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