class_popup.rst 3.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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. Base class for contextual windows and panels with fixed position.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. **Popup** is a base class for contextual windows and panels with fixed position. It's a modal by default (see :ref:`Window.popup_window<class_Window_property_popup_window>`) and provides methods for implementing custom popup behavior.
  16. .. rst-class:: classref-reftable-group
  17. Properties
  18. ----------
  19. .. table::
  20. :widths: auto
  21. +-------------------------+---------------+-------------------------------------------------------------------------+
  22. | :ref:`bool<class_bool>` | borderless | ``true`` (overrides :ref:`Window<class_Window_property_borderless>`) |
  23. +-------------------------+---------------+-------------------------------------------------------------------------+
  24. | :ref:`bool<class_bool>` | popup_window | ``true`` (overrides :ref:`Window<class_Window_property_popup_window>`) |
  25. +-------------------------+---------------+-------------------------------------------------------------------------+
  26. | :ref:`bool<class_bool>` | transient | ``true`` (overrides :ref:`Window<class_Window_property_transient>`) |
  27. +-------------------------+---------------+-------------------------------------------------------------------------+
  28. | :ref:`bool<class_bool>` | unresizable | ``true`` (overrides :ref:`Window<class_Window_property_unresizable>`) |
  29. +-------------------------+---------------+-------------------------------------------------------------------------+
  30. | :ref:`bool<class_bool>` | visible | ``false`` (overrides :ref:`Window<class_Window_property_visible>`) |
  31. +-------------------------+---------------+-------------------------------------------------------------------------+
  32. | :ref:`bool<class_bool>` | wrap_controls | ``true`` (overrides :ref:`Window<class_Window_property_wrap_controls>`) |
  33. +-------------------------+---------------+-------------------------------------------------------------------------+
  34. .. rst-class:: classref-section-separator
  35. ----
  36. .. rst-class:: classref-descriptions-group
  37. Signals
  38. -------
  39. .. _class_Popup_signal_popup_hide:
  40. .. rst-class:: classref-signal
  41. **popup_hide**\ (\ ) :ref:`🔗<class_Popup_signal_popup_hide>`
  42. Emitted when the popup is hidden.
  43. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  44. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  45. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  46. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  47. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  48. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  49. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  50. .. |void| replace:: :abbr:`void (No return value.)`