PySide6.QtGui.QTextCharFormat¶

class QTextCharFormat¶

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

Inherited by: QTextTableCellFormat, QTextImageFormat

Synopsis¶

Methods¶

def __init__()
def anchorHref()
def anchorNames()
def baselineOffset()
def font()
def fontCapitalization()
def fontFamilies()
def fontFamily()
def fontFixedPitch()
def fontHintingPreference()
def fontItalic()
def fontKerning()
def fontLetterSpacing()
def fontLetterSpacingType()
def fontOverline()
def fontPointSize()
def fontStretch()
def fontStrikeOut()
def fontStyleHint()
def fontStyleName()
def fontStyleStrategy()
def fontUnderline()
def fontWeight()
def fontWordSpacing()
def isAnchor()
def setAnchor()
def setAnchorHref()
def setAnchorNames()
def setBaselineOffset()
def setFont()
def setFontCapitalization()
def setFontFamilies()
def setFontFamily()
def setFontFixedPitch()
def setFontHintingPreference()
def setFontItalic()
def setFontKerning()
def setFontLetterSpacing()
def setFontLetterSpacingType()
def setFontOverline()
def setFontPointSize()
def setFontStretch()
def setFontStrikeOut()
def setFontStyleHint()
def setFontStyleName()
def setFontStyleStrategy()
def setFontUnderline()
def setFontWeight()
def setFontWordSpacing()
def setSubScriptBaseline()
def setSuperScriptBaseline()
def setTableCellColumnSpan()
def setTableCellRowSpan()
def setTextOutline()
def setToolTip()
def setUnderlineColor()
def setUnderlineStyle()
def setVerticalAlignment()
def subScriptBaseline()
def superScriptBaseline()
def tableCellColumnSpan()
def tableCellRowSpan()
def textOutline()
def toolTip()
def underlineColor()
def underlineStyle()
def verticalAlignment()

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¶

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

See also

QTextFormat QTextBlockFormat QTextTableFormat QTextListFormat

class VerticalAlignment¶

This enum describes the ways that adjacent characters can be vertically aligned.

Constant

Description

QTextCharFormat.AlignNormal

Adjacent characters are positioned in the standard way for text in the writing system in use.

QTextCharFormat.AlignSuperScript

Characters are placed above the base line for normal text.

QTextCharFormat.AlignSubScript

Characters are placed below the base line for normal text.

QTextCharFormat.AlignMiddle

The center of the object is vertically aligned with the base line. Currently, this is only implemented for inline objects.

QTextCharFormat.AlignBottom

The bottom edge of the object is vertically aligned with the base line.

QTextCharFormat.AlignTop

The top edge of the object is vertically aligned with the base line.

QTextCharFormat.AlignBaseline

The base lines of the characters are aligned.

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

class UnderlineStyle¶

This enum describes the different ways drawing underlined text.

Constant

Description

QTextCharFormat.NoUnderline

Text is draw without any underlining decoration.

QTextCharFormat.SingleUnderline

A line is drawn using Qt::SolidLine.

QTextCharFormat.DashUnderline

Dashes are drawn using Qt::DashLine.

QTextCharFormat.DotLine

Dots are drawn using Qt::DotLine;

QTextCharFormat.DashDotLine

Dashes and dots are drawn using Qt::DashDotLine.

QTextCharFormat.DashDotDotLine

Underlines draw drawn using Qt::DashDotDotLine.

QTextCharFormat.WaveUnderline

The text is underlined using a wave shaped line.

QTextCharFormat.SpellCheckUnderline

The underline is drawn depending on the SpellCheckUnderlineStyle theme hint of QPlatformTheme. By default this is mapped to WaveUnderline, on macOS it is mapped to DotLine.

See also

PenStyle

Constant	Description
QTextCharFormat.NoUnderline	Text is draw without any underlining decoration.
QTextCharFormat.SingleUnderline	A line is drawn using Qt::SolidLine.
QTextCharFormat.DashUnderline	Dashes are drawn using Qt::DashLine.
QTextCharFormat.DotLine	Dots are drawn using Qt::DotLine;
QTextCharFormat.DashDotLine	Dashes and dots are drawn using Qt::DashDotLine.
QTextCharFormat.DashDotDotLine	Underlines draw drawn using Qt::DashDotDotLine.
QTextCharFormat.WaveUnderline	The text is underlined using a wave shaped line.
QTextCharFormat.SpellCheckUnderline	The underline is drawn depending on the SpellCheckUnderlineStyle theme hint of QPlatformTheme. By default this is mapped to WaveUnderline, on macOS it is mapped to DotLine.

class FontPropertiesInheritanceBehavior¶

This enum specifies how the setFont() function should behave with respect to unset font properties.

Constant

Description

QTextCharFormat.FontPropertiesSpecifiedOnly

If a property is not explicitly set, do not change the text format’s property value.

QTextCharFormat.FontPropertiesAll

If a property is not explicitly set, override the text format’s property with a default value.

See also

setFont()

Constant	Description
QTextCharFormat.FontPropertiesSpecifiedOnly	If a property is not explicitly set, do not change the text format’s property value.
QTextCharFormat.FontPropertiesAll	If a property is not explicitly set, override the text format’s property with a default value.

__init__()¶

Constructs a new character format object.

__init__(fmt)

Parameters:: fmt – QTextFormat

anchorHref()¶

Return type:: str

Returns the text format’s hypertext link, or an empty string if none has been set.

See also

setAnchorHref()

anchorNames()¶

Return type:: list of strings

Returns the anchor names associated with this text format, or an empty string list if none has been set. If the anchor names are set, text with this format can be the destination of a hypertext link.

See also

setAnchorNames()

baselineOffset()¶

Return type:: float

Returns the the baseline offset in %.

See also

setBaselineOffset() setSubScriptBaseline() subScriptBaseline() setSuperScriptBaseline() superScriptBaseline()

font()¶

Return type:: QFont

Returns the font for this character format.

See also

setFont()

fontCapitalization()¶

Return type:: Capitalization

Returns the current capitalization type of the font.

See also

setFontCapitalization()

fontFamilies()¶

Return type:: object

Returns the text format’s font families.

Note

This function returns a QVariant for historical reasons. It will be corrected to return QStringList in Qt 7. The variant contains a QStringList object, which can be extracted by calling toStringList() on it.