org::kde::kirigami::Page

Search for usage in LXR

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

Properties

alias actions
 
alias contextualActions
 
Flickable flickable
 
Item globalToolBarItem
 
int globalToolBarStyle
 
ActionIconGroup icon
 
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 ApplicationWindow's pageStack should be a Page.

See also
ScrollablePage For content that should be scrollable, such as ListViews, use ScrollablePage instead.

Definition at line 20 of file Page.qml.

Property Documentation

◆ actions

alias org::kde::kirigami::Page::actions
read

Actions properties are grouped.

import org.kde.kirigami 2.4 as Kirigami
Kirigami.Page {
main: Kirigami.Action {...}
left: Kirigami.Action {...}
right: Kirigami.Action {...}
Kirigami.Action {...},
Kirigami.Action {...}
]
}
}
Remarks
This property is read-only

Definition at line 160 of file Page.qml.

◆ contextualActions

list< QtQml.QtObject > actions 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
}
}
]
[...]
}

Definition at line 77 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.

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

Definition at line 32 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
2.5
Remarks
This property is read-only

Definition at line 226 of file Page.qml.

◆ globalToolBarStyle

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

The style for the automatically generated global toolbar: by default the Page toolbar is the one set globally in the PageRow in its globalToolBar.style property.

A single page can override the application toolbar style for itself. It is discouraged to use this, except very specific exceptions, like a chat application which can't have controls on the bottom except the text field. If the Page is not in a PageRow, by default the toolbar will be invisible, so has to be explicitly set to Kirigami.ApplicationHeaderStyle.ToolBar if desired to be used in that case.

Definition at line 236 of file Page.qml.

◆ icon

variant Page::icon
read

The icon that represents this page.

Definition at line 192 of file Page.qml.

◆ isCurrentPage

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

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
2.1
Remarks
This property is read-only

Definition at line 176 of file Page.qml.

◆ leftAction

Action Page::leftAction
read

An optional extra action at the left of the main action button. it can be a Kirigami.Action or a QAction.

Example usage:

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

Definition at line 119 of file Page.qml.

◆ mainAction

Action Page::mainAction
read

An optional single action for the action button. it can be a Kirigami.Action or a QAction.

Example usage:

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

Definition at line 98 of file Page.qml.

◆ needsAttention

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

Whether this page needs user attention.

Definition at line 196 of file Page.qml.

◆ overlay

Item Page::overlay
read
Remarks
This property is read-only

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. It's a "local" version of ApplicationWindow's overlay

Since
2.5

Definition at line 186 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.

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. it can be a Kirigami.Action or a QAction.

Example usage:

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

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
2.7

Definition at line 208 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
2.7

The documentation for this class was generated from the following file:
QTextStream & right(QTextStream &stream)
QTextStream & left(QTextStream &stream)
ActionIconGroup icon
Definition: Page.qml:192
alias actions
Actions properties are grouped.
Definition: Page.qml:160
alias contextualActions
Defines the contextual actions for the page: an easy way to assign actions in the right sliding panel...
Definition: Page.qml:77
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Fri Jul 1 2022 05:18:19 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.