QTextTableFormat 类

QTextTableFormat 类提供格式化信息为表格在 QTextDocument . 更多...

头: #include <QTextTableFormat>
CMake: find_package(Qt6 COMPONENTS Gui REQUIRED)
target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake: QT += gui
继承: QTextFrameFormat

注意: 此类的所有函数 可重入 .

公共函数

  QTextTableFormat ()
Qt::Alignment alignment () const
bool borderCollapse () const
qreal cellPadding () const
qreal cellSpacing () const
void clearColumnWidthConstraints ()
QList<QTextLength> columnWidthConstraints () const
int columns () const
int headerRowCount () const
bool isValid () const
void setAlignment (Qt::Alignment alignment )
void setBorderCollapse (bool borderCollapse )
void setCellPadding (qreal padding )
void setCellSpacing (qreal spacing )
void setColumnWidthConstraints (const QList<QTextLength> & constraints )
void setHeaderRowCount (int count )

详细描述

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 background () function, and can be specified with setBackground (). 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 )。 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 list containing new constraints. If no constraints are required, clearColumnWidthConstraints () can be used to remove them.

另请参阅 QTextTable , QTextTableCell ,和 QTextLength .

成员函数文档编制

QTextTableFormat:: QTextTableFormat ()

构造新的表格格式对象。

Qt::Alignment QTextTableFormat:: alignment () const

返回表格的对齐方式。

另请参阅 setAlignment ().

[since 5.14] bool QTextTableFormat:: borderCollapse () const

Returns true if borderCollapse is enabled.

该函数在 Qt 5.14 引入。

另请参阅 setBorderCollapse ().

qreal QTextTableFormat:: cellPadding () const

返回表格的单元格铺垫。这描述单元格边框与其内容之间的距离。

另请参阅 setCellPadding ().

qreal QTextTableFormat:: cellSpacing () const

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

另请参阅 setCellSpacing ().

void QTextTableFormat:: clearColumnWidthConstraints ()

Clears the column width constraints for the table.

另请参阅 columnWidthConstraints () 和 setColumnWidthConstraints ().

QList < QTextLength > QTextTableFormat:: columnWidthConstraints () const

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

另请参阅 setColumnWidthConstraints ().

int QTextTableFormat:: columns () const

Returns the number of columns specified by the table format.

int QTextTableFormat:: headerRowCount () const

Returns the number of rows in the table that define the header.

另请参阅 setHeaderRowCount ().

bool QTextTableFormat:: isValid () const

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

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

Sets the table's alignment .

另请参阅 alignment ().

[since 5.14] void QTextTableFormat:: setBorderCollapse ( bool borderCollapse )

Enabling borderCollapse will have the following implications:

  • The borders and grid of the table will be rendered following the CSS table border-collapse : collapse rules
  • 设置 border property to a minimum value of 1 will render a one pixel solid inner table grid using the borderBrush property and an outer border as specified
  • The various border style properties of QTextTableCellFormat can be used to customize the grid and have precedence over the border and grid of the table
  • cellSpacing property will be ignored
  • For print pagination:
    • Columns continued on a page will not have their top cell border rendered
    • Repeated header rows will always have their bottom cell border rendered

采用 borderCollapse disabled, cell borders can still be styled using QTextTableCellFormat but styling will be applied only within the cell's frame, which is probably not very useful in practice.

该函数在 Qt 5.14 引入。

另请参阅 borderCollapse (), setBorder (), setBorderBrush (), setBorderStyle (),和 QTextTableCellFormat .

void QTextTableFormat:: setCellPadding ( qreal padding )

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

另请参阅 cellPadding ().

void QTextTableFormat:: setCellSpacing ( qreal spacing )

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

This property will be ignored if borderCollapse is enabled.

另请参阅 cellSpacing ().

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

Sets the column width constraints for the table.

另请参阅 columnWidthConstraints () 和 clearColumnWidthConstraints ().

void QTextTableFormat:: setHeaderRowCount ( int count )

Declares the first count rows of the table as table header. The table header rows get repeated when a table is broken across a page boundary.

另请参阅 headerRowCount ().