Class: QgsPanelWidgetStack

class qgis.gui.QgsPanelWidgetStack(parent: QWidget = None)

Bases: PyQt5.QtWidgets.QWidget

A stack widget to manage panels in the interface. Handles the open and close events for added panels.

Parameters:parent

A stack widget to manage panels in the interface. Handles the open and close events for added panels. Any widgets that want to have a non blocking panel based interface should use this class to manage the panels.

Methods

acceptAllPanels Accepts all panel widgets open in the stack in turn until until only the mainPanel() remains.
acceptCurrentPanel Accept the current active widget in the stack.
actionEvent
changeEvent
childEvent
clear Clear the stack of all widgets.
closeEvent
closePanel Closes the panel in the widget.
connectNotify
contextMenuEvent
create
currentPanel Returns the panel currently shown in the stack.
customEvent
destroy
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
enterEvent
event
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
hideEvent
initPainter
inputMethodEvent
isSignalConnected
keyPressEvent
keyReleaseEvent
leaveEvent
mainPanel The main panel widget that is set in the stack.
metric
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveEvent
nativeEvent
paintEvent
receivers
resizeEvent
sender
senderSignalIndex
setMainPanel Sets the main panel widget for the stack and selects it for the user.
sharedPainter
showEvent
showPanel Show a panel in the stack widget.
tabletEvent
takeMainPanel Removes the main panel widget from the stack and transfers ownsership to the caller.
timerEvent
updateMicroFocus
wheelEvent

Signals

Attributes

acceptAllPanels(self)

Accepts all panel widgets open in the stack in turn until until only the mainPanel() remains.

New in version 3.0.

acceptCurrentPanel(self)

Accept the current active widget in the stack.

Calls the panelAccepeted signal on the active widget.

actionEvent()
changeEvent()
childEvent()
clear(self)

Clear the stack of all widgets. Unless the panels autoDelete is set to false the widget will be deleted.

closeEvent()
closePanel(self, panel: QgsPanelWidget)

Closes the panel in the widget. Will also delete the widget. This slot is normally auto connected to panelAccepted when a panel is shown.

Parameters:panel – The panel to close.
connectNotify()
contextMenuEvent()
create()
currentPanel(self) → QgsPanelWidget

Returns the panel currently shown in the stack.

New in version 3.0.

customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
initPainter()
inputMethodEvent()
isSignalConnected()
keyPressEvent(self, e: QKeyEvent)
keyReleaseEvent()
leaveEvent()
mainPanel(self) → QgsPanelWidget

The main panel widget that is set in the stack. The main widget can not be closed and doesn’t display a back button.

Returns:The main QgsPanelWidget that is active in the stack.

See also

setMainPanel()

metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent(self, e: QMouseEvent)
moveEvent()
nativeEvent()
paintEvent()
receivers()
resizeEvent()
sender()
senderSignalIndex()
setMainPanel(self, panel: QgsPanelWidget)

Sets the main panel widget for the stack and selects it for the user.

The main widget cannot be closed and only the showPanel signal is attached to handle children widget opening panels.

Ownership of panel is transferred to the stack.

Note

a stack can have only one main panel. Any existing main panel should be removed by first calling takeMainPanel().

See also

mainPanel()

See also

takeMainPanel()

sharedPainter()
showEvent()
showPanel(self, panel: QgsPanelWidget)

Show a panel in the stack widget. Will connect to the panels showPanel event to handle nested panels. Auto switches the the given panel for the user.

Parameters:panel – The panel to show.
tabletEvent()
takeMainPanel(self) → QgsPanelWidget

Removes the main panel widget from the stack and transfers ownsership to the caller.

Returns:The main widget that is set in the stack.

Note

Calling this will clear out any current stacked panels by accepting each panel in turn.

See also

mainPanel()

See also

setMainPanel()

timerEvent()
updateMicroFocus()
wheelEvent()