SpinBox

SpinBox

Inherits: Range < Control < CanvasItem < Node < Object

Numerical input text field.

Description

SpinBox is a numerical input text field. It allows entering integers and floats.

Example:

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

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.

Note: SpinBox relies on an underlying LineEdit node. To theme a SpinBox‘s background, add theme items for LineEdit and customize them.

Note: If you want to implement drag and drop for the underlying LineEdit, you can use Control.set_drag_forwarding on the node returned by get_line_edit.

Properties

Align	align	`0`
bool	editable	`true`
String	prefix	`“”`
String	suffix	`“”`

Methods

void	apply ( )
LineEdit	get_line_edit ( )

Theme Properties

Texture

updown

Property Descriptions

Align align

Default	`0`
Setter	set_align(value)
Getter	get_align()

Sets the text alignment of the SpinBox.

bool editable

Default	`true`
Setter	set_editable(value)
Getter	is_editable()

If true, the SpinBox will be editable. Otherwise, it will be read only.

String prefix

Default	`“”`
Setter	set_prefix(value)
Getter	get_prefix()

Adds the specified prefix string before the numerical value of the SpinBox.

String suffix

Default	`“”`
Setter	set_suffix(value)
Getter	get_suffix()

Adds the specified suffix string after the numerical value of the SpinBox.

Method Descriptions

void apply ( )

Applies the current value of this SpinBox.

LineEdit get_line_edit ( )

Returns the LineEdit instance from this SpinBox. You can use it to access properties and methods of LineEdit.

Warning: 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 CanvasItem.visible property.

Theme Property Descriptions

Texture updown

Sets a custom Texture for up and down arrows of the SpinBox.