 |
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
|
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
\inmodule QtQmlDesignSupport More...
#include <qmultiobjectregistryref.h>
Signals | |
| void | objectsChanged () |
| void | objectAdded (QObject *obj) |
| This signal is emitted when a new object, obj, has been registered with the key of this reference. | |
| void | objectRemoved (QObject *obj) |
| \qmlsignal MultiObjectRegistryRef::objectAdded(QtObject obj) | |
| Signals inherited from QAbstractObjectRegistryRef | |
| void | keyChanged () |
| void | dataChanged () |
| 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 | |
| QMultiObjectRegistryRef (QObject *parent=nullptr) | |
| \qmlproperty list<QtObject> MultiObjectRegistryRef::objects | |
| QMultiObjectRegistryRef (QQmlEngine *engine, QObject *parent=nullptr) | |
| Constructs QMultiObjectRegistryRef instance with QML engine and parent. | |
| QMultiObjectRegistryRef (QQmlEngine *engine, const QString &key, QObject *parent=nullptr) | |
| Constructs QMultiObjectRegistryRef instance with QML engine, key and parent. | |
| QQmlListProperty< QObject > | objects () |
| QList< QObject * > | objectsList () |
| Public Member Functions inherited from QAbstractObjectRegistryRef | |
| ~QAbstractObjectRegistryRef () override | |
| QString | key () const |
| void | setKey (const QString &key) |
| QQmlListProperty< QObject > | data () |
| 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 | isQmlExposed () const noexcept |
| 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. | |
Properties | |
| QQmlListProperty< QObject > | objects |
| \qmltype MultiObjectRegistryRef \nativetype QObjectRegistryRef \inqmlmodule QtQml.DesignSupport\inherits AbstractObjectRegistryRef | |
| Properties inherited from QAbstractObjectRegistryRef | |
| QString | key |
| \qmltype AbstractObjectRegistryRef \nativetype QAbstractObjectRegistryRef \inqmlmodule QtQml.DesignSupport | |
| QQmlListProperty< QObject > | data |
| \qmlproperty string AbstractObjectRegistryRef::key This property specifies the key of the registered object that this reference refers to. | |
| 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 Member Functions inherited from QAbstractObjectRegistryRef | |
| QAbstractObjectRegistryRef (QAbstractObjectRegistryRefPrivate &dd, 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 |
| 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) | |
\inmodule QtQmlDesignSupport
This class is used to access objects registered with ObjectRegistry QML type from C++ code.
Multiple objects registered with the same key can be accessed via this reference.
Example usage:
\codeline
Definition at line 14 of file qmultiobjectregistryref.h.
\qmlproperty list<QtObject> MultiObjectRegistryRef::objects
This property provides the objects referenced by this instance. The order of the objects in this list is not guaranteed to match the order of their registration.
Constructs QMultiObjectRegistryRef instance with parent.
Definition at line 75 of file qmultiobjectregistryref.cpp.
|
explicit |
Constructs QMultiObjectRegistryRef instance with QML engine and parent.
All registrations are scoped to the specified QML engine.
Definition at line 85 of file qmultiobjectregistryref.cpp.
|
explicit |
Constructs QMultiObjectRegistryRef instance with QML engine, key and parent.
All registrations are scoped to the specified QML engine.
Definition at line 95 of file qmultiobjectregistryref.cpp.
This signal is emitted when a new object, obj, has been registered with the key of this reference.
\qmlsignal MultiObjectRegistryRef::objectAdded(QtObject obj)
This signal is emitted when a new object, obj, has been registered with the key of this reference.
This signal is emitted when an object, obj, registration has been removed with the key of this reference.
| QQmlListProperty< QObject > QMultiObjectRegistryRef::objects | ( | ) |
|
signal |
This is a method to get the list of registered objects as a QList.
The order of the objects in this list is not guaranteed to match the order of their registration.
Definition at line 118 of file qmultiobjectregistryref.cpp.
|
read |
\qmltype MultiObjectRegistryRef \nativetype QObjectRegistryRef \inqmlmodule QtQml.DesignSupport\inherits AbstractObjectRegistryRef
This type is used to access objects registered with ObjectRegistry type.
Multiple objects registered with the same key can be accessed via this reference.
Example usage:
\codeline
This property provides the objects referenced by this instance. The order of the objects in this list is not guaranteed to match the order of their registration.
Definition at line 20 of file qmultiobjectregistryref.h.
Referenced by testing.tools.fixup_pdf_template.TemplateProcessor::generate_xref_table(), testing.tools.fixup_pdf_template.TemplateProcessor::insert_xref_entry(), and testing.tools.fixup_pdf_template.TemplateProcessor::process_line().
1.16.1