QTextFormat ¶

概要 ¶

详细描述 ¶

A QTextFormat is a generic class used for describing the format of parts of a QTextDocument . The derived classes QTextCharFormat , QTextBlockFormat , QTextListFormat ，和 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() ，和 isImageFormat() . If the type is determined, it can be retrieved with toCharFormat() , toBlockFormat() , toListFormat() , toTableFormat() , toFrameFormat() ，和 toImageFormat() .

A format’s properties can be set with the setProperty() functions, and retrieved with boolProperty() , intProperty() , doubleProperty() ，和 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 .

另请参阅

FormatType

Creates a new text format of the given type .

另请参阅

FormatType

PySide2.QtGui.QTextFormat. FormatType ¶

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

常量	描述
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

另请参阅

QTextCharFormat QTextBlockFormat QTextListFormat QTextTableFormat type()

PySide2.QtGui.QTextFormat. 特性 ¶

This enum describes the different properties a format can have.

常量	描述
QTextFormat.ObjectIndex	The index of the formatted object. See objectIndex() .

Paragraph and character properties

常量	描述
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

常量	描述
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	type of adornment to be shown alongside the block. This enum value has been added in Qt 5.14.

Character properties

常量	描述
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	相当于 Stretch 特性
QTextFormat.FontStyleHint	相当于 StyleHint 特性
QTextFormat.FontStyleStrategy	相当于 StyleStrategy 特性
QTextFormat.FontKerning	Specifies whether the font has kerning turned on.
QTextFormat.FontHintingPreference	Controls the use of hinting according to values of the HintingPreference 枚举。
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

常量	描述
QTextFormat.ListStyle	Specifies the style used for the items in a list, described by values of the Style 枚举。
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

常量	描述
QTextFormat.FrameBorder
QTextFormat.FrameBorderBrush
QTextFormat.FrameBorderStyle	见 BorderStyle 枚举。
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 特性。

Table cell properties

常量	描述
QTextFormat.TableCellRowSpan
QTextFormat.TableCellColumnSpan
QTextFormat.TableCellLeftPadding
QTextFormat.TableCellRightPadding
QTextFormat.TableCellTopPadding
QTextFormat.TableCellBottomPadding

Table cell properties intended for use with borderCollapse enabled

常量	描述
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

常量	描述
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

常量	描述
QTextFormat.FullWidthSelection	When set on the characterFormat of a selection, the whole width of the text will be shown selected.

Page break properties

常量	描述
QTextFormat.PageBreakPolicy	Specifies how pages are broken. See the PageBreakFlag 枚举。
QTextFormat.UserProperty

另请参阅

property() setProperty()

PySide2.QtGui.QTextFormat. ObjectTypes ¶

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

常量	描述
QTextFormat.NoObject
QTextFormat.ImageObject
QTextFormat.TableObject
QTextFormat.TableCellObject
QTextFormat.UserObject	The first object that can be used for application-specific purposes.

另请参阅

QTextObject QTextTable format()

PySide2.QtGui.QTextFormat. PageBreakFlag ¶

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

常量	描述
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

另请参阅

pageBreakPolicy() pageBreakPolicy() PageBreakPolicy

PySide2.QtGui.QTextFormat. background ( ) ¶

返回类型

QBrush

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

另请参阅

setBackground() clearBackground() foreground()

PySide2.QtGui.QTextFormat. boolProperty ( propertyId ) ¶

参数

propertyId – int

返回类型

bool

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

另请参阅

setProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() 特性

PySide2.QtGui.QTextFormat. brushProperty ( propertyId ) ¶

参数

propertyId – int

返回类型

QBrush

Returns the value of the property given by propertyId ; if the property isn’t of Brush type, NoBrush 被返回取而代之。

另请参阅

setProperty() boolProperty() intProperty() doubleProperty() stringProperty() lengthProperty() lengthVectorProperty() 特性

PySide2.QtGui.QTextFormat. clearBackground ( ) ¶

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

另请参阅

background() setBackground() clearForeground()

PySide2.QtGui.QTextFormat. clearForeground ( ) ¶

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

另请参阅

foreground() setForeground() clearBackground()

PySide2.QtGui.QTextFormat. clearProperty ( propertyId ) ¶

参数

propertyId – int

Clears the value of the property given by propertyId

另请参阅

特性

PySide2.QtGui.QTextFormat. colorProperty ( propertyId ) ¶

参数

propertyId – int

返回类型

QColor

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

另请参阅

setProperty() boolProperty() intProperty() doubleProperty() stringProperty() lengthProperty() lengthVectorProperty() 特性

PySide2.QtGui.QTextFormat. doubleProperty ( propertyId ) ¶

参数

propertyId – int

返回类型

qreal

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

另请参阅

setProperty() boolProperty() intProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() 特性

PySide2.QtGui.QTextFormat. foreground ( ) ¶

返回类型

QBrush

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

另请参阅

setForeground() clearForeground() background()

PySide2.QtGui.QTextFormat. hasProperty ( propertyId ) ¶

参数

propertyId – int

返回类型

bool

返回 true if the text format has a property with the given propertyId ；否则返回 false .

另请参阅

properties() 特性

PySide2.QtGui.QTextFormat. intProperty ( propertyId ) ¶

参数

propertyId – int

返回类型

int

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

另请参阅

setProperty() boolProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() 特性

PySide2.QtGui.QTextFormat. isBlockFormat ( ) ¶

返回类型

bool

返回 true if this text format is a BlockFormat ；否则返回 false .

PySide2.QtGui.QTextFormat. isCharFormat ( ) ¶

返回类型

bool

返回 true if this text format is a CharFormat ；否则返回 false .

PySide2.QtGui.QTextFormat. isEmpty ( ) ¶

返回类型

bool

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

另请参阅

propertyCount() properties()

PySide2.QtGui.QTextFormat. isFrameFormat ( ) ¶

返回类型

bool

返回 true if this text format is a FrameFormat ；否则返回 false .

PySide2.QtGui.QTextFormat. isImageFormat ( ) ¶

返回类型

bool

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

PySide2.QtGui.QTextFormat. isListFormat ( ) ¶

返回类型

bool

返回 true if this text format is a ListFormat ；否则返回 false .

PySide2.QtGui.QTextFormat. isTableCellFormat ( ) ¶

返回类型

bool

返回 true if this text format is a TableCellFormat ；否则返回 false .

PySide2.QtGui.QTextFormat. isTableFormat ( ) ¶

返回类型

bool

返回 true if this text format is a TableFormat ；否则返回 false .

PySide2.QtGui.QTextFormat. isValid ( ) ¶

返回类型

bool

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

PySide2.QtGui.QTextFormat. layoutDirection ( ) ¶

返回类型

LayoutDirection

Returns the document’s layout direction.

另请参阅

setLayoutDirection()

PySide2.QtGui.QTextFormat. lengthProperty ( propertyId ) ¶

参数

propertyId – int

返回类型

QTextLength

Returns the value of the property given by propertyId .

另请参阅

setProperty() boolProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthVectorProperty() 特性

PySide2.QtGui.QTextFormat. lengthVectorProperty ( propertyId ) ¶

参数

propertyId – int

返回类型

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.

另请参阅

setProperty() boolProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() 特性

PySide2.QtGui.QTextFormat. merge ( other ) ¶

参数

other – QTextFormat

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

PySide2.QtGui.QTextFormat. objectIndex ( ) ¶

返回类型

int

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

另请参阅

setObjectIndex()

PySide2.QtGui.QTextFormat. objectType ( ) ¶

返回类型

int

Returns the text format’s object type.

另请参阅

ObjectTypes setObjectType()

PySide2.QtGui.QTextFormat. __ne__ ( rhs ) ¶

参数

rhs – QTextFormat

返回类型

bool

返回 true if this text format is different from the other text format.

PySide2.QtGui.QTextFormat. __eq__ ( rhs ) ¶

参数

rhs – QTextFormat

返回类型

bool

返回 true if this text format is the same as the other text format.

PySide2.QtGui.QTextFormat. penProperty ( propertyId ) ¶

参数

propertyId – int

返回类型

QPen

Returns the value of the property given by propertyId ; if the property isn’t of Pen type, NoPen 被返回取而代之。

另请参阅

setProperty() boolProperty() intProperty() doubleProperty() stringProperty() lengthProperty() lengthVectorProperty() 特性

PySide2.QtGui.QTextFormat. properties ( ) ¶

返回类型

Returns a map with all properties of this text format.

PySide2.QtGui.QTextFormat. 特性 ( propertyId ) ¶

参数

propertyId – int

返回类型

object

Returns the property specified by the given propertyId .

另请参阅

setProperty() 特性

PySide2.QtGui.QTextFormat. propertyCount ( ) ¶

返回类型

int

Returns the number of properties stored in the format.

PySide2.QtGui.QTextFormat. setBackground ( brush ) ¶

参数

brush – QBrush

Sets the brush use to paint the document’s background to the brush 指定。

另请参阅

background() clearBackground() setForeground()

PySide2.QtGui.QTextFormat. setForeground ( brush ) ¶

参数

brush – QBrush

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

另请参阅

foreground() clearForeground() setBackground()

PySide2.QtGui.QTextFormat. setLayoutDirection ( direction ) ¶

参数

direction – LayoutDirection

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

另请参阅

layoutDirection()

PySide2.QtGui.QTextFormat. setObjectIndex ( object ) ¶

参数

object – int

Sets the format object’s object index .

另请参阅

objectIndex()

PySide2.QtGui.QTextFormat. setObjectType ( type ) ¶

参数

type – int

Sets the text format’s object type to type .

另请参阅

ObjectTypes objectType()

PySide2.QtGui.QTextFormat. setProperty ( propertyId , value ) ¶

参数

• propertyId – int

• value – object

PySide2.QtGui.QTextFormat. setProperty ( propertyId , lengths ) ¶

参数

• propertyId – int

• lengths –

PySide2.QtGui.QTextFormat. stringProperty ( propertyId ) ¶

参数

propertyId – int

返回类型

unicode

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

另请参阅

setProperty() boolProperty() intProperty() doubleProperty() colorProperty() lengthProperty() lengthVectorProperty() 特性

PySide2.QtGui.QTextFormat. swap ( other ) ¶

参数

other – QTextFormat

Swaps this text format with other 。此函数非常快，且从不失败。

PySide2.QtGui.QTextFormat. toBlockFormat ( ) ¶

返回类型

QTextBlockFormat

Returns this format as a block format.

PySide2.QtGui.QTextFormat. toCharFormat ( ) ¶

返回类型

QTextCharFormat

Returns this format as a character format.

PySide2.QtGui.QTextFormat. toFrameFormat ( ) ¶

返回类型

QTextFrameFormat

Returns this format as a frame format.

PySide2.QtGui.QTextFormat. toImageFormat ( ) ¶

返回类型

QTextImageFormat

Returns this format as an image format.

PySide2.QtGui.QTextFormat. toListFormat ( ) ¶

返回类型

QTextListFormat

Returns this format as a list format.

PySide2.QtGui.QTextFormat. toTableCellFormat ( ) ¶

返回类型

QTextTableCellFormat

Returns this format as a table cell format.

PySide2.QtGui.QTextFormat. toTableFormat ( ) ¶

返回类型

QTextTableFormat

Returns this format as a table format.

PySide2.QtGui.QTextFormat. type ( ) ¶

返回类型

int

Returns the type of this format.

另请参阅

FormatType