QQuickDeliveryAgent Class Reference

#include <qquickdeliveryagent_p.h>

Inheritance diagram for QQuickDeliveryAgent:

Collaboration diagram for QQuickDeliveryAgent:

Classes
struct	Transform

Public Member Functions
	QQuickDeliveryAgent (QQuickItem *rootItem)
virtual	~QQuickDeliveryAgent ()
QQuickItem *	rootItem () const
Transform *	sceneTransform () const
void	setSceneTransform (Transform *transform)
bool	event (QEvent *ev) override
	Handle ev on behalf of this delivery agent's window or subscene.
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< QString >	bindableObjectName ()
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).
QThread *	thread () const
	Returns the thread in which the object lives.
void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.
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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
template<typename T >
T	findChild (const QString &aName=QString(), 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 (const QString &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 >
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 QObjectList &	children () 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< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () 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.

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
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.
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
QObject *	sender () 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< QObjectData >	d_ptr
Properties inherited from QObject
QString	objectName
	the name of this object
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 31 of file qquickdeliveryagent_p.h.

Constructor & Destructor Documentation

QQuickDeliveryAgent()

QQuickDeliveryAgent::QQuickDeliveryAgent ( QQuickItem *  rootItem )

explicit

QQuickDeliveryAgent delivers events to a tree of Qt Quick Items, beginning with the given root item, which is usually QQuickWindow::rootItem() but may alternatively be embedded into a Qt Quick 3D scene or something else.

Definition at line 655 of file qquickdeliveryagent.cpp.

~QQuickDeliveryAgent()

QQuickDeliveryAgent::~QQuickDeliveryAgent ( )

virtual

Definition at line 660 of file qquickdeliveryagent.cpp.

Member Function Documentation

event()

bool QQuickDeliveryAgent::event ( QEvent *  ev )

overridevirtual

Handle ev on behalf of this delivery agent's window or subscene.

This is the usual main entry point for every incoming event: QQuickWindow::event() and QQuick3DViewport::forwardEventToSubscenes() both call this function.

Reimplemented from QObject.

Definition at line 712 of file qquickdeliveryagent.cpp.

References Qt::AA_SynthesizeMouseForUnhandledTouchEvents, QEvent::accept(), d, QEvent::DragEnter, QEvent::DragLeave, QEvent::DragMove, QEvent::Drop, QEvent::Enter, QList< T >::first(), QEvent::FocusAboutToChange, QQuickWindowPrivate::get(), QEvent::HoverEnter, QEvent::HoverLeave, QEvent::HoverMove, QEvent::InputMethod, QEvent::InputMethodQuery, QEvent::Leave, QInputEvent::modifiers(), QEvent::MouseButtonDblClick, QEvent::MouseButtonPress, QEvent::MouseButtonRelease, QEvent::MouseMove, QEvent::NativeGesture, QPointerEvent::points(), Q_ASSERT, Q_LIKELY, Q_QUICK_INPUT_PROFILE, qCDebug, qGuiApp, qScopeGuard(), QEventPoint::sceneLastPosition, QSinglePointEvent::scenePosition(), Qt::ScrollUpdate, QCoreApplication::sendEvent(), QPointerEvent::setAccepted(), QEvent::ShortcutOverride, QEvent::TabletMove, QEvent::TabletPress, QEvent::TabletRelease, QCoreApplication::testAttribute(), QInputEvent::timestamp(), QEvent::TouchBegin, QEvent::TouchCancel, QEvent::TouchEnd, QEvent::TouchUpdate, QEvent::type(), and QEvent::Wheel.

Referenced by QQuickWindow::event().

Here is the call graph for this function:

Here is the caller graph for this function:

rootItem()

QQuickItem * QQuickDeliveryAgent::rootItem

(

)

const

Get the QQuickRootItem or subscene root item on behalf of which this delivery agent was constructed to handle events.

Definition at line 672 of file qquickdeliveryagent.cpp.

References d.

Referenced by operator<<().

Here is the caller graph for this function:

sceneTransform()

QQuickDeliveryAgent::Transform * QQuickDeliveryAgent::sceneTransform

(

)

const

Returns the object that was set in setSceneTransform(): a functor that transforms from scene coordinates in the parent scene to scene coordinates within this DA's subscene, or null if none was set.

Definition at line 683 of file qquickdeliveryagent.cpp.

References d.

setSceneTransform()

void QQuickDeliveryAgent::setSceneTransform

(

QQuickDeliveryAgent::Transform *

transform

)

QQuickDeliveryAgent takes ownership of the given transform, which encapsulates the ability to transform parent scene coordinates to rootItem (subscene) coordinates.

Definition at line 694 of file qquickdeliveryagent.cpp.

References d, and qCDebug.

Referenced by ViewportTransformHelper::setOnDeliveryAgent().

Here is the caller graph for this function:

---

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

• qtdeclarative/src/quick/util/qquickdeliveryagent_p.h
• qtdeclarative/src/quick/util/qquickdeliveryagent.cpp