API Documentation

Documentation for developing SailfishOS applications

SilicaListView QML Type

A Sailfish-styled list view More...

Import Statement: import Sailfish.Silica 1.0

Properties

pullDownMenu : Item
pushUpMenu : Item
quickScroll : bool
quickScrollAnimating : bool

Methods

scrollToBottom()
scrollToTop()

Detailed Description

The SilicaListView type provides a ListView with Sailfish-specific behaviors and additional properties.

Below is a simple Sailfish-style list view:

 import QtQuick 2.2
 import Sailfish.Silica 1.0

 SilicaListView {
     width: 480; height: 800
     model: ListModel {
         ListElement { fruit: "jackfruit" }
         ListElement { fruit: "orange" }
         ListElement { fruit: "lemon" }
         ListElement { fruit: "lychee" }
         ListElement { fruit: "apricots" }
     }
     delegate: Item {
         width: ListView.view.width
         height: Theme.itemSizeSmall

         Label { text: fruit }
     }
 }

SilicaListView inherits the QtQuick ListView type, so any properties, signals and methods of ListView (such as the model and delegate properties in the example above) are also available to SilicaListView objects. See the ListView documentation for its full list of available properties, signals and methods.

Property Documentation

pullDownMenu : Item

The PullDownMenu item assigned to this view, or null if no pull-down menu has been assigned.

pushUpMenu : Item

The PushUpMenu item assigned to this view, or null if no push-up menu has been assigned.

quickScroll : bool

Controls whether a vertical quick scroll area is enabled for the view. If enabled, it is shown when the view's contentHeight is at least three times that of its height. It allows the user to quickly jump to the beginning or the end of the flickable.

By default the quick scroll area is enabled if the view can be scrolled vertically.

quickScrollAnimating : bool

This property is true when the quick scroll functionality has been triggered and the view is quickly animating to the beginning or end of its content area.

Method Documentation

scrollToBottom()

Starts an animation which quickly scrolls the view to its last item.

This does nothing if the view cannot be scrolled vertically.

scrollToTop()

Starts an animation which quickly scrolls the view to its first item.