QTextCharFormat¶

PyQt5.QtGui.QTextCharFormat

Inherited by QTextImageFormat, QTextTableCellFormat.

Description¶

The QTextCharFormat class provides formatting information for characters in a QTextDocument.

The character format of text in a document specifies the visual properties of the text, as well as information about its role in a hypertext document.

The font used can be set by supplying a font to the setFont() function, and each aspect of its appearance can be adjusted to give the desired effect. setFontFamily() and setFontPointSize() define the font’s family (e.g. Times) and printed size; setFontWeight() and setFontItalic() provide control over the style of the font. setFontUnderline(), setFontOverline(), setFontStrikeOut(), and setFontFixedPitch() provide additional effects for text.

The color is set with setForeground(). If the text is intended to be used as an anchor (for hyperlinks), this can be enabled with setAnchor(). The setAnchorHref() and setAnchorNames() functions are used to specify the information about the hyperlink’s destination and the anchor’s name.

Enums¶

FontPropertiesInheritanceBehavior

TODO

Member	Value	Description
FontPropertiesAll	TODO	TODO
FontPropertiesSpecifiedOnly	TODO	TODO

UnderlineStyle

This enum describes the different ways drawing underlined text.

Methods¶

__init__(): TODO

__init__(QTextCharFormat): TODO

anchorHref() → str: See also

setAnchorHref().

anchorNames() → List[str]: See also

setAnchorNames().

font() → QFont: Returns the font for this character format.

See also

setFont().

fontCapitalization() → Capitalization: See also

setFontCapitalization().

fontFamilies() → Any: TODO

fontFamily() → str: See also

setFontFamily().

fontFixedPitch() → bool: See also

setFontFixedPitch().

fontHintingPreference() → HintingPreference: See also

setFontHintingPreference().

fontItalic() → bool: See also

setFontItalic().

fontKerning() → bool: See also

setFontKerning().

fontLetterSpacing() → float: See also

setFontLetterSpacing().

fontLetterSpacingType() → SpacingType: TODO

fontOverline() → bool: See also

setFontOverline().

fontPointSize() → float: See also

setFontPointSize().

fontStretch() → int: TODO

fontStrikeOut() → bool: See also

setFontStrikeOut().

fontStyleHint() → StyleHint: See also

setFontStyleHint().

fontStyleName() → Any: TODO

fontStyleStrategy() → StyleStrategy: See also

setFontStyleStrategy().

fontUnderline() → bool: See also

setFontUnderline().

fontWeight() → int: See also

setFontWeight().

fontWordSpacing() → float: See also

setFontWordSpacing().

isAnchor() → bool: TODO

isValid() → bool: TODO

setAnchor(bool): See also

isAnchor().

setAnchorHref(str): See also

anchorHref().

setAnchorNames(Iterable[str]): See also

anchorNames().

setFont(QFont)

This is an overloaded function.

Sets the text format’s font.

Member	Value	Description
DashDotDotLine	5	Underlines draw drawn using DashDotDotLine.
DashDotLine	4	Dashs and dots are drawn using DashDotLine.
DashUnderline	2	Dashes are drawn using DashLine.
DotLine	3	Dots are drawn using DotLine;
NoUnderline	0	Text is draw without any underlining decoration.
SingleUnderline	1	A line is drawn using SolidLine.
SpellCheckUnderline	7	The underline is drawn depending on the SpellCheckUnderlineStyle theme hint of QPlatformTheme. By default this is mapped to , on macOS it is mapped to .
WaveUnderline	6	The text is underlined using a wave shaped line.

Member	Value	Description
AlignBaseline	6	The base lines of the characters are aligned.
AlignBottom	5	The bottom edge of the object is vertically aligned with the base line.
AlignMiddle	3	The center of the object is vertically aligned with the base line. Currently, this is only implemented for inline objects.
AlignNormal	0	Adjacent characters are positioned in the standard way for text in the writing system in use.
AlignSubScript	2	Characters are placed below the base line for normal text.
AlignSuperScript	1	Characters are placed above the base line for normal text.
AlignTop	4	The top edge of the object is vertically aligned with the base line.