NDEVR
API Documentation
PopupInfo

Class which is used to pass arguments and requests for creating a popup dialog or widget. More...

Public Member Functions

 PopupInfo ()
 Default constructor with all flags set to their defaults.
 PopupInfo (const QRect &rect)
 Constructs a PopupInfo with a specified animation origin rectangle.
 PopupInfo (QWidget *widget)
 Constructs a PopupInfo using a widget as the animation origin.

Public Attributes

bool allow_title_autohide = false
 Whether the title bar can auto-hide when not hovered.
int animation_speed = -1
 The animation speed in milliseconds, or -1 for the default.
bool closable = false
 Whether the popup can be closed by the user.
bool delete_on_hide = false
 Whether to delete the popup widget when it is hidden.
std::function< void()> finished_callback
 Optional callback invoked when the popup is closed.
bool fullscreen = false
 Whether the popup should be displayed fullscreen.
bool hideable = false
 Whether the popup can be hidden (minimized) by the user.
bool is_popup_menu = false
 Whether this popup behaves as a popup menu (auto-closes on focus loss).
bool make_call_widget_dialog = false
 Whether to wrap the widget in a call-widget-style dialog.
Qt::WindowModality modality = Qt::WindowModality::NonModal
 The window modality for the popup dialog.
QPointer< QWidget > parent_widget
 The parent widget for the popup.
QRect rect
 The screen rectangle used as the animation origin for the popup.
bool request_dock = false
 Whether the popup requests to be docked in the main window.
bool request_margins = false
 Whether to add margins around the popup content.
std::function< void(PopupInfo)> settings_callback
 If set, requests a settings button on the dialog.
QPointer< QWidget > widget
 The widget to display inside the popup.
bool windowable = false
 Whether the popup can be detached into a standalone window.

Detailed Description

Class which is used to pass arguments and requests for creating a popup dialog or widget.


You can request things like fullscreen, whether or not the dialog is closable, etc, as well as the animation origin for the popup.

Definition at line 15 of file PopupInfo.h.

Constructor & Destructor Documentation

◆ PopupInfo() [1/2]

PopupInfo::PopupInfo ( const QRect & rect)
inline

Constructs a PopupInfo with a specified animation origin rectangle.

Parameters
[in]rectThe rectangle to animate the popup from.

Definition at line 26 of file PopupInfo.h.

References rect.

◆ PopupInfo() [2/2]

PopupInfo::PopupInfo ( QWidget * widget)

Constructs a PopupInfo using a widget as the animation origin.

Parameters
[in]widgetThe widget whose screen geometry defines the animation origin.

References widget.


The documentation for this struct was generated from the following file: