QML Flickable Element

These properties are true if the flickable view is positioned at the beginning, or end respecively.

This property holds whether the surface may be dragged beyond the Fickable's boundaries, or overshoot the Flickable's boundaries when flicked.

This enables the feeling that the edges of the view are soft, rather than a hard physical boundary.

The boundsBehavior can be one of:

• Flickable.StopAtBounds - the contents can not be dragged beyond the boundary of the flickable, and flicks will not overshoot.
• Flickable.DragOverBounds - the contents can be dragged beyond the boundary of the Flickable, but flicks will not overshoot.
• Flickable.DragAndOvershootBounds (default) - the contents can be dragged beyond the boundary of the Flickable, and can overshoot the boundary when flicked.

The internal item that contains the Items to be moved in the Flickable.

Items declared as children of a Flickable are automatically parented to the Flickable's contentItem.

Items created dynamically need to be explicitly parented to the contentItem:

 Flickable {
     id: myFlickable
     function addItem(file) {
         var component = Qt.createComponent(file)
         component.createObject(myFlickable.contentItem);
     }
 }

The dimensions of the content (the surface controlled by Flickable). This should typically be set to the combined size of the items placed in the Flickable.

The following snippet shows how these properties are used to display an image that is larger than the Flickable item itself:

 import QtQuick 1.0

 Flickable {
     width: 200; height: 200
     contentWidth: image.width; contentHeight: image.height

     Image { id: image; source: "bigImage.png" }
 }

In some cases, the the content dimensions can be automatically set using the childrenRect.width and childrenRect.height properties.

These properties hold the surface coordinate currently at the top-left corner of the Flickable. For example, if you flick an image up 100 pixels, contentY will be 100.

This property holds the rate at which a flick will decelerate.

The default value is platform dependent.

This property determines which directions the view can be flicked.

• Flickable.AutoFlickDirection (default) - allows flicking vertically if the contentHeight is not equal to the height of the Flickable. Allows flicking horizontally if the contentWidth is not equal to the width of the Flickable.
• Flickable.HorizontalFlick - allows flicking horizontally.
• Flickable.VerticalFlick - allows flicking vertically.
• Flickable.HorizontalAndVerticalFlick - allows flicking in both directions.

These properties describe whether the view is currently moving horizontally, vertically or in either direction, due to the user flicking the view.

The instantaneous velocity of movement along the x and y axes, in pixels/sec.

The reported velocity is smoothed to avoid erratic output.

This property describes whether the user can interact with the Flickable. A user cannot drag or flick a Flickable that is not interactive.

By default, this property is true.

This property is useful for temporarily disabling flicking. This allows special interaction with Flickable's children; for example, you might want to freeze a flickable map while scrolling through a pop-up dialog that is a child of the Flickable.

This property holds the maximum velocity that the user can flick the view in pixels/second.

The default value is platform dependent.

These properties describe whether the view is currently moving horizontally, vertically or in either direction, due to the user either dragging or flicking the view.

This property holds the time to delay (ms) delivering a press to children of the Flickable. This can be useful where reacting to a press before a flicking action has undesirable effects.

If the flickable is dragged/flicked before the delay times out the press event will not be delivered. If the button is released within the timeout, both the press and release will be delivered.

Note that for nested Flickables with pressDelay set, the pressDelay of inner Flickables is overridden by the outermost Flickable.

These properties describe the position and size of the currently viewed area. The size is defined as the percentage of the full view currently visible, scaled to 0.0 - 1.0. The page position is usually in the range 0.0 (beginning) to 1.0 minus size ratio (end), i.e. yPosition is in the range 0.0 to 1.0-heightRatio. However, it is possible for the contents to be dragged outside of the normal range, resulting in the page positions also being outside the normal range.

These properties are typically used to draw a scrollbar. For example:

 Rectangle {
     width: 200; height: 200

     Flickable {
         id: flickable
         ...
     }

     Rectangle {
         id: scrollbar
         anchors.right: flickable.right
         y: flickable.visibleArea.yPosition * flickable.height
         width: 10
         height: flickable.visibleArea.heightRatio * flickable.height
         color: "black"
     }
 }

See also scrollbar example.

This handler is called when the view stops moving due to a flick.

This handler is called when the view is flicked. A flick starts from the point that the mouse or touch is released, while still in motion.

This handler is called when the view stops moving due to user interaction. If a flick was generated, this handler will be triggered once the flick stops. If a flick was not generated, the handler will be triggered when the user stops dragging - i.e. a mouse or touch release.

This handler is called when the view begins moving due to user interaction.

This documentation is under development and is subject to change.

Resizes the content to width x height about center.

This does not scale the contents of the Flickable - it only resizes the contentWidth and contentHeight.

Resizing the content may result in the content being positioned outside the bounds of the Flickable. Calling returnToBounds() will move the content back within legal bounds.

This documentation was introduced in QtQuick 1.1.

This documentation is under development and is subject to change.

Ensures the content is within legal bounds.

This may be called to ensure that the content is within legal bounds after manually positioning the content.

This documentation was introduced in QtQuick 1.1.