QTextCharFormat

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

Inheritance diagram of PySide2.QtGui.QTextCharFormat

Inherited by: QTextImageFormat, QTextTableCellFormat

Synopsis

Functions

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. 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.

class QTextCharFormat

QTextCharFormat(QTextCharFormat)

QTextCharFormat(fmt)

param QTextCharFormat

QTextCharFormat

param fmt

QTextFormat

Constructs a new character format object.

PySide2.QtGui.QTextCharFormat.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.

PySide2.QtGui.QTextCharFormat.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 SolidLine .

QTextCharFormat.DashUnderline

Dashes are drawn using DashLine .

QTextCharFormat.DotLine

Dots are drawn using DotLine ;

QTextCharFormat.DashDotLine

Dashs and dots are drawn using DashDotLine .

QTextCharFormat.DashDotDotLine

Underlines draw drawn using 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 , on macOS it is mapped to .

See also

PenStyle

PySide2.QtGui.QTextCharFormat.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()

PySide2.QtGui.QTextCharFormat.anchorHref()
Return type

unicode

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

See also

setAnchorHref()

PySide2.QtGui.QTextCharFormat.anchorName()
Return type

unicode

Note

This function is deprecated.

This function is deprecated. Use anchorNames() instead.

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

See also

setAnchorName()

PySide2.QtGui.QTextCharFormat.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()

PySide2.QtGui.QTextCharFormat.font()
Return type

QFont

Returns the font for this character format.

See also

setFont()

PySide2.QtGui.QTextCharFormat.fontCapitalization()
Return type

Capitalization

Returns the current capitalization type of the font.

PySide2.QtGui.QTextCharFormat.fontFamilies()
Return type

object

Returns the text format’s font families.

PySide2.QtGui.QTextCharFormat.fontFamily()
Return type

unicode

Returns the text format’s font family.

PySide2.QtGui.QTextCharFormat.fontFixedPitch()
Return type

bool

Returns true if the text format’s font is fixed pitch; otherwise returns false .

PySide2.QtGui.QTextCharFormat.fontHintingPreference()
Return type

HintingPreference

Returns the hinting preference set for this text format.

PySide2.QtGui.QTextCharFormat.fontItalic()
Return type

bool

Returns true if the text format’s font is italic; otherwise returns false .

PySide2.QtGui.QTextCharFormat.fontKerning()
Return type

bool

Returns true if the font kerning is enabled.

PySide2.QtGui.QTextCharFormat.fontLetterSpacing()
Return type

qreal

Returns the current letter spacing.

PySide2.QtGui.QTextCharFormat.fontLetterSpacingType()
Return type

SpacingType

Returns the letter spacing type of this format..

PySide2.QtGui.QTextCharFormat.fontOverline()
Return type

bool

Returns true if the text format’s font is overlined; otherwise returns false .

PySide2.QtGui.QTextCharFormat.fontPointSize()
Return type

qreal

Returns the font size used to display text in this format.

PySide2.QtGui.QTextCharFormat.fontStretch()
Return type

int

Returns the current font stretching.

See also

setFontStretch()

PySide2.QtGui.QTextCharFormat.fontStrikeOut()
Return type

bool

Returns true if the text format’s font is struck out (has a horizontal line drawn through it); otherwise returns false .

PySide2.QtGui.QTextCharFormat.fontStyleHint()
Return type

StyleHint

Returns the font style hint.

PySide2.QtGui.QTextCharFormat.fontStyleName()
Return type

object

Returns the text format’s font style name.

PySide2.QtGui.QTextCharFormat.fontStyleStrategy()
Return type

StyleStrategy

Returns the current font style strategy.

PySide2.QtGui.QTextCharFormat.fontUnderline()
Return type

bool

Returns true if the text format’s font is underlined; otherwise returns false .

PySide2.QtGui.QTextCharFormat.fontWeight()
Return type

int

Returns the text format’s font weight.

See also

setFontWeight() font() Weight

PySide2.QtGui.QTextCharFormat.fontWordSpacing()
Return type

qreal

Returns the current word spacing value.

PySide2.QtGui.QTextCharFormat.isAnchor()
Return type

bool

Returns true if the text is formatted as an anchor; otherwise returns false .

PySide2.QtGui.QTextCharFormat.setAnchor(anchor)
Parameters

anchorbool

If anchor is true, text with this format represents an anchor, and is formatted in the appropriate way; otherwise the text is formatted normally. (Anchors are hyperlinks which are often shown underlined and in a different color from plain text.)

The way the text is rendered is independent of whether or not the format has a valid anchor defined. Use setAnchorHref() , and optionally setAnchorNames() to create a hypertext link.

See also

isAnchor()

PySide2.QtGui.QTextCharFormat.setAnchorHref(value)
Parameters

value – unicode

Sets the hypertext link for the text format to the given value . This is typically a URL like “http://example.com/index.html”.

The anchor will be displayed with the value as its display text; if you want to display different text call setAnchorNames() .

To format the text as a hypertext link use setAnchor() .

See also

anchorHref()

PySide2.QtGui.QTextCharFormat.setAnchorName(name)
Parameters

name – unicode

Note

This function is deprecated.

This function is deprecated. Use setAnchorNames() instead.

Sets the text format’s anchor name . For the anchor to work as a hyperlink, the destination must be set with setAnchorHref() and the anchor must be enabled with setAnchor() .

See also

anchorName()

PySide2.QtGui.QTextCharFormat.setAnchorNames(names)
Parameters

names – list of strings

Sets the text format’s anchor names . For the anchor to work as a hyperlink, the destination must be set with setAnchorHref() and the anchor must be enabled with setAnchor() .

See also

anchorNames()

PySide2.QtGui.QTextCharFormat.setFont(font)
Parameters

fontQFont

This is an overloaded function.

Sets the text format’s font .

See also

font()

PySide2.QtGui.QTextCharFormat.setFont(font, behavior)
Parameters

Sets the text format’s font .

If behavior is FontPropertiesAll , the font property that has not been explicitly set is treated like as it were set with default value; If behavior is FontPropertiesSpecifiedOnly , the font property that has not been explicitly set is ignored and the respective property value remains unchanged.

See also

font()

PySide2.QtGui.QTextCharFormat.setFontCapitalization(capitalization)
Parameters

capitalizationCapitalization

Sets the capitalization of the text that apppears in this font to capitalization .

A font’s capitalization makes the text appear in the selected capitalization mode.

PySide2.QtGui.QTextCharFormat.setFontFamilies(families)
Parameters

families – list of strings

Sets the text format’s font families .

PySide2.QtGui.QTextCharFormat.setFontFamily(family)
Parameters

family – unicode

Sets the text format’s font family .

PySide2.QtGui.QTextCharFormat.setFontFixedPitch(fixedPitch)
Parameters

fixedPitchbool

If fixedPitch is true, sets the text format’s font to be fixed pitch; otherwise a non-fixed pitch font is used.

PySide2.QtGui.QTextCharFormat.setFontHintingPreference(hintingPreference)
Parameters

hintingPreferenceHintingPreference

Sets the hinting preference of the text format’s font to be hintingPreference .

PySide2.QtGui.QTextCharFormat.setFontItalic(italic)
Parameters

italicbool

If italic is true, sets the text format’s font to be italic; otherwise the font will be non-italic.

PySide2.QtGui.QTextCharFormat.setFontKerning(enable)
Parameters

enablebool

Enables kerning for this font if enable is true; otherwise disables it.

When kerning is enabled, glyph metrics do not add up anymore, even for Latin text. In other words, the assumption that width(‘a’) + width(‘b’) is equal to width(“ab”) is not neccesairly true.

PySide2.QtGui.QTextCharFormat.setFontLetterSpacing(spacing)
Parameters

spacingqreal

Sets the letter spacing of this format to the given spacing . The meaning of the value depends on the font letter spacing type.

For percentage spacing a value of 100 indicates default spacing; a value of 200 doubles the amount of space a letter takes.

PySide2.QtGui.QTextCharFormat.setFontLetterSpacingType(letterSpacingType)
Parameters

letterSpacingTypeSpacingType

Sets the letter spacing type of this format to letterSpacingType .

PySide2.QtGui.QTextCharFormat.setFontOverline(overline)
Parameters

overlinebool

If overline is true, sets the text format’s font to be overlined; otherwise the font is displayed non-overlined.

PySide2.QtGui.QTextCharFormat.setFontPointSize(size)
Parameters

sizeqreal

Sets the text format’s font size .

PySide2.QtGui.QTextCharFormat.setFontStretch(factor)
Parameters

factorint

Sets the stretch factor for the font to factor .

The stretch factor changes the width of all characters in the font by factor percent. For example, setting factor to 150 results in all characters in the font being 1.5 times (ie. 150%) wider. The default stretch factor is 100. The minimum stretch factor is 1, and the maximum stretch factor is 4000.

The stretch factor is only applied to outline fonts. The stretch factor is ignored for bitmap fonts.

See also

fontStretch()

PySide2.QtGui.QTextCharFormat.setFontStrikeOut(strikeOut)
Parameters

strikeOutbool

If strikeOut is true, sets the text format’s font with strike-out enabled (with a horizontal line through it); otherwise it is displayed without strikeout.

PySide2.QtGui.QTextCharFormat.setFontStyleHint(hint[, strategy=QFont.PreferDefault])
Parameters
  • hintStyleHint

  • strategyStyleStrategy

Sets the font style hint and strategy .

Qt does not support style hints on X11 since this information is not provided by the window system.

PySide2.QtGui.QTextCharFormat.setFontStyleName(styleName)
Parameters

styleName – unicode

Sets the text format’s font styleName .

PySide2.QtGui.QTextCharFormat.setFontStyleStrategy(strategy)
Parameters

strategyStyleStrategy

Sets the font style strategy .

PySide2.QtGui.QTextCharFormat.setFontUnderline(underline)
Parameters

underlinebool

If underline is true, sets the text format’s font to be underlined; otherwise it is displayed non-underlined.

PySide2.QtGui.QTextCharFormat.setFontWeight(weight)
Parameters

weightint

Sets the text format’s font weight to weight .

See also

fontWeight() setFont() Weight

PySide2.QtGui.QTextCharFormat.setFontWordSpacing(spacing)
Parameters

spacingqreal

Sets the word spacing of this format to the given spacing , in pixels.

PySide2.QtGui.QTextCharFormat.setTableCellColumnSpan(tableCellColumnSpan)
Parameters

tableCellColumnSpanint

PySide2.QtGui.QTextCharFormat.setTableCellRowSpan(tableCellRowSpan)
Parameters

tableCellRowSpanint

PySide2.QtGui.QTextCharFormat.setTextOutline(pen)
Parameters

penQPen

Sets the pen used to draw the outlines of characters to the given pen .

See also

textOutline()

PySide2.QtGui.QTextCharFormat.setToolTip(tip)
Parameters

tip – unicode

Sets the tool tip for a fragment of text to the given text .

See also

toolTip()

PySide2.QtGui.QTextCharFormat.setUnderlineColor(color)
Parameters

colorQColor

Sets the underline color used for the characters with this format to the color specified.

See also

underlineColor()

PySide2.QtGui.QTextCharFormat.setUnderlineStyle(style)
Parameters

styleUnderlineStyle

Sets the style of underlining the text to style .

See also

underlineStyle()

PySide2.QtGui.QTextCharFormat.setVerticalAlignment(alignment)
Parameters

alignmentVerticalAlignment

Sets the vertical alignment used for the characters with this format to the alignment specified.

PySide2.QtGui.QTextCharFormat.tableCellColumnSpan()
Return type

int

PySide2.QtGui.QTextCharFormat.tableCellRowSpan()
Return type

int

PySide2.QtGui.QTextCharFormat.textOutline()
Return type

QPen

Returns the pen used to draw the outlines of characters in this format.

See also

setTextOutline()

PySide2.QtGui.QTextCharFormat.toolTip()
Return type

unicode

Returns the tool tip that is displayed for a fragment of text.

See also

setToolTip()

PySide2.QtGui.QTextCharFormat.underlineColor()
Return type

QColor

Returns the color used to underline the characters with this format.

PySide2.QtGui.QTextCharFormat.underlineStyle()
Return type

UnderlineStyle

Returns the style of underlining the text.

PySide2.QtGui.QTextCharFormat.verticalAlignment()
Return type

VerticalAlignment

Returns the vertical alignment used for characters with this format.