Class: QgsTextFormat

class qgis.core.QgsTextFormat

Bases: sip.wrapper

QgsTextFormat(other: QgsTextFormat) Copy constructor.

Parameters:other – source QgsTextFormat

Container for all settings relating to text rendering.

Note

QgsTextFormat objects are implicitly shared.

New in version 3.0: Enums

Methods

background Returns a reference to the text background settings.
blendMode Returns the blending mode used for drawing the text.
buffer Returns a reference to the text buffer settings.
color Returns the color that text will be rendered in.
containsAdvancedEffects Returns True if any component of the font format requires advanced effects such as blend modes, which require output in raster formats to be fully respected.
font Returns the font used for rendering text.
fontFound Returns True if the specified font was found on the system, or False if the font was not found and a replacement was used instead.
fromMimeData Attempts to parse the provided mime data as a QgsTextFormat.
fromQFont Returns a text format matching the settings from an input font.
lineHeight Returns the line height for text.
namedStyle Returns the named style for the font used for rendering text (e.g., “bold”).
opacity Returns the text’s opacity.
readFromLayer Reads settings from a layer’s custom properties (for QGIS 2.x projects).
readXml Read settings from a DOM element.
resolvedFontFamily Returns the family for the resolved font, ie if the specified font was not found on the system this will return the name of the replacement font.
scaledFont Returns a font with the size scaled to match the format’s size settings (including units and map unit scale) for a specified render context.
setBackground Sets the text’s background settings.q
setBlendMode Sets the blending mode used for drawing the text.
setBuffer Sets the text’s buffer settings.
setColor Sets the color that text will be rendered in.
setFont Sets the font used for rendering text.
setLineHeight Sets the line height for text.
setNamedStyle Sets the named style for the font used for rendering text.
setOpacity Sets the text’s opacity.
setShadow Sets the text’s drop shadow settings.
setSize Sets the size for rendered text.
setSizeMapUnitScale Sets the map unit scale object for the size.
setSizeUnit Sets the units for the size of rendered text.
shadow Returns a reference to the text drop shadow settings.
size Returns the size for rendered text.
sizeMapUnitScale Returns the map unit scale object for the size.
sizeUnit Returns the units for the size of rendered text.
toMimeData Returns new mime data representing the text format settings.
toQFont Returns a QFont matching the relevant settings from this text format.
writeXml Write settings into a DOM element.

Signals

Attributes

background(self) → QgsTextBackgroundSettings

Returns a reference to the text background settings.

See also

setBackground()

blendMode(self) → QPainter.CompositionMode

Returns the blending mode used for drawing the text.

See also

setBlendMode()

buffer(self) → QgsTextBufferSettings

Returns a reference to the text buffer settings.

See also

setBuffer()

color(self) → QColor

Returns the color that text will be rendered in.

See also

setColor()

containsAdvancedEffects(self) → bool

Returns True if any component of the font format requires advanced effects such as blend modes, which require output in raster formats to be fully respected.

font(self) → QFont

Returns the font used for rendering text. Note that the size of the font is not used, and size() should be called instead to determine the size of rendered text.

See also

scaledFont()

See also

setFont()

See also

namedStyle()

See also

toQFont()

fontFound(self) → bool

Returns True if the specified font was found on the system, or False if the font was not found and a replacement was used instead.

fromMimeData(data: QMimeData) → Tuple[QgsTextFormat, bool]

Attempts to parse the provided mime data as a QgsTextFormat. If data can be parsed as a text format, ok will be set to True.

See also

toMimeData()

fromQFont(font: QFont) → QgsTextFormat

Returns a text format matching the settings from an input font. Unlike setFont(), this method also handles the size and size units from font.

See also

toQFont()

New in version 3.2.

lineHeight(self) → float

Returns the line height for text. This is a number between 0.0 and 10.0 representing the leading between lines as a multiplier of line height.

See also

setLineHeight()

namedStyle(self) → str

Returns the named style for the font used for rendering text (e.g., “bold”).

See also

setNamedStyle()

See also

font()

opacity(self) → float

Returns the text’s opacity. The opacity is a double value between 0 (fully transparent) and 1 (totally opaque).

See also

setOpacity()

readFromLayer(self, layer: QgsVectorLayer)

Reads settings from a layer’s custom properties (for QGIS 2.x projects).

Parameters:layer – source vector layer
readXml(self, elem: QDomElement, context: QgsReadWriteContext)

Read settings from a DOM element.

See also

writeXml()

resolvedFontFamily(self) → str

Returns the family for the resolved font, ie if the specified font was not found on the system this will return the name of the replacement font.

See also

fontFound()

scaledFont(self, context: QgsRenderContext) → QFont

Returns a font with the size scaled to match the format’s size settings (including units and map unit scale) for a specified render context.

Parameters:context – destination render context
Returns:font with scaled size

See also

font()

See also

size()

setBackground(self, backgroundSettings: QgsTextBackgroundSettings)

Sets the text’s background settings.q

Parameters:backgroundSettings – background settings

See also

background()

setBlendMode(self, mode: QPainter.CompositionMode)

Sets the blending mode used for drawing the text.

Parameters:mode – blending mode

See also

blendMode()

setBuffer(self, bufferSettings: QgsTextBufferSettings)

Sets the text’s buffer settings.

Parameters:bufferSettings – buffer settings

See also

buffer()

setColor(self, color: Union[QColor, Qt.GlobalColor, QGradient])

Sets the color that text will be rendered in.

Parameters:color – text color

See also

color()

setFont(self, font: QFont)

Sets the font used for rendering text. Note that the size of the font is not used, and setSize() should be called instead to explicitly set the size of rendered text.

Parameters:font – desired font

See also

font()

See also

setNamedStyle()

See also

fromQFont()

setLineHeight(self, height: float)

Sets the line height for text.

Parameters:height – a number between 0.0 and 10.0 representing the leading between lines as a multiplier of line height.

See also

lineHeight()

setNamedStyle(self, style: str)

Sets the named style for the font used for rendering text.

Parameters:style – named style, e.g., “bold”

See also

namedStyle()

See also

setFont()

setOpacity(self, opacity: float)

Sets the text’s opacity.

Parameters:opacity – opacity as a double value between 0 (fully transparent) and 1 (totally opaque)

See also

opacity()

setShadow(self, shadowSettings: QgsTextShadowSettings)

Sets the text’s drop shadow settings.

Parameters:shadowSettings – shadow settings

See also

shadow()

setSize(self, size: float)

Sets the size for rendered text.

Parameters:size – size of rendered text. Units are set using setSizeUnit()

See also

size()

See also

setSizeUnit()

setSizeMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale object for the size. This is only used if the sizeUnit() is set to QgsUnitTypes.RenderMapUnit.

See also

setSizeUnit()

setSizeUnit(self, unit: QgsUnitTypes.RenderUnit)

Sets the units for the size of rendered text.

Parameters:unit – size units

See also

setSize()

See also

sizeUnit()

shadow(self) → QgsTextShadowSettings

Returns a reference to the text drop shadow settings.

See also

setShadow()

size(self) → float

Returns the size for rendered text. Units are retrieved using sizeUnit().

See also

setSize()

See also

sizeUnit()

sizeMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale object for the size. This is only used if the sizeUnit() is set to QgsUnitTypes.RenderMapUnit.

See also

sizeUnit()

sizeUnit(self) → QgsUnitTypes.RenderUnit

Returns the units for the size of rendered text.

See also

size()

See also

setSizeUnit()

toMimeData(self) → QMimeData

Returns new mime data representing the text format settings. Caller takes responsibility for deleting the returned object.

See also

fromMimeData()

toQFont(self) → QFont

Returns a QFont matching the relevant settings from this text format. Unlike font(), this method also handles the size and size units from the text format.

See also

fromQFont()

New in version 3.2.

writeXml(self, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement

Write settings into a DOM element.

See also

readXml()