:github_url: hide .. meta:: :keywords: number, numeric, input .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SpinBox.xml. .. _class_SpinBox: SpinBox ======= **Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` An input field for numbers. .. rst-class:: classref-introduction-group Description ----------- **SpinBox** is a numerical input text field. It allows entering integers and floating-point numbers. The **SpinBox** also has up and down buttons that can be clicked increase or decrease the value. The value can also be changed by dragging the mouse up or down over the **SpinBox**'s arrows. Additionally, mathematical expressions can be entered. These are evaluated when the user presses :kbd:`Enter` while editing the **SpinBox**'s text field. This uses the :ref:`Expression` class to parse and evaluate the expression. The result of the expression is then set as the value of the **SpinBox**. Some examples of valid expressions are ``5 + 2 * 3``, ``pow(2, 4)``, and ``PI + sin(0.5)``. Expressions are case-sensitive. \ **Example:** Create a **SpinBox**, disable its context menu and set its text alignment to right. .. tabs:: .. code-tab:: 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 .. code-tab:: csharp var spinBox = new SpinBox(); AddChild(spinBox); var lineEdit = spinBox.GetLineEdit(); lineEdit.ContextMenuEnabled = false; spinBox.AlignHorizontal = LineEdit.HorizontalAlignEnum.Right; See :ref:`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 :ref:`LineEdit` node. To theme a **SpinBox**'s background, add theme items for :ref:`LineEdit` and customize them. The :ref:`LineEdit` has the ``SpinBoxInnerLineEdit`` theme variation, so that you can give it a distinct appearance from regular :ref:`LineEdit`\ s. \ **Note:** If you want to implement drag and drop for the underlying :ref:`LineEdit`, you can use :ref:`Control.set_drag_forwarding()` on the node returned by :ref:`get_line_edit()`. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`HorizontalAlignment` | :ref:`alignment` | ``0`` | +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`float` | :ref:`custom_arrow_step` | ``0.0`` | +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editable` | ``true`` | +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`String` | :ref:`prefix` | ``""`` | +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`select_all_on_focus` | ``false`` | +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | |bitfield|\[:ref:`SizeFlags`\] | size_flags_vertical | ``1`` (overrides :ref:`Control`) | +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`float` | step | ``1.0`` (overrides :ref:`Range`) | +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`String` | :ref:`suffix` | ``""`` | +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`update_on_text_changed` | ``false`` | +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------+----------------------------------------------------------------+ | |void| | :ref:`apply`\ (\ ) | +---------------------------------+----------------------------------------------------------------+ | :ref:`LineEdit` | :ref:`get_line_edit`\ (\ ) | +---------------------------------+----------------------------------------------------------------+ .. rst-class:: classref-reftable-group Theme Properties ---------------- .. table:: :widths: auto +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`down_disabled_icon_modulate` | ``Color(0.875, 0.875, 0.875, 0.5)`` | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`down_hover_icon_modulate` | ``Color(0.95, 0.95, 0.95, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`down_icon_modulate` | ``Color(0.875, 0.875, 0.875, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`down_pressed_icon_modulate` | ``Color(0.95, 0.95, 0.95, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`up_disabled_icon_modulate` | ``Color(0.875, 0.875, 0.875, 0.5)`` | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`up_hover_icon_modulate` | ``Color(0.95, 0.95, 0.95, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`up_icon_modulate` | ``Color(0.875, 0.875, 0.875, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`up_pressed_icon_modulate` | ``Color(0.95, 0.95, 0.95, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`buttons_vertical_separation` | ``0`` | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`buttons_width` | ``16`` | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`field_and_buttons_separation` | ``2`` | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`set_min_buttons_width_from_icons` | ``1`` | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`down` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`down_disabled` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`down_hover` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`down_pressed` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`up` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`up_disabled` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`up_hover` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`up_pressed` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`updown` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`down_background` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`down_background_disabled` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`down_background_hovered` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`down_background_pressed` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`field_and_buttons_separator` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`up_background` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`up_background_disabled` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`up_background_hovered` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`up_background_pressed` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`up_down_buttons_separator` | | +-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_SpinBox_property_alignment: .. rst-class:: classref-property :ref:`HorizontalAlignment` **alignment** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_horizontal_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) - :ref:`HorizontalAlignment` **get_horizontal_alignment**\ (\ ) Changes the alignment of the underlying :ref:`LineEdit`. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_property_custom_arrow_step: .. rst-class:: classref-property :ref:`float` **custom_arrow_step** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_custom_arrow_step**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_custom_arrow_step**\ (\ ) If not ``0``, sets the step when interacting with the arrow buttons of the **SpinBox**. \ **Note:** :ref:`Range.value` will still be rounded to a multiple of :ref:`Range.step`. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_property_editable: .. rst-class:: classref-property :ref:`bool` **editable** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_editable**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_editable**\ (\ ) If ``true``, the **SpinBox** will be editable. Otherwise, it will be read only. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_property_prefix: .. rst-class:: classref-property :ref:`String` **prefix** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_prefix**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_prefix**\ (\ ) Adds the specified prefix string before the numerical value of the **SpinBox**. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_property_select_all_on_focus: .. rst-class:: classref-property :ref:`bool` **select_all_on_focus** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_select_all_on_focus**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_select_all_on_focus**\ (\ ) If ``true``, the **SpinBox** will select the whole text when the :ref:`LineEdit` gains focus. Clicking the up and down arrows won't trigger this behavior. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_property_suffix: .. rst-class:: classref-property :ref:`String` **suffix** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_suffix**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_suffix**\ (\ ) Adds the specified suffix string after the numerical value of the **SpinBox**. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_property_update_on_text_changed: .. rst-class:: classref-property :ref:`bool` **update_on_text_changed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_update_on_text_changed**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_update_on_text_changed**\ (\ ) Sets the value of the :ref:`Range` for this **SpinBox** when the :ref:`LineEdit` text is *changed* instead of *submitted*. See :ref:`LineEdit.text_changed` and :ref:`LineEdit.text_submitted`. \ **Note:** If set to ``true``, this will interfere with entering mathematical expressions in the **SpinBox**. The **SpinBox** will try to evaluate the expression as you type, which means symbols like a trailing ``+`` are removed immediately by the expression being evaluated. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_SpinBox_method_apply: .. rst-class:: classref-method |void| **apply**\ (\ ) :ref:`🔗` Applies the current value of this **SpinBox**. This is equivalent to pressing :kbd:`Enter` while editing the :ref:`LineEdit` used by the **SpinBox**. This will cause :ref:`LineEdit.text_submitted` to be emitted and its currently contained expression to be evaluated. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_method_get_line_edit: .. rst-class:: classref-method :ref:`LineEdit` **get_line_edit**\ (\ ) :ref:`🔗` Returns the :ref:`LineEdit` instance from this **SpinBox**. You can use it to access properties and methods of :ref:`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 :ref:`CanvasItem.visible` property. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Theme Property Descriptions --------------------------- .. _class_SpinBox_theme_color_down_disabled_icon_modulate: .. rst-class:: classref-themeproperty :ref:`Color` **down_disabled_icon_modulate** = ``Color(0.875, 0.875, 0.875, 0.5)`` :ref:`🔗` Down button icon modulation color, when the button is disabled. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_color_down_hover_icon_modulate: .. rst-class:: classref-themeproperty :ref:`Color` **down_hover_icon_modulate** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` Down button icon modulation color, when the button is hovered. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_color_down_icon_modulate: .. rst-class:: classref-themeproperty :ref:`Color` **down_icon_modulate** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` Down button icon modulation color. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_color_down_pressed_icon_modulate: .. rst-class:: classref-themeproperty :ref:`Color` **down_pressed_icon_modulate** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` Down button icon modulation color, when the button is being pressed. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_color_up_disabled_icon_modulate: .. rst-class:: classref-themeproperty :ref:`Color` **up_disabled_icon_modulate** = ``Color(0.875, 0.875, 0.875, 0.5)`` :ref:`🔗` Up button icon modulation color, when the button is disabled. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_color_up_hover_icon_modulate: .. rst-class:: classref-themeproperty :ref:`Color` **up_hover_icon_modulate** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` Up button icon modulation color, when the button is hovered. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_color_up_icon_modulate: .. rst-class:: classref-themeproperty :ref:`Color` **up_icon_modulate** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` Up button icon modulation color. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_color_up_pressed_icon_modulate: .. rst-class:: classref-themeproperty :ref:`Color` **up_pressed_icon_modulate** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` Up button icon modulation color, when the button is being pressed. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_constant_buttons_vertical_separation: .. rst-class:: classref-themeproperty :ref:`int` **buttons_vertical_separation** = ``0`` :ref:`🔗` Vertical separation between the up and down buttons. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_constant_buttons_width: .. rst-class:: classref-themeproperty :ref:`int` **buttons_width** = ``16`` :ref:`🔗` 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. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_constant_field_and_buttons_separation: .. rst-class:: classref-themeproperty :ref:`int` **field_and_buttons_separation** = ``2`` :ref:`🔗` Width of the horizontal separation between the text input field (:ref:`LineEdit`) and the buttons. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_constant_set_min_buttons_width_from_icons: .. rst-class:: classref-themeproperty :ref:`int` **set_min_buttons_width_from_icons** = ``1`` :ref:`🔗` If not ``0``, the minimum button width corresponds to the widest of all icons set on those buttons, even if :ref:`buttons_width` is smaller. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_icon_down: .. rst-class:: classref-themeproperty :ref:`Texture2D` **down** :ref:`🔗` Down button icon, displayed in the middle of the down (value-decreasing) button. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_icon_down_disabled: .. rst-class:: classref-themeproperty :ref:`Texture2D` **down_disabled** :ref:`🔗` Down button icon when the button is disabled. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_icon_down_hover: .. rst-class:: classref-themeproperty :ref:`Texture2D` **down_hover** :ref:`🔗` Down button icon when the button is hovered. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_icon_down_pressed: .. rst-class:: classref-themeproperty :ref:`Texture2D` **down_pressed** :ref:`🔗` Down button icon when the button is being pressed. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_icon_up: .. rst-class:: classref-themeproperty :ref:`Texture2D` **up** :ref:`🔗` Up button icon, displayed in the middle of the up (value-increasing) button. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_icon_up_disabled: .. rst-class:: classref-themeproperty :ref:`Texture2D` **up_disabled** :ref:`🔗` Up button icon when the button is disabled. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_icon_up_hover: .. rst-class:: classref-themeproperty :ref:`Texture2D` **up_hover** :ref:`🔗` Up button icon when the button is hovered. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_icon_up_pressed: .. rst-class:: classref-themeproperty :ref:`Texture2D` **up_pressed** :ref:`🔗` Up button icon when the button is being pressed. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_icon_updown: .. rst-class:: classref-themeproperty :ref:`Texture2D` **updown** :ref:`🔗` 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. If a valid icon is assigned, it will replace :ref:`up` and :ref:`down`. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_style_down_background: .. rst-class:: classref-themeproperty :ref:`StyleBox` **down_background** :ref:`🔗` Background style of the down button. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_style_down_background_disabled: .. rst-class:: classref-themeproperty :ref:`StyleBox` **down_background_disabled** :ref:`🔗` Background style of the down button when disabled. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_style_down_background_hovered: .. rst-class:: classref-themeproperty :ref:`StyleBox` **down_background_hovered** :ref:`🔗` Background style of the down button when hovered. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_style_down_background_pressed: .. rst-class:: classref-themeproperty :ref:`StyleBox` **down_background_pressed** :ref:`🔗` Background style of the down button when being pressed. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_style_field_and_buttons_separator: .. rst-class:: classref-themeproperty :ref:`StyleBox` **field_and_buttons_separator** :ref:`🔗` :ref:`StyleBox` drawn in the space occupied by the separation between the input field and the buttons. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_style_up_background: .. rst-class:: classref-themeproperty :ref:`StyleBox` **up_background** :ref:`🔗` Background style of the up button. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_style_up_background_disabled: .. rst-class:: classref-themeproperty :ref:`StyleBox` **up_background_disabled** :ref:`🔗` Background style of the up button when disabled. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_style_up_background_hovered: .. rst-class:: classref-themeproperty :ref:`StyleBox` **up_background_hovered** :ref:`🔗` Background style of the up button when hovered. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_style_up_background_pressed: .. rst-class:: classref-themeproperty :ref:`StyleBox` **up_background_pressed** :ref:`🔗` Background style of the up button when being pressed. .. rst-class:: classref-item-separator ---- .. _class_SpinBox_theme_style_up_down_buttons_separator: .. rst-class:: classref-themeproperty :ref:`StyleBox` **up_down_buttons_separator** :ref:`🔗` :ref:`StyleBox` drawn in the space occupied by the separation between the up and down buttons. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`