godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
stable
godot-docs/classes/class_spinbox.rst
Godot Organization 77812833de classref: Sync with current master branch (e0603ae)
2025-07-23 22:05:40 +00:00

719 lines
36 KiB
ReStructuredText
Raw Permalink Blame History

: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<class_Range>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_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_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_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<class_LineEdit>` node. To theme a **SpinBox**'s background, add theme items for :ref:`LineEdit<class_LineEdit>` and customize them. The :ref:`LineEdit<class_LineEdit>` has the ``SpinBoxInnerLineEdit`` theme variation, so that you can give it a distinct appearance from regular :ref:`LineEdit<class_LineEdit>`\ s.
\ **Note:** If you want to implement drag and drop for the underlying :ref:`LineEdit<class_LineEdit>`, you can use :ref:`Control.set_drag_forwarding()<class_Control_method_set_drag_forwarding>` on the node returned by :ref:`get_line_edit()<class_SpinBox_method_get_line_edit>`.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` | :ref:`alignment<class_SpinBox_property_alignment>` | ``0`` |
+-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`custom_arrow_step<class_SpinBox_property_custom_arrow_step>` | ``0.0`` |
+-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`editable<class_SpinBox_property_editable>` | ``true`` |
+-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`prefix<class_SpinBox_property_prefix>` | ``""`` |
+-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`select_all_on_focus<class_SpinBox_property_select_all_on_focus>` | ``false`` |
+-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+
| |bitfield|\[:ref:`SizeFlags<enum_Control_SizeFlags>`\] | size_flags_vertical | ``1`` (overrides :ref:`Control<class_Control_property_size_flags_vertical>`) |
+-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | step | ``1.0`` (overrides :ref:`Range<class_Range_property_step>`) |
+-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`suffix<class_SpinBox_property_suffix>` | ``""`` |
+-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`update_on_text_changed<class_SpinBox_property_update_on_text_changed>` | ``false`` |
+-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
Methods
-------
.. table::
:widths: auto
+---------------------------------+----------------------------------------------------------------+
| |void| | :ref:`apply<class_SpinBox_method_apply>`\ (\ ) |
+---------------------------------+----------------------------------------------------------------+
| :ref:`LineEdit<class_LineEdit>` | :ref:`get_line_edit<class_SpinBox_method_get_line_edit>`\ (\ ) |
+---------------------------------+----------------------------------------------------------------+
.. rst-class:: classref-reftable-group
Theme Properties
----------------
.. table::
:widths: auto
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`down_disabled_icon_modulate<class_SpinBox_theme_color_down_disabled_icon_modulate>` | ``Color(0.875, 0.875, 0.875, 0.5)`` |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`down_hover_icon_modulate<class_SpinBox_theme_color_down_hover_icon_modulate>` | ``Color(0.95, 0.95, 0.95, 1)`` |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`down_icon_modulate<class_SpinBox_theme_color_down_icon_modulate>` | ``Color(0.875, 0.875, 0.875, 1)`` |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`down_pressed_icon_modulate<class_SpinBox_theme_color_down_pressed_icon_modulate>` | ``Color(0.95, 0.95, 0.95, 1)`` |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`up_disabled_icon_modulate<class_SpinBox_theme_color_up_disabled_icon_modulate>` | ``Color(0.875, 0.875, 0.875, 0.5)`` |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`up_hover_icon_modulate<class_SpinBox_theme_color_up_hover_icon_modulate>` | ``Color(0.95, 0.95, 0.95, 1)`` |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`up_icon_modulate<class_SpinBox_theme_color_up_icon_modulate>` | ``Color(0.875, 0.875, 0.875, 1)`` |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`up_pressed_icon_modulate<class_SpinBox_theme_color_up_pressed_icon_modulate>` | ``Color(0.95, 0.95, 0.95, 1)`` |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`int<class_int>` | :ref:`buttons_vertical_separation<class_SpinBox_theme_constant_buttons_vertical_separation>` | ``0`` |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`int<class_int>` | :ref:`buttons_width<class_SpinBox_theme_constant_buttons_width>` | ``16`` |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`int<class_int>` | :ref:`field_and_buttons_separation<class_SpinBox_theme_constant_field_and_buttons_separation>` | ``2`` |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`int<class_int>` | :ref:`set_min_buttons_width_from_icons<class_SpinBox_theme_constant_set_min_buttons_width_from_icons>` | ``1`` |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`down<class_SpinBox_theme_icon_down>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`down_disabled<class_SpinBox_theme_icon_down_disabled>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`down_hover<class_SpinBox_theme_icon_down_hover>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`down_pressed<class_SpinBox_theme_icon_down_pressed>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`up<class_SpinBox_theme_icon_up>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`up_disabled<class_SpinBox_theme_icon_up_disabled>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`up_hover<class_SpinBox_theme_icon_up_hover>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`up_pressed<class_SpinBox_theme_icon_up_pressed>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`updown<class_SpinBox_theme_icon_updown>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`down_background<class_SpinBox_theme_style_down_background>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`down_background_disabled<class_SpinBox_theme_style_down_background_disabled>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`down_background_hovered<class_SpinBox_theme_style_down_background_hovered>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`down_background_pressed<class_SpinBox_theme_style_down_background_pressed>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`field_and_buttons_separator<class_SpinBox_theme_style_field_and_buttons_separator>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`up_background<class_SpinBox_theme_style_up_background>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`up_background_disabled<class_SpinBox_theme_style_up_background_disabled>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`up_background_hovered<class_SpinBox_theme_style_up_background_hovered>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`up_background_pressed<class_SpinBox_theme_style_up_background_pressed>` | |
+-----------------------------------+--------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`up_down_buttons_separator<class_SpinBox_theme_style_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<enum_@GlobalScope_HorizontalAlignment>` **alignment** = ``0`` :ref:`🔗<class_SpinBox_property_alignment>`
.. rst-class:: classref-property-setget
- |void| **set_horizontal_alignment**\ (\ value\: :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>`\ )
- :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` **get_horizontal_alignment**\ (\ )
Changes the alignment of the underlying :ref:`LineEdit<class_LineEdit>`.
.. rst-class:: classref-item-separator
----
.. _class_SpinBox_property_custom_arrow_step:
.. rst-class:: classref-property
:ref:`float<class_float>` **custom_arrow_step** = ``0.0`` :ref:`🔗<class_SpinBox_property_custom_arrow_step>`
.. rst-class:: classref-property-setget
- |void| **set_custom_arrow_step**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_custom_arrow_step**\ (\ )
If not ``0``, sets the step when interacting with the arrow buttons of the **SpinBox**.
\ **Note:** :ref:`Range.value<class_Range_property_value>` will still be rounded to a multiple of :ref:`Range.step<class_Range_property_step>`.
.. rst-class:: classref-item-separator
----
.. _class_SpinBox_property_editable:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **editable** = ``true`` :ref:`🔗<class_SpinBox_property_editable>`
.. rst-class:: classref-property-setget
- |void| **set_editable**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_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<class_String>` **prefix** = ``""`` :ref:`🔗<class_SpinBox_property_prefix>`
.. rst-class:: classref-property-setget
- |void| **set_prefix**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_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<class_bool>` **select_all_on_focus** = ``false`` :ref:`🔗<class_SpinBox_property_select_all_on_focus>`
.. rst-class:: classref-property-setget
- |void| **set_select_all_on_focus**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_select_all_on_focus**\ (\ )
If ``true``, the **SpinBox** will select the whole text when the :ref:`LineEdit<class_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<class_String>` **suffix** = ``""`` :ref:`🔗<class_SpinBox_property_suffix>`
.. rst-class:: classref-property-setget
- |void| **set_suffix**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_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<class_bool>` **update_on_text_changed** = ``false`` :ref:`🔗<class_SpinBox_property_update_on_text_changed>`
.. rst-class:: classref-property-setget
- |void| **set_update_on_text_changed**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_update_on_text_changed**\ (\ )
Sets the value of the :ref:`Range<class_Range>` for this **SpinBox** when the :ref:`LineEdit<class_LineEdit>` text is *changed* instead of *submitted*. See :ref:`LineEdit.text_changed<class_LineEdit_signal_text_changed>` and :ref:`LineEdit.text_submitted<class_LineEdit_signal_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:`🔗<class_SpinBox_method_apply>`
Applies the current value of this **SpinBox**. This is equivalent to pressing :kbd:`Enter` while editing the :ref:`LineEdit<class_LineEdit>` used by the **SpinBox**. This will cause :ref:`LineEdit.text_submitted<class_LineEdit_signal_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<class_LineEdit>` **get_line_edit**\ (\ ) :ref:`🔗<class_SpinBox_method_get_line_edit>`
Returns the :ref:`LineEdit<class_LineEdit>` instance from this **SpinBox**. You can use it to access properties and methods of :ref:`LineEdit<class_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<class_CanvasItem_property_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<class_Color>` **down_disabled_icon_modulate** = ``Color(0.875, 0.875, 0.875, 0.5)`` :ref:`🔗<class_SpinBox_theme_color_down_disabled_icon_modulate>`
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<class_Color>` **down_hover_icon_modulate** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗<class_SpinBox_theme_color_down_hover_icon_modulate>`
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<class_Color>` **down_icon_modulate** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗<class_SpinBox_theme_color_down_icon_modulate>`
Down button icon modulation color.
.. rst-class:: classref-item-separator
----
.. _class_SpinBox_theme_color_down_pressed_icon_modulate:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **down_pressed_icon_modulate** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗<class_SpinBox_theme_color_down_pressed_icon_modulate>`
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<class_Color>` **up_disabled_icon_modulate** = ``Color(0.875, 0.875, 0.875, 0.5)`` :ref:`🔗<class_SpinBox_theme_color_up_disabled_icon_modulate>`
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<class_Color>` **up_hover_icon_modulate** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗<class_SpinBox_theme_color_up_hover_icon_modulate>`
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<class_Color>` **up_icon_modulate** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗<class_SpinBox_theme_color_up_icon_modulate>`
Up button icon modulation color.
.. rst-class:: classref-item-separator
----
.. _class_SpinBox_theme_color_up_pressed_icon_modulate:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **up_pressed_icon_modulate** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗<class_SpinBox_theme_color_up_pressed_icon_modulate>`
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<class_int>` **buttons_vertical_separation** = ``0`` :ref:`🔗<class_SpinBox_theme_constant_buttons_vertical_separation>`
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<class_int>` **buttons_width** = ``16`` :ref:`🔗<class_SpinBox_theme_constant_buttons_width>`
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<class_int>` **field_and_buttons_separation** = ``2`` :ref:`🔗<class_SpinBox_theme_constant_field_and_buttons_separation>`
Width of the horizontal separation between the text input field (:ref:`LineEdit<class_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<class_int>` **set_min_buttons_width_from_icons** = ``1`` :ref:`🔗<class_SpinBox_theme_constant_set_min_buttons_width_from_icons>`
If not ``0``, the minimum button width corresponds to the widest of all icons set on those buttons, even if :ref:`buttons_width<class_SpinBox_theme_constant_buttons_width>` is smaller.
.. rst-class:: classref-item-separator
----
.. _class_SpinBox_theme_icon_down:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **down** :ref:`🔗<class_SpinBox_theme_icon_down>`
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<class_Texture2D>` **down_disabled** :ref:`🔗<class_SpinBox_theme_icon_down_disabled>`
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<class_Texture2D>` **down_hover** :ref:`🔗<class_SpinBox_theme_icon_down_hover>`
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<class_Texture2D>` **down_pressed** :ref:`🔗<class_SpinBox_theme_icon_down_pressed>`
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<class_Texture2D>` **up** :ref:`🔗<class_SpinBox_theme_icon_up>`
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<class_Texture2D>` **up_disabled** :ref:`🔗<class_SpinBox_theme_icon_up_disabled>`
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<class_Texture2D>` **up_hover** :ref:`🔗<class_SpinBox_theme_icon_up_hover>`
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<class_Texture2D>` **up_pressed** :ref:`🔗<class_SpinBox_theme_icon_up_pressed>`
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<class_Texture2D>` **updown** :ref:`🔗<class_SpinBox_theme_icon_updown>`
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<class_SpinBox_theme_icon_up>` and :ref:`down<class_SpinBox_theme_icon_down>`.
.. rst-class:: classref-item-separator
----
.. _class_SpinBox_theme_style_down_background:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **down_background** :ref:`🔗<class_SpinBox_theme_style_down_background>`
Background style of the down button.
.. rst-class:: classref-item-separator
----
.. _class_SpinBox_theme_style_down_background_disabled:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **down_background_disabled** :ref:`🔗<class_SpinBox_theme_style_down_background_disabled>`
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<class_StyleBox>` **down_background_hovered** :ref:`🔗<class_SpinBox_theme_style_down_background_hovered>`
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<class_StyleBox>` **down_background_pressed** :ref:`🔗<class_SpinBox_theme_style_down_background_pressed>`
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<class_StyleBox>` **field_and_buttons_separator** :ref:`🔗<class_SpinBox_theme_style_field_and_buttons_separator>`
:ref:`StyleBox<class_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<class_StyleBox>` **up_background** :ref:`🔗<class_SpinBox_theme_style_up_background>`
Background style of the up button.
.. rst-class:: classref-item-separator
----
.. _class_SpinBox_theme_style_up_background_disabled:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **up_background_disabled** :ref:`🔗<class_SpinBox_theme_style_up_background_disabled>`
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<class_StyleBox>` **up_background_hovered** :ref:`🔗<class_SpinBox_theme_style_up_background_hovered>`
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<class_StyleBox>` **up_background_pressed** :ref:`🔗<class_SpinBox_theme_style_up_background_pressed>`
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<class_StyleBox>` **up_down_buttons_separator** :ref:`🔗<class_SpinBox_theme_style_up_down_buttons_separator>`
:ref:`StyleBox<class_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.)`
Reference in New Issue View Git Blame Copy Permalink