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
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Public Attributes | Properties | List of all members
QuickTestResult Class Reference

#include <quicktestresult_p.h>

+ Inheritance diagram for QuickTestResult:
+ Collaboration diagram for QuickTestResult:

Public Types

enum  RunMode { RepeatUntilValidMeasurement , RunOnce }
 

Public Slots

void reset ()
 \qmlmethod TestResult::reset()
 
void startLogging ()
 \qmlmethod TestResult::startLogging()
 
void stopLogging ()
 \qmlmethod TestResult::stopLogging()
 
void initTestTable ()
 
void clearTestTable ()
 
void finishTestData ()
 
void finishTestDataCleanup ()
 
void finishTestFunction ()
 
void stringify (QQmlV4FunctionPtr args)
 
void fail (const QString &message, const QUrl &location, int line)
 
bool verify (bool success, const QString &message, const QUrl &location, int line)
 
bool compare (bool success, const QString &message, const QVariant &val1, const QVariant &val2, const QUrl &location, int line)
 
bool fuzzyCompare (const QVariant &actual, const QVariant &expected, qreal delta)
 
void skip (const QString &message, const QUrl &location, int line)
 
bool expectFail (const QString &tag, const QString &comment, const QUrl &location, int line)
 
bool expectFailContinue (const QString &tag, const QString &comment, const QUrl &location, int line)
 
void warn (const QString &message, const QUrl &location, int line)
 
void ignoreWarning (const QJSValue &message)
 
 Q_REVISION (6, 3) void failOnWarning(const QJSValue &message)
 
void wait (int ms)
 
void sleep (int ms)
 
bool waitForRendering (QQuickItem *item, int timeout=5000)
 
void startMeasurement ()
 
void beginDataRun ()
 
void endDataRun ()
 
bool measurementAccepted ()
 
bool needsMoreMeasurements ()
 
void startBenchmark (RunMode runMode, const QString &tag)
 
bool isBenchmarkDone () const
 
void nextBenchmark ()
 
void stopBenchmark ()
 
QObject * grabImage (QQuickItem *item)
 
 Q_REVISION (1, 1) QObject *findChild(QObject *parent
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void programNameChanged ()
 
void testCaseNameChanged ()
 
void functionNameChanged ()
 
void dataTagChanged ()
 
void skippedChanged ()
 
- 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

 QuickTestResult (QObject *parent=nullptr)
 
 ~QuickTestResult () override
 
QString testCaseName () const
 \qmlproperty string TestResult::testCaseName
 
void setTestCaseName (const QString &name)
 
QString functionName () const
 \qmlproperty string TestResult::functionName
 
void setFunctionName (const QString &name)
 
QString dataTag () const
 \qmlproperty string TestResult::dataTag
 
void setDataTag (const QString &tag)
 
bool isFailed () const
 \qmlproperty bool TestResult::failed
 
bool isSkipped () const
 \qmlproperty bool TestResult::skipped
 
void setSkipped (bool skip)
 
int passCount () const
 \qmlproperty int TestResult::passCount
 
int failCount () const
 \qmlproperty int TestResult::failCount
 
int skipCount () const
 \qmlproperty int TestResult::skipCount
 
QStringList functionsToRun () const
 \qmlproperty list<string> TestResult::functionsToRun
 
QStringList tagsToRun () const
 \qmlproperty list<string> TestResult::tagsToRun
 
 Q_REVISION (1, 13) bool isPolishScheduled(QObject *itemOrWindow) const
 
 Q_REVISION (6, 5) bool waitForPolish(QObject *itemOrWindow
 
- 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.
 

Static Public Member Functions

static void parseArgs (int argc, char *argv[])
 
static void setProgramName (const char *name)
 
static void setCurrentAppname (const char *appname)
 
static int exitCode ()
 
- 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)
 

Public Attributes

const QString & objectName
 
int timeout const
 

Properties

QString testCaseName
 
QString functionName
 
QString dataTag
 
bool failed
 
bool skipped
 
int passCount
 
int failCount
 
int skipCount
 
QStringList functionsToRun
 
QStringList tagsToRun
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- 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
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

Definition at line 31 of file quicktestresult_p.h.

Member Enumeration Documentation

◆ RunMode

enum QuickTestResult::RunMode
Enumerator
RepeatUntilValidMeasurement 
RunOnce 

Definition at line 53 of file quicktestresult_p.h.

Constructor & Destructor Documentation

◆ QuickTestResult()

QuickTestResult::QuickTestResult ( QObject * parent = nullptr)

Definition at line 168 of file quicktestresult.cpp.

◆ ~QuickTestResult()

QuickTestResult::~QuickTestResult ( )
override

Definition at line 175 of file quicktestresult.cpp.

Member Function Documentation

◆ beginDataRun

void QuickTestResult::beginDataRun ( )
slot

Definition at line 655 of file quicktestresult.cpp.

◆ clearTestTable

void QuickTestResult::clearTestTable ( )
slot

Definition at line 413 of file quicktestresult.cpp.

◆ compare

bool QuickTestResult::compare ( bool success,
const QString & message,
const QVariant & val1,
const QVariant & val2,
const QUrl & location,
int line )
slot

Definition at line 562 of file quicktestresult.cpp.

◆ dataTag()

QString QuickTestResult::dataTag ( ) const

\qmlproperty string TestResult::dataTag

This property defines the tag for the current row in a data-driven test, or an empty string if not a data-driven test.

Definition at line 242 of file quicktestresult.cpp.

◆ dataTagChanged

void QuickTestResult::dataTagChanged ( )
signal

◆ endDataRun

void QuickTestResult::endDataRun ( )
slot

Definition at line 660 of file quicktestresult.cpp.

◆ exitCode()

int QuickTestResult::exitCode ( )
static

Definition at line 828 of file quicktestresult.cpp.

◆ expectFail

bool QuickTestResult::expectFail ( const QString & tag,
const QString & comment,
const QUrl & location,
int line )
slot

Definition at line 583 of file quicktestresult.cpp.

◆ expectFailContinue

bool QuickTestResult::expectFailContinue ( const QString & tag,
const QString & comment,
const QUrl & location,
int line )
slot

Definition at line 592 of file quicktestresult.cpp.

◆ fail

void QuickTestResult::fail ( const QString & message,
const QUrl & location,
int line )
slot

Definition at line 442 of file quicktestresult.cpp.

◆ failCount()

int QuickTestResult::failCount ( ) const

\qmlproperty int TestResult::failCount

This property returns the number of tests that have failed.

See also
passCount, skipCount

Definition at line 321 of file quicktestresult.cpp.

◆ finishTestData

void QuickTestResult::finishTestData ( )
slot

Definition at line 420 of file quicktestresult.cpp.

◆ finishTestDataCleanup

void QuickTestResult::finishTestDataCleanup ( )
slot

Definition at line 425 of file quicktestresult.cpp.

◆ finishTestFunction

void QuickTestResult::finishTestFunction ( )
slot

Definition at line 430 of file quicktestresult.cpp.

◆ functionName()

QString QuickTestResult::functionName ( ) const

\qmlproperty string TestResult::functionName

This property defines the name of current test function within a TestCase element that is running. If this string is empty, then no function is currently running.

See also
testCaseName

Definition at line 209 of file quicktestresult.cpp.

◆ functionNameChanged

void QuickTestResult::functionNameChanged ( )
signal

◆ functionsToRun()

QStringList QuickTestResult::functionsToRun ( ) const

\qmlproperty list<string> TestResult::functionsToRun

This property returns the list of function names to be run.

Definition at line 343 of file quicktestresult.cpp.

◆ fuzzyCompare

bool QuickTestResult::fuzzyCompare ( const QVariant & actual,
const QVariant & expected,
qreal delta )
slot

Definition at line 463 of file quicktestresult.cpp.

◆ grabImage

QObject * QuickTestResult::grabImage ( QQuickItem * item)
slot

Definition at line 752 of file quicktestresult.cpp.

◆ ignoreWarning

void QuickTestResult::ignoreWarning ( const QJSValue & message)
slot

Definition at line 606 of file quicktestresult.cpp.

◆ initTestTable

void QuickTestResult::initTestTable ( )
slot

Definition at line 403 of file quicktestresult.cpp.

◆ isBenchmarkDone

bool QuickTestResult::isBenchmarkDone ( ) const
slot

Definition at line 729 of file quicktestresult.cpp.

◆ isFailed()

bool QuickTestResult::isFailed ( ) const

\qmlproperty bool TestResult::failed

This property returns true if the current test function (or current test data row for a data-driven test) has failed; false otherwise. The fail state is reset when functionName is changed or finishTestDataCleanup() is called.

See also
skipped

Definition at line 276 of file quicktestresult.cpp.

◆ isSkipped()

bool QuickTestResult::isSkipped ( ) const

\qmlproperty bool TestResult::skipped

This property returns true if the current test function was marked as skipped; false otherwise.

See also
failed

Definition at line 289 of file quicktestresult.cpp.

◆ measurementAccepted

bool QuickTestResult::measurementAccepted ( )
slot

Definition at line 679 of file quicktestresult.cpp.

◆ needsMoreMeasurements

bool QuickTestResult::needsMoreMeasurements ( )
slot

Definition at line 705 of file quicktestresult.cpp.

◆ nextBenchmark

void QuickTestResult::nextBenchmark ( )
slot

Definition at line 738 of file quicktestresult.cpp.

◆ parseArgs()

void QuickTestResult::parseArgs ( int argc,
char * argv[] )
static

Definition at line 802 of file quicktestresult.cpp.

◆ passCount()

int QuickTestResult::passCount ( ) const

\qmlproperty int TestResult::passCount

This property returns the number of tests that have passed.

See also
failCount, skipCount

Definition at line 309 of file quicktestresult.cpp.

◆ programNameChanged

void QuickTestResult::programNameChanged ( )
signal

◆ Q_REVISION [1/4]

QuickTestResult::Q_REVISION ( 1 ,
1  )
slot

◆ Q_REVISION() [2/4]

QuickTestResult::Q_REVISION ( 1 ,
13  ) const

◆ Q_REVISION [3/4]

QuickTestResult::Q_REVISION ( 6 ,
3  ) const &
slot

◆ Q_REVISION() [4/4]

QuickTestResult::Q_REVISION ( 6 ,
5  )

◆ reset

void QuickTestResult::reset ( )
slot

\qmlmethod TestResult::reset()

Resets all pass/fail/skip counters and prepare for testing.

Definition at line 363 of file quicktestresult.cpp.

◆ setCurrentAppname()

void QuickTestResult::setCurrentAppname ( const char * appname)
static

Definition at line 823 of file quicktestresult.cpp.

◆ setDataTag()

void QuickTestResult::setDataTag ( const QString & tag)

Definition at line 251 of file quicktestresult.cpp.

◆ setFunctionName()

void QuickTestResult::setFunctionName ( const QString & name)

Definition at line 215 of file quicktestresult.cpp.

◆ setProgramName()

void QuickTestResult::setProgramName ( const char * name)
static

Definition at line 809 of file quicktestresult.cpp.

◆ setSkipped()

void QuickTestResult::setSkipped ( bool skip)

Definition at line 294 of file quicktestresult.cpp.

◆ setTestCaseName()

void QuickTestResult::setTestCaseName ( const QString & name)

Definition at line 193 of file quicktestresult.cpp.

◆ skip

void QuickTestResult::skip ( const QString & message,
const QUrl & location,
int line )
slot

Definition at line 575 of file quicktestresult.cpp.

◆ skipCount()

int QuickTestResult::skipCount ( ) const

\qmlproperty int TestResult::skipCount

This property returns the number of tests that have been skipped.

See also
passCount, failCount

Definition at line 333 of file quicktestresult.cpp.

◆ skippedChanged

void QuickTestResult::skippedChanged ( )
signal

◆ sleep

void QuickTestResult::sleep ( int ms)
slot

Definition at line 633 of file quicktestresult.cpp.

◆ startBenchmark

void QuickTestResult::startBenchmark ( RunMode runMode,
const QString & tag )
slot

Definition at line 716 of file quicktestresult.cpp.

◆ startLogging

void QuickTestResult::startLogging ( )
slot

\qmlmethod TestResult::startLogging()

Starts logging to the test output stream and writes the test header.

See also
stopLogging()

Definition at line 377 of file quicktestresult.cpp.

◆ startMeasurement

void QuickTestResult::startMeasurement ( )
slot

Definition at line 645 of file quicktestresult.cpp.

◆ stopBenchmark

void QuickTestResult::stopBenchmark ( )
slot

Definition at line 745 of file quicktestresult.cpp.

◆ stopLogging

void QuickTestResult::stopLogging ( )
slot

\qmlmethod TestResult::stopLogging()

Writes the test footer to the test output stream and then stops logging.

See also
startLogging()

Definition at line 394 of file quicktestresult.cpp.

◆ stringify

void QuickTestResult::stringify ( QQmlV4FunctionPtr args)
slot

Definition at line 507 of file quicktestresult.cpp.

◆ tagsToRun()

QStringList QuickTestResult::tagsToRun ( ) const

\qmlproperty list<string> TestResult::tagsToRun

This property returns the list of test function's data tags to be run

Definition at line 353 of file quicktestresult.cpp.

◆ testCaseName()

QString QuickTestResult::testCaseName ( ) const

\qmlproperty string TestResult::testCaseName

This property defines the name of current TestCase element that is running test cases.

See also
functionName

Definition at line 187 of file quicktestresult.cpp.

◆ testCaseNameChanged

void QuickTestResult::testCaseNameChanged ( )
signal

◆ verify

bool QuickTestResult::verify ( bool success,
const QString & message,
const QUrl & location,
int line )
slot

Definition at line 449 of file quicktestresult.cpp.

◆ wait

void QuickTestResult::wait ( int ms)
slot

Definition at line 628 of file quicktestresult.cpp.

◆ waitForRendering

bool QuickTestResult::waitForRendering ( QQuickItem * item,
int timeout = 5000 )
slot

Definition at line 638 of file quicktestresult.cpp.

◆ warn

void QuickTestResult::warn ( const QString & message,
const QUrl & location,
int line )
slot

Definition at line 601 of file quicktestresult.cpp.

Member Data Documentation

◆ const

int timeout QuickTestResult::const

Definition at line 133 of file quicktestresult_p.h.

◆ objectName

const QString& QuickTestResult::objectName

Definition at line 130 of file quicktestresult_p.h.

Property Documentation

◆ dataTag

QString QuickTestResult::dataTag
readwrite

Definition at line 36 of file quicktestresult_p.h.

◆ failCount

int QuickTestResult::failCount
read

Definition at line 40 of file quicktestresult_p.h.

◆ failed

bool QuickTestResult::failed
read

Definition at line 37 of file quicktestresult_p.h.

◆ functionName

QString QuickTestResult::functionName
readwrite

Definition at line 35 of file quicktestresult_p.h.

◆ functionsToRun

QStringList QuickTestResult::functionsToRun
read

Definition at line 42 of file quicktestresult_p.h.

◆ passCount

int QuickTestResult::passCount
read

Definition at line 39 of file quicktestresult_p.h.

◆ skipCount

int QuickTestResult::skipCount
read

Definition at line 41 of file quicktestresult_p.h.

◆ skipped

bool QuickTestResult::skipped
readwrite

Definition at line 38 of file quicktestresult_p.h.

◆ tagsToRun

QStringList QuickTestResult::tagsToRun
read

Definition at line 43 of file quicktestresult_p.h.

◆ testCaseName

QString QuickTestResult::testCaseName
readwrite

Definition at line 34 of file quicktestresult_p.h.

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