Home · All Classes · Modules

QTextFormat Class Reference
^{^{[QtGui module]}}

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

Inherited by QTextBlockFormat, QTextCharFormat, QTextFrameFormat and QTextListFormat.

Types

enum FormatType { InvalidFormat, BlockFormat, CharFormat, ListFormat, ..., UserFormat }
enum ObjectTypes { NoObject, ImageObject, TableObject, TableCellObject, UserObject }
enum PageBreakFlag { PageBreak_Auto, PageBreak_AlwaysBefore, PageBreak_AlwaysAfter }
class PageBreakFlags
enum Property { ObjectIndex, CssFloat, LayoutDirection, OutlinePen, ..., UserProperty }

Methods

__init__ (self)
__init__ (self, int type)
__init__ (self, QTextFormat rhs)
__init__ (self, QVariant variant)
QBrush background (self)
bool boolProperty (self, int propertyId)
QBrush brushProperty (self, int propertyId)
clearBackground (self)
clearForeground (self)
clearProperty (self, int propertyId)
QColor colorProperty (self, int propertyId)
float doubleProperty (self, int propertyId)
QBrush foreground (self)
bool hasProperty (self, int propertyId)
int intProperty (self, int propertyId)
bool isBlockFormat (self)
bool isCharFormat (self)
bool isFrameFormat (self)
bool isImageFormat (self)
bool isListFormat (self)
bool isTableCellFormat (self)
bool isTableFormat (self)
bool isValid (self)
Qt.LayoutDirection layoutDirection (self)
QTextLength lengthProperty (self, int propertyId)
list-of-QTextLength lengthVectorProperty (self, int propertyId)
merge (self, QTextFormat other)
int objectIndex (self)
int objectType (self)
QPen penProperty (self, int propertyId)
dict-of-int-QVariant properties (self)
QVariant property (self, int propertyId)
int propertyCount (self)
setBackground (self, QBrush brush)
setForeground (self, QBrush brush)
setLayoutDirection (self, Qt.LayoutDirection direction)
setObjectIndex (self, int object)
setObjectType (self, int atype)
setProperty (self, int propertyId, QVariant value)
setProperty (self, int propertyId, list-of-QTextLength lengths)
QString stringProperty (self, int propertyId)
QTextBlockFormat toBlockFormat (self)
QTextCharFormat toCharFormat (self)
QTextFrameFormat toFrameFormat (self)
QTextImageFormat toImageFormat (self)
QTextListFormat toListFormat (self)
QTextTableCellFormat toTableCellFormat (self)
QTextTableFormat toTableFormat (self)
int type (self)

Special Methods

bool __eq__ (self, QTextFormat rhs)
bool __ne__ (self, QTextFormat rhs)

Detailed Description

The QTextFormat class provides formatting information for a QTextDocument.

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.

Type Documentation

QTextFormat.FormatType

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

Constant	Value	Description
`QTextFormat.InvalidFormat`	`-1`	An invalid format as created by the default constructor
`QTextFormat.BlockFormat`	`1`	The object formats a text block
`QTextFormat.CharFormat`	`2`	The object formats a single character
`QTextFormat.ListFormat`	`3`	The object formats a list
`QTextFormat.TableFormat`	`4`	The object formats a table
`QTextFormat.FrameFormat`	`5`	The object formats a frame
`QTextFormat.UserFormat`	`100`

QTextFormat.ObjectTypes

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

Constant	Value	Description
`QTextFormat.NoObject`	`0`
`QTextFormat.ImageObject`	`1`
`QTextFormat.TableObject`	`2`
`QTextFormat.TableCellObject`	`3`
`QTextFormat.UserObject`	`0x1000`	The first object that can be used for application-specific purposes.

See also QTextObject, QTextTable, and QTextObject.format().

QTextFormat.PageBreakFlag

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

Constant	Value	Description
`QTextFormat.PageBreak_Auto`	`0`	The page break is determined automatically depending on the available space on the current page
`QTextFormat.PageBreak_AlwaysBefore`	`0x001`	The page is always broken before the paragraph/table
`QTextFormat.PageBreak_AlwaysAfter`	`0x010`	A new page is always started after the paragraph/table

This enum was introduced or modified in Qt 4.2.

The PageBreakFlags type is a typedef for QFlags<PageBreakFlag>. It stores an OR combination of PageBreakFlag values.

QTextFormat.Property

This enum describes the different properties a format can have.

Constant	Value	Description
`QTextFormat.ObjectIndex`	`0x0`	The index of the formatted object. See objectIndex().

Paragraph and character properties

Constant	Value	Description
`QTextFormat.CssFloat`	`0x0800`	How a frame is located relative to the surrounding text
`QTextFormat.LayoutDirection`	`0x0801`	The layout direction of the text in the document (Qt.LayoutDirection).
`QTextFormat.OutlinePen`	`0x810`
`QTextFormat.ForegroundBrush`	`0x821`
`QTextFormat.BackgroundBrush`	`0x820`
`QTextFormat.BackgroundImageUrl`	`0x823`

Paragraph properties

Constant	Value	Description
`QTextFormat.BlockAlignment`	`0x1010`
`QTextFormat.BlockTopMargin`	`0x1030`
`QTextFormat.BlockBottomMargin`	`0x1031`
`QTextFormat.BlockLeftMargin`	`0x1032`
`QTextFormat.BlockRightMargin`	`0x1033`
`QTextFormat.TextIndent`	`0x1034`
`QTextFormat.TabPositions`	`0x1035`	Specifies the tab positions. The tab positions are structs of QTextOption.Tab which are stored in a QList (internally, in a QList<QVariant>).
`QTextFormat.BlockIndent`	`0x1040`
`QTextFormat.LineHeight`	`0x1048`
`QTextFormat.LineHeightType`	`0x1049`
`QTextFormat.BlockNonBreakableLines`	`0x1050`
`QTextFormat.BlockTrailingHorizontalRulerWidth`	`0x1060`	The width of a horizontal ruler element.

Character properties

Constant	Value	Description
`QTextFormat.FontFamily`	`0x2000`
`QTextFormat.FontPointSize`	`0x2001`
`QTextFormat.FontPixelSize`	`0x2009`
`QTextFormat.FontSizeAdjustment`	`0x2002`	Specifies the change in size given to the fontsize already set using FontPointSize or FontPixelSize.
`QTextFormat.FontFixedPitch`	`0x2008`
`QTextFormat.FontWeight`	`0x2003`
`QTextFormat.FontItalic`	`0x2004`
`QTextFormat.FontUnderline`	`0x2005`	This property has been deprecated. Use QTextFormat.TextUnderlineStyle instead.
`QTextFormat.FontOverline`	`0x2006`
`QTextFormat.FontStrikeOut`	`0x2007`
`QTextFormat.FontCapitalization`	`FirstFontProperty`	Specifies the capitalization type that is to be applied to the text.
`QTextFormat.FontLetterSpacing`	`0x1FE1`	Changes the default spacing between individual letters in the font. The value is specified in percentage, with 100 as the default value.
`QTextFormat.FontWordSpacing`	`0x1FE2`	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.FontStyleHint`	`0x1FE3`	Corresponds to the QFont.StyleHint property
`QTextFormat.FontStyleStrategy`	`0x1FE4`	Corresponds to the QFont.StyleStrategy property
`QTextFormat.FontKerning`	`0x1FE5`	Specifies whether the font has kerning turned on.
`QTextFormat.FontHintingPreference`	`0x1FE6`	Controls the use of hinting according to values of the QFont.HintingPreference enum.
`QTextFormat.TextUnderlineColor`	`0x2010`
`QTextFormat.TextVerticalAlignment`	`0x2021`
`QTextFormat.TextOutline`	`0x2022`
`QTextFormat.TextUnderlineStyle`	`0x2023`
`QTextFormat.TextToolTip`	`0x2024`	Specifies the (optional) tool tip to be displayed for a fragment of text.
`QTextFormat.IsAnchor`	`0x2030`
`QTextFormat.AnchorHref`	`0x2031`
`QTextFormat.AnchorName`	`0x2032`
`QTextFormat.ObjectType`	`0x2f00`

List properties

Constant	Value	Description
`QTextFormat.ListStyle`	`0x3000`	Specifies the style used for the items in a list, described by values of the QTextListFormat.Style enum.
`QTextFormat.ListIndent`	`0x3001`	Specifies the amount of indentation used for a list.
`QTextFormat.ListNumberPrefix`	`0x3002`	Defines the text which is prepended to item numbers in numeric lists.
`QTextFormat.ListNumberSuffix`	`0x3003`	Defines the text which is appended to item numbers in numeric lists.

Table and frame properties

Constant	Value	Description
`QTextFormat.FrameBorder`	`0x4000`
`QTextFormat.FrameBorderBrush`	`0x4009`
`QTextFormat.FrameBorderStyle`	`0x4010`	See the BorderStyle enum.
`QTextFormat.FrameBottomMargin`	`0x4006`
`QTextFormat.FrameHeight`	`0x4004`
`QTextFormat.FrameLeftMargin`	`0x4007`
`QTextFormat.FrameMargin`	`0x4001`
`QTextFormat.FramePadding`	`0x4002`
`QTextFormat.FrameRightMargin`	`0x4008`
`QTextFormat.FrameTopMargin`	`0x4005`
`QTextFormat.FrameWidth`	`0x4003`
`QTextFormat.TableCellSpacing`	`0x4102`
`QTextFormat.TableCellPadding`	`0x4103`
`QTextFormat.TableColumns`	`0x4100`
`QTextFormat.TableColumnWidthConstraints`	`0x4101`
`QTextFormat.TableHeaderRowCount`	`0x4104`

Table cell properties

Constant	Value
`QTextFormat.TableCellRowSpan`	`0x4810`
`QTextFormat.TableCellColumnSpan`	`0x4811`
`QTextFormat.TableCellLeftPadding`	`0x4814`
`QTextFormat.TableCellRightPadding`	`0x4815`
`QTextFormat.TableCellTopPadding`	`0x4812`
`QTextFormat.TableCellBottomPadding`	`0x4813`