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 {
        id: 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 229 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 244 of file AbstractApplicationItem.qml.

color

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

read

This property holds background's color.

default: Kirigami.Theme.backgroundColor

Definition at line 240 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 234 of file AbstractApplicationItem.qml.

contextDrawer

kirigami::ContextDrawer org::kde::kirigami::AbstractApplicationItem::contextDrawer

read

This property holds the drawer for context-dependent actions.

This drawer can be opened by sliding from the right screen edge or by either pressing on the handle or sliding it to the left.

Note

It is recommended to use the ContextDrawer class here.

The context drawer will display the previously defined contextual actions of the page that is currently active in the pageStack.

Example usage:

import org.kde.kirigami 2.4 as Kirigami
 
Kirigami.ApplicationItem {
 [...]
    contextDrawer: Kirigami.ContextDrawer {
        id: contextDrawer
    }
 [...]
}

import org.kde.kirigami 2.4 as Kirigami
 
Kirigami.Page {
  [...]
    // setting the contextual actions
    actions.contextualActions: [
        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 201 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

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

read

This property holds the drawer for global actions.

This drawer can be opened by sliding from the left screen edge or by either pressing on the handle or sliding it to the right.

Note

It is recommended to use the GlobalDrawer here.

Definition at line 139 of file AbstractApplicationItem.qml.

header

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

• Layout.minimumHeight: default is 0, i.e. hidden
• Layout.preferredHeight: default is Kirigami.Units.gridUnit * 1.6
• Layout.maximumHeight: default is Kirigami.Units.gridUnit * 3

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 or PageRow.

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 property specifies 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.

Note

This property should be treated as readonly. Use reachableModeEnabled instead.

default: false

See also

::reachableModeEnabled

Definition at line 216 of file AbstractApplicationItem.qml.

reachableModeEnabled

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

read

This property sets whether reachable mode can be used.

default: true

Definition at line 222 of file AbstractApplicationItem.qml.

wideScreen

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

read

This property specifies 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 returns a pointer to the main instance of AbstractApplicationItem.

This is available to any children of this Item, including those instantiated from separate QML files, making interoperation with multiple files easier.

Use this whenever you need access to properties that are available to the main AbstractApplicationItem, such as its pageStack, globalDrawer or header.

See also

AbstractApplicationWindow::applicationWindow()

Returns

a pointer to the instantiated AbstractApplicationItem.

hidePassiveNotification()

void org::kde::kirigami::AbstractApplicationItem::hidePassiveNotification

(

index

= 0

)

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

Parameters

index

Index 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 passive notification at the bottom of the app window lasting for few seconds, with an optional action button.

Parameters

message	The text message to be shown to the user.
timeout	How long to show the message: possible values: "short", "long" or the number of milliseconds
actionText	Text in the action button, if any.
callBack	A JavaScript function that will be executed when the user clicks the button.

---

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

• AbstractApplicationItem.qml