QTextInlineObject Class

The QTextInlineObject class represents an inline object in a QAbstractTextDocumentLayout and its implementations. More...

Header: #include <QTextInlineObject>
qmake: QT += gui

Note: All functions in this class are reentrant.

Public Functions

qreal ascent() const
qreal descent() const
QTextFormat format() const
int formatIndex() const
qreal height() const
bool isValid() const
QRectF rect() const
void setAscent(qreal a)
void setDescent(qreal d)
void setWidth(qreal w)
Qt::LayoutDirection textDirection() const
int textPosition() const
qreal width() const

Detailed Description

The QTextInlineObject class represents an inline object in a QAbstractTextDocumentLayout and its implementations.

Normally, you do not need to create a QTextInlineObject. It is used by QAbstractTextDocumentLayout to handle inline objects when implementing a custom layout.

The inline object has various attributes that can be set, for example using, setWidth(), setAscent(), and setDescent(). The rectangle it occupies is given by rect(), and its direction by textDirection(). Its position in the text layout is given by textPosition(), and its format is given by format().

Member Function Documentation

qreal QTextInlineObject::ascent() const

Returns the inline object's ascent.

See also setAscent(), descent(), width(), and rect().

qreal QTextInlineObject::descent() const

Returns the inline object's descent.

See also setDescent(), ascent(), width(), and rect().

QTextFormat QTextInlineObject::format() const

Returns format of the inline object within the text layout.

int QTextInlineObject::formatIndex() const

Returns an integer describing the format of the inline object within the text layout.

qreal QTextInlineObject::height() const

Returns the inline object's total height. This is equal to ascent() + descent() + 1.

See also ascent(), descent(), width(), and rect().

bool QTextInlineObject::isValid() const

Returns true if this inline object is valid; otherwise returns false.

QRectF QTextInlineObject::rect() const

Returns the inline object's rectangle.

See also ascent(), descent(), and width().

void QTextInlineObject::setAscent(qreal a)

Sets the inline object's ascent to a.

See also ascent(), setDescent(), width(), and rect().

void QTextInlineObject::setDescent(qreal d)

Sets the inline object's descent to d.

See also descent(), setAscent(), width(), and rect().

void QTextInlineObject::setWidth(qreal w)

Sets the inline object's width to w.

See also width(), ascent(), descent(), and rect().

Qt::LayoutDirection QTextInlineObject::textDirection() const

Returns if the object should be laid out right-to-left or left-to-right.

int QTextInlineObject::textPosition() const

The position of the inline object within the text layout.

qreal QTextInlineObject::width() const

Returns the inline object's width.

See also setWidth(), ascent(), descent(), and rect().

© 2020 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.