class QTextFrameFormat#

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

Inheritance diagram of PySide6.QtGui.QTextFrameFormat

Inherited by: QTextTableFormat

Synopsis#

Methods#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

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

class 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

__init__(fmt)#
Parameters:

fmt – QTextFormat

__init__()

Constructs a text frame format object with the default properties.

border()#
Return type:

float

Returns the width of the border in pixels.

See also

setBorder()

borderBrush()#
Return type:

QBrush

Returns the brush used for the frame’s border.

See also

setBorderBrush()

borderStyle()#
Return type:

BorderStyle

Returns the style of the frame’s border.

See also

setBorderStyle()

bottomMargin()#
Return type:

float

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

height()#
Return type:

QTextLength

Returns the height of the frame’s border rectangle.

See also

setHeight()

leftMargin()#
Return type:

float

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

See also

setLeftMargin()

margin()#
Return type:

float

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

See also

setMargin()

padding()#
Return type:

float

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

See also

setPadding()

pageBreakPolicy()#
Return type:

Combination of PageBreakFlag

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

position()#
Return type:

Position

Returns the positioning policy for frames with this frame format.

See also

setPosition()

rightMargin()#
Return type:

float

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

See also

setRightMargin()

setBorder(border)#
Parameters:

border – float

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

See also

border()

setBorderBrush(brush)#
Parameters:

brush – QBrush

Sets the brush used for the frame’s border.

See also

borderBrush()

setBorderStyle(style)#
Parameters:

style – BorderStyle

Sets the style of the frame’s border.

See also

borderStyle()

setBottomMargin(margin)#
Parameters:

margin – float

Sets the frame’s bottom margin in pixels.

See also

bottomMargin()

setHeight(height)#
Parameters:

height – QTextLength

Sets the frame’s height.

See also

height()

setHeight(height)
Parameters:

height – float

This is an overloaded function.

Sets the frame’s height.

setLeftMargin(margin)#
Parameters:

margin – float

Sets the frame’s left margin in pixels.

See also

leftMargin()

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

setPadding(padding)#
Parameters:

padding – float

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

See also

padding()

setPageBreakPolicy(flags)#
Parameters:

flags – Combination of PageBreakFlag

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

setPosition(f)#
Parameters:

f – Position

Sets the policy for positioning frames with this frame format.

See also

position()

setRightMargin(margin)#
Parameters:

margin – float

Sets the frame’s right margin in pixels.

See also

rightMargin()

setTopMargin(margin)#
Parameters:

margin – float

Sets the frame’s top margin in pixels.

See also

topMargin()

setWidth(length)#
Parameters:

length – QTextLength

Sets the frame’s border rectangle’s width.

See also

width() QTextLength

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.

topMargin()#
Return type:

float

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

See also

setTopMargin()

width()#
Return type:

QTextLength

Returns the width of the frame’s border rectangle.