API reference - Class QFontMetrics

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QFontMetrics

Public constructors

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

Public methods

[const]bool!=(const QFontMetrics other)Method bool QFontMetrics::operator !=(const QFontMetrics &other)
[const]bool==(const QFontMetrics other)Method bool QFontMetrics::operator==(const QFontMetrics &other)
void_assign(const QFontMetrics other)Assigns another object 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]intascentMethod int QFontMetrics::ascent()
QFontMetricsassign(const QFontMetrics arg1)Method QFontMetrics &QFontMetrics::operator=(const QFontMetrics &)
[const]intaverageCharWidthMethod int QFontMetrics::averageCharWidth()
[const]QRectboundingRect(unsigned int arg1)Method QRect QFontMetrics::boundingRect(QChar)
[const]QRectboundingRect(string text)Method QRect QFontMetrics::boundingRect(const QString &text)
[const]QRectboundingRect(const QRect r,
int flags,
string text,
int tabstops = 0,
int ptr tabarray = 0)
Method QRect QFontMetrics::boundingRect(const QRect &r, int flags, const QString &text, int tabstops, int *tabarray)
[const]QRectboundingRect(int x,
int y,
int w,
int h,
int flags,
string text,
int tabstops = 0,
int ptr tabarray = 0)
Method QRect QFontMetrics::boundingRect(int x, int y, int w, int h, int flags, const QString &text, int tabstops, int *tabarray)
[const]intcharWidth(string str,
int pos)
Method int QFontMetrics::charWidth(const QString &str, int pos)
[const]intdescentMethod int QFontMetrics::descent()
[const]new QFontMetrics ptrdupCreates a copy of self
[const]stringelidedText(string text,
const Qt_TextElideMode mode,
int width,
int flags = 0)
Method QString QFontMetrics::elidedText(const QString &text, Qt::TextElideMode mode, int width, int flags)
[const]intheightMethod int QFontMetrics::height()
[const]boolinFont(unsigned int arg1)Method bool QFontMetrics::inFont(QChar)
[const]boolinFontUcs4(unsigned int ucs4)Method bool QFontMetrics::inFontUcs4(unsigned int ucs4)
[const]intleadingMethod int QFontMetrics::leading()
[const]intleftBearing(unsigned int arg1)Method int QFontMetrics::leftBearing(QChar)
[const]intlineSpacingMethod int QFontMetrics::lineSpacing()
[const]intlineWidthMethod int QFontMetrics::lineWidth()
[const]intmaxWidthMethod int QFontMetrics::maxWidth()
[const]intminLeftBearingMethod int QFontMetrics::minLeftBearing()
[const]intminRightBearingMethod int QFontMetrics::minRightBearing()
[const]intoverlinePosMethod int QFontMetrics::overlinePos()
[const]intrightBearing(unsigned int arg1)Method int QFontMetrics::rightBearing(QChar)
[const]QSizesize(int flags,
string str,
int tabstops = 0,
int ptr tabarray = 0)
Method QSize QFontMetrics::size(int flags, const QString &str, int tabstops, int *tabarray)
[const]intstrikeOutPosMethod int QFontMetrics::strikeOutPos()
voidswap(QFontMetrics other)Method void QFontMetrics::swap(QFontMetrics &other)
[const]QRecttightBoundingRect(string text)Method QRect QFontMetrics::tightBoundingRect(const QString &text)
[const]intunderlinePosMethod int QFontMetrics::underlinePos()
[const]intwidth(string arg1,
int len = -1)
Method int QFontMetrics::width(const QString &, int len)
[const]intwidth(string arg1,
int len,
int flags)
Method int QFontMetrics::width(const QString &, int len, int flags)
[const]intwidth(unsigned int arg1)Method int QFontMetrics::width(QChar)
[const]intxHeightMethod int QFontMetrics::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 QFontMetrics other)

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

==

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

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

_assign

Signature: void _assign (const QFontMetrics other)

Description: Assigns another object to self

_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] int ascent

Description: Method int QFontMetrics::ascent()

assign

Signature: QFontMetrics assign (const QFontMetrics arg1)

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

averageCharWidth

Signature: [const] int averageCharWidth

Description: Method int QFontMetrics::averageCharWidth()

boundingRect

(1) Signature: [const] QRect boundingRect (unsigned int arg1)

Description: Method QRect QFontMetrics::boundingRect(QChar)

(2) Signature: [const] QRect boundingRect (string text)

Description: Method QRect QFontMetrics::boundingRect(const QString &text)

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

Description: Method QRect QFontMetrics::boundingRect(const QRect &r, int flags, const QString &text, int tabstops, int *tabarray)

(4) Signature: [const] QRect boundingRect (int x, int y, int w, int h, int flags, string text, int tabstops = 0, int ptr tabarray = 0)

Description: Method QRect QFontMetrics::boundingRect(int x, int y, int w, int h, int flags, const QString &text, int tabstops, int *tabarray)

charWidth

Signature: [const] int charWidth (string str, int pos)

Description: Method int QFontMetrics::charWidth(const QString &str, int pos)

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] int descent

Description: Method int QFontMetrics::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 QFontMetrics 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, int width, int flags = 0)

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

height

Signature: [const] int height

Description: Method int QFontMetrics::height()

inFont

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

Description: Method bool QFontMetrics::inFont(QChar)

inFontUcs4

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

Description: Method bool QFontMetrics::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] int leading

Description: Method int QFontMetrics::leading()

leftBearing

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

Description: Method int QFontMetrics::leftBearing(QChar)

lineSpacing

Signature: [const] int lineSpacing

Description: Method int QFontMetrics::lineSpacing()

lineWidth

Signature: [const] int lineWidth

Description: Method int QFontMetrics::lineWidth()

maxWidth

Signature: [const] int maxWidth

Description: Method int QFontMetrics::maxWidth()

minLeftBearing

Signature: [const] int minLeftBearing

Description: Method int QFontMetrics::minLeftBearing()

minRightBearing

Signature: [const] int minRightBearing

Description: Method int QFontMetrics::minRightBearing()

new

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

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

This method creates an object of class QFontMetrics.

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

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

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

This method creates an object of class QFontMetrics.

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

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

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

This method creates an object of class QFontMetrics.

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

overlinePos

Signature: [const] int overlinePos

Description: Method int QFontMetrics::overlinePos()

rightBearing

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

Description: Method int QFontMetrics::rightBearing(QChar)

size

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

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

strikeOutPos

Signature: [const] int strikeOutPos

Description: Method int QFontMetrics::strikeOutPos()

swap

Signature: void swap (QFontMetrics other)

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

tightBoundingRect

Signature: [const] QRect tightBoundingRect (string text)

Description: Method QRect QFontMetrics::tightBoundingRect(const QString &text)

underlinePos

Signature: [const] int underlinePos

Description: Method int QFontMetrics::underlinePos()

width

(1) Signature: [const] int width (string arg1, int len = -1)

Description: Method int QFontMetrics::width(const QString &, int len)

(2) Signature: [const] int width (string arg1, int len, int flags)

Description: Method int QFontMetrics::width(const QString &, int len, int flags)

(3) Signature: [const] int width (unsigned int arg1)

Description: Method int QFontMetrics::width(QChar)

xHeight

Signature: [const] int xHeight

Description: Method int QFontMetrics::xHeight()