class QTableWidget#

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

Synopsis#

Properties#

columnCountᅟ - The number of columns in the table
rowCountᅟ - The number of rows in the table

Methods#

def __init__()
def cellWidget()
def closePersistentEditor()
def column()
def columnCount()
def currentColumn()
def currentItem()
def currentRow()
def editItem()
def findItems()
def horizontalHeaderItem()
def indexFromItem()
def isPersistentEditorOpen()
def item()
def itemAt()
def itemFromIndex()
def itemPrototype()
def items()
def openPersistentEditor()
def removeCellWidget()
def row()
def rowCount()
def selectedItems()
def selectedRanges()
def setCellWidget()
def setColumnCount()
def setCurrentCell()
def setCurrentItem()
def setHorizontalHeaderItem()
def setHorizontalHeaderLabels()
def setItem()
def setItemPrototype()
def setRangeSelected()
def setRowCount()
def setVerticalHeaderItem()
def setVerticalHeaderLabels()
def sortItems()
def takeHorizontalHeaderItem()
def takeItem()
def takeVerticalHeaderItem()
def verticalHeaderItem()
def visualColumn()
def visualItemRect()
def visualRow()

Slots#

def clear()
def clearContents()
def insertColumn()
def insertRow()
def removeColumn()
def removeRow()
def scrollToItem()

Signals#

def cellActivated()
def cellChanged()
def cellClicked()
def cellDoubleClicked()
def cellEntered()
def cellPressed()
def currentCellChanged()
def currentItemChanged()
def itemActivated()
def itemChanged()
def itemClicked()
def itemDoubleClicked()
def itemEntered()
def itemPressed()
def itemSelectionChanged()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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 = QTableWidget(12, 3, self)

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

tableWidget = QTableWidget(self)
tableWidget.setRowCount(10)
tableWidget.setColumnCount(5)

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

newItem = 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:

cubesHeaderItem = 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.

See also

QTableWidgetItem QTableView Model/View Programming

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property 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:

columnCount()
setColumnCount()

property 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:

rowCount()
setRowCount()

__init__(rows, columns[, parent=None])#

Parameters:

rows – int
columns – int
parent – QWidget

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

__init__([parent=None])

Parameters:: parent – QWidget

Creates a new table view with the given parent.

cellActivated(row, column)#

Parameters:

row – int
column – int

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

cellChanged(row, column)#

Parameters:

row – int
column – int

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

cellClicked(row, column)#

Parameters:

row – int
column – int

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

cellDoubleClicked(row, column)#

Parameters:

row – int
column – int

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.

cellEntered(row, column)#

Parameters:

row – int
column – int

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.

cellPressed(row, column)#

Parameters:

row – int
column – int

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

cellWidget(row, column)#

Parameters:

row – int
column – int

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

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.

clearContents()#

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

closePersistentEditor(item)#

Parameters:: item – QTableWidgetItem

Closes the persistent editor for item.

See also

openPersistentEditor() isPersistentEditorOpen()

column(item)#

Parameters:: item – QTableWidgetItem
Return type:: int

Returns the column for the item.

columnCount()#

Return type:: int

Returns the number of columns.

See also

setColumnCount()

Getter of property columnCountᅟ .

currentCellChanged(currentRow, currentColumn, previousRow, previousColumn)#

Parameters:

currentRow – int
currentColumn – int
previousRow – int
previousColumn – int

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.

currentColumn()#

Return type:: int

Returns the column of the current item.

See also

currentRow() setCurrentCell()

currentItem()#

Return type:: QTableWidgetItem

Returns the current item.

See also

setCurrentItem()

currentItemChanged(current, previous)#

Parameters:

current – QTableWidgetItem
previous – QTableWidgetItem

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.

currentRow()#

Return type:: int

Returns the row of the current item.

See also

currentColumn() setCurrentCell()

dropMimeData(row, column, data, action)#

Parameters:

row – int
column – int
data – QMimeData
action – DropAction

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.

See also

supportedDropActions()

editItem(item)#

Parameters:: item – QTableWidgetItem

Starts editing the item if it is editable.

findItems(text, flags)#

Parameters:

text – str
flags – Combination of MatchFlag

Return type:

.list of QTableWidgetItem

Finds items that matches the text using the given flags.

horizontalHeaderItem(column)#

Parameters:: column – int
Return type:: QTableWidgetItem

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

See also

setHorizontalHeaderItem()

indexFromItem(item)#

Parameters:: item – QTableWidgetItem
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.

insertColumn(column)#

Parameters:: column – int

Inserts an empty column into the table at column.

insertRow(row)#

Parameters:: row – int

Inserts an empty row into the table at row.

isPersistentEditorOpen(item)#

Parameters:: item – QTableWidgetItem
Return type:: bool

Returns whether a persistent editor is open for item item.

See also

openPersistentEditor() closePersistentEditor()

item(row, column)#

Parameters:

row – int
column – int

Return type:

QTableWidgetItem

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

See also

setItem()

itemActivated(item)#

Parameters:: item – QTableWidgetItem

This signal is emitted when the specified item has been activated

itemAt(p)#

Parameters:: p – QPoint
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()

itemAt(x, y)

Parameters:

x – int
y – int

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

itemChanged(item)#

Parameters:: item – QTableWidgetItem

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

itemClicked(item)#

Parameters:: item – QTableWidgetItem

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

itemDoubleClicked(item)#

Parameters:: item – QTableWidgetItem

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

itemEntered(item)#

Parameters:: item – QTableWidgetItem

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.

itemFromIndex(index)#

Parameters:: index – QModelIndex
Return type:: QTableWidgetItem

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

itemPressed(item)#

Parameters:: item – QTableWidgetItem

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

itemPrototype()#

Return type:: QTableWidgetItem

Returns the item prototype used by the table.

See also

setItemPrototype()

itemSelectionChanged()#

This signal is emitted whenever the selection changes.

See also

selectedItems() isSelected()

items(data)#

Parameters:: data – QMimeData
Return type:: .list of QTableWidgetItem

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.

mimeData(items)#

Parameters:: items – .list of QTableWidgetItem
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, None is returned rather than a serialized empty list.

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

openPersistentEditor(item)#

Parameters:: item – QTableWidgetItem

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

See also

closePersistentEditor() isPersistentEditorOpen()

removeCellWidget(row, column)#

Parameters:

row – int
column – int

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

removeColumn(column)#

Parameters:: column – int

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

removeRow(row)#

Parameters:: row – int

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

row(item)#

Parameters:: item – QTableWidgetItem
Return type:: int

Returns the row for the item.

rowCount()#

Return type:: int

Returns the number of rows.

See also

setRowCount()

Getter of property rowCountᅟ .

scrollToItem(item[, hint=QAbstractItemView.ScrollHint.EnsureVisible])#

Parameters:

item – QTableWidgetItem
hint – ScrollHint

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.

selectedItems()#

Return type:: .list of QTableWidgetItem

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

selectedRanges()#

Return type:: .list of QTableWidgetSelectionRange

Returns a list of all selected ranges.

See also

QTableWidgetSelectionRange

setCellWidget(row, column, widget)#

Parameters:

row – int
column – int
widget – QWidget

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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