org::kde::kirigami::ApplicationWindow

org
kde
kirigami
ApplicationWindow

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

[legend]

Properties
alias	pageStack

Properties inherited from org::kde::kirigami::AbstractApplicationWindow
OverlayDrawer	contextDrawer

bool	controlsVisible

OverlayDrawer	globalDrawer

Item	pageStack

Action	quitAction

bool	reachableMode

bool	reachableModeEnabled

bool	wideScreen

Additional Inherited Members
Public Member Functions inherited from org::kde::kirigami::AbstractApplicationWindow
void	applicationWindow ()

void	hidePassiveNotification (index=0)

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 AbstractApplicationWindow

See also: AbstractApplicationWindow

Setting a width and height property on the ApplicationWindow will set its initial size, but it won't set it as an automatically binding. to resize programmatically the ApplicationWindow they need to be assigned again in an imperative fashion

Example usage:

import org.kde.kirigami 2.4 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 86 of file ApplicationWindow.qml.

Property Documentation

◆ pageStack

org::kde::kirigami::PageRow org::kde::kirigami::ApplicationWindow::pageStack

read

This property holds 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.