本页内容

QTextFrameFormat Class

QTextFrameFormat 类为QTextDocument 中的框架提供格式设置信息。更多内容...

头文件: #include <QTextFrameFormat>
CMake: find_package(Qt6 REQUIRED COMPONENTS Gui)
target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake: QT += gui
继承自: QTextFormat
被继承者:

QTextTableFormat

注意:该类中的所有函数均为可重入的。

公共类型

enum BorderStyle { BorderStyle_None, BorderStyle_Dotted, BorderStyle_Dashed, BorderStyle_Solid, BorderStyle_Double, …, BorderStyle_Outset }
enum Position { InFlow, FloatLeft, FloatRight }

公共函数

QTextFrameFormat()
qreal border() const
QBrush borderBrush() const
QTextFrameFormat::BorderStyle borderStyle() const
qreal bottomMargin() const
QTextLength height() const
bool isValid() const
qreal leftMargin() const
qreal margin() const
qreal padding() const
QTextFormat::PageBreakFlags pageBreakPolicy() const
QTextFrameFormat::Position position() const
qreal rightMargin() const
void setBorder(qreal width)
void setBorderBrush(const QBrush &brush)
void setBorderStyle(QTextFrameFormat::BorderStyle style)
void setBottomMargin(qreal margin)
void setHeight(const QTextLength &height)
void setHeight(qreal height)
void setLeftMargin(qreal margin)
void setMargin(qreal margin)
void setPadding(qreal width)
void setPageBreakPolicy(QTextFormat::PageBreakFlags policy)
void setPosition(QTextFrameFormat::Position policy)
void setRightMargin(qreal margin)
void setTopMargin(qreal margin)
void setWidth(const QTextLength &width)
void setWidth(qreal width)
qreal topMargin() const
QTextLength width() const

详细描述

文本框将一个或多个文本块组合在一起,提供了一个比段落更大的结构层。文本框的格式指定了它在屏幕上的呈现和定位方式。它并不直接指定内部文本格式化的行为,但对其子元素的布局提供了约束。

框架格式定义了框架在屏幕上的width()和height()。 每个框架都可以有一个border(),该属性会用一个矩形框包围其内容。边框外侧由margin()包围,而框架的内容则通过框架的padding()与边框保持分离。这种方案类似于层叠样式表(CSS)在HTML页面中使用的盒模型。

示意图展示了内边距、边框和外边距如何围绕文本内容矩形进行布局。

框架的position() 属性通过setPosition() 进行设置,并决定其相对于周围文本的位置。

可以通过isValid() 函数来判断 QTextFrameFormat 对象的有效性。

另请参阅 QTextFrame 和QTextBlockFormat 。

成员类型文档

enum QTextFrameFormat::BorderStyle

此枚举描述了文本框的各种边框样式。

常量值
QTextFrameFormat::BorderStyle_None0
QTextFrameFormat::BorderStyle_Dotted1
QTextFrameFormat::BorderStyle_Dashed2
QTextFrameFormat::BorderStyle_Solid3
QTextFrameFormat::BorderStyle_Double4
QTextFrameFormat::BorderStyle_DotDash5
QTextFrameFormat::BorderStyle_DotDotDash6
QTextFrameFormat::BorderStyle_Groove7
QTextFrameFormat::BorderStyle_Ridge8
QTextFrameFormat::BorderStyle_Inset9
QTextFrameFormat::BorderStyle_Outset10

另请参阅 borderStyle() 和FrameBorderStyle 。

enum QTextFrameFormat::Position

此枚举描述了框架相对于周围文本的位置。

常量值
QTextFrameFormat::InFlow0
QTextFrameFormat::FloatLeft1
QTextFrameFormat::FloatRight2

另请参阅 position() 和CssFloat 。

成员函数文档

QTextFrameFormat::QTextFrameFormat()

创建一个具有默认属性的文本框格式对象。

qreal QTextFrameFormat::border() const

返回边框的宽度(以像素为单位)。

另请参阅 setBorder()。

QBrush QTextFrameFormat::borderBrush() const

返回用于绘制框架边框的画笔。

另请参阅 setBorderBrush()。

QTextFrameFormat::BorderStyle QTextFrameFormat::borderStyle() const

返回框架边框的样式。

另请参阅 setBorderStyle()。

qreal QTextFrameFormat::bottomMargin() const

返回框架底部边距的宽度(以像素为单位)。

另请参阅 setBottomMargin()。

QTextLength QTextFrameFormat::height() const

返回框架边框矩形的高度。

另请参阅 setHeight()。

bool QTextFrameFormat::isValid() const

如果格式描述有效,则返回true ;否则返回false 。

qreal QTextFrameFormat::leftMargin() const

返回框架左边距的宽度(以像素为单位)。

另请参阅 ` setLeftMargin()`。

qreal QTextFrameFormat::margin() const

返回框架外部边距的宽度(单位为像素)。

另请参阅 ` setMargin()`。

qreal QTextFrameFormat::padding() const

返回框架内部填充的宽度(以像素为单位)。

另请参阅 ` setPadding()`。

QTextFormat::PageBreakFlags QTextFrameFormat::pageBreakPolicy() const

返回该框架/表格当前设置的分页策略。默认值为QTextFormat::PageBreak_Auto 。

另请参阅 setPageBreakPolicy()。

QTextFrameFormat::Position QTextFrameFormat::position() const

返回具有此帧格式的帧的定位策略。

另请参阅 setPosition()。

qreal QTextFrameFormat::rightMargin() const

返回框架右边距的宽度(以像素为单位)。

另请参阅 setRightMargin()。

void QTextFrameFormat::setBorder(qreal width)

设置框架边框的width (以像素为单位)。

另请参阅 border()。

void QTextFrameFormat::setBorderBrush(const QBrush &brush)

设置用于帧边框的brush 。

另请参阅 borderBrush()。

void QTextFrameFormat::setBorderStyle(QTextFrameFormat::BorderStyle style)

设置帧边框的style 属性。

另请参阅 borderStyle()。

void QTextFrameFormat::setBottomMargin(qreal margin)

设置框架的底部margin (单位为像素)。

另请参阅 bottomMargin()。

void QTextFrameFormat::setHeight(const QTextLength &height)

设置画面的height 。

另请参阅 height()。

void QTextFrameFormat::setHeight(qreal height)

设置画面的height 。

这是一个重载函数。

void QTextFrameFormat::setLeftMargin(qreal margin)

设置框架的左侧边距margin (单位为像素)。

另请参阅 leftMargin()。

void QTextFrameFormat::setMargin(qreal margin)

将框架的margin 设置为指定像素值。此方法还会将框架的左、右、上、下边距均设置为该值。各边距的设置将覆盖全局边距。

另请参阅 margin()。

void QTextFrameFormat::setPadding(qreal width)

设置帧内部填充的width (以像素为单位)。

另请参阅 padding()。

void QTextFrameFormat::setPageBreakPolicy(QTextFormat::PageBreakFlags policy)

将框架/表格的分页策略设置为“policy ”。

另请参阅 pageBreakPolicy()。

void QTextFrameFormat::setPosition(QTextFrameFormat::Position policy)

设置“policy ”属性,用于定位采用此帧格式的帧。

另请参阅 position()。

void QTextFrameFormat::setRightMargin(qreal margin)

设置帧的右侧margin (以像素为单位)。

另请参阅 rightMargin()。

void QTextFrameFormat::setTopMargin(qreal margin)

将框架的顶部margin 设置为指定像素值。

另请参阅 topMargin()。

void QTextFrameFormat::setWidth(const QTextLength &width)

设置框架边框矩形的width 。

另请参阅 width()和QTextLength 。

void QTextFrameFormat::setWidth(qreal width)

一个便捷方法,用于将框架边框矩形的宽度设置为指定的固定值width 。

这是一个重载函数。

qreal QTextFrameFormat::topMargin() const

返回框架顶部边距的宽度(以像素为单位)。

另请参阅 setTopMargin()。

QTextLength QTextFrameFormat::width() const

返回框架边框矩形的宽度。

另请参阅 setWidth() 和QTextLength 。

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