StackLayout QML Type
The StackLayout class provides a stack of items where only one item is visible at a time. More...
Import Statement: | import QtQuick.Layouts 1.2 |
Inherits: |
Properties
- count : int
- currentIndex : int
Attached Properties
- index : int
- isCurrentItem : bool
- layout : StackLayout
Detailed Description
The current visible item can be modified by setting the currentIndex property. The index corresponds to the order of the StackLayout's children.
In contrast to most other layouts, child Items' Layout.fillWidth and Layout.fillHeight properties default to true
. As a consequence, child items are by default filled to match the size of the StackLayout as long as their Layout.maximumWidth or Layout.maximumHeight does not prevent it.
Items are added to the layout by reparenting the item to the layout. Similarly, removal is done by reparenting the item from the layout. Both of these operations will affect the layout's count property.
The following code will create a StackLayout where only the 'plum' rectangle is visible.
StackLayout { id: layout anchors.fill: parent currentIndex: 1 Rectangle { color: 'teal' implicitWidth: 200 implicitHeight: 200 } Rectangle { color: 'plum' implicitWidth: 300 implicitHeight: 200 } }
Items in a StackLayout support these attached properties:
- Layout.minimumWidth
- Layout.minimumHeight
- Layout.preferredWidth
- Layout.preferredHeight
- Layout.maximumWidth
- Layout.maximumHeight
- Layout.fillWidth
- Layout.fillHeight
Read more about attached properties here.
See also ColumnLayout, GridLayout, RowLayout, and StackView.
Property Documentation
count : int |
This property holds the number of items that belong to the layout.
Only items that are children of the StackLayout will be candidates for layouting.
currentIndex : int |
This property holds the index of the child item that is currently visible in the StackLayout. By default it will be -1
for an empty layout, otherwise the default is 0
(referring to the first item).
Attached Property Documentation
[since QtQuick.Layouts 1.15] StackLayout.index : int |
This attached property holds the index of each child item in the StackLayout.
This property was introduced in QtQuick.Layouts 1.15.
See also isCurrentItem and layout.
[since QtQuick.Layouts 1.15] StackLayout.isCurrentItem : bool |
This attached property is true
if this child is the current item in the StackLayout.
This property was introduced in QtQuick.Layouts 1.15.
[since QtQuick.Layouts 1.15] StackLayout.layout : StackLayout |
This attached property holds the StackLayout that manages this child item.
This property was introduced in QtQuick.Layouts 1.15.
See also index and isCurrentItem.