|  | Home · Overviews · Examples

# QTextFrameFormat Class Reference
[com.trolltech.qt.gui module]

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

Inherits `QTextFormat`.

Inherited by `QTextTableFormat`.

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

See also `QTextFrame` and `QTextBlockFormat`.