QStackedLayout

Synopsis

Functions

• def currentIndex ()
• def currentWidget ()
• def insertWidget (index, w)
• def setStackingMode (stackingMode)
• def stackingMode ()
• def widget (arg__1)

Slots

• def setCurrentIndex (index)
• def setCurrentWidget (w)

Signals

• def currentChanged (index)
• def widgetRemoved (index)

Detailed Description

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

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

A PySide.QtGui.QStackedLayout can be populated with a number of child widgets (“pages”). For example:

QWidget *firstPageWidget = new QWidget;
QWidget *secondPageWidget = new QWidget;
QWidget *thirdPageWidget = new QWidget;

QStackedLayout *stackedLayout = new QStackedLayout;
stackedLayout->addWidget(firstPageWidget);
stackedLayout->addWidget(secondPageWidget);
stackedLayout->addWidget(thirdPageWidget);


QVBoxLayout *mainLayout = new QVBoxLayout;
mainLayout->addLayout(stackedLayout);
setLayout(mainLayout);

PySide.QtGui.QStackedLayout 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.QStackedLayout ‘s pages. For example:

QComboBox *pageComboBox = new QComboBox;
pageComboBox->addItem(tr("Page 1"));
pageComboBox->addItem(tr("Page 2"));
pageComboBox->addItem(tr("Page 3"));
connect(pageComboBox, SIGNAL(activated(int)),
        stackedLayout, SLOT(setCurrentIndex(int)));

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

The PySide.QtGui.QStackedLayout.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.QStackedLayout.currentIndex() and can be changed using PySide.QtGui.QStackedLayout.setCurrentIndex() . In a similar manner, the currently shown widget can be retrieved using the PySide.QtGui.QStackedLayout.currentWidget() function, and altered using the PySide.QtGui.QStackedLayout.setCurrentWidget() function.

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

See also

PySide.QtGui.QStackedWidget PySide.QtGui.QTabWidget

class PySide.QtGui.QStackedLayout

class PySide.QtGui.QStackedLayout(parentLayout)

class PySide.QtGui.QStackedLayout(parent)

Parameters:

• parent – PySide.QtGui.QWidget
• parentLayout – PySide.QtGui.QLayout

Constructs a PySide.QtGui.QStackedLayout with no parent.

This PySide.QtGui.QStackedLayout must be installed on a widget later on to become effective.

See also

PySide.QtGui.QStackedLayout.addWidget() PySide.QtGui.QStackedLayout.insertWidget()

Constructs a new PySide.QtGui.QStackedLayout and inserts it into the given parentLayout .

Constructs a new PySide.QtGui.QStackedLayout with the given parent .

This layout will install itself on the parent widget and manage the geometry of its children.

PySide.QtGui.QStackedLayout.StackingMode

This enum specifies how the layout handles its child widgets regarding their visibility.

Constant	Description
QStackedLayout.StackOne	Only the current widget is visible. This is the default.
QStackedLayout.StackAll	All widgets are visible. The current widget is merely raised.

PySide.QtGui.QStackedLayout.currentChanged(index)

Parameters:index – PySide.QtCore.int

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

See also

PySide.QtGui.QStackedLayout.currentWidget() PySide.QtGui.QLayout.indexOf()

PySide.QtGui.QStackedLayout.currentWidget()

Return type:PySide.QtGui.QWidget

Returns the current widget, or 0 if there are no widgets in this layout.

See also

PySide.QtGui.QStackedLayout.currentIndex() PySide.QtGui.QStackedLayout.setCurrentWidget()

PySide.QtGui.QStackedLayout.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 this PySide.QtGui.QStackedLayout . 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.QStackedLayout is 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.QStackedLayout.addWidget() PySide.QtGui.QLayout.removeWidget() PySide.QtGui.QStackedLayout.setCurrentWidget()

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

See also

PySide.QtGui.QStackedLayout.currentWidget() PySide.QtGui.QLayout.indexOf()

PySide.QtGui.QStackedLayout.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 layout.

See also

PySide.QtGui.QStackedLayout.setCurrentIndex() PySide.QtGui.QStackedLayout.currentWidget()

PySide.QtGui.QStackedLayout.setStackingMode(stackingMode)

Parameters:stackingMode – PySide.QtGui.QStackedLayout.StackingMode

This property determines the way visibility of child widgets are handled..

The default value is StackOne . Setting the property to StackAll allows you to make use of the layout for overlay widgets that do additional drawing on top of other widgets, for example, graphical editors.

PySide.QtGui.QStackedLayout.stackingMode()

Return type:PySide.QtGui.QStackedLayout.StackingMode

This property determines the way visibility of child widgets are handled..

The default value is StackOne . Setting the property to StackAll allows you to make use of the layout for overlay widgets that do additional drawing on top of other widgets, for example, graphical editors.

PySide.QtGui.QStackedLayout.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 widget at the given position.

See also

PySide.QtGui.QStackedLayout.currentWidget() PySide.QtGui.QLayout.indexOf()

PySide.QtGui.QStackedLayout.widgetRemoved(index)

Parameters:index – PySide.QtCore.int