PullDownIndicator Class Reference

Properties
bool	active
Flickable	flickable
real	progress
int	refreshDelay

Signals
void	triggered ()

Detailed Description

A pull-down to refresh indicator that can be added to any Flickable or ScrollablePage.

Definition at line 13 of file PullDownIndicator.qml.

Property Documentation

active

bool PullDownIndicator::active

read

Whether to show the busy indicator at the top of the flickable.

This should be set to true whenever a refresh is in progress. It should typically be set to true whe triggered() is emitted, and set to false when the refresh is complete. This is not done automatically because the refresh may be triggered from outside the indicator.

Definition at line 30 of file PullDownIndicator.qml.

flickable

Flickable PullDownIndicator::flickable

read

The flickable that this indicator is attached to.

If this is not set, the indicator will search for a Flickable in its parent chain.

Definition at line 21 of file PullDownIndicator.qml.

progress

real PullDownIndicator::progress

read

How far the flickable has been pulled down, between 0 (not at all) and 1 (where a refresh is triggered).

Remarks

This property is read-only

Definition at line 35 of file PullDownIndicator.qml.

refreshDelay

int PullDownIndicator::refreshDelay

read

Time to wait after the flickable has been pulled down before triggering a refresh.

This gives the user a chance to back out of the refresh if they release the flickable before the refreshDelay has elapsed.

Definition at line 42 of file PullDownIndicator.qml.

Member Function Documentation

triggered

void PullDownIndicator::triggered ( )

signal

emitted when the flickable is pulled down far enough to trigger a refresh

---

The documentation for this class was generated from the following file:

• PullDownIndicator.qml