Table of Contents

Class SpinBox

An input field for numbers.

Inheritance
SpinBox

Remarks

SpinBox is a numerical input text field. It allows entering integers and floating-point numbers.

Example: Create a SpinBox, disable its context menu and set its text alignment to right.

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

See Range class for more options over the SpinBox.

Note: With the SpinBox's context menu disabled, you can right-click the bottom half of the spinbox to set the value to its minimum, while right-clicking the top half sets the value to its maximum.

Note: SpinBox relies on an underlying LineEdit node. To theme a SpinBox's background, add theme items for LineEdit and customize them. The LineEdit has the SpinBoxInnerLineEdit theme variation, so that you can give it a distinct appearance from regular LineEdits.

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

alignment

Changes the alignment of the underlying LineEdit.

var alignment : int = 0

Property Value

int

Remarks

  • void set_horizontal_alignment(int value)
  • int get_horizontal_alignment

custom_arrow_step

If not 0, value will always be rounded to a multiple of custom_arrow_step when interacting with the arrow buttons of the SpinBox.

var custom_arrow_step : float = 0.0

Property Value

float

Remarks

  • void set_custom_arrow_step(float value)
  • float get_custom_arrow_step

editable

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

var editable : bool = true

Property Value

bool

Remarks

  • void set_editable(bool value)
  • bool is_editable

prefix

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

var prefix : String = ""

Property Value

String

Remarks

select_all_on_focus

If true, the SpinBox will select the whole text when the LineEdit gains focus. Clicking the up and down arrows won't trigger this behavior.

var select_all_on_focus : bool = false

Property Value

bool

Remarks

  • void set_select_all_on_focus(bool value)
  • bool is_select_all_on_focus

suffix

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

var suffix : String = ""

Property Value

String

Remarks

update_on_text_changed

Sets the value of the Range for this SpinBox when the LineEdit text is changed instead of submitted. See LineEdit.text_changed and LineEdit.text_submitted.

var update_on_text_changed : bool = false

Property Value

bool

Remarks

  • void set_update_on_text_changed(bool value)
  • bool get_update_on_text_changed

down_disabled_icon_modulate

Theme Property

Down button icon modulation color, when the button is disabled.

 = ``Color(0.875, 0.875, 0.875, 0.5)``

Property Value

Color

down_hover_icon_modulate

Theme Property

Down button icon modulation color, when the button is hovered.

 = ``Color(0.95, 0.95, 0.95, 1)``

Property Value

Color

down_icon_modulate

Theme Property

Down button icon modulation color.

 = ``Color(0.875, 0.875, 0.875, 1)``

Property Value

Color

down_pressed_icon_modulate

Theme Property

Down button icon modulation color, when the button is being pressed.

 = ``Color(0.95, 0.95, 0.95, 1)``

Property Value

Color

up_disabled_icon_modulate

Theme Property

Up button icon modulation color, when the button is disabled.

 = ``Color(0.875, 0.875, 0.875, 0.5)``

Property Value

Color

up_hover_icon_modulate

Theme Property

Up button icon modulation color, when the button is hovered.

 = ``Color(0.95, 0.95, 0.95, 1)``

Property Value

Color

up_icon_modulate

Theme Property

Up button icon modulation color.

 = ``Color(0.875, 0.875, 0.875, 1)``

Property Value

Color

up_pressed_icon_modulate

Theme Property

Up button icon modulation color, when the button is being pressed.

 = ``Color(0.95, 0.95, 0.95, 1)``

Property Value

Color

buttons_vertical_separation

Theme Property

Vertical separation between the up and down buttons.

 = ``0``

Property Value

int

buttons_width

Theme Property

Width of the up and down buttons. If smaller than any icon set on the buttons, the respective icon may overlap neighboring elements. If smaller than 0, the width is automatically adjusted from the icon size.

 = ``16``

Property Value

int

field_and_buttons_separation

Theme Property

Width of the horizontal separation between the text input field (LineEdit) and the buttons.

 = ``2``

Property Value

int

set_min_buttons_width_from_icons

Theme Property

If not 0, the minimum button width corresponds to the widest of all icons set on those buttons, even if buttons_width is smaller.

 = ``1``

Property Value

int

down

Theme Property

Down button icon, displayed in the middle of the down (value-decreasing) button.

Texture2D down

Property Value

Texture2D

down_disabled

Theme Property

Down button icon when the button is disabled.

Texture2D down_disabled

Property Value

Texture2D

down_hover

Theme Property

Down button icon when the button is hovered.

Texture2D down_hover

Property Value

Texture2D

down_pressed

Theme Property

Down button icon when the button is being pressed.

Texture2D down_pressed

Property Value

Texture2D

up

Theme Property

Up button icon, displayed in the middle of the up (value-increasing) button.

Texture2D up

Property Value

Texture2D

up_disabled

Theme Property

Up button icon when the button is disabled.

Texture2D up_disabled

Property Value

Texture2D

up_hover

Theme Property

Up button icon when the button is hovered.

Texture2D up_hover

Property Value

Texture2D

up_pressed

Theme Property

Up button icon when the button is being pressed.

Texture2D up_pressed

Property Value

Texture2D

updown

Theme Property

Single texture representing both the up and down buttons icons. It is displayed in the middle of the buttons and does not change upon interaction. It is recommended to use individual up and down graphics for better usability. This can also be used as additional decoration between the two buttons.

Texture2D updown

Property Value

Texture2D

down_background

Theme Property

Background style of the down button.

StyleBox down_background

Property Value

StyleBox

down_background_disabled

Theme Property

Background style of the down button when disabled.

StyleBox down_background_disabled

Property Value

StyleBox

down_background_hovered

Theme Property

Background style of the down button when hovered.

StyleBox down_background_hovered

Property Value

StyleBox

down_background_pressed

Theme Property

Background style of the down button when being pressed.

StyleBox down_background_pressed

Property Value

StyleBox

field_and_buttons_separator

Theme Property

StyleBox drawn in the space occupied by the separation between the input field and the buttons.

StyleBox field_and_buttons_separator

Property Value

StyleBox

up_background

Theme Property

Background style of the up button.

StyleBox up_background

Property Value

StyleBox

up_background_disabled

Theme Property

Background style of the up button when disabled.

StyleBox up_background_disabled

Property Value

StyleBox

up_background_hovered

Theme Property

Background style of the up button when hovered.

StyleBox up_background_hovered

Property Value

StyleBox

up_background_pressed

Theme Property

Background style of the up button when being pressed.

StyleBox up_background_pressed

Property Value

StyleBox

up_down_buttons_separator

Theme Property

StyleBox drawn in the space occupied by the separation between the up and down buttons.

StyleBox up_down_buttons_separator

Property Value

StyleBox

Methods

apply

Applies the current value of this SpinBox.

void apply

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 visible property.

LineEdit get_line_edit