org::kde::kirigami::AbstractApplicationItem

Search for usage in LXR

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

Properties

alias __data
 
Item activeFocusItem
 
Item background
 
color color
 
Item contentItem
 
OverlayDrawer contextDrawer
 
bool controlsVisible
 
font font
 
Item footer
 
OverlayDrawer globalDrawer
 
Item header
 
Locale locale
 
Item menuBar
 
alias overlay
 
Item pageStack
 
var palette
 
bool reachableMode
 
bool reachableModeEnabled
 
bool wideScreen
 

Public Member Functions

void applicationWindow ()
 
void hidePassiveNotification (index=0)
 
void showPassiveNotification (message, timeout, actionText, callBack)
 
- Public Member Functions inherited from QtQuick.Item
 childAt (x, real y)
 
bool contains (point)
 
 forceActiveFocus ()
 
 forceActiveFocus (reason)
 
bool grabToImage (callback, targetSize)
 
object mapFromGlobal (x, real y)
 
object mapFromItem (item, point p)
 
object mapFromItem (item, real x, real y)
 
object mapFromItem (item, real x, real y, real width, real height)
 
object mapFromItem (item, rect r)
 
object mapToGlobal (x, real y)
 
object mapToItem (item, point p)
 
object mapToItem (item, real x, real y)
 
object mapToItem (item, real x, real y, real width, real height)
 
object mapToItem (item, rect r)
 
 nextItemInFocusChain (forward)
 

Detailed Description

An item that provides the features of AbstractApplicationWindow without the window itself.

This allows embedding into a larger application. Unless you need extra flexibility it is recommended to use ApplicationItem instead.

Example usage:

import org.kde.kirigami 2.4 as Kirigami
Kirigami.AbstractApplicationItem {
[...]
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: Kirigami.PageRow {
...
}
[...]
}

Definition at line 59 of file AbstractApplicationItem.qml.

Property Documentation

◆ __data

list< Object > org::kde::kirigami::AbstractApplicationItem::__data
read

This property holds the list of all children of this item.

Remarks
This is the default property

Definition at line 225 of file AbstractApplicationItem.qml.

◆ activeFocusItem

Item org::kde::kirigami::AbstractApplicationItem::activeFocusItem
read

This property exists for compatibility with Applicationwindow.

default: Window.activeFocusItem

Remarks
This property is read-only

Definition at line 75 of file AbstractApplicationItem.qml.

◆ background

Item org::kde::kirigami::AbstractApplicationItem::background
read

This property holds the background of the Application UI.

Definition at line 240 of file AbstractApplicationItem.qml.

◆ color

color org::kde::kirigami::AbstractApplicationItem::color
read

This property holds the color for the background.

default: Kirigami.Theme.backgroundColor

Definition at line 236 of file AbstractApplicationItem.qml.

◆ contentItem

Item org::kde::kirigami::AbstractApplicationItem::contentItem
read

This property holds the Item of the main part of the Application UI.

Remarks
This property is read-only

Definition at line 230 of file AbstractApplicationItem.qml.

◆ contextDrawer

org::kde::kirigami::ContextDrawer org::kde::kirigami::AbstractApplicationItem::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 class here.

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

Example usage:

import org.kde.kirigami 2.4 as Kirigami
Kirigami.ApplicationItem {
[...]
contextDrawer: Kirigami.ContextDrawer {
}
[...]
}
import org.kde.kirigami 2.4 as Kirigami
Kirigami.Page {
[...]
contextualActions: [
Kirigami.Action {
icon.name: "edit"
text: "Action text"
onTriggered: {
// do stuff
}
},
Kirigami.Action {
icon.name: "edit"
text: "Action text"
onTriggered: {
// do stuff
}
}
]
[...]
}

When this page will be the current one, the context drawer will visualize contextualActions defined as property in that page.

Definition at line 202 of file AbstractApplicationItem.qml.

◆ controlsVisible

bool org::kde::kirigami::AbstractApplicationItem::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 129 of file AbstractApplicationItem.qml.

◆ font

font org::kde::kirigami::AbstractApplicationItem::font
read

This property holds the font for this item.

default: Kirigami.Theme.defaultFont

Definition at line 81 of file AbstractApplicationItem.qml.

◆ footer

Item org::kde::kirigami::AbstractApplicationItem::footer
read

This property holds an item that can be used as a footer for the application.

Definition at line 121 of file AbstractApplicationItem.qml.

◆ globalDrawer

org::kde::kirigami::OverlayDrawer org::kde::kirigami::AbstractApplicationItem::globalDrawer
read

This property holds the drawer for global actions.

Thos 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 139 of file AbstractApplicationItem.qml.

◆ header

org::kde:kirigami::ApplicationHeader org::kde::kirigami::AbstractApplicationItem::header
read

This property holds an item that can be used as a title for the application.

Scrolling the main page will make it taller or shorter (through the point of going away).

It's a behavior similar to the typical mobile web browser addressbar.

The minimum, preferred and maximum heights of the item can be controlled with

To achieve a titlebar that stays completely fixed, just set the 3 sizes as the same.

Warning
This will be restricted to Kirigami.ApplicationHeader in KF6.

Definition at line 116 of file AbstractApplicationItem.qml.

◆ locale

Locale org::kde::kirigami::AbstractApplicationItem::locale
read

This property holds the locale for this item.

Definition at line 91 of file AbstractApplicationItem.qml.

◆ menuBar

Item org::kde::kirigami::AbstractApplicationItem::menuBar
read

This property holds an item that can be used as a menuBar for the application.

Warning
This will be restricted to QQC2.MenuBar in KF6.

Definition at line 96 of file AbstractApplicationItem.qml.

◆ pageStack

Item org::kde::kirigami::AbstractApplicationItem::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 68 of file AbstractApplicationItem.qml.

◆ palette

var org::kde::kirigami::AbstractApplicationItem::palette
read

This property holds the palette for this item.

default: Kirigami.Theme.palette

Definition at line 87 of file AbstractApplicationItem.qml.

◆ reachableMode

bool org::kde::kirigami::AbstractApplicationItem::reachableMode
read

This tells us whether the application is in reachable mode for single hand use.

The whole content of the application is moved down the screen to be reachable with the thumb. If wideScreen is true, or reachableModeEnabled is false, this property has no effect.

default: false

Definition at line 212 of file AbstractApplicationItem.qml.

◆ reachableModeEnabled

bool org::kde::kirigami::AbstractApplicationItem::reachableModeEnabled
read

This property sets whether the application will go into reachable mode on pull down.

default: true

Definition at line 218 of file AbstractApplicationItem.qml.

◆ wideScreen

bool org::kde::kirigami::AbstractApplicationItem::wideScreen
read

This property tells us 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 147 of file AbstractApplicationItem.qml.

Member Function Documentation

◆ applicationWindow()

void org::kde::kirigami::AbstractApplicationItem::applicationWindow ( )

This property gets application windows object anywhere in the application.

Returns
a pointer to this item.

◆ hidePassiveNotification()

void org::kde::kirigami::AbstractApplicationItem::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 org::kde::kirigami::AbstractApplicationItem::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:
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.
OverlayDrawer globalDrawer
This property holds the drawer for global actions.
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Feb 7 2023 04:14:24 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.