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
QQmlEngineControlClient Class Reference

#include <qqmlenginecontrolclient_p.h>

+ Inheritance diagram for QQmlEngineControlClient:
+ Collaboration diagram for QQmlEngineControlClient:

Signals

void engineAboutToBeAdded (int engineId, const QString &name)
 
void engineAdded (int engineId, const QString &name)
 
void engineAboutToBeRemoved (int engineId, const QString &name)
 
void engineRemoved (int engineId, const QString &name)
 
- 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

 QQmlEngineControlClient (QQmlDebugConnection *connection)
 
void blockEngine (int engineId)
 Block the starting or stopping of the engine with id engineId for now.
 
void releaseEngine (int engineId)
 Release the engine with id engineId.
 
QList< int > blockedEngines () 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 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

 QQmlEngineControlClient (QQmlEngineControlClientPrivate &dd)
 
- 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)
 

Private Member Functions

void messageReceived (const QByteArray &) override
 

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 23 of file qqmlenginecontrolclient_p.h.

Constructor & Destructor Documentation

◆ QQmlEngineControlClient() [1/2]

QT_BEGIN_NAMESPACE QQmlEngineControlClient::QQmlEngineControlClient ( QQmlDebugConnection * connection)

Definition at line 12 of file qqmlenginecontrolclient.cpp.

◆ QQmlEngineControlClient() [2/2]

QQmlEngineControlClient::QQmlEngineControlClient ( QQmlEngineControlClientPrivate & dd)
protected

Definition at line 17 of file qqmlenginecontrolclient.cpp.

Member Function Documentation

◆ blockedEngines()

QList< int > QQmlEngineControlClient::blockedEngines ( ) const

Definition at line 55 of file qqmlenginecontrolclient.cpp.

References d.

◆ blockEngine()

void QQmlEngineControlClient::blockEngine ( int engineId)

Block the starting or stopping of the engine with id engineId for now.

By calling releaseEngine later the block can be lifted again. In the debugged application the engine control server waits until a message is received before continuing. So by not sending a message here we delay the process. Blocks add up. You have to call releaseEngine() as often as you've called blockEngine before. The intention of that is to allow different debug clients to use the same engine control and communicate with their respective counterparts before the QML engine starts or shuts down.

Definition at line 31 of file qqmlenginecontrolclient.cpp.

References d, and Q_ASSERT.

◆ engineAboutToBeAdded

void QQmlEngineControlClient::engineAboutToBeAdded ( int engineId,
const QString & name )
signal

Referenced by QQmlProfilerClient::QQmlProfilerClient(), QQmlProfilerClient::QQmlProfilerClient(), and messageReceived().

+ Here is the caller graph for this function:

◆ engineAboutToBeRemoved

void QQmlEngineControlClient::engineAboutToBeRemoved ( int engineId,
const QString & name )
signal

Referenced by QQmlProfilerClient::QQmlProfilerClient(), and messageReceived().

+ Here is the caller graph for this function:

◆ engineAdded

void QQmlEngineControlClient::engineAdded ( int engineId,
const QString & name )
signal

Referenced by messageReceived().

+ Here is the caller graph for this function:

◆ engineRemoved

void QQmlEngineControlClient::engineRemoved ( int engineId,
const QString & name )
signal

Referenced by messageReceived().

+ Here is the caller graph for this function:

◆ messageReceived()

◆ releaseEngine()

void QQmlEngineControlClient::releaseEngine ( int engineId)

Release the engine with id engineId.

If no other blocks are present, depending on what the engine is waiting for, the start or stop command is sent to the process being debugged.

Definition at line 42 of file qqmlenginecontrolclient.cpp.

References d, QQmlEngineControlClientPrivate::InvalidCommand, Q_ASSERT, and QQmlDebugClient::state().

+ Here is the call graph for this function:

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