• Skip to content
  • Skip to link menu
Brand

API Documentation

  1. KDE API Reference
  2. Kirigami
  • KDE Home
  • Contact Us

Quick Links

Skip menu "Kirigami"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • File List
  • Related Pages

Class Picker

About

QtQuick plugins to build user interfaces based on the KDE UX guidelines

Maintainer
Marco Martin
Supported platforms
Android, Linux
Community
IRC: #plasma on Freenode
Mailing list: plasma-devel
Use with CMake
find_package(KF5Kirigami)
target_link_libraries(yourapp KF5::Kirigami)
Clone
git clone git://anongit.kde.org/kirigami1.git
Browse source
Kirigami on cgit.kde.org

Kirigami

  • View on LXR
  • org
  • kde
  • kirigami
  • ScrollablePage
Properties | List of all members
org::kde::kirigami::ScrollablePage Class Reference
Inheritance diagram for org::kde::kirigami::ScrollablePage:
Inheritance graph
[legend]

Properties

alias bottomPadding
 
alias contentItem
 
alias flickable
 
alias leftPadding
 
alias refreshing
 
alias rightPadding
 
alias supportsRefreshing
 
alias topPadding
 
- Properties inherited from org::kde::kirigami::Page
alias actions
 
Item background
 
int bottomPadding
 
alias contentData
 
alias contextualActions
 
Flickable flickable
 
alias leftAction
 
int leftPadding
 
alias mainAction
 
alias rightAction
 
int rightPadding
 
string title
 
int topPadding
 

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
}
}
ScrollablePage {
id: root
//support for the popular "pull down to refresh" behavior in mobile apps
supportsRefreshing: true
//The ListView will automatically receive proper scroll indicators
ListView {
model: myModel
delegate: BasicListItem { ... }
}
}

Definition at line 60 of file ScrollablePage.qml.

Property Documentation

alias org::kde::kirigami::ScrollablePage::bottomPadding

bottomPadding: int default contents padding at bottom

Definition at line 107 of file ScrollablePage.qml.

alias org::kde::kirigami::ScrollablePage::contentItem

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)

Remarks
This is the default property

Definition at line 87 of file ScrollablePage.qml.

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

flickable: Flickable The main Flickable item of this page

Definition at line 80 of file ScrollablePage.qml.

alias org::kde::kirigami::ScrollablePage::leftPadding

leftPadding: int default contents padding at left

Definition at line 92 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 69 of file ScrollablePage.qml.

alias org::kde::kirigami::ScrollablePage::rightPadding

rightPadding: int default contents padding at right

Definition at line 102 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 75 of file ScrollablePage.qml.

alias org::kde::kirigami::ScrollablePage::topPadding

topPadding: int default contents padding at top

Definition at line 97 of file ScrollablePage.qml.


The documentation for this class was generated from the following file:
  • ScrollablePage.qml
This file is part of the KDE documentation.
Documentation copyright © 1996-2017 The KDE developers.
Generated on Fri Feb 17 2017 11:09:23 by doxygen 1.8.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal