Skip to content

Latest commit

 

History

History
199 lines (118 loc) · 7.47 KB

class_hscrollbar.rst

File metadata and controls

199 lines (118 loc) · 7.47 KB
github_url:hide

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>`

A horizontal scrollbar that goes from left (min) to right (max).

.. rst-class:: classref-introduction-group

Description

A horizontal scrollbar, typically used to navigate through content that extends beyond the visible width of a control. It is a :ref:`Range<class_Range>`-based control and goes from left (min) to right (max).

.. rst-class:: classref-reftable-group

Theme Properties

:ref:`Texture2D<class_Texture2D>` :ref:`decrement<class_HScrollBar_theme_icon_decrement>`
:ref:`Texture2D<class_Texture2D>` :ref:`decrement_highlight<class_HScrollBar_theme_icon_decrement_highlight>`
:ref:`Texture2D<class_Texture2D>` :ref:`decrement_pressed<class_HScrollBar_theme_icon_decrement_pressed>`
:ref:`Texture2D<class_Texture2D>` :ref:`increment<class_HScrollBar_theme_icon_increment>`
:ref:`Texture2D<class_Texture2D>` :ref:`increment_highlight<class_HScrollBar_theme_icon_increment_highlight>`
:ref:`Texture2D<class_Texture2D>` :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>` 
.. rst-class:: classref-section-separator


.. rst-class:: classref-descriptions-group

Theme Property Descriptions

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` 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.

.. rst-class:: classref-item-separator


.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` decrement_highlight

Displayed when the mouse cursor hovers over the decrement button.

.. rst-class:: classref-item-separator


.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` decrement_pressed

Displayed when the decrement button is being pressed.

.. rst-class:: classref-item-separator


.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` 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.

.. rst-class:: classref-item-separator


.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` increment_highlight

Displayed when the mouse cursor hovers over the increment button.

.. rst-class:: classref-item-separator


.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` increment_pressed

Displayed when the increment button is being pressed.

.. rst-class:: classref-item-separator


.. 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


.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` grabber_highlight

Used when the mouse hovers over the grabber.

.. rst-class:: classref-item-separator


.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` grabber_pressed

Used when the grabber is being dragged.

.. rst-class:: classref-item-separator


.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` scroll

Used as background of this :ref:`ScrollBar<class_ScrollBar>`.

.. rst-class:: classref-item-separator


.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` scroll_focus

Used as background when the :ref:`ScrollBar<class_ScrollBar>` has the GUI focus.