QTextFrameFormat Class▲
-
Header: QTextFrameFormat
-
CMake:
find_package(Qt6 REQUIRED COMPONENTS Gui)
target_link_libraries(mytarget PRIVATE Qt6::Gui)
-
qmake: QT += gui
-
Inherits: QTextFormat
-
Inherited By: QTextTableFormat
-
Group: QTextFrameFormat is part of Rich Text Processing APIs, shared
Detailed Description▲
A text frame groups together one or more blocks of text, providing a layer of structure larger than the paragraph. The format of a frame specifies how it is rendered and positioned on the screen. It does not directly specify the behavior of the text formatting within, but provides constraints on the layout of its children.
The frame format defines the width() and height() of the frame on the screen. Each frame can have a border() that surrounds its contents with a rectangular box. The border is surrounded by a margin() around the frame, and the contents of the frame are kept separate from the border by the frame's padding(). This scheme is similar to the box model used by Cascading Style Sheets for HTML pages.
The position() of a frame is set using setPosition() and determines how it is located relative to the surrounding text.
The validity of a QTextFrameFormat object can be determined with the isValid() function.
See Also▲
See also QTextFrame, QTextBlockFormat
Member Type Documentation▲
enum QTextFrameFormat::BorderStyle▲
This enum describes different border styles for the text frame.
|
Constant |
|
|---|---|
|
QTextFrameFormat::BorderStyle_None |
0 |
|
QTextFrameFormat::BorderStyle_Dotted |
1 |
|
QTextFrameFormat::BorderStyle_Dashed |
2 |
|
QTextFrameFormat::BorderStyle_Solid |
3 |
|
QTextFrameFormat::BorderStyle_Double |
4 |
|
QTextFrameFormat::BorderStyle_DotDash |
5 |
|
QTextFrameFormat::BorderStyle_DotDotDash |
6 |
|
QTextFrameFormat::BorderStyle_Groove |
7 |
|
QTextFrameFormat::BorderStyle_Ridge |
8 |
|
QTextFrameFormat::BorderStyle_Inset |
9 |
|
QTextFrameFormat::BorderStyle_Outset |
10 |
See Also▲
See also borderStyle(), FrameBorderStyle
enum QTextFrameFormat::Position▲
This enum describes how a frame is located relative to the surrounding text.
|
Constant |
|
|---|---|
|
QTextFrameFormat::InFlow |
0 |
|
QTextFrameFormat::FloatLeft |
1 |
|
QTextFrameFormat::FloatRight |
2 |
See Also▲
Member Function Documentation▲
QTextFrameFormat::QTextFrameFormat()▲
Constructs a text frame format object with the default properties.
qreal QTextFrameFormat::border() const▲
QBrush QTextFrameFormat::borderBrush() const▲
QTextFrameFormat::BorderStyle QTextFrameFormat::borderStyle() const▲
qreal QTextFrameFormat::bottomMargin() const▲
QTextLength QTextFrameFormat::height() const▲
bool QTextFrameFormat::isValid() const▲
Returns true if the format description is valid; otherwise returns false.
qreal QTextFrameFormat::leftMargin() const▲
qreal QTextFrameFormat::margin() const▲
qreal QTextFrameFormat::padding() const▲
QTextFormat::PageBreakFlags QTextFrameFormat::pageBreakPolicy() const▲
Returns the currently set page break policy for the frame/table. The default is QTextFormat::PageBreak_Auto.
See Also▲
See also setPageBreakPolicy()
QTextFrameFormat::Position QTextFrameFormat::position() const▲
qreal QTextFrameFormat::rightMargin() const▲
void QTextFrameFormat::setBorder(qreal width)▲
void QTextFrameFormat::setBorderBrush(const QBrush &brush)▲
void QTextFrameFormat::setBorderStyle(QTextFrameFormat::BorderStyle style)▲
void QTextFrameFormat::setBottomMargin(qreal margin)▲
void QTextFrameFormat::setHeight(const QTextLength &height)▲
void QTextFrameFormat::setHeight(qreal height)▲
This is an overloaded function.
Sets the frame's height.
void QTextFrameFormat::setLeftMargin(qreal margin)▲
void QTextFrameFormat::setMargin(qreal margin)▲
Sets the frame's margin in pixels. This method also sets the left, right, top and bottom margins of the frame to the same value. The individual margins override the general margin.
See Also▲
See also margin()
void QTextFrameFormat::setPadding(qreal width)▲
void QTextFrameFormat::setPageBreakPolicy(QTextFormat::PageBreakFlags policy)▲
void QTextFrameFormat::setPosition(QTextFrameFormat::Position policy)▲
void QTextFrameFormat::setRightMargin(qreal margin)▲
void QTextFrameFormat::setTopMargin(qreal margin)▲
void QTextFrameFormat::setWidth(const QTextLength &width)▲
void QTextFrameFormat::setWidth(qreal width)▲
This is an overloaded function.
Convenience method that sets the width of the frame's border rectangle's width to the specified fixed width.