class_container.rst 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the Container.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_Container:
  6. Container
  7. =========
  8. **Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. **Inherited By:** :ref:`BoxContainer<class_BoxContainer>`, :ref:`CenterContainer<class_CenterContainer>`, :ref:`EditorProperty<class_EditorProperty>`, :ref:`GraphNode<class_GraphNode>`, :ref:`GridContainer<class_GridContainer>`, :ref:`MarginContainer<class_MarginContainer>`, :ref:`PanelContainer<class_PanelContainer>`, :ref:`ScrollContainer<class_ScrollContainer>`, :ref:`SplitContainer<class_SplitContainer>`, :ref:`TabContainer<class_TabContainer>`, :ref:`ViewportContainer<class_ViewportContainer>`
  10. Base node for containers.
  11. Description
  12. -----------
  13. Base node for containers. A ``Container`` contains other controls and automatically arranges them in a certain way.
  14. A Control can inherit this to create custom container classes.
  15. Properties
  16. ----------
  17. +----------------------------------------------+--------------+--------------+
  18. | :ref:`MouseFilter<enum_Control_MouseFilter>` | mouse_filter | **O:** ``1`` |
  19. +----------------------------------------------+--------------+--------------+
  20. Methods
  21. -------
  22. +------+----------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`fit_child_in_rect<class_Container_method_fit_child_in_rect>` **(** :ref:`Control<class_Control>` child, :ref:`Rect2<class_Rect2>` rect **)** |
  24. +------+----------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | void | :ref:`queue_sort<class_Container_method_queue_sort>` **(** **)** |
  26. +------+----------------------------------------------------------------------------------------------------------------------------------------------------+
  27. Signals
  28. -------
  29. .. _class_Container_signal_sort_children:
  30. - **sort_children** **(** **)**
  31. Emitted when sorting the children is needed.
  32. Constants
  33. ---------
  34. .. _class_Container_constant_NOTIFICATION_SORT_CHILDREN:
  35. - **NOTIFICATION_SORT_CHILDREN** = **50** --- Notification for when sorting the children, it must be obeyed immediately.
  36. Method Descriptions
  37. -------------------
  38. .. _class_Container_method_fit_child_in_rect:
  39. - void **fit_child_in_rect** **(** :ref:`Control<class_Control>` child, :ref:`Rect2<class_Rect2>` rect **)**
  40. Fit a child control in a given rect. This is mainly a helper for creating custom container classes.
  41. ----
  42. .. _class_Container_method_queue_sort:
  43. - void **queue_sort** **(** **)**
  44. Queue resort of the contained children. This is called automatically anyway, but can be called upon request.