class_vscrollbar.rst 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VScrollBar.xml.
  6. .. _class_VScrollBar:
  7. VScrollBar
  8. ==========
  9. **Inherits:** :ref:`ScrollBar<class_ScrollBar>` **<** :ref:`Range<class_Range>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. A vertical scrollbar that goes from top (min) to bottom (max).
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. A vertical scrollbar, typically used to navigate through content that extends beyond the visible height of a control. It is a :ref:`Range<class_Range>`-based control and goes from top (min) to bottom (max). Note that this direction is the opposite of :ref:`VSlider<class_VSlider>`'s.
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +--------------------------------------------------------+-----------------------+--------------------------------------------------------------------------------+
  21. | |bitfield|\[:ref:`SizeFlags<enum_Control_SizeFlags>`\] | size_flags_horizontal | ``0`` (overrides :ref:`Control<class_Control_property_size_flags_horizontal>`) |
  22. +--------------------------------------------------------+-----------------------+--------------------------------------------------------------------------------+
  23. | |bitfield|\[:ref:`SizeFlags<enum_Control_SizeFlags>`\] | size_flags_vertical | ``1`` (overrides :ref:`Control<class_Control_property_size_flags_vertical>`) |
  24. +--------------------------------------------------------+-----------------------+--------------------------------------------------------------------------------+
  25. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  26. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  27. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  28. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  29. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  30. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  31. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  32. .. |void| replace:: :abbr:`void (No return value.)`