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

API reference - Class QGlyphRun

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QGlyphRun

Sub-classes: GlyphRunFlag, QFlags_GlyphRunFlag

Public constructors

new QGlyphRunnewConstructor QGlyphRun::QGlyphRun()
new QGlyphRunnew(const QGlyphRun other)Constructor QGlyphRun::QGlyphRun(const QGlyphRun &other)

Public methods

[const]bool!=(const QGlyphRun other)Method bool QGlyphRun::operator!=(const QGlyphRun &other)
[const]bool==(const QGlyphRun other)Method bool QGlyphRun::operator==(const QGlyphRun &other)
void_assign(const QGlyphRun other)Assigns another object to self
[const]QGlyphRun 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.
QGlyphRunassign(const QGlyphRun other)Method QGlyphRun &QGlyphRun::operator=(const QGlyphRun &other)
[const]QRectFboundingRectMethod QRectF QGlyphRun::boundingRect()
voidboundingRect=(const QRectF boundingRect)Method void QGlyphRun::setBoundingRect(const QRectF &boundingRect)
voidclearMethod void QGlyphRun::clear()
[const]new QGlyphRun ptrdupCreates a copy of self
[const]QGlyphRun_QFlags_GlyphRunFlagflagsMethod QFlags<QGlyphRun::GlyphRunFlag> QGlyphRun::flags()
voidflags=(QGlyphRun_QFlags_GlyphRunFlag flags)Method void QGlyphRun::setFlags(QFlags<QGlyphRun::GlyphRunFlag> flags)
[const]unsigned int[]glyphIndexesMethod QVector<quint32> QGlyphRun::glyphIndexes()
voidglyphIndexes=(unsigned int[] glyphIndexes)Method void QGlyphRun::setGlyphIndexes(const QVector<quint32> &glyphIndexes)
[const]boolisEmpty?Method bool QGlyphRun::isEmpty()
[const]boolisRightToLeft?Method bool QGlyphRun::isRightToLeft()
[const]booloverlineMethod bool QGlyphRun::overline()
voidoverline=(bool overline)Method void QGlyphRun::setOverline(bool overline)
[const]QPointF[]positionsMethod QVector<QPointF> QGlyphRun::positions()
voidpositions=(QPointF[] positions)Method void QGlyphRun::setPositions(const QVector<QPointF> &positions)
[const]QRawFontrawFontMethod QRawFont QGlyphRun::rawFont()
voidrawFont=(const QRawFont rawFont)Method void QGlyphRun::setRawFont(const QRawFont &rawFont)
[const]boolrightToLeftMethod bool QGlyphRun::isRightToLeft()
voidrightToLeft=(bool on)Method void QGlyphRun::setRightToLeft(bool on)
voidsetBoundingRect(const QRectF boundingRect)Method void QGlyphRun::setBoundingRect(const QRectF &boundingRect)
voidsetFlag(const QGlyphRun_GlyphRunFlag flag,
bool enabled = true)
Method void QGlyphRun::setFlag(QGlyphRun::GlyphRunFlag flag, bool enabled)
voidsetFlags(QGlyphRun_QFlags_GlyphRunFlag flags)Method void QGlyphRun::setFlags(QFlags<QGlyphRun::GlyphRunFlag> flags)
voidsetGlyphIndexes(unsigned int[] glyphIndexes)Method void QGlyphRun::setGlyphIndexes(const QVector<quint32> &glyphIndexes)
voidsetOverline(bool overline)Method void QGlyphRun::setOverline(bool overline)
voidsetPositions(QPointF[] positions)Method void QGlyphRun::setPositions(const QVector<QPointF> &positions)
voidsetRawData(unsigned int ptr glyphIndexArray,
const QPointF ptr glyphPositionArray,
int size)
Method void QGlyphRun::setRawData(const quint32 *glyphIndexArray, const QPointF *glyphPositionArray, int size)
voidsetRawFont(const QRawFont rawFont)Method void QGlyphRun::setRawFont(const QRawFont &rawFont)
voidsetRightToLeft(bool on)Method void QGlyphRun::setRightToLeft(bool on)
voidsetStrikeOut(bool strikeOut)Method void QGlyphRun::setStrikeOut(bool strikeOut)
voidsetUnderline(bool underline)Method void QGlyphRun::setUnderline(bool underline)
[const]boolstrikeOutMethod bool QGlyphRun::strikeOut()
voidstrikeOut=(bool strikeOut)Method void QGlyphRun::setStrikeOut(bool strikeOut)
voidswap(QGlyphRun other)Method void QGlyphRun::swap(QGlyphRun &other)
[const]boolunderlineMethod bool QGlyphRun::underline()
voidunderline=(bool underline)Method void QGlyphRun::setUnderline(bool underline)

Public static methods and constants

[static,const]QGlyphRun_GlyphRunFlagOverlineEnum constant QGlyphRun::Overline
[static,const]QGlyphRun_GlyphRunFlagRightToLeftEnum constant QGlyphRun::RightToLeft
[static,const]QGlyphRun_GlyphRunFlagSplitLigatureEnum constant QGlyphRun::SplitLigature
[static,const]QGlyphRun_GlyphRunFlagStrikeOutEnum constant QGlyphRun::StrikeOut
[static,const]QGlyphRun_GlyphRunFlagUnderlineEnum constant QGlyphRun::Underline

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

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

==

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

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

Overline

Signature: [static,const] QGlyphRun_GlyphRunFlag Overline

Description: Enum constant QGlyphRun::Overline

Python specific notes:
The object exposes a readable attribute 'Overline'. This is the getter.

RightToLeft

Signature: [static,const] QGlyphRun_GlyphRunFlag RightToLeft

Description: Enum constant QGlyphRun::RightToLeft

Python specific notes:
The object exposes a readable attribute 'RightToLeft'. This is the getter.

SplitLigature

Signature: [static,const] QGlyphRun_GlyphRunFlag SplitLigature

Description: Enum constant QGlyphRun::SplitLigature

Python specific notes:
The object exposes a readable attribute 'SplitLigature'. This is the getter.

StrikeOut

Signature: [static,const] QGlyphRun_GlyphRunFlag StrikeOut

Description: Enum constant QGlyphRun::StrikeOut

Python specific notes:
The object exposes a readable attribute 'StrikeOut'. This is the getter.

Underline

Signature: [static,const] QGlyphRun_GlyphRunFlag Underline

Description: Enum constant QGlyphRun::Underline

Python specific notes:
The object exposes a readable attribute 'Underline'. This is the getter.

_assign

Signature: void _assign (const QGlyphRun other)

Description: Assigns another object to self

_const_cast

Signature: [const] QGlyphRun 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.

assign

Signature: QGlyphRun assign (const QGlyphRun other)

Description: Method QGlyphRun &QGlyphRun::operator=(const QGlyphRun &other)

boundingRect

Signature: [const] QRectF boundingRect

Description: Method QRectF QGlyphRun::boundingRect()

Python specific notes:
The object exposes a readable attribute 'boundingRect'. This is the getter.

boundingRect=

Signature: void boundingRect= (const QRectF boundingRect)

Description: Method void QGlyphRun::setBoundingRect(const QRectF &boundingRect)

Python specific notes:
The object exposes a writable attribute 'boundingRect'. This is the setter.

clear

Signature: void clear

Description: Method void QGlyphRun::clear()

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.

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 QGlyphRun ptr dup

Description: Creates a copy of self

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

flags

Signature: [const] QGlyphRun_QFlags_GlyphRunFlag flags

Description: Method QFlags<QGlyphRun::GlyphRunFlag> QGlyphRun::flags()

Python specific notes:
The object exposes a readable attribute 'flags'. This is the getter.

flags=

Signature: void flags= (QGlyphRun_QFlags_GlyphRunFlag flags)

Description: Method void QGlyphRun::setFlags(QFlags<QGlyphRun::GlyphRunFlag> flags)

Python specific notes:
The object exposes a writable attribute 'flags'. This is the setter.

glyphIndexes

Signature: [const] unsigned int[] glyphIndexes

Description: Method QVector<quint32> QGlyphRun::glyphIndexes()

Python specific notes:
The object exposes a readable attribute 'glyphIndexes'. This is the getter.

glyphIndexes=

Signature: void glyphIndexes= (unsigned int[] glyphIndexes)

Description: Method void QGlyphRun::setGlyphIndexes(const QVector<quint32> &glyphIndexes)

Python specific notes:
The object exposes a writable attribute 'glyphIndexes'. This is the setter.

isEmpty?

Signature: [const] bool isEmpty?

Description: Method bool QGlyphRun::isEmpty()

isRightToLeft?

Signature: [const] bool isRightToLeft?

Description: Method bool QGlyphRun::isRightToLeft()

Python specific notes:
The object exposes a readable attribute 'rightToLeft'. This is the getter.

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.

new

(1) Signature: [static] new QGlyphRun new

Description: Constructor QGlyphRun::QGlyphRun()

This method creates an object of class QGlyphRun.

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

(2) Signature: [static] new QGlyphRun new (const QGlyphRun other)

Description: Constructor QGlyphRun::QGlyphRun(const QGlyphRun &other)

This method creates an object of class QGlyphRun.

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

overline

Signature: [const] bool overline

Description: Method bool QGlyphRun::overline()

Python specific notes:
The object exposes a readable attribute 'overline'. This is the getter.

overline=

Signature: void overline= (bool overline)

Description: Method void QGlyphRun::setOverline(bool overline)

Python specific notes:
The object exposes a writable attribute 'overline'. This is the setter.

positions

Signature: [const] QPointF[] positions

Description: Method QVector<QPointF> QGlyphRun::positions()

Python specific notes:
The object exposes a readable attribute 'positions'. This is the getter.

positions=

Signature: void positions= (QPointF[] positions)

Description: Method void QGlyphRun::setPositions(const QVector<QPointF> &positions)

Python specific notes:
The object exposes a writable attribute 'positions'. This is the setter.

rawFont

Signature: [const] QRawFont rawFont

Description: Method QRawFont QGlyphRun::rawFont()

Python specific notes:
The object exposes a readable attribute 'rawFont'. This is the getter.

rawFont=

Signature: void rawFont= (const QRawFont rawFont)

Description: Method void QGlyphRun::setRawFont(const QRawFont &rawFont)

Python specific notes:
The object exposes a writable attribute 'rawFont'. This is the setter.

rightToLeft

Signature: [const] bool rightToLeft

Description: Method bool QGlyphRun::isRightToLeft()

Python specific notes:
The object exposes a readable attribute 'rightToLeft'. This is the getter.

rightToLeft=

Signature: void rightToLeft= (bool on)

Description: Method void QGlyphRun::setRightToLeft(bool on)

Python specific notes:
The object exposes a writable attribute 'rightToLeft'. This is the setter.

setBoundingRect

Signature: void setBoundingRect (const QRectF boundingRect)

Description: Method void QGlyphRun::setBoundingRect(const QRectF &boundingRect)

Python specific notes:
The object exposes a writable attribute 'boundingRect'. This is the setter.

setFlag

Signature: void setFlag (const QGlyphRun_GlyphRunFlag flag, bool enabled = true)

Description: Method void QGlyphRun::setFlag(QGlyphRun::GlyphRunFlag flag, bool enabled)

setFlags

Signature: void setFlags (QGlyphRun_QFlags_GlyphRunFlag flags)

Description: Method void QGlyphRun::setFlags(QFlags<QGlyphRun::GlyphRunFlag> flags)

Python specific notes:
The object exposes a writable attribute 'flags'. This is the setter.

setGlyphIndexes

Signature: void setGlyphIndexes (unsigned int[] glyphIndexes)

Description: Method void QGlyphRun::setGlyphIndexes(const QVector<quint32> &glyphIndexes)

Python specific notes:
The object exposes a writable attribute 'glyphIndexes'. This is the setter.

setOverline

Signature: void setOverline (bool overline)

Description: Method void QGlyphRun::setOverline(bool overline)

Python specific notes:
The object exposes a writable attribute 'overline'. This is the setter.

setPositions

Signature: void setPositions (QPointF[] positions)

Description: Method void QGlyphRun::setPositions(const QVector<QPointF> &positions)

Python specific notes:
The object exposes a writable attribute 'positions'. This is the setter.

setRawData

Signature: void setRawData (unsigned int ptr glyphIndexArray, const QPointF ptr glyphPositionArray, int size)

Description: Method void QGlyphRun::setRawData(const quint32 *glyphIndexArray, const QPointF *glyphPositionArray, int size)

setRawFont

Signature: void setRawFont (const QRawFont rawFont)

Description: Method void QGlyphRun::setRawFont(const QRawFont &rawFont)

Python specific notes:
The object exposes a writable attribute 'rawFont'. This is the setter.

setRightToLeft

Signature: void setRightToLeft (bool on)

Description: Method void QGlyphRun::setRightToLeft(bool on)

Python specific notes:
The object exposes a writable attribute 'rightToLeft'. This is the setter.

setStrikeOut

Signature: void setStrikeOut (bool strikeOut)

Description: Method void QGlyphRun::setStrikeOut(bool strikeOut)

Python specific notes:
The object exposes a writable attribute 'strikeOut'. This is the setter.

setUnderline

Signature: void setUnderline (bool underline)

Description: Method void QGlyphRun::setUnderline(bool underline)

Python specific notes:
The object exposes a writable attribute 'underline'. This is the setter.

strikeOut

Signature: [const] bool strikeOut

Description: Method bool QGlyphRun::strikeOut()

Python specific notes:
The object exposes a readable attribute 'strikeOut'. This is the getter.

strikeOut=

Signature: void strikeOut= (bool strikeOut)

Description: Method void QGlyphRun::setStrikeOut(bool strikeOut)

Python specific notes:
The object exposes a writable attribute 'strikeOut'. This is the setter.

swap

Signature: void swap (QGlyphRun other)

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

underline

Signature: [const] bool underline

Description: Method bool QGlyphRun::underline()

Python specific notes:
The object exposes a readable attribute 'underline'. This is the getter.

underline=

Signature: void underline= (bool underline)

Description: Method void QGlyphRun::setUnderline(bool underline)

Python specific notes:
The object exposes a writable attribute 'underline'. This is the setter.