class_vslider.rst 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VSlider.xml.
  6. .. _class_VSlider:
  7. VSlider
  8. =======
  9. **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>`
  10. Vertical slider.
  11. Description
  12. -----------
  13. Vertical slider. See :ref:`Slider<class_Slider>`. This one goes from bottom (min) to top (max).
  14. \ **Note:** The :ref:`Range.changed<class_Range_signal_changed>` and :ref:`Range.value_changed<class_Range_signal_value_changed>` signals are part of the :ref:`Range<class_Range>` class which this class inherits from.
  15. Properties
  16. ----------
  17. +-----------------------+-----------------------+--------------------------------------------------------------------------------+
  18. | :ref:`int<class_int>` | size_flags_horizontal | ``0`` (overrides :ref:`Control<class_Control_property_size_flags_horizontal>`) |
  19. +-----------------------+-----------------------+--------------------------------------------------------------------------------+
  20. | :ref:`int<class_int>` | size_flags_vertical | ``1`` (overrides :ref:`Control<class_Control_property_size_flags_vertical>`) |
  21. +-----------------------+-----------------------+--------------------------------------------------------------------------------+
  22. Theme Properties
  23. ----------------
  24. +-----------------------------------+---------------------------------------------------------------------------------+
  25. | :ref:`Texture2D<class_Texture2D>` | :ref:`grabber<class_VSlider_theme_icon_grabber>` |
  26. +-----------------------------------+---------------------------------------------------------------------------------+
  27. | :ref:`Texture2D<class_Texture2D>` | :ref:`grabber_disabled<class_VSlider_theme_icon_grabber_disabled>` |
  28. +-----------------------------------+---------------------------------------------------------------------------------+
  29. | :ref:`Texture2D<class_Texture2D>` | :ref:`grabber_highlight<class_VSlider_theme_icon_grabber_highlight>` |
  30. +-----------------------------------+---------------------------------------------------------------------------------+
  31. | :ref:`Texture2D<class_Texture2D>` | :ref:`tick<class_VSlider_theme_icon_tick>` |
  32. +-----------------------------------+---------------------------------------------------------------------------------+
  33. | :ref:`StyleBox<class_StyleBox>` | :ref:`grabber_area<class_VSlider_theme_style_grabber_area>` |
  34. +-----------------------------------+---------------------------------------------------------------------------------+
  35. | :ref:`StyleBox<class_StyleBox>` | :ref:`grabber_area_highlight<class_VSlider_theme_style_grabber_area_highlight>` |
  36. +-----------------------------------+---------------------------------------------------------------------------------+
  37. | :ref:`StyleBox<class_StyleBox>` | :ref:`slider<class_VSlider_theme_style_slider>` |
  38. +-----------------------------------+---------------------------------------------------------------------------------+
  39. Theme Property Descriptions
  40. ---------------------------
  41. .. _class_VSlider_theme_icon_grabber:
  42. - :ref:`Texture2D<class_Texture2D>` **grabber**
  43. The texture for the grabber (the draggable element).
  44. ----
  45. .. _class_VSlider_theme_icon_grabber_disabled:
  46. - :ref:`Texture2D<class_Texture2D>` **grabber_disabled**
  47. The texture for the grabber when it's disabled.
  48. ----
  49. .. _class_VSlider_theme_icon_grabber_highlight:
  50. - :ref:`Texture2D<class_Texture2D>` **grabber_highlight**
  51. The texture for the grabber when it's focused.
  52. ----
  53. .. _class_VSlider_theme_icon_tick:
  54. - :ref:`Texture2D<class_Texture2D>` **tick**
  55. The texture for the ticks, visible when :ref:`Slider.tick_count<class_Slider_property_tick_count>` is greater than 0.
  56. ----
  57. .. _class_VSlider_theme_style_grabber_area:
  58. - :ref:`StyleBox<class_StyleBox>` **grabber_area**
  59. The background of the area below the grabber.
  60. ----
  61. .. _class_VSlider_theme_style_grabber_area_highlight:
  62. - :ref:`StyleBox<class_StyleBox>` **grabber_area_highlight**
  63. ----
  64. .. _class_VSlider_theme_style_slider:
  65. - :ref:`StyleBox<class_StyleBox>` **slider**
  66. The background for the whole slider. Determines the width of the ``grabber_area``.
  67. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  68. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  69. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  70. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  71. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  72. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`