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
QAbstractItemModelTester Class Reference

The QAbstractItemModelTester class helps testing QAbstractItemModel subclasses. More...

#include <qabstractitemmodeltester.h>

+ Inheritance diagram for QAbstractItemModelTester:
+ Collaboration diagram for QAbstractItemModelTester:

Public Types

enum class  FailureReportingMode { QtTest , Warning , Fatal }
 This enumeration specifies how QAbstractItemModelTester should report a failure when it tests a QAbstractItemModel subclass. More...
 

Public Member Functions

 QAbstractItemModelTester (QAbstractItemModel *model, QObject *parent=nullptr)
 Creates a model tester instance, with the given parent, that will test the model model.
 
 QAbstractItemModelTester (QAbstractItemModel *model, FailureReportingMode mode, QObject *parent=nullptr)
 Creates a model tester instance, with the given parent, that will test the model model, using the specified mode to report test failures.
 
QAbstractItemModelmodel () const
 Returns the model that this instance is testing.
 
FailureReportingMode failureReportingMode () const
 Returns the mode that this instancing is using to report test failures.
 
void setUseFetchMore (bool value)
 If value is true, enables dynamic population of the tested model, which is the default.
 
- 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 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.
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- 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.
 
- 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 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)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

The QAbstractItemModelTester class helps testing QAbstractItemModel subclasses.

Since
5.11 \inmodule QtTest

The QAbstractItemModelTester class is a utility class to test item models.

When implementing an item model (that is, a concrete QAbstractItemModel subclass) one must abide to a very strict set of rules that ensure consistency for users of the model (views, proxy models, and so on).

For instance, for a given index, a model's reimplementation of \l{QAbstractItemModel::hasChildren()}{hasChildren()} must be consistent with the values returned by \l{QAbstractItemModel::rowCount()}{rowCount()} and \l{QAbstractItemModel::columnCount()}{columnCount()}.

QAbstractItemModelTester helps catching the most common errors in custom item model classes. By performing a series of tests, it will try to check that the model status is consistent at all times. The tests will be repeated automatically every time the model is modified.

QAbstractItemModelTester employs non-destructive tests, which typically consist in reading data and metadata out of a given item model. QAbstractItemModelTester will also attempt illegal modifications of the model. In models which are properly implemented, such attempts should be rejected, and no data should be changed as a consequence.

Definition at line 33 of file qabstractitemmodeltester.h.

Member Enumeration Documentation

◆ FailureReportingMode

This enumeration specifies how QAbstractItemModelTester should report a failure when it tests a QAbstractItemModel subclass.

\value QtTest The failures will be reported as QtTest test failures.

\value Warning The failures will be reported as warning messages in the {qt.modeltest} logging category.

\value Fatal A failure will cause immediate and abnormal program termination. The reason for the failure will be reported using {qFatal()}.

Enumerator
QtTest 
Warning 
Fatal 

Definition at line 39 of file qabstractitemmodeltester.h.

Constructor & Destructor Documentation

◆ QAbstractItemModelTester() [1/2]

QAbstractItemModelTester::QAbstractItemModelTester ( QAbstractItemModel * model,
QObject * parent = nullptr )

Creates a model tester instance, with the given parent, that will test the model model.

The failure reporting mode is set to FailureReportingMode::QtTest.

Definition at line 202 of file qabstractitemmodeltester.cpp.

◆ QAbstractItemModelTester() [2/2]

QAbstractItemModelTester::QAbstractItemModelTester ( QAbstractItemModel * model,
FailureReportingMode mode,
QObject * parent = nullptr )

Creates a model tester instance, with the given parent, that will test the model model, using the specified mode to report test failures.

See also
QAbstractItemModelTester::FailureReportingMode

Definition at line 213 of file qabstractitemmodeltester.cpp.

Member Function Documentation

◆ failureReportingMode()

QAbstractItemModelTester::FailureReportingMode QAbstractItemModelTester::failureReportingMode ( ) const

Returns the mode that this instancing is using to report test failures.

See also
QAbstractItemModelTester::FailureReportingMode

Definition at line 317 of file qabstractitemmodeltester.cpp.

◆ model()

QAbstractItemModel * QAbstractItemModelTester::model ( ) const

Returns the model that this instance is testing.

Definition at line 306 of file qabstractitemmodeltester.cpp.

◆ setUseFetchMore()

void QAbstractItemModelTester::setUseFetchMore ( bool value)

If value is true, enables dynamic population of the tested model, which is the default.

If value is false, it disables it.

Since
6.4
See also
QAbstractItemModel::fetchMore()

Definition at line 331 of file qabstractitemmodeltester.cpp.


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