KLayout Manual: Main Index » Class Index » API reference - Class QTextLine

API reference - Class QTextLine

Notation used in Ruby API documentation

Description: Binding of QTextLine

Sub-classes: CursorPosition, Edge

• Public constructors
• Public methods
• Public static methods and constants
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

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

Detailed description

[static,const] new QTextLine_CursorPosition ptr CursorBetweenCharacters

Description: Enum constant QTextLine::CursorBetweenCharacters

[static,const] new QTextLine_CursorPosition ptr CursorOnCharacter

Description: Enum constant QTextLine::CursorOnCharacter

[static,const] new QTextLine_Edge ptr Leading

Description: Enum constant QTextLine::Leading

[static,const] new QTextLine_Edge ptr Trailing

Description: Enum constant QTextLine::Trailing

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.

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.

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

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

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.

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.

[const] double ascent

Description: Method double QTextLine::ascent()

void assign(const QTextLine other)

Description: Assigns another object to self

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[const] double cursorToX(int ptr cursorPos,const QTextLine_Edge edge = QTextLine::Leading)

Description: Method double QTextLine::cursorToX(int *cursorPos, QTextLine::Edge edge)

[const] double cursorToX(int cursorPos,const QTextLine_Edge edge = QTextLine::Leading)

Description: Method double QTextLine::cursorToX(int cursorPos, QTextLine::Edge edge)

[const] double descent

Description: Method double QTextLine::descent()

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

[const] void draw(QPainter ptr p,const QPointF point,const QTextLayout_FormatRange ptr selection = 0)

Description: Method void QTextLine::draw(QPainter *p, const QPointF &point, const QTextLayout::FormatRange *selection)

[const] new QTextLine ptr dup

Description: Creates a copy of self

[const] double height

Description: Method double QTextLine::height()

[const] bool isValid?

Description: Method bool QTextLine::isValid()

[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

[const] double leading

Description: Method double QTextLine::leading()

[const] bool leadingIncluded

Description: Method bool QTextLine::leadingIncluded()

Python specific notes:

The object exposes a readable attribute 'leadingIncluded'. This is the getter.

void leadingIncluded=(bool included)

Description: Method void QTextLine::setLeadingIncluded(bool included)

Python specific notes:

The object exposes a writable attribute 'leadingIncluded'. This is the setter.

[const] int lineNumber

Description: Method int QTextLine::lineNumber()

[const] QRectF naturalTextRect

Description: Method QRectF QTextLine::naturalTextRect()

[const] double naturalTextWidth

Description: Method double QTextLine::naturalTextWidth()

[static] new QTextLine new

Description: Constructor QTextLine::QTextLine()

This method creates an object of class QTextLine.

Python specific notes:

This method is the default initializer of the object

[const] QPointF position

Description: Method QPointF QTextLine::position()

Python specific notes:

The object exposes a readable attribute 'position'. This is the getter.

void position=(const QPointF pos)

Description: Method void QTextLine::setPosition(const QPointF &pos)

Python specific notes:

The object exposes a writable attribute 'position'. This is the setter.

[const] QRectF rect

Description: Method QRectF QTextLine::rect()

void setLeadingIncluded(bool included)

Description: Method void QTextLine::setLeadingIncluded(bool included)

Python specific notes:

The object exposes a writable attribute 'leadingIncluded'. This is the setter.

void setLineWidth(double width)

Description: Method void QTextLine::setLineWidth(double width)

void setNumColumns(int columns)

Description: Method void QTextLine::setNumColumns(int columns)

void setNumColumns(int columns,double alignmentWidth)

Description: Method void QTextLine::setNumColumns(int columns, double alignmentWidth)

void setPosition(const QPointF pos)

Description: Method void QTextLine::setPosition(const QPointF &pos)

Python specific notes:

The object exposes a writable attribute 'position'. This is the setter.

[const] int textLength

Description: Method int QTextLine::textLength()

[const] int textStart

Description: Method int QTextLine::textStart()

[const] double width

Description: Method double QTextLine::width()

[const] double x

Description: Method double QTextLine::x()

[const] int xToCursor(double x,const QTextLine_CursorPosition arg2 = QTextLine::CursorBetweenCharacters)

Description: Method int QTextLine::xToCursor(double x, QTextLine::CursorPosition)

[const] double y

Description: Method double QTextLine::y()