QTableWidget¶

Inheritance diagram of QTableWidget

Synopsis¶

Functions¶

def cellWidget (row, column)
def closePersistentEditor (item)
def column (item)
def columnCount ()
def currentColumn ()
def currentItem ()
def currentRow ()
def editItem (item)
def findItems (text, flags)
def horizontalHeaderItem (column)
def indexFromItem (item)
def item (row, column)
def itemAt (p)
def itemAt (x, y)
def itemFromIndex (index)
def itemPrototype ()
def items (data)
def openPersistentEditor (item)
def removeCellWidget (row, column)
def row (item)
def rowCount ()
def selectedItems ()
def selectedRanges ()
def setCellWidget (row, column, widget)
def setColumnCount (columns)
def setCurrentCell (row, column)
def setCurrentCell (row, column, command)
def setCurrentItem (item)
def setCurrentItem (item, command)
def setHorizontalHeaderItem (column, item)
def setHorizontalHeaderLabels (labels)
def setItem (row, column, item)
def setItemPrototype (item)
def setRangeSelected (range, select)
def setRowCount (rows)
def setVerticalHeaderItem (row, item)
def setVerticalHeaderLabels (labels)
def sortItems (column[, order=Qt.AscendingOrder])
def takeHorizontalHeaderItem (column)
def takeItem (row, column)
def takeVerticalHeaderItem (row)
def verticalHeaderItem (row)
def visualColumn (logicalColumn)
def visualItemRect (item)
def visualRow (logicalRow)

Virtual functions¶

def dropMimeData (row, column, data, action)
def mimeData (items)
def mimeTypes ()
def supportedDropActions ()

Slots¶

def clear ()
def clearContents ()
def insertColumn (column)
def insertRow (row)
def removeColumn (column)
def removeRow (row)
def scrollToItem (item[, hint=EnsureVisible])

Signals¶

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

Detailed Description¶

The PySide.QtGui.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 PySide.QtGui.QTableWidget are provided by PySide.QtGui.QTableWidgetItem .

If you want a table that uses your own data model you should use PySide.QtGui.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()
tableWidget.setRowCount(10)
tableWidget.setColumnCount(5)
Items are created ouside the table (with no parent widget) and inserted into the table with PySide.QtGui.QTableWidget.setItem() :
newItem = QTableWidgetItem(tr("%s" % ((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 PySide.QtGui.QTableWidget.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 PySide.QtGui.QTableWidget.setHorizontalHeaderLabels() and PySide.QtGui.QTableWidget.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 PySide.QtGui.QTableWidget.rowCount() , and the number of columns with PySide.QtGui.QTableWidget.columnCount() . The table can be cleared with the PySide.QtGui.QTableWidget.clear() function.

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

See also

PySide.QtGui.QTableWidgetItem PySide.QtGui.QTableView Model/View Programming

class PySide.QtGui.QTableWidget([parent=None])¶

class PySide.QtGui.QTableWidget(rows, columns[, parent=None])

Parameters:	rows – `PySide.QtCore.int` columns – `PySide.QtCore.int` parent – `PySide.QtGui.QWidget`

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 .

PySide.QtGui.QTableWidget.cellActivated(row, column)¶

Parameters:	row – `PySide.QtCore.int` column – `PySide.QtCore.int`

PySide.QtGui.QTableWidget.cellChanged(row, column)¶

Parameters:	row – `PySide.QtCore.int` column – `PySide.QtCore.int`

PySide.QtGui.QTableWidget.cellClicked(row, column)¶

Parameters:	row – `PySide.QtCore.int` column – `PySide.QtCore.int`

PySide.QtGui.QTableWidget.cellDoubleClicked(row, column)¶

Parameters:	row – `PySide.QtCore.int` column – `PySide.QtCore.int`

PySide.QtGui.QTableWidget.cellEntered(row, column)¶

Parameters:	row – `PySide.QtCore.int` column – `PySide.QtCore.int`

PySide.QtGui.QTableWidget.cellPressed(row, column)¶

Parameters:	row – `PySide.QtCore.int` column – `PySide.QtCore.int`

PySide.QtGui.QTableWidget.cellWidget(row, column)¶

Parameters:	row – `PySide.QtCore.int` column – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QWidget`

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

Note

The table takes ownership of the widget.

PySide.QtGui.QTableWidget.clear()¶: Removes all items in the view. This will also remove all selections. The table dimensions stay the same.

PySide.QtGui.QTableWidget.clearContents()¶: Removes all items not in the headers from the view. This will also remove all selections. The table dimensions stay the same.

PySide.QtGui.QTableWidget.closePersistentEditor(item)¶

Parameters:	item – `PySide.QtGui.QTableWidgetItem`

Closes the persistent editor for item .

PySide.QtGui.QTableWidget.column(item)¶

Parameters:	item – `PySide.QtGui.QTableWidgetItem`
Return type:	`PySide.QtCore.int`

Returns the column for the item .

PySide.QtGui.QTableWidget.columnCount()¶

Return type:	`PySide.QtCore.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.

PySide.QtGui.QTableWidget.currentCellChanged(currentRow, currentColumn, previousRow, previousColumn)¶

Parameters:	currentRow – `PySide.QtCore.int` currentColumn – `PySide.QtCore.int` previousRow – `PySide.QtCore.int` previousColumn – `PySide.QtCore.int`

PySide.QtGui.QTableWidget.currentColumn()¶

Return type:	`PySide.QtCore.int`

Returns the column of the current item.

PySide.QtGui.QTableWidget.currentItem()¶

Return type:	`PySide.QtGui.QTableWidgetItem`

Returns the current item.

PySide.QtGui.QTableWidget.currentItemChanged(current, previous)¶

Parameters:	current – `PySide.QtGui.QTableWidgetItem` previous – `PySide.QtGui.QTableWidgetItem`

PySide.QtGui.QTableWidget.currentRow()¶

Return type:	`PySide.QtCore.int`

Returns the row of the current item.

PySide.QtGui.QTableWidget.dropMimeData(row, column, data, action)¶

Parameters:	row – `PySide.QtCore.int` column – `PySide.QtCore.int` data – `PySide.QtCore.QMimeData` action – `PySide.QtCore.Qt.DropAction`
Return type:	`PySide.QtCore.bool`

PySide.QtGui.QTableWidget.editItem(item)¶

Parameters:	item – `PySide.QtGui.QTableWidgetItem`

Starts editing the item if it is editable.

PySide.QtGui.QTableWidget.findItems(text, flags)¶

Parameters:	text – unicode flags – `PySide.QtCore.Qt.MatchFlags`
Return type:

PySide.QtGui.QTableWidget.horizontalHeaderItem(column)¶

Parameters:	column – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QTableWidgetItem`

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

PySide.QtGui.QTableWidget.indexFromItem(item)¶

Parameters:	item – `PySide.QtGui.QTableWidgetItem`
Return type:	`PySide.QtCore.QModelIndex`

Returns the PySide.QtCore.QModelIndex assocated with the given item .

PySide.QtGui.QTableWidget.insertColumn(column)¶

Parameters:	column – `PySide.QtCore.int`

Inserts an empty column into the table at column .

PySide.QtGui.QTableWidget.insertRow(row)¶

Parameters:	row – `PySide.QtCore.int`

Inserts an empty row into the table at row .

PySide.QtGui.QTableWidget.item(row, column)¶

Parameters:	row – `PySide.QtCore.int` column – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QTableWidgetItem`

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

See also

PySide.QtGui.QTableWidget.setItem()

PySide.QtGui.QTableWidget.itemActivated(item)¶

Parameters:	item – `PySide.QtGui.QTableWidgetItem`

PySide.QtGui.QTableWidget.itemAt(x, y)¶

Parameters:	x – `PySide.QtCore.int` y – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QTableWidgetItem`

Returns the item at the position equivalent to PySide.QtCore.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

PySide.QtGui.QTableWidget.item()

PySide.QtGui.QTableWidget.itemAt(p)

Parameters:	p – `PySide.QtCore.QPoint`
Return type:	`PySide.QtGui.QTableWidgetItem`

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

PySide.QtGui.QTableWidget.item()

PySide.QtGui.QTableWidget.itemChanged(item)¶

Parameters:	item – `PySide.QtGui.QTableWidgetItem`

PySide.QtGui.QTableWidget.itemClicked(item)¶

Parameters:	item – `PySide.QtGui.QTableWidgetItem`

PySide.QtGui.QTableWidget.itemDoubleClicked(item)¶

Parameters:	item – `PySide.QtGui.QTableWidgetItem`

PySide.QtGui.QTableWidget.itemEntered(item)¶

Parameters:	item – `PySide.QtGui.QTableWidgetItem`

PySide.QtGui.QTableWidget.itemFromIndex(index)¶

Parameters:	index – `PySide.QtCore.QModelIndex`
Return type:	`PySide.QtGui.QTableWidgetItem`

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

PySide.QtGui.QTableWidget.itemPressed(item)¶

Parameters:	item – `PySide.QtGui.QTableWidgetItem`

PySide.QtGui.QTableWidget.itemPrototype()¶

Return type:	`PySide.QtGui.QTableWidgetItem`

Returns the item prototype used by the table.

PySide.QtGui.QTableWidget.itemSelectionChanged()¶

PySide.QtGui.QTableWidget.items(data)¶

Parameters:	data – `PySide.QtCore.QMimeData`
Return type:

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

PySide.QtGui.QTableWidget.mimeData(items)¶

Parameters:	items –
Return type:	`PySide.QtCore.QMimeData`

PySide.QtGui.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

PySide.QtGui.QTableWidget.mimeData()

PySide.QtGui.QTableWidget.openPersistentEditor(item)¶

Parameters:	item – `PySide.QtGui.QTableWidgetItem`

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

PySide.QtGui.QTableWidget.removeCellWidget(row, column)¶

Parameters:	row – `PySide.QtCore.int` column – `PySide.QtCore.int`

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

PySide.QtGui.QTableWidget.removeColumn(column)¶

Parameters:	column – `PySide.QtCore.int`

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

PySide.QtGui.QTableWidget.removeRow(row)¶

Parameters:	row – `PySide.QtCore.int`

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

PySide.QtGui.QTableWidget.row(item)¶

Parameters:	item – `PySide.QtGui.QTableWidgetItem`
Return type:	`PySide.QtCore.int`

Returns the row for the item .

PySide.QtGui.QTableWidget.rowCount()¶

Return type:	`PySide.QtCore.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.

PySide.QtGui.QTableWidget.scrollToItem(item[, hint=EnsureVisible])¶

Parameters:	item – `PySide.QtGui.QTableWidgetItem` hint – `PySide.QtGui.QAbstractItemView.ScrollHint`

PySide.QtGui.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 PySide.QtGui.QTableView.selectedIndexes() function to retrieve the complete selection including empty cells.

See also

PySide.QtGui.QTableView.selectedIndexes()

PySide.QtGui.QTableWidget.selectedRanges()¶

Return type:

Returns a list of all selected ranges.

PySide.QtGui.QTableWidget.setCellWidget(row, column, widget)¶

Parameters:	row – `PySide.QtCore.int` column – `PySide.QtCore.int` widget – `PySide.QtGui.QWidget`

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 PySide.QtGui.QLineEdit object will be deleted.

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

PySide.QtGui.QTableWidget.setColumnCount(columns)¶

Parameters:	columns – `PySide.QtCore.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.

PySide.QtGui.QTableWidget.setCurrentCell(row, column, command)¶

Parameters:	row – `PySide.QtCore.int` column – `PySide.QtCore.int` command – `PySide.QtGui.QItemSelectionModel.SelectionFlags`

PySide.QtGui.QTableWidget.setCurrentCell(row, column)

Parameters:	row – `PySide.QtCore.int` column – `PySide.QtCore.int`

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

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

PySide.QtGui.QTableWidget.setCurrentItem(item)¶

Parameters:	item – `PySide.QtGui.QTableWidgetItem`

Sets the current item to item .

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

PySide.QtGui.QTableWidget.setCurrentItem(item, command)

Parameters:	item – `PySide.QtGui.QTableWidgetItem` command – `PySide.QtGui.QItemSelectionModel.SelectionFlags`

PySide.QtGui.QTableWidget.setHorizontalHeaderItem(column, item)¶

Parameters:	column – `PySide.QtCore.int` item – `PySide.QtGui.QTableWidgetItem`

Sets the horizontal header item for column column to item .

PySide.QtGui.QTableWidget.setHorizontalHeaderLabels(labels)¶

Parameters:	labels – list of strings

Sets the horizontal header labels using labels .

PySide.QtGui.QTableWidget.setItem(row, column, item)¶

Parameters:	row – `PySide.QtCore.int` column – `PySide.QtCore.int` item – `PySide.QtGui.QTableWidgetItem`

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 PySide.QtGui.QTableView.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 PySide.QtGui.QTableWidget.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. PySide.QtGui.QTableWidget.setItem() will not move the row).

PySide.QtGui.QTableWidget.setItemPrototype(item)¶

Parameters:	item – `PySide.QtGui.QTableWidgetItem`

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 PySide.QtGui.QTableWidgetItem subclass and want to make sure that PySide.QtGui.QTableWidget creates instances of your subclass.

The table takes ownership of the prototype.

PySide.QtGui.QTableWidget.setRangeSelected(range, select)¶

Parameters:	range – `PySide.QtGui.QTableWidgetSelectionRange` select – `PySide.QtCore.bool`

Selects or deselects the range depending on select .

PySide.QtGui.QTableWidget.setRowCount(rows)¶

Parameters:	rows – `PySide.QtCore.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.

PySide.QtGui.QTableWidget.setVerticalHeaderItem(row, item)¶

Parameters:	row – `PySide.QtCore.int` item – `PySide.QtGui.QTableWidgetItem`

Sets the vertical header item for row row to item .

PySide.QtGui.QTableWidget.setVerticalHeaderLabels(labels)¶

Parameters:	labels – list of strings

Sets the vertical header labels using labels .

PySide.QtGui.QTableWidget.sortItems(column[, order=Qt.AscendingOrder])¶

Parameters:	column – `PySide.QtCore.int` order – `PySide.QtCore.Qt.SortOrder`

PySide.QtGui.QTableWidget.supportedDropActions()¶

Return type:	`PySide.QtCore.Qt.DropActions`

Returns the drop actions supported by this view.

See also

Qt.DropActions

PySide.QtGui.QTableWidget.takeHorizontalHeaderItem(column)¶

Parameters:	column – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QTableWidgetItem`

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

PySide.QtGui.QTableWidget.takeItem(row, column)¶

Parameters:	row – `PySide.QtCore.int` column – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QTableWidgetItem`

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

PySide.QtGui.QTableWidget.takeVerticalHeaderItem(row)¶

Parameters:	row – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QTableWidgetItem`

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

PySide.QtGui.QTableWidget.verticalHeaderItem(row)¶

Parameters:	row – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QTableWidgetItem`

Returns the vertical header item for row row .

PySide.QtGui.QTableWidget.visualColumn(logicalColumn)¶

Parameters:	logicalColumn – `PySide.QtCore.int`
Return type:	`PySide.QtCore.int`

Returns the visual column of the given logicalColumn .

PySide.QtGui.QTableWidget.visualItemRect(item)¶

Parameters:	item – `PySide.QtGui.QTableWidgetItem`
Return type:	`PySide.QtCore.QRect`

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

PySide.QtGui.QTableWidget.visualRow(logicalRow)¶

Parameters:	logicalRow – `PySide.QtCore.int`
Return type:	`PySide.QtCore.int`

Returns the visual row of the given logicalRow .

Table Of Contents

Previous topic

Next topic

QTableWidget¶

Synopsis¶

Functions¶

Virtual functions¶

Slots¶

Signals¶

Detailed Description¶


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

Table Of Contents

Previous topic

Next topic

Quick search

QTableWidget¶

Synopsis¶

Functions¶

Virtual functions¶

Slots¶

Signals¶

Detailed Description¶