QStackedWidget

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

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

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

Like PySide.QtGui.QStackedLayout , PySide.QtGui.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)

PySide.QtGui.QStackedWidget provides no intrinsic means for the user to switch page. This is typically done through a PySide.QtGui.QComboBox or a PySide.QtGui.QListWidget that stores the titles of the PySide.QtGui.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 PySide.QtGui.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 PySide.QtGui.QStackedWidget.addWidget() function, or inserted at a given index using the PySide.QtGui.QStackedWidget.insertWidget() function. The PySide.QtGui.QStackedWidget.removeWidget() function removes a widget from the stacked widget. The number of widgets contained in the stacked widget, can be obtained using the PySide.QtGui.QStackedWidget.count() function.

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

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

See also

PySide.QtGui.QStackedLayout PySide.QtGui.QTabWidget Config Dialog Example

class PySide.QtGui.QStackedWidget([parent=None])

Parameters:parent – PySide.QtGui.QWidget

Constructs a PySide.QtGui.QStackedWidget with the given parent .

See also

PySide.QtGui.QStackedWidget.addWidget() PySide.QtGui.QStackedWidget.insertWidget()

PySide.QtGui.QStackedWidget.addWidget(w)

Parameters:w – PySide.QtGui.QWidget Return type:PySide.QtCore.int

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

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

See also

PySide.QtGui.QStackedWidget.insertWidget() PySide.QtGui.QStackedWidget.removeWidget() PySide.QtGui.QStackedWidget.setCurrentWidget()

PySide.QtGui.QStackedWidget.count()

Return type:PySide.QtCore.int

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

By default, this property contains a value of 0.

See also

PySide.QtGui.QStackedWidget.currentIndex() PySide.QtGui.QStackedWidget.widget()

PySide.QtGui.QStackedWidget.currentChanged(arg__1)

Parameters:arg__1 – PySide.QtCore.int

PySide.QtGui.QStackedWidget.currentIndex()

Return type:PySide.QtCore.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

PySide.QtGui.QStackedWidget.currentWidget() PySide.QtGui.QStackedWidget.indexOf()

PySide.QtGui.QStackedWidget.currentWidget()

Return type:PySide.QtGui.QWidget

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

See also

PySide.QtGui.QStackedWidget.currentIndex() PySide.QtGui.QStackedWidget.setCurrentWidget()

PySide.QtGui.QStackedWidget.indexOf(arg__1)

Parameters:arg__1 – PySide.QtGui.QWidget Return type:PySide.QtCore.int

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

See also

PySide.QtGui.QStackedWidget.currentIndex() PySide.QtGui.QStackedWidget.widget()

PySide.QtGui.QStackedWidget.insertWidget(index, w)

Parameters:

• index – PySide.QtCore.int
• w – PySide.QtGui.QWidget

Return type:

PySide.QtCore.int

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

PySide.QtGui.QStackedWidget.addWidget() PySide.QtGui.QStackedWidget.removeWidget() PySide.QtGui.QStackedWidget.setCurrentWidget()

PySide.QtGui.QStackedWidget.removeWidget(w)

Parameters:w – PySide.QtGui.QWidget

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

Note

Ownership of widget reverts to the application.

See also

PySide.QtGui.QStackedWidget.addWidget() PySide.QtGui.QStackedWidget.insertWidget() PySide.QtGui.QStackedWidget.currentWidget()

PySide.QtGui.QStackedWidget.setCurrentIndex(index)

Parameters:index – PySide.QtCore.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

PySide.QtGui.QStackedWidget.currentWidget() PySide.QtGui.QStackedWidget.indexOf()

PySide.QtGui.QStackedWidget.setCurrentWidget(w)

Parameters:w – PySide.QtGui.QWidget

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

See also

PySide.QtGui.QStackedWidget.currentWidget() PySide.QtGui.QStackedWidget.setCurrentIndex()

PySide.QtGui.QStackedWidget.widget(arg__1)

Parameters:arg__1 – PySide.QtCore.int Return type:PySide.QtGui.QWidget

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

See also

PySide.QtGui.QStackedWidget.currentWidget() PySide.QtGui.QStackedWidget.indexOf()

PySide.QtGui.QStackedWidget.widgetRemoved(index)

Parameters:index – PySide.QtCore.int