SplitContainer.xml 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="SplitContainer" inherits="Container" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  3. <brief_description>
  4. Container for splitting and adjusting.
  5. </brief_description>
  6. <description>
  7. Container for splitting two [Control]s vertically or horizontally, with a grabber that allows adjusting the split offset or ratio.
  8. </description>
  9. <tutorials>
  10. <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link>
  11. </tutorials>
  12. <methods>
  13. <method name="clamp_split_offset">
  14. <return type="void" />
  15. <description>
  16. Clamps the [member split_offset] value to not go outside the currently possible minimal and maximum values.
  17. </description>
  18. </method>
  19. </methods>
  20. <members>
  21. <member name="collapsed" type="bool" setter="set_collapsed" getter="is_collapsed" default="false">
  22. If [code]true[/code], the area of the first [Control] will be collapsed and the dragger will be disabled.
  23. </member>
  24. <member name="dragger_visibility" type="int" setter="set_dragger_visibility" getter="get_dragger_visibility" enum="SplitContainer.DraggerVisibility" default="0">
  25. Determines the dragger's visibility. See [enum DraggerVisibility] for details.
  26. </member>
  27. <member name="split_offset" type="int" setter="set_split_offset" getter="get_split_offset" default="0">
  28. The initial offset of the splitting between the two [Control]s, with [code]0[/code] being at the end of the first [Control].
  29. </member>
  30. </members>
  31. <signals>
  32. <signal name="dragged">
  33. <argument index="0" name="offset" type="int" />
  34. <description>
  35. Emitted when the dragger is dragged by user.
  36. </description>
  37. </signal>
  38. </signals>
  39. <constants>
  40. <constant name="DRAGGER_VISIBLE" value="0" enum="DraggerVisibility">
  41. The split dragger is visible when the cursor hovers it.
  42. </constant>
  43. <constant name="DRAGGER_HIDDEN" value="1" enum="DraggerVisibility">
  44. The split dragger is never visible.
  45. </constant>
  46. <constant name="DRAGGER_HIDDEN_COLLAPSED" value="2" enum="DraggerVisibility">
  47. The split dragger is never visible and its space collapsed.
  48. </constant>
  49. </constants>
  50. </class>