Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QQuickStackViewAttached Class Reference

#include <qquickstackview_p.h>

+ Inheritance diagram for QQuickStackViewAttached:
+ Collaboration diagram for QQuickStackViewAttached:

Signals

void indexChanged ()
 
void viewChanged ()
 
void statusChanged ()
 
void activated ()
 
void activating ()
 
void deactivated ()
 
void deactivating ()
 
void removed ()
 
void visibleChanged ()
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QQuickStackViewAttached (QObject *parent=nullptr)
 
 ~QQuickStackViewAttached ()
 
int index () const
 \qmlattachedproperty int QtQuick.Controls::StackView::index \readonly
 
QQuickStackViewview () const
 \qmlattachedproperty StackView QtQuick.Controls::StackView::view \readonly
 
QQuickStackView::Status status () const
 \qmlattachedproperty enumeration QtQuick.Controls::StackView::status \readonly
 
bool isVisible () const
 
void setVisible (bool visible)
 
void resetVisible ()
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Properties

int index
 
QQuickStackViewview
 
QQuickStackView::Status status
 
bool visible
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

Definition at line 209 of file qquickstackview_p.h.

Constructor & Destructor Documentation

◆ QQuickStackViewAttached()

QQuickStackViewAttached::QQuickStackViewAttached ( QObject * parent = nullptr)
explicit

Definition at line 1689 of file qquickstackview.cpp.

References QObject::connect(), d, QQuickItemPrivate::get(), item, QObject::parent(), QQuickItemPrivate::Parent, QGraphicsItem::parentItem(), qmlWarning(), qobject_cast< QQuickItem * >(), QQuickItem::visibleChanged(), and visibleChanged().

+ Here is the call graph for this function:

◆ ~QQuickStackViewAttached()

QQuickStackViewAttached::~QQuickStackViewAttached ( )

Definition at line 1703 of file qquickstackview.cpp.

References d, QQuickItemPrivate::get(), QObject::parent(), QQuickItemPrivate::Parent, and qobject_cast< QQuickItem * >().

+ Here is the call graph for this function:

Member Function Documentation

◆ activated

void QQuickStackViewAttached::activated ( )
signal

Referenced by QQuickStackElement::setStatus().

+ Here is the caller graph for this function:

◆ activating

void QQuickStackViewAttached::activating ( )
signal

Referenced by QQuickStackElement::setStatus().

+ Here is the caller graph for this function:

◆ deactivated

void QQuickStackViewAttached::deactivated ( )
signal

Referenced by QQuickStackElement::setStatus().

+ Here is the caller graph for this function:

◆ deactivating

void QQuickStackViewAttached::deactivating ( )
signal

Referenced by QQuickStackElement::setStatus().

+ Here is the caller graph for this function:

◆ index()

int QQuickStackViewAttached::index ( ) const

\qmlattachedproperty int QtQuick.Controls::StackView::index \readonly

This attached property holds the stack index of the item it's attached to, or -1 if the item is not in a stack.

Definition at line 1718 of file qquickstackview.cpp.

References d.

◆ indexChanged

void QQuickStackViewAttached::indexChanged ( )
signal

Referenced by QQuickStackElement::setIndex().

+ Here is the caller graph for this function:

◆ isVisible()

bool QQuickStackViewAttached::isVisible ( ) const
Since
QtQuick.Controls 2.2 (Qt 5.9) \qmlattachedproperty bool QtQuick.Controls::StackView::visible

This attached property holds the visibility of the item it's attached to. The value follows the value of \l Item::visible.

By default, StackView shows incoming items when the enter transition begins, and hides outgoing items when the exit transition ends. Setting this property explicitly allows the default behavior to be overridden, making it possible to keep items that are below the top-most item visible.

Note
The default transitions of most styles slide outgoing items outside the view, and may also animate their opacity. In order to keep a full stack of items visible, consider customizing the \l transitions so that the items underneath can be seen.
StackView {
id: stackView
property real offset: 10
width: 100; height: 100
initialItem: Component {
id: page
Rectangle {
property real pos: StackView.index * stackView.offset
property real hue: Math.random()
color: Qt.hsla(hue, 0.5, 0.8, 0.6)
border.color: Qt.hsla(hue, 0.5, 0.5, 0.9)
StackView.visible: true
}
}
pushEnter: Transition {
id: pushEnter
ParallelAnimation {
PropertyAction { property: "x"; value: pushEnter.ViewTransition.item.pos }
NumberAnimation { properties: "y"; from: pushEnter.ViewTransition.item.pos + stackView.offset; to: pushEnter.ViewTransition.item.pos; duration: 400; easing.type: Easing.OutCubic }
NumberAnimation { property: "opacity"; from: 0; to: 1; duration: 400; easing.type: Easing.OutCubic }
}
}
popExit: Transition {
id: popExit
ParallelAnimation {
PropertyAction { property: "x"; value: popExit.ViewTransition.item.pos }
NumberAnimation { properties: "y"; from: popExit.ViewTransition.item.pos; to: popExit.ViewTransition.item.pos + stackView.offset; duration: 400; easing.type: Easing.OutCubic }
NumberAnimation { property: "opacity"; from: 1; to: 0; duration: 400; easing.type: Easing.OutCubic }
}
}
pushExit: Transition {
id: pushExit
PropertyAction { property: "x"; value: pushExit.ViewTransition.item.pos }
PropertyAction { property: "y"; value: pushExit.ViewTransition.item.pos }
}
popEnter: Transition {
id: popEnter
PropertyAction { property: "x"; value: popEnter.ViewTransition.item.pos }
PropertyAction { property: "y"; value: popEnter.ViewTransition.item.pos }
}
}

Definition at line 1777 of file qquickstackview.cpp.

References QQuickItem::isVisible(), QObject::parent(), and qobject_cast< QQuickItem * >().

+ Here is the call graph for this function:

◆ removed

void QQuickStackViewAttached::removed ( )
signal

Referenced by QQuickStackElement::~QQuickStackElement().

+ Here is the caller graph for this function:

◆ resetVisible()

void QQuickStackViewAttached::resetVisible ( )

Definition at line 1792 of file qquickstackview.cpp.

References d, QObject::parent(), qobject_cast< QQuickItem * >(), and QQuickItem::setVisible().

+ Here is the call graph for this function:

◆ setVisible()

void QQuickStackViewAttached::setVisible ( bool visible)

Definition at line 1783 of file qquickstackview.cpp.

References d, QObject::parent(), qobject_cast< QQuickItem * >(), QQuickItem::setVisible(), and visible.

+ Here is the call graph for this function:

◆ status()

QQuickStackView::Status QQuickStackViewAttached::status ( ) const

\qmlattachedproperty enumeration QtQuick.Controls::StackView::status \readonly

This attached property holds the stack status of the item it's attached to, or StackView.Inactive if the item is not in a stack.

Available values: \value StackView.Inactive The item is inactive (or not in a stack). \value StackView.Deactivating The item is being deactivated (popped off). \value StackView.Activating The item is being activated (becoming the current item). \value StackView.Active The item is active, that is, the current item.

Definition at line 1750 of file qquickstackview.cpp.

References d, and QQuickStackView::Inactive.

◆ statusChanged

void QQuickStackViewAttached::statusChanged ( )
signal

Referenced by QQuickStackElement::setStatus().

+ Here is the caller graph for this function:

◆ view()

QQuickStackView * QQuickStackViewAttached::view ( ) const

\qmlattachedproperty StackView QtQuick.Controls::StackView::view \readonly

This attached property holds the stack view of the item it's attached to, or null if the item is not in a stack.

Definition at line 1731 of file qquickstackview.cpp.

References d.

◆ viewChanged

void QQuickStackViewAttached::viewChanged ( )
signal

Referenced by QQuickStackElement::setView().

+ Here is the caller graph for this function:

◆ visibleChanged

void QQuickStackViewAttached::visibleChanged ( )
signal

Referenced by QQuickStackViewAttached().

+ Here is the caller graph for this function:

Property Documentation

◆ index

int QQuickStackViewAttached::index
read

Definition at line 212 of file qquickstackview_p.h.

◆ status

QQuickStackView::Status QQuickStackViewAttached::status
read

Definition at line 214 of file qquickstackview_p.h.

◆ view

QQuickStackView * QQuickStackViewAttached::view
read

Definition at line 213 of file qquickstackview_p.h.

◆ visible

bool QQuickStackViewAttached::visible
readwrite

Definition at line 216 of file qquickstackview_p.h.

Referenced by setVisible().


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