#include <qqmldebugservice_p.h>

Inheritance diagram for QQmlDebugService:

Collaboration diagram for QQmlDebugService:

Public Types
enum	State { NotConnected , Unavailable , Enabled }

Signals
void	attachedToEngine (QJSEngine *)

void	detachedFromEngine (QJSEngine *)

void	messageToClient (const QString &name, const QByteArray &message)

void	messagesToClient (const QString &name, const QList< QByteArray > &messages)

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
	~QQmlDebugService () override

const QString &	name () const

float	version () const

State	state () const

void	setState (State newState)

virtual void	stateAboutToBeChanged (State)

virtual void	stateChanged (State)

virtual void	messageReceived (const QByteArray &)

virtual void	engineAboutToBeAdded (QJSEngine *engine)

virtual void	engineAboutToBeRemoved (QJSEngine *engine)

virtual void	engineAdded (QJSEngine *)

virtual void	engineRemoved (QJSEngine *)

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`.

Static Public Member Functions
static const QHash< int, QObject * > &	objectsForIds ()
	Returns the mapping of objects to unique ids, created through calls to idForObject().

static int	idForObject (QObject *)
	Returns a unique id for object.

static QObject *	objectForId (int id)

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
	QQmlDebugService (const QString &, float version, QObject *parent=nullptr)

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 Slots inherited from QObject
void	deleteLater ()
	\threadsafe

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 30 of file qqmldebugservice_p.h.

Member Enumeration Documentation

◆ State

enum QQmlDebugService::State

Enumerator
NotConnected
Unavailable
Enabled

Definition at line 41 of file qqmldebugservice_p.h.

Constructor & Destructor Documentation

◆ ~QQmlDebugService()

QQmlDebugService::~QQmlDebugService ( )

override

Definition at line 49 of file qqmldebugservice.cpp.

References d, QQmlDebugConnector::instance(), qWarning, and server.

Here is the call graph for this function:

◆ QQmlDebugService()

QQmlDebugService::QQmlDebugService	(	const QString &	name,
		float	version,
		QObject *	parent = `nullptr`
	)

explicitprotected

Definition at line 33 of file qqmldebugservice.cpp.

References d, QQmlDebugConnector::instance(), qWarning, and server.

Here is the call graph for this function:

Member Function Documentation

◆ attachedToEngine

void QQmlDebugService::attachedToEngine ( QJSEngine * )

signal

Referenced by QQmlDebugServerImpl::addService(), QQmlPreviewServiceImpl::engineAboutToBeAdded(), and QQmlDebugServerImpl::removeService().

Here is the caller graph for this function:

◆ detachedFromEngine

void QQmlDebugService::detachedFromEngine ( QJSEngine * )

signal

Referenced by QQmlDebugServerImpl::addService(), QQmlPreviewServiceImpl::engineAboutToBeRemoved(), and QQmlDebugServerImpl::removeService().

Here is the caller graph for this function:

◆ engineAboutToBeAdded()

virtual void QQmlDebugService::engineAboutToBeAdded ( QJSEngine * engine )

inlinevirtual

Reimplemented in QQmlPreviewServiceImpl.

Definition at line 49 of file qqmldebugservice_p.h.

References engine, and Q_EMIT.

Referenced by QQmlNativeDebugServiceImpl::engineAboutToBeAdded().

Here is the caller graph for this function:

◆ engineAboutToBeRemoved()

virtual void QQmlDebugService::engineAboutToBeRemoved ( QJSEngine * engine )

inlinevirtual

Reimplemented in QQmlPreviewServiceImpl.

Definition at line 50 of file qqmldebugservice_p.h.

References engine, and Q_EMIT.

Referenced by QQmlNativeDebugServiceImpl::engineAboutToBeRemoved().

Here is the caller graph for this function:

◆ engineAdded()

virtual void QQmlDebugService::engineAdded ( QJSEngine * )

inlinevirtual

Definition at line 52 of file qqmldebugservice_p.h.

◆ engineRemoved()

virtual void QQmlDebugService::engineRemoved ( QJSEngine * )

inlinevirtual

Definition at line 53 of file qqmldebugservice_p.h.

◆ idForObject()

int QQmlDebugService::idForObject ( QObject * object )

static

Returns a unique id for object.

Calling this method multiple times for the same object will return the same id.

Definition at line 117 of file qqmldebugservice.cpp.

References QObject::connect(), QObject::destroyed(), hash, and iter.

Referenced by QQmlEngineDebugServiceImpl::objectCreated().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ messageReceived()

virtual void QQmlDebugService::messageReceived ( const QByteArray & )

inlinevirtual

Reimplemented in QQmlPreviewServiceImpl.

Definition at line 47 of file qqmldebugservice_p.h.

Referenced by qt_qmlDebugSendDataToService().

Here is the caller graph for this function:

◆ messagesToClient

void QQmlDebugService::messagesToClient	(	const QString &	name,
		const QList< QByteArray > &	messages
	)

signal

Referenced by QQmlNativeDebugConnector::addService(), QQmlDebugServerImpl::addService(), QQmlNativeDebugConnector::removeService(), and QQmlDebugServerImpl::removeService().

Here is the caller graph for this function:

◆ messageToClient

void QQmlDebugService::messageToClient	(	const QString &	name,
		const QByteArray &	message
	)

signal

Referenced by QQmlNativeDebugConnector::addService(), QQmlDebugServerImpl::addService(), QQmlPreviewServiceImpl::forwardError(), QQmlPreviewServiceImpl::forwardFps(), QQmlPreviewServiceImpl::forwardRequest(), QQmlNativeDebugConnector::removeService(), and QQmlDebugServerImpl::removeService().

Here is the caller graph for this function:

◆ name()

const QString & QQmlDebugService::name ( ) const

Definition at line 63 of file qqmldebugservice.cpp.

References d.

Referenced by QQmlPreviewServiceImpl::forwardError(), QQmlPreviewServiceImpl::forwardFps(), and QQmlPreviewServiceImpl::forwardRequest().

Here is the caller graph for this function:

◆ objectForId()

static QObject * QQmlDebugService::objectForId ( int id )

inlinestatic

Definition at line 57 of file qqmldebugservice_p.h.

Referenced by QQmlWatcher::addWatch(), QQmlWatcher::addWatch(), QQmlWatcher::addWatch(), QmlJSDebugger::GlobalInspector::processMessage(), and JavaScriptJob::run().

Here is the caller graph for this function:

◆ objectsForIds()

const QHash< int, QObject * > & QQmlDebugService::objectsForIds ( )

static

Returns the mapping of objects to unique ids, created through calls to idForObject().

Definition at line 137 of file qqmldebugservice.cpp.

◆ setState()

void QQmlDebugService::setState ( State newState )

Definition at line 81 of file qqmldebugservice.cpp.

References d, and newState().

Here is the call graph for this function:

◆ state()

QQmlDebugService::State QQmlDebugService::state ( ) const

Definition at line 75 of file qqmldebugservice.cpp.

References d.

Referenced by QQmlPreviewServiceImpl::stateChanged().

Here is the caller graph for this function:

◆ stateAboutToBeChanged()

virtual void QQmlDebugService::stateAboutToBeChanged ( State )

inlinevirtual

Definition at line 45 of file qqmldebugservice_p.h.

Referenced by QQmlNativeDebugServiceImpl::stateAboutToBeChanged().

Here is the caller graph for this function:

◆ stateChanged()

virtual void QQmlDebugService::stateChanged ( State )

inlinevirtual

Reimplemented in QQmlPreviewServiceImpl.

Definition at line 46 of file qqmldebugservice_p.h.

◆ version()

float QQmlDebugService::version ( ) const

Definition at line 69 of file qqmldebugservice.cpp.

References d.

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

qtdeclarative/src/qml/debugger/qqmldebugservice_p.h
qtdeclarative/src/qml/debugger/qqmldebugservice.cpp

Public Types

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ ~QQmlDebugService()

◆ QQmlDebugService()

Member Function Documentation

◆ attachedToEngine

◆ detachedFromEngine

◆ engineAboutToBeAdded()

◆ engineAboutToBeRemoved()

◆ engineAdded()

◆ engineRemoved()

◆ idForObject()

◆ messageReceived()

◆ messagesToClient

◆ messageToClient

◆ name()

◆ objectForId()

◆ objectsForIds()

◆ setState()

◆ state()

◆ stateAboutToBeChanged()

◆ stateChanged()

◆ version()