PopupManager

Responsible for displaying widgets that want to be in their own window. More...

Inheritance diagram for PopupManager:

Collaboration diagram for PopupManager:

Public Member Functions
	PopupManager ()
	Constructs a PopupManager.
virtual ContainerWidgetBase *	container () const
	Returns the primary container widget for adding new docks.
virtual DropArea	defaultDropArea (const QCustomDockWidget *) const
	Returns the default drop area for a dock widget.
virtual SectionWidget *	defaultDropReference (const QCustomDockWidget *) const
	Returns the default drop reference section for a dock widget.
virtual RibbonArea	defaultRibbonArea (const QCustomDockWidget *)
	Returns the default ribbon area for a dock widget.
virtual void	hideWidget (QWidget *widget, const PopupInfo &popup_origin)
	Hides a widget that was previously shown as a popup.
void	setupAsPopupHandler ()
	Registers this manager as the application's popup handler service.
virtual bool	showWidget (QWidget *widget, PopupInfo popup_origin, PopupInfo popup_end)
	Shows a widget as a popup with animation from origin to destination.

Protected Attributes
Dictionary< QObject *, QPointer< QCustomDockWidget > >	m_docks
	Mapping of objects to their associated dock widgets.
PopupWidget *	m_popup_widget = nullptr
	The popup widget used for displaying popup content.

Detailed Description

Responsible for displaying widgets that want to be in their own window.

---

Definition at line 16 of file PopupManager.h.

Member Function Documentation

container()

virtual ContainerWidgetBase * PopupManager::container ( ) const

inlinevirtual

Returns the primary container widget for adding new docks.

---

Returns

The primary container widget, as defined by the application

Reimplemented in DatasetView, FormSheetWindowManager, and QTWindowManager.

Definition at line 60 of file PopupManager.h.

defaultDropArea()

virtual DropArea PopupManager::defaultDropArea ( const QCustomDockWidget * ) const

inlinevirtual

Returns the default drop area for a dock widget.

Returns

The default DropArea, which is e_drop_popup.

Reimplemented in QTWindowManager, and WindowManager.

Definition at line 45 of file PopupManager.h.

References e_drop_popup.

defaultDropReference()

virtual SectionWidget * PopupManager::defaultDropReference ( const QCustomDockWidget * ) const

inlinevirtual

Returns the default drop reference section for a dock widget.

Returns

nullptr by default (no reference section).

Reimplemented in QTWindowManager, and WindowManager.

Definition at line 50 of file PopupManager.h.

defaultRibbonArea()

virtual RibbonArea PopupManager::defaultRibbonArea ( const QCustomDockWidget * )

inlinevirtual

Returns the default ribbon area for a dock widget.

Returns

The default RibbonArea, which is e_top.

Reimplemented in QTWindowManager.

Definition at line 55 of file PopupManager.h.

References e_top.

hideWidget()

virtual void PopupManager::hideWidget ( QWidget * widget, const PopupInfo & popup_origin )

virtual

Hides a widget that was previously shown as a popup.

Parameters

[in]	widget	The widget to hide.
[in]	popup_origin	The popup info describing the hide animation target.

showWidget()

virtual bool PopupManager::showWidget ( QWidget * widget, PopupInfo popup_origin, PopupInfo popup_end )

virtual

Shows a widget as a popup with animation from origin to destination.

Parameters

[in]	widget	The widget to show.
[in]	popup_origin	The popup info describing the animation start.
[in]	popup_end	The popup info describing the animation end and display settings.

Returns

True if the widget was successfully shown.

---

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

• Widgets/Headers/PopupManager.h