QTextFrameFormat Class

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

Header: #include <QTextFrameFormat>
qmake: QT += gui
Inherits: QTextFormat
Inherited By:

QTextTableFormat

Note: All functions in this class are reentrant.

Public Types

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

Additional Inherited Members

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.

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.

Member Type Documentation

enum QTextFrameFormat::BorderStyle

This enum describes different border styles for the text frame.

ConstantValue
QTextFrameFormat::BorderStyle_None0
QTextFrameFormat::BorderStyle_Dotted1
QTextFrameFormat::BorderStyle_Dashed2
QTextFrameFormat::BorderStyle_Solid3
QTextFrameFormat::BorderStyle_Double4
QTextFrameFormat::BorderStyle_DotDash5
QTextFrameFormat::BorderStyle_DotDotDash6
QTextFrameFormat::BorderStyle_Groove7
QTextFrameFormat::BorderStyle_Ridge8
QTextFrameFormat::BorderStyle_Inset9
QTextFrameFormat::BorderStyle_Outset10

This enum was introduced or modified in Qt 4.3.

See also borderStyle() and FrameBorderStyle.

enum QTextFrameFormat::Position

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

ConstantValue
QTextFrameFormat::InFlow0
QTextFrameFormat::FloatLeft1
QTextFrameFormat::FloatRight2

See also position() and CssFloat.