Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QQmlInstanceModel Class Referenceabstract

#include <qqmlobjectmodel_p.h>

Inheritance diagram for QQmlInstanceModel:
Collaboration diagram for QQmlInstanceModel:

Public Types

enum  ReusableFlag { NotReusable , Reusable }
enum  ReleaseFlag { Referenced = 0x01 , Destroyed = 0x02 , Pooled = 0x04 }

Signals

void countChanged ()
void modelUpdated (const QQmlChangeSet &changeSet, bool reset)
void createdItem (int index, QObject *object)
void initItem (int index, QObject *object)
void destroyingItem (QObject *object)
 Q_REVISION (2, 15) void itemPooled(int index
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

virtual int count () const =0
virtual bool isValid () const =0
virtual QObjectobject (int index, QQmlIncubator::IncubationMode incubationMode=QQmlIncubator::AsynchronousIfNested)=0
virtual ReleaseFlags release (QObject *object, ReusableFlag reusableFlag=NotReusable)=0
virtual void cancel (int)
QString stringValue (int index, const QString &role)
virtual QVariant variantValue (int, const QString &)=0
virtual void setWatchedRoles (const QList< QByteArray > &roles)=0
virtual QQmlIncubator::Status incubationStatus (int index)=0
virtual void drainReusableItemsPool (int maxPoolTime)
virtual int poolSize ()
virtual int indexOf (QObject *object, QObject *objectContext) const =0
virtual const QAbstractItemModelabstractItemModel () const
virtual bool setRequiredProperty (int index, const QString &name, const QVariant &value)
 Q_REVISION (2, 15) void itemReused(int index
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 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).
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.

Public Attributes

QObjectobject

Protected Member Functions

 QQmlInstanceModel (QObjectPrivate &dd, QObject *parent=nullptr)
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)

Properties

int count
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< QObjectDatad_ptr

Detailed Description

Definition at line 32 of file qqmlobjectmodel_p.h.

Member Enumeration Documentation

◆ ReleaseFlag

Enumerator
Referenced 
Destroyed 
Pooled 

Definition at line 46 of file qqmlobjectmodel_p.h.

◆ ReusableFlag

Enumerator
NotReusable 
Reusable 

Definition at line 41 of file qqmlobjectmodel_p.h.

Constructor & Destructor Documentation

◆ QQmlInstanceModel()

QQmlInstanceModel::QQmlInstanceModel ( QObjectPrivate & dd,
QObject * parent = nullptr )
inlineprotected

Definition at line 77 of file qqmlobjectmodel_p.h.

Member Function Documentation

◆ abstractItemModel()

virtual const QAbstractItemModel * QQmlInstanceModel::abstractItemModel ( ) const
inlinevirtual

Reimplemented in QQmlDelegateModel, and QQmlTableInstanceModel.

Definition at line 63 of file qqmlobjectmodel_p.h.

◆ cancel()

virtual void QQmlInstanceModel::cancel ( int )
inlinevirtual

Reimplemented in QQmlDelegateModel, and QQmlTableInstanceModel.

Definition at line 53 of file qqmlobjectmodel_p.h.

◆ count()

virtual int QQmlInstanceModel::count ( ) const
pure virtual

◆ countChanged

void QQmlInstanceModel::countChanged ( )
signal

◆ createdItem

void QQmlInstanceModel::createdItem ( int index,
QObject * object )
signal

◆ destroyingItem

void QQmlInstanceModel::destroyingItem ( QObject * object)
signal

◆ drainReusableItemsPool()

virtual void QQmlInstanceModel::drainReusableItemsPool ( int maxPoolTime)
inlinevirtual

Reimplemented in QQmlDelegateModel, and QQmlTableInstanceModel.

Definition at line 59 of file qqmlobjectmodel_p.h.

◆ incubationStatus()

virtual QQmlIncubator::Status QQmlInstanceModel::incubationStatus ( int index)
pure virtual

◆ indexOf()

virtual int QQmlInstanceModel::indexOf ( QObject * object,
QObject * objectContext ) const
pure virtual

◆ initItem

void QQmlInstanceModel::initItem ( int index,
QObject * object )
signal

◆ isValid()

virtual bool QQmlInstanceModel::isValid ( ) const
pure virtual

◆ modelUpdated

void QQmlInstanceModel::modelUpdated ( const QQmlChangeSet & changeSet,
bool reset )
signal

◆ object()

virtual QObject * QQmlInstanceModel::object ( int index,
QQmlIncubator::IncubationMode incubationMode = QQmlIncubator::AsynchronousIfNested )
pure virtual

◆ poolSize()

virtual int QQmlInstanceModel::poolSize ( )
inlinevirtual

Reimplemented in QQmlDelegateModel, and QQmlTableInstanceModel.

Definition at line 60 of file qqmlobjectmodel_p.h.

◆ Q_REVISION [1/2]

QQmlInstanceModel::Q_REVISION ( 2 ,
15  )
signal

◆ Q_REVISION() [2/2]

QQmlInstanceModel::Q_REVISION ( 2 ,
15  )

◆ release()

virtual ReleaseFlags QQmlInstanceModel::release ( QObject * object,
ReusableFlag reusableFlag = NotReusable )
pure virtual

◆ setRequiredProperty()

bool QQmlInstanceModel::setRequiredProperty ( int index,
const QString & name,
const QVariant & value )
virtual

Reimplemented in QQmlTableInstanceModel.

Definition at line 484 of file qqmlobjectmodel.cpp.

◆ setWatchedRoles()

virtual void QQmlInstanceModel::setWatchedRoles ( const QList< QByteArray > & roles)
pure virtual

◆ stringValue()

QString QQmlInstanceModel::stringValue ( int index,
const QString & role )
inline

Definition at line 54 of file qqmlobjectmodel_p.h.

◆ variantValue()

virtual QVariant QQmlInstanceModel::variantValue ( int ,
const QString &  )
pure virtual

Member Data Documentation

◆ object

QObject * QQmlInstanceModel::object

Definition at line 73 of file qqmlobjectmodel_p.h.

Property Documentation

◆ count

int QQmlInstanceModel::count
read

Definition at line 36 of file qqmlobjectmodel_p.h.


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