#include <qquicktextmetrics_p.h>

Inheritance diagram for QQuickTextMetrics:

Collaboration diagram for QQuickTextMetrics:

Signals
void	fontChanged ()

void	textChanged ()

void	elideChanged ()

void	elideWidthChanged ()

void	metricsChanged ()

void	renderTypeChanged ()

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
	QQuickTextMetrics (QObject *parent=nullptr)
	\qmltype TextMetrics \instantiates QQuickTextMetrics \inqmlmodule QtQuick

QFont	font () const
	\qmlproperty font QtQuick::TextMetrics::font

void	setFont (const QFont &font)

QString	text () const
	\qmlproperty string QtQuick::TextMetrics::text

void	setText (const QString &text)

Qt::TextElideMode	elide () const
	\qmlproperty enumeration QtQuick::TextMetrics::elide

void	setElide (Qt::TextElideMode elide)

qreal	elideWidth () const
	\qmlproperty real QtQuick::TextMetrics::elideWidth

void	setElideWidth (qreal elideWidth)

qreal	advanceWidth () const
	\qmlproperty real QtQuick::TextMetrics::advanceWidth

QRectF	boundingRect () const
	\qmlproperty rect QtQuick::TextMetrics::boundingRect

qreal	width () const
	\qmlproperty real QtQuick::TextMetrics::width

qreal	height () const
	\qmlproperty real QtQuick::TextMetrics::height

QRectF	tightBoundingRect () const
	\qmlproperty rect QtQuick::TextMetrics::tightBoundingRect

QString	elidedText () const
	\qmlproperty string QtQuick::TextMetrics::elidedText

QQuickText::RenderType	renderType () const
	\qmlproperty enumeration QtQuick::TextMetrics::renderType

void	setRenderType (QQuickText::RenderType renderType)

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`.

Properties
QFont	font

QString	text

qreal	advanceWidth

QRectF	boundingRect

qreal	width

qreal	height

QRectF	tightBoundingRect

QString	elidedText

Qt::TextElideMode	elide

qreal	elideWidth

QQuickText::RenderType	renderType

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 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)

Detailed Description

Definition at line 31 of file qquicktextmetrics_p.h.

Constructor & Destructor Documentation

◆ QQuickTextMetrics()

QT_BEGIN_NAMESPACE QQuickTextMetrics::QQuickTextMetrics ( QObject * parent = nullptr )

explicit

\qmltype TextMetrics \instantiates QQuickTextMetrics \inqmlmodule QtQuick

Since: 5.4

Provides metrics for a given font and text.

TextMetrics calculates various properties of a given string of text for a particular font.

It provides a declarative API for the functions in \l QFontMetricsF which take arguments.

TextMetrics {
    id: textMetrics
    font.family: "Arial"
    elide: Text.ElideMiddle
    elideWidth: 100
    text: "Hello World"
}
 
MyItem {
    text: textMetrics.elidedText
}

See also: QFontMetricsF, FontMetrics

Definition at line 41 of file qquicktextmetrics.cpp.

Member Function Documentation

◆ advanceWidth()

qreal QQuickTextMetrics::advanceWidth ( ) const

\qmlproperty real QtQuick::TextMetrics::advanceWidth

This property holds the advance in pixels of the characters in \l text. This is the distance from the position of the string to where the next string should be drawn.

See also: {QFontMetricsF::horizontalAdvance()}

Definition at line 147 of file qquicktextmetrics.cpp.

References QFontMetricsF::horizontalAdvance(), QQuickText::QtRendering, and QTextOption::setUseDesignMetrics().

Here is the call graph for this function:

◆ boundingRect()

QRectF QQuickTextMetrics::boundingRect ( ) const

\qmlproperty rect QtQuick::TextMetrics::boundingRect

This property holds the bounding rectangle of the characters in the string specified by \l text.

See also: {QFontMetricsF::boundingRect()}, tightBoundingRect

Definition at line 162 of file qquicktextmetrics.cpp.

References QFontMetricsF::boundingRect(), QQuickText::QtRendering, and QTextOption::setUseDesignMetrics().

Here is the call graph for this function:

◆ elide()

Qt::TextElideMode QQuickTextMetrics::elide ( ) const

\qmlproperty enumeration QtQuick::TextMetrics::elide

This property holds the elide mode of the text. This determines the position in which the string is elided. The possible values are:

\value Qt::ElideNone No eliding; this is the default value. \value Qt::ElideLeft For example: "...World" \value Qt::ElideMiddle For example: "He...ld" \value Qt::ElideRight For example: "Hello..."

See also: elideWidth, QFontMetrics::elidedText

Definition at line 102 of file qquicktextmetrics.cpp.

◆ elideChanged

void QQuickTextMetrics::elideChanged ( )

signal

Referenced by setElide().

Here is the caller graph for this function:

◆ elidedText()

QString QQuickTextMetrics::elidedText ( ) const

\qmlproperty string QtQuick::TextMetrics::elidedText

This property holds an elided version of the string (i.e., a string with "..." in it) if the string \l text is wider than \l elideWidth. If the text is not wider than \l elideWidth, or \l elide is set to Qt::ElideNone, this property will be equal to the original string.

See also: {QFontMetricsF::elidedText()}

Definition at line 228 of file qquicktextmetrics.cpp.

References QFontMetricsF::elidedText().

Here is the call graph for this function:

◆ elideWidth()

qreal QQuickTextMetrics::elideWidth ( ) const

\qmlproperty real QtQuick::TextMetrics::elideWidth

This property holds the largest width the text can have (in pixels) before eliding will occur.

See also: elide, QFontMetrics::elidedText

Definition at line 124 of file qquicktextmetrics.cpp.

◆ elideWidthChanged

void QQuickTextMetrics::elideWidthChanged ( )

signal

Referenced by setElideWidth().

Here is the caller graph for this function:

◆ font()

QFont QQuickTextMetrics::font ( ) const

\qmlproperty font QtQuick::TextMetrics::font

This property holds the font used for the metrics calculations.

Definition at line 55 of file qquicktextmetrics.cpp.

◆ fontChanged

void QQuickTextMetrics::fontChanged ( )

signal

Referenced by setFont().

Here is the caller graph for this function:

◆ height()

qreal QQuickTextMetrics::height ( ) const

\qmlproperty real QtQuick::TextMetrics::height

This property holds the height of the bounding rectangle of the characters in the string specified by \l text. It is equivalent to:

textMetrics.boundingRect.height

See also: boundingRect

Definition at line 198 of file qquicktextmetrics.cpp.

References boundingRect, and QRectF::height().

Here is the call graph for this function:

◆ metricsChanged

void QQuickTextMetrics::metricsChanged ( )

signal

Referenced by setElide(), setElideWidth(), setFont(), and setText().

Here is the caller graph for this function:

◆ renderType()

QQuickText::RenderType QQuickTextMetrics::renderType ( ) const

\qmlproperty enumeration QtQuick::TextMetrics::renderType

Override the default rendering type for this component.

Supported render types are:

\value TextEdit.QtRendering Text is rendered using a scalable distance field for each glyph. \value TextEdit.NativeRendering Text is rendered using a platform-specific technique.

This should match the intended renderType where you draw the text.

Since: 6.3

See also: {Text::renderType}{Text.renderType}

Definition at line 248 of file qquicktextmetrics.cpp.

◆ renderTypeChanged

void QQuickTextMetrics::renderTypeChanged ( )

signal

Referenced by setRenderType().

Here is the caller graph for this function:

◆ setElide()

void QQuickTextMetrics::setElide ( Qt::TextElideMode elide )

Definition at line 107 of file qquicktextmetrics.cpp.

References elide, elideChanged(), emit, and metricsChanged().

Here is the call graph for this function:

◆ setElideWidth()

void QQuickTextMetrics::setElideWidth ( qreal elideWidth )

Definition at line 129 of file qquicktextmetrics.cpp.

References elideWidth, elideWidthChanged(), emit, and metricsChanged().

Here is the call graph for this function:

◆ setFont()

void QQuickTextMetrics::setFont ( const QFont & font )

Definition at line 60 of file qquicktextmetrics.cpp.

References emit, font, fontChanged(), and metricsChanged().

Here is the call graph for this function:

◆ setRenderType()

void QQuickTextMetrics::setRenderType ( QQuickText::RenderType renderType )

Definition at line 253 of file qquicktextmetrics.cpp.

References emit, renderType, and renderTypeChanged().

Here is the call graph for this function:

◆ setText()

void QQuickTextMetrics::setText ( const QString & text )

Definition at line 80 of file qquicktextmetrics.cpp.

References emit, metricsChanged(), text, and textChanged().

Here is the call graph for this function:

◆ text()

QString QQuickTextMetrics::text ( ) const

\qmlproperty string QtQuick::TextMetrics::text

This property holds the text used for the metrics calculations.

Definition at line 75 of file qquicktextmetrics.cpp.

◆ textChanged

void QQuickTextMetrics::textChanged ( )

signal

Referenced by setText().

Here is the caller graph for this function:

◆ tightBoundingRect()

QRectF QQuickTextMetrics::tightBoundingRect ( ) const

\qmlproperty rect QtQuick::TextMetrics::tightBoundingRect

This property holds a tight bounding rectangle around the characters in the string specified by \l text.

See also: {QFontMetricsF::tightBoundingRect()}, boundingRect

Definition at line 211 of file qquicktextmetrics.cpp.

References QQuickText::QtRendering, QTextOption::setUseDesignMetrics(), and QFontMetricsF::tightBoundingRect().

Here is the call graph for this function:

◆ width()

qreal QQuickTextMetrics::width ( ) const

\qmlproperty real QtQuick::TextMetrics::width

This property holds the width of the bounding rectangle of the characters in the string specified by \l text. It is equivalent to:

textMetrics.boundingRect.width

See also: boundingRect

Definition at line 181 of file qquicktextmetrics.cpp.

References boundingRect, and QRectF::width().

Here is the call graph for this function:

Property Documentation

◆ advanceWidth

qreal QQuickTextMetrics::advanceWidth

read

Definition at line 37 of file qquicktextmetrics_p.h.

◆ boundingRect

QRectF QQuickTextMetrics::boundingRect

read

Definition at line 38 of file qquicktextmetrics_p.h.

Referenced by height(), and width().

◆ elide

Qt::TextElideMode QQuickTextMetrics::elide

readwrite

Definition at line 43 of file qquicktextmetrics_p.h.

Referenced by setElide().

◆ elidedText

QString QQuickTextMetrics::elidedText

read

Definition at line 42 of file qquicktextmetrics_p.h.

◆ elideWidth

qreal QQuickTextMetrics::elideWidth

readwrite

Definition at line 44 of file qquicktextmetrics_p.h.

Referenced by setElideWidth().

◆ font

QFont QQuickTextMetrics::font

readwrite

Definition at line 35 of file qquicktextmetrics_p.h.

Referenced by setFont().

◆ height

qreal QQuickTextMetrics::height

read

Definition at line 40 of file qquicktextmetrics_p.h.

◆ renderType

QQuickText::RenderType QQuickTextMetrics::renderType

readwrite

Definition at line 45 of file qquicktextmetrics_p.h.

Referenced by setRenderType().

◆ text

QString QQuickTextMetrics::text

readwrite

Definition at line 36 of file qquicktextmetrics_p.h.

Referenced by setText().

◆ tightBoundingRect

QRectF QQuickTextMetrics::tightBoundingRect

read

Definition at line 41 of file qquicktextmetrics_p.h.

◆ width

qreal QQuickTextMetrics::width

read

Definition at line 39 of file qquicktextmetrics_p.h.

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

qtdeclarative/src/quick/util/qquicktextmetrics_p.h (9dd45fff835a7c261dacc9ee6239d42ef1a74bbe)
qtdeclarative/src/quick/util/qquicktextmetrics.cpp (2a6151097e0dffc3722023b206c35d6535354096)

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickTextMetrics()

Member Function Documentation

◆ advanceWidth()

◆ boundingRect()

◆ elide()

◆ elideChanged

◆ elidedText()

◆ elideWidth()

◆ elideWidthChanged

◆ font()

◆ fontChanged

◆ height()

◆ metricsChanged

◆ renderType()

◆ renderTypeChanged

◆ setElide()

◆ setElideWidth()

◆ setFont()

◆ setRenderType()

◆ setText()

◆ text()

◆ textChanged

◆ tightBoundingRect()

◆ width()

Property Documentation

◆ advanceWidth

◆ boundingRect

◆ elide

◆ elidedText

◆ elideWidth

◆ font

◆ height

◆ renderType

◆ text

◆ tightBoundingRect

◆ width