Files
godot-docs/classes/class_slider.rst
2017-10-21 13:55:57 +02:00

99 lines
3.7 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Slider.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_Slider:
Slider
======
**Inherits:** :ref:`Range<class_range>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Inherited By:** :ref:`HSlider<class_hslider>`, :ref:`VSlider<class_vslider>`
**Category:** Core
Brief Description
-----------------
Base class for GUI Sliders.
Member Functions
----------------
+--------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_ticks<class_Slider_get_ticks>` **(** **)** const |
+--------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_ticks_on_borders<class_Slider_get_ticks_on_borders>` **(** **)** const |
+--------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_editable<class_Slider_is_editable>` **(** **)** const |
+--------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_editable<class_Slider_set_editable>` **(** :ref:`bool<class_bool>` editable **)** |
+--------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ticks<class_Slider_set_ticks>` **(** :ref:`int<class_int>` count **)** |
+--------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ticks_on_borders<class_Slider_set_ticks_on_borders>` **(** :ref:`bool<class_bool>` ticks_on_border **)** |
+--------------------------+----------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_Slider_editable:
- :ref:`bool<class_bool>` **editable**
.. _class_Slider_focus_mode:
- :ref:`int<class_int>` **focus_mode**
.. _class_Slider_tick_count:
- :ref:`int<class_int>` **tick_count**
.. _class_Slider_ticks_on_borders:
- :ref:`bool<class_bool>` **ticks_on_borders**
Description
-----------
Base class for GUI Sliders.
Member Function Description
---------------------------
.. _class_Slider_get_ticks:
- :ref:`int<class_int>` **get_ticks** **(** **)** const
Return amounts of ticks to display on slider.
.. _class_Slider_get_ticks_on_borders:
- :ref:`bool<class_bool>` **get_ticks_on_borders** **(** **)** const
Return true if ticks are visible on borders.
.. _class_Slider_is_editable:
- :ref:`bool<class_bool>` **is_editable** **(** **)** const
.. _class_Slider_set_editable:
- void **set_editable** **(** :ref:`bool<class_bool>` editable **)**
.. _class_Slider_set_ticks:
- void **set_ticks** **(** :ref:`int<class_int>` count **)**
Set amount of ticks to display in slider.
.. _class_Slider_set_ticks_on_borders:
- void **set_ticks_on_borders** **(** :ref:`bool<class_bool>` ticks_on_border **)**
Set true if ticks are visible on borders.