Qt 4.7: QTableWidget Class Reference

Qt Reference Documentation

# QTableWidget Class Reference

The QTableWidget class provides an item-based table view with a default model. More...

     #include <QTableWidget>

Inherits: QTableView.

- List of all members, including inherited members
- Obsolete members

## Properties

- columnCount : int
- rowCount : int

- 5 properties inherited from QTableView
- 16 properties inherited from QAbstractItemView
- 2 properties inherited from QAbstractScrollArea
- 6 properties inherited from QFrame
- 58 properties inherited from QWidget
- 1 property inherited from QObject

## Public Functions

| QTableWidget ( QWidget * parent = 0 )
| QTableWidget ( int rows, int columns, QWidget * parent = 0 )
| ~QTableWidget ()
QWidget * | cellWidget ( int row, int column ) const
void | closePersistentEditor ( QTableWidgetItem * item )
int | column ( const QTableWidgetItem * item ) const
int | columnCount () const
int | currentColumn () const
QTableWidgetItem * | currentItem () const
int | currentRow () const
void | editItem ( QTableWidgetItem * item )
QList<QTableWidgetItem *> | findItems ( const QString & text, Qt::MatchFlags flags ) const
QTableWidgetItem * | horizontalHeaderItem ( int column ) const
QTableWidgetItem * | item ( int row, int column ) const
QTableWidgetItem * | itemAt ( const QPoint & point ) const
QTableWidgetItem * | itemAt ( int ax, int ay ) const
const QTableWidgetItem * | itemPrototype () const
void | openPersistentEditor ( QTableWidgetItem * item )
void | removeCellWidget ( int row, int column )
int | row ( const QTableWidgetItem * item ) const
int | rowCount () const
QList<QTableWidgetItem *> | selectedItems ()
QList<QTableWidgetSelectionRange> | selectedRanges () const
void | setCellWidget ( int row, int column, QWidget * widget )
void | setColumnCount ( int columns )
void | setCurrentCell ( int row, int column )
void | setCurrentCell ( int row, int column, QItemSelectionModel::SelectionFlags command )
void | setCurrentItem ( QTableWidgetItem * item )
void | setCurrentItem ( QTableWidgetItem * item, QItemSelectionModel::SelectionFlags command )
void | setHorizontalHeaderItem ( int column, QTableWidgetItem * item )
void | setHorizontalHeaderLabels ( const QStringList & labels )
void | setItem ( int row, int column, QTableWidgetItem * item )
void | setItemPrototype ( const QTableWidgetItem * item )
void | setRangeSelected ( const QTableWidgetSelectionRange & range, bool select )
void | setRowCount ( int rows )
void | setVerticalHeaderItem ( int row, QTableWidgetItem * item )
void | setVerticalHeaderLabels ( const QStringList & labels )
void | sortItems ( int column, Qt::SortOrder order = Qt::AscendingOrder )
QTableWidgetItem * | takeHorizontalHeaderItem ( int column )
QTableWidgetItem * | takeItem ( int row, int column )
QTableWidgetItem * | takeVerticalHeaderItem ( int row )
QTableWidgetItem * | verticalHeaderItem ( int row ) const
int | visualColumn ( int logicalColumn ) const
QRect | visualItemRect ( const QTableWidgetItem * item ) const
int | visualRow ( int logicalRow ) const

- 34 public functions inherited from QTableView
- 57 public functions inherited from QAbstractItemView
- 17 public functions inherited from QAbstractScrollArea
- 14 public functions inherited from QFrame
- 217 public functions inherited from QWidget
- 29 public functions inherited from QObject
- 13 public functions inherited from QPaintDevice

## Public Slots

void | clear ()
void | clearContents ()
void | insertColumn ( int column )
void | insertRow ( int row )
void | removeColumn ( int column )
void | removeRow ( int row )
void | scrollToItem ( const QTableWidgetItem * item, QAbstractItemView::ScrollHint hint = EnsureVisible )

- 11 public slots inherited from QTableView
- 9 public slots inherited from QAbstractItemView
- 19 public slots inherited from QWidget
- 1 public slot inherited from QObject

## Signals

void | cellActivated ( int row, int column )
void | cellChanged ( int row, int column )
void | cellClicked ( int row, int column )
void | cellDoubleClicked ( int row, int column )
void | cellEntered ( int row, int column )
void | cellPressed ( int row, int column )
void | currentCellChanged ( int currentRow, int currentColumn, int previousRow, int previousColumn )
void | currentItemChanged ( QTableWidgetItem * current, QTableWidgetItem * previous )
void | itemActivated ( QTableWidgetItem * item )
void | itemChanged ( QTableWidgetItem * item )
void | itemClicked ( QTableWidgetItem * item )
void | itemDoubleClicked ( QTableWidgetItem * item )
void | itemEntered ( QTableWidgetItem * item )
void | itemPressed ( QTableWidgetItem * item )
void | itemSelectionChanged ()

- 6 signals inherited from QAbstractItemView
- 1 signal inherited from QWidget
- 1 signal inherited from QObject

## Protected Functions

virtual bool | dropMimeData ( int row, int column, const QMimeData * data, Qt::DropAction action )
QModelIndex | indexFromItem ( QTableWidgetItem * item ) const
QTableWidgetItem * | itemFromIndex ( const QModelIndex & index ) const
QList<QTableWidgetItem *> | items ( const QMimeData * data ) const
virtual QMimeData * | mimeData ( const QList<QTableWidgetItem *> items ) const
virtual QStringList | mimeTypes () const
virtual Qt::DropActions | supportedDropActions () const

## Reimplemented Protected Functions

virtual void | dropEvent ( QDropEvent * event )
virtual bool | event ( QEvent * e )

- 14 protected functions inherited from QTableView
- 36 protected functions inherited from QAbstractItemView
- 18 protected functions inherited from QAbstractScrollArea
- 3 protected functions inherited from QFrame
- 37 protected functions inherited from QWidget
- 7 protected functions inherited from QObject
- 1 protected function inherited from QPaintDevice

### Additional Inherited Members

- 4 static public members inherited from QWidget
- 5 static public members inherited from QObject
- 6 protected slots inherited from QTableView
- 9 protected slots inherited from QAbstractItemView
- 1 protected slot inherited from QAbstractScrollArea
- 1 protected slot inherited from QWidget

## Detailed Description

The QTableWidget class provides an item-based table view with a default model.

Table widgets provide standard table display facilities for applications. The items in a QTableWidget are provided by QTableWidgetItem.

If you want a table that uses your own data model you should use QTableView rather than this class.

Table widgets can be constructed with the required numbers of rows and columns:

         tableWidget = new QTableWidget(12, 3, this);

Alternatively, tables can be constructed without a given size and resized later:

         tableWidget = new QTableWidget(this);
         tableWidget->setRowCount(10);
         tableWidget->setColumnCount(5);

Items are created ouside the table (with no parent widget) and inserted into the table with setItem():

         QTableWidgetItem *newItem = new QTableWidgetItem(tr("%1").arg(
             (row+1)*(column+1)));
         tableWidget->setItem(row, column, newItem);

If you want to enable sorting in your table widget, do so after you have populated it with items, otherwise sorting may interfere with the insertion order (see setItem() for details).

Tables can be given both horizontal and vertical headers. The simplest way to create the headers is to supply a list of strings to the setHorizontalHeaderLabels() and setVerticalHeaderLabels() functions. These will provide simple textual headers for the table's columns and rows. More sophisticated headers can be created from existing table items that are usually constructed outside the table. For example, we can construct a table item with an icon and aligned text, and use it as the header for a particular column:

         QTableWidgetItem *cubesHeaderItem = new QTableWidgetItem(tr("Cubes"));
         cubesHeaderItem->setIcon(QIcon(QPixmap(":/Images/cubed.png")));
         cubesHeaderItem->setTextAlignment(Qt::AlignVCenter);

The number of rows in the table can be found with rowCount(), and the number of columns with columnCount(). The table can be cleared with the clear() function.

A Windows XP style table widget. | A Macintosh style table widget. | A Plastique style table widget.

See also QTableWidgetItem, QTableView, and Model/View Programming.

## Property Documentation

### columnCount : int

This property holds the number of columns in the table.

By default, for a table constructed without row and column counts, this property contains a value of 0.

Access functions:

int | columnCount () const
void | setColumnCount ( int columns )

### rowCount : int

This property holds the number of rows in the table.

By default, for a table constructed without row and column counts, this property contains a value of 0.

Access functions:

int | rowCount () const
void | setRowCount ( int rows )

## Member Function Documentation

### QTableWidget::QTableWidget ( QWidget * parent = 0 )

Creates a new table view with the given parent.

### QTableWidget::QTableWidget ( int rows, int columns, QWidget * parent = 0 )

Creates a new table view with the given rows and columns, and with the given parent.

### QTableWidget::~QTableWidget ()

Destroys this QTableWidget.

### void QTableWidget::cellActivated ( int row, int column )`[signal]`

This signal is emitted when the cell specified by row and column has been activated

This function was introduced in Qt 4.1.

### void QTableWidget::cellChanged ( int row, int column )`[signal]`

This signal is emitted whenever the data of the item in the cell specified by row and column has changed.

This function was introduced in Qt 4.1.

### void QTableWidget::cellClicked ( int row, int column )`[signal]`

This signal is emitted whenever a cell in the table is clicked. The row and column specified is the cell that was clicked.

This function was introduced in Qt 4.1.

### void QTableWidget::cellDoubleClicked ( int row, int column )`[signal]`

This signal is emitted whenever a cell in the table is double clicked. The row and column specified is the cell that was double clicked.

This function was introduced in Qt 4.1.

### void QTableWidget::cellEntered ( int row, int column )`[signal]`

This signal is emitted when the mouse cursor enters a cell. The cell is specified by row and column.

This signal is only emitted when mouseTracking is turned on, or when a mouse button is pressed while moving into an item.

This function was introduced in Qt 4.1.

### void QTableWidget::cellPressed ( int row, int column )`[signal]`

This signal is emitted whenever a cell in the table is pressed. The row and column specified is the cell that was pressed.

This function was introduced in Qt 4.1.

### QWidget * QTableWidget::cellWidget ( int row, int column ) const

Returns the widget displayed in the cell in the given row and column.

Note: The table takes ownership of the widget.

This function was introduced in Qt 4.1.

See also setCellWidget().

### void QTableWidget::clear ()`[slot]`

Removes all items in the view. This will also remove all selections. The table dimensions stay the same.

### void QTableWidget::clearContents ()`[slot]`

Removes all items not in the headers from the view. This will also remove all selections. The table dimensions stay the same.

This function was introduced in Qt 4.2.

### void QTableWidget::closePersistentEditor ( QTableWidgetItem * item )

Closes the persistent editor for item.

See also openPersistentEditor().

### int QTableWidget::column ( const QTableWidgetItem * item ) const

Returns the column for the item.

### void QTableWidget::currentCellChanged ( int currentRow, int currentColumn, int previousRow, int previousColumn )`[signal]`

This signal is emitted whenever the current cell changes. The cell specified by previousRow and previousColumn is the cell that previously had the focus, the cell specified by currentRow and currentColumn is the new current cell.

This function was introduced in Qt 4.1.

### int QTableWidget::currentColumn () const

Returns the column of the current item.

See also currentRow() and setCurrentCell().

### QTableWidgetItem * QTableWidget::currentItem () const

Returns the current item.

See also setCurrentItem().

### void QTableWidget::currentItemChanged ( QTableWidgetItem * current, QTableWidgetItem * previous )`[signal]`

This signal is emitted whenever the current item changes. The previous item is the item that previously had the focus, current is the new current item.

### int QTableWidget::currentRow () const

Returns the row of the current item.

See also currentColumn() and setCurrentCell().

### void QTableWidget::dropEvent ( QDropEvent * event )`[virtual protected]`

Reimplemented from QWidget::dropEvent().

### bool QTableWidget::dropMimeData ( int row, int column, const QMimeData * data, Qt::DropAction action )`[virtual protected]`

Handles the data supplied by a drag and drop operation that ended with the given action in the given row and column. Returns true if the data and action can be handled by the model; otherwise returns false.

See also supportedDropActions().

### void QTableWidget::editItem ( QTableWidgetItem * item )

Starts editing the item if it is editable.

### bool QTableWidget::event ( QEvent * e )`[virtual protected]`

Reimplemented from QObject::event().

### QList<QTableWidgetItem *> QTableWidget::findItems ( const QString & text, Qt::MatchFlags flags ) const

Finds items that matches the text using the given flags.

### QTableWidgetItem * QTableWidget::horizontalHeaderItem ( int column ) const

Returns the horizontal header item for column, column, if one has been set; otherwise returns 0.

See also setHorizontalHeaderItem().

### QModelIndex QTableWidget::indexFromItem ( QTableWidgetItem * item ) const`[protected]`

Returns the QModelIndex assocated with the given item.

### void QTableWidget::insertColumn ( int column )`[slot]`

Inserts an empty column into the table at column.

### void QTableWidget::insertRow ( int row )`[slot]`

Inserts an empty row into the table at row.

### QTableWidgetItem * QTableWidget::item ( int row, int column ) const

Returns the item for the given row and column if one has been set; otherwise returns 0.

See also setItem().

### void QTableWidget::itemActivated ( QTableWidgetItem * item )`[signal]`

This signal is emitted when the specified item has been activated

### QTableWidgetItem * QTableWidget::itemAt ( const QPoint & point ) const

Returns a pointer to the item at the given point, or returns 0 if point is not covered by an item in the table widget.

See also item().

### QTableWidgetItem * QTableWidget::itemAt ( int ax, int ay ) const

Returns the item at the position equivalent to QPoint(ax, ay) in the table widget's coordinate system, or returns 0 if the specified point is not covered by an item in the table widget.

See also item().

### void QTableWidget::itemChanged ( QTableWidgetItem * item )`[signal]`

This signal is emitted whenever the data of item has changed.

### void QTableWidget::itemClicked ( QTableWidgetItem * item )`[signal]`

This signal is emitted whenever an item in the table is clicked. The item specified is the item that was clicked.

### void QTableWidget::itemDoubleClicked ( QTableWidgetItem * item )`[signal]`

This signal is emitted whenever an item in the table is double clicked. The item specified is the item that was double clicked.

### void QTableWidget::itemEntered ( QTableWidgetItem * item )`[signal]`

This signal is emitted when the mouse cursor enters an item. The item is the item entered.

This signal is only emitted when mouseTracking is turned on, or when a mouse button is pressed while moving into an item.

### QTableWidgetItem * QTableWidget::itemFromIndex ( const QModelIndex & index ) const`[protected]`

Returns a pointer to the QTableWidgetItem assocated with the given index.

### void QTableWidget::itemPressed ( QTableWidgetItem * item )`[signal]`

This signal is emitted whenever an item in the table is pressed. The item specified is the item that was pressed.

### const QTableWidgetItem * QTableWidget::itemPrototype () const

Returns the item prototype used by the table.

See also setItemPrototype().

### void QTableWidget::itemSelectionChanged ()`[signal]`

This signal is emitted whenever the selection changes.

See also selectedItems() and QTableWidgetItem::isSelected().

### QList<QTableWidgetItem *> QTableWidget::items ( const QMimeData * data ) const`[protected]`

Returns a list of pointers to the items contained in the data object. If the object was not created by a QTreeWidget in the same process, the list is empty.

### QMimeData * QTableWidget::mimeData ( const QList<QTableWidgetItem *> items ) const`[virtual protected]`

Returns an object that contains a serialized description of the specified items. The format used to describe the items is obtained from the mimeTypes() function.

If the list of items is empty, 0 is returned rather than a serialized empty list.

### QStringList QTableWidget::mimeTypes () const`[virtual protected]`

Returns a list of MIME types that can be used to describe a list of tablewidget items.

See also mimeData().

### void QTableWidget::openPersistentEditor ( QTableWidgetItem * item )

Opens an editor for the give item. The editor remains open after editing.

See also closePersistentEditor().

### void QTableWidget::removeCellWidget ( int row, int column )

Removes the widget set on the cell indicated by row and column.

This function was introduced in Qt 4.3.

### void QTableWidget::removeColumn ( int column )`[slot]`

Removes the column column and all its items from the table.

### void QTableWidget::removeRow ( int row )`[slot]`

Removes the row row and all its items from the table.

### int QTableWidget::row ( const QTableWidgetItem * item ) const

Returns the row for the item.

### void QTableWidget::scrollToItem ( const QTableWidgetItem * item, QAbstractItemView::ScrollHint hint = EnsureVisible )`[slot]`

Scrolls the view if necessary to ensure that the item is visible. The hint parameter specifies more precisely where the item should be located after the operation.

### QList<QTableWidgetItem *> QTableWidget::selectedItems ()

Returns a list of all selected items.

This function returns a list of pointers to the contents of the selected cells. Use the selectedIndexes() function to retrieve the complete selection including empty cells.

See also selectedIndexes().

### QList<QTableWidgetSelectionRange> QTableWidget::selectedRanges () const

Returns a list of all selected ranges.

See also QTableWidgetSelectionRange.

### void QTableWidget::setCellWidget ( int row, int column, QWidget * widget )

Sets the given widget to be displayed in the cell in the given row and column, passing the ownership of the widget to the table.

If cell widget A is replaced with cell widget B, cell widget A will be deleted. For example, in the code snippet below, the QLineEdit object will be deleted.

     setCellWidget(index, new QLineEdit);
     ...
     setCellWidget(index, new QTextEdit);

This function was introduced in Qt 4.1.

See also cellWidget().

### void QTableWidget::setCurrentCell ( int row, int column )

Sets the current cell to be the cell at position (row, column).

Depending on the current selection mode, the cell may also be selected.

This function was introduced in Qt 4.1.

See also setCurrentItem(), currentRow(), and currentColumn().

### void QTableWidget::setCurrentCell ( int row, int column, QItemSelectionModel::SelectionFlags command )

Sets the current cell to be the cell at position (row, column), using the given command.

This function was introduced in Qt 4.4.

See also setCurrentItem(), currentRow(), and currentColumn().

### void QTableWidget::setCurrentItem ( QTableWidgetItem * item )

Sets the current item to item.

Unless the selection mode is NoSelection, the item is also be selected.

See also currentItem() and setCurrentCell().

### void QTableWidget::setCurrentItem ( QTableWidgetItem * item, QItemSelectionModel::SelectionFlags command )

Sets the current item to be item, using the given command.

This function was introduced in Qt 4.4.

See also currentItem() and setCurrentCell().

### void QTableWidget::setHorizontalHeaderItem ( int column, QTableWidgetItem * item )

Sets the horizontal header item for column column to item.

See also horizontalHeaderItem().

### void QTableWidget::setHorizontalHeaderLabels ( const QStringList & labels )

Sets the horizontal header labels using labels.

### void QTableWidget::setItem ( int row, int column, QTableWidgetItem * item )

Sets the item for the given row and column to item.

The table takes ownership of the item.

Note that if sorting is enabled (see sortingEnabled) and column is the current sort column, the row will be moved to the sorted position determined by item.

If you want to set several items of a particular row (say, by calling setItem() in a loop), you may want to turn off sorting before doing so, and turn it back on afterwards; this will allow you to use the same row argument for all items in the same row (i.e. setItem() will not move the row).

See also item() and takeItem().

### void QTableWidget::setItemPrototype ( const QTableWidgetItem * item )

Sets the item prototype for the table to the specified item.

The table widget will use the item prototype clone function when it needs to create a new table item. For example when the user is editing in an empty cell. This is useful when you have a QTableWidgetItem subclass and want to make sure that QTableWidget creates instances of your subclass.

The table takes ownership of the prototype.

See also itemPrototype().

### void QTableWidget::setRangeSelected ( const QTableWidgetSelectionRange & range, bool select )

Selects or deselects the range depending on select.

### void QTableWidget::setVerticalHeaderItem ( int row, QTableWidgetItem * item )

Sets the vertical header item for row row to item.

See also verticalHeaderItem().

### void QTableWidget::setVerticalHeaderLabels ( const QStringList & labels )

Sets the vertical header labels using labels.

### void QTableWidget::sortItems ( int column, Qt::SortOrder order = Qt::AscendingOrder )

Sorts all the rows in the table widget based on column and order.

### Qt::DropActions QTableWidget::supportedDropActions () const`[virtual protected]`

Returns the drop actions supported by this view.

See also Qt::DropActions.

### QTableWidgetItem * QTableWidget::takeHorizontalHeaderItem ( int column )

Removes the horizontal header item at column from the header without deleting it.

This function was introduced in Qt 4.1.

### QTableWidgetItem * QTableWidget::takeItem ( int row, int column )

Removes the item at row and column from the table without deleting it.

### QTableWidgetItem * QTableWidget::takeVerticalHeaderItem ( int row )

Removes the vertical header item at row from the header without deleting it.

This function was introduced in Qt 4.1.

### QTableWidgetItem * QTableWidget::verticalHeaderItem ( int row ) const

Returns the vertical header item for row row.

See also setVerticalHeaderItem().

### int QTableWidget::visualColumn ( int logicalColumn ) const

Returns the visual column of the given logicalColumn.

### QRect QTableWidget::visualItemRect ( const QTableWidgetItem * item ) const

Returns the rectangle on the viewport occupied by the item at item.

### int QTableWidget::visualRow ( int logicalRow ) const

Returns the visual row of the given logicalRow.