#include <qquickfontmetrics_p.h>

Inheritance diagram for QQuickFontMetrics:

Collaboration diagram for QQuickFontMetrics:

Signals
void	fontChanged (const QFont &font)

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

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

void	setFont (const QFont &font)

qreal	ascent () const
	\qmlproperty real QtQuick::FontMetrics::ascent

qreal	descent () const
	\qmlproperty real QtQuick::FontMetrics::descent

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

qreal	leading () const
	\qmlproperty real QtQuick::FontMetrics::leading

qreal	lineSpacing () const
	\qmlproperty real QtQuick::FontMetrics::lineSpacing

qreal	minimumLeftBearing () const
	\qmlproperty real QtQuick::FontMetrics::minimumLeftBearing

qreal	minimumRightBearing () const
	\qmlproperty real QtQuick::FontMetrics::minimumRightBearing

qreal	maximumCharacterWidth () const
	\qmlproperty real QtQuick::FontMetrics::maximumCharacterWidth

qreal	xHeight () const
	\qmlproperty real QtQuick::FontMetrics::xHeight

qreal	averageCharacterWidth () const
	\qmlproperty real QtQuick::FontMetrics::averageCharacterWidth

qreal	underlinePosition () const
	\qmlproperty real QtQuick::FontMetrics::underlinePosition

qreal	overlinePosition () const
	\qmlproperty real QtQuick::FontMetrics::overlinePosition

qreal	strikeOutPosition () const
	\qmlproperty real QtQuick::FontMetrics::strikeOutPosition

qreal	lineWidth () const
	\qmlproperty real QtQuick::FontMetrics::lineWidth

Q_INVOKABLE qreal	advanceWidth (const QString &text) const
	\qmlmethod qreal QtQuick::FontMetrics::advanceWidth(string text)

Q_INVOKABLE QRectF	boundingRect (const QString &text) const
	\qmlmethod rect QtQuick::FontMetrics::boundingRect(string text)

Q_INVOKABLE QRectF	tightBoundingRect (const QString &text) const
	\qmlmethod rect QtQuick::FontMetrics::tightBoundingRect(string text)

Q_INVOKABLE QString	elidedText (const QString &text, Qt::TextElideMode mode, qreal width, int flags=0) const
	\qmlmethod string QtQuick::FontMetrics::elidedText(string text, enumeration mode, real width, int flags)

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

qreal	ascent

qreal	descent

qreal	height

qreal	leading

qreal	lineSpacing

qreal	minimumLeftBearing

qreal	minimumRightBearing

qreal	maximumCharacterWidth

qreal	xHeight

qreal	averageCharacterWidth

qreal	underlinePosition

qreal	overlinePosition

qreal	strikeOutPosition

qreal	lineWidth

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 30 of file qquickfontmetrics_p.h.

Constructor & Destructor Documentation

◆ QQuickFontMetrics()

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

explicit

\qmltype FontMetrics \instantiates QQuickFontMetrics \inqmlmodule QtQuick

Since: 5.4

Provides metrics for a given font.

FontMetrics calculates the size of characters and strings for a given font.

It provides a subset of the C++ \l QFontMetricsF API, with the added ability to change the font that is used for calculations via the \l font property.

FontMetrics {
    id: fontMetrics
    font.family: "Arial"
}
 
Rectangle {
    width: fontMetrics.height * 4
    height: fontMetrics.height * 2
}

See also: QFontMetricsF, TextMetrics

Definition at line 38 of file qquickfontmetrics.cpp.

Member Function Documentation

◆ advanceWidth()

qreal QQuickFontMetrics::advanceWidth ( const QString & text ) const

\qmlmethod qreal QtQuick::FontMetrics::advanceWidth(string text)

This method returns the advance in pixels of the characters in text. This is the distance from the position of the string to where the next string should be drawn.

This method is offered as an imperative alternative to the \l {QtQuick::TextMetrics::advanceWidth}{advanceWidth} property of TextMetrics.

See also: {QFontMetricsF::horizontalAdvance()}, {QFontMetricsF::height()}

Definition at line 248 of file qquickfontmetrics.cpp.

References QFontMetricsF::horizontalAdvance(), and text.

Here is the call graph for this function:

◆ ascent()

qreal QQuickFontMetrics::ascent ( ) const

\qmlproperty real QtQuick::FontMetrics::ascent

This property holds the ascent of the font.

See also: {QFontMetricsF::ascent()}, descent, height

Definition at line 70 of file qquickfontmetrics.cpp.

References QFontMetricsF::ascent().

Here is the call graph for this function:

◆ averageCharacterWidth()

qreal QQuickFontMetrics::averageCharacterWidth ( ) const

\qmlproperty real QtQuick::FontMetrics::averageCharacterWidth

This property holds the average width of glyphs in the font.

See also: {QFontMetricsF::averageCharWidth()}

Definition at line 178 of file qquickfontmetrics.cpp.

References QFontMetricsF::averageCharWidth().

Here is the call graph for this function:

◆ boundingRect()

QRectF QQuickFontMetrics::boundingRect ( const QString & text ) const

\qmlmethod rect QtQuick::FontMetrics::boundingRect(string text)

This method returns the bounding rectangle of the characters in the string specified by text.

This method is offered as an imperative alternative to the \l {QtQuick::TextMetrics::boundingRect}{boundingRect} property of TextMetrics.

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

Definition at line 265 of file qquickfontmetrics.cpp.

References QFontMetricsF::boundingRect(), and text.

Here is the call graph for this function:

◆ descent()

qreal QQuickFontMetrics::descent ( ) const

\qmlproperty real QtQuick::FontMetrics::descent

This property holds the descent of the font.

See also: {QFontMetricsF::descent()}, ascent, height

Definition at line 82 of file qquickfontmetrics.cpp.

References QFontMetricsF::descent().

Here is the call graph for this function:

◆ elidedText()

QString QQuickFontMetrics::elidedText	(	const QString &	text,
		Qt::TextElideMode	mode,
		qreal	width,
		int	flags = 0 ) const

\qmlmethod string QtQuick::FontMetrics::elidedText(string text, enumeration mode, real width, int flags)

This method returns an elided version of the string (i.e., a string with "..." in it) if the string text is wider than width. Otherwise, returns the original string.

The mode argument specifies the text elide mode; that is, where the ellipsis should appear when displaying text that doesn't fit.

The flags argument is optional and currently only supports \l {Qt::TextShowMnemonic}.

This method is offered as an imperative alternative to the \l {QtQuick::TextMetrics::elidedText}{elidedText} property of TextMetrics.

See also: Qt::TextElideMode, QFontMetricsF::elidedText()

Definition at line 306 of file qquickfontmetrics.cpp.

References QFontMetricsF::elidedText(), and text.

Here is the call graph for this function:

◆ font()

QFont QQuickFontMetrics::font ( ) const

\qmlproperty font QtQuick::FontMetrics::font

This property holds the font used for the metrics calculations.

Definition at line 49 of file qquickfontmetrics.cpp.

◆ fontChanged

void QQuickFontMetrics::fontChanged ( const QFont & font )

signal

Referenced by setFont().

Here is the caller graph for this function:

◆ height()

qreal QQuickFontMetrics::height ( ) const

\qmlproperty real QtQuick::FontMetrics::height

This property holds the height of the font.

See also: {QFontMetricsF::height()}

Definition at line 94 of file qquickfontmetrics.cpp.

References QFontMetricsF::height().

Here is the call graph for this function:

◆ leading()

qreal QQuickFontMetrics::leading ( ) const

\qmlproperty real QtQuick::FontMetrics::leading

This property holds the leading of the font.

See also: {QFontMetricsF::leading()}

Definition at line 106 of file qquickfontmetrics.cpp.

References QFontMetricsF::leading().

Here is the call graph for this function:

◆ lineSpacing()

qreal QQuickFontMetrics::lineSpacing ( ) const

\qmlproperty real QtQuick::FontMetrics::lineSpacing

This property holds the distance from one base line to the next.

See also: {QFontMetricsF::lineSpacing()}

Definition at line 118 of file qquickfontmetrics.cpp.

References QFontMetricsF::lineSpacing().

Here is the call graph for this function:

◆ lineWidth()

qreal QQuickFontMetrics::lineWidth ( ) const

\qmlproperty real QtQuick::FontMetrics::lineWidth

This property holds the width of the underline and strikeout lines, adjusted for the point size of the font.

See also: {QFontMetricsF::lineWidth()}

Definition at line 230 of file qquickfontmetrics.cpp.

References QFontMetricsF::lineWidth().

Here is the call graph for this function:

◆ maximumCharacterWidth()

qreal QQuickFontMetrics::maximumCharacterWidth ( ) const

\qmlproperty real QtQuick::FontMetrics::maximumCharacterWidth

This property holds the width of the widest character in the font.

See also: {QFontMetricsF::maxWidth()}

Definition at line 154 of file qquickfontmetrics.cpp.

References QFontMetricsF::maxWidth().

Here is the call graph for this function:

◆ minimumLeftBearing()

qreal QQuickFontMetrics::minimumLeftBearing ( ) const

\qmlproperty real QtQuick::FontMetrics::minimumLeftBearing

This property holds the minimum left bearing of the font.

See also: {QFontMetricsF::minLeftBearing()}

Definition at line 130 of file qquickfontmetrics.cpp.

References QFontMetricsF::minLeftBearing().

Here is the call graph for this function:

◆ minimumRightBearing()

qreal QQuickFontMetrics::minimumRightBearing ( ) const

\qmlproperty real QtQuick::FontMetrics::minimumRightBearing

This property holds the minimum right bearing of the font.

See also: {QFontMetricsF::minRightBearing()}

Definition at line 142 of file qquickfontmetrics.cpp.

References QFontMetricsF::minRightBearing().

Here is the call graph for this function:

◆ overlinePosition()

qreal QQuickFontMetrics::overlinePosition ( ) const

\qmlproperty real QtQuick::FontMetrics::overlinePosition

This property holds the distance from the base line to where an overline should be drawn.

See also: {QFontMetricsF::overlinePos()}, underlinePosition, strikeOutPosition

Definition at line 204 of file qquickfontmetrics.cpp.

References QFontMetricsF::overlinePos().

Here is the call graph for this function:

◆ setFont()

void QQuickFontMetrics::setFont ( const QFont & font )

Definition at line 54 of file qquickfontmetrics.cpp.

References emit, font, and fontChanged().

Here is the call graph for this function:

◆ strikeOutPosition()

qreal QQuickFontMetrics::strikeOutPosition ( ) const

\qmlproperty real QtQuick::FontMetrics::strikeOutPosition

This property holds the distance from the base line to where the strikeout line should be drawn.

See also: {QFontMetricsF::strikeOutPos()}, overlinePosition, underlinePosition

Definition at line 217 of file qquickfontmetrics.cpp.

References QFontMetricsF::strikeOutPos().

Here is the call graph for this function:

◆ tightBoundingRect()

QRectF QQuickFontMetrics::tightBoundingRect ( const QString & text ) const

\qmlmethod rect QtQuick::FontMetrics::tightBoundingRect(string text)

This method returns a tight bounding rectangle around the characters in the string specified by text.

This method is offered as an imperative alternative to the \l {QtQuick::TextMetrics::tightBoundingRect}{tightBoundingRect} property of TextMetrics.

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

Definition at line 282 of file qquickfontmetrics.cpp.

References text, and QFontMetricsF::tightBoundingRect().

Here is the call graph for this function:

◆ underlinePosition()

qreal QQuickFontMetrics::underlinePosition ( ) const

\qmlproperty real QtQuick::FontMetrics::underlinePosition

This property holds the distance from the base line to where an underscore should be drawn.

See also: {QFontMetricsF::underlinePos()}, overlinePosition, strikeOutPosition

Definition at line 191 of file qquickfontmetrics.cpp.

References QFontMetricsF::underlinePos().

Here is the call graph for this function:

◆ xHeight()

qreal QQuickFontMetrics::xHeight ( ) const

\qmlproperty real QtQuick::FontMetrics::xHeight

This property holds the 'x' height of the font.

See also: {QFontMetricsF::xHeight()}

Definition at line 166 of file qquickfontmetrics.cpp.

References QFontMetricsF::xHeight().

Here is the call graph for this function:

Property Documentation

◆ ascent

qreal QQuickFontMetrics::ascent

read

Definition at line 35 of file qquickfontmetrics_p.h.

◆ averageCharacterWidth

qreal QQuickFontMetrics::averageCharacterWidth

read

Definition at line 44 of file qquickfontmetrics_p.h.

◆ descent

qreal QQuickFontMetrics::descent

read

Definition at line 36 of file qquickfontmetrics_p.h.

◆ font

QFont QQuickFontMetrics::font

readwrite

Definition at line 34 of file qquickfontmetrics_p.h.

Referenced by setFont().

◆ height

qreal QQuickFontMetrics::height

read

Definition at line 37 of file qquickfontmetrics_p.h.

◆ leading

qreal QQuickFontMetrics::leading

read

Definition at line 38 of file qquickfontmetrics_p.h.

◆ lineSpacing

qreal QQuickFontMetrics::lineSpacing

read

Definition at line 39 of file qquickfontmetrics_p.h.

◆ lineWidth

qreal QQuickFontMetrics::lineWidth

read

Definition at line 48 of file qquickfontmetrics_p.h.

◆ maximumCharacterWidth

qreal QQuickFontMetrics::maximumCharacterWidth

read

Definition at line 42 of file qquickfontmetrics_p.h.

◆ minimumLeftBearing

qreal QQuickFontMetrics::minimumLeftBearing

read

Definition at line 40 of file qquickfontmetrics_p.h.

◆ minimumRightBearing

qreal QQuickFontMetrics::minimumRightBearing

read

Definition at line 41 of file qquickfontmetrics_p.h.

◆ overlinePosition

qreal QQuickFontMetrics::overlinePosition

read

Definition at line 46 of file qquickfontmetrics_p.h.

◆ strikeOutPosition

qreal QQuickFontMetrics::strikeOutPosition

read

Definition at line 47 of file qquickfontmetrics_p.h.

◆ underlinePosition

qreal QQuickFontMetrics::underlinePosition

read

Definition at line 45 of file qquickfontmetrics_p.h.

◆ xHeight

qreal QQuickFontMetrics::xHeight

read

Definition at line 43 of file qquickfontmetrics_p.h.

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

qtdeclarative/src/quick/util/qquickfontmetrics_p.h (bd131dcbf579f822ac8cee98324dc1355f7cd314)
qtdeclarative/src/quick/util/qquickfontmetrics.cpp (0dc4fd240a2897c5c443a0ef6d84c416843e4938)

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickFontMetrics()

Member Function Documentation

◆ advanceWidth()

◆ ascent()

◆ averageCharacterWidth()

◆ boundingRect()

◆ descent()

◆ elidedText()

◆ font()

◆ fontChanged

◆ height()

◆ leading()

◆ lineSpacing()

◆ lineWidth()

◆ maximumCharacterWidth()

◆ minimumLeftBearing()

◆ minimumRightBearing()

◆ overlinePosition()

◆ setFont()

◆ strikeOutPosition()

◆ tightBoundingRect()

◆ underlinePosition()

◆ xHeight()

Property Documentation

◆ ascent

◆ averageCharacterWidth

◆ descent

◆ font

◆ height

◆ leading

◆ lineSpacing

◆ lineWidth

◆ maximumCharacterWidth

◆ minimumLeftBearing

◆ minimumRightBearing

◆ overlinePosition

◆ strikeOutPosition

◆ underlinePosition

◆ xHeight