QStackedWidget

Inheritance diagram of PySide2.QtWidgets.QStackedWidget

Synopsis

Functions

Slots

Signals

Detailed Description

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

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

Like PySide2.QtWidgets.QStackedLayout , PySide2.QtWidgets.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)

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

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

When populating a stacked widget, the widgets are added to an internal list. The PySide2.QtWidgets.QStackedWidget.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 PySide2.QtWidgets.QStackedWidget.addWidget() function, or inserted at a given index using the PySide2.QtWidgets.QStackedWidget.insertWidget() function. The PySide2.QtWidgets.QStackedWidget.removeWidget() function removes a widget from the stacked widget. The number of widgets contained in the stacked widget can be obtained using the PySide2.QtWidgets.QStackedWidget.count() function.

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

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

class PySide2.QtWidgets.QStackedWidget([parent=nullptr])
Parameters:parentPySide2.QtWidgets.QWidget

Constructs a PySide2.QtWidgets.QStackedWidget with the given parent .

PySide2.QtWidgets.QStackedWidget.addWidget(w)
Parameters:wPySide2.QtWidgets.QWidget
Return type:PySide2.QtCore.int

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

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

PySide2.QtWidgets.QStackedWidget.count()
Return type:PySide2.QtCore.int
PySide2.QtWidgets.QStackedWidget.currentChanged(arg__1)
Parameters:arg__1PySide2.QtCore.int
PySide2.QtWidgets.QStackedWidget.currentIndex()
Return type:PySide2.QtCore.int
PySide2.QtWidgets.QStackedWidget.currentWidget()
Return type:PySide2.QtWidgets.QWidget

Returns the current widget, or 0 if there are no child widgets.

PySide2.QtWidgets.QStackedWidget.indexOf(arg__1)
Parameters:arg__1PySide2.QtWidgets.QWidget
Return type:PySide2.QtCore.int

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

PySide2.QtWidgets.QStackedWidget.insertWidget(index, w)
Parameters:
Return type:

PySide2.QtCore.int

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

PySide2.QtWidgets.QStackedWidget.removeWidget(w)
Parameters:wPySide2.QtWidgets.QWidget

Removes widget from the PySide2.QtWidgets.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 PySide2.QtWidgets.QStackedWidget . If the application wants to reuse the removed widget , then it is recommended to re-parent it.

PySide2.QtWidgets.QStackedWidget.setCurrentIndex(index)
Parameters:indexPySide2.QtCore.int
PySide2.QtWidgets.QStackedWidget.setCurrentWidget(w)
Parameters:wPySide2.QtWidgets.QWidget

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

PySide2.QtWidgets.QStackedWidget.widget(arg__1)
Parameters:arg__1PySide2.QtCore.int
Return type:PySide2.QtWidgets.QWidget

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

PySide2.QtWidgets.QStackedWidget.widgetRemoved(index)
Parameters:indexPySide2.QtCore.int