QTextOption Class
QTextOption 类提供了对通用富文本属性的描述。更多内容...
| 头文件： | #include <QTextOption> |
| CMake： | find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake： | QT += gui |
- 所有成员的列表，包括继承的成员
- QTextOption 是富文本处理 API 的一部分。
注意：该类中的所有函数均为可重入函数。
公共类型
| struct | Tab |
| enum | Flag { IncludeTrailingSpaces, ShowTabsAndSpaces, ShowLineAndParagraphSeparators, ShowDocumentTerminator, ShowDefaultIgnorables, …, DisableEmojiParsing } |
| flags | Flags |
| enum | TabType { LeftTab, RightTab, CenterTab, DelimiterTab } |
| enum | 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) |
另请参阅 QTextEdit 、QTextDocument 和QTextCursor 。
成员类型文档
enum QTextOption::Flag
flags QTextOption::Flags
| 常数 | 值 | 描述 |
|---|---|---|
QTextOption::IncludeTrailingSpaces | 0x80000000 | 当设置此选项时，QTextLine::naturalTextWidth() 和 naturalTextRect() 将返回一个包含文本末尾空格宽度的值；否则，该宽度将被排除在外。 |
QTextOption::ShowTabsAndSpaces | 0x1 | 用小圆点表示空格，用小箭头表示制表符。不可分隔空格与可分隔空格的显示方式不同。 |
QTextOption::ShowLineAndParagraphSeparators | 0x2 | 使用适当的符号字符来显示行和段落分隔符。 |
QTextOption::ShowDocumentTerminator (since Qt 5.7) | 0x10 | 使用分节符显示文档结尾。 |
QTextOption::ShowDefaultIgnorables (since Qt 6.9) | 0x20 | 如果字体支持，则正常渲染通常不可见的字符。 |
QTextOption::AddSpaceForLineAndParagraphSeparators | 0x4 | 在确定换行位置时，应考虑为绘制分隔符而添加的空格。 |
QTextOption::SuppressColors | 0x8 | 抑制字符格式中的所有颜色变化（主选中状态除外）。 |
QTextOption::DisableEmojiParsing (since Qt 6.9) | 0x40 | 默认情况下，Qt 会检测输入字符串中的表情符号序列，并优先使用彩色字体来显示它们。如果事先知道不需要此功能，可以通过设置 DisableEmojiParsing 标志来禁用此额外步骤。 |
Flags 类型是QFlags<Flag> 的 typedef。它存储 Flag 值的按“或”运算组合。
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。
注意：调用 此构造函数将把默认文本方向设置为Qt::LayoutDirectionAuto 。
QTextOption::QTextOption(Qt::Alignment alignment)
根据给定的文本alignment 创建一个文本选项。将word wrap属性设置为QTextOption::WordWrap 。将using of design metrics标志设置为false。
注意：调用 此构造函数会将默认文本方向设置为QGuiApplication::layoutDirection()的当前值，该值取决于系统区域设置。出于向后兼容性的考虑，这与默认构造函数设置的默认文本方向并不一致。
QTextOption::QTextOption(const QTextOption &other)
创建“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 为真，则布局将使用设计度量；否则将使用绘制设备的度量（这是默认行为）。
另请参阅 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)
如果文本选项与other 文本选项相同，则返回true ；否则返回false 。
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
