godot/doc/classes/ToolButton.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ToolButton" inherits="Button" version="3.4">
	<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" 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="font" data_type="font" type="Font">
			[Font] of the [ToolButton]'s text.
		</theme_item>
		<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="hover" data_type="style" type="StyleBox">
			[StyleBox] used when the [ToolButton] is being hovered.
		</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="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>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
doc: Update classref headers with 3.4 version 2021-04-26 11:14:51 +00:00			`<class name="ToolButton" inherits="Button" version="3.4">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`<brief_description>`
			`Flat button helper class.`
			`</brief_description>`
			`<description>`
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class. 2019-03-29 22:37:35 +00:00			`This is a helper class to generate a flat [Button] (see [member Button.flat]), creating a [ToolButton] is equivalent to:`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`[codeblock]`
			`var btn = Button.new()`
doc: Fix wrong references found by Sphinx and new makerst.py 2019-01-07 10:46:26 +00:00			`btn.flat = true`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`[/codeblock]`
			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`</methods>`
Run doctool after overridden properties changes 2019-09-03 10:44:58 +00:00			`<members>`
doc: Fix parsing of self-closing XML tags Follow-up to #31925, `<member />` tags just before `</members>` would cause a parsing issue, and we'd never notice that we're no longer parsing members. Also added space before closing `/>`. 2019-09-24 11:34:03 +00:00			`<member name="flat" type="bool" setter="set_flat" getter="is_flat" override="true" default="true" />`
Run doctool after overridden properties changes 2019-09-03 10:44:58 +00:00			`</members>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`<constants>`
			`</constants>`
			`<theme_items>`
Add theme item descriptions to the online documentation 2021-08-06 15:07:21 +00:00			`<theme_item name="disabled" data_type="style" type="StyleBox">`
Document theme_items of multiple classes 2020-01-27 01:15:37 +00:00			`[StyleBox] used when the [ToolButton] is disabled.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-06 15:07:21 +00:00			`<theme_item name="focus" data_type="style" type="StyleBox">`
Completes doc for button classes (cherry picked from commit db42d5ddffd707017097cc864b0015a11e2fc81e) 2020-02-04 07:46:01 +00:00			`[StyleBox] used when the [ToolButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-06 15:07:21 +00:00			`<theme_item name="font" data_type="font" type="Font">`
Document theme_items of multiple classes 2020-01-27 01:15:37 +00:00			`[Font] of the [ToolButton]'s text.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-06 15:07:21 +00:00			`<theme_item name="font_color" data_type="color" type="Color" default="Color( 0.88, 0.88, 0.88, 1 )">`
Document theme_items of multiple classes 2020-01-27 01:15:37 +00:00			`Default text [Color] of the [ToolButton].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-06 15:07:21 +00:00			`<theme_item name="font_color_disabled" data_type="color" type="Color" default="Color( 0.9, 0.95, 1, 0.3 )">`
Document theme_items of multiple classes 2020-01-27 01:15:37 +00:00			`Text [Color] used when the [ToolButton] is disabled.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</theme_item>`
Add focus font color to Button and derivatives 2021-10-26 13:32:15 +00:00			`<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>`
Add theme item descriptions to the online documentation 2021-08-06 15:07:21 +00:00			`<theme_item name="font_color_hover" data_type="color" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )">`
Document theme_items of multiple classes 2020-01-27 01:15:37 +00:00			`Text [Color] used when the [ToolButton] is being hovered.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-06 15:07:21 +00:00			`<theme_item name="font_color_pressed" data_type="color" type="Color" default="Color( 1, 1, 1, 1 )">`
Document theme_items of multiple classes 2020-01-27 01:15:37 +00:00			`Text [Color] used when the [ToolButton] is being pressed.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-06 15:07:21 +00:00			`<theme_item name="hover" data_type="style" type="StyleBox">`
Document theme_items of multiple classes 2020-01-27 01:15:37 +00:00			`[StyleBox] used when the [ToolButton] is being hovered.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-06 15:07:21 +00:00			`<theme_item name="hseparation" data_type="constant" type="int" default="3">`
Document theme_items of multiple classes 2020-01-27 01:15:37 +00:00			`The horizontal space between [ToolButton]'s icon and text.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-06 15:07:21 +00:00			`<theme_item name="normal" data_type="style" type="StyleBox">`
Document theme_items of multiple classes 2020-01-27 01:15:37 +00:00			`Default [StyleBox] for the [ToolButton].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</theme_item>`
Add theme item descriptions to the online documentation 2021-08-06 15:07:21 +00:00			`<theme_item name="pressed" data_type="style" type="StyleBox">`
Document theme_items of multiple classes 2020-01-27 01:15:37 +00:00			`[StyleBox] used when the [ToolButton] is being pressed.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</theme_item>`
			`</theme_items>`
			`</class>`