:github_url: hide .. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the SpinBox.xml source instead. .. The source is found in doc/classes or modules//doc_classes. .. _class_SpinBox: SpinBox ======= **Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- Numerical input text field. Properties ---------- +-----------------------------------+--------------------------------------------------+------+ | :ref:`Align` | :ref:`align` | 0 | +-----------------------------------+--------------------------------------------------+------+ | :ref:`bool` | :ref:`editable` | true | +-----------------------------------+--------------------------------------------------+------+ | :ref:`String` | :ref:`prefix` | "" | +-----------------------------------+--------------------------------------------------+------+ | :ref:`String` | :ref:`suffix` | "" | +-----------------------------------+--------------------------------------------------+------+ Methods ------- +---------------------------------+----------------------------------------------------------------------+ | :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | +---------------------------------+----------------------------------------------------------------------+ Theme Properties ---------------- +-------------------------------+--------+ | :ref:`Texture` | updown | +-------------------------------+--------+ 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 :ref:`Range` class for more options over the ``SpinBox``. Property Descriptions --------------------- .. _class_SpinBox_property_align: - :ref:`Align` **align** +-----------+------------------+ | *Default* | 0 | +-----------+------------------+ | *Setter* | set_align(value) | +-----------+------------------+ | *Getter* | get_align() | +-----------+------------------+ Sets the text alignment of the ``SpinBox``. .. _class_SpinBox_property_editable: - :ref:`bool` **editable** +-----------+---------------------+ | *Default* | true | +-----------+---------------------+ | *Setter* | set_editable(value) | +-----------+---------------------+ | *Getter* | is_editable() | +-----------+---------------------+ If ``true``, the ``SpinBox`` will be editable. Otherwise, it will be read only. .. _class_SpinBox_property_prefix: - :ref:`String` **prefix** +-----------+-------------------+ | *Default* | "" | +-----------+-------------------+ | *Setter* | set_prefix(value) | +-----------+-------------------+ | *Getter* | get_prefix() | +-----------+-------------------+ Adds the specified ``prefix`` string before the numerical value of the ``SpinBox``. .. _class_SpinBox_property_suffix: - :ref:`String` **suffix** +-----------+-------------------+ | *Default* | "" | +-----------+-------------------+ | *Setter* | set_suffix(value) | +-----------+-------------------+ | *Getter* | get_suffix() | +-----------+-------------------+ Adds the specified ``prefix`` string after the numerical value of the ``SpinBox``. Method Descriptions ------------------- .. _class_SpinBox_method_get_line_edit: - :ref:`LineEdit` **get_line_edit** **(** **)** Returns the :ref:`LineEdit` instance from this ``SpinBox``. You can use it to access properties and methods of :ref:`LineEdit`.