PageStackAttached Class Reference

#include <pagestackattached.h>

Inheritance diagram for PageStackAttached:

Properties
QQuickItem *	pageStack
Properties inherited from QObject
	objectName

Signals
void	pageStackChanged ()

Public Member Functions
	PageStackAttached (QObject *parent)
Q_INVOKABLE void	clear ()
QQuickItem *	pageStack () const
Q_INVOKABLE void	pop (const QVariant &page=QVariant())
Q_INVOKABLE void	push (const QVariant &page, const QVariantMap &properties=QVariantMap())
Q_INVOKABLE void	replace (const QVariant &page, const QVariantMap &properties=QVariantMap())
void	setPageStack (QQuickItem *pageStack)
Public Member Functions inherited from QQuickAttachedPropertyPropagator
	QQuickAttachedPropertyPropagator (QObject *parent)
QList< QQuickAttachedPropertyPropagator * >	attachedChildren () const const
QQuickAttachedPropertyPropagator *	attachedParent () const const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Static Public Member Functions
static PageStackAttached *	qmlAttachedProperties (QObject *object)
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)

Protected Member Functions
void	attachedParentChange (QQuickAttachedPropertyPropagator *newParent, QQuickAttachedPropertyPropagator *oldParent) override
bool	hasStackCapabilities (QQuickItem *candidate)
void	propagatePageStack (QQuickItem *pageStack)
Protected Member Functions inherited from QQuickAttachedPropertyPropagator
void	initialize ()
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

This attached property makes possible to access from anywhere the page stack this page was pushed into.

It can be an instance of org::kde::kirigami::PageRow or a StackView from QtQuickControls

Kirigami.Page { id: root

Button { text: "Push Page" onClicked: Kirigami.PageStack.push(Qt.resolvedurl("AnotherPage")); } }

Since

6.10

Definition at line 28 of file pagestackattached.h.

Property Documentation

pageStack

QQuickItem * PageStackAttached::pageStack

readwrite

Definition at line 35 of file pagestackattached.h.

Constructor & Destructor Documentation

PageStackAttached()

PageStackAttached::PageStackAttached ( QObject * parent )

explicit

Definition at line 46 of file pagestackattached.cpp.

Member Function Documentation

attachedParentChange()

void PageStackAttached::attachedParentChange ( QQuickAttachedPropertyPropagator * newParent, QQuickAttachedPropertyPropagator * oldParent )

overrideprotectedvirtual

Reimplemented from QQuickAttachedPropertyPropagator.

Definition at line 230 of file pagestackattached.cpp.

clear()

void PageStackAttached::clear

(

)

Definition at line 153 of file pagestackattached.cpp.

hasStackCapabilities()

bool PageStackAttached::hasStackCapabilities ( QQuickItem * candidate )

protected

Definition at line 165 of file pagestackattached.cpp.

pageStack()

QQuickItem * PageStackAttached::pageStack

(

)

const

\qmlattachedproperty PageRow PageStack::pageStack

This property holds the pageStack where this page was pushed. It will point to the proper instance in the parent hyerarchy and normally is not necessary to explicitly write it. Write on this property only if it's desired this attached property and those of all the children to point to a different PageRow or StackView

Definition at line 72 of file pagestackattached.cpp.

pop()

void PageStackAttached::pop

(

const QVariant &

page = QVariant()

)

Definition at line 135 of file pagestackattached.cpp.

propagatePageStack()

void PageStackAttached::propagatePageStack ( QQuickItem * pageStack )

protected

Definition at line 91 of file pagestackattached.cpp.

push()

void PageStackAttached::push	(	const QVariant &	page,
		const QVariantMap &	properties = QVariantMap() )

Definition at line 111 of file pagestackattached.cpp.

qmlAttachedProperties()

PageStackAttached * PageStackAttached::qmlAttachedProperties ( QObject * object )

static

Definition at line 225 of file pagestackattached.cpp.

replace()

void PageStackAttached::replace	(	const QVariant &	page,
		const QVariantMap &	properties = QVariantMap() )

Definition at line 123 of file pagestackattached.cpp.

setPageStack()

void PageStackAttached::setPageStack

(

QQuickItem *

pageStack

)

Definition at line 77 of file pagestackattached.cpp.

---

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

• pagestackattached.h
• pagestackattached.cpp