PySide6.QtWidgets.QStackedLayout

class QStackedLayout

The QStackedLayout class provides a stack of widgets where only one widget is visible at a time. More…

Inheritance diagram of PySide6.QtWidgets.QStackedLayout

Synopsis

Properties

Methods

Slots

Signals

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

QStackedLayout can be used to create a user interface similar to the one provided by QTabWidget . There is also a convenience QStackedWidget class built on top of QStackedLayout .

A QStackedLayout can be populated with a number of child widgets (“pages”). For example:

firstPageWidget = QWidget()
secondPageWidget = QWidget()
thirdPageWidget = QWidget()
stackedLayout = QStackedLayout()
stackedLayout.addWidget(firstPageWidget)
stackedLayout.addWidget(secondPageWidget)
stackedLayout.addWidget(thirdPageWidget)

mainLayout = QVBoxLayout()
mainLayout.addLayout(stackedLayout)
setLayout(mainLayout)

QStackedLayout provides no intrinsic means for the user to switch page. This is typically done through a QComboBox or a QListWidget that stores the titles of the QStackedLayout ‘s pages. For example:

pageComboBox = QComboBox()
pageComboBox.addItem(tr("Page 1"))
pageComboBox.addItem(tr("Page 2"))
pageComboBox.addItem(tr("Page 3"))
pageComboBox.activated.connect(
        stackedLayout.setCurrentIndex)

When populating a layout, the widgets are added to an internal list. The indexOf() function returns the index of a widget in that list. The widgets can either be added to the end of the list using the addWidget() function, or inserted at a given index using the insertWidget() function. The removeWidget() function removes the widget at the given index from the layout. The number of widgets contained in the layout, can be obtained using the count() function.

The widget() function returns the widget at a given index position. The index of the widget that is shown on screen is given by currentIndex() and can be changed using setCurrentIndex() . In a similar manner, the currently shown widget can be retrieved using the currentWidget() function, and altered using the setCurrentWidget() function.

Whenever the current widget in the layout changes or a widget is removed from the layout, the currentChanged() and widgetRemoved() signals are emitted respectively.

class StackingMode

This enum specifies how the layout handles its child widgets regarding their visibility.

Constant

Description

QStackedLayout.StackOne

Only the current widget is visible. This is the default.

QStackedLayout.StackAll

All widgets are visible. The current widget is merely raised.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property currentIndexᅟ: int

This property holds the index position of the widget that is visible.

The current index is -1 if there is no current widget.

Access functions:
property stackingModeᅟ: QStackedLayout.StackingMode

This property determines the way visibility of child widgets are handled..

The default value is StackOne . Setting the property to StackAll allows you to make use of the layout for overlay widgets that do additional drawing on top of other widgets, for example, graphical editors.

Access functions:
__init__()

Constructs a QStackedLayout with no parent.

This QStackedLayout must be installed on a widget later on to become effective.

See also

addWidget() insertWidget()

__init__(parentLayout)
Parameters:

parentLayout – QLayout

Constructs a new QStackedLayout and inserts it into the given parentLayout.

__init__(parent)
Parameters:

parent – QWidget

Constructs a new QStackedLayout with the given parent.

This layout will install itself on the parent widget and manage the geometry of its children.

currentChanged(index)
Parameters:

index – int

This signal is emitted whenever the current widget in the layout changes. The index specifies the index of the new current widget, or -1 if there isn’t a new one (for example, if there are no widgets in the QStackedLayout )

Notification signal of property currentIndexᅟ .

currentIndex()
Return type:

int

See also

setCurrentIndex()

Getter of property currentIndexᅟ .

currentWidget()
Return type:

QWidget

Returns the current widget, or None if there are no widgets in this layout.

insertWidget(index, w)
Parameters:
Return type:

int

Inserts the given widget at the given index in this QStackedLayout . If index is out of range, the widget is appended (in which case it is the actual index of the widget that is returned).

If the QStackedLayout is empty before this function is called, the given widget becomes the current widget.

Inserting a new widget at an index less than or equal to the current index will increment the current index, but keep the current widget.

See also

addWidget() removeWidget() setCurrentWidget()

setCurrentIndex(index)
Parameters:

index – int

See also

currentIndex()

Setter of property currentIndexᅟ .

setCurrentWidget(w)
Parameters:

w – QWidget

Sets the current widget to be the specified widget. The new current widget must already be contained in this stacked layout.

setStackingMode(stackingMode)
Parameters:

stackingMode – StackingMode

See also

stackingMode()

Setter of property stackingModeᅟ .

stackingMode()
Return type:

StackingMode

See also

setStackingMode()

Getter of property stackingModeᅟ .

widget(index)
Parameters:

index – int

Return type:

QWidget

Returns the widget at the given index, or None if there is no widget at the given position.

widgetRemoved(index)
Parameters:

index – int

This signal is emitted whenever a widget is removed from the layout. The widget’s index is passed as parameter.

See also

removeWidget()