58 lines
2.2 KiB
XML
58 lines
2.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="SpinBox" inherits="Range" version="3.4">
|
|
<brief_description>
|
|
Numerical input text field.
|
|
</brief_description>
|
|
<description>
|
|
SpinBox is a numerical input text field. It allows entering integers and floats.
|
|
[b]Example:[/b]
|
|
[codeblock]
|
|
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
|
|
[/codeblock]
|
|
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].
|
|
[b]Note:[/b] [SpinBox] relies on an underlying [LineEdit] node. To theme a [SpinBox]'s background, add theme items for [LineEdit] and customize them.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="apply">
|
|
<return type="void" />
|
|
<description>
|
|
Applies the current value of this [SpinBox].
|
|
</description>
|
|
</method>
|
|
<method name="get_line_edit">
|
|
<return type="LineEdit" />
|
|
<description>
|
|
Returns the [LineEdit] instance from this [SpinBox]. You can use it to access properties and methods of [LineEdit].
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="align" type="int" setter="set_align" getter="get_align" enum="LineEdit.Align" default="0">
|
|
Sets the text alignment of the [SpinBox].
|
|
</member>
|
|
<member name="editable" type="bool" setter="set_editable" getter="is_editable" default="true">
|
|
If [code]true[/code], the [SpinBox] will be editable. Otherwise, it will be read only.
|
|
</member>
|
|
<member name="prefix" type="String" setter="set_prefix" getter="get_prefix" default="""">
|
|
Adds the specified [code]prefix[/code] string before the numerical value of the [SpinBox].
|
|
</member>
|
|
<member name="suffix" type="String" setter="set_suffix" getter="get_suffix" default="""">
|
|
Adds the specified [code]suffix[/code] string after the numerical value of the [SpinBox].
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
<theme_items>
|
|
<theme_item name="updown" type="Texture">
|
|
Sets a custom [Texture] for up and down arrows of the [SpinBox].
|
|
</theme_item>
|
|
</theme_items>
|
|
</class>
|