Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
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< QQmlEngineDebugEngineReferenceengines () const
QQmlEngineDebugContextReference rootContext () const
QQmlEngineDebugObjectReference object () const
QList< QQmlEngineDebugObjectReferenceobjects () 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)
QQmlDebugConnectionconnection () 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< 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 isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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.

Protected Member Functions

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

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< QObjectDatad_ptr
Properties inherited from QObject
QString objectName
 the name of this object

Detailed Description

Definition at line 71 of file qqmlenginedebugclient_p.h.

Constructor & Destructor Documentation

◆ QQmlEngineDebugClient()

QQmlEngineDebugClient::QQmlEngineDebugClient ( QQmlDebugConnection * conn)
explicit

Definition at line 49 of file qqmlenginedebugclient.cpp.

Member Function Documentation

◆ addWatch() [1/5]

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

Definition at line 76 of file qqmlenginedebugclient.cpp.

◆ addWatch() [2/5]

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

Definition at line 115 of file qqmlenginedebugclient.cpp.

◆ addWatch() [3/5]

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

Definition at line 100 of file qqmlenginedebugclient.cpp.

◆ addWatch() [4/5]

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

Definition at line 84 of file qqmlenginedebugclient.cpp.

◆ addWatch() [5/5]

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

Definition at line 60 of file qqmlenginedebugclient.cpp.

◆ decode() [1/3]

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

Definition at line 389 of file qqmlenginedebugclient.cpp.

◆ decode() [2/3]

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

Definition at line 438 of file qqmlenginedebugclient.cpp.

◆ decode() [3/3]

◆ engines()

QList< QQmlEngineDebugEngineReference > QQmlEngineDebugClient::engines ( ) const

Definition at line 402 of file qqmlenginedebugclient.cpp.

◆ getId()

qint32 QQmlEngineDebugClient::getId ( )

Definition at line 538 of file qqmlenginedebugclient.cpp.

◆ messageReceived()

void QQmlEngineDebugClient::messageReceived ( const QByteArray & data)
overrideprotectedvirtual

Reimplemented from QQmlDebugClient.

Definition at line 463 of file qqmlenginedebugclient.cpp.

◆ newObject

void QQmlEngineDebugClient::newObject ( qint32 objectId)
signal

◆ object()

QQmlEngineDebugObjectReference QQmlEngineDebugClient::object ( ) const

Definition at line 414 of file qqmlenginedebugclient.cpp.

◆ objects()

QList< QQmlEngineDebugObjectReference > QQmlEngineDebugClient::objects ( ) const

Definition at line 420 of file qqmlenginedebugclient.cpp.

◆ queryAvailableEngines()

qint32 QQmlEngineDebugClient::queryAvailableEngines ( bool * success)

Definition at line 134 of file qqmlenginedebugclient.cpp.

◆ queryExpressionResult()

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

Definition at line 237 of file qqmlenginedebugclient.cpp.

◆ queryExpressionResultBC()

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

Definition at line 255 of file qqmlenginedebugclient.cpp.

◆ queryObject()

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

Definition at line 167 of file qqmlenginedebugclient.cpp.

◆ queryObjectRecursive()

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

Definition at line 202 of file qqmlenginedebugclient.cpp.

◆ queryObjectsForLocation()

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

Definition at line 184 of file qqmlenginedebugclient.cpp.

◆ queryObjectsForLocationRecursive()

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

Definition at line 219 of file qqmlenginedebugclient.cpp.

◆ queryRootContexts()

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

Definition at line 150 of file qqmlenginedebugclient.cpp.

◆ removeWatch()

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

Definition at line 123 of file qqmlenginedebugclient.cpp.

◆ resetBindingForObject()

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

Definition at line 293 of file qqmlenginedebugclient.cpp.

◆ result

void QQmlEngineDebugClient::result ( )
signal

◆ resultExpr()

QVariant QQmlEngineDebugClient::resultExpr ( ) const

Definition at line 426 of file qqmlenginedebugclient.cpp.

◆ rootContext()

QQmlEngineDebugContextReference QQmlEngineDebugClient::rootContext ( ) const

Definition at line 408 of file qqmlenginedebugclient.cpp.

◆ setBindingForObject()

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

Definition at line 272 of file qqmlenginedebugclient.cpp.

◆ setMethodBody()

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

Definition at line 310 of file qqmlenginedebugclient.cpp.

◆ valid()

bool QQmlEngineDebugClient::valid ( ) const

Definition at line 432 of file qqmlenginedebugclient.cpp.

◆ valueChanged

void QQmlEngineDebugClient::valueChanged ( QByteArray ,
QVariant  )
signal

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