QTableWidget

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

Inheritance diagram of PySide2.QtWidgets.QTableWidget

Synopsis

Functions

Virtual functions

Slots

Signals

Detailed Description

../../_images/windows-tableview.png

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 outside 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.

class QTableWidget([parent=None])

QTableWidget(rows, columns[, parent=None])

param parent

QWidget

param columns

int

param rows

int

Creates a new table view with the given parent .

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

PySide2.QtWidgets.QTableWidget.cellActivated(row, column)
Parameters
  • rowint

  • columnint

PySide2.QtWidgets.QTableWidget.cellChanged(row, column)
Parameters
  • rowint

  • columnint

PySide2.QtWidgets.QTableWidget.cellClicked(row, column)
Parameters
  • rowint

  • columnint

PySide2.QtWidgets.QTableWidget.cellDoubleClicked(row, column)
Parameters
  • rowint

  • columnint

PySide2.QtWidgets.QTableWidget.cellEntered(row, column)
Parameters
  • rowint

  • columnint

PySide2.QtWidgets.QTableWidget.cellPressed(row, column)
Parameters
  • rowint

  • columnint

PySide2.QtWidgets.QTableWidget.cellWidget(row, column)
Parameters
  • rowint

  • columnint

Return type

QWidget

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

Note

The table takes ownership of the widget.

See also

setCellWidget()

PySide2.QtWidgets.QTableWidget.clear()

Removes all items in the view. This will also remove all selections and headers. If you don’t want to remove the headers, use clearContents() . The table dimensions stay the same.

PySide2.QtWidgets.QTableWidget.clearContents()

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

PySide2.QtWidgets.QTableWidget.closePersistentEditor(item)
Parameters

itemQTableWidgetItem

Closes the persistent editor for item .

PySide2.QtWidgets.QTableWidget.column(item)
Parameters

itemQTableWidgetItem

Return type

int

Returns the column for the item .

PySide2.QtWidgets.QTableWidget.columnCount()
Return type

int

Returns the number of columns.

See also

setColumnCount()

PySide2.QtWidgets.QTableWidget.currentCellChanged(currentRow, currentColumn, previousRow, previousColumn)
Parameters
  • currentRowint

  • currentColumnint

  • previousRowint

  • previousColumnint

PySide2.QtWidgets.QTableWidget.currentColumn()
Return type

int

Returns the column of the current item.

PySide2.QtWidgets.QTableWidget.currentItem()
Return type

QTableWidgetItem

Returns the current item.

See also

setCurrentItem()

PySide2.QtWidgets.QTableWidget.currentItemChanged(current, previous)
Parameters
PySide2.QtWidgets.QTableWidget.currentRow()
Return type

int

Returns the row of the current item.

PySide2.QtWidgets.QTableWidget.dropMimeData(row, column, data, action)
Parameters
  • rowint

  • columnint

  • dataQMimeData

  • actionDropAction

Return type

bool

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 .

PySide2.QtWidgets.QTableWidget.editItem(item)
Parameters

itemQTableWidgetItem

Starts editing the item if it is editable.

PySide2.QtWidgets.QTableWidget.findItems(text, flags)
Parameters
  • text – unicode

  • flagsMatchFlags

Return type

Finds items that matches the text using the given flags .

PySide2.QtWidgets.QTableWidget.horizontalHeaderItem(column)
Parameters

columnint

Return type

QTableWidgetItem

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

PySide2.QtWidgets.QTableWidget.indexFromItem(item)
Parameters

itemQTableWidgetItem

Return type

QModelIndex

This is an overloaded function.

PySide2.QtWidgets.QTableWidget.indexFromItem(item)
Parameters

itemQTableWidgetItem

Return type

QModelIndex

Returns the QModelIndex associated with the given item .

Note

In Qt versions prior to 5.10, this function took a non-const item .

PySide2.QtWidgets.QTableWidget.insertColumn(column)
Parameters

columnint

Inserts an empty column into the table at column .

PySide2.QtWidgets.QTableWidget.insertRow(row)
Parameters

rowint

Inserts an empty row into the table at row .

PySide2.QtWidgets.QTableWidget.isItemSelected(item)
Parameters

itemQTableWidgetItem

Return type

bool

Note

This function is deprecated.

Returns true if the item is selected, otherwise returns false .

This function is deprecated. Use isSelected() instead.

PySide2.QtWidgets.QTableWidget.isPersistentEditorOpen(item)
Parameters

itemQTableWidgetItem

Return type

bool

Returns whether a persistent editor is open for item item .

PySide2.QtWidgets.QTableWidget.item(row, column)
Parameters
  • rowint

  • columnint

Return type

QTableWidgetItem

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

See also

setItem()

PySide2.QtWidgets.QTableWidget.itemActivated(item)
Parameters

itemQTableWidgetItem

PySide2.QtWidgets.QTableWidget.itemAt(x, y)
Parameters
  • xint

  • yint

Return type

QTableWidgetItem

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

See also

item()

PySide2.QtWidgets.QTableWidget.itemAt(p)
Parameters

pQPoint

Return type

QTableWidgetItem

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

See also

item()

PySide2.QtWidgets.QTableWidget.itemChanged(item)
Parameters

itemQTableWidgetItem

PySide2.QtWidgets.QTableWidget.itemClicked(item)
Parameters

itemQTableWidgetItem

PySide2.QtWidgets.QTableWidget.itemDoubleClicked(item)
Parameters

itemQTableWidgetItem

PySide2.QtWidgets.QTableWidget.itemEntered(item)
Parameters

itemQTableWidgetItem

PySide2.QtWidgets.QTableWidget.itemFromIndex(index)
Parameters

indexQModelIndex

Return type

QTableWidgetItem

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

PySide2.QtWidgets.QTableWidget.itemPressed(item)
Parameters

itemQTableWidgetItem

PySide2.QtWidgets.QTableWidget.itemPrototype()
Return type

QTableWidgetItem

Returns the item prototype used by the table.

PySide2.QtWidgets.QTableWidget.itemSelectionChanged()
PySide2.QtWidgets.QTableWidget.items(data)
Parameters

dataQMimeData

Return type

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.

PySide2.QtWidgets.QTableWidget.mimeData(items)
Parameters

items

Return type

QMimeData

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.

PySide2.QtWidgets.QTableWidget.mimeTypes()
Return type

list of strings

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

See also

mimeData()

PySide2.QtWidgets.QTableWidget.openPersistentEditor(item)
Parameters

itemQTableWidgetItem

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

PySide2.QtWidgets.QTableWidget.removeCellWidget(row, column)
Parameters
  • rowint

  • columnint

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

PySide2.QtWidgets.QTableWidget.removeColumn(column)
Parameters

columnint

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

PySide2.QtWidgets.QTableWidget.removeRow(row)
Parameters

rowint

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

PySide2.QtWidgets.QTableWidget.row(item)
Parameters

itemQTableWidgetItem

Return type

int

Returns the row for the item .

PySide2.QtWidgets.QTableWidget.rowCount()
Return type

int

Returns the number of rows.

See also

setRowCount()

PySide2.QtWidgets.QTableWidget.scrollToItem(item[, hint=EnsureVisible])
Parameters

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.

PySide2.QtWidgets.QTableWidget.selectedItems()
Return type

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()

PySide2.QtWidgets.QTableWidget.selectedRanges()
Return type

Returns a list of all selected ranges.

PySide2.QtWidgets.QTableWidget.setCellWidget(row, column, widget)
Parameters
  • rowint

  • columnint

  • widgetQWidget

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, QLineEdit())
...
setCellWidget(index, QTextEdit())

See also

cellWidget()

PySide2.QtWidgets.QTableWidget.setColumnCount(columns)
Parameters

columnsint

Sets the number of columns in this table’s model to columns . If this is less than columnCount() , the data in the unwanted columns is discarded.

PySide2.QtWidgets.QTableWidget.setCurrentCell(row, column)
Parameters
  • rowint

  • columnint

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

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

PySide2.QtWidgets.QTableWidget.setCurrentCell(row, column, command)
Parameters
  • rowint

  • columnint

  • commandSelectionFlags

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

PySide2.QtWidgets.QTableWidget.setCurrentItem(item)
Parameters

itemQTableWidgetItem

Sets the current item to item .

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

PySide2.QtWidgets.QTableWidget.setCurrentItem(item, command)
Parameters

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

PySide2.QtWidgets.QTableWidget.setHorizontalHeaderItem(column, item)
Parameters

Sets the horizontal header item for column column to item . If necessary, the column count is increased to fit the item. The previous header item (if there was one) is deleted.

PySide2.QtWidgets.QTableWidget.setHorizontalHeaderLabels(labels)
Parameters

labels – list of strings

Sets the horizontal header labels using labels .

PySide2.QtWidgets.QTableWidget.setItem(row, column, item)
Parameters

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 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. will not move the row).

See also

item() takeItem()

PySide2.QtWidgets.QTableWidget.setItemPrototype(item)
Parameters

itemQTableWidgetItem

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()

PySide2.QtWidgets.QTableWidget.setItemSelected(item, select)
Parameters

Note

This function is deprecated.

Selects or deselects item depending on select .

This function is deprecated. Use setSelected() instead.

See also

isItemSelected()

PySide2.QtWidgets.QTableWidget.setRangeSelected(range, select)
Parameters

Selects or deselects the range depending on select .

PySide2.QtWidgets.QTableWidget.setRowCount(rows)
Parameters

rowsint

Sets the number of rows in this table’s model to rows . If this is less than rowCount() , the data in the unwanted rows is discarded.

PySide2.QtWidgets.QTableWidget.setVerticalHeaderItem(row, item)
Parameters

Sets the vertical header item for row row to item .

PySide2.QtWidgets.QTableWidget.setVerticalHeaderLabels(labels)
Parameters

labels – list of strings

Sets the vertical header labels using labels .

PySide2.QtWidgets.QTableWidget.sortItems(column[, order=Qt.AscendingOrder])
Parameters
  • columnint

  • orderSortOrder

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

PySide2.QtWidgets.QTableWidget.supportedDropActions()
Return type

DropActions

Returns the drop actions supported by this view.

See also

DropActions

PySide2.QtWidgets.QTableWidget.takeHorizontalHeaderItem(column)
Parameters

columnint

Return type

QTableWidgetItem

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

PySide2.QtWidgets.QTableWidget.takeItem(row, column)
Parameters
  • rowint

  • columnint

Return type

QTableWidgetItem

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

PySide2.QtWidgets.QTableWidget.takeVerticalHeaderItem(row)
Parameters

rowint

Return type

QTableWidgetItem

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

PySide2.QtWidgets.QTableWidget.verticalHeaderItem(row)
Parameters

rowint

Return type

QTableWidgetItem

Returns the vertical header item for row row .

PySide2.QtWidgets.QTableWidget.visualColumn(logicalColumn)
Parameters

logicalColumnint

Return type

int

Returns the visual column of the given logicalColumn .

PySide2.QtWidgets.QTableWidget.visualItemRect(item)
Parameters

itemQTableWidgetItem

Return type

QRect

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

PySide2.QtWidgets.QTableWidget.visualRow(logicalRow)
Parameters

logicalRowint

Return type

int

Returns the visual row of the given logicalRow .