QTextBlockFormat

The QTextBlockFormat class provides formatting information for blocks of text in a QTextDocument . More…

Synopsis

Functions

• def alignment ()

• def bottomMargin ()

• def headingLevel ()

• def indent ()

• def leftMargin ()

• def lineHeight ()

• def lineHeight (scriptLineHeight, scaling)

• def lineHeightType ()

• def marker ()

• def nonBreakableLines ()

• def pageBreakPolicy ()

• def rightMargin ()

• def setAlignment (alignment)

• def setBottomMargin (margin)

• def setHeadingLevel (alevel)

• def setIndent (indent)

• def setLeftMargin (margin)

• def setLineHeight (height, heightType)

• def setMarker (marker)

• def setNonBreakableLines (b)

• def setPageBreakPolicy (flags)

• def setRightMargin (margin)

• def setTabPositions (tabs)

• def setTextIndent (aindent)

• def setTopMargin (margin)

• def tabPositions ()

• def textIndent ()

• def topMargin ()

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 setDirection(). 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 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.

See also

QTextBlock QTextCharFormat

class PySide6.QtGui.QTextBlockFormat

PySide6.QtGui.QTextBlockFormat(QTextBlockFormat)

PySide6.QtGui.QTextBlockFormat(fmt)

Parameters

• fmt – PySide6.QtGui.QTextFormat

• QTextBlockFormat – PySide6.QtGui.QTextBlockFormat

Constructs a new QTextBlockFormat .

PySide6.QtGui.QTextBlockFormat.LineHeightTypes

This enum describes the various types of line spacing support paragraphs can have.

Constant	Description
QTextBlockFormat.SingleHeight	This is the default line height: single spacing.
QTextBlockFormat.ProportionalHeight	This sets the spacing proportional to the line (in percentage). For example, set to 200 for double spacing.
QTextBlockFormat.FixedHeight	This sets the line height to a fixed line height (in pixels).
QTextBlockFormat.MinimumHeight	This sets the minimum line height (in pixels).
QTextBlockFormat.LineDistanceHeight	This adds the specified height between lines (in pixels).

See also

lineHeight() lineHeightType() setLineHeight()

New in version 4.8.

PySide6.QtGui.QTextBlockFormat.MarkerType

This enum describes the types of markers a list item can have. If a list item (a paragraph for which textList() returns the list) has a marker, it is rendered instead of the normal bullet. In this way, checkable list items can be mixed with plain list items in the same list, overriding the type of bullet specified by the style() for the entire list.

Constant	Description
QTextBlockFormat.MarkerType.NoMarker	This is the default: the list item’s bullet will be shown.
QTextBlockFormat.MarkerType.Unchecked	Instead of the list item’s bullet, an unchecked checkbox will be shown.
QTextBlockFormat.MarkerType.Checked	Instead of the list item’s bullet, a checked checkbox will be shown.

In the future, this may be extended to specify other types of paragraph decorations.

See also

style()

New in version 5.14.

PySide6.QtGui.QTextBlockFormat.alignment()

Return type

Alignment

Returns the paragraph’s alignment.

See also

setAlignment()

PySide6.QtGui.QTextBlockFormat.bottomMargin()

Return type

float

Returns the paragraph’s bottom margin.

See also

setBottomMargin() topMargin()

PySide6.QtGui.QTextBlockFormat.headingLevel()

Return type

int

Returns the paragraph’s heading level if it is a heading, or 0 if not.

See also

setHeadingLevel()

PySide6.QtGui.QTextBlockFormat.indent()

Return type

int

Returns the paragraph’s indent.

See also

setIndent()

PySide6.QtGui.QTextBlockFormat.leftMargin()

Return type

float

Returns the paragraph’s left margin.

See also

setLeftMargin() rightMargin() indent()

PySide6.QtGui.QTextBlockFormat.lineHeight()

Return type

float

This returns the LineHeight property for the paragraph.

See also

LineHeightTypes setLineHeight() lineHeightType()

PySide6.QtGui.QTextBlockFormat.lineHeight(scriptLineHeight, scaling)

Parameters

• scriptLineHeight – float

• scaling – float

Return type

float

Returns the height of the lines in the paragraph based on the height of the script line given by scriptLineHeight and the specified scaling factor.

The value that is returned is also dependent on the given LineHeightType of the paragraph as well as the LineHeight setting that has been set for the paragraph.

The scaling is needed for heights that include a fixed number of pixels, to scale them appropriately for printing.

See also

LineHeightTypes setLineHeight() lineHeightType()

PySide6.QtGui.QTextBlockFormat.lineHeightType()

Return type

int

This returns the LineHeightType property of the paragraph.

See also

LineHeightTypes setLineHeight() lineHeight()

PySide6.QtGui.QTextBlockFormat.marker()

Return type

MarkerType

Returns the paragraph’s marker if one has been set, or NoMarker if not.

See also

setMarker()

PySide6.QtGui.QTextBlockFormat.nonBreakableLines()

Return type

bool

Returns true if the lines in the paragraph are non-breakable; otherwise returns false.

See also

setNonBreakableLines()

PySide6.QtGui.QTextBlockFormat.pageBreakPolicy()

Return type

PageBreakFlags

Returns the currently set page break policy for the paragraph. The default is PageBreak_Auto .

See also

setPageBreakPolicy()

PySide6.QtGui.QTextBlockFormat.rightMargin()

Return type

float

Returns the paragraph’s right margin.

See also

setRightMargin() leftMargin()

PySide6.QtGui.QTextBlockFormat.setAlignment(alignment)

Parameters

alignment – Alignment

Sets the paragraph’s alignment.

See also

alignment()

PySide6.QtGui.QTextBlockFormat.setBottomMargin(margin)

Parameters

margin – float

Sets the paragraph’s bottom margin.

See also

bottomMargin() setTopMargin() setLeftMargin() setRightMargin()

PySide6.QtGui.QTextBlockFormat.setHeadingLevel(alevel)

Parameters

alevel – int

Sets the paragraph’s heading level, where 1 is the highest-level heading type (usually with the largest possible heading font size), and increasing values are progressively deeper into the document (and usually with smaller font sizes). For example when reading an HTML H1 tag, the heading level is set to 1. Setting the heading level does not automatically change the font size; however fromHtml() sets both the heading level and the font size simultaneously.

If the paragraph is not a heading, the level should be set to 0 (the default).

See also

headingLevel()

PySide6.QtGui.QTextBlockFormat.setIndent(indent)

Parameters

indent – int

Sets the paragraph’s indentation. Margins are set independently of indentation with setLeftMargin() and setTextIndent() . The indentation is an integer that is multiplied with the document-wide standard indent, resulting in the actual indent of the paragraph.

See also

indent() indentWidth()

PySide6.QtGui.QTextBlockFormat.setLeftMargin(margin)

Parameters

margin – float

Sets the paragraph’s left margin. Indentation can be applied separately with setIndent() .

See also

leftMargin() setRightMargin() setTopMargin() setBottomMargin()

PySide6.QtGui.QTextBlockFormat.setLineHeight(height, heightType)

Parameters

• height – float

• heightType – int

Sets the line height for the paragraph to the value given by height which is dependent on heightType in the way described by the LineHeightTypes enum.

See also

LineHeightTypes lineHeight() lineHeightType()

PySide6.QtGui.QTextBlockFormat.setMarker(marker)

Parameters

marker – MarkerType

Sets the type of adornment that should be rendered alongside the paragraph to marker. For example, a list item can be adorned with a checkbox, either checked or unchecked, as a replacement for its bullet. The default is NoMarker.

See also

marker()

PySide6.QtGui.QTextBlockFormat.setNonBreakableLines(b)

Parameters

b – bool

If b is true, the lines in the paragraph are treated as non-breakable; otherwise they are breakable.

See also

nonBreakableLines()

PySide6.QtGui.QTextBlockFormat.setPageBreakPolicy(flags)

Parameters

flags – PageBreakFlags

Sets the page break policy for the paragraph to policy.

See also

pageBreakPolicy()

PySide6.QtGui.QTextBlockFormat.setRightMargin(margin)

Parameters

margin – float

Sets the paragraph’s right margin.

See also

rightMargin() setLeftMargin() setTopMargin() setBottomMargin()

PySide6.QtGui.QTextBlockFormat.setTabPositions(tabs)

Parameters

tabs –

Sets the tab positions for the text block to those specified by tabs.

See also

tabPositions()

PySide6.QtGui.QTextBlockFormat.setTextIndent(aindent)

Parameters

aindent – float

Sets the indent for the first line in the block. This allows the first line of a paragraph to be indented differently to the other lines, enhancing the readability of the text.

See also

textIndent() setLeftMargin() setRightMargin() setTopMargin() setBottomMargin()

PySide6.QtGui.QTextBlockFormat.setTopMargin(margin)

Parameters

margin – float

Sets the paragraph’s top margin.

See also

topMargin() setBottomMargin() setLeftMargin() setRightMargin()

PySide6.QtGui.QTextBlockFormat.tabPositions()

Return type

Returns a list of tab positions defined for the text block.

See also

setTabPositions()

PySide6.QtGui.QTextBlockFormat.textIndent()

Return type

float

Returns the paragraph’s text indent.

See also

setTextIndent()

PySide6.QtGui.QTextBlockFormat.topMargin()

Return type

float

Returns the paragraph’s top margin.

See also

setTopMargin() bottomMargin()