class QStackedWidget#

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

Synopsis#

Properties#

countᅟ - The number of widgets contained by this stacked widget
currentIndexᅟ - The index position of the widget that is visible

Methods#

def __init__()
def addWidget()
def count()
def currentIndex()
def currentWidget()
def indexOf()
def insertWidget()
def removeWidget()
def widget()

Signals#

def currentChanged()
def widgetRemoved()

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.

See also

QStackedLayout QTabWidget

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.

See also

currentIndex() widget()

Access functions:

count()

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.

See also

currentWidget() indexOf()

Access functions:

currentIndex()
setCurrentIndex()
Signal currentChanged()

__init__([parent=None])#

Parameters:: parent – QWidget

Constructs a QStackedWidget with the given parent.

See also

addWidget() insertWidget()

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.

See also

insertWidget() removeWidget() setCurrentWidget()

count()#

Return type:: int

Getter of property countᅟ .

currentChanged(arg__1)#

Parameters:: arg__1 – 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 ).

See also

currentWidget() setCurrentWidget()

Notification signal of property currentIndexᅟ .

currentIndex()#

Return type:: int