class_popup.rst 3.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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/Popup.xml.
  6. .. _class_Popup:
  7. Popup
  8. =====
  9. **Inherits:** :ref:`Window<class_Window>` **<** :ref:`Viewport<class_Viewport>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`PopupMenu<class_PopupMenu>`, :ref:`PopupPanel<class_PopupPanel>`
  11. Popup is a base window container for popup-like subwindows.
  12. Description
  13. -----------
  14. 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.
  15. Properties
  16. ----------
  17. +-------------------------+---------------+-------------------------------------------------------------------------+
  18. | :ref:`bool<class_bool>` | borderless | ``true`` (overrides :ref:`Window<class_Window_property_borderless>`) |
  19. +-------------------------+---------------+-------------------------------------------------------------------------+
  20. | :ref:`bool<class_bool>` | popup_window | ``true`` (overrides :ref:`Window<class_Window_property_popup_window>`) |
  21. +-------------------------+---------------+-------------------------------------------------------------------------+
  22. | :ref:`bool<class_bool>` | transient | ``true`` (overrides :ref:`Window<class_Window_property_transient>`) |
  23. +-------------------------+---------------+-------------------------------------------------------------------------+
  24. | :ref:`bool<class_bool>` | unresizable | ``true`` (overrides :ref:`Window<class_Window_property_unresizable>`) |
  25. +-------------------------+---------------+-------------------------------------------------------------------------+
  26. | :ref:`bool<class_bool>` | visible | ``false`` (overrides :ref:`Window<class_Window_property_visible>`) |
  27. +-------------------------+---------------+-------------------------------------------------------------------------+
  28. | :ref:`bool<class_bool>` | wrap_controls | ``true`` (overrides :ref:`Window<class_Window_property_wrap_controls>`) |
  29. +-------------------------+---------------+-------------------------------------------------------------------------+
  30. Signals
  31. -------
  32. .. _class_Popup_signal_popup_hide:
  33. - **popup_hide** **(** **)**
  34. Emitted when the popup is hidden.
  35. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  36. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  37. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  38. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  39. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  40. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`