QTextOption Class

QTextOption 类提供了对一般富文本属性的描述。更多

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

注意:该类中的所有函数都是可重入的

公共类型

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)

详细说明

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

另请参阅 QTextEdit,QTextDocument, 和QTextCursor

成员类型文档

枚举 QTextOption::Flag
flags QTextOption::Flags

常量说明
QTextOption::IncludeTrailingSpaces0x80000000当设置此选项时,QTextLine::naturalTextWidth() 和 naturalTextRect() 将返回一个包含文本中尾部空格宽度的值;否则该宽度将被排除。
QTextOption::ShowTabsAndSpaces0x1空格用小圆点显示,制表符用小箭头显示。非分隔符与分隔符的显示方式不同。
QTextOption::ShowLineAndParagraphSeparators0x2用适当的符号字符显示行和段落分隔符。
QTextOption::ShowDocumentTerminator (since Qt 5.7)0x10用段落符号显示文档的结尾。
QTextOption::ShowDefaultIgnorables (since Qt 6.9)0x20如果字体支持,可正常显示非可视字符。
QTextOption::AddSpaceForLineAndParagraphSeparators0x4在确定换行位置时,考虑到为绘制分隔符而增加的空间。
QTextOption::SuppressColors0x8抑制字符格式中的所有颜色变化(主选区除外)。
QTextOption::DisableEmojiParsing (since Qt 6.9)0x40默认情况下,Qt 会检测输入字符串中的表情符号序列,并优先使用彩色字体显示它们。如果事先知道不需要这一额外步骤,可以通过设置 DisableEmojiParsing 标志来禁用。

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

enum QTextOption::TabType

该枚举表示不同类型的制表符

常量描述
QTextOption::LeftTab0左制表符
QTextOption::RightTab1右制表符
QTextOption::CenterTab2居中制表符
QTextOption::DelimiterTab3在特定分隔符处停止的制表符

enum QTextOption::WrapMode

该枚举描述了文档中文本的包装方式。

常量说明
QTextOption::NoWrap0文本完全不包边。
QTextOption::WordWrap1在单词边界处对文本进行包边。
QTextOption::ManualWrap2与 QTextOption::NoWrap 相同
QTextOption::WrapAnywhere3文本可以在一行中的任何位置被换行,即使它出现在一个单词的中间。
QTextOption::WrapAtWordBoundaryOrAnywhere4如果可能,会在单词边界处进行换行;否则,会在行上的适当位置换行,即使是在单词中间。

成员函数文档

QTextOption::QTextOption()

构造一个具有文本默认属性的文本选项。文本对齐方式属性设置为Qt::AlignLeft 。换行属性设置为QTextOption::WordWrap 。使用设计指标标志设置为 false。

QTextOption::QTextOption(Qt::Alignment alignment)

使用给定的alignment 文本构建文本选项。换行属性设置为QTextOption::WordWrap 。使用设计指标标志设置为 false。

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 为 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)

如果文本选项与other 文本选项相同,则返回true ;否则返回false

© 2025 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.