QTextFrameFormat

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

Inheritance diagram of PySide6.QtGui.QTextFrameFormat

Inherited by: QTextTableFormat

Synopsis

Functions

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.

../../_images/qtextframe-style.png

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.

class PySide6.QtGui.QTextFrameFormat

PySide6.QtGui.QTextFrameFormat(fmt)

PySide6.QtGui.QTextFrameFormat(QTextFrameFormat)

Parameters

Constructs a text frame format object with the default properties.

PySide6.QtGui.QTextFrameFormat.Position

This enum describes how a frame is located relative to the surrounding text.

Constant

Description

QTextFrameFormat.InFlow

QTextFrameFormat.FloatLeft

QTextFrameFormat.FloatRight

See also

position() CssFloat

PySide6.QtGui.QTextFrameFormat.BorderStyle

This enum describes different border styles for the text frame.

Constant

Description

QTextFrameFormat.BorderStyle_None

QTextFrameFormat.BorderStyle_Dotted

QTextFrameFormat.BorderStyle_Dashed

QTextFrameFormat.BorderStyle_Solid

QTextFrameFormat.BorderStyle_Double

QTextFrameFormat.BorderStyle_DotDash

QTextFrameFormat.BorderStyle_DotDotDash

QTextFrameFormat.BorderStyle_Groove

QTextFrameFormat.BorderStyle_Ridge

QTextFrameFormat.BorderStyle_Inset

QTextFrameFormat.BorderStyle_Outset

See also

borderStyle() FrameBorderStyle

PySide6.QtGui.QTextFrameFormat.border()
Return type

float

Returns the width of the border in pixels.

See also

setBorder()

PySide6.QtGui.QTextFrameFormat.borderBrush()
Return type

PySide6.QtGui.QBrush

Returns the brush used for the frame’s border.

See also

setBorderBrush()

PySide6.QtGui.QTextFrameFormat.borderStyle()
Return type

BorderStyle

Returns the style of the frame’s border.

See also

setBorderStyle()

PySide6.QtGui.QTextFrameFormat.bottomMargin()
Return type

float

Returns the width of the frame’s bottom margin in pixels.

PySide6.QtGui.QTextFrameFormat.height()
Return type

PySide6.QtGui.QTextLength

Returns the height of the frame’s border rectangle.

See also

setHeight()

PySide6.QtGui.QTextFrameFormat.leftMargin()
Return type

float

Returns the width of the frame’s left margin in pixels.

See also

setLeftMargin()

PySide6.QtGui.QTextFrameFormat.margin()
Return type

float

Returns the width of the frame’s external margin in pixels.

See also

setMargin()

PySide6.QtGui.QTextFrameFormat.padding()
Return type

float

Returns the width of the frame’s internal padding in pixels.

See also

setPadding()

PySide6.QtGui.QTextFrameFormat.pageBreakPolicy()
Return type

PageBreakFlags

Returns the currently set page break policy for the frame/table. The default is PageBreak_Auto .

PySide6.QtGui.QTextFrameFormat.position()
Return type

Position

Returns the positioning policy for frames with this frame format.

See also

setPosition()

PySide6.QtGui.QTextFrameFormat.rightMargin()
Return type

float

Returns the width of the frame’s right margin in pixels.

See also

setRightMargin()

PySide6.QtGui.QTextFrameFormat.setBorder(border)
Parameters

border – float

Sets the width (in pixels) of the frame’s border.

See also

border()

PySide6.QtGui.QTextFrameFormat.setBorderBrush(brush)
Parameters

brushPySide6.QtGui.QBrush

Sets the brush used for the frame’s border.

See also

borderBrush()

PySide6.QtGui.QTextFrameFormat.setBorderStyle(style)
Parameters

styleBorderStyle

Sets the style of the frame’s border.

See also

borderStyle()

PySide6.QtGui.QTextFrameFormat.setBottomMargin(margin)
Parameters

margin – float

Sets the frame’s bottom margin in pixels.

See also

bottomMargin()

PySide6.QtGui.QTextFrameFormat.setHeight(height)
Parameters

heightPySide6.QtGui.QTextLength

PySide6.QtGui.QTextFrameFormat.setHeight(height)
Parameters

height – float

This is an overloaded function.

Sets the frame’s height.

PySide6.QtGui.QTextFrameFormat.setLeftMargin(margin)
Parameters

margin – float

Sets the frame’s left margin in pixels.

See also

leftMargin()

PySide6.QtGui.QTextFrameFormat.setMargin(margin)
Parameters

margin – float

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

margin()

PySide6.QtGui.QTextFrameFormat.setPadding(padding)
Parameters

padding – float

Sets the width of the frame’s internal padding in pixels.

See also

padding()

PySide6.QtGui.QTextFrameFormat.setPageBreakPolicy(flags)
Parameters

flagsPageBreakFlags

Sets the page break policy for the frame/table to policy.

PySide6.QtGui.QTextFrameFormat.setPosition(f)
Parameters

fPosition

Sets the policy for positioning frames with this frame format.

See also

position()

PySide6.QtGui.QTextFrameFormat.setRightMargin(margin)
Parameters

margin – float

Sets the frame’s right margin in pixels.

See also

rightMargin()

PySide6.QtGui.QTextFrameFormat.setTopMargin(margin)
Parameters

margin – float

Sets the frame’s top margin in pixels.

See also

topMargin()

PySide6.QtGui.QTextFrameFormat.setWidth(length)
Parameters

lengthPySide6.QtGui.QTextLength

PySide6.QtGui.QTextFrameFormat.setWidth(width)
Parameters

width – float

This is an overloaded function.

Convenience method that sets the width of the frame’s border rectangle’s width to the specified fixed width.

PySide6.QtGui.QTextFrameFormat.topMargin()
Return type

float

Returns the width of the frame’s top margin in pixels.

See also

setTopMargin()

PySide6.QtGui.QTextFrameFormat.width()
Return type

PySide6.QtGui.QTextLength

Returns the width of the frame’s border rectangle.