mirror of
https://github.com/godotengine/godot.git
synced 2024-11-27 09:16:35 +08:00
78 lines
4.2 KiB
XML
78 lines
4.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="SpinBox" inherits="Range" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<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]
|
|
[codeblocks]
|
|
[gdscript]
|
|
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.horizontal_alignment = LineEdit.HORIZONTAL_ALIGNMENT_RIGHT
|
|
[/gdscript]
|
|
[csharp]
|
|
var spinBox = new SpinBox();
|
|
AddChild(spinBox);
|
|
var lineEdit = spinBox.GetLineEdit();
|
|
lineEdit.ContextMenuEnabled = false;
|
|
spinBox.AlignHorizontal = LineEdit.HorizontalAlignEnum.Right;
|
|
[/csharp]
|
|
[/codeblocks]
|
|
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.
|
|
[b]Note:[/b] If you want to implement drag and drop for the underlying [LineEdit], you can use [method Control.set_drag_forwarding] on the node returned by [method get_line_edit].
|
|
</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].
|
|
[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.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="alignment" type="int" setter="set_horizontal_alignment" getter="get_horizontal_alignment" enum="HorizontalAlignment" default="0">
|
|
Changes the alignment of the underlying [LineEdit].
|
|
</member>
|
|
<member name="custom_arrow_step" type="float" setter="set_custom_arrow_step" getter="get_custom_arrow_step" default="0.0">
|
|
If not [code]0[/code], [code]value[/code] will always be rounded to a multiple of [code]custom_arrow_step[/code] when interacting with the arrow buttons 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="select_all_on_focus" type="bool" setter="set_select_all_on_focus" getter="is_select_all_on_focus" default="false">
|
|
If [code]true[/code], the [SpinBox] will select the whole text when the [LineEdit] gains focus. Clicking the up and down arrows won't trigger this behavior.
|
|
</member>
|
|
<member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags" overrides="Control" enum="Control.SizeFlags" 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="""">
|
|
Adds the specified [code]suffix[/code] string after the numerical value of the [SpinBox].
|
|
</member>
|
|
<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>
|
|
</members>
|
|
<theme_items>
|
|
<theme_item name="updown" data_type="icon" type="Texture2D">
|
|
Sets a custom [Texture2D] for up and down arrows of the [SpinBox].
|
|
</theme_item>
|
|
</theme_items>
|
|
</class>
|