Files
godot-docs/classes/class_spinbox.rst
2017-09-23 11:01:36 +02:00

92 lines
3.6 KiB
ReStructuredText

.. 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/<name>/doc_classes.
.. _class_SpinBox:
SpinBox
=======
**Inherits:** :ref:`Range<class_range>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Numerical input text field.
Member Functions
----------------
+----------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`LineEdit<class_lineedit>` | :ref:`get_line_edit<class_SpinBox_get_line_edit>` **(** **)** |
+----------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_prefix<class_SpinBox_get_prefix>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_suffix<class_SpinBox_get_suffix>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_editable<class_SpinBox_is_editable>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------+
| void | :ref:`set_editable<class_SpinBox_set_editable>` **(** :ref:`bool<class_bool>` editable **)** |
+----------------------------------+------------------------------------------------------------------------------------------------+
| void | :ref:`set_prefix<class_SpinBox_set_prefix>` **(** :ref:`String<class_string>` prefix **)** |
+----------------------------------+------------------------------------------------------------------------------------------------+
| void | :ref:`set_suffix<class_SpinBox_set_suffix>` **(** :ref:`String<class_string>` suffix **)** |
+----------------------------------+------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`bool<class_bool>` **editable**
- :ref:`String<class_string>` **prefix**
- :ref:`String<class_string>` **suffix**
Description
-----------
SpinBox is a numerical input text field. It allows entering integers and floats.
Member Function Description
---------------------------
.. _class_SpinBox_get_line_edit:
- :ref:`LineEdit<class_lineedit>` **get_line_edit** **(** **)**
.. _class_SpinBox_get_prefix:
- :ref:`String<class_string>` **get_prefix** **(** **)** const
.. _class_SpinBox_get_suffix:
- :ref:`String<class_string>` **get_suffix** **(** **)** const
Return the specific suffix.
.. _class_SpinBox_is_editable:
- :ref:`bool<class_bool>` **is_editable** **(** **)** const
Return if the spinbox is editable.
.. _class_SpinBox_set_editable:
- void **set_editable** **(** :ref:`bool<class_bool>` editable **)**
Set whether the spinbox is editable.
.. _class_SpinBox_set_prefix:
- void **set_prefix** **(** :ref:`String<class_string>` prefix **)**
Set a prefix.
.. _class_SpinBox_set_suffix:
- void **set_suffix** **(** :ref:`String<class_string>` suffix **)**
Set a specific suffix.