Base container control for popups and dialogs.
    public class Popup : Control

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.

Inheritance Chain

Derived Classes

Static Fields

    public const Int32 NotificationPopupHide = 81

    public const Int32 NotificationPostPopup = 80

Constructors

    public Popup()

Signals

    "about_to_show" ()

Emitted when a popup is about to be shown. This is often used in PopupMenu to clear the list of options then create a new one according to the current context.

    "popup_hide" ()

Emitted when a popup is hidden.

Properties

    public bool PopupExclusive { get; set; }

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.

Methods

    [Obsolete("IsExclusive is deprecated. Use the PopupExclusive property instead.")]
    public bool IsExclusive()

Getter for PopupExclusive

    public void Popup_(Rect2? bounds = default(Rect2?))

Popup (show the control in modal form).

    public void PopupCentered(Vector2? size = default(Vector2?))

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.

    public void PopupCenteredClamped(Vector2? size = default(Vector2?), float fallbackRatio = 0.75f)

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 fallbackRatio.

    public void PopupCenteredMinsize(Vector2? minsize = default(Vector2?))

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.

    public void PopupCenteredRatio(float ratio = 0.75f)

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.

    public void SetAsMinsize()

Shrink popup to keep to the minimum size of content.

    [Obsolete("SetExclusive is deprecated. Use the PopupExclusive property instead.")]
    public void SetExclusive(bool enable)

Setter for PopupExclusive

Tags: