org::kde::kirigami::ScrollablePage Class Reference

Inheritance diagram for org::kde::kirigami::ScrollablePage:

Properties
alias	flickable
alias	horizontalScrollBarPolicy
bool	keyboardNavigationEnabled
QtObject	mainItem
alias	refreshing
alias	supportsRefreshing
alias	verticalScrollBarPolicy
Properties inherited from org::kde::kirigami::Page
alias	actions
alias	contextualActions
Flickable	flickable
Item	globalToolBarItem
bool	isCurrentPage
alias	leftAction
alias	mainAction
alias	overlay
alias	rightAction

Additional Inherited Members
Signals inherited from org::kde::kirigami::Page
void	backRequested (var event)

Detailed Description

ScrollablePage is a container for all the app pages: everything pushed to the ApplicationWindow stackView should be a Page or ScrollablePage instabnce.

This Page subclass is for content that has to be scrolled around, such as bigger content than the screen that would normally go in a Flickable or a ListView. Scrolling and scrolling indicators will be automatically managed

ScrollablePage {
    id: root
    //The rectangle will automatically bescrollable
    Rectangle {
        width: root.width
        height: 99999
    }
}

Another behavior added by this class is a "scroll down to refresh" behavior It also can give 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.

Implementations should handle the refresh themselves as follows

Kirigami.ScrollablePage {
    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 75 of file ScrollablePage.qml.

Property Documentation

alias org::kde::kirigami::ScrollablePage::flickable

flickable: Flickable The main Flickable item of this page

Definition at line 95 of file ScrollablePage.qml.

alias org::kde::kirigami::ScrollablePage::horizontalScrollBarPolicy

horizontalScrollBarPolicy: Qt.ScrollBarPolicy The horizontal scrollbar policy

Definition at line 105 of file ScrollablePage.qml.

bool org::kde::kirigami::ScrollablePage::keyboardNavigationEnabled

keyboardNavigationEnabled: bool If true, and if flickable is an item view, like a ListView or a GridView, it will be possible to navigate the list current item to next and previous items with keyboard up/down arrow buttons.

Also, any key event will be forwarded to the current list item. default is true.

Definition at line 122 of file ScrollablePage.qml.

QtObject org::kde::kirigami::ScrollablePage::mainItem

The main content Item of this page.

In the case of a ListView or GridView, both contentItem and flickable will be a pointer to the ListView (or GridView) NOTE: can't be contentItem as Page's contentItem is final

Remarks

This is the default property

Definition at line 113 of file ScrollablePage.qml.

alias org::kde::kirigami::ScrollablePage::refreshing

refreshing: 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 84 of file ScrollablePage.qml.

alias org::kde::kirigami::ScrollablePage::supportsRefreshing

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

default is false.

Definition at line 90 of file ScrollablePage.qml.

alias org::kde::kirigami::ScrollablePage::verticalScrollBarPolicy

verticalScrollBarPolicy: Qt.ScrollBarPolicy The vertical scrollbar policy

Definition at line 100 of file ScrollablePage.qml.

---

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

• ScrollablePage.qml