Contents

• Public Functions
• Detailed Description

Detailed Description

TheQTextImageFormat class provides formatting information for images in aQTextDocument.

Inline images are represented by an object replacement character (0xFFFC in Unicode) which has an associatedQTextImageFormat. The image format specifies a name withsetName() that is used to locate the image. The size of the rectangle that the image will occupy is specified usingsetWidth() andsetHeight().

Images can be supplied in any format for which Qt has an image reader, so SVG drawings can be included alongside PNG, TIFF and other bitmap formats.

Member Function Documentation

QTextImageFormat::QTextImageFormat()

Creates a new image format object.

qreal QTextImageFormat::height() const

Returns the height of the rectangle occupied by the image.

See alsowidth() andsetHeight().

bool QTextImageFormat::isValid() const

Returns true if this image format is valid; otherwise returns false.

QString QTextImageFormat::name() const

Returns the name of the image. The name refers to an entry in the application's resources file.

See alsosetName().

void QTextImageFormat::setHeight(qreal height)

Sets theheight of the rectangle occupied by the image.

See alsoheight() andsetWidth().

void QTextImageFormat::setName(constQString & name)

Sets thename of the image. Thename is used to locate the image in the application's resources.

See alsoname().

void QTextImageFormat::setWidth(qreal width)

Sets thewidth of the rectangle occupied by the image.

See alsowidth() andsetHeight().

qreal QTextImageFormat::width() const

Returns the width of the rectangle occupied by the image.

See alsoheight() andsetWidth().