PySide6.QtGui.QTextImageFormat¶

class QTextImageFormat¶

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

Synopsis¶

Methods¶

def __init__()
def height()
def maximumWidth()
def name()
def quality()
def setHeight()
def setMaximumWidth()
def setName()
def setQuality()
def setWidth()
def width()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

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

__init__()¶

Creates a new image format object.

__init__(format)

Parameters:: format – QTextFormat

height()¶

Return type:: float

Returns the height of the rectangle occupied by the image.

See also

width() setHeight()

maximumWidth()¶

Return type:: QTextLength

Returns the maximum width of the rectangle occupied by the image.

See also

width() setMaximumWidth()

name()¶

Return type:: str

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

See also

setName()

quality()¶

Return type:: int

Returns the value set by setQuality() .

See also

setQuality()

setHeight(height)¶

Parameters:: height – float

Sets the height of the rectangle occupied by the image.

See also

height() setWidth()

setMaximumWidth(maxWidth)¶

Parameters:: maxWidth – QTextLength

Sets the maximumWidth of the rectangle occupied by the image. This can be an absolute number or a percentage of the available document size.

See also

maximumWidth() width() setHeight()

setName(name)¶

Parameters:: name – str

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

See also

name()

setQuality()¶: Note

This function is deprecated.

setQuality(quality)

Parameters:: quality – int

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

setWidth(width)¶

Parameters:: width – float

Sets the width of the rectangle occupied by the image.

See also

width() setHeight() maximumWidth()

width()¶

Return type:: float

Returns the width of the rectangle occupied by the image.

See also

height() setWidth()