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

# QTextTableFormat Class Reference

The QTextTableFormat class provides formatting information for tables in a QTextDocument. More...

    #include <QTextTableFormat>

Inherits QTextFrameFormat.

- List of all members, including inherited members

### Public Functions

- QTextTableFormat ()
- Qt::Alignment alignment () const
- QColor backgroundColor () const
- int cellPadding () const
- int cellSpacing () const
- void clearBackgroundColor ()
- void clearColumnWidthConstraints ()
- QVector<QTextLength> columnWidthConstraints () const
- int columns () const
- bool isValid () const
- void setAlignment ( Qt::Alignment alignment )
- void setBackgroundColor ( const QColor & color )
- void setCellPadding ( int padding )
- void setCellSpacing ( int spacing )
- void setColumnWidthConstraints ( const QVector<QTextLength> & constraints )
- void setColumns ( int columns )

- 15 public functions inherited from QTextFrameFormat
- 41 public functions inherited from QTextFormat

## Detailed Description

The QTextTableFormat class provides formatting information for tables in a QTextDocument.

A table is a group of cells ordered into rows and columns. Each table contains at least one row and one column. Each cell contains a block. Tables in rich text documents are formatted using the properties defined in this class.

Tables are horizontally justified within their parent frame according to the table's alignment. This can be read with the alignment() function and set with setAlignment().

Cells within the table are separated by cell spacing. The number of pixels between cells is set with setCellSpacing() and read with cellSpacing(). The contents of each cell is surrounded by cell padding. The number of pixels between each cell edge and its contents is set with setCellPadding() and read with cellPadding().

The table's background color can be read with the backgroundColor() function, and can be specified with setBackgroundColor(). The background color of each cell can be set independently, and will control the color of the cell within the padded area.

The table format also provides a way to constrain the widths of the columns in the table. Columns can be assigned a fixed width, a variable width, or a percentage of the available width (see QTextLength). The columns() function returns the number of columns with constraints, and the columnWidthConstraints() function returns the constraints defined for the table. These quantities can also be set by calling setColumnWidthConstraints() with a vector containing new constraints. The setColumns() function can be used to change the number of constraints in use. If no constraints are required, clearColumnWidthConstraints() can be used to remove them.

See also QTextTable, QTextTableCell, and QTextLength.

## Member Function Documentation

### QTextTableFormat::QTextTableFormat ()

Constructs a new table format object.

### Qt::Alignment QTextTableFormat::alignment () const

Returns the table's alignment.

See also setAlignment().

### QColor QTextTableFormat::backgroundColor () const

Returns the table's background color.

See also setBackgroundColor().

### int QTextTableFormat::cellPadding () const

Returns the table's cell padding. This describes the distance between the border of a cell and its contents.

### int QTextTableFormat::cellSpacing () const

Returns the table's cell spacing. This describes the distance between adjacent cells.

### void QTextTableFormat::clearBackgroundColor ()

Clears the table's background color. The default background color will be used for the table.

See also backgroundColor() and setBackgroundColor().

### void QTextTableFormat::clearColumnWidthConstraints ()

Clears the column width constraints for the table.

See also columnWidthConstraints() and setColumnWidthConstraints().

### QVector<QTextLength> QTextTableFormat::columnWidthConstraints () const

Returns a list of constraints used by this table format to control the appearance of columns in a table.

See also setColumnWidthConstraints().

### int QTextTableFormat::columns () const

Returns the number of columns specified by the table format.

See also setColumns().

### bool QTextTableFormat::isValid () const

Returns true if this table format is valid; otherwise returns false.

### void QTextTableFormat::setAlignment ( Qt::Alignment alignment )

Sets the table's alignment.

See also alignment().

### void QTextTableFormat::setBackgroundColor ( const QColor & color )

Sets the table's background color.

See also backgroundColor().

### void QTextTableFormat::setCellPadding ( int padding )

Sets the cell padding for the table. This determines the distance between the border of a cell and its contents.

### void QTextTableFormat::setCellSpacing ( int spacing )

Sets the cell spacing for the table. This determines the distance between adjacent cells.

### void QTextTableFormat::setColumnWidthConstraints ( const QVector<QTextLength> & constraints )

Sets the column width constraints for the table.

See also columnWidthConstraints() and clearColumnWidthConstraints().

### void QTextTableFormat::setColumns ( int columns )

Sets the number of columns required by the table format.

See also columns().