The QTextTableCell class represents the properties of a cell in a QTextTable. \inmodule QtGui. More...

#include <qtexttable.h>

Public Member Functions
	QTextTableCell ()

	~QTextTableCell ()

	QTextTableCell (const QTextTableCell &o)

QTextTableCell &	operator= (const QTextTableCell &o)

void	setFormat (const QTextCharFormat &format)

QTextCharFormat	format () const

int	row () const

int	column () const

int	rowSpan () const

int	columnSpan () const

bool	isValid () const

QTextCursor	firstCursorPosition () const

QTextCursor	lastCursorPosition () const

int	firstPosition () const

int	lastPosition () const

bool	operator== (const QTextTableCell &other) const

bool	operator!= (const QTextTableCell &other) const

QTextFrame::iterator	begin () const

QTextFrame::iterator	end () const

int	tableCellFormatIndex () const

Friends
class	QTextTable

Detailed Description

The QTextTableCell class represents the properties of a cell in a QTextTable. \inmodule QtGui.

\reentrant

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.

See also: QTextTable, QTextTableFormat

Definition at line 54 of file qtexttable.h.

Constructor & Destructor Documentation

◆ QTextTableCell() [1/2]

QTextTableCell::QTextTableCell ( )

inline

Constructs an invalid table cell.

See also: isValid()

Definition at line 57 of file qtexttable.h.

◆ ~QTextTableCell()

QTextTableCell::~QTextTableCell ( )

inline

Destroys the table cell.

Definition at line 58 of file qtexttable.h.

◆ QTextTableCell() [2/2]

QTextTableCell::QTextTableCell ( const QTextTableCell & other )

inline

Copy constructor. Creates a new QTextTableCell object based on the other cell.

Definition at line 59 of file qtexttable.h.

Member Function Documentation

◆ begin()

QTextFrame::iterator QTextTableCell::begin ( ) const

Returns a frame iterator pointing to the beginning of the table's cell.

See also: end()

Definition at line 279 of file qtexttable.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ column()

int QTextTableCell::column ( ) const

Returns the number of the column in the table that contains this cell.

See also: row()

Definition at line 183 of file qtexttable.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ columnSpan()

int QTextTableCell::columnSpan ( ) const

Returns the number of columns this cell spans. The default is 1.

See also: rowSpan()

Definition at line 210 of file qtexttable.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ end()

QTextFrame::iterator QTextTableCell::end ( ) const

Returns a frame iterator pointing to the end of the table's cell.

See also: begin()

Definition at line 292 of file qtexttable.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ firstCursorPosition()

QTextCursor QTextTableCell::firstCursorPosition ( ) const

Returns the first valid cursor position in this cell.

See also: lastCursorPosition()

Definition at line 228 of file qtexttable.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ firstPosition()

int QTextTableCell::firstPosition ( ) const

Definition at line 249 of file qtexttable.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ format()

QTextCharFormat QTextTableCell::format ( ) const

Returns the cell's character format.

Definition at line 138 of file qtexttable.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isValid()

bool QTextTableCell::isValid ( ) const

inline

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

Definition at line 72 of file qtexttable.h.

Here is the caller graph for this function:

◆ lastCursorPosition()

QTextCursor QTextTableCell::lastCursorPosition ( ) const

Returns the last valid cursor position in this cell.

See also: firstCursorPosition()

Definition at line 238 of file qtexttable.cpp.

Here is the call graph for this function:

◆ lastPosition()

int QTextTableCell::lastPosition ( ) const

Definition at line 260 of file qtexttable.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator!=()

QTextCursor QTextTableCell::operator!= ( const QTextTableCell & other ) const

inline

Returns true if this cell object and the other cell object describe different cells; otherwise returns false.

Definition at line 81 of file qtexttable.h.

Here is the call graph for this function:

◆ operator=()

QTextTableCell & QTextTableCell::operator= ( const QTextTableCell & other )

inline

Assigns the other table cell to this table cell.

Definition at line 60 of file qtexttable.h.

◆ operator==()

QTextCursor QTextTableCell::operator== ( const QTextTableCell & other ) const

inline

Returns true if this cell object and the other cell object describe the same cell; otherwise returns false.

Definition at line 79 of file qtexttable.h.

Here is the call graph for this function:

◆ row()

int QTextTableCell::row ( ) const

Returns the number of the row in the table that contains this cell.

See also: column()

Definition at line 166 of file qtexttable.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rowSpan()

int QTextTableCell::rowSpan ( ) const

Returns the number of rows this cell spans. The default is 1.

See also: columnSpan()

Definition at line 200 of file qtexttable.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFormat()

void QTextTableCell::setFormat ( const QTextCharFormat & format )

Since: 4.2

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.

See also: format()

Definition at line 119 of file qtexttable.cpp.

Here is the call graph for this function:

◆ tableCellFormatIndex()

int QTextTableCell::tableCellFormatIndex ( ) const

Since: 4.5

Returns the index of the tableCell's format in the document's internal list of formats.

See also: QTextDocument::allFormats()

Definition at line 155 of file qtexttable.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ QTextTable

friend class QTextTable

friend

Definition at line 90 of file qtexttable.h.

The documentation for this class was generated from the following files:

src/gui/text/qtexttable.h
src/gui/text/qtexttable.cpp

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ QTextTableCell() [1/2]

◆ ~QTextTableCell()

◆ QTextTableCell() [2/2]

Member Function Documentation

◆ begin()

◆ column()

◆ columnSpan()

◆ end()

◆ firstCursorPosition()

◆ firstPosition()

◆ format()

◆ isValid()

◆ lastCursorPosition()

◆ lastPosition()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ row()

◆ rowSpan()

◆ setFormat()

◆ tableCellFormatIndex()

Friends And Related Function Documentation

◆ QTextTable