CopperSpice API  1.9.2
Public Methods | Friends | List of all members
QTextInlineObject Class Reference
CsGui | Rich Text Processing

Represents an inline object in a QTextLayout. More...

Public Methods

 QTextInlineObject (int index, QTextEngine *engine)
 
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
 

Friends

class QTextLayout
 

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.

Some of the attributes for this class include setWidth(), setAscent(), and setDescent(). The rectangle for the text can be obtained by calling rect() and the direction is returned by calling textDirection(). The position in the text layout is returned by calling at() and the format by calling format().

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

Constructor & Destructor Documentation

QTextInlineObject::QTextInlineObject ( int  index,
QTextEngine *  engine 
)
inline

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

Method Documentation

qreal QTextInlineObject::ascent ( ) const

Returns the inline object's ascent.

See also
setAscent(), descent(), width(), rect()
qreal QTextInlineObject::descent ( ) const

Returns the inline object's descent.

See also
setDescent(), ascent(), width(), 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(), rect()
bool QTextInlineObject::isValid ( ) const
inline

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(), width()
void QTextInlineObject::setAscent ( qreal  a)

Sets the inline object's ascent to a.

See also
ascent(), setDescent(), width(), rect()
void QTextInlineObject::setDescent ( qreal  d)

Sets the inline object's decent to d.

See also
descent(), setAscent(), width(), rect()
void QTextInlineObject::setWidth ( qreal  w)

Sets the inline object's width to w.

See also
width(), ascent(), descent(), 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(), rect()