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

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

Properties
alias	actions
Item	background
int	bottomPadding
alias	contentData
alias	contextualActions
Flickable	flickable
alias	leftAction
int	leftPadding
alias	mainAction
alias	rightAction
int	rightPadding
string	title
int	topPadding

Signals
void	backRequested (var event)

Detailed Description

Page is a container for all the app pages: everything pushed to the ApplicationWindow stackView should be a Page instabnce (or a subclass, such as ScrollablePage)

See Also

ScrollablePage

Definition at line 29 of file Page.qml.

Property Documentation

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

Actions properties are grouped.

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

Remarks

This property is read-only

Definition at line 199 of file Page.qml.

Item org::kde::kirigami::Page::background

background: Item This property holds the background item.

Note: If the background item has no explicit size specified, it automatically follows the control's size. In most cases, there is no need to specify width or height for a background item.

Definition at line 208 of file Page.qml.

int org::kde::kirigami::Page::bottomPadding

bottomPadding: int default contents padding at bottom

Definition at line 55 of file Page.qml.

alias org::kde::kirigami::Page::contentData

contentData: Item The main items contained in this Page

Remarks

This is the default property

Definition at line 61 of file Page.qml.

alias org::kde::kirigami::Page::contextualActions

actions.contextualActions: list<QtObject> Defines the contextual actions for the page: an easy way to assign actions in the right sliding panel

Example usage:

import org.kde.kirigami 1.0 as Kirigami

Kirigami.ApplicationWindow {
 [...]
    contextDrawer: Kirigami.ContextDrawer {
        id: contextDrawer
    }
 [...]
}

import org.kde.kirigami 1.0 as Kirigami

Kirigami.Page {
  [...]
    actions.contextualActions: [
        Kirigami.Action {
            iconName: "edit"
            text: "Action text"
            onTriggered: {
                // do stuff
            }
        },
        Kirigami.Action {
            iconName: "edit"
            text: "Action text"
            onTriggered: {
                // do stuff
            }
        }
    ]
  [...]
}

Definition at line 116 of file Page.qml.

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

flickable: Flickable 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 71 of file Page.qml.

alias org::kde::kirigami::Page::leftAction

actions.left: Action 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 1.0 as Kirigami
Kirigami.Page {
    actions.left: Kirigami.Action {
        iconName: "edit"
        onTriggered: {
            // do stuff
        }
    }
}

Definition at line 158 of file Page.qml.

int org::kde::kirigami::Page::leftPadding

leftPadding: int default contents padding at left

Definition at line 40 of file Page.qml.

alias org::kde::kirigami::Page::mainAction

actions.main: Action An optional single action for the action button.

it can be a Kirigami.Action or a QAction

Example usage:

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

Definition at line 137 of file Page.qml.

alias org::kde::kirigami::Page::rightAction

actions.right: Action 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 1.0 as Kirigami
Kirigami.Page {
    actions.right: Kirigami.Action {
        iconName: "edit"
        onTriggered: {
            // do stuff
        }
    }
}

Definition at line 179 of file Page.qml.

int org::kde::kirigami::Page::rightPadding

rightPadding: int default contents padding at right

Definition at line 50 of file Page.qml.

string org::kde::kirigami::Page::title

title: string Title for the page

Definition at line 35 of file Page.qml.

int org::kde::kirigami::Page::topPadding

topPadding: int default contents padding at top

Definition at line 45 of file Page.qml.

Member Function Documentation

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.

---

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

• Page.qml