org::kde::kirigami::Page Class Reference

Inheritance diagram for org::kde::kirigami::Page:

Properties
P	ActionIconGroup
alias	actions
alias	contextualActions
Flickable	flickable
Item	globalToolBarItem
int	globalToolBarStyle
bool	isCurrentPage
alias	leftAction
alias	mainAction
bool	needsAttention
alias	overlay
var	progress
alias	rightAction
Component	titleDelegate

Signals
void	backRequested (var event)
void	contextualActionsAboutToShow ()

Detailed Description

Page is a container for all the app pages: everything pushed to the pageStack should be a Page.

For content that should be scrollable, such as QtQuick.ListView, use ScrollablePage instead.

Definition at line 19 of file Page.qml.

Property Documentation

ActionIconGroup

P org::kde::kirigami::Page::ActionIconGroup

read

This holds the icon that represents this page.

Definition at line 189 of file Page.qml.

actions

kirigami::private::PageActionPropertyGroup Page::actions

read

This property holds the actions group.

Remarks

This property is read-only

import org.kde.kirigami 2.4 as Kirigami
Kirigami.Page {
    actions {
        main: Kirigami.Action {...}
        left: Kirigami.Action {...}
        right: Kirigami.Action {...}
        contextualActions: [
            Kirigami.Action {...},
            Kirigami.Action {...}
        ]
    }
}

See also

KDE Human Interface Guidelines on Actions

Definition at line 161 of file Page.qml.

contextualActions

list< QtQml.QtObject > Page::contextualActions

read

Defines the contextual actions for the page: an easy way to assign actions in the right sliding panel.

Example usage:

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

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

Warning

This will be removed in KF6.

Definition at line 80 of file Page.qml.

flickable

Flickable org::kde::kirigami::Page::flickable

read

If the central element of the page is a Flickable (ListView and Gridview as well) you can set it there.

Normally, you wouldn't need to do that, but just use the ScrollablePage element instead.

Use this if your flickable has some non standard properties, such as not covering the whole Page.

See also

kirigami::ScrollablePage

Definition at line 34 of file Page.qml.

globalToolBarItem

Item org::kde::kirigami::Page::globalToolBarItem

read

The item used as global toolbar for the page present only if we are in a PageRow as a page or as a layer, and the style is either Titles or ToolBar.

Since

org.kde.kirigami 2.5

Remarks

This property is read-only

Definition at line 220 of file Page.qml.

globalToolBarStyle

int org::kde::kirigami::Page::globalToolBarStyle

read

This property holds the style for the automatically generated toolbar of the PageRow where the Page is inserted.

By default, the Page's globalToolBarStyle determines the style used by the PageRow where it is inserted, updating the PageRow's globalToolBar style. This allows for a single page to override the application toolbar style for itself.

It is discouraged to use this, except in very specific cases, like a chat application that can't have controls at the bottom except for a text field. If the Page is not in a PageRow, by default, the toolbar will be invisible, so Page::globalToolBarStyle has to be explicitly set to ApplicationHeaderStyle.ToolBar to be used in that case.

Definition at line 236 of file Page.qml.

isCurrentPage

bool org::kde::kirigami::Page::isCurrentPage

read

This property specifies us if it is the currently active page.

Specifies if it's the currently selected page in the window's pages row, or if layers are used whether this is the topmost item on the layers stack. If the page is not attached to either a column view or a stack view, expect this to be true.

Since

org.kde.kirigami 2.1

Remarks

This property is read-only

Definition at line 174 of file Page.qml.

leftAction

Action Page::leftAction

read

An optional extra action at the left of the main action button.

Example usage:

import org.kde.kirigami 2.4 as Kirigami
Kirigami.Page {
    actions.left: Kirigami.Action {
        icon.name: "edit"
        onTriggered: {
            // do stuff
        }
    }
}

Warning

This will be removed in KF6.

Definition at line 120 of file Page.qml.

mainAction

Action Page::mainAction

read

An optional single action for the action button.

Example usage:

import org.kde.kirigami 2.4 as Kirigami
Kirigami.Page {
    actions.main: Kirigami.Action {
        icon.name: "edit"
        onTriggered: {
            // do stuff
        }
    }
}

Warning

This will be removed in KF6.

Definition at line 100 of file Page.qml.

needsAttention

bool org::kde::kirigami::Page::needsAttention

read

Whether this page needs user attention.

Definition at line 193 of file Page.qml.

overlay

Item Page::overlay

read

An item which stays on top of every other item in the page, if you want to make sure some elements are completely in a layer on top of the whole content, parent items to this one.

Remarks

This property is read-only

It's a "local" version of ApplicationWindow's overlay

Since

org.kde.kirigami 2.5

Definition at line 185 of file Page.qml.

progress

real Page::progress

read

Progress of a task this page is doing.

Set to undefined to indicate that there are no ongoing tasks.

default: undefined

Definition at line 203 of file Page.qml.

rightAction

Action Page::rightAction

read

An optional extra action at the right of the main action button.

Example usage:

import org.kde.kirigami 2.4 as Kirigami
Kirigami.Page {
    actions.right: Kirigami.Action {
        icon.name: "edit"
        onTriggered: {
            // do stuff
        }
    }
}

Warning

This will be removed in KF6.

Definition at line 140 of file Page.qml.

titleDelegate

Component org::kde::kirigami::Page::titleDelegate

read

The delegate which will be used to draw the page title.

It can be customized to put any kind of Item in there.

Since

org.kde.kirigami 2.7

Definition at line 211 of file Page.qml.

Member Function Documentation

backRequested

void org::kde::kirigami::Page::backRequested ( var  event )

signal

Emitted when the application requests a Back action.

For instance a global "back" shortcut or the Android Back button has been pressed. The page can manage the back event by itself, and if it set event.accepted = true, it will stop the main application to manage the back event.

contextualActionsAboutToShow

void org::kde::kirigami::Page::contextualActionsAboutToShow ( )

signal

Emitted when a visualization for the actions is about to be shown, such as the toolbar menu or the ContextDrawer.

Since

org.kde.kirigami 2.7

---

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

• Page.qml