StackListLayout

Since: BlackBerry 10.0.0

#include <bb/cascades/StackListLayout>

A layout used with ListView to lay out children in a simple stack.

A StackListLayout with ten entries

Setting a StackListLayout on the ListView::layout property causes the items in that ListView to be positioned as a simple stack (one item after another in the orientation that's specified).

Margin-properties on root nodes of item visuals affect the spacing between items in a StackListLayout. The distance between two items in the orientation direction will be the largest margin of the two adjacent margins in the layout orientation.

You can specify a preferred size for list items, but these are limited by the width or height (minus padding) of the ListView (width is limited in vertical lists, height is limited in horizontal lists).

The following C++ example demonstrates adding three StandardListItem items to a StackListLayout, with "Hey", "Hello" and "Bye" as title texts. Since StackListLayout is the default layout for ListView, it's not necessary to explicitly specify the layout type.

ListView *pListView = new ListView(new QListDataModel<QString>(
        QList<QString>() << "Hey" << "Hello" << "Bye"));

This example demonstrates when it is necessary to set the headerMode to None on the StackListLayout. The example displays an outer vertical ListView which has horizontal grid lists as items. Setting headerMode to None on the StackListLayout causes the outer ListView to use only the top level items from the DataModel, leaving the items on the second level for the grid lists.

ListView {
    topPadding: -6

    layout: StackListLayout {
        headerMode: ListHeaderMode.None
    }
    dataModel: XmlDataModel {
        source: "headersModel.xml"
    }

    listItemComponents: [
        ListItemComponent {
            type: "folder"

            Container {
                id: root
                topPadding: 6
                layout: DockLayout {}
                maxHeight: 206

                ListView {
                    dataModel: root.ListItem.view.dataModel
                    rootIndexPath: root.ListItem.indexPath
                    layout: GridListLayout {
                         orientation: Orientation.LeftToRight
                         columnCount: 2
                    }

                    listItemComponents: [
                        ListItemComponent {
                            type: "image"

                            ImageView {
                                imageSource: ListItemData.source
                                scalingMethod: ScalingMethod.AspectFill
                            }
                        }
                    ]
                }

                Header {
                    maxWidth: 400
                    title: ListItemData.title
                    opacity: 0.75
                }
            }
        }
    ]
}


Overview

QML properties

headerMode: bb::cascades::ListHeaderMode::Type
orientation: bb::cascades::LayoutOrientation::Type
attachedObjects: QDeclarativeListProperty< QObject > [read-only]Inherited
objectName: QStringInherited
parent: QObject [read-only]Inherited
ui: bb::cascades::UIConfig [read-only]Inherited

QML signals

Public Functions Index

StackListLayout ()
virtual ~StackListLayout ()
bb::cascades::ListHeaderMode::TypeheaderMode () const
bb::cascades::LayoutOrientation::Typeorientation () const
Q_SLOT voidresetHeaderMode ()
Q_SLOT voidresetOrientation ()
Q_SLOT voidsetHeaderMode (bb::cascades::ListHeaderMode::Type newHeaderMode)
Q_SLOT voidsetOrientation (bb::cascades::LayoutOrientation::Type orientation)
virtual boolevent (QEvent *event)Inherited
voidsetObjectName (const QString &name)Inherited
virtual Q_INVOKABLE QStringtoDebugString () const Inherited
Q_INVOKABLE bb::cascades::UIConfig *ui () const Inherited

Static Public Functions Index

Buildercreate ()

Protected Functions Index

Only has inherited protected functions

BaseObject (QObject *parent=0)Inherited
virtual voidconnectNotify (const char *signal)Inherited
virtual voiddisconnectNotify (const char *signal)Inherited

Signals Index

voidheaderModeChanged (bb::cascades::ListHeaderMode::Type newHeaderMode)
voidorientationChanged (bb::cascades::LayoutOrientation::Type newOrientation)
voidcreationCompleted ()Inherited
voidobjectNameChanged (const QString &objectName)Inherited

Properties

bb::cascades::ListHeaderMode::Type headerMode

Determines if and how headers are shown by the StackListLayout.

Since:

BlackBerry 10.0.0

bb::cascades::LayoutOrientation::Type orientation

The orientation for the stack layout.

The orientation determines the direction in which list items are added to the list (for example, when using TopToBottom, items are added starting from the top). If items exist outside of the visible area, it is possible to scroll down the list to view them.

Item sizes have no limitation in the orientation direction, but are limited in the opposite direction. For example, in a ListView that uses a StackListLayout with orientation of TopToBottom or BottomToTop, the height of the items is only limited by the item themselves. But the width of items is limited by the width of the ListView, minus any leftPadding and rightPadding that might be applied on the ListView.

The default orientation is TopToBottom, but LeftToRight, RightToLeft, and BottomToTop can also be used.

Since:

BlackBerry 10.0.0

QDeclarativeListProperty< QObject > attachedObjectsInherited[read-only]

A hierarchical list of the UIObject's attached objects.

Since:

BlackBerry 10.0.0

QString objectNameInherited

This property is overridden from QObject.

See also:

QObject::objectName().

Since:

BlackBerry 10.0.0

QObject parentInherited[read-only]

A read-only property that represents this object's parent.

The parent of an object is specified using QObject::setParent(QObject*). The purpose of the property is to expose the object's parent to QML.

This property is read-only to prevent modifications from QML, where typically the parent is declaratively set. In C++ code, the parent can be explicitly set using QObject::setParent(QObject*), or implicitly set by adding it to a visual container.

The default value of this property is 0.

Since:

BlackBerry 10.0.0

bb::cascades::UIConfig uiInherited[read-only]

An object that gives access to unit conversion routines.

QML use:
        // Size using design units
        Container {
            preferredWidth: ui.du(12)
            preferredHeight: ui.du(5)
        }

        // Size using design units, snap to whole pixels
        Container {
            preferredWidth: ui.sdu(13.5)
            preferredHeight: ui.sdu(7.5)
        }

        // Size using absolute pixel values
        Container {
            preferredWidth: ui.px(150)
            preferredHeight: ui.px(50)
        }
C++ use:
Container *container1 = Container::create().background(Color::Red);
UIConfig *ui = container1->ui();
container1->setPreferredWidth(ui->du(12));
container1->setPreferredHeight(ui->du(5));

Container *container2 = Container::create().background(Color::Green);
container2->setPreferredWidth(ui->sdu(13.5));
container2->setPreferredHeight(ui->sdu(7.5));

Container *container3 = Container::create().background(Color::Blue);
container3->setPreferredWidth(ui->px(150));
container3->setPreferredHeight(ui->sdu(50));
Since:

Blackberry 10.3.0

Public Functions

StackListLayout ()

Constructs a StackListLayout instance.

Since:

BlackBerry 10.0.0

virtual~StackListLayout ()

Destructor.

bb::cascades::ListHeaderMode::Type headerMode ()

Returns the value of the headerMode property.

Return:

The value of the headerMode property.

Since:

BlackBerry 10.0.0

bb::cascades::LayoutOrientation::Type orientation ()

Returns the orientation for the StackListLayout.

Return:

The orientation of the layout.

Since:

BlackBerry 10.0.0

Q_SLOT void resetHeaderMode ()

Resets the headerMode property to its default value.

The default value is ListHeaderMode::Standard.

If the property value is changed, the headerModeChanged() signal is emitted.

Since:

BlackBerry 10.0.0

Q_SLOT void resetOrientation ()

Resets the orientation to its default.

The default orientation is LayoutOrientation::TopToBottom.

If the orientation is changed, the orientationChanged() signal is emitted.

Since:

BlackBerry 10.0.0

Q_SLOT void setHeaderMode (

Sets a value on the headerMode property.

Parameters
newHeaderMode

The value to set on the headerMode property.

If the property value is changed, the headerModeChanged() signal is emitted.
Since:

BlackBerry 10.0.0

Q_SLOT void setOrientation (

Sets the orientation for the StackListLayout.

If the orientation is changed, the orientationChanged() signal is emitted.

Parameters
orientation

The new orientation.

Since:

BlackBerry 10.0.0

virtual bool event (Inherited

Overloaded to implement the event mechanism in Cascades.

Warning!

If this function is overridden, it must be called by the derived class for events to work properly in Cascades.

Parameters
event

The received event.

Return:

True if the received event was recognized and processed, false otherwise.

Since:

BlackBerry 10.0.0

void setObjectName (Inherited

Sets the objectName property.

Parameters
name

The new name for the object.

Since:

BlackBerry 10.0.0

virtual Q_INVOKABLE QString toDebugString ()Inherited

Returns a debug string representing this object.

Return:

A debug string for the object.

Since:

BlackBerry 10.0.0

Q_INVOKABLE bb::cascades::UIConfig * ui ()Inherited

Returns the UIConfig for this ui object.

The UIConfig can be used to perform unit conversions from design units (du) and snapped design units (sdu) to pixels.

Ownership remains with Cascades.

C++ use:
Container *container1 = Container::create().background(Color::Red);
UIConfig *ui = container1->ui();
container1->setPreferredWidth(ui->du(12));
container1->setPreferredHeight(ui->du(5));

Container *container2 = Container::create().background(Color::Green);
container2->setPreferredWidth(ui->sdu(13.5));
container2->setPreferredHeight(ui->sdu(7.5));

Container *container3 = Container::create().background(Color::Blue);
container3->setPreferredWidth(ui->px(150));
container3->setPreferredHeight(ui->sdu(50));
Return:

The UIConfig for this ui object.

Since:

BlackBerry 10.3.0

Static Public Functions

Builder create ()

Creates and returns a builder for constructing a stack list layout.

Using the builder to create a stack list layout:
StackListLayout* stackListLayout = StackListLayout::create()
        .orientation(LayoutOrientation::LeftToRight);
Return:

A builder used for constructing a stack list layout.

Since:

BlackBerry 10.0.0

Protected Functions

(Only has inherited protected functions)

BaseObject (Inherited

Constructs an instance of BaseObject's subclass.

Parameters
parent

An optional parent, defaults to 0.

Since:

BlackBerry 10.0.0

virtual void connectNotify (
  • const char *signal)
Inherited

Overloaded to implement the event mechanism in Cascades.

If this function is overridden, it must be called by the derived class for events to work properly in Cascades.

Parameters
signal

The connected signal.

Since:

BlackBerry 10.0.0

virtual void disconnectNotify (
  • const char *signal)
Inherited

Overloaded to implement the event mechanism in Cascades.

If this function is overridden, it must be called by the derived class for events to work properly in Cascades.

Parameters
signal

The disconnected signal.

Since:

BlackBerry 10.0.0

Signals

void headerModeChanged (

Emitted when the headerMode property has changed.

Note:

Due to a workaround for a Qt Core issue with accessing enums from QML the argument of this signal doesn't follow naming convention for signals in which the signal arguments are typically named to match the associated property's name. Use the object's property to access current property value instead of the signal argument to avoid runtime errors (i.e. use headerMode instead of newHeaderMode).

Parameters
newHeaderMode

The new value for the headerMode property.

Since:

BlackBerry 10.0.0

void orientationChanged (

Emitted when the orientation property has changed.

Note:

Due to a workaround for a Qt Core issue with accessing enums from QML the argument of this signal doesn't follow naming convention for signals in which the signal arguments are typically named to match the associated property's name. Use the object's property to access current property value instead of the signal argument to avoid runtime errors (i.e. use orientation instead of newOrientation).

Parameters
newOrientation

The new orientation.

Since:

BlackBerry 10.0.0

void creationCompleted ()Inherited

Emitted when this object is instantiated as a result of loading a QML document and creating the root node (only after the root component that caused this instantiation has completed construction), or when the object is being constructed from its builder class.

This signal indicates that the construction and initialization of the object has been completed, the properties are initialized, and any QML binding values have been assigned to the object.

This signal is not emitted when the object is constructed from C++ using the constructor. If the object is constructed using its builder class, the signal is emitted when the the builder class returns the fully constructed object.

This signal can be used when there is an activity that needs to be performed, such as a property state integrity verification after the object is instantiated from a QML document or a builder, but before control is returned to the application.

See also:

QmlDocument

Since:

BlackBerry 10.0.0

void objectNameChanged (Inherited

This signal is emitted when the objectName property is changed.

Since:

BlackBerry 10.0.0

Last modified: 2014-06-24



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus