class_spinbox.rst 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_SpinBox:
  4. SpinBox
  5. =======
  6. **Inherits:** :ref:`Range<class_range>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Numerical input text field.
  11. Member Functions
  12. ----------------
  13. +------------------------------+------------------------------------------------------------------------------------------------+
  14. | :ref:`Object<class_object>` | :ref:`get_line_edit<class_SpinBox_get_line_edit>` **(** **)** |
  15. +------------------------------+------------------------------------------------------------------------------------------------+
  16. | :ref:`String<class_string>` | :ref:`get_prefix<class_SpinBox_get_prefix>` **(** **)** const |
  17. +------------------------------+------------------------------------------------------------------------------------------------+
  18. | :ref:`String<class_string>` | :ref:`get_suffix<class_SpinBox_get_suffix>` **(** **)** const |
  19. +------------------------------+------------------------------------------------------------------------------------------------+
  20. | :ref:`bool<class_bool>` | :ref:`is_editable<class_SpinBox_is_editable>` **(** **)** const |
  21. +------------------------------+------------------------------------------------------------------------------------------------+
  22. | void | :ref:`set_editable<class_SpinBox_set_editable>` **(** :ref:`bool<class_bool>` editable **)** |
  23. +------------------------------+------------------------------------------------------------------------------------------------+
  24. | void | :ref:`set_prefix<class_SpinBox_set_prefix>` **(** :ref:`String<class_string>` prefix **)** |
  25. +------------------------------+------------------------------------------------------------------------------------------------+
  26. | void | :ref:`set_suffix<class_SpinBox_set_suffix>` **(** :ref:`String<class_string>` suffix **)** |
  27. +------------------------------+------------------------------------------------------------------------------------------------+
  28. Description
  29. -----------
  30. SpinBox is a numerical input text field. It allows entering integers and floats.
  31. Member Function Description
  32. ---------------------------
  33. .. _class_SpinBox_get_line_edit:
  34. - :ref:`Object<class_object>` **get_line_edit** **(** **)**
  35. .. _class_SpinBox_get_prefix:
  36. - :ref:`String<class_string>` **get_prefix** **(** **)** const
  37. .. _class_SpinBox_get_suffix:
  38. - :ref:`String<class_string>` **get_suffix** **(** **)** const
  39. Return the specific suffix.
  40. .. _class_SpinBox_is_editable:
  41. - :ref:`bool<class_bool>` **is_editable** **(** **)** const
  42. Return if the spinbox is editable.
  43. .. _class_SpinBox_set_editable:
  44. - void **set_editable** **(** :ref:`bool<class_bool>` editable **)**
  45. Set whether the spinbox is editable.
  46. .. _class_SpinBox_set_prefix:
  47. - void **set_prefix** **(** :ref:`String<class_string>` prefix **)**
  48. Set a prefix.
  49. .. _class_SpinBox_set_suffix:
  50. - void **set_suffix** **(** :ref:`String<class_string>` suffix **)**
  51. Set a specific suffix.