godot-docs/classes/class_toolbutton.rst

: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>`

**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          |
+---------------------------------+---------------------+
| :ref:`Color<class_Color>`       | font_color_disabled |
+---------------------------------+---------------------+
| :ref:`Color<class_Color>`       | font_color_hover    |
+---------------------------------+---------------------+
| :ref:`Color<class_Color>`       | font_color_pressed  |
+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | hover               |
+---------------------------------+---------------------+
| :ref:`int<class_int>`           | hseparation         |
+---------------------------------+---------------------+
| :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