QTextInlineObject Class Reference

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

#include <qtextlayout.h>

Public Functions
qreal	ascent () const
	Returns the inline object's ascent. More...
qreal	descent () const
	Returns the inline object's descent. More...
QTextFormat	format () const
	Returns format of the inline object within the text layout. More...
int	formatIndex () const
	Returns an integer describing the format of the inline object within the text layout. More...
qreal	height () const
	Returns the inline object's total height. More...
bool	isValid () const
	Returns true if this inline object is valid; otherwise returns false. More...
	QTextInlineObject (int i, QTextEngine *e)
	Creates a new inline object for the item at position i in the text engine e. More...
	QTextInlineObject ()
QRectF	rect () const
	Returns the inline object's rectangle. More...
void	setAscent (qreal a)
	Sets the inline object's ascent to a. More...
void	setDescent (qreal d)
	Sets the inline object's decent to d. More...
void	setWidth (qreal w)
	Sets the inline object's width to w. More...
Qt::LayoutDirection	textDirection () const
	Returns if the object should be laid out right-to-left or left-to-right. More...
int	textPosition () const
	The position of the inline object within the text layout. More...
qreal	width () const
	Returns the inline object's width. More...

Properties
QTextEngine *	eng
int	itm

Friends
class	QTextLayout

Detailed Description

The QTextInlineObject class represents an inline object in a QTextLayout.

Note

This class or function is reentrant.

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

Definition at line 69 of file qtextlayout.h.

Constructors and Destructors

QTextInlineObject() [1/2]

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

inline

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

Definition at line 72 of file qtextlayout.h.

: itm(i), eng(e) {}

QTextInlineObject() [2/2]

QTextInlineObject::QTextInlineObject ( )

inline

Warning

This function is not part of the public interface.

Definition at line 73 of file qtextlayout.h.

Referenced by QTextLine::draw(), and QTextLine::layout_helper().

: itm(0), eng(0) {}

Functions

ascent()

qreal QTextInlineObject::ascent

(

)

const

Returns the inline object's ascent.

See also

descent(), width(), rect()

Definition at line 184 of file qtextlayout.cpp.

{
    return eng->layoutData->items[itm].ascent.toReal();
}

descent()

qreal QTextInlineObject::descent

(

)

const

Returns the inline object's descent.

See also

ascent(), width(), rect()

Definition at line 194 of file qtextlayout.cpp.

Referenced by QTextLayout::drawCursor().

{
    return eng->layoutData->items[itm].descent.toReal();
}

format()

QTextFormat QTextInlineObject::format

(

)

const

Returns format of the inline object within the text layout.

Definition at line 260 of file qtextlayout.cpp.

Referenced by QTextLine::draw(), and QTextLine::layout_helper().

{
    if (!eng->block.docHandle())
        return QTextFormat();
    return eng->formats()->format(eng->formatIndex(&eng->layoutData->items[itm]));
}

formatIndex()

int QTextInlineObject::formatIndex

(

)

const

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

Definition at line 252 of file qtextlayout.cpp.

{
    return eng->formatIndex(&eng->layoutData->items[itm]);
}

height()

qreal QTextInlineObject::height

(

)

const

Returns the inline object's total height.

This is equal to ascent() + descent() + 1.

See also

ascent(), descent(), width(), rect()

Definition at line 205 of file qtextlayout.cpp.

Referenced by QTextLine::draw().

{
    return eng->layoutData->items[itm].height().toReal();
}

isValid()

bool QTextInlineObject::isValid ( ) const

inline

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

Definition at line 74 of file qtextlayout.h.

{ return eng; }

rect()

QRectF QTextInlineObject::rect

(

)

const

Returns the inline object's rectangle.

See also

ascent(), descent(), width()

Definition at line 163 of file qtextlayout.cpp.

Referenced by addSelectedRegionsToPath().

{
    QScriptItem& si = eng->layoutData->items[itm];
    return QRectF(0, -si.ascent.toReal(), si.width.toReal(), si.height().toReal());
}

setAscent()

void QTextInlineObject::setAscent

(

qreal

a

)

Sets the inline object's ascent to a.

See also

ascent(), setDescent(), width(), rect()

Definition at line 225 of file qtextlayout.cpp.

Referenced by QTextDocumentLayout::resizeInlineObject(), and QAbstractTextDocumentLayout::resizeInlineObject().

{
    eng->layoutData->items[itm].ascent = QFixed::fromReal(a);
}

setDescent()

void QTextInlineObject::setDescent

(

qreal

d

)

Sets the inline object's decent to d.

See also

descent(), setAscent(), width(), rect()

Definition at line 235 of file qtextlayout.cpp.

Referenced by QTextDocumentLayout::resizeInlineObject(), and QAbstractTextDocumentLayout::resizeInlineObject().

{
    eng->layoutData->items[itm].descent = QFixed::fromReal(d);
}

setWidth()

void QTextInlineObject::setWidth

(

qreal

w

)

Sets the inline object's width to w.

See also

width(), ascent(), descent(), rect()

Definition at line 215 of file qtextlayout.cpp.

Referenced by QTextDocumentLayout::resizeInlineObject(), and QAbstractTextDocumentLayout::resizeInlineObject().

{
    eng->layoutData->items[itm].width = QFixed::fromReal(w);
}

textDirection()

Qt::LayoutDirection QTextInlineObject::textDirection

(

)

const

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

Definition at line 270 of file qtextlayout.cpp.

{
    return (eng->layoutData->items[itm].analysis.bidiLevel % 2 ? Qt::RightToLeft : Qt::LeftToRight);
}

textPosition()

int QTextInlineObject::textPosition

(

)

const

The position of the inline object within the text layout.

Definition at line 243 of file qtextlayout.cpp.

{
    return eng->layoutData->items[itm].position;
}

width()

qreal QTextInlineObject::width

(

)

const

Returns the inline object's width.

See also

ascent(), descent(), rect()

Definition at line 174 of file qtextlayout.cpp.

Referenced by QTextLine::draw(), QTextLine::naturalTextRect(), and QTextDocumentLayout::positionInlineObject().

{
    return eng->layoutData->items[itm].width.toReal();
}

Friends and Related Functions

QTextLayout

friend class QTextLayout

friend

Definition at line 94 of file qtextlayout.h.

Properties

eng

QTextEngine* QTextInlineObject::eng

private

Definition at line 96 of file qtextlayout.h.

Referenced by ascent(), QTextLine::ascent(), QTextLine::cursorToX(), descent(), QTextLine::descent(), QTextLine::draw(), format(), formatIndex(), QTextLine::glyphs(), height(), QTextLine::height(), QTextLine::horizontalAdvance(), QTextLine::layout_helper(), QTextLine::leading(), QTextLine::leadingIncluded(), QTextLine::naturalTextRect(), QTextLine::naturalTextWidth(), QTextLine::position(), rect(), QTextLine::rect(), setAscent(), setDescent(), QTextLine::setLeadingIncluded(), QTextLine::setLineWidth(), QTextLine::setNumColumns(), QTextLine::setPosition(), setWidth(), textDirection(), QTextLine::textLength(), textPosition(), QTextLine::textStart(), width(), QTextLine::width(), QTextLine::x(), QTextLine::xToCursor(), and QTextLine::y().

itm

int QTextInlineObject::itm

private

Definition at line 95 of file qtextlayout.h.

Referenced by ascent(), QTextLine::cursorToX(), descent(), QTextLayout::drawCursor(), format(), formatIndex(), height(), rect(), setAscent(), setDescent(), setWidth(), textDirection(), textPosition(), and width().

---

The documentation for this class was generated from the following files:

• /src/gui/text/qtextlayout.h
• /src/gui/text/qtextlayout.cpp