class_slider.rst 3.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  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. Member Functions
  14. ----------------
  15. +--------------------------+----------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`int<class_int>` | :ref:`get_ticks<class_Slider_get_ticks>` **(** **)** const |
  17. +--------------------------+----------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`bool<class_bool>` | :ref:`get_ticks_on_borders<class_Slider_get_ticks_on_borders>` **(** **)** const |
  19. +--------------------------+----------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`bool<class_bool>` | :ref:`is_editable<class_Slider_is_editable>` **(** **)** const |
  21. +--------------------------+----------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`set_editable<class_Slider_set_editable>` **(** :ref:`bool<class_bool>` editable **)** |
  23. +--------------------------+----------------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`set_ticks<class_Slider_set_ticks>` **(** :ref:`int<class_int>` count **)** |
  25. +--------------------------+----------------------------------------------------------------------------------------------------------------------+
  26. | void | :ref:`set_ticks_on_borders<class_Slider_set_ticks_on_borders>` **(** :ref:`bool<class_bool>` ticks_on_border **)** |
  27. +--------------------------+----------------------------------------------------------------------------------------------------------------------+
  28. Member Variables
  29. ----------------
  30. - :ref:`bool<class_bool>` **editable**
  31. - :ref:`int<class_int>` **focus_mode**
  32. - :ref:`int<class_int>` **tick_count**
  33. - :ref:`bool<class_bool>` **ticks_on_borders**
  34. Description
  35. -----------
  36. Base class for GUI Sliders.
  37. Member Function Description
  38. ---------------------------
  39. .. _class_Slider_get_ticks:
  40. - :ref:`int<class_int>` **get_ticks** **(** **)** const
  41. Return amounts of ticks to display on slider.
  42. .. _class_Slider_get_ticks_on_borders:
  43. - :ref:`bool<class_bool>` **get_ticks_on_borders** **(** **)** const
  44. Return true if ticks are visible on borders.
  45. .. _class_Slider_is_editable:
  46. - :ref:`bool<class_bool>` **is_editable** **(** **)** const
  47. .. _class_Slider_set_editable:
  48. - void **set_editable** **(** :ref:`bool<class_bool>` editable **)**
  49. .. _class_Slider_set_ticks:
  50. - void **set_ticks** **(** :ref:`int<class_int>` count **)**
  51. Set amount of ticks to display in slider.
  52. .. _class_Slider_set_ticks_on_borders:
  53. - void **set_ticks_on_borders** **(** :ref:`bool<class_bool>` ticks_on_border **)**
  54. Set true if ticks are visible on borders.