class_slider.rst 3.6 KB

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