class_popuppanel.rst 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  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/PopupPanel.xml.
  6. .. _class_PopupPanel:
  7. PopupPanel
  8. ==========
  9. **Inherits:** :ref:`Popup<class_Popup>` **<** :ref:`Window<class_Window>` **<** :ref:`Viewport<class_Viewport>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. Class for displaying popups with a panel background.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. Class for displaying popups with a panel background. In some cases it might be simpler to use than :ref:`Popup<class_Popup>`, since it provides a configurable background. If you are making windows, better check :ref:`Window<class_Window>`.
  15. If any :ref:`Control<class_Control>` node is added as a child of this **PopupPanel**, it will be stretched to fit the panel's size (similar to how :ref:`PanelContainer<class_PanelContainer>` works).
  16. .. rst-class:: classref-reftable-group
  17. Theme Properties
  18. ----------------
  19. .. table::
  20. :widths: auto
  21. +---------------------------------+--------------------------------------------------+
  22. | :ref:`StyleBox<class_StyleBox>` | :ref:`panel<class_PopupPanel_theme_style_panel>` |
  23. +---------------------------------+--------------------------------------------------+
  24. .. rst-class:: classref-section-separator
  25. ----
  26. .. rst-class:: classref-descriptions-group
  27. Theme Property Descriptions
  28. ---------------------------
  29. .. _class_PopupPanel_theme_style_panel:
  30. .. rst-class:: classref-themeproperty
  31. :ref:`StyleBox<class_StyleBox>` **panel**
  32. The background panel style of this **PopupPanel**.
  33. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  34. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  35. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  36. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  37. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  38. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`