org::kde::kirigami::RefreshableScrollView Class Reference

Inherits QtQuick.Controls.Scrollview, and ScrollView.

Properties
int	bottomPadding
int	leftPadding
bool	refreshing
int	rightPadding
bool	supportsRefreshing
int	topPadding

Detailed Description

RefreshableScrollView is a scroll view for any Flickable that supports the "scroll down to refresh" behavior, and also allows the contents of the flickable to have more top margins in order to make possible to scroll down the list to reach it with the thumb while using the phone with a single hand.

Example usage:

import org.kde.kirigami 1.0 as Kirigami
[...]

Kirigami.RefreshableScrollView {
    id: view
    supportsRefreshing: true
    onRefreshingChanged: {
        if (refreshing) {
            myModel.refresh();
        }
    }
    ListView {
        //NOTE: MyModel doesn't come from the components,
        //it's purely an example on how it can be used together
        //some application logic that can update the list model
        //and signals when it's done.
        model: MyModel {
            onRefreshDone: view.refreshing = false;
        }
        delegate: BasicListItem {}
    }
}
[...]

Definition at line 62 of file RefreshableScrollView.qml.

Property Documentation

int org::kde::kirigami::RefreshableScrollView::bottomPadding

bottomPadding: int default contents padding at bottom

Definition at line 96 of file RefreshableScrollView.qml.

int org::kde::kirigami::RefreshableScrollView::leftPadding

leftPadding: int default contents padding at left

Definition at line 81 of file RefreshableScrollView.qml.

bool org::kde::kirigami::RefreshableScrollView::refreshing

type: bool If true the list is asking for refresh and will show a loading spinner.

it will automatically be set to true when the user pulls down enough the list. This signals the application logic to start its refresh procedure. The application itself will have to set back this property to false when done.

Definition at line 71 of file RefreshableScrollView.qml.

int org::kde::kirigami::RefreshableScrollView::rightPadding

rightPadding: int default contents padding at right

Definition at line 91 of file RefreshableScrollView.qml.

bool org::kde::kirigami::RefreshableScrollView::supportsRefreshing

type: bool If true the list supports the "pull down to refresh" behavior.

Definition at line 76 of file RefreshableScrollView.qml.

int org::kde::kirigami::RefreshableScrollView::topPadding

topPadding: int default contents padding at top

Definition at line 86 of file RefreshableScrollView.qml.

---

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

• RefreshableScrollView.qml