PySide6.QtWidgets.QStackedWidget

class QStackedWidget

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

Inheritance diagram of PySide6.QtWidgets.QStackedWidget

Synopsis

Properties

  • countᅟ - The number of widgets contained by this stacked widget

  • currentIndexᅟ - The index position of the widget that is visible

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.

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

Like QStackedLayout , QStackedWidget can be constructed and populated with a number of child widgets (“pages”):

firstPageWidget = QWidget()
secondPageWidget = QWidget()
thirdPageWidget = QWidget()
stackedWidget = QStackedWidget()
stackedWidget.addWidget(firstPageWidget)
stackedWidget.addWidget(secondPageWidget)
stackedWidget.addWidget(thirdPageWidget)
layout = QVBoxLayout()
layout.addWidget(stackedWidget)
setLayout(layout)

QStackedWidget 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 QStackedWidget ‘s pages. For example:

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

When populating a stacked widget, 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 a widget from the stacked widget. The number of widgets contained in the stacked widget 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 stacked widget changes or a widget is removed from the stacked widget, the currentChanged() and widgetRemoved() signals are emitted respectively.

Note

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

property countᅟ: int

This property holds the number of widgets contained by this stacked widget.

By default, this property contains a value of 0.

Access functions:
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.

By default, this property contains a value of -1 because the stack is initially empty.

Access functions:
__init__([parent=None])
Parameters:

parent – QWidget

Constructs a QStackedWidget with the given parent.

addWidget(w)
Parameters:

w – QWidget

Return type:

int

Appends the given widget to the QStackedWidget and returns the index position. Ownership of widget is passed on to the QStackedWidget .

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

count()
Return type:

int

Getter of property countᅟ .

currentChanged(index)
Parameters:

index – int

This signal is emitted whenever the current widget changes.

The parameter holds 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 QStackedWidget ).

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 child widgets.

indexOf(widget)
Parameters:

widget – QWidget

Return type:

int

Returns the index of the given widget, or -1 if the given widget is not a child of the QStackedWidget .

insertWidget(index, w)
Parameters:
Return type:

int

Inserts the given widget at the given index in the QStackedWidget . Ownership of widget is passed on to the QStackedWidget . 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 QStackedWidget was 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.

removeWidget(w)
Parameters:

w – QWidget

Removes widget from the QStackedWidget . i.e., widget is not deleted but simply removed from the stacked layout, causing it to be hidden.

Note

Parent object and parent widget of widget will remain the QStackedWidget . If the application wants to reuse the removed widget, then it is recommended to re-parent it.

See also

addWidget() insertWidget() currentWidget()

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 widget.

widget(index)
Parameters:

index – int

Return type:

QWidget

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

widgetAdded(index)
Parameters:

index – int

This signal is emitted whenever a widget is added or inserted. The widget’s index is passed as parameter.

widgetRemoved(index)
Parameters:

index – int

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

See also

removeWidget()