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
QQuickVisualTestUtils Namespace Reference

Classes

class  MnemonicKeySimulator
class  PointLerper
class  QQuickApplicationHelper
struct  SignalMultiSpy

Enumerations

enum class  FindViewDelegateItemFlag { None = 0x0 , PositionViewAtIndex = 0x01 }

Functions

QQuickItemfindVisibleChild (QQuickItem *parent, const QString &objectName)
void dumpTree (QQuickItem *parent, int depth=0)
void moveMouseAway (QQuickWindow *window)
void centerOnScreen (QQuickWindow *window)
template<typename F>
void forEachStep (int steps, F &&func)
QPoint lerpPoints (const QPoint &point1, const QPoint &point2, qreal t)
bool isDelegateVisible (QQuickItem *item)
template<typename T>
T * findItem (QQuickItem *parent, const QString &objectName, int index=-1)
template<typename T>
QList< T * > findItems (QQuickItem *parent, const QString &objectName, bool visibleOnly=true)
template<typename T>
QList< T * > findItems (QQuickItem *parent, const QString &objectName, const QList< int > &indexes)
bool compareImages (const QImage &ia, const QImage &ib, QString *errorMessage)
template<typename T>
bool findViewDelegateItem (QQuickItemView *itemView, int index, T &delegateItem, FindViewDelegateItemFlags flags=FindViewDelegateItemFlag::PositionViewAtIndex)
QPoint mapCenterToWindow (const QQuickItem *item)
QPoint mapToWindow (const QQuickItem *item, qreal relativeX, qreal relativeY)
QPoint mapToWindow (const QQuickItem *item, const QPointF &relativePos)

Enumeration Type Documentation

◆ FindViewDelegateItemFlag

Enumerator
None 
PositionViewAtIndex 

Definition at line 167 of file visualtestutils_p.h.

Function Documentation

◆ centerOnScreen()

void QQuickVisualTestUtils::centerOnScreen ( QQuickWindow * window)

Definition at line 62 of file visualtestutils.cpp.

◆ compareImages()

bool QQuickVisualTestUtils::compareImages ( const QImage & ia,
const QImage & ib,
QString * errorMessage )

Compares ia with ib, returning true if the images are equal. If they are not equal, false is returned and errorMessage is set.

A custom compare function to avoid issues such as: When running on native Nvidia graphics cards on linux, the distance field glyph pixels have a measurable, but not visible pixel error. This was GT-216 with the ubuntu "nvidia-319" driver package. llvmpipe does not show the same issue.

To see the actual and expected images upon failure, enable the qt.quicktestutils.compareimages debug logging category.

Definition at line 144 of file visualtestutils.cpp.

◆ dumpTree()

void QQuickVisualTestUtils::dumpTree ( QQuickItem * parent,
int depth = 0 )

Definition at line 35 of file visualtestutils.cpp.

◆ findItem()

template<typename T>
T * QQuickVisualTestUtils::findItem ( QQuickItem * parent,
const QString & objectName,
int index = -1 )

Definition at line 83 of file visualtestutils_p.h.

◆ findItems() [1/2]

template<typename T>
QList< T * > QQuickVisualTestUtils::findItems ( QQuickItem * parent,
const QString & objectName,
bool visibleOnly = true )

Definition at line 113 of file visualtestutils_p.h.

◆ findItems() [2/2]

template<typename T>
QList< T * > QQuickVisualTestUtils::findItems ( QQuickItem * parent,
const QString & objectName,
const QList< int > & indexes )

Definition at line 130 of file visualtestutils_p.h.

◆ findViewDelegateItem()

template<typename T>
bool QQuickVisualTestUtils::findViewDelegateItem ( QQuickItemView * itemView,
int index,
T & delegateItem,
FindViewDelegateItemFlags flags = FindViewDelegateItemFlag::PositionViewAtIndex )
nodiscard

Same as above except allows use in QTRY_* functions without having to call it again afterwards to assign the delegate.

Definition at line 185 of file visualtestutils_p.h.

◆ findVisibleChild()

QT_BEGIN_NAMESPACE QQuickItem * QQuickVisualTestUtils::findVisibleChild ( QQuickItem * parent,
const QString & objectName )

Definition at line 22 of file visualtestutils.cpp.

◆ forEachStep()

template<typename F>
void QQuickVisualTestUtils::forEachStep ( int steps,
F && func )

Definition at line 42 of file visualtestutils_p.h.

◆ isDelegateVisible()

bool QQuickVisualTestUtils::isDelegateVisible ( QQuickItem * item)
nodiscard

Returns true if {item->isVisible()} returns true, and the item is not culled.

Definition at line 124 of file visualtestutils.cpp.

◆ lerpPoints()

QPoint QQuickVisualTestUtils::lerpPoints ( const QPoint & point1,
const QPoint & point2,
qreal t )
nodiscard

Definition at line 67 of file visualtestutils.cpp.

◆ mapCenterToWindow()

QPoint QQuickVisualTestUtils::mapCenterToWindow ( const QQuickItem * item)

Definition at line 308 of file visualtestutils.cpp.

◆ mapToWindow() [1/2]

QPoint QQuickVisualTestUtils::mapToWindow ( const QQuickItem * item,
const QPointF & relativePos )

Definition at line 318 of file visualtestutils.cpp.

◆ mapToWindow() [2/2]

QPoint QQuickVisualTestUtils::mapToWindow ( const QQuickItem * item,
qreal relativeX,
qreal relativeY )

Definition at line 313 of file visualtestutils.cpp.

◆ moveMouseAway()

void QQuickVisualTestUtils::moveMouseAway ( QQuickWindow * window)

Definition at line 47 of file visualtestutils.cpp.