#include <qqmlpreviewservice.h>

Inheritance diagram for QQmlPreviewServiceImpl:

Collaboration diagram for QQmlPreviewServiceImpl:

Public Types
enum	Command { File , Load , Request , Error , Rerun , Directory , ClearCache , Zoom , Fps }
Public Types inherited from QQmlDebugService
enum	State { NotConnected , Unavailable , Enabled }

Signals
void	error (const QString &file)
void	file (const QString &file, const QByteArray &contents)
void	directory (const QString &file, const QStringList &entries)
void	load (const QUrl &url)
void	drop (const QUrl &url)
void	rerun ()
void	clearCache ()
void	zoom (qreal factor)
Signals inherited from QQmlDebugService
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
	QQmlPreviewServiceImpl (QObject *parent=nullptr)
virtual	~QQmlPreviewServiceImpl ()
void	messageReceived (const QByteArray &message) override
void	engineAboutToBeAdded (QJSEngine *engine) override
void	engineAboutToBeRemoved (QJSEngine *engine) override
void	stateChanged (State state) override
void	forwardRequest (const QString &file)
void	forwardError (const QString &error)
void	forwardFps (const QQmlPreviewHandler::FpsInfo &frames)
QQuickItem *	currentRootItem ()
Public Member Functions inherited from QQmlDebugService
	~QQmlDebugService () override
const QString &	name () const
float	version () const
State	state () const
void	setState (State newState)
virtual void	stateAboutToBeChanged (State)
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	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).
QThread *	thread () 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>
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>
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 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 Attributes
static const QString	s_key = QStringLiteral("QmlPreview")

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Static Public Member Functions inherited from QQmlDebugService
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 inherited from QQmlDebugService
	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)
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 26 of file qqmlpreviewservice.h.

Member Enumeration Documentation

◆ Command

enum QQmlPreviewServiceImpl::Command

Enumerator
File
Load
Request
Error
Rerun
Directory
ClearCache
Zoom
Fps

Definition at line 31 of file qqmlpreviewservice.h.

Constructor & Destructor Documentation

◆ QQmlPreviewServiceImpl()

QQmlPreviewServiceImpl::QQmlPreviewServiceImpl ( QObject * parent = nullptr )

Definition at line 22 of file qqmlpreviewservice.cpp.

References QQmlPreviewServiceImpl().

Referenced by QQmlPreviewServiceImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~QQmlPreviewServiceImpl()

QQmlPreviewServiceImpl::~QQmlPreviewServiceImpl ( )

virtual

Definition at line 35 of file qqmlpreviewservice.cpp.

Member Function Documentation

◆ clearCache

void QQmlPreviewServiceImpl::clearCache ( )

signal

◆ currentRootItem()

QQuickItem * QQmlPreviewServiceImpl::currentRootItem ( )

Definition at line 160 of file qqmlpreviewservice.cpp.

Referenced by QQmlDebugTranslationServicePrivate::currentRootItem().

Here is the caller graph for this function:

◆ directory

void QQmlPreviewServiceImpl::directory	(	const QString &	file,
		const QStringList &	entries )

signal

◆ drop

void QQmlPreviewServiceImpl::drop ( const QUrl & url )

signal

◆ engineAboutToBeAdded()

void QQmlPreviewServiceImpl::engineAboutToBeAdded ( QJSEngine * engine )

overridevirtual

Reimplemented from QQmlDebugService.

Definition at line 108 of file qqmlpreviewservice.cpp.

◆ engineAboutToBeRemoved()

void QQmlPreviewServiceImpl::engineAboutToBeRemoved ( QJSEngine * engine )

overridevirtual

Reimplemented from QQmlDebugService.

Definition at line 115 of file qqmlpreviewservice.cpp.

◆ error

void QQmlPreviewServiceImpl::error ( const QString & file )

signal

◆ file

void QQmlPreviewServiceImpl::file	(	const QString &	file,
		const QByteArray &	contents )

signal

◆ forwardError()

void QQmlPreviewServiceImpl::forwardError ( const QString & error )

Definition at line 144 of file qqmlpreviewservice.cpp.

◆ forwardFps()

void QQmlPreviewServiceImpl::forwardFps ( const QQmlPreviewHandler::FpsInfo & frames )

Definition at line 151 of file qqmlpreviewservice.cpp.

◆ forwardRequest()

void QQmlPreviewServiceImpl::forwardRequest ( const QString & file )

Definition at line 137 of file qqmlpreviewservice.cpp.

◆ load

void QQmlPreviewServiceImpl::load ( const QUrl & url )

signal

◆ messageReceived()

void QQmlPreviewServiceImpl::messageReceived ( const QByteArray & message )

overridevirtual

Reimplemented from QQmlDebugService.

Definition at line 39 of file qqmlpreviewservice.cpp.

References QQmlTypeLoader::clearCache().

Here is the call graph for this function:

◆ rerun

void QQmlPreviewServiceImpl::rerun ( )

signal

◆ stateChanged()

void QQmlPreviewServiceImpl::stateChanged ( State state )

overridevirtual

Reimplemented from QQmlDebugService.

Definition at line 122 of file qqmlpreviewservice.cpp.

◆ zoom

void QQmlPreviewServiceImpl::zoom ( qreal factor )

signal

Member Data Documentation

◆ s_key

QT_BEGIN_NAMESPACE const QString QQmlPreviewServiceImpl::s_key = QStringLiteral("QmlPreview")

static

Definition at line 43 of file qqmlpreviewservice.h.

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

qtdeclarative/src/plugins/qmltooling/qmldbg_preview/qqmlpreviewservice.h (64cd070c8c4bee26c04bf48dcd99a29262a2fd6f)
qtdeclarative/src/plugins/qmltooling/qmldbg_preview/qqmlpreviewservice.cpp (64cd070c8c4bee26c04bf48dcd99a29262a2fd6f)

Public Types

Signals

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Command

Constructor & Destructor Documentation

◆ QQmlPreviewServiceImpl()

◆ ~QQmlPreviewServiceImpl()

Member Function Documentation

◆ clearCache

◆ currentRootItem()

◆ directory

◆ drop

◆ engineAboutToBeAdded()

◆ engineAboutToBeRemoved()

◆ error

◆ file

◆ forwardError()

◆ forwardFps()

◆ forwardRequest()

◆ load

◆ messageReceived()

◆ rerun

◆ stateChanged()

◆ zoom

Member Data Documentation

◆ s_key