summaryrefslogtreecommitdiff
path: root/doc/classes/EditorSpinSlider.xml
blob: d270d32df7be385196d2d0a4f1038823e12c022b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorSpinSlider" inherits="Range" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Godot editor's control for editing numeric values.
	</brief_description>
	<description>
		This [Control] node is used in the editor's Inspector dock to allow editing of numeric values. Can be used with [EditorInspectorPlugin] to recreate the same behavior.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="flat" type="bool" setter="set_flat" getter="is_flat" default="false">
			If [code]true[/code], the slider will not draw background.
		</member>
		<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" overrides="Control" enum="Control.FocusMode" default="2" />
		<member name="hide_slider" type="bool" setter="set_hide_slider" getter="is_hiding_slider" default="false">
			If [code]true[/code], the slider is hidden.
		</member>
		<member name="label" type="String" setter="set_label" getter="get_label" default="&quot;&quot;">
			The text that displays to the left of the value.
		</member>
		<member name="read_only" type="bool" setter="set_read_only" getter="is_read_only" default="false">
			If [code]true[/code], the slider can't be interacted with.
		</member>
		<member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags" overrides="Control" default="1" />
		<member name="step" type="float" setter="set_step" getter="get_step" overrides="Range" default="1.0" />
		<member name="suffix" type="String" setter="set_suffix" getter="get_suffix" default="&quot;&quot;">
			The suffix to display after the value (in a faded color). This should generally be a plural word. You may have to use an abbreviation if the suffix is too long to be displayed.
		</member>
	</members>
	<signals>
		<signal name="grabbed">
			<description>
				Emitted when the spinner/slider is grabbed.
			</description>
		</signal>
		<signal name="ungrabbed">
			<description>
				Emitted when the spinner/slider is ungrabbed.
			</description>
		</signal>
		<signal name="value_focus_entered">
			<description>
				Emitted when the value form gains focus.
			</description>
		</signal>
		<signal name="value_focus_exited">
			<description>
				Emitted when the value form loses focus.
			</description>
		</signal>
	</signals>
</class>