Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# QTextInlineObject Class Reference

The QTextInlineObject class represents an inline object in a QTextLayout. More...

    #include <QTextInlineObject>

- List of all members, including inherited members

### Public Functions

- QTextInlineObject ( int i, QTextEngine * e )
- int ascent () const
- int at () const
- int descent () const
- QTextEngine * engine () const
- QTextFormat format () const
- int formatIndex () const
- int height () const
- bool isRightToLeft () const
- bool isValid () const
- int item () const
- QRect rect () const
- void setAscent ( int a )
- void setDescent ( int d )
- void setWidth ( int w )
- int width () const

## Detailed Description

The QTextInlineObject class represents an inline object in a QTextLayout.

This class is only used if the text layout is used to lay out parts of a QTextDocument.

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 isRightToLeft(). Its position in the text layout is given by at(), and its format is given by format().

## Member Function Documentation

### QTextInlineObject::QTextInlineObject ( int i, QTextEngine * e )

Creates a new inline object for the item at position i in the text engine e.

### int QTextInlineObject::ascent () const

Returns the inline object's ascent.

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

### int QTextInlineObject::at () const

The position of the inline object within the text layout.

### int QTextInlineObject::descent () const

Returns the inline object's descent.

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

### QTextEngine * QTextInlineObject::engine () const

Returns the text engine set in the constructor.

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

### int 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::isRightToLeft () const

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

### bool QTextInlineObject::isValid () const

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

### int QTextInlineObject::item () const

Returns the inline object's position in the text engine as set in the constructor.

### QRect QTextInlineObject::rect () const

Returns the inline object's rectangle.

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

### void QTextInlineObject::setAscent ( int a )

Sets the inline object's ascent to a.

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

### void QTextInlineObject::setDescent ( int d )

Sets the inline object's decent to d.

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

### void QTextInlineObject::setWidth ( int w )

Sets the inline object's width to w.

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

### int QTextInlineObject::width () const

Returns the inline object's width.

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