org::kde::kirigami::ApplicationWindow

Search for usage in LXR

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

Properties

alias pageStack
 
- Properties inherited from org::kde::kirigami::AbstractApplicationWindow
Kirigami Action
 
OverlayDrawer contextDrawer
 
bool controlsVisible
 
OverlayDrawer globalDrawer
 
Item pageStack
 
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.

An application window is a top-level component that provides several utilities for convenience, such as:

See also
kirigami::AbstractApplicationWindow

Use this class only if you need custom content for your application that is different from the PageRow behavior recommended by the HIG and provided by kirigami::AbstractApplicationWindow.

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 {
}
pageStack.initialPage: Kirigami.Page {
actions {
main: 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 87 of file ApplicationWindow.qml.

Property Documentation

◆ pageStack

Kirgiami PageRow org::kde::kirigami::ApplicationWindow::pageStack
read

This property holds the PageRow that is used to allocate the pages and manage the transitions between them.

It implements useful features to control then shown pages such as:

See also
kirigami::PageRow
Warning
This property is not currently readonly, but it should be treated like it is readonly.

Definition at line 102 of file ApplicationWindow.qml.


The documentation for this class was generated from the following file:
OverlayDrawer contextDrawer
This property holds the drawer for context-dependent actions.
OverlayDrawer globalDrawer
This property holds the drawer for global actions.
alias pageStack
This property holds the PageRow that is used to allocate the pages and manage the transitions between...
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon May 8 2023 04:07:14 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.