godot/doc/classes/ToolButton.xml
2022-08-05 18:51:38 +02:00

61 lines
2.7 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ToolButton" inherits="Button" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Flat button helper class.
</brief_description>
<description>
This is a helper class to generate a flat [Button] (see [member Button.flat]), creating a [ToolButton] is equivalent to:
[codeblock]
var btn = Button.new()
btn.flat = true
[/codeblock]
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="flat" type="bool" setter="set_flat" getter="is_flat" overrides="Button" default="true" />
</members>
<constants>
</constants>
<theme_items>
<theme_item name="font_color" data_type="color" type="Color" default="Color( 0.88, 0.88, 0.88, 1 )">
Default text [Color] of the [ToolButton].
</theme_item>
<theme_item name="font_color_disabled" data_type="color" type="Color" default="Color( 0.9, 0.95, 1, 0.3 )">
Text [Color] used when the [ToolButton] is disabled.
</theme_item>
<theme_item name="font_color_focus" data_type="color" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )">
Text [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.
</theme_item>
<theme_item name="font_color_hover" data_type="color" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )">
Text [Color] used when the [ToolButton] is being hovered.
</theme_item>
<theme_item name="font_color_pressed" data_type="color" type="Color" default="Color( 1, 1, 1, 1 )">
Text [Color] used when the [ToolButton] is being pressed.
</theme_item>
<theme_item name="hseparation" data_type="constant" type="int" default="3">
The horizontal space between [ToolButton]'s icon and text.
</theme_item>
<theme_item name="font" data_type="font" type="Font">
[Font] of the [ToolButton]'s text.
</theme_item>
<theme_item name="disabled" data_type="style" type="StyleBox">
[StyleBox] used when the [ToolButton] is disabled.
</theme_item>
<theme_item name="focus" data_type="style" type="StyleBox">
[StyleBox] used when the [ToolButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect.
</theme_item>
<theme_item name="hover" data_type="style" type="StyleBox">
[StyleBox] used when the [ToolButton] is being hovered.
</theme_item>
<theme_item name="normal" data_type="style" type="StyleBox">
Default [StyleBox] for the [ToolButton].
</theme_item>
<theme_item name="pressed" data_type="style" type="StyleBox">
[StyleBox] used when the [ToolButton] is being pressed.
</theme_item>
</theme_items>
</class>