#include <qqmlconnections_p.h>

Inheritance diagram for QQmlConnections:

Collaboration diagram for QQmlConnections:

Signals
void	targetChanged ()

	Q_REVISION (2, 3) void enabledChanged()

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
	QQmlConnections (QObject *parent=nullptr)

	~QQmlConnections ()

QObject *	target () const
	\qmlproperty QtObject QtQml::Connections::target This property holds the object that sends the signal.

void	setTarget (QObject *)

bool	isEnabled () const
	\qmlproperty bool QtQml::Connections::enabled

void	setEnabled (bool enabled)

bool	ignoreUnknownSignals () const
	\qmlproperty bool QtQml::Connections::ignoreUnknownSignals

void	setIgnoreUnknownSignals (bool ignore)

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.

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

Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()

virtual	~QQmlParserStatus ()

Protected Member Functions
void	classBegin () override
	Invoked after class creation, but before any properties have been set.

void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.

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)

Properties
QObject *	target

bool	enabled

bool	ignoreUnknownSignals

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
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

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 29 of file qqmlconnections_p.h.

Constructor & Destructor Documentation

◆ QQmlConnections()

QQmlConnections::QQmlConnections ( QObject * parent = nullptr )

\qmltype Connections
\instantiates QQmlConnections
\inqmlmodule QtQml
\ingroup qtquick-interceptors
\brief Describes generalized connections to signals.

A Connections object creates a connection to a QML signal.

When connecting to signals in QML, the usual way is to create an
"on<Signal>" handler that reacts when a signal is received, like this:

\qml
MouseArea {
    onClicked: (mouse)=> { foo(mouse) }
}
\endqml

However, it is not possible to connect to a signal in this way in some
cases, such as when:

\list
    \li Multiple connections to the same signal are required
    \li Creating connections outside the scope of the signal sender
    \li Connecting to targets not defined in QML
\endlist

When any of these are needed, the Connections type can be used instead.

For example, the above code can be changed to use a Connections object,
like this:

\qml
MouseArea {
    Connections {
        function onClicked(mouse) { foo(mouse) }
    }
}
\endqml

More generally, the Connections object can be a child of some object other than
the sender of the signal:

\qml
MouseArea {
    id: area
}

... \endqml \qml Connections { target: area function onClicked(mouse) { foo(mouse) } } \endqml

Note: For backwards compatibility you can also specify the signal handlers without {function}, like you would specify them directly in the target object. This is not recommended. If you specify one signal handler this way, then all signal handlers specified as {function} in the same Connections object are ignored.

See also: {Qt Qml}

Definition at line 207 of file qqmlconnections.cpp.

◆ ~QQmlConnections()

QQmlConnections::~QQmlConnections ( )

Definition at line 212 of file qqmlconnections.cpp.

References d.

Member Function Documentation

◆ classBegin()

void QQmlConnections::classBegin ( )

overrideprotectedvirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 480 of file qqmlconnections.cpp.

References d.

◆ componentComplete()

void QQmlConnections::componentComplete ( )

overrideprotectedvirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 486 of file qqmlconnections.cpp.

References d.

◆ ignoreUnknownSignals()

bool QQmlConnections::ignoreUnknownSignals ( ) const

\qmlproperty bool QtQml::Connections::ignoreUnknownSignals

Normally, a connection to a non-existent signal produces runtime errors.

If this property is set to true, such errors are ignored. This is useful if you intend to connect to different types of objects, handling a different set of signals for each object.

Definition at line 320 of file qqmlconnections.cpp.

References d.

◆ isEnabled()

bool QQmlConnections::isEnabled ( ) const

\qmlproperty bool QtQml::Connections::enabled

Since: 5.7

This property holds whether the item accepts change events.

By default, this property is true.

Definition at line 287 of file qqmlconnections.cpp.

References d.

◆ Q_REVISION

QQmlConnections::Q_REVISION	(	2	,
		3	)

signal

◆ setEnabled()

void QQmlConnections::setEnabled ( bool enabled )

Definition at line 293 of file qqmlconnections.cpp.

References d, emit, enabled, and signal.

◆ setIgnoreUnknownSignals()

void QQmlConnections::setIgnoreUnknownSignals ( bool ignore )

Definition at line 326 of file qqmlconnections.cpp.

References d.

◆ setTarget()

void QQmlConnections::setTarget ( QObject * obj )

Definition at line 253 of file qqmlconnections.cpp.

References QQmlConnectionSlotDispatcher::connection, d, QObject::deleteLater(), QtPrivate::QSlotObjectBase::destroyIfLastRef(), QObject::disconnect(), emit, signal, and targetChanged().

Here is the call graph for this function:

◆ target()

QObject * QQmlConnections::target ( ) const

\qmlproperty QtObject QtQml::Connections::target This property holds the object that sends the signal.

If this property is not set, the target defaults to the parent of the Connection.

If set to null, no connection is made and any signal handlers are ignored until the target is not null.

Definition at line 237 of file qqmlconnections.cpp.

References d, and QObject::parent().

Here is the call graph for this function:

◆ targetChanged

void QQmlConnections::targetChanged ( )

signal

Referenced by setTarget().

Here is the caller graph for this function:

Property Documentation

◆ enabled

bool QQmlConnections::enabled

readwrite

Definition at line 36 of file qqmlconnections_p.h.

Referenced by setEnabled().

◆ ignoreUnknownSignals

bool QQmlConnections::ignoreUnknownSignals

readwrite

Definition at line 37 of file qqmlconnections_p.h.

◆ target

QObject * QQmlConnections::target

readwrite

Definition at line 35 of file qqmlconnections_p.h.

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

qtdeclarative/src/qml/types/qqmlconnections_p.h (5c5a2c24847c636857153078e4716fcb242f394d)
qtdeclarative/src/qml/types/qqmlconnections.cpp (72c825e685229a2b747f1d79216ef3c6d3304de8)

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQmlConnections()

◆ ~QQmlConnections()

Member Function Documentation

◆ classBegin()

◆ componentComplete()

◆ ignoreUnknownSignals()

◆ isEnabled()

◆ Q_REVISION

◆ setEnabled()

◆ setIgnoreUnknownSignals()

◆ setTarget()

◆ target()

◆ targetChanged

Property Documentation

◆ enabled

◆ ignoreUnknownSignals

◆ target