QTextOption¶

PyQt5.QtGui.QTextOption

Description¶

The QTextOption class provides a description of general rich text properties.

QTextOption is used to encapsulate common rich text properties in a single object. It contains information about text alignment, layout direction, word wrapping, and other standard properties associated with text rendering and layout.

Classes¶

Flags

Tab

Enums¶

Flag

Member	Value	Description
AddSpaceForLineAndParagraphSeparators	0x4	While determining the line-break positions take into account the space added for drawing a separator character.
IncludeTrailingSpaces	0x80000000	When this option is set, naturalTextWidth() and naturalTextRect() will return a value that includes the width of trailing spaces in the text; otherwise this width is excluded.
ShowDocumentTerminator	TODO	Visualize the end of the document with a section sign. This enum value was added in Qt 5.7.
ShowLineAndParagraphSeparators	0x2	Visualize line and paragraph separators with appropriate symbol characters.
ShowTabsAndSpaces	0x1	Visualize spaces with little dots, and tabs with little arrows. Non-breaking spaces are shown differently to breaking spaces.
SuppressColors	0x8	Suppress all color changes in the character formats (except the main selection).

TabType

This enum holds the different types of tabulator

Member	Value	Description
CenterTab	2	A centered-tab
DelimiterTab	3	A tab stopping at a certain delimiter-character
LeftTab	0	A left-tab
RightTab	1	A right-tab

WrapMode

This enum describes how text is wrapped in a document.

Member	Value	Description
ManualWrap	2	Same as
NoWrap	0	Text is not wrapped at all.
WordWrap	1	Text is wrapped at word boundaries.
WrapAnywhere	3	Text can be wrapped at any point on a line, even if it occurs in the middle of a word.
WrapAtWordBoundaryOrAnywhere	4	If possible, wrapping occurs at a word boundary; otherwise it will occur at the appropriate point on the line, even in the middle of a word.

Methods¶

__init__(): Constructs a text option with default properties for text. The text alignment property is set to AlignLeft. The word wrap property is set to WordWrap. The using of design metrics flag is set to false.

__init__(Union[Alignment, AlignmentFlag]): Constructs a text option with the given alignment for text. The word wrap property is set to WordWrap. The using of design metrics flag is set to false.

__init__(QTextOption): TODO

alignment() → Alignment: See also

setAlignment().

flags() → Flags: See also

setFlags().

setAlignment(Union[Alignment, AlignmentFlag]): See also

alignment().

setFlags(Union[Flags, Flag]): See also

flags().

setTabArray(Iterable[float]): TODO

setTabs(Iterable[Tab]): TODO

setTabStop(float): See also

tabStop().

setTabStopDistance(float): TODO

setTextDirection(LayoutDirection): See also

textDirection().

setUseDesignMetrics(bool): See also

useDesignMetrics().

setWrapMode(WrapMode): See also

wrapMode().

tabArray() → List[float]: Returns a list of tab positions defined for the text layout.

See also

setTabArray(), tabStop().

tabs() → List[Tab]: See also

setTabs().

tabStop() → float: See also

setTabStop().

tabStopDistance() → float: TODO

textDirection() → LayoutDirection: See also

setTextDirection().

useDesignMetrics() → bool: See also

setUseDesignMetrics().

wrapMode() → WrapMode: See also

setWrapMode().