QTextFormat

The QTextFormat class provides formatting information for a QTextDocument . More

Inheritance diagram of PySide2.QtGui.QTextFormat

Inherited by: QTextBlockFormat, QTextCharFormat, QTextFrameFormat, QTextImageFormat, QTextListFormat, QTextTableCellFormat, QTextTableFormat

Synopsis

Functions

Detailed Description

A QTextFormat is a generic class used for describing the format of parts of a QTextDocument . The derived classes QTextCharFormat , QTextBlockFormat , QTextListFormat , and QTextTableFormat are usually more useful, and describe the formatting that is applied to specific parts of the document.

A format has a FormatType which specifies the kinds of text item it can format; e.g. a block of text, a list, a table, etc. A format also has various properties (some specific to particular format types), as described by the Property enum. Every property has a corresponding Property.

The format type is given by type() , and the format can be tested with isCharFormat() , isBlockFormat() , isListFormat() , isTableFormat() , isFrameFormat() , and isImageFormat() . If the type is determined, it can be retrieved with toCharFormat() , toBlockFormat() , toListFormat() , toTableFormat() , toFrameFormat() , and toImageFormat() .

A format’s properties can be set with the setProperty() functions, and retrieved with boolProperty() , intProperty() , doubleProperty() , and stringProperty() as appropriate. All the property IDs used in the format can be retrieved with allPropertyIds(). One format can be merged into another using merge() .

A format’s object index can be set with setObjectIndex() , and retrieved with objectIndex() . These methods can be used to associate the format with a QTextObject . It is used to represent lists, frames, and tables inside the document.

class QTextFormat

QTextFormat(rhs)

QTextFormat(type)

param type

int

param rhs

QTextFormat

Creates a new text format with an InvalidFormat .

See also

FormatType

Creates a new text format of the given type .

See also

FormatType

PySide2.QtGui.QTextFormat.FormatType

This enum describes the text item a QTextFormat object is formatting.

Constant

Description

QTextFormat.InvalidFormat

An invalid format as created by the default constructor

QTextFormat.BlockFormat

The object formats a text block

QTextFormat.CharFormat

The object formats a single character

QTextFormat.ListFormat

The object formats a list

QTextFormat.FrameFormat

The object formats a frame

QTextFormat.UserFormat

PySide2.QtGui.QTextFormat.Property

This enum describes the different properties a format can have.

Constant

Description

QTextFormat.ObjectIndex

The index of the formatted object. See objectIndex() .

Paragraph and character properties

Constant

Description

QTextFormat.CssFloat

How a frame is located relative to the surrounding text

QTextFormat.LayoutDirection

The layout direction of the text in the document ( LayoutDirection ).

QTextFormat.OutlinePen

QTextFormat.ForegroundBrush

QTextFormat.BackgroundBrush

QTextFormat.BackgroundImageUrl

Paragraph properties

Constant

Description

QTextFormat.BlockAlignment

QTextFormat.BlockTopMargin

QTextFormat.BlockBottomMargin

QTextFormat.BlockLeftMargin

QTextFormat.BlockRightMargin

QTextFormat.TextIndent

QTextFormat.TabPositions

Specifies the tab positions. The tab positions are structs of Tab which are stored in a QList (internally, in a QList < QVariant >).

QTextFormat.BlockIndent

QTextFormat.LineHeight

QTextFormat.LineHeightType

QTextFormat.BlockNonBreakableLines

QTextFormat.BlockTrailingHorizontalRulerWidth

The width of a horizontal ruler element.

QTextFormat.HeadingLevel

The level of a heading, for example 1 corresponds to an HTML H1 tag; otherwise 0. This enum value has been added in Qt 5.12.

Character properties

Constant

Description

QTextFormat.FontFamily

QTextFormat.FontFamilies

QTextFormat.FontStyleName

QTextFormat.FontPointSize

QTextFormat.FontPixelSize

QTextFormat.FontSizeAdjustment

Specifies the change in size given to the fontsize already set using or .

QTextFormat.FontFixedPitch

QTextFormat.FontWeight

QTextFormat.FontItalic

QTextFormat.FontUnderline

This property has been deprecated. Use instead.

QTextFormat.FontOverline

QTextFormat.FontStrikeOut

QTextFormat.FontCapitalization

Specifies the capitalization type that is to be applied to the text.

QTextFormat.FontLetterSpacingType

Specifies the meaning of the property. The default is PercentageSpacing .

QTextFormat.FontLetterSpacing

Changes the default spacing between individual letters in the font. The value is specified as a percentage or absolute value, depending on . The default value is 100%.

QTextFormat.FontWordSpacing

Changes the default spacing between individual words. A positive value increases the word spacing by the corresponding pixels; a negative value decreases the spacing.

QTextFormat.FontStretch

Corresponds to the Stretch property

QTextFormat.FontStyleHint

Corresponds to the StyleHint property

QTextFormat.FontStyleStrategy

Corresponds to the StyleStrategy property

QTextFormat.FontKerning

Specifies whether the font has kerning turned on.

QTextFormat.FontHintingPreference

Controls the use of hinting according to values of the HintingPreference enum.

QTextFormat.TextUnderlineColor

QTextFormat.TextVerticalAlignment

QTextFormat.TextOutline

QTextFormat.TextUnderlineStyle

QTextFormat.TextToolTip

Specifies the (optional) tool tip to be displayed for a fragment of text.

QTextFormat.IsAnchor

QTextFormat.AnchorHref

QTextFormat.AnchorName

QTextFormat.ObjectType

List properties

Constant

Description

QTextFormat.ListStyle

Specifies the style used for the items in a list, described by values of the Style enum.

QTextFormat.ListIndent

Specifies the amount of indentation used for a list.

QTextFormat.ListNumberPrefix

Defines the text which is prepended to item numbers in numeric lists.

QTextFormat.ListNumberSuffix

Defines the text which is appended to item numbers in numeric lists.

Table and frame properties

Constant

Description

QTextFormat.FrameBorder

QTextFormat.FrameBorderBrush

QTextFormat.FrameBorderStyle

See the BorderStyle enum.

QTextFormat.FrameBottomMargin

QTextFormat.FrameHeight

QTextFormat.FrameLeftMargin

QTextFormat.FrameMargin

QTextFormat.FramePadding

QTextFormat.FrameRightMargin

QTextFormat.FrameTopMargin

QTextFormat.FrameWidth

QTextFormat.TableCellSpacing

QTextFormat.TableCellPadding

QTextFormat.TableColumns

QTextFormat.TableColumnWidthConstraints

QTextFormat.TableHeaderRowCount

Table cell properties

Constant

Description

QTextFormat.TableCellRowSpan

QTextFormat.TableCellColumnSpan

QTextFormat.TableCellLeftPadding

QTextFormat.TableCellRightPadding

QTextFormat.TableCellTopPadding

QTextFormat.TableCellBottomPadding

Image properties

Constant

Description

QTextFormat.ImageName

QTextFormat.ImageWidth

QTextFormat.ImageHeight

QTextFormat.ImageQuality

Selection properties

Constant

Description

QTextFormat.FullWidthSelection

When set on the characterFormat of a selection, the whole width of the text will be shown selected.

Page break properties

Constant

Description

QTextFormat.PageBreakPolicy

Specifies how pages are broken. See the PageBreakFlag enum.

QTextFormat.UserProperty

PySide2.QtGui.QTextFormat.ObjectTypes

This enum describes what kind of QTextObject this format is associated with.

Constant

Description

QTextFormat.NoObject

QTextFormat.ImageObject

QTextFormat.TableObject

QTextFormat.TableCellObject

QTextFormat.UserObject

The first object that can be used for application-specific purposes.

PySide2.QtGui.QTextFormat.PageBreakFlag

This enum describes how page breaking is performed when printing. It maps to the corresponding css properties.

Constant

Description

QTextFormat.PageBreak_Auto

The page break is determined automatically depending on the available space on the current page

QTextFormat.PageBreak_AlwaysBefore

The page is always broken before the paragraph/table

QTextFormat.PageBreak_AlwaysAfter

A new page is always started after the paragraph/table

See also

pageBreakPolicy() pageBreakPolicy() PageBreakPolicy

PySide2.QtGui.QTextFormat.background()
Return type

QBrush

Returns the brush used to paint the document’s background.

PySide2.QtGui.QTextFormat.boolProperty(propertyId)
Parameters

propertyIdint

Return type

bool

Returns the value of the property specified by propertyId . If the property isn’t of QTextFormat::Bool type, false is returned instead.

PySide2.QtGui.QTextFormat.brushProperty(propertyId)
Parameters

propertyIdint

Return type

QBrush

Returns the value of the property given by propertyId ; if the property isn’t of Brush type, NoBrush is returned instead.

PySide2.QtGui.QTextFormat.clearBackground()

Clears the brush used to paint the document’s background. The default brush will be used.

PySide2.QtGui.QTextFormat.clearForeground()

Clears the brush used to paint the document’s foreground. The default brush will be used.

PySide2.QtGui.QTextFormat.clearProperty(propertyId)
Parameters

propertyIdint

Clears the value of the property given by propertyId

See also

Property

PySide2.QtGui.QTextFormat.colorProperty(propertyId)
Parameters

propertyIdint

Return type

QColor

Returns the value of the property given by propertyId ; if the property isn’t of Color type, an invalid color is returned instead.

PySide2.QtGui.QTextFormat.doubleProperty(propertyId)
Parameters

propertyIdint

Return type

qreal

Returns the value of the property specified by propertyId . If the property isn’t of Double or Float type, 0 is returned instead.

PySide2.QtGui.QTextFormat.foreground()
Return type

QBrush

Returns the brush used to render foreground details, such as text, frame outlines, and table borders.

PySide2.QtGui.QTextFormat.hasProperty(propertyId)
Parameters

propertyIdint

Return type

bool

Returns true if the text format has a property with the given propertyId ; otherwise returns false .

See also

properties() Property

PySide2.QtGui.QTextFormat.intProperty(propertyId)
Parameters

propertyIdint

Return type

int

Returns the value of the property specified by propertyId . If the property is not of QTextFormat::Integer type, 0 is returned instead.

PySide2.QtGui.QTextFormat.isBlockFormat()
Return type

bool

Returns true if this text format is a BlockFormat ; otherwise returns false .

PySide2.QtGui.QTextFormat.isCharFormat()
Return type

bool

Returns true if this text format is a CharFormat ; otherwise returns false .

PySide2.QtGui.QTextFormat.isEmpty()
Return type

bool

Returns true if the format does not store any properties; false otherwise.

PySide2.QtGui.QTextFormat.isFrameFormat()
Return type

bool

Returns true if this text format is a FrameFormat ; otherwise returns false .

PySide2.QtGui.QTextFormat.isImageFormat()
Return type

bool

Returns true if this text format is an image format; otherwise returns false .

PySide2.QtGui.QTextFormat.isListFormat()
Return type

bool

Returns true if this text format is a ListFormat ; otherwise returns false .

PySide2.QtGui.QTextFormat.isTableCellFormat()
Return type

bool

Returns true if this text format is a TableCellFormat ; otherwise returns false .

PySide2.QtGui.QTextFormat.isTableFormat()
Return type

bool

Returns true if this text format is a TableFormat ; otherwise returns false .

PySide2.QtGui.QTextFormat.isValid()
Return type

bool

Returns true if the format is valid (i.e. is not InvalidFormat ); otherwise returns false .

PySide2.QtGui.QTextFormat.layoutDirection()
Return type

LayoutDirection

Returns the document’s layout direction.

PySide2.QtGui.QTextFormat.lengthProperty(propertyId)
Parameters

propertyIdint

Return type

QTextLength

Returns the value of the property given by propertyId .

PySide2.QtGui.QTextFormat.lengthVectorProperty(propertyId)
Parameters

propertyIdint

Return type

Returns the value of the property given by propertyId . If the property isn’t of QTextFormat::LengthVector type, an empty length vector is returned instead.

PySide2.QtGui.QTextFormat.merge(other)
Parameters

otherQTextFormat

Merges the other format with this format; where there are conflicts the other format takes precedence.

PySide2.QtGui.QTextFormat.objectIndex()
Return type

int

Returns the index of the format object, or -1 if the format object is invalid.

See also

setObjectIndex()

PySide2.QtGui.QTextFormat.objectType()
Return type

int

Returns the text format’s object type.

See also

ObjectTypes setObjectType()

PySide2.QtGui.QTextFormat.__ne__(rhs)
Parameters

rhsQTextFormat

Return type

bool

Returns true if this text format is different from the other text format.

PySide2.QtGui.QTextFormat.__eq__(rhs)
Parameters

rhsQTextFormat

Return type

bool

Returns true if this text format is the same as the other text format.

PySide2.QtGui.QTextFormat.penProperty(propertyId)
Parameters

propertyIdint

Return type

QPen

Returns the value of the property given by propertyId ; if the property isn’t of Pen type, NoPen is returned instead.

PySide2.QtGui.QTextFormat.properties()
Return type

Returns a map with all properties of this text format.

PySide2.QtGui.QTextFormat.property(propertyId)
Parameters

propertyIdint

Return type

object

Returns the property specified by the given propertyId .

See also

setProperty() Property

PySide2.QtGui.QTextFormat.propertyCount()
Return type

int

Returns the number of properties stored in the format.

PySide2.QtGui.QTextFormat.setBackground(brush)
Parameters

brushQBrush

Sets the brush use to paint the document’s background to the brush specified.

PySide2.QtGui.QTextFormat.setForeground(brush)
Parameters

brushQBrush

Sets the foreground brush to the specified brush . The foreground brush is mostly used to render text.

PySide2.QtGui.QTextFormat.setLayoutDirection(direction)
Parameters

directionLayoutDirection

Sets the document’s layout direction to the specified direction .

PySide2.QtGui.QTextFormat.setObjectIndex(object)
Parameters

objectint

Sets the format object’s object index .

See also

objectIndex()

PySide2.QtGui.QTextFormat.setObjectType(type)
Parameters

typeint

Sets the text format’s object type to type .

See also

ObjectTypes objectType()

PySide2.QtGui.QTextFormat.setProperty(propertyId, value)
Parameters
  • propertyIdint

  • value – object

PySide2.QtGui.QTextFormat.setProperty(propertyId, lengths)
Parameters
  • propertyIdint

  • lengths

PySide2.QtGui.QTextFormat.stringProperty(propertyId)
Parameters

propertyIdint

Return type

unicode

Returns the value of the property given by propertyId ; if the property isn’t of String type, an empty string is returned instead.

PySide2.QtGui.QTextFormat.swap(other)
Parameters

otherQTextFormat

Swaps this text format with other . This function is very fast and never fails.

PySide2.QtGui.QTextFormat.toBlockFormat()
Return type

QTextBlockFormat

Returns this format as a block format.

PySide2.QtGui.QTextFormat.toCharFormat()
Return type

QTextCharFormat

Returns this format as a character format.

PySide2.QtGui.QTextFormat.toFrameFormat()
Return type

QTextFrameFormat

Returns this format as a frame format.

PySide2.QtGui.QTextFormat.toImageFormat()
Return type

QTextImageFormat

Returns this format as an image format.

PySide2.QtGui.QTextFormat.toListFormat()
Return type

QTextListFormat

Returns this format as a list format.

PySide2.QtGui.QTextFormat.toTableCellFormat()
Return type

QTextTableCellFormat

Returns this format as a table cell format.

PySide2.QtGui.QTextFormat.toTableFormat()
Return type

QTextTableFormat

Returns this format as a table format.

PySide2.QtGui.QTextFormat.type()
Return type

int

Returns the type of this format.

See also

FormatType