API reference - Class QTextLine

Notation used in Ruby API documentation

Description: Binding of QTextLine

Public constructors

new QTextLinenewConstructor QTextLine::QTextLine()

Public methods

[const]doubleascentMethod double QTextLine::ascent()
[const]voidassign(const QTextLine other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
[const]doublecursorToX(int ptr cursorPos,
const QTextLine_Edge edge = QTextLine::Leading)
Method double QTextLine::cursorToX(int *cursorPos, QTextLine::Edge edge)
[const]doublecursorToX(int cursorPos,
const QTextLine_Edge edge = QTextLine::Leading)
Method double QTextLine::cursorToX(int cursorPos, QTextLine::Edge edge)
[const]doubledescentMethod double QTextLine::descent()
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]voiddraw(QPainter ptr p,
const QPointF point,
const QTextLayout_FormatRange ptr selection = 0)
Method void QTextLine::draw(QPainter *p, const QPointF &point, const QTextLayout::FormatRange *selection)
[const]QTextLinedupCreates a copy of self
[const]doubleheightMethod double QTextLine::height()
[const]boolisValidMethod bool QTextLine::isValid()
[const]boolisValid?Method bool QTextLine::isValid()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]doubleleadingMethod double QTextLine::leading()
[const]boolleadingIncludedMethod bool QTextLine::leadingIncluded()
voidleadingIncluded=(bool included)Method void QTextLine::setLeadingIncluded(bool included)
[const]intlineNumberMethod int QTextLine::lineNumber()
[const]QRectFnaturalTextRectMethod QRectF QTextLine::naturalTextRect()
[const]doublenaturalTextWidthMethod double QTextLine::naturalTextWidth()
[const]QPointFpositionMethod QPointF QTextLine::position()
voidposition=(const QPointF pos)Method void QTextLine::setPosition(const QPointF &pos)
[const]QRectFrectMethod QRectF QTextLine::rect()
voidsetLeadingIncluded(bool included)Method void QTextLine::setLeadingIncluded(bool included)
voidsetLineWidth(double width)Method void QTextLine::setLineWidth(double width)
voidsetNumColumns(int columns)Method void QTextLine::setNumColumns(int columns)
voidsetNumColumns(int columns,
double alignmentWidth)
Method void QTextLine::setNumColumns(int columns, double alignmentWidth)
voidsetPosition(const QPointF pos)Method void QTextLine::setPosition(const QPointF &pos)
[const]inttextLengthMethod int QTextLine::textLength()
[const]inttextStartMethod int QTextLine::textStart()
[const]doublewidthMethod double QTextLine::width()
[const]doublexMethod double QTextLine::x()
[const]intxToCursor(double x,
const QTextLine_CursorPosition arg2 = QTextLine::CursorBetweenCharacters)
Method int QTextLine::xToCursor(double x, QTextLine::CursorPosition)
[const]doubleyMethod double QTextLine::y()

Public static methods and constants

QTextLine_CursorPositionCursorBetweenCharactersEnum constant QTextLine::CursorBetweenCharacters
QTextLine_CursorPositionCursorOnCharacterEnum constant QTextLine::CursorOnCharacter
QTextLine_EdgeLeadingEnum constant QTextLine::Leading
QTextLine_EdgeTrailingEnum constant QTextLine::Trailing

Detailed description

[static] QTextLine_CursorPosition CursorBetweenCharacters

Description: Enum constant QTextLine::CursorBetweenCharacters

[static] QTextLine_CursorPosition CursorOnCharacter

Description: Enum constant QTextLine::CursorOnCharacter

[static] QTextLine_Edge Leading

Description: Enum constant QTextLine::Leading

[static] QTextLine_Edge Trailing

Description: Enum constant QTextLine::Trailing

[const] double ascent

Description: Method double QTextLine::ascent()

[const] void assign(const QTextLine other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

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.

[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 destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, 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] 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] QTextLine 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 isValid?

Description: Method bool QTextLine::isValid()

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

[const] double leading

Description: Method double QTextLine::leading()

[const] bool leadingIncluded

Description: Method bool QTextLine::leadingIncluded()

void leadingIncluded=(bool included)

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

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

[const] QPointF position

Description: Method QPointF QTextLine::position()

void position=(const QPointF pos)

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

[const] QRectF rect

Description: Method QRectF QTextLine::rect()

void setLeadingIncluded(bool included)

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

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)

[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()