class_popup.rst 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the Popup.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_Popup:
  6. Popup
  7. =====
  8. **Inherits:** :ref:`Window<class_Window>` **<** :ref:`Viewport<class_Viewport>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. **Inherited By:** :ref:`PopupMenu<class_PopupMenu>`, :ref:`PopupPanel<class_PopupPanel>`
  10. Popup is a base window container for popup-like subwindows.
  11. Description
  12. -----------
  13. Popup is a base window container for popup-like subwindows. It's a modal by default (see :ref:`popup_window<class_Popup_property_popup_window>`) and has helpers for custom popup behavior.
  14. Properties
  15. ----------
  16. +-------------------------+---------------+-------------------------------------------------------------------------+
  17. | :ref:`bool<class_bool>` | borderless | ``true`` (overrides :ref:`Window<class_Window_property_borderless>`) |
  18. +-------------------------+---------------+-------------------------------------------------------------------------+
  19. | :ref:`bool<class_bool>` | popup_window | ``true`` (overrides :ref:`Window<class_Window_property_popup_window>`) |
  20. +-------------------------+---------------+-------------------------------------------------------------------------+
  21. | :ref:`bool<class_bool>` | transient | ``true`` (overrides :ref:`Window<class_Window_property_transient>`) |
  22. +-------------------------+---------------+-------------------------------------------------------------------------+
  23. | :ref:`bool<class_bool>` | unresizable | ``true`` (overrides :ref:`Window<class_Window_property_unresizable>`) |
  24. +-------------------------+---------------+-------------------------------------------------------------------------+
  25. | :ref:`bool<class_bool>` | visible | ``false`` (overrides :ref:`Window<class_Window_property_visible>`) |
  26. +-------------------------+---------------+-------------------------------------------------------------------------+
  27. | :ref:`bool<class_bool>` | wrap_controls | ``true`` (overrides :ref:`Window<class_Window_property_wrap_controls>`) |
  28. +-------------------------+---------------+-------------------------------------------------------------------------+
  29. Signals
  30. -------
  31. .. _class_Popup_signal_popup_hide:
  32. - **popup_hide** **(** **)**
  33. Emitted when the popup is hidden.
  34. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  35. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  36. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  37. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  38. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  39. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`