org::kde::kirigami::Page
Search for usage in LXR
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.
◆ actions
org::kde::kirigami::private::PageActionPropertyGroup Page::actions |
|
read |
This property holds the actions group.
import org.kde.kirigami 2.4 as Kirigami
Kirigami.Page {
main: Kirigami.Action {...}
left: Kirigami.Action {...}
right: Kirigami.Action {...}
Kirigami.Action {...},
Kirigami.Action {...}
]
}
}
Definition at line 174 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 {
[...]
Kirigami.Action {
icon.name: "edit"
text: "Action text"
onTriggered: {
}
},
Kirigami.Action {
icon.name: "edit"
text: "Action text"
onTriggered: {
}
}
]
[...]
}
- Warning
- This will likely be removed someday.
Definition at line 93 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
- ScrollablePage
Definition at line 46 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
Definition at line 240 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 250 of file Page.qml.
◆ isCurrentPage
bool org::kde::kirigami::Page::isCurrentPage |
|
read |
This property tells 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
- 2.1
Definition at line 193 of file Page.qml.
◆ leftAction
An optional extra action at the left of the main action button.
Example usage:
import org.kde.kirigami 2.4 as Kirigami
Kirigami.Page {
icon.name: "edit"
onTriggered: {
}
}
}
- Warning
- This will likely be removed someday.
Definition at line 134 of file Page.qml.
◆ mainAction
An optional single action for the action button.
Example usage:
import org.kde.kirigami 2.4 as Kirigami
Kirigami.Page {
icon.name: "edit"
onTriggered: {
}
}
}
- Warning
- This will likely be removed someday.
Definition at line 113 of file Page.qml.
◆ needsAttention
bool org::kde::kirigami::Page::needsAttention |
|
read |
Whether this page needs user attention.
Definition at line 213 of file Page.qml.
◆ overlay
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 204 of file Page.qml.
◆ progress
Progress of a task this page is doing.
Set to undefined to indicate that there are no ongoing tasks.
default: undefined
Definition at line 223 of file Page.qml.
◆ rightAction
An optional extra action at the right of the main action button.
Example usage:
import org.kde.kirigami 2.4 as Kirigami
Kirigami.Page {
icon.name: "edit"
onTriggered: {
}
}
}
- Warning
- This will likely be removed someday.
Definition at line 154 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 231 of file Page.qml.
◆ 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)
alias actions
This property holds the actions group.
alias contextualActions
Defines the contextual actions for the page: an easy way to assign actions in the right sliding panel...
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Fri Jan 27 2023 07:55:00 by
doxygen 1.8.17 written
by
Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.