Popup¶

Inherits: Control < CanvasItem < Node < Object

Inherited By: PopupDialog, PopupMenu, PopupPanel, WindowDialog

Category: Core

Brief Description¶

Base container control for popups and dialogs.

Properties¶

bool	popup_exclusive

Methods¶

void	popup ( Rect2 bounds=Rect2( 0, 0, 0, 0 ) )
void	popup_centered ( Vector2 size=Vector2( 0, 0 ) )
void	popup_centered_clamped ( Vector2 size=Vector2( 0, 0 ), float fallback_ratio=0.75 )
void	popup_centered_minsize ( Vector2 minsize=Vector2( 0, 0 ) )
void	popup_centered_ratio ( float ratio=0.75 )

Signals¶

This signal is emitted when a popup is about to be shown. (often used in PopupMenu for clearing the list of options and creating a new one according to the current context).

This signal is emitted when a popup is hidden.

Constants¶

Description¶

Popup is a base Control used to show dialogs and popups. It’s a subwindow and modal by default (see Control) and has helpers for custom popup behavior.

Property Descriptions¶

Setter	set_exclusive(value)
Getter	is_exclusive()

If true, the popup will not be hidden when a click event occurs outside of it, or when it receives the ui_cancel action event.

Method Descriptions¶

Popup (show the control in modal form).

Popup (show the control in modal form) in the center of the screen relative to its current canvas transform, at the current size, or at a size determined by «size».

Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, clamping the size to size, then ensuring the popup is no larger than the viewport size multiplied by fallback_ratio.

Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, ensuring the size is never smaller than minsize.

Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, scaled at a ratio of size of the screen.