Skip to content

PythonQt.Qt.QTextBlockFormat

QTextBlockFormat

PythonQtInstanceWrapper object

Native bases: PythonQtInstanceWrapper

Supplemental documentation: Qt 5 reference:

Detailed Description

A document is composed of a list of blocks, represented by QTextBlock objects. Each block can contain an item of some kind, such as a paragraph of text, a table, a list, or an image. Every block has an associated QTextBlockFormat that specifies its characteristics.

To cater for left-to-right and right-to-left languages you can set a block's direction with setLayoutDirection(). Paragraph alignment is set with setAlignment(). Margins are controlled by setTopMargin(), setBottomMargin(), setLeftMargin(), setRightMargin(). Overall indentation is set with setIndent(), the indentation of the first line with setTextIndent().

Line spacing is set with setLineHeight() and retrieved via lineHeight() and lineHeightType(). The types of line spacing available are in the LineHeightTypes enum.

Line breaking can be enabled and disabled with setNonBreakableLines().

The brush used to paint the paragraph's background is set with setBackground(), and other aspects of the text's appearance can be customized by using the setProperty() function with the OutlinePen, ForegroundBrush, and BackgroundBrush QTextFormat::Property values.

If a text block is part of a list, it can also have a list format that is accessible with the listFormat() function.

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html

Complete member index

Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.

Member Kind Signature Summary
AnchorHref attribute Any (shared captured text)
AnchorName attribute Any (shared captured text)
BackgroundBrush attribute Any (shared captured text)
BackgroundImageUrl attribute Any (shared captured text)
BlockAlignment attribute Any (shared captured text)
BlockBottomMargin attribute Any (shared captured text)
BlockFormat attribute Any (shared captured text)
BlockIndent attribute Any (shared captured text)
BlockLeftMargin attribute Any (shared captured text)
BlockNonBreakableLines attribute Any (shared captured text)
BlockRightMargin attribute Any (shared captured text)
BlockTopMargin attribute Any (shared captured text)
BlockTrailingHorizontalRulerWidth attribute Any (shared captured text)
CharFormat attribute Any (shared captured text)
CssFloat attribute Any (shared captured text)
FirstFontProperty attribute Any (shared captured text)
FixedHeight attribute Any (shared captured text)
FontCapitalization attribute Any (shared captured text)
FontFamily attribute Any (shared captured text)
FontFixedPitch attribute Any (shared captured text)
FontHintingPreference attribute Any (shared captured text)
FontItalic attribute Any (shared captured text)
FontKerning attribute Any (shared captured text)
FontLetterSpacing attribute Any (shared captured text)
FontLetterSpacingType attribute Any (shared captured text)
FontOverline attribute Any (shared captured text)
FontPixelSize attribute Any (shared captured text)
FontPointSize attribute Any (shared captured text)
FontSizeAdjustment attribute Any (shared captured text)
FontSizeIncrement attribute Any (shared captured text)
FontStretch attribute Any (shared captured text)
FontStrikeOut attribute Any (shared captured text)
FontStyleHint attribute Any (shared captured text)
FontStyleStrategy attribute Any (shared captured text)
FontUnderline attribute Any (shared captured text)
FontWeight attribute Any (shared captured text)
FontWordSpacing attribute Any (shared captured text)
ForegroundBrush attribute Any (shared captured text)
FormatType attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
FrameBorder attribute Any (shared captured text)
FrameBorderBrush attribute Any (shared captured text)
FrameBorderStyle attribute Any (shared captured text)
FrameBottomMargin attribute Any (shared captured text)
FrameFormat attribute Any (shared captured text)
FrameHeight attribute Any (shared captured text)
FrameLeftMargin attribute Any (shared captured text)
FrameMargin attribute Any (shared captured text)
FramePadding attribute Any (shared captured text)
FrameRightMargin attribute Any (shared captured text)
FrameTopMargin attribute Any (shared captured text)
FrameWidth attribute Any (shared captured text)
FullWidthSelection attribute Any (shared captured text)
ImageHeight attribute Any (shared captured text)
ImageName attribute Any (shared captured text)
ImageObject attribute Any (shared captured text)
ImageWidth attribute Any (shared captured text)
InvalidFormat attribute Any (shared captured text)
IsAnchor attribute Any (shared captured text)
LastFontProperty attribute Any (shared captured text)
LayoutDirection attribute Any (shared captured text)
LineDistanceHeight attribute Any (shared captured text)
LineHeight attribute Any (shared captured text)
LineHeightType attribute Any (shared captured text)
LineHeightTypes attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
ListFormat attribute Any (shared captured text)
ListIndent attribute Any (shared captured text)
ListNumberPrefix attribute Any (shared captured text)
ListNumberSuffix attribute Any (shared captured text)
ListStyle attribute Any (shared captured text)
MinimumHeight attribute Any (shared captured text)
NoObject attribute Any (shared captured text)
ObjectIndex attribute Any (shared captured text)
ObjectType attribute Any (shared captured text)
ObjectTypes attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
OutlinePen attribute Any (shared captured text)
PageBreakFlag attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
PageBreakFlags attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
PageBreakPolicy attribute Any (shared captured text)
PageBreak_AlwaysAfter attribute Any (shared captured text)
PageBreak_AlwaysBefore attribute Any (shared captured text)
PageBreak_Auto attribute Any (shared captured text)
Property attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
ProportionalHeight attribute Any (shared captured text)
SingleHeight attribute Any (shared captured text)
TabPositions attribute Any (shared captured text)
TableCellBottomPadding attribute Any (shared captured text)
TableCellColumnSpan attribute Any (shared captured text)
TableCellLeftPadding attribute Any (shared captured text)
TableCellObject attribute Any (shared captured text)
TableCellPadding attribute Any (shared captured text)
TableCellRightPadding attribute Any (shared captured text)
TableCellRowSpan attribute Any (shared captured text)
TableCellSpacing attribute Any (shared captured text)
TableCellTopPadding attribute Any (shared captured text)
TableColumnWidthConstraints attribute Any (shared captured text)
TableColumns attribute Any (shared captured text)
TableFormat attribute Any (shared captured text)
TableHeaderRowCount attribute Any (shared captured text)
TableObject attribute Any (shared captured text)
TextIndent attribute Any (shared captured text)
TextOutline attribute Any (shared captured text)
TextToolTip attribute Any (shared captured text)
TextUnderlineColor attribute Any (shared captured text)
TextUnderlineStyle attribute Any (shared captured text)
TextVerticalAlignment attribute Any (shared captured text)
UserFormat attribute Any (shared captured text)
UserObject attribute Any (shared captured text)
UserProperty attribute Any (shared captured text)
__init__ function (self, *args: Any, **kwargs: Any) -> None Native constructor; consult class documentation for supported overloads. (shared captured text)
alignment function (self) -> Any Returns the paragraph's alignment. (shared captured text)
background function (self) -> Any X.background() -> PythonQt.QtGui.QBrush (shared captured text)
boolProperty function (self, propertyId: Any) -> bool X.boolProperty(propertyId) -> bool (shared captured text)
bottomMargin function (self) -> float X.bottomMargin() -> float (shared captured text)
brushProperty function (self, propertyId: Any) -> Any X.brushProperty(propertyId) -> PythonQt.QtGui.QBrush (shared captured text)
className function (self, *args: Any, **kwargs: Any) -> Any Return the classname of the object (shared captured text)
clearBackground function (self) -> Any (shared captured text)
clearForeground function (self) -> Any (shared captured text)
clearProperty function (self, propertyId: Any) -> Any (shared captured text)
colorProperty function (self, propertyId: Any) -> Any X.colorProperty(propertyId) -> PythonQt.QtGui.QColor (shared captured text)
delete function (self, *args: Any, **kwargs: Any) -> Any Deletes the C++ object (at your own risk, my friend!) (shared captured text)
doubleProperty function (self, propertyId: Any) -> float X.doubleProperty(propertyId) -> float (shared captured text)
foreground function (self) -> Any X.foreground() -> PythonQt.QtGui.QBrush (shared captured text)
hasProperty function (self, propertyId: Any) -> bool X.hasProperty(propertyId) -> bool (shared captured text)
help function (self, *args: Any, **kwargs: Any) -> Any Shows the help of available methods for this class (shared captured text)
indent function (self) -> int X.indent() -> int (shared captured text)
inherits function (self, *args: Any, **kwargs: Any) -> Any Returns if the class inherits or is of given type name (shared captured text)
intProperty function (self, propertyId: Any) -> int X.intProperty(propertyId) -> int (shared captured text)
isBlockFormat function (self) -> bool X.isBlockFormat() -> bool (shared captured text)
isCharFormat function (self) -> bool X.isCharFormat() -> bool (shared captured text)
isEmpty function (self) -> bool X.isEmpty() -> bool (shared captured text)
isFrameFormat function (self) -> bool X.isFrameFormat() -> bool (shared captured text)
isImageFormat function (self) -> bool X.isImageFormat() -> bool (shared captured text)
isListFormat function (self) -> bool X.isListFormat() -> bool (shared captured text)
isTableCellFormat function (self) -> bool X.isTableCellFormat() -> bool (shared captured text)
isTableFormat function (self) -> bool X.isTableFormat() -> bool (shared captured text)
isValid function (self) -> bool X.isValid() -> bool (shared captured text)
layoutDirection function (self) -> Any (shared captured text)
leftMargin function (self) -> float X.leftMargin() -> float (shared captured text)
lengthProperty function (self, propertyId: Any) -> Any X.lengthProperty(propertyId) -> PythonQt.QtGui.QTextLength (shared captured text)
lengthVectorProperty function (self, propertyId: Any) -> tuple X.lengthVectorProperty(propertyId) -> tuple (shared captured text)
lineHeight function (self, scriptLineHeight: Any, scaling: Any) -> float X.lineHeight(scriptLineHeight, scaling) -> float (shared captured text)
lineHeightType function (self) -> int X.lineHeightType() -> int (shared captured text)
merge function (self, other: Any) -> Any (shared captured text)
nonBreakableLines function (self) -> bool X.nonBreakableLines() -> bool (shared captured text)
objectIndex function (self) -> int X.objectIndex() -> int (shared captured text)
objectType function (self) -> int X.objectType() -> int (shared captured text)
pageBreakPolicy function (self) -> Any Returns the currently set page break policy for the paragraph. (shared captured text)
penProperty function (self, propertyId: Any) -> Any X.penProperty(propertyId) -> PythonQt.QtGui.QPen (shared captured text)
properties function (self) -> dict X.properties() -> dict (shared captured text)
property function (self, propertyId: Any) -> Any X.property(propertyId) -> object (shared captured text)
propertyCount function (self) -> int X.propertyCount() -> int (shared captured text)
readFrom function (self, arg__1: Any) -> Any (shared captured text)
rightMargin function (self) -> float X.rightMargin() -> float (shared captured text)
setAlignment function (self, alignment: Any) -> None Sets the paragraph's alignment. (shared captured text)
setBackground function (self, brush: Any) -> Any (shared captured text)
setBottomMargin function (self, margin: float) -> None Sets the paragraph's bottom margin. (shared captured text)
setForeground function (self, brush: Any) -> Any (shared captured text)
setIndent function (self, indent: int) -> None Sets the paragraph's indentation. (shared captured text)
setLayoutDirection function (self, direction: Any) -> Any (shared captured text)
setLeftMargin function (self, margin: float) -> None Sets the paragraph's left margin. (shared captured text)
setLineHeight function (self, height: float, heightType: int) -> None X.setLineHeight(height, heightType) (shared captured text)
setNonBreakableLines function (self, b: bool) -> None If b is true, the lines in the paragraph are treated as non-breakable; otherwise they are breakable. (shared captured text)
setObjectIndex function (self, object: Any) -> Any (shared captured text)
setObjectType function (self, type: Any) -> Any (shared captured text)
setPageBreakPolicy function (self, arg0: flags) -> None Sets the page break policy for the paragraph to policy. (shared captured text)
setProperty function (self, propertyId: Any, value: Any) -> Any X.setProperty(propertyId, value) (shared captured text)
setRightMargin function (self, margin: float) -> None Sets the paragraph's right margin. (shared captured text)
setTabPositions function (self, tabs: Any) -> None Sets the tab positions for the text block to those specified by tabs. (shared captured text)
setTextIndent function (self, aindent: float) -> None Sets the indent for the first line in the block. (shared captured text)
setTopMargin function (self, margin: float) -> None Sets the paragraph's top margin. (shared captured text)
stringProperty function (self, propertyId: Any) -> str X.stringProperty(propertyId) -> str (shared captured text)
swap function (self, other: Any) -> Any (shared captured text)
tabPositions function (self) -> tuple X.tabPositions() -> tuple (shared captured text)
textIndent function (self) -> float X.textIndent() -> float (shared captured text)
toBlockFormat function (self) -> Any X.toBlockFormat() -> PythonQt.QtGui.QTextBlockFormat (shared captured text)
toCharFormat function (self) -> Any X.toCharFormat() -> PythonQt.QtGui.QTextCharFormat (shared captured text)
toFrameFormat function (self) -> Any X.toFrameFormat() -> PythonQt.QtGui.QTextFrameFormat (shared captured text)
toImageFormat function (self) -> Any X.toImageFormat() -> PythonQt.QtGui.QTextImageFormat (shared captured text)
toListFormat function (self) -> Any X.toListFormat() -> PythonQt.QtGui.QTextListFormat (shared captured text)
toTableCellFormat function (self) -> Any X.toTableCellFormat() -> PythonQt.QtGui.QTextTableCellFormat (shared captured text)
toTableFormat function (self) -> Any X.toTableFormat() -> PythonQt.QtGui.QTextTableFormat (shared captured text)
topMargin function (self) -> float X.topMargin() -> float (shared captured text)
type function (self) -> int X.type() -> int (shared captured text)
writeTo function (self, arg__1: Any) -> Any (shared captured text)