- Qt 6.4
- Qt GUI
- C++ Classes
- QTextTableCellFormat
- Qt 6.4.2 Reference Documentation

# QTextTableCellFormat Class

The QTextTableCellFormat class provides formatting information for table cells in a QTextDocument. More...

Header: | #include <QTextTableCellFormat>
CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake: | QT += gui
Inherits: | QTextCharFormat

- List of all members, including inherited members

Note: All functions in this class are reentrant.

## Public Functions

| QTextTableCellFormat()
qreal | bottomBorder() const
QBrush | bottomBorderBrush() const
QTextFrameFormat::BorderStyle | bottomBorderStyle() const
qreal | bottomPadding() const
bool | isValid() const
qreal | leftBorder() const
QBrush | leftBorderBrush() const
QTextFrameFormat::BorderStyle | leftBorderStyle() const
qreal | leftPadding() const
qreal | rightBorder() const
QBrush | rightBorderBrush() const
QTextFrameFormat::BorderStyle | rightBorderStyle() const
qreal | rightPadding() const
void | setBorder(qreal width)
void | setBorderBrush(const QBrush &brush)
void | setBorderStyle(QTextFrameFormat::BorderStyle style)
void | setBottomBorder(qreal width)
void | setBottomBorderBrush(const QBrush &brush)
void | setBottomBorderStyle(QTextFrameFormat::BorderStyle style)
void | setBottomPadding(qreal padding)
void | setLeftBorder(qreal width)
void | setLeftBorderBrush(const QBrush &brush)
void | setLeftBorderStyle(QTextFrameFormat::BorderStyle style)
void | setLeftPadding(qreal padding)
void | setPadding(qreal padding)
void | setRightBorder(qreal width)
void | setRightBorderBrush(const QBrush &brush)
void | setRightBorderStyle(QTextFrameFormat::BorderStyle style)
void | setRightPadding(qreal padding)
void | setTopBorder(qreal width)
void | setTopBorderBrush(const QBrush &brush)
void | setTopBorderStyle(QTextFrameFormat::BorderStyle style)
void | setTopPadding(qreal padding)
qreal | topBorder() const
QBrush | topBorderBrush() const
QTextFrameFormat::BorderStyle | topBorderStyle() const
qreal | topPadding() const

## Detailed Description

The table cell format of a table cell in a document specifies the visual properties of the table cell.

The padding properties of a table cell are controlled by setLeftPadding(), setRightPadding(), setTopPadding(), and setBottomPadding(). All the paddings can be set at once using setPadding().

See also QTextFormat, QTextBlockFormat, QTextTableFormat, and QTextCharFormat.

## Member Function Documentation

### QTextTableCellFormat::QTextTableCellFormat()

Constructs a new table cell format object.

### `[since 5.14]` qreal QTextTableCellFormat::bottomBorder() const

Returns the bottom border width of the table cell.

This function was introduced in Qt 5.14.

See also setBottomBorder().

### `[since 5.14]` QBrush QTextTableCellFormat::bottomBorderBrush() const

Returns the bottom border brush of the table cell.

This function was introduced in Qt 5.14.

See also setBottomBorderBrush().

### `[since 5.14]` QTextFrameFormat::BorderStyle QTextTableCellFormat::bottomBorderStyle() const

Returns the bottom border style of the table cell.

This function was introduced in Qt 5.14.

See also setBottomBorderStyle().

### qreal QTextTableCellFormat::bottomPadding() const

Gets the bottom padding of the table cell.

See also setBottomPadding(), leftPadding(), rightPadding(), and topPadding().

### bool QTextTableCellFormat::isValid() const

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

### `[since 5.14]` qreal QTextTableCellFormat::leftBorder() const

Returns the left border width of the table cell.

This function was introduced in Qt 5.14.

See also setLeftBorder().

### `[since 5.14]` QBrush QTextTableCellFormat::leftBorderBrush() const

Returns the left border brush of the table cell.

This function was introduced in Qt 5.14.

See also setLeftBorderBrush().

### `[since 5.14]` QTextFrameFormat::BorderStyle QTextTableCellFormat::leftBorderStyle() const

Returns the left border style of the table cell.

This function was introduced in Qt 5.14.

See also setLeftBorderStyle().

### qreal QTextTableCellFormat::leftPadding() const

Gets the left padding of the table cell.

See also setLeftPadding(), rightPadding(), topPadding(), and bottomPadding().

### `[since 5.14]` qreal QTextTableCellFormat::rightBorder() const

Returns the right border width of the table cell.

This function was introduced in Qt 5.14.

See also setRightBorder().

### `[since 5.14]` QBrush QTextTableCellFormat::rightBorderBrush() const

Returns the right border brush of the table cell.

This function was introduced in Qt 5.14.

See also setRightBorderBrush().

### `[since 5.14]` QTextFrameFormat::BorderStyle QTextTableCellFormat::rightBorderStyle() const

Returns the right border style of the table cell.

This function was introduced in Qt 5.14.

See also setRightBorderStyle().

### qreal QTextTableCellFormat::rightPadding() const

Gets the right padding of the table cell.

See also setRightPadding(), leftPadding(), topPadding(), and bottomPadding().

### `[since 5.14]` void QTextTableCellFormat::setBorder(qreal width)

Sets the left, right, top, and bottom border width of the table cell.

This function was introduced in Qt 5.14.

See also setLeftBorder(), setRightBorder(), setTopBorder(), setBottomBorder(), and QTextTableFormat::setBorderCollapse.

### `[since 5.14]` void QTextTableCellFormat::setBorderBrush(const QBrush &brush)

Sets the left, right, top, and bottom border brush of the table cell.

This function was introduced in Qt 5.14.

See also setLeftBorderBrush(), setRightBorderBrush(), setTopBorderBrush(), setBottomBorderBrush(), and QTextTableFormat::setBorderCollapse.

### `[since 5.14]` void QTextTableCellFormat::setBorderStyle(QTextFrameFormat::BorderStyle style)

Sets the left, right, top, and bottom border style of the table cell.

This function was introduced in Qt 5.14.

See also setLeftBorderStyle(), setRightBorderStyle(), setTopBorderStyle(), setBottomBorderStyle(), and QTextTableFormat::setBorderCollapse.

### `[since 5.14]` void QTextTableCellFormat::setBottomBorder(qreal width)

Sets the bottom border width of the table cell.

This function was introduced in Qt 5.14.

See also bottomBorder() and QTextTableFormat::setBorderCollapse.

### `[since 5.14]` void QTextTableCellFormat::setBottomBorderBrush(const QBrush &brush)

Sets the bottom border brush of the table cell.

This function was introduced in Qt 5.14.

See also bottomBorderBrush() and QTextTableFormat::setBorderCollapse.

### `[since 5.14]` void QTextTableCellFormat::setBottomBorderStyle(QTextFrameFormat::BorderStyle style)

Sets the bottom border style of the table cell.

This function was introduced in Qt 5.14.

See also bottomBorderStyle() and QTextTableFormat::setBorderCollapse.

### void QTextTableCellFormat::setBottomPadding(qreal padding)

Sets the bottom padding of the table cell.

See also bottomPadding(), setLeftPadding(), setRightPadding(), and setTopPadding().

### `[since 5.14]` void QTextTableCellFormat::setLeftBorder(qreal width)

Sets the left border width of the table cell.

This function was introduced in Qt 5.14.

See also leftBorder() and QTextTableFormat::setBorderCollapse.

### `[since 5.14]` void QTextTableCellFormat::setLeftBorderBrush(const QBrush &brush)

Sets the left border brush of the table cell.

This function was introduced in Qt 5.14.

See also leftBorderBrush() and QTextTableFormat::setBorderCollapse.

### `[since 5.14]` void QTextTableCellFormat::setLeftBorderStyle(QTextFrameFormat::BorderStyle style)

Sets the left border style of the table cell.

This function was introduced in Qt 5.14.

See also leftBorderStyle() and QTextTableFormat::setBorderCollapse.

### void QTextTableCellFormat::setLeftPadding(qreal padding)

Sets the left padding of the table cell.

See also leftPadding(), setRightPadding(), setTopPadding(), and setBottomPadding().

### void QTextTableCellFormat::setPadding(qreal padding)

Sets the left, right, top, and bottom padding of the table cell.

See also setLeftPadding(), setRightPadding(), setTopPadding(), and setBottomPadding().

### `[since 5.14]` void QTextTableCellFormat::setRightBorder(qreal width)

Sets the right border width of the table cell.

This function was introduced in Qt 5.14.

See also rightBorder() and QTextTableFormat::setBorderCollapse.

### `[since 5.14]` void QTextTableCellFormat::setRightBorderBrush(const QBrush &brush)

Sets the right border brush of the table cell.

This function was introduced in Qt 5.14.

See also rightBorderBrush() and QTextTableFormat::setBorderCollapse.

### `[since 5.14]` void QTextTableCellFormat::setRightBorderStyle(QTextFrameFormat::BorderStyle style)

Sets the right border style of the table cell.

This function was introduced in Qt 5.14.

See also rightBorderStyle() and QTextTableFormat::setBorderCollapse.

### void QTextTableCellFormat::setRightPadding(qreal padding)

Sets the right padding of the table cell.

See also rightPadding(), setLeftPadding(), setTopPadding(), and setBottomPadding().

### `[since 5.14]` void QTextTableCellFormat::setTopBorder(qreal width)

Sets the top border width of the table cell.

This function was introduced in Qt 5.14.

See also topBorder() and QTextTableFormat::setBorderCollapse.

### `[since 5.14]` void QTextTableCellFormat::setTopBorderBrush(const QBrush &brush)

Sets the top border brush of the table cell.

This function was introduced in Qt 5.14.

See also topBorderBrush() and QTextTableFormat::setBorderCollapse.

### `[since 5.14]` void QTextTableCellFormat::setTopBorderStyle(QTextFrameFormat::BorderStyle style)

Sets the top border style of the table cell.

This function was introduced in Qt 5.14.

See also topBorderStyle() and QTextTableFormat::setBorderCollapse.

### void QTextTableCellFormat::setTopPadding(qreal padding)

Sets the top padding of the table cell.

See also topPadding(), setLeftPadding(), setRightPadding(), and setBottomPadding().

### `[since 5.14]` qreal QTextTableCellFormat::topBorder() const

Returns the top border width of the table cell.

This function was introduced in Qt 5.14.

See also setTopBorder().

### `[since 5.14]` QBrush QTextTableCellFormat::topBorderBrush() const

Returns the top border brush of the table cell.

This function was introduced in Qt 5.14.

See also setTopBorderBrush().

### `[since 5.14]` QTextFrameFormat::BorderStyle QTextTableCellFormat::topBorderStyle() const

Returns the top border style of the table cell.

This function was introduced in Qt 5.14.

See also setTopBorderStyle().

### qreal QTextTableCellFormat::topPadding() const

Gets the top padding of the table cell.

See also setTopPadding(), leftPadding(), rightPadding(), and bottomPadding().