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

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.

qreal QTextTableCellFormat::bottomBorder() const

Returns the bottom border width of the table cell.

See also setBottomBorder().

QBrush QTextTableCellFormat::bottomBorderBrush() const

Returns the bottom border brush of the table cell.

See also setBottomBorderBrush().

QTextFrameFormat::BorderStyle QTextTableCellFormat::bottomBorderStyle() const

Returns the bottom border style of the table cell.

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.

qreal QTextTableCellFormat::leftBorder() const

Returns the left border width of the table cell.

See also setLeftBorder().

QBrush QTextTableCellFormat::leftBorderBrush() const

Returns the left border brush of the table cell.

See also setLeftBorderBrush().

QTextFrameFormat::BorderStyle QTextTableCellFormat::leftBorderStyle() const

Returns the left border style of the table cell.

See also setLeftBorderStyle().

qreal QTextTableCellFormat::leftPadding() const

Gets the left padding of the table cell.

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

qreal QTextTableCellFormat::rightBorder() const

Returns the right border width of the table cell.

See also setRightBorder().

QBrush QTextTableCellFormat::rightBorderBrush() const

Returns the right border brush of the table cell.

See also setRightBorderBrush().

QTextFrameFormat::BorderStyle QTextTableCellFormat::rightBorderStyle() const

Returns the right border style of the table cell.

See also setRightBorderStyle().

qreal QTextTableCellFormat::rightPadding() const

Gets the right padding of the table cell.

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

void QTextTableCellFormat::setBorder(qreal width)

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

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

void QTextTableCellFormat::setBorderBrush(const QBrush &brush)

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

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

void QTextTableCellFormat::setBorderStyle(QTextFrameFormat::BorderStyle style)

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

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

void QTextTableCellFormat::setBottomBorder(qreal width)

Sets the bottom border width of the table cell.

See also bottomBorder() and QTextTableFormat::setBorderCollapse.

void QTextTableCellFormat::setBottomBorderBrush(const QBrush &brush)

Sets the bottom border brush of the table cell.

See also bottomBorderBrush() and QTextTableFormat::setBorderCollapse.

void QTextTableCellFormat::setBottomBorderStyle(QTextFrameFormat::BorderStyle style)

Sets the bottom border style of the table cell.

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().

void QTextTableCellFormat::setLeftBorder(qreal width)

Sets the left border width of the table cell.

See also leftBorder() and QTextTableFormat::setBorderCollapse.

void QTextTableCellFormat::setLeftBorderBrush(const QBrush &brush)

Sets the left border brush of the table cell.

See also leftBorderBrush() and QTextTableFormat::setBorderCollapse.

void QTextTableCellFormat::setLeftBorderStyle(QTextFrameFormat::BorderStyle style)

Sets the left border style of the table cell.

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().

void QTextTableCellFormat::setRightBorder(qreal width)

Sets the right border width of the table cell.

See also rightBorder() and QTextTableFormat::setBorderCollapse.

void QTextTableCellFormat::setRightBorderBrush(const QBrush &brush)

Sets the right border brush of the table cell.

See also rightBorderBrush() and QTextTableFormat::setBorderCollapse.

void QTextTableCellFormat::setRightBorderStyle(QTextFrameFormat::BorderStyle style)

Sets the right border style of the table cell.

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().

void QTextTableCellFormat::setTopBorder(qreal width)

Sets the top border width of the table cell.

See also topBorder() and QTextTableFormat::setBorderCollapse.

void QTextTableCellFormat::setTopBorderBrush(const QBrush &brush)

Sets the top border brush of the table cell.

See also topBorderBrush() and QTextTableFormat::setBorderCollapse.

void QTextTableCellFormat::setTopBorderStyle(QTextFrameFormat::BorderStyle style)

Sets the top border style of the table cell.

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().

qreal QTextTableCellFormat::topBorder() const

Returns the top border width of the table cell.

See also setTopBorder().

QBrush QTextTableCellFormat::topBorderBrush() const

Returns the top border brush of the table cell.

See also setTopBorderBrush().

QTextFrameFormat::BorderStyle QTextTableCellFormat::topBorderStyle() const

Returns the top border style of the table cell.

See also setTopBorderStyle().

qreal QTextTableCellFormat::topPadding() const

Gets the top padding of the table cell.

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

© 2023 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.