mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
classref: Sync with current master branch (2e7fc81)
This commit is contained in:
Godot Organization
@@ -1,5 +1,8 @@
|
||||
: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.
|
||||
@@ -73,7 +76,7 @@ Properties
|
||||
+-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
||||
| :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>`) |
|
||||
| |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>`) |
|
||||
+-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
||||
@@ -90,11 +93,11 @@ 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>` **(** **)** |
|
||||
+---------------------------------+----------------------------------------------------------------------+
|
||||
+---------------------------------+----------------------------------------------------------------+
|
||||
| |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
|
||||
|
||||
@@ -125,8 +128,8 @@ Property Descriptions
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_horizontal_alignment** **(** :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` value **)**
|
||||
- :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` **get_horizontal_alignment** **(** **)**
|
||||
- |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>`.
|
||||
|
||||
@@ -142,8 +145,8 @@ Changes the alignment of the underlying :ref:`LineEdit<class_LineEdit>`.
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_custom_arrow_step** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_custom_arrow_step** **(** **)**
|
||||
- |void| **set_custom_arrow_step**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
- :ref:`float<class_float>` **get_custom_arrow_step**\ (\ )
|
||||
|
||||
If not ``0``, :ref:`Range.value<class_Range_property_value>` will always be rounded to a multiple of :ref:`custom_arrow_step<class_SpinBox_property_custom_arrow_step>` when interacting with the arrow buttons of the **SpinBox**.
|
||||
|
||||
@@ -159,8 +162,8 @@ If not ``0``, :ref:`Range.value<class_Range_property_value>` will always be roun
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_editable** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_editable** **(** **)**
|
||||
- |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.
|
||||
|
||||
@@ -176,8 +179,8 @@ If ``true``, the **SpinBox** will be editable. Otherwise, it will be read only.
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_prefix** **(** :ref:`String<class_String>` value **)**
|
||||
- :ref:`String<class_String>` **get_prefix** **(** **)**
|
||||
- |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**.
|
||||
|
||||
@@ -193,8 +196,8 @@ Adds the specified prefix string before the numerical value of the **SpinBox**.
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_select_all_on_focus** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_select_all_on_focus** **(** **)**
|
||||
- |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.
|
||||
|
||||
@@ -210,8 +213,8 @@ If ``true``, the **SpinBox** will select the whole text when the :ref:`LineEdit<
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_suffix** **(** :ref:`String<class_String>` value **)**
|
||||
- :ref:`String<class_String>` **get_suffix** **(** **)**
|
||||
- |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**.
|
||||
|
||||
@@ -227,8 +230,8 @@ Adds the specified suffix string after the numerical value of the **SpinBox**.
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_update_on_text_changed** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **get_update_on_text_changed** **(** **)**
|
||||
- |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>`.
|
||||
|
||||
@@ -245,7 +248,7 @@ Method Descriptions
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **apply** **(** **)**
|
||||
|void| **apply**\ (\ )
|
||||
|
||||
Applies the current value of this **SpinBox**.
|
||||
|
||||
@@ -257,7 +260,7 @@ Applies the current value of this **SpinBox**.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`LineEdit<class_LineEdit>` **get_line_edit** **(** **)**
|
||||
:ref:`LineEdit<class_LineEdit>` **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>`.
|
||||
|
||||
@@ -287,3 +290,4 @@ Sets a custom :ref:`Texture2D<class_Texture2D>` for up and down arrows of the **
|
||||
.. |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
Block a user