Wrapper widget for existing widgets which can't have the inheritance tree changed, e.g dialogs. More...

Inheritance diagram for QgsPanelWidgetWrapper:

Public Member Functions
	QgsPanelWidgetWrapper (QWidget widget, QWidget parent=nullptr)
	Wrapper widget for existing widgets which can't have the inheritance tree changed, e.g dialogs. More...

QWidget *	widget ()
	Returns the internal widget that is wrapped in this panel. More...

Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as a inline panel. More...

bool	autoDelete ()
	The the auto delete property on the widget. More...

void	connectChildPanel (QgsPanelWidget *panel)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More...

void	connectChildPanels (const QList< QgsPanelWidget * > &panels)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More...

bool	dockMode ()
	Returns the dock mode state. More...

QString	panelTitle ()
	The title of the panel. More...

void	setAutoDelete (bool autoDelete)
	The the auto delete property on the widget. More...

virtual void	setDockMode (bool dockMode)
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...

void	setPanelTitle (const QString &panelTitle)
	Set the title of the panel when shown in the interface. More...

Additional Inherited Members
Public Slots inherited from QgsPanelWidget
void	acceptPanel ()
	Accept the panel. More...

void	openPanel (QgsPanelWidget *panel)
	Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the showPanel signal for connected slots to handle the open event. More...

Signals inherited from QgsPanelWidget
void	panelAccepted (QgsPanelWidget *panel)
	Emitted when the panel is accepted by the user. More...

void	showPanel (QgsPanelWidget *panel)
	Emit when you require a panel to be show in the interface. More...

void	widgetChanged ()
	Emitted when the widget state changes. More...

Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidget *	findParentPanel (QWidget *widget)
	Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More...

Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget. More...

Detailed Description

Wrapper widget for existing widgets which can't have the inheritance tree changed, e.g dialogs.

Note: Generally you should use the QgsPanelWidget class if you can and only use this wrapper if you can't update your code.

Definition at line 181 of file qgspanelwidget.h.

Constructor & Destructor Documentation

QgsPanelWidgetWrapper::QgsPanelWidgetWrapper	(	QWidget *	widget,
		QWidget *	parent = `nullptr`
	)

Wrapper widget for existing widgets which can't have the inheritance tree changed, e.g dialogs.

Parameters

widget	The widget to wrap.
parent	The parent widget.

Definition at line 109 of file qgspanelwidget.cpp.

QWidget* QgsPanelWidgetWrapper::widget ( )

inline

Returns the internal widget that is wrapped in this panel.

Definition at line 198 of file qgspanelwidget.h.

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