AbstractApplicationWindow

Search for usage in LXR

AbstractApplicationWindow Class Reference
Inheritance diagram for AbstractApplicationWindow:

Properties

OverlayDrawer contextDrawer
 
bool controlsVisible
 
OverlayDrawer globalDrawer
 
Item overlay
 
Item pageStack
 
KirigamiAction quitAction
 
bool wideScreen
 

Public Member Functions

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 Use this class only if you need a custom content for your application, different from the Page Row behavior recommended by the HIG and provided by ApplicationWindow.

It is recommended to use ApplicationWindow instead

See also
ApplicationWindow

It's usually used as a root QML component for the application. It provides support for a central page stack, side drawers, and basic support for the Android back button.

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 as Kirigami
Kirigami.ApplicationWindow {
[...]
globalDrawer: Kirigami.GlobalDrawer {
actions: [
Kirigami.Action {
text: "View"
icon.name: "view-list-icons"
Kirigami.Action {
text: "action 1"
}
Kirigami.Action {
text: "action 2"
}
Kirigami.Action {
text: "action 3"
}
},
Kirigami.Action {
text: "Sync"
icon.name: "folder-sync"
}
]
}
contextDrawer: Kirigami.ContextDrawer {
}
pageStack: PageStack {
...
}
[...]
}
OverlayDrawer contextDrawer
This property holds the drawer for context-dependent actions.
Item pageStack
This property holds the stack used to allocate the pages and to manage the transitions between them.

Definition at line 69 of file AbstractApplicationWindow.qml.

Property Documentation

◆ contextDrawer

OverlayDrawer AbstractApplicationWindow::contextDrawer
read

This property holds the drawer for context-dependent actions.

The drawer that will be opened by sliding from the right screen edge or by dragging the ActionButton to the left.

Note
It is recommended to use the ContextDrawer type here.

The contents of the context drawer should depend from what page is loaded in the main pageStack

Example usage:

import org.kde.kirigami as Kirigami
Kirigami.ApplicationWindow {
contextDrawer: Kirigami.ContextDrawer {
enabled: true
actions: [
Kirigami.Action {
icon.name: "edit"
text: "Action text"
onTriggered: {
// do stuff
}
},
Kirigami.Action {
icon.name: "edit"
text: "Action text"
onTriggered: {
// do stuff
}
}
]
}
}

Definition at line 146 of file AbstractApplicationWindow.qml.

◆ controlsVisible

bool AbstractApplicationWindow::controlsVisible
read

This property sets whether the standard chrome of the app is visible.

These are the action button, the drawer handles, and the application header.

default: true

Definition at line 86 of file AbstractApplicationWindow.qml.

◆ globalDrawer

OverlayDrawer AbstractApplicationWindow::globalDrawer
read

This property holds the drawer for global actions.

This drawer can be opened by sliding from the left screen edge or by dragging the ActionButton to the right.

Note
It is recommended to use the GlobalDrawer here.

Definition at line 96 of file AbstractApplicationWindow.qml.

◆ overlay

Item AbstractApplicationWindow::overlay
read

Effectively the same as T.Overlay.overlay.

Remarks
This property is read-only

Definition at line 151 of file AbstractApplicationWindow.qml.

◆ pageStack

Item AbstractApplicationWindow::pageStack
read

This property holds the stack used to allocate the pages and to manage the transitions between them.

Put a container here, such as QtQuick.Controls.StackView.

Definition at line 78 of file AbstractApplicationWindow.qml.

◆ quitAction

KirigamiAction AbstractApplicationWindow::quitAction
read

This property holds a standard action that will quit the application when triggered.

Its properties have the following values:

Action {
text: "Quit"
icon.name: "application-exit-symbolic"
shortcut: StandardKey.Quit
// ...
}
Since
5.76
Remarks
This property is read-only

Definition at line 167 of file AbstractApplicationWindow.qml.

◆ wideScreen

bool AbstractApplicationWindow::wideScreen
read

This property tells whether the application is in "widescreen" mode.

This is enabled on desktops or horizontal tablets.

Note
Different styles can have their own logic for deciding this.

Definition at line 104 of file AbstractApplicationWindow.qml.

Member Function Documentation

◆ applicationWindow()

void AbstractApplicationWindow::applicationWindow ( )

This function returns application window's object anywhere in the application.

Returns
a pointer to this application window can be used anywhere in the application.

◆ hidePassiveNotification()

void AbstractApplicationWindow::hidePassiveNotification ( index = 0)

This function hides the passive notification at specified index, if any is shown.

Parameters
indexIndex of the notification to hide. Default is 0 (oldest notification).

◆ showPassiveNotification()

void AbstractApplicationWindow::showPassiveNotification ( message ,
timeout ,
actionText ,
callBack  )

This function shows a little passive notification at the bottom of the app window lasting for few seconds, with an optional action button.

Parameters
messageThe text message to be shown to the user.
timeoutHow long to show the message: possible values: "short", "long" or the number of milliseconds
actionTextText in the action button, if any.
callBackA JavaScript function that will be executed when the user clicks the button.

The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 12 2024 12:00:02 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.