Popup QML Type
A styled popup container for overlays. More...
| Import Statement: | import FluentUI 1.0 |
Properties
- closePolicy : enumeration
- contentHeight : real
- contentItem : Item
- contentWidth : real
- height : real
- margins : real
- modal : bool
- open : bool
- padding : real
- width : real
- x : real
- y : real
Signals
Methods
Detailed Description
Popup provides a styled overlay container that can display content above the current window. It supports modal and modeless modes, configurable close policies, and customizable margins and padding. The popup can be opened and closed programmatically and emits signals when its visibility changes.
Property Documentation
closePolicy : enumeration
Determines the conditions under which the popup is automatically closed. Common values include Popup.CloseOnEscape, Popup.CloseOnPressOutside, Popup.CloseOnReleaseOutside, and Popup.NoAutoClose.
contentHeight : real
The height of the content area inside the popup, excluding margins and padding.
contentItem : Item
The visual content item displayed inside the popup.
contentWidth : real
The width of the content area inside the popup, excluding margins and padding.
height : real
The height of the popup.
margins : real
The margins around the popup content within the popup item. This affects the placement of the content inside the popup frame.
modal : bool
Whether the popup blocks input to other content behind it. When true, events outside the popup are blocked.
open : bool
Whether the popup is currently open. Set to true to open the popup and false to close it.
padding : real
The padding inside the popup, determining the space between the popup border and its content item.
width : real
The width of the popup.
x : real
The x-coordinate of the popup within its parent.
y : real
The y-coordinate of the popup within its parent.
Signal Documentation
closed()
Emitted when the popup has been closed, after the close animation has completed.
Note: The corresponding handler is onClosed.
opened()
Emitted when the popup has been opened, after the open animation has completed.
Note: The corresponding handler is onOpened.
Method Documentation
void close()
Closes the popup, hiding it from view. This is equivalent to setting the open property to false.
void open()
Opens the popup, making it visible. This is equivalent to setting the open property to true.