QTextFrameFormat¶

PyQt5.QtGui.QTextFrameFormat

Description¶

The QTextFrameFormat class provides formatting information for frames in a QTextDocument.

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.

Enums¶

BorderStyle

This enum describes different border styles for the text frame.

Methods¶

__init__(): TODO

__init__(QTextFrameFormat): TODO

border() → float: See also

setBorder().

borderBrush() → QBrush: See also

setBorderBrush().

borderStyle() → BorderStyle: See also

setBorderStyle().

bottomMargin() → float: See also

setBottomMargin().

height() → QTextLength: See also

setHeight().

isValid() → bool: TODO

leftMargin() → float: See also

setLeftMargin().

margin() → float: See also

setMargin().

padding() → float: See also

setPadding().

pageBreakPolicy() → PageBreakFlags: See also

setPageBreakPolicy().

position() → Position: See also

setPosition().

rightMargin() → float: See also

setRightMargin().

setBorder(float): See also

border().

setBorderBrush(Union[QBrush, QColor, GlobalColor, QGradient]): See also

borderBrush().

setBorderStyle(BorderStyle): See also

borderStyle().

setBottomMargin(float): See also

bottomMargin().

setHeight(float): See also

height().

setHeight(QTextLength): TODO

setLeftMargin(float): See also

leftMargin().

setMargin(float): See also

margin().

setPadding(float): See also

padding().

setPageBreakPolicy(Union[PageBreakFlags, PageBreakFlag]): See also

pageBreakPolicy().

setPosition(Position): See also

position().

setRightMargin(float): See also

rightMargin().

setTopMargin(float): See also

topMargin().

setWidth(QTextLength): TODO

setWidth(float): See also

width().

topMargin() → float: See also

setTopMargin().

width() → QTextLength: See also

setWidth().

Member	Value	Description
BorderStyle_Dashed	TODO	TODO
BorderStyle_DotDash	TODO	TODO
BorderStyle_DotDotDash	TODO	TODO
BorderStyle_Dotted	TODO	TODO
BorderStyle_Double	TODO	TODO
BorderStyle_Groove	TODO	TODO
BorderStyle_Inset	TODO	TODO
BorderStyle_None	TODO	TODO
BorderStyle_Outset	TODO	TODO
BorderStyle_Ridge	TODO	TODO
BorderStyle_Solid	TODO	TODO