Slider.xml 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="Slider" inherits="Range" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  3. <brief_description>
  4. Base class for GUI sliders.
  5. </brief_description>
  6. <description>
  7. Base class for GUI sliders.
  8. [b]Note:[/b] The [signal Range.changed] and [signal Range.value_changed] signals are part of the [Range] class which this class inherits from.
  9. </description>
  10. <tutorials>
  11. </tutorials>
  12. <methods>
  13. </methods>
  14. <members>
  15. <member name="editable" type="bool" setter="set_editable" getter="is_editable" default="true">
  16. If [code]true[/code], the slider can be interacted with. If [code]false[/code], the value can be changed only by code.
  17. </member>
  18. <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" overrides="Control" enum="Control.FocusMode" default="2" />
  19. <member name="scrollable" type="bool" setter="set_scrollable" getter="is_scrollable" default="true">
  20. If [code]true[/code], the value can be changed using the mouse wheel.
  21. </member>
  22. <member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags" overrides="Control" default="0" />
  23. <member name="tick_count" type="int" setter="set_ticks" getter="get_ticks" default="0">
  24. Number of ticks displayed on the slider, including border ticks. Ticks are uniformly-distributed value markers.
  25. </member>
  26. <member name="ticks_on_borders" type="bool" setter="set_ticks_on_borders" getter="get_ticks_on_borders" default="false">
  27. If [code]true[/code], the slider will display ticks for minimum and maximum values.
  28. </member>
  29. </members>
  30. <signals>
  31. <signal name="drag_ended">
  32. <argument index="0" name="value_changed" type="bool" />
  33. <description>
  34. Emitted when dragging stops. If [code]value_changed[/code] is true, [member Range.value] is different from the value when you started the dragging.
  35. </description>
  36. </signal>
  37. <signal name="drag_started">
  38. <description>
  39. Emitted when dragging is started.
  40. </description>
  41. </signal>
  42. </signals>
  43. <constants>
  44. </constants>
  45. </class>