211 lines
7.7 KiB
Text
211 lines
7.7 KiB
Text
|
:github_url: hide
|
||
|
|
|
||
|
|
.. DO NOT EDIT THIS FILE!!!
|
||
|
|
.. Generated automatically from Godot engine sources.
|
||
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
|
||
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.6/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.
|
||
|
|
|
||
|
|
.. rst-class:: classref-introduction-group
|
||
|
|
|
||
|
|
Description
|
||
|
|
-----------
|
||
|
|
|
||
|
|
Vertical version of :ref:`ScrollBar<class_ScrollBar>`, which goes from top (min) to bottom (max).
|
||
|
|
|
||
|
|
.. rst-class:: classref-reftable-group
|
||
|
|
|
||
|
|
Properties
|
||
|
|
----------
|
||
|
|
|
||
|
|
.. table::
|
||
|
|
:widths: auto
|
||
|
|
|
||
|
|
+-----------------------+-----------------------+--------------------------------------------------------------------------------+
|
||
|
|
| :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>`) |
|
||
|
|
+-----------------------+-----------------------+--------------------------------------------------------------------------------+
|
||
|
|
|
||
|
|
.. rst-class:: classref-reftable-group
|
||
|
|
|
||
|
|
Theme Properties
|
||
|
|
----------------
|
||
|
|
|
||
|
|
.. table::
|
||
|
|
:widths: auto
|
||
|
|
|
||
|
|
+---------------------------------+-----------------------------------------------------------------------------+
|
||
|
|
| :ref:`Texture<class_Texture>` | :ref:`decrement<class_VScrollBar_theme_icon_decrement>` |
|
||
|
|
+---------------------------------+-----------------------------------------------------------------------------+
|
||
|
|
| :ref:`Texture<class_Texture>` | :ref:`decrement_highlight<class_VScrollBar_theme_icon_decrement_highlight>` |
|
||
|
|
+---------------------------------+-----------------------------------------------------------------------------+
|
||
|
|
| :ref:`Texture<class_Texture>` | :ref:`decrement_pressed<class_VScrollBar_theme_icon_decrement_pressed>` |
|
||
|
|
+---------------------------------+-----------------------------------------------------------------------------+
|
||
|
|
| :ref:`Texture<class_Texture>` | :ref:`increment<class_VScrollBar_theme_icon_increment>` |
|
||
|
|
+---------------------------------+-----------------------------------------------------------------------------+
|
||
|
|
| :ref:`Texture<class_Texture>` | :ref:`increment_highlight<class_VScrollBar_theme_icon_increment_highlight>` |
|
||
|
|
+---------------------------------+-----------------------------------------------------------------------------+
|
||
|
|
| :ref:`Texture<class_Texture>` | :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>` |
|
||
|
|
+---------------------------------+-----------------------------------------------------------------------------+
|
||
|
|
|
||
|
|
.. rst-class:: classref-section-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. rst-class:: classref-descriptions-group
|
||
|
|
|
||
|
|
Theme Property Descriptions
|
||
|
|
---------------------------
|
||
|
|
|
||
|
|
.. _class_VScrollBar_theme_icon_decrement:
|
||
|
|
|
||
|
|
.. rst-class:: classref-themeproperty
|
||
|
|
|
||
|
|
:ref:`Texture<class_Texture>` **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.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_VScrollBar_theme_icon_decrement_highlight:
|
||
|
|
|
||
|
|
.. rst-class:: classref-themeproperty
|
||
|
|
|
||
|
|
:ref:`Texture<class_Texture>` **decrement_highlight**
|
||
|
|
|
||
|
|
Displayed when the mouse cursor hovers over the decrement button.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_VScrollBar_theme_icon_decrement_pressed:
|
||
|
|
|
||
|
|
.. rst-class:: classref-themeproperty
|
||
|
|
|
||
|
|
:ref:`Texture<class_Texture>` **decrement_pressed**
|
||
|
|
|
||
|
|
Displayed when the decrement button is being pressed.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_VScrollBar_theme_icon_increment:
|
||
|
|
|
||
|
|
.. rst-class:: classref-themeproperty
|
||
|
|
|
||
|
|
:ref:`Texture<class_Texture>` **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.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_VScrollBar_theme_icon_increment_highlight:
|
||
|
|
|
||
|
|
.. rst-class:: classref-themeproperty
|
||
|
|
|
||
|
|
:ref:`Texture<class_Texture>` **increment_highlight**
|
||
|
|
|
||
|
|
Displayed when the mouse cursor hovers over the increment button.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_VScrollBar_theme_icon_increment_pressed:
|
||
|
|
|
||
|
|
.. rst-class:: classref-themeproperty
|
||
|
|
|
||
|
|
:ref:`Texture<class_Texture>` **increment_pressed**
|
||
|
|
|
||
|
|
Displayed when the increment button is being pressed.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_VScrollBar_theme_style_grabber:
|
||
|
|
|
||
|
|
.. rst-class:: classref-themeproperty
|
||
|
|
|
||
|
|
:ref:`StyleBox<class_StyleBox>` **grabber**
|
||
|
|
|
||
|
|
Used as texture for the grabber, the draggable element representing current scroll.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_VScrollBar_theme_style_grabber_highlight:
|
||
|
|
|
||
|
|
.. rst-class:: classref-themeproperty
|
||
|
|
|
||
|
|
:ref:`StyleBox<class_StyleBox>` **grabber_highlight**
|
||
|
|
|
||
|
|
Used when the mouse hovers over the grabber.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_VScrollBar_theme_style_grabber_pressed:
|
||
|
|
|
||
|
|
.. rst-class:: classref-themeproperty
|
||
|
|
|
||
|
|
:ref:`StyleBox<class_StyleBox>` **grabber_pressed**
|
||
|
|
|
||
|
|
Used when the grabber is being dragged.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_VScrollBar_theme_style_scroll:
|
||
|
|
|
||
|
|
.. rst-class:: classref-themeproperty
|
||
|
|
|
||
|
|
:ref:`StyleBox<class_StyleBox>` **scroll**
|
||
|
|
|
||
|
|
Used as background of this :ref:`ScrollBar<class_ScrollBar>`.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_VScrollBar_theme_style_scroll_focus:
|
||
|
|
|
||
|
|
.. rst-class:: classref-themeproperty
|
||
|
|
|
||
|
|
: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.)`
|
||
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|