QQmlEngineDebugClient Class Reference

#include <qqmlenginedebugclient_p.h>

Inheritance diagram for QQmlEngineDebugClient:

Collaboration diagram for QQmlEngineDebugClient:

Signals
void	newObject (qint32 objectId)
void	valueChanged (QByteArray, QVariant)
void	result ()
Signals inherited from QQmlDebugClient
void	stateChanged (State state)
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
	QQmlEngineDebugClient (QQmlDebugConnection *conn)
qint32	addWatch (const QQmlEngineDebugPropertyReference &, bool *success)
qint32	addWatch (const QQmlEngineDebugContextReference &, const QString &, bool *success)
qint32	addWatch (const QQmlEngineDebugObjectReference &, const QString &, bool *success)
qint32	addWatch (const QQmlEngineDebugObjectReference &, bool *success)
qint32	addWatch (const QQmlEngineDebugFileReference &, bool *success)
void	removeWatch (qint32 watch, bool *success)
qint32	queryAvailableEngines (bool *success)
qint32	queryRootContexts (const QQmlEngineDebugEngineReference &, bool *success)
qint32	queryObject (const QQmlEngineDebugObjectReference &, bool *success)
qint32	queryObjectsForLocation (const QString &file, qint32 lineNumber, qint32 columnNumber, bool *success)
qint32	queryObjectRecursive (const QQmlEngineDebugObjectReference &, bool *success)
qint32	queryObjectsForLocationRecursive (const QString &file, qint32 lineNumber, qint32 columnNumber, bool *success)
qint32	queryExpressionResult (qint32 objectDebugId, const QString &expr, bool *success)
qint32	queryExpressionResultBC (qint32 objectDebugId, const QString &expr, bool *success)
qint32	setBindingForObject (qint32 objectDebugId, const QString &propertyName, const QVariant &bindingExpression, bool isLiteralValue, const QString &source, qint32 line, bool *success)
qint32	resetBindingForObject (qint32 objectDebugId, const QString &propertyName, bool *success)
qint32	setMethodBody (qint32 objectDebugId, const QString &methodName, const QString &methodBody, bool *success)
qint32	getId ()
void	decode (QPacket &ds, QQmlEngineDebugContextReference &)
void	decode (QPacket &ds, QQmlEngineDebugObjectReference &, bool simple)
void	decode (QPacket &ds, QList< QQmlEngineDebugObjectReference > &o, bool simple)
QList< QQmlEngineDebugEngineReference >	engines () const
QQmlEngineDebugContextReference	rootContext () const
QQmlEngineDebugObjectReference	object () const
QList< QQmlEngineDebugObjectReference >	objects () const
QVariant	resultExpr () const
bool	valid () const
Public Member Functions inherited from QQmlDebugClient
	QQmlDebugClient (const QString &name, QQmlDebugConnection *parent)
	~QQmlDebugClient ()
QString	name () const
float	serviceVersion () const
State	state () const
void	sendMessage (const QByteArray &message)
QQmlDebugConnection *	connection () const
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.

Protected Member Functions
void	messageReceived (const QByteArray &) override
Protected Member Functions inherited from QQmlDebugClient
	QQmlDebugClient (QQmlDebugClientPrivate &dd)
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)

Additional Inherited Members
Public Types inherited from QQmlDebugClient
enum	State { NotConnected , Unavailable , Enabled }
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 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 70 of file qqmlenginedebugclient_p.h.

Constructor & Destructor Documentation

QQmlEngineDebugClient()

QQmlEngineDebugClient::QQmlEngineDebugClient ( QQmlDebugConnection *  conn )

explicit

Definition at line 48 of file qqmlenginedebugclient.cpp.

Member Function Documentation

addWatch() [1/5]

qint32 QQmlEngineDebugClient::addWatch	(	const QQmlEngineDebugContextReference &	,
		const QString &	,
		bool *	success
	)

Definition at line 75 of file qqmlenginedebugclient.cpp.

References qWarning.

addWatch() [2/5]

qint32 QQmlEngineDebugClient::addWatch	(	const QQmlEngineDebugFileReference &	,
		bool *	success
	)

Definition at line 114 of file qqmlenginedebugclient.cpp.

References qWarning.

addWatch() [3/5]

qint32 QQmlEngineDebugClient::addWatch	(	const QQmlEngineDebugObjectReference &	object,
		bool *	success
	)

Definition at line 99 of file qqmlenginedebugclient.cpp.

References QQmlDebugClient::connection(), QPacket::data(), QQmlDebugClient::Enabled, getId(), QQmlDebugClient::sendMessage(), and QQmlDebugClient::state().

Here is the call graph for this function:

addWatch() [4/5]

qint32 QQmlEngineDebugClient::addWatch	(	const QQmlEngineDebugObjectReference &	object,
		const QString &	expr,
		bool *	success
	)

Definition at line 83 of file qqmlenginedebugclient.cpp.

References QQmlDebugClient::connection(), QPacket::data(), QQmlDebugClient::Enabled, getId(), QQmlDebugClient::sendMessage(), and QQmlDebugClient::state().

Here is the call graph for this function:

addWatch() [5/5]

qint32 QQmlEngineDebugClient::addWatch	(	const QQmlEngineDebugPropertyReference &	property,
		bool *	success
	)

Definition at line 59 of file qqmlenginedebugclient.cpp.

References QQmlDebugClient::connection(), QPacket::data(), QQmlDebugClient::Enabled, getId(), QQmlDebugClient::sendMessage(), and QQmlDebugClient::state().

Here is the call graph for this function:

decode() [1/3]

void QQmlEngineDebugClient::decode	(	QPacket &	ds,
		QList< QQmlEngineDebugObjectReference > &	o,
		bool	simple
	)

Definition at line 388 of file qqmlenginedebugclient.cpp.

References decode, i, and o.

decode() [2/3]

void QQmlEngineDebugClient::decode	(	QPacket &	ds,
		QQmlEngineDebugContextReference &	c
	)

Definition at line 437 of file qqmlenginedebugclient.cpp.

References decode.

decode() [3/3]

void QQmlEngineDebugClient::decode	(	QPacket &	ds,
		QQmlEngineDebugObjectReference &	o,
		bool	simple
	)

Definition at line 326 of file qqmlenginedebugclient.cpp.

References QQmlObjectProperty::Basic, QQmlEngineDebugPropertyReference::binding, decode, QVariant::fromValue(), QQmlEngineDebugPropertyReference::hasNotifySignal, QQmlObjectProperty::List, QQmlEngineDebugPropertyReference::name, o, QQmlObjectProperty::Object, QQmlEngineDebugPropertyReference::objectDebugId, QQmlObjectProperty::SignalProperty, QQmlObjectProperty::Unknown, QVariant::value(), QQmlEngineDebugPropertyReference::value, and QQmlEngineDebugPropertyReference::valueTypeName.

Here is the call graph for this function:

engines()

QList< QQmlEngineDebugEngineReference > QQmlEngineDebugClient::engines

(

)

const

Definition at line 401 of file qqmlenginedebugclient.cpp.

References d.

Referenced by queryExpressionResult().

Here is the caller graph for this function:

getId()

qint32 QQmlEngineDebugClient::getId

(

)

Definition at line 537 of file qqmlenginedebugclient.cpp.

References d.

Referenced by addWatch(), addWatch(), addWatch(), queryAvailableEngines(), queryExpressionResult(), queryExpressionResultBC(), queryObject(), queryObjectRecursive(), queryObjectsForLocation(), queryObjectsForLocationRecursive(), queryRootContexts(), resetBindingForObject(), setBindingForObject(), and setMethodBody().

Here is the caller graph for this function:

messageReceived()

void QQmlEngineDebugClient::messageReceived ( const QByteArray &  data )

overrideprotectedvirtual

Reimplemented from QQmlDebugClient.

Definition at line 462 of file qqmlenginedebugclient.cpp.

References QDataStream::atEnd(), QQmlDebugClient::connection(), d, QQmlEngineDebugEngineReference::debugId, decode, emit, QQmlDebugClient::name(), QQmlEngineDebugEngineReference::name, newObject(), result(), and valueChanged().

Here is the call graph for this function:

newObject

void QQmlEngineDebugClient::newObject ( qint32  objectId )

signal

Referenced by messageReceived().

Here is the caller graph for this function:

object()

QQmlEngineDebugObjectReference QQmlEngineDebugClient::object

(

)

const

Definition at line 413 of file qqmlenginedebugclient.cpp.

References d.

objects()

QList< QQmlEngineDebugObjectReference > QQmlEngineDebugClient::objects

(

)

const

Definition at line 419 of file qqmlenginedebugclient.cpp.

References d.

queryAvailableEngines()

qint32 QQmlEngineDebugClient::queryAvailableEngines

(

bool *

success

)

Definition at line 133 of file qqmlenginedebugclient.cpp.

References QQmlDebugClient::connection(), d, QPacket::data(), QQmlDebugClient::Enabled, getId(), QQmlDebugClient::sendMessage(), and QQmlDebugClient::state().

Here is the call graph for this function:

queryExpressionResult()

qint32 QQmlEngineDebugClient::queryExpressionResult	(	qint32	objectDebugId,
		const QString &	expr,
		bool *	success
	)

Definition at line 236 of file qqmlenginedebugclient.cpp.

References QQmlDebugClient::connection(), d, QPacket::data(), QQmlDebugClient::Enabled, engines(), getId(), QQmlDebugClient::sendMessage(), and QQmlDebugClient::state().

Here is the call graph for this function:

queryExpressionResultBC()

qint32 QQmlEngineDebugClient::queryExpressionResultBC	(	qint32	objectDebugId,
		const QString &	expr,
		bool *	success
	)

Definition at line 254 of file qqmlenginedebugclient.cpp.

References QQmlDebugClient::connection(), d, QPacket::data(), QQmlDebugClient::Enabled, getId(), QQmlDebugClient::sendMessage(), and QQmlDebugClient::state().

Here is the call graph for this function:

queryObject()

qint32 QQmlEngineDebugClient::queryObject	(	const QQmlEngineDebugObjectReference &	object,
		bool *	success
	)

Definition at line 166 of file qqmlenginedebugclient.cpp.

References QQmlDebugClient::connection(), d, QPacket::data(), QQmlDebugClient::Enabled, getId(), QQmlDebugClient::sendMessage(), and QQmlDebugClient::state().

Here is the call graph for this function:

queryObjectRecursive()

qint32 QQmlEngineDebugClient::queryObjectRecursive	(	const QQmlEngineDebugObjectReference &	object,
		bool *	success
	)

Definition at line 201 of file qqmlenginedebugclient.cpp.

References QQmlDebugClient::connection(), d, QPacket::data(), QQmlDebugClient::Enabled, getId(), QQmlDebugClient::sendMessage(), and QQmlDebugClient::state().

Here is the call graph for this function:

queryObjectsForLocation()

qint32 QQmlEngineDebugClient::queryObjectsForLocation	(	const QString &	file,
		qint32	lineNumber,
		qint32	columnNumber,
		bool *	success
	)

Definition at line 183 of file qqmlenginedebugclient.cpp.

References QQmlDebugClient::connection(), d, QPacket::data(), QQmlDebugClient::Enabled, file, getId(), QQmlDebugClient::sendMessage(), and QQmlDebugClient::state().

Here is the call graph for this function:

queryObjectsForLocationRecursive()

qint32 QQmlEngineDebugClient::queryObjectsForLocationRecursive	(	const QString &	file,
		qint32	lineNumber,
		qint32	columnNumber,
		bool *	success
	)

Definition at line 218 of file qqmlenginedebugclient.cpp.

References QQmlDebugClient::connection(), d, QPacket::data(), QQmlDebugClient::Enabled, file, getId(), QQmlDebugClient::sendMessage(), and QQmlDebugClient::state().

Here is the call graph for this function:

queryRootContexts()

qint32 QQmlEngineDebugClient::queryRootContexts	(	const QQmlEngineDebugEngineReference &	engine,
		bool *	success
	)

Definition at line 149 of file qqmlenginedebugclient.cpp.

References QQmlDebugClient::connection(), d, QPacket::data(), QQmlDebugClient::Enabled, engine, getId(), QQmlDebugClient::sendMessage(), and QQmlDebugClient::state().

Here is the call graph for this function:

removeWatch()

void QQmlEngineDebugClient::removeWatch	(	qint32	watch,
		bool *	success
	)

Definition at line 122 of file qqmlenginedebugclient.cpp.

References QQmlDebugClient::connection(), QPacket::data(), QQmlDebugClient::Enabled, QQmlDebugClient::sendMessage(), and QQmlDebugClient::state().

Here is the call graph for this function:

resetBindingForObject()

qint32 QQmlEngineDebugClient::resetBindingForObject	(	qint32	objectDebugId,
		const QString &	propertyName,
		bool *	success
	)

Definition at line 292 of file qqmlenginedebugclient.cpp.

References QQmlDebugClient::connection(), QPacket::data(), QQmlDebugClient::Enabled, getId(), QQmlDebugClient::sendMessage(), and QQmlDebugClient::state().

Here is the call graph for this function:

result

void QQmlEngineDebugClient::result ( )

signal

Referenced by messageReceived().

Here is the caller graph for this function:

resultExpr()

QVariant QQmlEngineDebugClient::resultExpr

(

)

const

Definition at line 425 of file qqmlenginedebugclient.cpp.

References d.

rootContext()

QQmlEngineDebugContextReference QQmlEngineDebugClient::rootContext

(

)

const

Definition at line 407 of file qqmlenginedebugclient.cpp.

References d.

setBindingForObject()

qint32 QQmlEngineDebugClient::setBindingForObject	(	qint32	objectDebugId,
		const QString &	propertyName,
		const QVariant &	bindingExpression,
		bool	isLiteralValue,
		const QString &	source,
		qint32	line,
		bool *	success
	)

Definition at line 271 of file qqmlenginedebugclient.cpp.

References QQmlDebugClient::connection(), QPacket::data(), QQmlDebugClient::Enabled, getId(), line, QQmlDebugClient::sendMessage(), and QQmlDebugClient::state().

Here is the call graph for this function:

setMethodBody()

qint32 QQmlEngineDebugClient::setMethodBody	(	qint32	objectDebugId,
		const QString &	methodName,
		const QString &	methodBody,
		bool *	success
	)

Definition at line 309 of file qqmlenginedebugclient.cpp.

References QQmlDebugClient::connection(), QPacket::data(), QQmlDebugClient::Enabled, getId(), methodName(), QQmlDebugClient::sendMessage(), and QQmlDebugClient::state().

Here is the call graph for this function:

valid()

bool QQmlEngineDebugClient::valid

(

)

const

Definition at line 431 of file qqmlenginedebugclient.cpp.

References d.

valueChanged

void QQmlEngineDebugClient::valueChanged ( QByteArray  , QVariant    )

signal

Referenced by messageReceived().

Here is the caller graph for this function:

---

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

• qtdeclarative/src/qmldebug/qqmlenginedebugclient_p.h
• qtdeclarative/src/qmldebug/qqmlenginedebugclient.cpp