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.
Properties
| ||
| ||
| ||
|
Methods
void | apply ( ) |
get_line_edit ( ) |
Theme Properties
updown |
Property Descriptions
Align align
Default |
|
Setter | set_align(value) |
Getter | get_align() |
Sets the text alignment of the SpinBox
.
bool editable
Default |
|
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.
© 2014–2021 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
https://docs.godotengine.org/en/3.3/classes/class_spinbox.html