• Skip to content
  • Skip to link menu
Brand

API Documentation

  1. KDE API Reference
  2. The KDE Frameworks
  3. Kirigami2
  • KDE Home
  • Contact Us

Quick Links

Skip menu "Kirigami2"
  • 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 human interface guidelines

Maintainer
Marco Martin
Supported platforms
Android, FreeBSD, iOS, Linux, MacOSX, Windows
Community
IRC: #kde-kirigami on Freenode
Mailing list: plasma-devel
Use with CMake
find_package(KF5Kirigami2)
target_link_libraries(yourapp KF5::Kirigami2)
Clone
git clone git://anongit.kde.org/kirigami.git
Browse source
Kirigami2 on cgit.kde.org

Kirigami2

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

Properties

alias pageStack
 
- Properties inherited from org::kde::kirigami::AbstractApplicationItem
alias __data
 
Item activeFocusItem
 
Item contentItem
 
OverlayDrawer contextDrawer
 
bool controlsVisible
 
Item footer
 
OverlayDrawer globalDrawer
 
Item header
 
alias overlay
 
Item pageStack
 
bool reachableMode
 
bool reachableModeEnabled
 
bool wideScreen
 

Additional Inherited Members

- Public Member Functions inherited from org::kde::kirigami::AbstractApplicationItem
void applicationWindow ()
 
void hidePassiveNotification ()
 
void showPassiveNotification (message, timeout, actionText, callBack)
 

Detailed Description

A window that provides some basic features needed for all apps This version is an Item as opposed to a window, it's intended for use into a QQuickView.

It's usually used as a root QML component for the application. It's based around the PageRow component, the application will be about pages adding and removal. For most of the usages, this class should be used instead of AbstractApplicationWindow

See also
AbstractApplicationWindow

Example usage:

import org.kde.kirigami 2.4 as Kirigami
Kirigami.ApplicationItem {
[...]
globalDrawer: Kirigami.GlobalDrawer {
actions: [
Kirigami.Action {
text: "View"
iconName: "view-list-icons"
Kirigami.Action {
text: "action 1"
}
Kirigami.Action {
text: "action 2"
}
Kirigami.Action {
text: "action 3"
}
},
Kirigami.Action {
text: "Sync"
iconName: "folder-sync"
}
]
}
contextDrawer: Kirigami.ContextDrawer {
id: contextDrawer
}
pageStack.initialPage: Kirigami.Page {
mainAction: Kirigami.Action {
iconName: "edit"
onTriggered: {
// do stuff
}
}
contextualActions: [
Kirigami.Action {
iconName: "edit"
text: "Action text"
onTriggered: {
// do stuff
}
},
Kirigami.Action {
iconName: "edit"
text: "Action text"
onTriggered: {
// do stuff
}
}
]
[...]
}
[...]
}

Definition at line 97 of file ApplicationItem.qml.

Property Documentation

alias org::kde::kirigami::ApplicationItem::pageStack

pageStack: StackView Readonly.

The stack used to allocate the pages and to manage the transitions between them. It's using a PageRow, while having the same API as PageStack, it positions the pages as adjacent columns, with as many columns as can fit in the screen. An handheld device would usually have a single fullscreen column, a tablet device would have many tiled columns.

Definition at line 109 of file ApplicationItem.qml.


The documentation for this class was generated from the following file:
  • ApplicationItem.qml
This file is part of the KDE documentation.
Documentation copyright © 1996-2019 The KDE developers.
Generated on Thu Dec 5 2019 03:54:03 by doxygen 1.8.11 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