QTextImageFormat

The QTextImageFormat class provides formatting information for images in a QTextDocument . More

Inheritance diagram of PySide2.QtGui.QTextImageFormat

Synopsis

Functions

Detailed Description

Inline images are represented by a Unicode value U+FFFC (OBJECT REPLACEMENT CHARACTER) which has an associated QTextImageFormat . The image format specifies a name with setName() that is used to locate the image. The size of the rectangle that the image will occupy is specified in pixels using setWidth() and setHeight() . The desired image quality may be set with setQuality() .

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.

See also

QImage QImageReader

class QTextImageFormat

QTextImageFormat(format)

QTextImageFormat(QTextImageFormat)

param format

QTextFormat

param QTextImageFormat

QTextImageFormat

Creates a new image format object.

PySide2.QtGui.QTextImageFormat.height()
Return type

qreal

Returns the height of the rectangle occupied by the image.

See also

width() setHeight()

PySide2.QtGui.QTextImageFormat.name()
Return type

unicode

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

See also

setName()

PySide2.QtGui.QTextImageFormat.quality()
Return type

int

Returns the value set by setQuality() .

See also

setQuality()

PySide2.QtGui.QTextImageFormat.setHeight(height)
Parameters

heightqreal

Sets the height of the rectangle occupied by the image.

See also

height() setWidth()

PySide2.QtGui.QTextImageFormat.setName(name)
Parameters

name – unicode

Sets the name of the image. The name is used to locate the image in the application’s resources.

See also

name()

PySide2.QtGui.QTextImageFormat.setQuality([quality=100])
Parameters

qualityint

Sets the quality that should be used by exporters when exporting the image. QTextDocumentWriter will export jpg images with the quality set here when exporting to ODF files if quality is set to a value between 0 and 100. Or it will export png images if quality is set to 100 (default) or greater.

See also

quality()

PySide2.QtGui.QTextImageFormat.setWidth(width)
Parameters

widthqreal

Sets the width of the rectangle occupied by the image.

See also

width() setHeight()

PySide2.QtGui.QTextImageFormat.width()
Return type

qreal

Returns the width of the rectangle occupied by the image.

See also

height() setWidth()