mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
172 lines
6.5 KiB
ReStructuredText
172 lines
6.5 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/4.1/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/4.1/doc/classes/HSlider.xml.
|
|
|
|
.. _class_HSlider:
|
|
|
|
HSlider
|
|
=======
|
|
|
|
**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>`
|
|
|
|
A horizontal slider that goes from left (min) to right (max).
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
A horizontal slider, used to adjust a value by moving a grabber along a horizontal axis. It is a :ref:`Range<class_Range>`-based control and goes from left (min) to right (max).
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Theme Properties
|
|
----------------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-----------------------------------+---------------------------------------------------------------------------------+-------+
|
|
| :ref:`int<class_int>` | :ref:`center_grabber<class_HSlider_theme_constant_center_grabber>` | ``0`` |
|
|
+-----------------------------------+---------------------------------------------------------------------------------+-------+
|
|
| :ref:`int<class_int>` | :ref:`grabber_offset<class_HSlider_theme_constant_grabber_offset>` | ``0`` |
|
|
+-----------------------------------+---------------------------------------------------------------------------------+-------+
|
|
| :ref:`Texture2D<class_Texture2D>` | :ref:`grabber<class_HSlider_theme_icon_grabber>` | |
|
|
+-----------------------------------+---------------------------------------------------------------------------------+-------+
|
|
| :ref:`Texture2D<class_Texture2D>` | :ref:`grabber_disabled<class_HSlider_theme_icon_grabber_disabled>` | |
|
|
+-----------------------------------+---------------------------------------------------------------------------------+-------+
|
|
| :ref:`Texture2D<class_Texture2D>` | :ref:`grabber_highlight<class_HSlider_theme_icon_grabber_highlight>` | |
|
|
+-----------------------------------+---------------------------------------------------------------------------------+-------+
|
|
| :ref:`Texture2D<class_Texture2D>` | :ref:`tick<class_HSlider_theme_icon_tick>` | |
|
|
+-----------------------------------+---------------------------------------------------------------------------------+-------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`grabber_area<class_HSlider_theme_style_grabber_area>` | |
|
|
+-----------------------------------+---------------------------------------------------------------------------------+-------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`grabber_area_highlight<class_HSlider_theme_style_grabber_area_highlight>` | |
|
|
+-----------------------------------+---------------------------------------------------------------------------------+-------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`slider<class_HSlider_theme_style_slider>` | |
|
|
+-----------------------------------+---------------------------------------------------------------------------------+-------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Theme Property Descriptions
|
|
---------------------------
|
|
|
|
.. _class_HSlider_theme_constant_center_grabber:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`int<class_int>` **center_grabber** = ``0``
|
|
|
|
Boolean constant. If ``1``, the grabber texture size will be ignored and it will fit within slider's bounds based only on its center position.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_HSlider_theme_constant_grabber_offset:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`int<class_int>` **grabber_offset** = ``0``
|
|
|
|
Vertical offset of the grabber.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_HSlider_theme_icon_grabber:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Texture2D<class_Texture2D>` **grabber**
|
|
|
|
The texture for the grabber (the draggable element).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_HSlider_theme_icon_grabber_disabled:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Texture2D<class_Texture2D>` **grabber_disabled**
|
|
|
|
The texture for the grabber when it's disabled.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_HSlider_theme_icon_grabber_highlight:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Texture2D<class_Texture2D>` **grabber_highlight**
|
|
|
|
The texture for the grabber when it's focused.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_HSlider_theme_icon_tick:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Texture2D<class_Texture2D>` **tick**
|
|
|
|
The texture for the ticks, visible when :ref:`Slider.tick_count<class_Slider_property_tick_count>` is greater than 0.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_HSlider_theme_style_grabber_area:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **grabber_area**
|
|
|
|
The background of the area to the left of the grabber.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_HSlider_theme_style_grabber_area_highlight:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **grabber_area_highlight**
|
|
|
|
The background of the area to the left of the grabber that displays when it's being hovered or focused.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_HSlider_theme_style_slider:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **slider**
|
|
|
|
The background for the whole slider. Determines the height 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.)`
|
|
.. |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.)`
|
|
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|