The QTextTable class represents a table in a QTextDocument. \inmodule QtGui. More...

#include <qtexttable.h>

Inheritance diagram for QTextTable:

Collaboration diagram for QTextTable:

Public Member Functions
	QTextTable (QTextDocument *doc)

	~QTextTable ()

void	resize (int rows, int cols)

void	insertRows (int pos, int num)

void	insertColumns (int pos, int num)

void	appendRows (int count)

void	appendColumns (int count)

void	removeRows (int pos, int num)

void	removeColumns (int pos, int num)

void	mergeCells (int row, int col, int numRows, int numCols)

void	mergeCells (const QTextCursor &cursor)

void	splitCell (int row, int col, int numRows, int numCols)

int	rows () const

int	columns () const

QTextTableCell	cellAt (int row, int col) const

QTextTableCell	cellAt (int position) const

QTextTableCell	cellAt (const QTextCursor &c) const

QTextCursor	rowStart (const QTextCursor &c) const

QTextCursor	rowEnd (const QTextCursor &c) const

void	setFormat (const QTextTableFormat &format)

QTextTableFormat	format () const

Public Member Functions inherited from QTextFrame
	QTextFrame (QTextDocument *doc)

	~QTextFrame ()

void	setFrameFormat (const QTextFrameFormat &format)

QTextFrameFormat	frameFormat () const

QTextCursor	firstCursorPosition () const

QTextCursor	lastCursorPosition () const

int	firstPosition () const

int	lastPosition () const

QTextFrameLayoutData *	layoutData () const

void	setLayoutData (QTextFrameLayoutData *data)

QList< QTextFrame * >	childFrames () const

QTextFrame *	parentFrame () const

iterator	begin () const

iterator	end () const

Public Member Functions inherited from QTextObject
QTextFormat	format () const

int	formatIndex () const

QTextDocument *	document () const

int	objectIndex () const

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)

virtual	~QObject ()

virtual bool	event (QEvent *event)

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const

void	setObjectName (const QString &name)

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const noexcept

bool	blockSignals (bool b) noexcept

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const

void	dumpObjectInfo () const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const

bool	inherits (const char *classname) const

Friends
class	QTextTableCell

Additional Inherited Members
Public Types inherited from QTextFrame
typedef iterator	Iterator

Public Slots inherited from QObject
void	deleteLater ()

Signals inherited from QObject
void	destroyed (QObject *=nullptr)

void	objectNameChanged (const QString &objectName, QPrivateSignal)

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Member Functions inherited from QTextFrame
	QTextFrame (QTextFramePrivate &p, QTextDocument *doc)

Protected Member Functions inherited from QTextObject
	QTextObject (QTextDocument *doc)

	~QTextObject ()

void	setFormat (const QTextFormat &format)

	QTextObject (QTextObjectPrivate &p, QTextDocument *doc)

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object More...

Related Functions inherited from QObject
template< class T > T	qobject_cast (const QObject *object)

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList

Detailed Description

The QTextTable class represents a table in a QTextDocument. \inmodule QtGui.

\reentrant

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, and is surrounded by a frame.

Tables are usually created and inserted into a document with the QTextCursor::insertTable() function. For example, we can insert a table with three rows and two columns at the current cursor position in an editor using the following lines of code:

\codeline

The table format is either defined when the table is created or changed later with setFormat().

The table currently being edited by the cursor is found with QTextCursor::currentTable(). This allows its format or dimensions to be changed after it has been inserted into a document.

A table's size can be changed with resize(), or by using insertRows(), insertColumns(), removeRows(), or removeColumns(). Use cellAt() to retrieve table cells.

The starting and ending positions of table rows can be found by moving a cursor within a table, and using the rowStart() and rowEnd() functions to obtain cursors at the start and end of each row.

Rows and columns within a QTextTable can be merged and split using the mergeCells() and splitCell() functions. However, only cells that span multiple rows or columns can be split. (Merging or splitting does not increase or decrease the number of rows and columns.)

Note that if you have merged multiple columns and rows into one cell, you will not be able to split the merged cell into new cells spanning over more than one row or column. To be able to split cells spanning over several rows and columns you need to do this over several iterations.

\table 80% \row

\inlineimage texttable-split.png Original Table
Suppose we have a 2x3 table of names and addresses. To merge both columns in the first row we invoke mergeCells() with row = 0, column = 0, numRows = 1 and numColumns = 2.
\row
\inlineimage texttable-merge.png
This gives us the following table. To split the first row of the table back into two cells, we invoke the splitCell() function with numRows and numCols = 1.
\row
\inlineimage texttable-split.png Split Table
This results in the original table. \endtable

See also: QTextTableFormat

Definition at line 98 of file qtexttable.h.

Constructor & Destructor Documentation

◆ QTextTable()

QTextTable::QTextTable ( QTextDocument * doc )

explicit

Definition at line 559 of file qtexttable.cpp.

◆ ~QTextTable()

QTextTable::~QTextTable ( )

Definition at line 568 of file qtexttable.cpp.

Member Function Documentation

◆ appendColumns()

void QTextTable::appendColumns ( int count )

Since: 4.5 Appends count columns at the right side of the table.

See also: insertColumns(), insertRows(), resize(), removeRows(), removeColumns(), appendRows()

Definition at line 848 of file qtexttable.cpp.

Here is the call graph for this function:

◆ appendRows()

void QTextTable::appendRows ( int count )

Since: 4.5 Appends count rows at the bottom of the table.

See also: insertColumns(), insertRows(), resize(), removeRows(), removeColumns(), appendColumns()

Definition at line 837 of file qtexttable.cpp.

Here is the call graph for this function:

◆ cellAt() [1/3]

QTextTableCell QTextTable::cellAt ( const QTextCursor & cursor ) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Returns the table cell containing the given cursor.

Definition at line 624 of file qtexttable.cpp.

Here is the call graph for this function:

◆ cellAt() [2/3]

QTextTableCell QTextTable::cellAt ( int position ) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Returns the table cell that contains the character at the given position in the document.

Definition at line 598 of file qtexttable.cpp.

Here is the call graph for this function:

◆ cellAt() [3/3]

QTextTableCell QTextTable::cellAt	(	int	row,
		int	column
	)		const

Returns the table cell at the given row and column in the table.

See also: columns(), rows()

Definition at line 580 of file qtexttable.cpp.

Here is the caller graph for this function:

◆ columns()

int QTextTable::columns ( ) const

Returns the number of columns in the table.

See also: rows()

Definition at line 1262 of file qtexttable.cpp.

Here is the caller graph for this function:

◆ format()

QTextTableFormat QTextTable::format ( ) const

inline

Returns the table's format.

See also: setFormat()

Definition at line 128 of file qtexttable.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insertColumns()

void QTextTable::insertColumns	(	int	index,
		int	columns
	)

Inserts a number of columns before the column with the specified index.

See also: insertRows(), resize(), removeRows(), removeColumns(), appendRows(), appendColumns()

Definition at line 736 of file qtexttable.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insertRows()

void QTextTable::insertRows	(	int	index,
		int	rows
	)

Inserts a number of rows before the row with the specified index.

See also: resize(), insertColumns(), removeRows(), removeColumns(), appendRows(), appendColumns()

Definition at line 670 of file qtexttable.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mergeCells() [1/2]

void QTextTable::mergeCells ( const QTextCursor & cursor )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since: 4.1

Merges the cells selected by the provided cursor.

See also: splitCell()

Definition at line 1156 of file qtexttable.cpp.

Here is the call graph for this function:

◆ mergeCells() [2/2]

void QTextTable::mergeCells	(	int	row,
		int	column,
		int	numRows,
		int	numCols
	)

Since: 4.1

Merges the cell at the specified row and column with the adjacent cells into one cell. The new cell will span numRows rows and numCols columns. This method does nothing if numRows or numCols is less than the current number of rows or columns spanned by the cell.