org::kde::kirigami::ApplicationWindow Class Reference

Inheritance diagram for org::kde::kirigami::ApplicationWindow:

Properties
alias	pageStack
Properties inherited from org::kde::kirigami::AbstractApplicationWindow
AbstractDrawer	contextDrawer
bool	controlsVisible
AbstractDrawer	globalDrawer
var	header
Item	pageStack
bool	reachableMode
bool	wideScreen

Additional Inherited Members
Public Member Functions inherited from org::kde::kirigami::AbstractApplicationWindow
void	applicationWindow ()
void	hidePassiveNotification ()
void	showPassiveNotification (message, timeout, actionText, callBack)

Detailed Description

A window that provides some basic features needed for all apps.

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 AbstractApplicationWidnow

See Also

AbstractApplicationWidnow

Example usage:

import org.kde.kirigami 1.0 as Kirigami

Kirigami.ApplicationWindow {
 [...]
    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 96 of file controls/ApplicationWindow.qml.

Property Documentation

alias org::kde::kirigami::ApplicationWindow::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 108 of file controls/ApplicationWindow.qml.

---

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

• controls/ApplicationWindow.qml