org::kde::kirigami::PagePoolAction

Search for usage in LXR

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

Properties

QtObject _private
 
var initialProperties
 
string page
 
QQC2 Page
 
Kirigami PagePool
 
Item pageStack
 
bool useLayers
 
- Properties inherited from org::kde::kirigami::Action
QQC2 Action
 
list< QtObject > children
 
Component displayComponent
 
int displayHint
 
bool expandible
 
alias iconName
 
alias iconSource
 
bool separator
 
string tooltip
 
bool visible
 
var visibleChildren
 

Public Member Functions

void layerContainsPage ()
 
void pageItem ()
 
void stackContainsPage ()
 
- Public Member Functions inherited from org::kde::kirigami::Action
void displayHintSet (hint)
 

Additional Inherited Members

- Public Types inherited from org::kde::kirigami::Action
enum  DisplayHint {
  DisplayHint::NoPreference = 0, DisplayHint::IconOnly = 1, DisplayHint::KeepVisible = 2, DisplayHint::AlwaysHide = 4,
  DisplayHint::HideChildIndicator = 8
}
 

Detailed Description

An action used to load Pages coming from a common PagePool in a PageRow or QtQuickControls2 StackView.

See also
PagePool

Definition at line 17 of file PagePoolAction.qml.

Property Documentation

◆ initialProperties

QVariantMap org::kde::kirigami::PagePoolAction::initialProperties
read

This property holds a function that generate the property values for the created page when it is pushed onto the Kirigami.PagePool.

Example usage:

Kirigami.PagePoolAction {
text: i18n("Security")
icon.name: "security-low"
page: Qt.resolvedUrl("Security.qml")
return {
room: root.room
}
}
}

Definition at line 66 of file PagePoolAction.qml.

◆ page

string org::kde::kirigami::PagePoolAction::page
read

This property holds the url or filename of the page that this action will load.

Definition at line 23 of file PagePoolAction.qml.

◆ Page

QQC2 org::kde::kirigami::PagePoolAction::Page
read

This property sets the page in the pageStack after which new pages will be pushed.

All pages present after the given basePage will be removed from the pageStack

Definition at line 46 of file PagePoolAction.qml.

◆ PagePool

Kirigami org::kde::kirigami::PagePoolAction::PagePool
read

This property holds the PagePool object used by this PagePoolAction.

PagePool will make sure only one instance of the page identified by the page url will be created and reused. PagePool's lastLoaderUrl property will be used to control the mutual exclusivity of the checked state of the PagePoolAction instances sharing the same PagePool.

Definition at line 31 of file PagePoolAction.qml.

◆ pageStack

Item org::kde::kirigami::PagePoolAction::pageStack
read

The pageStack property accepts either a Kirigami.PageRow or a QtQuickControls2 StackView.

The component that will instantiate the pages, which has to work with a stack logic. Kirigami.PageRow is recommended, but will work with QtQuicControls2 StackView as well.

default: bound to ApplicationWindow's global pageStack, which is a PageRow by default

Definition at line 39 of file PagePoolAction.qml.

◆ useLayers

bool org::kde::kirigami::PagePoolAction::useLayers
read

This property sets whether PagePoolAction will use the layers property implemented by the pageStack.

This is intended for use with PageRow layers to allow PagePoolActions to push context-specific pages onto the layers stack.

default: false

Since
5.70
org.kde.kirigami 2.12

Definition at line 79 of file PagePoolAction.qml.

Member Function Documentation

◆ layerContainsPage()

void org::kde::kirigami::PagePoolAction::layerContainsPage ( )
Returns
true if the page has been loaded and placed on pageStack.layers and useLayers is true, otherwise returns null.

◆ pageItem()

void org::kde::kirigami::PagePoolAction::pageItem ( )
Returns
the page item held in the PagePool or null if it has not been loaded yet.

◆ stackContainsPage()

void org::kde::kirigami::PagePoolAction::stackContainsPage ( )
Returns
true if the page has been loaded and placed on the pageStack, otherwise returns null.

The documentation for this class was generated from the following file:
string page
This property holds the url or filename of the page that this action will load.
QString i18n(const char *text, const TYPE &arg...)
var initialProperties
This property holds a function that generate the property values for the created page when it is push...
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 6 2023 04:13:18 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.