class_scrollbar.rst 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the ScrollBar.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_ScrollBar:
  5. ScrollBar
  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:`HScrollBar<class_hscrollbar>`, :ref:`VScrollBar<class_vscrollbar>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Base class for scroll bars.
  13. Member Functions
  14. ----------------
  15. +----------------------------+------------------------------------------------------------------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`get_custom_step<class_ScrollBar_get_custom_step>` **(** **)** const |
  17. +----------------------------+------------------------------------------------------------------------------------------------------+
  18. | void | :ref:`set_custom_step<class_ScrollBar_set_custom_step>` **(** :ref:`float<class_float>` step **)** |
  19. +----------------------------+------------------------------------------------------------------------------------------------------+
  20. Signals
  21. -------
  22. - **scrolling** **(** **)**
  23. Member Variables
  24. ----------------
  25. - :ref:`float<class_float>` **custom_step**
  26. Description
  27. -----------
  28. 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.
  29. Member Function Description
  30. ---------------------------
  31. .. _class_ScrollBar_get_custom_step:
  32. - :ref:`float<class_float>` **get_custom_step** **(** **)** const
  33. .. _class_ScrollBar_set_custom_step:
  34. - void **set_custom_step** **(** :ref:`float<class_float>` step **)**