SplitContainer.xml 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="SplitContainer" inherits="Container" version="3.3">
  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. </tutorials>
  11. <methods>
  12. <method name="clamp_split_offset">
  13. <return type="void" />
  14. <description>
  15. Clamps the [member split_offset] value to not go outside the currently possible minimal and maximum values.
  16. </description>
  17. </method>
  18. </methods>
  19. <members>
  20. <member name="collapsed" type="bool" setter="set_collapsed" getter="is_collapsed" default="false">
  21. If [code]true[/code], the area of the first [Control] will be collapsed and the dragger will be disabled.
  22. </member>
  23. <member name="dragger_visibility" type="int" setter="set_dragger_visibility" getter="get_dragger_visibility" enum="SplitContainer.DraggerVisibility" default="0">
  24. Determines the dragger's visibility. See [enum DraggerVisibility] for details.
  25. </member>
  26. <member name="split_offset" type="int" setter="set_split_offset" getter="get_split_offset" default="0">
  27. The initial offset of the splitting between the two [Control]s, with [code]0[/code] being at the end of the first [Control].
  28. </member>
  29. </members>
  30. <signals>
  31. <signal name="dragged">
  32. <argument index="0" name="offset" type="int" />
  33. <description>
  34. Emitted when the dragger is dragged by user.
  35. </description>
  36. </signal>
  37. </signals>
  38. <constants>
  39. <constant name="DRAGGER_VISIBLE" value="0" enum="DraggerVisibility">
  40. The split dragger is visible when the cursor hovers it.
  41. </constant>
  42. <constant name="DRAGGER_HIDDEN" value="1" enum="DraggerVisibility">
  43. The split dragger is never visible.
  44. </constant>
  45. <constant name="DRAGGER_HIDDEN_COLLAPSED" value="2" enum="DraggerVisibility">
  46. The split dragger is never visible and its space collapsed.
  47. </constant>
  48. </constants>
  49. </class>