Public Member Functions | Protected Slots | List of all members
pqPopOutWidget Class Reference

This pqPopOutWidget provides a mechanism to pop out its contained widget into a dialog return it to its prior location. More...

#include <pqPopOutWidget.h>

Inherits QWidget.

Public Member Functions

 pqPopOutWidget (QWidget *widgetToPopOut, const QString &dialogTitle, QWidget *p=nullptr)
 Constructs a pqPopOutWidget wrapping the given widget and using the given string as the title of the dialog when the widget is popped out. More...
 
 ~pqPopOutWidget () override
 
void setPopOutButton (QPushButton *button)
 Sets the button that will control when the widget is popped out to the dialog. More...
 

Protected Slots

void toggleWidgetLocation ()
 Moves the widget to the other location. More...
 
void moveWidgetToDialog ()
 Moves the widget to the dialog and shows the dialog if the widget is not in the dialog. More...
 
void moveWidgetBackToParent ()
 Moves the widget from the dialog back to being a child of this widget. More...
 

Detailed Description

This pqPopOutWidget provides a mechanism to pop out its contained widget into a dialog return it to its prior location.

As layout and contained widgets are managed internally, do not call its inherited functions that modify these.

Definition at line 49 of file pqPopOutWidget.h.

Constructor & Destructor Documentation

◆ pqPopOutWidget()

pqPopOutWidget::pqPopOutWidget ( QWidget *  widgetToPopOut,
const QString &  dialogTitle,
QWidget *  p = nullptr 
)

Constructs a pqPopOutWidget wrapping the given widget and using the given string as the title of the dialog when the widget is popped out.

◆ ~pqPopOutWidget()

pqPopOutWidget::~pqPopOutWidget ( )
override

Member Function Documentation

◆ setPopOutButton()

void pqPopOutWidget::setPopOutButton ( QPushButton *  button)

Sets the button that will control when the widget is popped out to the dialog.

This function connects the button to the appropriate slots and will cause its icon to be updated based on whether the dialog is visible or not.

◆ toggleWidgetLocation

void pqPopOutWidget::toggleWidgetLocation ( )
protectedslot

Moves the widget to the other location.

◆ moveWidgetToDialog

void pqPopOutWidget::moveWidgetToDialog ( )
protectedslot

Moves the widget to the dialog and shows the dialog if the widget is not in the dialog.

If the widget is already in the dialog, this function does nothing.

◆ moveWidgetBackToParent

void pqPopOutWidget::moveWidgetBackToParent ( )
protectedslot

Moves the widget from the dialog back to being a child of this widget.

This slot also hides the dialog if it is visible. This slot does nothing if the widget is not in the dialog and is automatically called when the dialog is closed.


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