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

Synopsis¶
Functions¶
def
addWidget
(w)def
count
()def
currentChanged
(arg__1)def
currentIndex
()def
currentWidget
()def
indexOf
(arg__1)def
insertWidget
(index, w)def
removeWidget
(w)def
setCurrentIndex
(index)def
setCurrentWidget
(w)def
widget
(arg__1)def
widgetRemoved
(index)
Detailed Description¶
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[int].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 function.
Whenever the current widget in the stacked widget changes or a widget is removed from the stacked widget, the currentChanged()
and signals are emitted respectively.
See also
-
class
PySide6.QtWidgets.
QStackedWidget
([parent=None])¶ - Parameters
parent –
PySide6.QtWidgets.QWidget
Constructs a QStackedWidget
with the given parent
.
See also
-
PySide6.QtWidgets.QStackedWidget.
addWidget
(w)¶ - Parameters
- 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.
-
PySide6.QtWidgets.QStackedWidget.
count
()¶ - Return type
int
-
PySide6.QtWidgets.QStackedWidget.
currentChanged
(arg__1)¶ - Parameters
arg__1 – int
-
PySide6.QtWidgets.QStackedWidget.
currentIndex
()¶ - Return type
int
See also
-
PySide6.QtWidgets.QStackedWidget.
currentWidget
()¶ - Return type
Returns the current widget, or None
if there are no child widgets.
See also
-
PySide6.QtWidgets.QStackedWidget.
indexOf
(arg__1)¶ - Parameters
arg__1 –
PySide6.QtWidgets.QWidget
- Return type
int
Returns the index of the given widget
, or -1 if the given widget
is not a child of the QStackedWidget
.
See also
-
PySide6.QtWidgets.QStackedWidget.
insertWidget
(index, w)¶ - Parameters
index – int
- 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.
See also
-
PySide6.QtWidgets.QStackedWidget.
removeWidget
(w)¶ - Parameters
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
-
PySide6.QtWidgets.QStackedWidget.
setCurrentIndex
(index)¶ - Parameters
index – int
See also
-
PySide6.QtWidgets.QStackedWidget.
setCurrentWidget
(w)¶ - Parameters
See also
-
PySide6.QtWidgets.QStackedWidget.
widget
(arg__1)¶ - Parameters
arg__1 – int
- Return type
Returns the widget at the given index
, or None
if there is no such widget.
See also
-
PySide6.QtWidgets.QStackedWidget.
widgetRemoved
(index)¶ - Parameters
index – int
© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.