class_popuppanel.rst 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  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. A popup with a panel background.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. A popup with a configurable panel background. Any child controls added to this node will be stretched to fit the panel's size (similar to how :ref:`PanelContainer<class_PanelContainer>` works). If you are making windows, see :ref:`Window<class_Window>`.
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +-------------------------+----------------+------------------------------------------------------------------------------+
  21. | :ref:`bool<class_bool>` | transparent | ``true`` (overrides :ref:`Window<class_Window_property_transparent>`) |
  22. +-------------------------+----------------+------------------------------------------------------------------------------+
  23. | :ref:`bool<class_bool>` | transparent_bg | ``true`` (overrides :ref:`Viewport<class_Viewport_property_transparent_bg>`) |
  24. +-------------------------+----------------+------------------------------------------------------------------------------+
  25. .. rst-class:: classref-reftable-group
  26. Theme Properties
  27. ----------------
  28. .. table::
  29. :widths: auto
  30. +---------------------------------+--------------------------------------------------+
  31. | :ref:`StyleBox<class_StyleBox>` | :ref:`panel<class_PopupPanel_theme_style_panel>` |
  32. +---------------------------------+--------------------------------------------------+
  33. .. rst-class:: classref-section-separator
  34. ----
  35. .. rst-class:: classref-descriptions-group
  36. Theme Property Descriptions
  37. ---------------------------
  38. .. _class_PopupPanel_theme_style_panel:
  39. .. rst-class:: classref-themeproperty
  40. :ref:`StyleBox<class_StyleBox>` **panel** :ref:`🔗<class_PopupPanel_theme_style_panel>`
  41. :ref:`StyleBox<class_StyleBox>` for the background panel.
  42. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  43. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  44. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  45. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  46. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  47. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  48. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  49. .. |void| replace:: :abbr:`void (No return value.)`