API Documentation

Documentation for developing SailfishOS applications

SilicaFlickable QML Type

A Sailfish-styled flickable view More...

Import Statement:	import Sailfish.Silica 1.0
Inherited By:	DockedPanel

Properties

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

Methods

scrollToBottom()
scrollToTop()

Detailed Description

The SilicaFlickable type provides a Flickable type with Sailfish-specific behaviors and additional properties.

Below is a simple Sailfish-style flickable:

 import QtQuick 2.2
 import Sailfish.Silica 1.0

 Rectangle {
     width: 200; height: 100

     SilicaFlickable {
         anchors.fill: parent
         contentWidth: text.width; contentHeight: text.height

         Text {
             id: text
             text: "Hello, Sailor!"
             font.pixelSize: 100
         }
     }
 }

SilicaFlickable inherits the QtQuick Flickable type, so any properties, signals and methods of Flickable (such as the model and delegate properties in the example above) are also available to SilicaFlickable objects. See the Flickable 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 flickable. If enabled, it is shown when the flickable'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 for flickables with a flickableDirection of Flickable.VerticalFlick or Flickable.AutoFlickDirection.

quickScrollAnimating : bool

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

Method Documentation

scrollToBottom()

Starts an animation which quickly scrolls the view to the bottom.

This does nothing if the flickable cannot be scrolled vertically.

scrollToTop()

Starts an animation which quickly scrolls the view to the top.