PageRouterAttached

Search for usage in LXR

PageRouterAttached Class Reference

#include <pagerouter.h>

Inheritance diagram for PageRouterAttached:

Properties

QVariant data
 
bool isCurrent
 
PreloadRouteGroup preload
 
PageRouter router
 
QJSValue watchedRoute
 
bool watchedRouteActive
 
- Properties inherited from QObject
 objectName
 

Signals

void dataChanged ()
 
void isCurrentChanged ()
 
void navigationChanged ()
 
void routerChanged ()
 
void watchedRouteChanged ()
 

Public Member Functions

Q_INVOKABLE void bringToView (QJSValue route)
 
QVariant data () const
 
bool isCurrent () const
 
Q_INVOKABLE void navigateToRoute (QJSValue route)
 
Q_INVOKABLE void popFromHere ()
 
Q_INVOKABLE void popRoute ()
 
PreloadRouteGrouppreload () const
 
Q_INVOKABLE void pushFromHere (QJSValue route)
 
Q_INVOKABLE void pushRoute (QJSValue route)
 
Q_INVOKABLE void replaceFromHere (QJSValue route)
 
Q_INVOKABLE bool routeActive (QJSValue route)
 
PageRouterrouter () const
 
void setRouter (PageRouter *router)
 
void setWatchedRoute (QJSValue route)
 
QJSValue watchedRoute ()
 
bool watchedRouteActive ()
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Attached object allowing children of a PageRouter to access its functions without requiring the children to have the parent PageRouter's id.

See also
PageRouter

Definition at line 690 of file pagerouter.h.

Property Documentation

QVariant PageRouterAttached::data
read

The data for the page this item belongs to.

Accessing this property outside of a PageRouter will result in undefined behavior.

Definition at line 699 of file pagerouter.h.

bool PageRouterAttached::isCurrent
read

Whether the page this item belongs to is the current index of the ColumnView.

Accessing this property outside of a PageRouter will result in undefined behaviour.

Definition at line 705 of file pagerouter.h.

PreloadRouteGroup PageRouterAttached::preload
read

Route preloading settings.

Definition at line 717 of file pagerouter.h.

QJSValue PageRouterAttached::watchedRoute
readwrite

Which route this PageRouterAttached should watch for.

import QtQuick 2.12
import QtQuick.Controls 2.12 as QQC2
import org.kde.kirigami 2.12 as Kirigami
Kirigami.ApplicationWindow {
id: applicaionWindow
Kirigami.PageRouter {
initialRoute: "one"
pageStack: applicaionWindow.pageStack.columnView
Kirigami.PageRoute {
name: "one"
Kirigami.Page {
Column {
Kirigami.Heading {
Kirigami.PageRouter.watchedRoute: ["one", "two"]
text: Kirigami.PageRouter.watchedRouteActive ? "/one/two is active" : "only /one is active"
}
QQC2.Button {
text: "Push Two"
onClicked: Kirigami.PageRouter.navigateToRoute(["one", "two"])
}
}
}
}
Kirigami.PageRoute {
name: "two"
Kirigami.Page {
// Page contents...
}
}
}
}

Definition at line 712 of file pagerouter.h.

bool PageRouterAttached::watchedRouteActive
read

Whether the watchedRoute is currently active.

Definition at line 722 of file pagerouter.h.

Member Function Documentation

void PageRouterAttached::navigateToRoute ( QJSValue  route)
See also
PageRouter::navigateToRoute()

Definition at line 576 of file pagerouter.cpp.

void PageRouterAttached::popFromHere ( )

Pop routes after this route on the stack.

Pop the routes after the route this is invoked on with the provided route.

For example, if you invoke this method on the second route in the PageRouter's stack, routes after the second route will be removed from the stack.

Definition at line 685 of file pagerouter.cpp.

void PageRouterAttached::popRoute ( )
See also
PageRouter::popRoute()

Definition at line 606 of file pagerouter.cpp.

void PageRouterAttached::pushFromHere ( QJSValue  route)

Push a route from this route on the stack.

Replace the routes after the route this is invoked on with the provided route.

For example, if you invoke this method on the second route in the PageRouter's stack, routes after the second route will be replaced with the provided routes.

Definition at line 667 of file pagerouter.cpp.

void PageRouterAttached::pushRoute ( QJSValue  route)
See also
PageRouter::pushRoute()

Definition at line 596 of file pagerouter.cpp.

void PageRouterAttached::replaceFromHere ( QJSValue  route)

Replaces this route with the given routes on the stack.

Behaves like pushFromHere, except the current route is also popped.

Definition at line 676 of file pagerouter.cpp.

bool PageRouterAttached::routeActive ( QJSValue  route)
See also
PageRouter::routeActive()

Definition at line 586 of file pagerouter.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Mon Dec 6 2021 22:34:23 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.