pandemonium_engine_docs/classes/class_vslider.rst

110 lines
4.8 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VSlider.xml.
.. _class_VSlider:
VSlider
=======
**Inherits:** :ref:`Slider<class_Slider>` **<** :ref:`Range<class_Range>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Vertical slider.
Description
-----------
Vertical slider. See :ref:`Slider<class_Slider>`. This one goes from bottom (min) to top (max).
\ **Note:** The :ref:`Range.changed<class_Range_signal_changed>` and :ref:`Range.value_changed<class_Range_signal_value_changed>` signals are part of the :ref:`Range<class_Range>` class which this class inherits from.
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:`Texture<class_Texture>` | :ref:`grabber<class_VSlider_theme_icon_grabber>` |
+---------------------------------+---------------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`grabber_disabled<class_VSlider_theme_icon_grabber_disabled>` |
+---------------------------------+---------------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`grabber_highlight<class_VSlider_theme_icon_grabber_highlight>` |
+---------------------------------+---------------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`tick<class_VSlider_theme_icon_tick>` |
+---------------------------------+---------------------------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`grabber_area<class_VSlider_theme_style_grabber_area>` |
+---------------------------------+---------------------------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`grabber_area_highlight<class_VSlider_theme_style_grabber_area_highlight>` |
+---------------------------------+---------------------------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`slider<class_VSlider_theme_style_slider>` |
+---------------------------------+---------------------------------------------------------------------------------+
Theme Property Descriptions
---------------------------
.. _class_VSlider_theme_icon_grabber:
- :ref:`Texture<class_Texture>` **grabber**
The texture for the grabber (the draggable element).
----
.. _class_VSlider_theme_icon_grabber_disabled:
- :ref:`Texture<class_Texture>` **grabber_disabled**
The texture for the grabber when it's disabled.
----
.. _class_VSlider_theme_icon_grabber_highlight:
- :ref:`Texture<class_Texture>` **grabber_highlight**
The texture for the grabber when it's focused.
----
.. _class_VSlider_theme_icon_tick:
- :ref:`Texture<class_Texture>` **tick**
The texture for the ticks, visible when :ref:`Slider.tick_count<class_Slider_property_tick_count>` is greater than 0.
----
.. _class_VSlider_theme_style_grabber_area:
- :ref:`StyleBox<class_StyleBox>` **grabber_area**
The background of the area below the grabber.
----
.. _class_VSlider_theme_style_grabber_area_highlight:
- :ref:`StyleBox<class_StyleBox>` **grabber_area_highlight**
----
.. _class_VSlider_theme_style_slider:
- :ref:`StyleBox<class_StyleBox>` **slider**
The background for the whole slider. Determines the width of the ``grabber_area``.
.. |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.)`