| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VScrollBar.xml.
- .. _class_VScrollBar:
- VScrollBar
- ==========
- **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>`
- Vertical scroll bar.
- Description
- -----------
- Vertical version of :ref:`ScrollBar<class_ScrollBar>`, which goes from top (min) to bottom (max).
- Properties
- ----------
- +-----------------------+-----------------------+--------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | size_flags_horizontal | ``0`` (overrides :ref:`Control<class_Control_property_size_flags_horizontal>`) |
- +-----------------------+-----------------------+--------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | size_flags_vertical | ``1`` (overrides :ref:`Control<class_Control_property_size_flags_vertical>`) |
- +-----------------------+-----------------------+--------------------------------------------------------------------------------+
- Theme Properties
- ----------------
- +-----------------------------------+-----------------------------------------------------------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`decrement<class_VScrollBar_theme_icon_decrement>` |
- +-----------------------------------+-----------------------------------------------------------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`decrement_highlight<class_VScrollBar_theme_icon_decrement_highlight>` |
- +-----------------------------------+-----------------------------------------------------------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`decrement_pressed<class_VScrollBar_theme_icon_decrement_pressed>` |
- +-----------------------------------+-----------------------------------------------------------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`increment<class_VScrollBar_theme_icon_increment>` |
- +-----------------------------------+-----------------------------------------------------------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`increment_highlight<class_VScrollBar_theme_icon_increment_highlight>` |
- +-----------------------------------+-----------------------------------------------------------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`increment_pressed<class_VScrollBar_theme_icon_increment_pressed>` |
- +-----------------------------------+-----------------------------------------------------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | :ref:`grabber<class_VScrollBar_theme_style_grabber>` |
- +-----------------------------------+-----------------------------------------------------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | :ref:`grabber_highlight<class_VScrollBar_theme_style_grabber_highlight>` |
- +-----------------------------------+-----------------------------------------------------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | :ref:`grabber_pressed<class_VScrollBar_theme_style_grabber_pressed>` |
- +-----------------------------------+-----------------------------------------------------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | :ref:`scroll<class_VScrollBar_theme_style_scroll>` |
- +-----------------------------------+-----------------------------------------------------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | :ref:`scroll_focus<class_VScrollBar_theme_style_scroll_focus>` |
- +-----------------------------------+-----------------------------------------------------------------------------+
- Theme Property Descriptions
- ---------------------------
- .. _class_VScrollBar_theme_icon_decrement:
- - :ref:`Texture2D<class_Texture2D>` **decrement**
- Icon used as a button to scroll the :ref:`ScrollBar<class_ScrollBar>` up. Supports custom step using the :ref:`ScrollBar.custom_step<class_ScrollBar_property_custom_step>` property.
- ----
- .. _class_VScrollBar_theme_icon_decrement_highlight:
- - :ref:`Texture2D<class_Texture2D>` **decrement_highlight**
- Displayed when the mouse cursor hovers over the decrement button.
- ----
- .. _class_VScrollBar_theme_icon_decrement_pressed:
- - :ref:`Texture2D<class_Texture2D>` **decrement_pressed**
- Displayed when the decrement button is being pressed.
- ----
- .. _class_VScrollBar_theme_icon_increment:
- - :ref:`Texture2D<class_Texture2D>` **increment**
- Icon used as a button to scroll the :ref:`ScrollBar<class_ScrollBar>` down. Supports custom step using the :ref:`ScrollBar.custom_step<class_ScrollBar_property_custom_step>` property.
- ----
- .. _class_VScrollBar_theme_icon_increment_highlight:
- - :ref:`Texture2D<class_Texture2D>` **increment_highlight**
- Displayed when the mouse cursor hovers over the increment button.
- ----
- .. _class_VScrollBar_theme_icon_increment_pressed:
- - :ref:`Texture2D<class_Texture2D>` **increment_pressed**
- Displayed when the increment button is being pressed.
- ----
- .. _class_VScrollBar_theme_style_grabber:
- - :ref:`StyleBox<class_StyleBox>` **grabber**
- Used as texture for the grabber, the draggable element representing current scroll.
- ----
- .. _class_VScrollBar_theme_style_grabber_highlight:
- - :ref:`StyleBox<class_StyleBox>` **grabber_highlight**
- Used when the mouse hovers over the grabber.
- ----
- .. _class_VScrollBar_theme_style_grabber_pressed:
- - :ref:`StyleBox<class_StyleBox>` **grabber_pressed**
- Used when the grabber is being dragged.
- ----
- .. _class_VScrollBar_theme_style_scroll:
- - :ref:`StyleBox<class_StyleBox>` **scroll**
- Used as background of this :ref:`ScrollBar<class_ScrollBar>`.
- ----
- .. _class_VScrollBar_theme_style_scroll_focus:
- - :ref:`StyleBox<class_StyleBox>` **scroll_focus**
- Used as background when the :ref:`ScrollBar<class_ScrollBar>` has the GUI focus.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
