class_scrollbar.rst 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  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 ScrollBar.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_ScrollBar:
  6. ScrollBar
  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:`HScrollBar<class_HScrollBar>`, :ref:`VScrollBar<class_VScrollBar>`
  10. **Category:** Core
  11. Brief Description
  12. -----------------
  13. Base class for scroll bars.
  14. Properties
  15. ----------
  16. +---------------------------+----------------------------------------------------------+
  17. | :ref:`float<class_float>` | :ref:`custom_step<class_ScrollBar_property_custom_step>` |
  18. +---------------------------+----------------------------------------------------------+
  19. Signals
  20. -------
  21. .. _class_ScrollBar_signal_scrolling:
  22. - **scrolling** **(** **)**
  23. Emitted whenever the scrollbar is being scrolled.
  24. Description
  25. -----------
  26. 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.
  27. Property Descriptions
  28. ---------------------
  29. .. _class_ScrollBar_property_custom_step:
  30. - :ref:`float<class_float>` **custom_step**
  31. +----------+------------------------+
  32. | *Setter* | set_custom_step(value) |
  33. +----------+------------------------+
  34. | *Getter* | get_custom_step() |
  35. +----------+------------------------+