QTextOption 类

The QTextOption 类提供了一般富文本属性的描述。更多信息...

头文件	#include <QTextOption>
CMake	find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake	QT += gui

所有成员的列表，包括继承的成员
QTextOption 属于富文本处理 API。

注意： 此类中的所有函数都是重入的。

公共类型

结构体	Tab
枚举	Flag { IncludeTrailingSpaces, ShowTabsAndSpaces, ShowLineAndParagraphSeparators, ShowDocumentTerminator, AddSpaceForLineAndParagraphSeparators, SuppressColors }
标志	标志
枚举	TabType { LeftTab, RightTab, CenterTab, DelimiterTab }
枚举	WrapMode { NoWrap, WordWrap, ManualWrap, WrapAnywhere, WrapAtWordBoundaryOrAnywhere }

公共函数

	QTextOption()
	QTextOption(Qt::Alignment alignment)
	QTextOption(const QTextOption &other)
	~QTextOption()
Qt::Alignment	alignment() const
QTextOption::Flags	flags() const
void	setAlignment(Qt::Alignment alignment)
void	setFlags(QTextOption::Flags flags)
void	setTabArray(const QList<qreal> &tabStops)
void	setTabStopDistance(qreal tabStopDistance)
void	setTabs(const QList<QTextOption::Tab> &tabStops)
void	setTextDirection(Qt::LayoutDirection direction)
void	setUseDesignMetrics(bool enable)
void	setWrapMode(QTextOption::WrapMode mode)
QList<qreal>	tabArray() const
qreal	tabStopDistance() const
QList<QTextOption::Tab>	tabs() const
Qt::LayoutDirection	textDirection() const
bool	useDesignMetrics() const
QTextOption::WrapMode	wrapMode() const
QTextOption &	operator=(const QTextOption &other)

详细描述

QTextOption 用于在单个对象中封装常见的富文本属性。它包含有关文本对齐、布局方向、换行以及与文本渲染和布局相关的其他标准属性信息。

另请参阅 QTextEdit、QTextDocument 和 QTextCursor。

成员类型文档

enum QTextOption::Flag
flags QTextOption::Flags

常量	值	说明
`QTextOption::IncludeTrailingSpaces`	`0x80000000`	当此选项被设置时，QTextLine::naturalTextWidth() 和 naturalTextRect() 将返回包含文本中尾随空格宽度的值；否则此宽度将不包括。
`QTextOption::ShowTabsAndSpaces`	`0x1`	用小点可视化空格，用小箭头可视化制表符。非断行空格以不同方式显示。
`QTextOption::ShowLineAndParagraphSeparators`	`0x2`	用适当的符号字符可视化行和段落分隔符。
`QTextOption::ShowDocumentTerminator`	`0x10`	用节符号可视化文档的末尾。此枚举值是在 Qt 5.7 中添加的。
`QTextOption::AddSpaceForLineAndParagraphSeparators`	`0x4`	在确定换行位置时，考虑为绘制分隔字符而添加的空间。
`QTextOption::SuppressColors`	`0x8`	抑制字符格式中所有颜色变化（除主要选择外）。

The Flags 类型是 QFlags<Flag> 的typedef。它存储 Flag 值的 OR 组合。

enum QTextOption::TabType

此枚举包含不同类型的制表符

常量	值	说明
`QTextOption::LeftTab`	`0`	左制表符
`QTextOption::RightTab`	`1`	右制表符
`QTextOption::CenterTab`	`2`	居中制表符
`QTextOption::DelimiterTab`	`3`	在特定分隔符字符处停止的制表符

enum QTextOption::WrapMode

此枚举描述了文本在文档中的换行方式。

常量	值	说明
`QTextOption::NoWrap`	`0`	文本根本不换行。
`QTextOption::WordWrap`	`1`	文本在单词边界处换行。
`QTextOption::ManualWrap`	`2`	等同于 QTextOption::NoWrap
`QTextOption::WrapAnywhere`	`3`	文本可以在行的任何点换行，甚至在单词的中间。
`QTextOption::WrapAtWordBoundaryOrAnywhere`	`4`	如果可能，换行将在单词边界发生；否则它将在行的适当的点上发生，即使它在单词的中间。

成员函数文档

QTextOption::QTextOption()

构造具有文本默认属性的文本选项。文本对齐属性设置为 Qt::AlignLeft。单词换行属性设置为 QTextOption::WordWrap。使用设计度量标志设置为 false。

QTextOption::QTextOption(Qt::Alignment alignment)

构造具有给定 alignment 的文本属性。单词换行属性设置为 QTextOption::WordWrap。使用设计度量标志设置为 false。

QTextOption::QTextOption(const QTextOption &other)

创建其他文本选项的副本。

`[noexcept]` QTextOption::~QTextOption()

销毁文本选项。

Qt::Alignment QTextOption::alignment() const

返回由选项定义的文本对齐方式。

另请参阅 setAlignment().

QTextOption::Flags QTextOption::flags() const

返回与选项关联的标志。

另请参阅 setFlags().

void QTextOption::setAlignment(Qt::Alignment alignment)

将选项的文本对齐设置为指定的 alignment。

另请参阅 alignment().

void QTextOption::setFlags(QTextOption::Flags flags)

将选项关联的标志设置为给定的 flags。

另请参阅 flags().

void QTextOption::setTabArray(const QList<qreal> &tabStops)

将文本布局的制表位位置设置为 tabStops 中指定的那些。

另请参阅 tabArray(), setTabStopDistance() 和 setTabs().

void QTextOption::setTabStopDistance(qreal tabStopDistance)

将制表位之间的默认设备单元距离设置为 tabStopDistance 指定的值。

另请参阅 tabStopDistance(), setTabArray(), setTabs() 和 tabs().

void QTextOption::setTabs(const QList<QTextOption::Tab> &tabStops)

将文本布局的制表位位置设置为 tabStops 中指定的那些。

另请参阅 tabs() 和 tabStopDistance().

void QTextOption::setTextDirection(Qt::LayoutDirection direction)

将选项定义的文本布局方向设置为给定的 direction。

另请参阅 textDirection().

void QTextOption::setUseDesignMetrics(bool enable)

如果 enable 为 true，则布局将使用设计度量；否则，它将使用绘制设备的度量（这是默认行为）。

另请参阅 useDesignMetrics().

void QTextOption::setWrapMode(QTextOption::WrapMode mode)

将选项的文本换行模式设置为给定的 mode。

另请参阅 wrapMode().

QList<qreal> QTextOption::tabArray() const

返回为文本布局定义的制表位位置的列表。

另请参阅 setTabArray() 和 tabStopDistance。

qreal QTextOption::tabStopDistance() const

返回制表位之间的距离（设备单位）。

另请参阅 setTabStopDistance，tabArray，setTabs 和 tabs。

QList<QTextOption::Tab> QTextOption::tabs() const

返回为文本布局定义的制表位位置的列表。

另请参阅 tabStopDistance，setTabs 和 setTabStopDistance。

Qt::LayoutDirection QTextOption::textDirection() const

返回由选项定义的文本布局方向。

另请参阅 setTextDirection。

bool QTextOption::useDesignMetrics() const

如果布局使用设计而不是设备度量，则返回 true；否则返回 false。

另请参阅 setUseDesignMetrics。

QTextOption::WrapMode QTextOption::wrapMode() const

返回由选项定义的文本换行模式。

另请参阅 setWrapMode。

QTextOption &QTextOption::operator=(const QTextOption &other)

如果文本选项与其他文本选项相同，则返回 true；否则返回 false。