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
currentIndex
()def
currentWidget
()def
indexOf
(arg__1)def
insertWidget
(index, w)def
removeWidget
(w)def
widget
(arg__1)
Slots¶
def
setCurrentIndex
(index)def
setCurrentWidget
(w)
Signals¶
def
currentChanged
(arg__1)def
widgetRemoved
(index)
Detailed Description¶
QStackedWidget
can be used to create a user interface similar to the one provided byQTabWidget
. It is a convenience layout widget built on top of theQStackedLayout
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 aQComboBox
or aQListWidget
that stores the titles of theQStackedWidget
‘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 theaddWidget()
function, or inserted at a given index using theinsertWidget()
function. TheremoveWidget()
function removes a widget from the stacked widget. The number of widgets contained in the stacked widget can be obtained using thecount()
function.The
widget()
function returns the widget at a given index position. The index of the widget that is shown on screen is given bycurrentIndex()
and can be changed usingsetCurrentIndex()
. In a similar manner, the currently shown widget can be retrieved using thecurrentWidget()
function, and altered using thesetCurrentWidget()
function.Whenever the current widget in the stacked widget changes or a widget is removed from the stacked widget, the
currentChanged()
andwidgetRemoved()
signals are emitted respectively.See also
- class PySide2.QtWidgets.QStackedWidget([parent=None])¶
- param parent:
Constructs a
QStackedWidget
with the givenparent
.See also
- PySide2.QtWidgets.QStackedWidget.addWidget(w)¶
- Parameters:
- Return type:
int
Appends the given
widget
to theQStackedWidget
and returns the index position. Ownership ofwidget
is passed on to theQStackedWidget
.If the
QStackedWidget
is empty before this function is called,widget
becomes the current widget.
- PySide2.QtWidgets.QStackedWidget.count()¶
- Return type:
int
This property holds the number of widgets contained by this stacked widget.
By default, this property contains a value of 0.
See also
- PySide2.QtWidgets.QStackedWidget.currentChanged(arg__1)¶
- Parameters:
arg__1 – int
- PySide2.QtWidgets.QStackedWidget.currentIndex()¶
- Return type:
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
- PySide2.QtWidgets.QStackedWidget.currentWidget()¶
- Return type:
Returns the current widget, or
None
if there are no child widgets.See also
- PySide2.QtWidgets.QStackedWidget.indexOf(arg__1)¶
- Parameters:
arg__1 –
PySide2.QtWidgets.QWidget
- Return type:
int
Returns the index of the given
widget
, or -1 if the givenwidget
is not a child of theQStackedWidget
.See also
- PySide2.QtWidgets.QStackedWidget.insertWidget(index, w)¶
- Parameters:
index – int
- Return type:
int
Inserts the given
widget
at the givenindex
in theQStackedWidget
. Ownership ofwidget
is passed on to theQStackedWidget
. Ifindex
is out of range, thewidget
is appended (in which case it is the actual index of thewidget
that is returned).If the
QStackedWidget
was empty before this function is called, the givenwidget
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
- PySide2.QtWidgets.QStackedWidget.removeWidget(w)¶
- Parameters:
Removes
widget
from theQStackedWidget
. 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 theQStackedWidget
. If the application wants to reuse the removedwidget
, then it is recommended to re-parent it.See also
- PySide2.QtWidgets.QStackedWidget.setCurrentIndex(index)¶
- Parameters:
index – 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
- PySide2.QtWidgets.QStackedWidget.setCurrentWidget(w)¶
- Parameters:
Sets the current widget to be the specified
widget
. The new current widget must already be contained in this stacked widget.See also
- PySide2.QtWidgets.QStackedWidget.widget(arg__1)¶
- Parameters:
arg__1 – int
- Return type:
Returns the widget at the given
index
, orNone
if there is no such widget.See also
- PySide2.QtWidgets.QStackedWidget.widgetRemoved(index)¶
- Parameters:
index – int
© 2022 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.