class_slider.rst 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the Slider.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_Slider:
  5. Slider
  6. ======
  7. **Inherits:** :ref:`Range<class_Range>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  8. **Inherited By:** :ref:`HSlider<class_HSlider>`, :ref:`VSlider<class_VSlider>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Base class for GUI Sliders.
  13. Properties
  14. ----------
  15. +------------------------------------------+-----------------------------------------------------------------+
  16. | :ref:`bool<class_bool>` | :ref:`editable<class_Slider_property_editable>` |
  17. +------------------------------------------+-----------------------------------------------------------------+
  18. | :ref:`FocusMode<enum_Control_FocusMode>` | :ref:`focus_mode<class_Slider_property_focus_mode>` |
  19. +------------------------------------------+-----------------------------------------------------------------+
  20. | :ref:`bool<class_bool>` | :ref:`scrollable<class_Slider_property_scrollable>` |
  21. +------------------------------------------+-----------------------------------------------------------------+
  22. | :ref:`int<class_int>` | :ref:`tick_count<class_Slider_property_tick_count>` |
  23. +------------------------------------------+-----------------------------------------------------------------+
  24. | :ref:`bool<class_bool>` | :ref:`ticks_on_borders<class_Slider_property_ticks_on_borders>` |
  25. +------------------------------------------+-----------------------------------------------------------------+
  26. Description
  27. -----------
  28. Base class for GUI Sliders.
  29. Property Descriptions
  30. ---------------------
  31. .. _class_Slider_property_editable:
  32. - :ref:`bool<class_bool>` **editable**
  33. +----------+---------------------+
  34. | *Setter* | set_editable(value) |
  35. +----------+---------------------+
  36. | *Getter* | is_editable() |
  37. +----------+---------------------+
  38. If ``true``, the slider can be interacted with. If ``false``, the value can be changed only by code.
  39. .. _class_Slider_property_focus_mode:
  40. - :ref:`FocusMode<enum_Control_FocusMode>` **focus_mode**
  41. +----------+-----------------------+
  42. | *Setter* | set_focus_mode(value) |
  43. +----------+-----------------------+
  44. | *Getter* | get_focus_mode() |
  45. +----------+-----------------------+
  46. .. _class_Slider_property_scrollable:
  47. - :ref:`bool<class_bool>` **scrollable**
  48. +----------+-----------------------+
  49. | *Setter* | set_scrollable(value) |
  50. +----------+-----------------------+
  51. | *Getter* | is_scrollable() |
  52. +----------+-----------------------+
  53. If ``true``, the value can be changed using the mouse wheel.
  54. .. _class_Slider_property_tick_count:
  55. - :ref:`int<class_int>` **tick_count**
  56. +----------+------------------+
  57. | *Setter* | set_ticks(value) |
  58. +----------+------------------+
  59. | *Getter* | get_ticks() |
  60. +----------+------------------+
  61. Number of ticks displayed on the slider, including border ticks. Ticks are uniformly-distributed value markers.
  62. .. _class_Slider_property_ticks_on_borders:
  63. - :ref:`bool<class_bool>` **ticks_on_borders**
  64. +----------+-----------------------------+
  65. | *Setter* | set_ticks_on_borders(value) |
  66. +----------+-----------------------------+
  67. | *Getter* | get_ticks_on_borders() |
  68. +----------+-----------------------------+
  69. If ``true``, the slider will display ticks for minimum and maximum values.