godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f87858a8f)

Browse Source
This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
classes/class_scrollbar.rst
View File

@@ -16,45 +16,65 @@ ScrollBar
Base class for scroll bars.
.. rst-class:: classref-introduction-group
Description
-----------
Scrollbars are a :ref:`Range<class_Range>`-based :ref:`Control<class_Control>`, that display a draggable area (the size of the page). Horizontal (:ref:`HScrollBar<class_HScrollBar>`) and Vertical (:ref:`VScrollBar<class_VScrollBar>`) versions are available.
.. rst-class:: classref-reftable-group
Properties
----------
+---------------------------+----------------------------------------------------------+-------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`custom_step<class_ScrollBar_property_custom_step>` | ``-1.0`` |
+---------------------------+----------------------------------------------------------+-------------------------------------------------------------+
| :ref:`float<class_float>` | step | ``0.0`` (overrides :ref:`Range<class_Range_property_step>`) |
+---------------------------+----------------------------------------------------------+-------------------------------------------------------------+
.. table::
:widths: auto
+---------------------------+----------------------------------------------------------+-------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`custom_step<class_ScrollBar_property_custom_step>` | ``-1.0`` |
+---------------------------+----------------------------------------------------------+-------------------------------------------------------------+
| :ref:`float<class_float>` | step | ``0.0`` (overrides :ref:`Range<class_Range_property_step>`) |
+---------------------------+----------------------------------------------------------+-------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Signals
-------
.. _class_ScrollBar_signal_scrolling:
- **scrolling** **(** **)**
.. rst-class:: classref-signal
**scrolling** **(** **)**
Emitted when the scrollbar is being scrolled.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_ScrollBar_property_custom_step:
- :ref:`float<class_float>` **custom_step**
.. rst-class:: classref-property
+-----------+------------------------+
| *Default* | ``-1.0`` |
+-----------+------------------------+
| *Setter* | set_custom_step(value) |
+-----------+------------------------+
| *Getter* | get_custom_step() |
+-----------+------------------------+
:ref:`float<class_float>` **custom_step** = ``-1.0``
Overrides the step used when clicking increment and decrement buttons or when using arrow keys when the ``ScrollBar`` is focused.
.. rst-class:: classref-property-setget
- void **set_custom_step** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_custom_step** **(** **)**
Overrides the step used when clicking increment and decrement buttons or when using arrow keys when the **ScrollBar** is focused.
.. |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.)`