pandemonium_engine_docs/classes/class_hscrollbar.rst

141 lines
5.7 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/HScrollBar.xml.
.. _class_HScrollBar:
HScrollBar
==========
**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>`
Horizontal scroll bar.
Description
-----------
Horizontal version of :ref:`ScrollBar<class_ScrollBar>`, which goes from left (min) to right (max).
Theme Properties
----------------
+---------------------------------+-----------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`decrement<class_HScrollBar_theme_icon_decrement>` |
+---------------------------------+-----------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`decrement_highlight<class_HScrollBar_theme_icon_decrement_highlight>` |
+---------------------------------+-----------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`decrement_pressed<class_HScrollBar_theme_icon_decrement_pressed>` |
+---------------------------------+-----------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`increment<class_HScrollBar_theme_icon_increment>` |
+---------------------------------+-----------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`increment_highlight<class_HScrollBar_theme_icon_increment_highlight>` |
+---------------------------------+-----------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`increment_pressed<class_HScrollBar_theme_icon_increment_pressed>` |
+---------------------------------+-----------------------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`grabber<class_HScrollBar_theme_style_grabber>` |
+---------------------------------+-----------------------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`grabber_highlight<class_HScrollBar_theme_style_grabber_highlight>` |
+---------------------------------+-----------------------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`grabber_pressed<class_HScrollBar_theme_style_grabber_pressed>` |
+---------------------------------+-----------------------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`scroll<class_HScrollBar_theme_style_scroll>` |
+---------------------------------+-----------------------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`scroll_focus<class_HScrollBar_theme_style_scroll_focus>` |
+---------------------------------+-----------------------------------------------------------------------------+
Theme Property Descriptions
---------------------------
.. _class_HScrollBar_theme_icon_decrement:
- :ref:`Texture<class_Texture>` **decrement**
Icon used as a button to scroll the :ref:`ScrollBar<class_ScrollBar>` left. Supports custom step using the :ref:`ScrollBar.custom_step<class_ScrollBar_property_custom_step>` property.
----
.. _class_HScrollBar_theme_icon_decrement_highlight:
- :ref:`Texture<class_Texture>` **decrement_highlight**
Displayed when the mouse cursor hovers over the decrement button.
----
.. _class_HScrollBar_theme_icon_decrement_pressed:
- :ref:`Texture<class_Texture>` **decrement_pressed**
Displayed when the decrement button is being pressed.
----
.. _class_HScrollBar_theme_icon_increment:
- :ref:`Texture<class_Texture>` **increment**
Icon used as a button to scroll the :ref:`ScrollBar<class_ScrollBar>` right. Supports custom step using the :ref:`ScrollBar.custom_step<class_ScrollBar_property_custom_step>` property.
----
.. _class_HScrollBar_theme_icon_increment_highlight:
- :ref:`Texture<class_Texture>` **increment_highlight**
Displayed when the mouse cursor hovers over the increment button.
----
.. _class_HScrollBar_theme_icon_increment_pressed:
- :ref:`Texture<class_Texture>` **increment_pressed**
Displayed when the increment button is being pressed.
----
.. _class_HScrollBar_theme_style_grabber:
- :ref:`StyleBox<class_StyleBox>` **grabber**
Used as texture for the grabber, the draggable element representing current scroll.
----
.. _class_HScrollBar_theme_style_grabber_highlight:
- :ref:`StyleBox<class_StyleBox>` **grabber_highlight**
Used when the mouse hovers over the grabber.
----
.. _class_HScrollBar_theme_style_grabber_pressed:
- :ref:`StyleBox<class_StyleBox>` **grabber_pressed**
Used when the grabber is being dragged.
----
.. _class_HScrollBar_theme_style_scroll:
- :ref:`StyleBox<class_StyleBox>` **scroll**
Used as background of this :ref:`ScrollBar<class_ScrollBar>`.
----
.. _class_HScrollBar_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.)`