QTextFormat

The QTextFormat class provides formatting information for a QTextDocument . More…

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

Synopsis

Functions

• def __eq__ (rhs)

• def __ne__ (rhs)

• def background ()

• def boolProperty (propertyId)

• def brushProperty (propertyId)

• def clearBackground ()

• def clearForeground ()

• def clearProperty (propertyId)

• def colorProperty (propertyId)

• def doubleProperty (propertyId)

• def foreground ()

• def hasProperty (propertyId)

• def intProperty (propertyId)

• def isBlockFormat ()

• def isCharFormat ()

• def isEmpty ()

• def isFrameFormat ()

• def isImageFormat ()

• def isListFormat ()

• def isTableCellFormat ()

• def isTableFormat ()

• def isValid ()

• def layoutDirection ()

• def lengthProperty (propertyId)

• def lengthVectorProperty (propertyId)

• def merge (other)

• def objectIndex ()

• def objectType ()

• def penProperty (propertyId)

• def properties ()

• def property (propertyId)

• def propertyCount ()

• def setBackground (brush)

• def setForeground (brush)

• def setLayoutDirection (direction)

• def setObjectIndex (object)

• def setObjectType (type)

• def setProperty (propertyId, lengths)

• def setProperty (propertyId, value)

• def stringProperty (propertyId)

• def swap (other)

• def toBlockFormat ()

• def toCharFormat ()

• def toFrameFormat ()

• def toImageFormat ()

• def toListFormat ()

• def toTableCellFormat ()

• def toTableFormat ()

• def type ()

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.

See also

Rich Text Processing

class PySide6.QtGui.QTextFormat

PySide6.QtGui.QTextFormat(rhs)

PySide6.QtGui.QTextFormat(type)

Parameters

• rhs – PySide6.QtGui.QTextFormat

• type – int

Creates a new text format with an InvalidFormat.

See also

FormatType

Creates a new text format with the same attributes as the other text format.

Creates a new text format of the given type.

See also

FormatType

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

See also

QTextCharFormat QTextBlockFormat QTextListFormat QTextTableFormat type()

PySide6.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.
QTextFormat.BlockCodeFence	The character that was used in the “fences” around a Markdown code block. If the code block was indented rather than fenced, the block should not have this property. This enum value has been added in Qt 5.14.
QTextFormat.BlockQuoteLevel	The depth of nested quoting on this block: 1 means the block is a top-level block quote. Blocks that are not block quotes should not have this property. This enum value has been added in Qt 5.14.
QTextFormat.BlockCodeLanguage	The programming language in a preformatted or code block. Blocks that do not contain code should not have this property. This enum value has been added in Qt 5.14.
QTextFormat.BlockMarker	The type of adornment to be shown alongside the block. This enum value has been added in Qt 5.14.

Character properties

Constant	Description
QTextFormat.FontFamily	e{This property has been deprecated.} Use instead.
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	Specifies the color to draw underlines, overlines and strikeouts.
QTextFormat.TextVerticalAlignment
QTextFormat.TextOutline
QTextFormat.TextUnderlineStyle
QTextFormat.TextToolTip	Specifies the (optional) tool tip to be displayed for a fragment of text.
QTextFormat.TextSuperScriptBaseline	Specifies the baseline (in % of height) of superscript texts.
QTextFormat.TextSubScriptBaseline	Specifies the baseline (in % of height) of subscript texts.
QTextFormat.TextBaselineOffset	Specifies the baseline (in % of height) of text. A positive value moves up the text, by the corresponding %; a negative value moves it down.
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
QTextFormat.TableBorderCollapse	Specifies the borderCollapse property.

Table cell properties

Constant	Description
QTextFormat.TableCellRowSpan
QTextFormat.TableCellColumnSpan
QTextFormat.TableCellLeftPadding
QTextFormat.TableCellRightPadding
QTextFormat.TableCellTopPadding
QTextFormat.TableCellBottomPadding

Table cell properties intended for use with borderCollapse enabled

Constant	Description
QTextFormat.TableCellTopBorder
QTextFormat.TableCellBottomBorder
QTextFormat.TableCellLeftBorder
QTextFormat.TableCellRightBorder
QTextFormat.TableCellTopBorderStyle
QTextFormat.TableCellBottomBorderStyle
QTextFormat.TableCellLeftBorderStyle
QTextFormat.TableCellRightBorderStyle
QTextFormat.TableCellTopBorderBrush
QTextFormat.TableCellBottomBorderBrush
QTextFormat.TableCellLeftBorderBrush
QTextFormat.TableCellRightBorderBrush

Image properties

Constant	Description
QTextFormat.ImageName	The filename or source of the image.
QTextFormat.ImageTitle	The title attribute of an HTML image tag, or the quoted string that comes after the URL in a Markdown image link. This enum value has been added in Qt 5.14.
QTextFormat.ImageAltText	The alt attribute of an HTML image tag, or the image description in a Markdown image link. This enum value has been added in Qt 5.14.
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

See also

property() setProperty()

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

See also

QTextObject QTextTable format()

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

PySide6.QtGui.QTextFormat.background()

Return type

PySide6.QtGui.QBrush

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

See also

setBackground() clearBackground() foreground()

PySide6.QtGui.QTextFormat.boolProperty(propertyId)

Parameters

propertyId – int

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.

See also

setProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() Property

PySide6.QtGui.QTextFormat.brushProperty(propertyId)

Parameters

propertyId – int

Return type

PySide6.QtGui.QBrush

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

See also

setProperty() boolProperty() intProperty() doubleProperty() stringProperty() lengthProperty() lengthVectorProperty() Property

PySide6.QtGui.QTextFormat.clearBackground()

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

See also

background() setBackground() clearForeground()

PySide6.QtGui.QTextFormat.clearForeground()

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

See also

foreground() setForeground() clearBackground()

PySide6.QtGui.QTextFormat.clearProperty(propertyId)

Parameters

propertyId – int

Clears the value of the property given by propertyId

See also

Property

PySide6.QtGui.QTextFormat.colorProperty(propertyId)

Parameters

propertyId – int

Return type

PySide6.QtGui.QColor

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

See also

setProperty() boolProperty() intProperty() doubleProperty() stringProperty() lengthProperty() lengthVectorProperty() Property

PySide6.QtGui.QTextFormat.doubleProperty(propertyId)

Parameters

propertyId – int

Return type

float

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

See also

setProperty() boolProperty() intProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() Property

PySide6.QtGui.QTextFormat.foreground()

Return type

PySide6.QtGui.QBrush

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

See also

setForeground() clearForeground() background()

PySide6.QtGui.QTextFormat.hasProperty(propertyId)

Parameters

propertyId – int

Return type

bool

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

See also

properties() Property

PySide6.QtGui.QTextFormat.intProperty(propertyId)

Parameters

propertyId – int

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.

See also

setProperty() boolProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() Property

PySide6.QtGui.QTextFormat.isBlockFormat()

Return type

bool

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

PySide6.QtGui.QTextFormat.isCharFormat()

Return type

bool

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

PySide6.QtGui.QTextFormat.isEmpty()

Return type

bool

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

See also

propertyCount() properties()

PySide6.QtGui.QTextFormat.isFrameFormat()

Return type

bool

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

PySide6.QtGui.QTextFormat.isImageFormat()

Return type

bool

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

PySide6.QtGui.QTextFormat.isListFormat()

Return type

bool

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

PySide6.QtGui.QTextFormat.isTableCellFormat()

Return type

bool

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

PySide6.QtGui.QTextFormat.isTableFormat()

Return type

bool

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

PySide6.QtGui.QTextFormat.isValid()

Return type

bool

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

PySide6.QtGui.QTextFormat.layoutDirection()

Return type

LayoutDirection

Returns the document’s layout direction.

See also

setLayoutDirection()

PySide6.QtGui.QTextFormat.lengthProperty(propertyId)

Parameters

propertyId – int

Return type

PySide6.QtGui.QTextLength

Returns the value of the property given by propertyId.

See also

setProperty() boolProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthVectorProperty() Property

PySide6.QtGui.QTextFormat.lengthVectorProperty(propertyId)

Parameters

propertyId – int

Return type

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

See also

setProperty() boolProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() Property

PySide6.QtGui.QTextFormat.merge(other)

Parameters

other – PySide6.QtGui.QTextFormat

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

PySide6.QtGui.QTextFormat.objectIndex()

Return type

int

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

See also

setObjectIndex()

PySide6.QtGui.QTextFormat.objectType()

Return type

int

Returns the text format’s object type.

See also

ObjectTypes setObjectType()

PySide6.QtGui.QTextFormat.__ne__(rhs)

Parameters

rhs – PySide6.QtGui.QTextFormat

Return type

bool

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

PySide6.QtGui.QTextFormat.__eq__(rhs)

Parameters

rhs – PySide6.QtGui.QTextFormat

Return type

bool

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

PySide6.QtGui.QTextFormat.penProperty(propertyId)

Parameters

propertyId – int

Return type

PySide6.QtGui.QPen

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

See also

setProperty() boolProperty() intProperty() doubleProperty() stringProperty() lengthProperty() lengthVectorProperty() Property

PySide6.QtGui.QTextFormat.properties()

Return type

Returns a map with all properties of this text format.

PySide6.QtGui.QTextFormat.property(propertyId)

Parameters

propertyId – int

Return type

object

Returns the property specified by the given propertyId.

See also

setProperty() Property

PySide6.QtGui.QTextFormat.propertyCount()

Return type

int

Returns the number of properties stored in the format.

PySide6.QtGui.QTextFormat.setBackground(brush)

Parameters

brush – PySide6.QtGui.QBrush

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

See also

background() clearBackground() setForeground()

PySide6.QtGui.QTextFormat.setForeground(brush)

Parameters

brush – PySide6.QtGui.QBrush

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

See also

foreground() clearForeground() setBackground()

PySide6.QtGui.QTextFormat.setLayoutDirection(direction)

Parameters

direction – LayoutDirection

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

See also

layoutDirection()

PySide6.QtGui.QTextFormat.setObjectIndex(object)

Parameters

object – int

Sets the format object’s object index.

See also

objectIndex()

PySide6.QtGui.QTextFormat.setObjectType(type)

Parameters

type – int

Sets the text format’s object type to type.

See also

ObjectTypes objectType()

PySide6.QtGui.QTextFormat.setProperty(propertyId, lengths)

Parameters

• propertyId – int

• lengths –

PySide6.QtGui.QTextFormat.setProperty(propertyId, value)

Parameters

• propertyId – int

• value – object

Sets the property specified by the propertyId to the given value.

See also

property() Property

PySide6.QtGui.QTextFormat.stringProperty(propertyId)

Parameters

propertyId – int

Return type

str

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

See also

setProperty() boolProperty() intProperty() doubleProperty() colorProperty() lengthProperty() lengthVectorProperty() Property

PySide6.QtGui.QTextFormat.swap(other)

Parameters

other – PySide6.QtGui.QTextFormat

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

PySide6.QtGui.QTextFormat.toBlockFormat()

Return type

PySide6.QtGui.QTextBlockFormat

Returns this format as a block format.

PySide6.QtGui.QTextFormat.toCharFormat()

Return type

PySide6.QtGui.QTextCharFormat

Returns this format as a character format.

PySide6.QtGui.QTextFormat.toFrameFormat()

Return type

PySide6.QtGui.QTextFrameFormat

Returns this format as a frame format.

PySide6.QtGui.QTextFormat.toImageFormat()

Return type

PySide6.QtGui.QTextImageFormat

Returns this format as an image format.

PySide6.QtGui.QTextFormat.toListFormat()

Return type

PySide6.QtGui.QTextListFormat

Returns this format as a list format.

PySide6.QtGui.QTextFormat.toTableCellFormat()

Return type

PySide6.QtGui.QTextTableCellFormat

Returns this format as a table cell format.

PySide6.QtGui.QTextFormat.toTableFormat()

Return type

PySide6.QtGui.QTextTableFormat

Returns this format as a table format.

PySide6.QtGui.QTextFormat.type()

Return type

int

Returns the type of this format.

See also

FormatType