summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2020-06-19 20:49:04 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2020-06-19 20:49:49 +0200
commit31b7f02a29cdf4f1c30cfc37962f43f67380b9ad (patch)
tree1c0de1bac35046915575687e8d8993643d372474 /doc/classes
parentcb9d02a8d1b5bb71abcec6be0e75002c5ea656c4 (diff)
Remove ToolButton in favor of Button
ToolButton has no redeeming differences with Button; it's just a Button with the Flat property enabled by default. Removing it avoids some confusion when creating GUIs. Existing ToolButtons will be converted to Buttons, but the Flat property won't be enabled automatically. This closes https://github.com/godotengine/godot-proposals/issues/1081.
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/EditorPlugin.xml2
-rw-r--r--doc/classes/ToolButton.xml57
2 files changed, 1 insertions, 58 deletions
diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml
index 19583fca28..2fa791a9df 100644
--- a/doc/classes/EditorPlugin.xml
+++ b/doc/classes/EditorPlugin.xml
@@ -22,7 +22,7 @@
</description>
</method>
<method name="add_control_to_bottom_panel">
- <return type="ToolButton">
+ <return type="Button">
</return>
<argument index="0" name="control" type="Control">
</argument>
diff --git a/doc/classes/ToolButton.xml b/doc/classes/ToolButton.xml
deleted file mode 100644
index f78627b163..0000000000
--- a/doc/classes/ToolButton.xml
+++ /dev/null
@@ -1,57 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<class name="ToolButton" inherits="Button" version="4.0">
- <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" override="true" default="true" />
- </members>
- <constants>
- </constants>
- <theme_items>
- <theme_item name="disabled" type="StyleBox">
- [StyleBox] used when the [ToolButton] is disabled.
- </theme_item>
- <theme_item name="focus" 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="font" type="Font">
- [Font] of the [ToolButton]'s text.
- </theme_item>
- <theme_item name="font_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" 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_hover" 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" type="Color" default="Color( 1, 1, 1, 1 )">
- Text [Color] used when the [ToolButton] is being pressed.
- </theme_item>
- <theme_item name="hover" type="StyleBox">
- [StyleBox] used when the [ToolButton] is being hovered.
- </theme_item>
- <theme_item name="hseparation" type="int" default="3">
- The horizontal space between [ToolButton]'s icon and text.
- </theme_item>
- <theme_item name="normal" type="StyleBox">
- Default [StyleBox] for the [ToolButton].
- </theme_item>
- <theme_item name="pressed" type="StyleBox">
- [StyleBox] used when the [ToolButton] is being pressed.
- </theme_item>
- </theme_items>
-</class>