Home · All Classes · Modules

QTextFrameFormat Class Reference
^{^{[QtGui module]}}

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

Inherits QTextFormat.

Inherited by QTextTableFormat.

Types

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

Methods

__init__ (self)
__init__ (self, QTextFrameFormat)
float border (self)
QBrush borderBrush (self)
BorderStyle borderStyle (self)
float bottomMargin (self)
QTextLength height (self)
bool isValid (self)
float leftMargin (self)
float margin (self)
float padding (self)
QTextFormat.PageBreakFlags pageBreakPolicy (self)
Position position (self)
float rightMargin (self)
setBorder (self, float aborder)
setBorderBrush (self, QBrush brush)
setBorderStyle (self, BorderStyle style)
setBottomMargin (self, float amargin)
setHeight (self, float aheight)
setHeight (self, QTextLength aheight)
setLeftMargin (self, float amargin)
setMargin (self, float amargin)
setPadding (self, float apadding)
setPageBreakPolicy (self, QTextFormat.PageBreakFlags flags)
setPosition (self, Position f)
setRightMargin (self, float amargin)
setTopMargin (self, float amargin)
setWidth (self, QTextLength length)
setWidth (self, float awidth)
float topMargin (self)
QTextLength width (self)

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

Type Documentation

QTextFrameFormat.BorderStyle

This enum describes different border styles for the text frame.

Constant	Value
`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`