2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 01:03:48 +00:00
<class name= "SpinBox" inherits= "Range" version= "4.0" >
2017-09-12 20:42:36 +00:00
<brief_description >
Numerical input text field.
</brief_description>
<description >
SpinBox is a numerical input text field. It allows entering integers and floats.
2019-06-20 13:23:56 +00:00
[b]Example:[/b]
2020-11-27 23:33:15 +00:00
[codeblocks]
[gdscript]
2019-06-20 13:23:56 +00:00
var spin_box = SpinBox.new()
add_child(spin_box)
var line_edit = spin_box.get_line_edit()
line_edit.context_menu_enabled = false
spin_box.align = LineEdit.ALIGN_RIGHT
2020-11-27 23:33:15 +00:00
[/gdscript]
[csharp]
var spinBox = new SpinBox();
AddChild(spinBox);
var lineEdit = spinBox.GetLineEdit();
lineEdit.ContextMenuEnabled = false;
spinBox.Align = LineEdit.AlignEnum.Right;
[/csharp]
[/codeblocks]
2019-06-20 13:23:56 +00:00
The above code will create a [SpinBox], disable context menu on it and set the text alignment to right.
See [Range] class for more options over the [SpinBox].
2021-02-21 18:31:25 +00:00
[b]Note:[/b] [SpinBox] relies on an underlying [LineEdit] node. To theme a [SpinBox]'s background, add theme items for [LineEdit] and customize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<methods >
2020-01-12 13:30:21 +00:00
<method name= "apply" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2017-09-12 20:42:36 +00:00
<description >
2020-01-12 13:30:21 +00:00
Applies the current value of this [SpinBox].
2017-09-12 20:42:36 +00:00
</description>
2020-01-09 13:44:23 +00:00
</method>
2020-01-12 13:30:21 +00:00
<method name= "get_line_edit" >
2021-07-30 13:28:05 +00:00
<return type= "LineEdit" />
2020-01-09 13:44:23 +00:00
<description >
2020-01-12 13:30:21 +00:00
Returns the [LineEdit] instance from this [SpinBox]. You can use it to access properties and methods of [LineEdit].
2021-10-10 19:28:56 +00:00
[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property.
2020-01-09 13:44:23 +00:00
</description>
2017-09-12 20:42:36 +00:00
</method>
</methods>
<members >
2019-06-29 10:38:01 +00:00
<member name= "align" type= "int" setter= "set_align" getter= "get_align" enum= "LineEdit.Align" default= "0" >
2019-06-20 13:23:56 +00:00
Sets the text alignment of the [SpinBox].
2018-10-07 13:52:07 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "editable" type= "bool" setter= "set_editable" getter= "is_editable" default= "true" >
2019-06-20 13:23:56 +00:00
If [code]true[/code], the [SpinBox] will be editable. Otherwise, it will be read only.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "prefix" type= "String" setter= "set_prefix" getter= "get_prefix" default= """" >
2019-06-20 13:23:56 +00:00
Adds the specified [code]prefix[/code] string before the numerical value of the [SpinBox].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "suffix" type= "String" setter= "set_suffix" getter= "get_suffix" default= """" >
2020-05-05 17:00:12 +00:00
Adds the specified [code]suffix[/code] string after the numerical value of the [SpinBox].
2017-09-12 20:42:36 +00:00
</member>
2020-04-27 10:24:27 +00:00
<member name= "update_on_text_changed" type= "bool" setter= "set_update_on_text_changed" getter= "get_update_on_text_changed" default= "false" >
Sets the value of the [Range] for this [SpinBox] when the [LineEdit] text is [i]changed[/i] instead of [i]submitted[/i]. See [signal LineEdit.text_changed] and [signal LineEdit.text_submitted].
</member>
2017-09-12 20:42:36 +00:00
</members>
<theme_items >
2021-08-04 16:54:41 +00:00
<theme_item name= "updown" data_type= "icon" type= "Texture2D" >
2020-02-12 08:59:06 +00:00
Sets a custom [Texture2D] for up and down arrows of the [SpinBox].
2017-09-12 20:42:36 +00:00
</theme_item>
</theme_items>
</class>
