mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 19:29:06 +00:00
72 lines
3.8 KiB
ReStructuredText
72 lines
3.8 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the Popup.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_Popup:
|
|
|
|
Popup
|
|
=====
|
|
|
|
**Inherits:** :ref:`Window<class_Window>` **<** :ref:`Viewport<class_Viewport>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Inherited By:** :ref:`PopupMenu<class_PopupMenu>`, :ref:`PopupPanel<class_PopupPanel>`
|
|
|
|
Base container control for popups and dialogs.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Popup is a base :ref:`Control<class_Control>` used to show dialogs and popups. It's a subwindow and modal by default (see :ref:`Control<class_Control>`) and has helpers for custom popup behavior.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------+--------------------------------------------------------------------------+-------------------------------+
|
|
| :ref:`bool<class_bool>` | borderless | ``true`` *(parent override)* |
|
|
+-------------------------+--------------------------------------------------------------------------+-------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`close_on_parent_focus<class_Popup_property_close_on_parent_focus>` | ``true`` |
|
|
+-------------------------+--------------------------------------------------------------------------+-------------------------------+
|
|
| :ref:`bool<class_bool>` | transient | ``true`` *(parent override)* |
|
|
+-------------------------+--------------------------------------------------------------------------+-------------------------------+
|
|
| :ref:`bool<class_bool>` | unresizable | ``true`` *(parent override)* |
|
|
+-------------------------+--------------------------------------------------------------------------+-------------------------------+
|
|
| :ref:`bool<class_bool>` | visible | ``false`` *(parent override)* |
|
|
+-------------------------+--------------------------------------------------------------------------+-------------------------------+
|
|
| :ref:`bool<class_bool>` | wrap_controls | ``true`` *(parent override)* |
|
|
+-------------------------+--------------------------------------------------------------------------+-------------------------------+
|
|
|
|
Signals
|
|
-------
|
|
|
|
.. _class_Popup_signal_popup_hide:
|
|
|
|
- **popup_hide** **(** **)**
|
|
|
|
Emitted when a popup is hidden.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_Popup_property_close_on_parent_focus:
|
|
|
|
- :ref:`bool<class_bool>` **close_on_parent_focus**
|
|
|
|
+-----------+----------------------------------+
|
|
| *Default* | ``true`` |
|
|
+-----------+----------------------------------+
|
|
| *Setter* | set_close_on_parent_focus(value) |
|
|
+-----------+----------------------------------+
|
|
| *Getter* | get_close_on_parent_focus() |
|
|
+-----------+----------------------------------+
|
|
|
|
If ``true``, the ``Popup`` will close when its parent is focused.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|