Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# QTextFrameFormat Class Reference

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

    #include <QTextFrameFormat>

Inherits QTextFormat.

Inherited by QTextTableFormat.

- List of all members, including inherited members

### Public Types

- enum Position { InFlow, FloatLeft, FloatRight }

### Public Functions

- QTextFrameFormat ()
- int border () const
- QTextLength height () const
- bool isValid () const
- int margin () const
- int padding () const
- Position position () const
- void setBorder ( int width )
- void setHeight ( int height )
- void setHeight ( const QTextLength & height )
- void setMargin ( int margin )
- void setPadding ( int width )
- void setPosition ( Position policy )
- void setWidth ( const QTextLength & width )
- void setWidth ( int width )
- QTextLength width () const

- 41 public functions inherited from QTextFormat

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

## Member Type Documentation

### enum QTextFrameFormat::Position

`QTextFrameFormat::InFlow` |
`QTextFrameFormat::FloatLeft` |
`QTextFrameFormat::FloatRight` |

## Member Function Documentation

### QTextFrameFormat::QTextFrameFormat ()

Constructs a text frame format object with the default properties.

### int QTextFrameFormat::border () const

Returns the width of the border in pixels.

### QTextLength QTextFrameFormat::height () const

Returns the height of the frame's border rectangle.

### bool QTextFrameFormat::isValid () const

Returns true if the format description is valid; otherwise returns false.

### int QTextFrameFormat::margin () const

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

### int QTextFrameFormat::padding () const

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

### Position QTextFrameFormat::position () const

Returns the positioning policy for frames with this frame format.

### void QTextFrameFormat::setBorder ( int width )

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

### void QTextFrameFormat::setHeight ( int height )

Sets the frame's height.

### void QTextFrameFormat::setHeight ( const QTextLength & height )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Sets the frame's height.

### void QTextFrameFormat::setMargin ( int margin )

Sets the frame's margin in pixels.

### void QTextFrameFormat::setPadding ( int width )

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

### void QTextFrameFormat::setPosition ( Position policy )

Sets the policy for positioning frames with this frame format.

### void QTextFrameFormat::setWidth ( const QTextLength & width )

Sets the frame's border rectangle's width.

See also QTextLength.

### void QTextFrameFormat::setWidth ( int width )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

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

### QTextLength QTextFrameFormat::width () const

Returns the width of the frame's border rectangle.

See also QTextLength.