Detailed Description
The QTextTableCell class represents the properties of a cell in a QTextTable.
Table cells are pieces of document structure that belong to a table. The table orders cells into particular rows and columns; cells can also span multiple columns and rows.
Cells are usually created when a table is inserted into a document with QTextCursor::insertTable(), but they are also created and destroyed when a table is resized.
Cells contain information about their location in a table; you can obtain the row() and column() numbers of a cell, and its rowSpan() and columnSpan().
The format() of a cell describes the default character format of its contents. The firstCursorPosition() and lastCursorPosition() functions are used to obtain the extent of the cell in the document.
Member Function Documentation
QTextTableCell::QTextTableCell()
Constructs an invalid table cell.
See also isValid().
QTextTableCell::QTextTableCell(const QTextTableCell & other)
Copy constructor. Creates a new QTextTableCell object based on the other cell.
QTextTableCell::~QTextTableCell()
Destroys the table cell.
Returns a frame iterator pointing to the beginning of the table's cell.
See also end().
int QTextTableCell::column() const
Returns the number of the column in the table that contains this cell.
See also row().
int QTextTableCell::columnSpan() const
Returns the number of columns this cell spans. The default is 1.
See also rowSpan().
Returns a frame iterator pointing to the end of the table's cell.
See also begin().
QTextCursor QTextTableCell::firstCursorPosition() const
Returns the first valid cursor position in this cell.
See also lastCursorPosition().
QTextCharFormat QTextTableCell::format() const
Returns the cell's character format.
See also setFormat().
bool QTextTableCell::isValid() const
Returns true if this is a valid table cell; otherwise returns false.
QTextCursor QTextTableCell::lastCursorPosition() const
Returns the last valid cursor position in this cell.
See also firstCursorPosition().
int QTextTableCell::row() const
Returns the number of the row in the table that contains this cell.
See also column().
int QTextTableCell::rowSpan() const
Returns the number of rows this cell spans. The default is 1.
See also columnSpan().
void QTextTableCell::setFormat(const QTextCharFormat & format)
Sets the cell's character format to format. This can for example be used to change the background color of the entire cell:
QTextTableCell cell = table->cellAt(2, 3); QTextCharFormat format = cell.format(); format.setBackground(Qt::blue); cell.setFormat(format);
Note that the cell's row or column span cannot be changed through this function. You have to use QTextTable::mergeCells and QTextTable::splitCell instead.
This function was introduced in Qt 4.2.
See also format().
int QTextTableCell::tableCellFormatIndex() const
Returns the index of the tableCell's format in the document's internal list of formats.
This function was introduced in Qt 4.5.
See also QTextDocument::allFormats().
bool QTextTableCell::operator!=(const QTextTableCell & other) const
Returns true if this cell object and the other cell object describe different cells; otherwise returns false.
QTextTableCell & QTextTableCell::operator=(const QTextTableCell & other)
Assigns the other table cell to this table cell.
bool QTextTableCell::operator==(const QTextTableCell & other) const
Returns true if this cell object and the other cell object describe the same cell; otherwise returns false.
