class_scrollbar.rst 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  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_ScrollBar:
  4. ScrollBar
  5. =========
  6. **Inherits:** :ref:`Range<class_range>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  7. **Inherited By:** :ref:`HScrollBar<class_hscrollbar>`, :ref:`VScrollBar<class_vscrollbar>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Base class for scroll bars.
  12. Member Functions
  13. ----------------
  14. +----------------------------+------------------------------------------------------------------------------------------------------+
  15. | :ref:`float<class_float>` | :ref:`get_custom_step<class_ScrollBar_get_custom_step>` **(** **)** const |
  16. +----------------------------+------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`set_custom_step<class_ScrollBar_set_custom_step>` **(** :ref:`float<class_float>` step **)** |
  18. +----------------------------+------------------------------------------------------------------------------------------------------+
  19. Description
  20. -----------
  21. Scrollbars are a :ref:`Range<class_range>` based :ref:`Control<class_control>`, that display a draggable area (the size of the page). Horizontal (:ref:`HScrollBar<class_hscrollbar>`) and Vertical (:ref:`VScrollBar<class_vscrollbar>`) versions are available.
  22. Member Function Description
  23. ---------------------------
  24. .. _class_ScrollBar_get_custom_step:
  25. - :ref:`float<class_float>` **get_custom_step** **(** **)** const
  26. .. _class_ScrollBar_set_custom_step:
  27. - void **set_custom_step** **(** :ref:`float<class_float>` step **)**