KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QFontMetricsF

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QFontMetricsF

Public constructors

new QFontMetricsFnew(const QFont arg1)Constructor QFontMetricsF::QFontMetricsF(const QFont &)
new QFontMetricsFnew(const QFont arg1,
QPaintDevice ptr pd)
Constructor QFontMetricsF::QFontMetricsF(const QFont &, QPaintDevice *pd)
new QFontMetricsFnew(const QFontMetrics arg1)Constructor QFontMetricsF::QFontMetricsF(const QFontMetrics &)
new QFontMetricsFnew(const QFontMetricsF arg1)Constructor QFontMetricsF::QFontMetricsF(const QFontMetricsF &)

Public methods

[const]bool!=(const QFontMetricsF other)Method bool QFontMetricsF::operator !=(const QFontMetricsF &other)
[const]bool==(const QFontMetricsF other)Method bool QFontMetricsF::operator==(const QFontMetricsF &other)
void_assign(const QFontMetricsF other)Assigns another object to self
[const]QFontMetricsF ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]doubleascentMethod double QFontMetricsF::ascent()
QFontMetricsFassign(const QFontMetricsF arg1)Method QFontMetricsF &QFontMetricsF::operator=(const QFontMetricsF &)
QFontMetricsFassign(const QFontMetrics arg1)Method QFontMetricsF &QFontMetricsF::operator=(const QFontMetrics &)
[const]doubleaverageCharWidthMethod double QFontMetricsF::averageCharWidth()
[const]QRectFboundingRect(string string)Method QRectF QFontMetricsF::boundingRect(const QString &string)
[const]QRectFboundingRect(unsigned int arg1)Method QRectF QFontMetricsF::boundingRect(QChar)
[const]QRectFboundingRect(const QRectF r,
int flags,
string string,
int tabstops = 0,
int ptr tabarray = nullptr)
Method QRectF QFontMetricsF::boundingRect(const QRectF &r, int flags, const QString &string, int tabstops, int *tabarray)
[const]doublecapHeightMethod double QFontMetricsF::capHeight()
[const]doubledescentMethod double QFontMetricsF::descent()
[const]new QFontMetricsF ptrdupCreates a copy of self
[const]stringelidedText(string text,
const Qt_TextElideMode mode,
double width,
int flags = 0)
Method QString QFontMetricsF::elidedText(const QString &text, Qt::TextElideMode mode, double width, int flags)
[const]doubleheightMethod double QFontMetricsF::height()
[const]doublehorizontalAdvance(string string,
int length = -1)
Method double QFontMetricsF::horizontalAdvance(const QString &string, int length)
[const]doublehorizontalAdvance(unsigned int arg1)Method double QFontMetricsF::horizontalAdvance(QChar)
[const]boolinFont(unsigned int arg1)Method bool QFontMetricsF::inFont(QChar)
[const]boolinFontUcs4(unsigned int ucs4)Method bool QFontMetricsF::inFontUcs4(unsigned int ucs4)
[const]doubleleadingMethod double QFontMetricsF::leading()
[const]doubleleftBearing(unsigned int arg1)Method double QFontMetricsF::leftBearing(QChar)
[const]doublelineSpacingMethod double QFontMetricsF::lineSpacing()
[const]doublelineWidthMethod double QFontMetricsF::lineWidth()
[const]doublemaxWidthMethod double QFontMetricsF::maxWidth()
[const]doubleminLeftBearingMethod double QFontMetricsF::minLeftBearing()
[const]doubleminRightBearingMethod double QFontMetricsF::minRightBearing()
[const]doubleoverlinePosMethod double QFontMetricsF::overlinePos()
[const]doublerightBearing(unsigned int arg1)Method double QFontMetricsF::rightBearing(QChar)
[const]QSizeFsize(int flags,
string str,
int tabstops = 0,
int ptr tabarray = nullptr)
Method QSizeF QFontMetricsF::size(int flags, const QString &str, int tabstops, int *tabarray)
[const]doublestrikeOutPosMethod double QFontMetricsF::strikeOutPos()
voidswap(QFontMetricsF other)Method void QFontMetricsF::swap(QFontMetricsF &other)
[const]QRectFtightBoundingRect(string text)Method QRectF QFontMetricsF::tightBoundingRect(const QString &text)
[const]doubleunderlinePosMethod double QFontMetricsF::underlinePos()
[const]doublewidth(string string)Method double QFontMetricsF::width(const QString &string)
[const]doublewidth(unsigned int arg1)Method double QFontMetricsF::width(QChar)
[const]doublexHeightMethod double QFontMetricsF::xHeight()

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const QFontMetricsF other)

Description: Method bool QFontMetricsF::operator !=(const QFontMetricsF &other)

==

Signature: [const] bool == (const QFontMetricsF other)

Description: Method bool QFontMetricsF::operator==(const QFontMetricsF &other)

_assign

Signature: void _assign (const QFontMetricsF other)

Description: Assigns another object to self

_const_cast

Signature: [const] QFontMetricsF ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

ascent

Signature: [const] double ascent

Description: Method double QFontMetricsF::ascent()

assign

(1) Signature: QFontMetricsF assign (const QFontMetricsF arg1)

Description: Method QFontMetricsF &QFontMetricsF::operator=(const QFontMetricsF &)

(2) Signature: QFontMetricsF assign (const QFontMetrics arg1)

Description: Method QFontMetricsF &QFontMetricsF::operator=(const QFontMetrics &)

averageCharWidth

Signature: [const] double averageCharWidth

Description: Method double QFontMetricsF::averageCharWidth()

boundingRect

(1) Signature: [const] QRectF boundingRect (string string)

Description: Method QRectF QFontMetricsF::boundingRect(const QString &string)

(2) Signature: [const] QRectF boundingRect (unsigned int arg1)

Description: Method QRectF QFontMetricsF::boundingRect(QChar)

(3) Signature: [const] QRectF boundingRect (const QRectF r, int flags, string string, int tabstops = 0, int ptr tabarray = nullptr)

Description: Method QRectF QFontMetricsF::boundingRect(const QRectF &r, int flags, const QString &string, int tabstops, int *tabarray)

capHeight

Signature: [const] double capHeight

Description: Method double QFontMetricsF::capHeight()

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

descent

Signature: [const] double descent

Description: Method double QFontMetricsF::descent()

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

dup

Signature: [const] new QFontMetricsF ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

elidedText

Signature: [const] string elidedText (string text, const Qt_TextElideMode mode, double width, int flags = 0)

Description: Method QString QFontMetricsF::elidedText(const QString &text, Qt::TextElideMode mode, double width, int flags)

height

Signature: [const] double height

Description: Method double QFontMetricsF::height()

horizontalAdvance

(1) Signature: [const] double horizontalAdvance (string string, int length = -1)

Description: Method double QFontMetricsF::horizontalAdvance(const QString &string, int length)

(2) Signature: [const] double horizontalAdvance (unsigned int arg1)

Description: Method double QFontMetricsF::horizontalAdvance(QChar)

inFont

Signature: [const] bool inFont (unsigned int arg1)

Description: Method bool QFontMetricsF::inFont(QChar)

inFontUcs4

Signature: [const] bool inFontUcs4 (unsigned int ucs4)

Description: Method bool QFontMetricsF::inFontUcs4(unsigned int ucs4)

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

leading

Signature: [const] double leading

Description: Method double QFontMetricsF::leading()

leftBearing

Signature: [const] double leftBearing (unsigned int arg1)

Description: Method double QFontMetricsF::leftBearing(QChar)

lineSpacing

Signature: [const] double lineSpacing

Description: Method double QFontMetricsF::lineSpacing()

lineWidth

Signature: [const] double lineWidth

Description: Method double QFontMetricsF::lineWidth()

maxWidth

Signature: [const] double maxWidth

Description: Method double QFontMetricsF::maxWidth()

minLeftBearing

Signature: [const] double minLeftBearing

Description: Method double QFontMetricsF::minLeftBearing()

minRightBearing

Signature: [const] double minRightBearing

Description: Method double QFontMetricsF::minRightBearing()

new

(1) Signature: [static] new QFontMetricsF new (const QFont arg1)

Description: Constructor QFontMetricsF::QFontMetricsF(const QFont &)

This method creates an object of class QFontMetricsF.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QFontMetricsF new (const QFont arg1, QPaintDevice ptr pd)

Description: Constructor QFontMetricsF::QFontMetricsF(const QFont &, QPaintDevice *pd)

This method creates an object of class QFontMetricsF.

Python specific notes:
This method is the default initializer of the object.

(3) Signature: [static] new QFontMetricsF new (const QFontMetrics arg1)

Description: Constructor QFontMetricsF::QFontMetricsF(const QFontMetrics &)

This method creates an object of class QFontMetricsF.

Python specific notes:
This method is the default initializer of the object.

(4) Signature: [static] new QFontMetricsF new (const QFontMetricsF arg1)

Description: Constructor QFontMetricsF::QFontMetricsF(const QFontMetricsF &)

This method creates an object of class QFontMetricsF.

Python specific notes:
This method is the default initializer of the object.

overlinePos

Signature: [const] double overlinePos

Description: Method double QFontMetricsF::overlinePos()

rightBearing

Signature: [const] double rightBearing (unsigned int arg1)

Description: Method double QFontMetricsF::rightBearing(QChar)

size

Signature: [const] QSizeF size (int flags, string str, int tabstops = 0, int ptr tabarray = nullptr)

Description: Method QSizeF QFontMetricsF::size(int flags, const QString &str, int tabstops, int *tabarray)

strikeOutPos

Signature: [const] double strikeOutPos

Description: Method double QFontMetricsF::strikeOutPos()

swap

Signature: void swap (QFontMetricsF other)

Description: Method void QFontMetricsF::swap(QFontMetricsF &other)

tightBoundingRect

Signature: [const] QRectF tightBoundingRect (string text)

Description: Method QRectF QFontMetricsF::tightBoundingRect(const QString &text)

underlinePos

Signature: [const] double underlinePos

Description: Method double QFontMetricsF::underlinePos()

width

(1) Signature: [const] double width (string string)

Description: Method double QFontMetricsF::width(const QString &string)

(2) Signature: [const] double width (unsigned int arg1)

Description: Method double QFontMetricsF::width(QChar)

xHeight

Signature: [const] double xHeight

Description: Method double QFontMetricsF::xHeight()