|  | Home · All Classes · Modules

# QTextCharFormat Class Reference
[QtGui module]

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

Inherits QTextFormat.

Inherited by QTextImageFormat and QTextTableCellFormat.

### Types

- enum UnderlineStyle { NoUnderline, SingleUnderline, DashUnderline, DotLine, ..., SpellCheckUnderline }
- enum VerticalAlignment { AlignNormal, AlignSuperScript, AlignSubScript, AlignMiddle, ..., AlignBaseline }

### Methods

- __init__ (self)
- __init__ (self, QTextCharFormat)
- QString anchorHref (self)
- QString anchorName (self)
- QStringList anchorNames (self)
- QFont font (self)
- QFont.Capitalization fontCapitalization (self)
- QString fontFamily (self)
- bool fontFixedPitch (self)
- QFont.HintingPreference fontHintingPreference (self)
- bool fontItalic (self)
- bool fontKerning (self)
- float fontLetterSpacing (self)
- bool fontOverline (self)
- float fontPointSize (self)
- bool fontStrikeOut (self)
- QFont.StyleHint fontStyleHint (self)
- QFont.StyleStrategy fontStyleStrategy (self)
- bool fontUnderline (self)
- int fontWeight (self)
- float fontWordSpacing (self)
- bool isAnchor (self)
- bool isValid (self)
- setAnchor (self, bool anchor)
- setAnchorHref (self, QString value)
- setAnchorName (self, QString name)
- setAnchorNames (self, QStringList names)
- setFont (self, QFont font)
- setFontCapitalization (self, QFont.Capitalization capitalization)
- setFontFamily (self, QString family)
- setFontFixedPitch (self, bool fixedPitch)
- setFontHintingPreference (self, QFont.HintingPreference hintingPreference)
- setFontItalic (self, bool italic)
- setFontKerning (self, bool enable)
- setFontLetterSpacing (self, float spacing)
- setFontOverline (self, bool overline)
- setFontPointSize (self, float size)
- setFontStrikeOut (self, bool strikeOut)
- setFontStyleHint (self, QFont.StyleHint hint, QFont.StyleStrategy strategy = QFont.PreferDefault)
- setFontStyleStrategy (self, QFont.StyleStrategy strategy)
- setFontUnderline (self, bool underline)
- setFontWeight (self, int weight)
- setFontWordSpacing (self, float spacing)
- setTableCellColumnSpan (self, int atableCellColumnSpan)
- setTableCellRowSpan (self, int atableCellRowSpan)
- setTextOutline (self, QPen pen)
- setToolTip (self, QString tip)
- setUnderlineColor (self, QColor color)
- setUnderlineStyle (self, UnderlineStyle style)
- setVerticalAlignment (self, VerticalAlignment alignment)
- int tableCellColumnSpan (self)
- int tableCellRowSpan (self)
- QPen textOutline (self)
- QString toolTip (self)
- QColor underlineColor (self)
- UnderlineStyle underlineStyle (self)
- VerticalAlignment verticalAlignment (self)

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

## Type Documentation

### QTextCharFormat.UnderlineStyle

This enum describes the different ways drawing underlined text.

Constant | Value | Description
--- | --- | ---
`QTextCharFormat.NoUnderline` | `0` | Text is draw without any underlining decoration.
`QTextCharFormat.SingleUnderline` | `1` | A line is drawn using Qt.SolidLine.
`QTextCharFormat.DashUnderline` | `2` | Dashes are drawn using Qt.DashLine.
`QTextCharFormat.DotLine` | `3` | Dots are drawn using Qt.DotLine;
`QTextCharFormat.DashDotLine` | `4` | Dashs and dots are drawn using Qt.DashDotLine.
`QTextCharFormat.DashDotDotLine` | `5` | Underlines draw drawn using Qt.DashDotDotLine.
`QTextCharFormat.WaveUnderline` | `6` | The text is underlined using a wave shaped line.
`QTextCharFormat.SpellCheckUnderline` | `7` | The underline is drawn depending on the QStyle.SH_SpellCeckUnderlineStyle style hint of the QApplication style. By default this is mapped to WaveUnderline, on Mac OS X it is mapped to DashDotLine.

See also Qt.PenStyle.

### QTextCharFormat.VerticalAlignment

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

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

## Method Documentation

### QTextCharFormat.__init__ (self)

Constructs a new character format object.

### QTextCharFormat.__init__ (self, QTextCharFormat)

### QString QTextCharFormat.anchorHref (self)

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

See also setAnchorHref().

### QString QTextCharFormat.anchorName (self)

### QStringList QTextCharFormat.anchorNames (self)

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.

This function was introduced in Qt 4.3.

See also setAnchorNames().

### QFont QTextCharFormat.font (self)

Returns the font for this character format.

See also setFont().

### QFont.Capitalization QTextCharFormat.fontCapitalization (self)

Returns the current capitalization type of the font.

This function was introduced in Qt 4.4.

See also setFontCapitalization().

### QString QTextCharFormat.fontFamily (self)

Returns the text format's font family.

See also setFontFamily() and font().

### bool QTextCharFormat.fontFixedPitch (self)

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

See also setFontFixedPitch() and font().

### QFont.HintingPreference QTextCharFormat.fontHintingPreference (self)

Returns the hinting preference set for this text format.

This function was introduced in Qt 4.8.

See also setFontHintingPreference(), font(), and QFont.hintingPreference().

### bool QTextCharFormat.fontItalic (self)

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

See also setFontItalic() and font().

### bool QTextCharFormat.fontKerning (self)

Returns true if the font kerning is enabled.

This function was introduced in Qt 4.5.

See also setFontKerning() and font().

### float QTextCharFormat.fontLetterSpacing (self)

Returns the current letter spacing percentage.

This function was introduced in Qt 4.4.

See also setFontLetterSpacing().

### bool QTextCharFormat.fontOverline (self)

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

See also setFontOverline() and font().

### float QTextCharFormat.fontPointSize (self)

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

See also setFontPointSize() and font().

### bool QTextCharFormat.fontStrikeOut (self)

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

See also setFontStrikeOut() and font().

### QFont.StyleHint QTextCharFormat.fontStyleHint (self)

Returns the font style hint.

This function was introduced in Qt 4.5.

See also setFontStyleHint() and font().

### QFont.StyleStrategy QTextCharFormat.fontStyleStrategy (self)

Returns the current font style strategy.

This function was introduced in Qt 4.5.

See also setFontStyleStrategy() and font().

### bool QTextCharFormat.fontUnderline (self)

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

See also setFontUnderline() and font().

### int QTextCharFormat.fontWeight (self)

Returns the text format's font weight.

See also setFontWeight(), font(), and QFont.Weight.

### float QTextCharFormat.fontWordSpacing (self)

Returns the current word spacing value.

This function was introduced in Qt 4.4.

See also setFontWordSpacing().

### bool QTextCharFormat.isAnchor (self)

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

See also setAnchor(), setAnchorHref(), and setAnchorNames().

### bool QTextCharFormat.isValid (self)

Returns true if this character format is valid; otherwise returns false.

### QTextCharFormat.setAnchor (self, bool anchor)

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

### QTextCharFormat.setAnchorHref (self, QString value)

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

### QTextCharFormat.setAnchorName (self, QString name)

### QTextCharFormat.setAnchorNames (self, QStringList names)

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

This function was introduced in Qt 4.3.

See also anchorNames().

### QTextCharFormat.setFont (self, QFont font)

Sets the text format's font.

See also font().

### QTextCharFormat.setFontCapitalization (self, QFont.Capitalization capitalization)

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.

This function was introduced in Qt 4.4.

See also fontCapitalization().

### QTextCharFormat.setFontFamily (self, QString family)

Sets the text format's font family.

See also fontFamily() and setFont().

### QTextCharFormat.setFontFixedPitch (self, bool fixedPitch)

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

See also fontFixedPitch() and setFont().

### QTextCharFormat.setFontHintingPreference (self, QFont.HintingPreference hintingPreference)

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

This function was introduced in Qt 4.8.

See also fontHintingPreference(), setFont(), and QFont.setHintingPreference().

### QTextCharFormat.setFontItalic (self, bool italic)

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

See also fontItalic() and setFont().

### QTextCharFormat.setFontKerning (self, bool enable)

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.

This function was introduced in Qt 4.5.

See also fontKerning() and setFont().

### QTextCharFormat.setFontLetterSpacing (self, float spacing)

Sets the letter spacing of this format to the given spacing, in percent. A value of 100 indicates default spacing; a value of 200 doubles the amount of space a letter takes.

This function was introduced in Qt 4.4.

See also fontLetterSpacing().

### QTextCharFormat.setFontOverline (self, bool overline)

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

See also fontOverline() and setFont().

### QTextCharFormat.setFontPointSize (self, float size)

Sets the text format's font size.

See also fontPointSize() and setFont().

### QTextCharFormat.setFontStrikeOut (self, bool strikeOut)

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.

See also fontStrikeOut() and setFont().

### QTextCharFormat.setFontStyleHint (self, QFont.StyleHint hint, QFont.StyleStrategy strategy = QFont.PreferDefault)

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.

This function was introduced in Qt 4.5.

See also fontStyleHint(), setFont(), and QFont.setStyleHint().

### QTextCharFormat.setFontStyleStrategy (self, QFont.StyleStrategy strategy)

Sets the font style strategy.

This function was introduced in Qt 4.5.

See also fontStyleStrategy(), setFont(), and QFont.setStyleStrategy().

### QTextCharFormat.setFontUnderline (self, bool underline)

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

See also fontUnderline() and setFont().

### QTextCharFormat.setFontWeight (self, int weight)

Sets the text format's font weight to weight.

See also fontWeight(), setFont(), and QFont.Weight.

### QTextCharFormat.setFontWordSpacing (self, float spacing)

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

This function was introduced in Qt 4.4.

See also fontWordSpacing().

### QTextCharFormat.setTableCellColumnSpan (self, int atableCellColumnSpan)

### QTextCharFormat.setTableCellRowSpan (self, int atableCellRowSpan)

### QTextCharFormat.setTextOutline (self, QPen pen)

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

See also textOutline().

### QTextCharFormat.setToolTip (self, QString tip)

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

This function was introduced in Qt 4.3.

See also toolTip().

### QTextCharFormat.setUnderlineColor (self, QColor color)

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

See also underlineColor().

### QTextCharFormat.setUnderlineStyle (self, UnderlineStyle style)

Sets the style of underlining the text to style.

This function was introduced in Qt 4.2.

See also underlineStyle().

### QTextCharFormat.setVerticalAlignment (self, VerticalAlignment alignment)

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

See also verticalAlignment().

### int QTextCharFormat.tableCellColumnSpan (self)

### int QTextCharFormat.tableCellRowSpan (self)

### QPen QTextCharFormat.textOutline (self)

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

See also setTextOutline().

### QString QTextCharFormat.toolTip (self)

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

This function was introduced in Qt 4.3.

See also setToolTip().

### QColor QTextCharFormat.underlineColor (self)

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

See also setUnderlineColor().

### UnderlineStyle QTextCharFormat.underlineStyle (self)

Returns the style of underlining the text.

This function was introduced in Qt 4.2.

See also setUnderlineStyle().

### VerticalAlignment QTextCharFormat.verticalAlignment (self)

Returns the vertical alignment used for characters with this format.

See also setVerticalAlignment().