{"id":5272,"date":"2022-10-17T02:38:37","date_gmt":"2022-10-17T02:38:37","guid":{"rendered":"https:\/\/www.pythontutorial.net\/?page_id=5272"},"modified":"2022-10-17T02:40:00","modified_gmt":"2022-10-17T02:40:00","slug":"pyqt-qtablewidget","status":"publish","type":"page","link":"https:\/\/www.pythontutorial.net\/pyqt\/pyqt-qtablewidget\/","title":{"rendered":"PyQt QTableWidget"},"content":{"rendered":"\n

Summary<\/strong>: in this tutorial, you’ll learn how to use the QTableWidget<\/code> class to create a table widget.<\/p>\n\n\n\n

Introduction to PyQt QTableWidget class #<\/a><\/h2>\n\n\n\n

The QTableWidget<\/code><\/code> class allows you to create a table widget that displays the tabular form of items. The items in the QTableWidget<\/code><\/code> are created using the QTableWidget<\/code><\/code>Item class.<\/p>\n\n\n\n

The following creates a table widget using the QTableWidget<\/code> class:<\/p>\n\n\n

table = QTableWidget(parent)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Once having a QTableWidget<\/code> object, you can set the number of columns for the table using the setColumnCount()<\/code> method:<\/p>\n\n\n
table.setColumnCount(columns)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
To set the horizontal labels for the table columns, you use the setHorizontalHeaderLabels()<\/code> method:<\/p>\n\n\n
table.setHorizontalHeaderLabels(labels)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Each column has an index starting from zero. For each column, you can configure its width using the setColumnWidth()<\/code> method:<\/p>\n\n\n
table.setColumnWidth(column, width)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
To set the number of rows for the table, you use the setRowCount()<\/code> method:<\/p>\n\n\n
table.setRowCount(rows)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
If you know the number of rows and columns that the table may have at the time of creation, you can use the following:<\/p>\n\n\n
table = QTableWidget(rows, columns, parent<\/span>)<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
To add an item to the table, you use the setItem()<\/code> method:<\/p>\n\n\n
table.setItem(row, column, item)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
PyQt QTableWidget example #<\/a><\/h2>\n\n\n\n
We’ll develop an application that uses a QTableWidget<\/code> to manage employee data:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
If you enter the first name, last name, and age and click add, the program will add the new employee to the table.  Also, if you select a row and click the delete icon, the table will delete the row.<\/p>\n\n\n\n
Here’s the complete program:<\/p>\n\n\n
import<\/span> sys\nfrom<\/span> PyQt6.QtWidgets import<\/span> (\n    QApplication, QMainWindow, QTableWidget, \n    QTableWidgetItem, QDockWidget, QFormLayout, \n    QLineEdit, QWidget, QPushButton, QSpinBox, \n    QMessageBox, QToolBar, QMessageBox\n)\nfrom<\/span> PyQt6.QtCore import<\/span> Qt,QSize\nfrom<\/span> PyQt6.QtGui import<\/span> QIcon, QAction\n\n\nclass<\/span> MainWindow<\/span>(QMainWindow)<\/span>:<\/span>\n    def<\/span> __init__<\/span>(self, *args, **kwargs)<\/span>:<\/span>\n        super().__init__(*args, **kwargs)\n        self.setWindowTitle('Employees'<\/span>)\n        self.setWindowIcon(QIcon('.\/assets\/usergroup.png'<\/span>))\n        self.setGeometry(100<\/span>, 100<\/span>, 600<\/span>, 400<\/span>)\n\n        employees = [\n            {'First Name'<\/span>: 'John'<\/span>, 'Last Name'<\/span>: 'Doe'<\/span>, 'Age'<\/span>: 25<\/span>},\n            {'First Name'<\/span>: 'Jane'<\/span>, 'Last Name'<\/span>: 'Doe'<\/span>, 'Age'<\/span>: 22<\/span>},\n            {'First Name'<\/span>: 'Alice'<\/span>, 'Last Name'<\/span>: 'Doe'<\/span>, 'Age'<\/span>: 22<\/span>},\n        ]\n\n        self.table = QTableWidget(self)\n        self.setCentralWidget(self.table)\n\n        self.table.setColumnCount(3<\/span>)\n        self.table.setColumnWidth(0<\/span>, 150<\/span>)\n        self.table.setColumnWidth(1<\/span>, 150<\/span>)\n        self.table.setColumnWidth(2<\/span>, 50<\/span>)\n\n        self.table.setHorizontalHeaderLabels(employees[0<\/span>].keys())\n        self.table.setRowCount(len(employees))\n\n        row = 0<\/span>\n        for<\/span> e in<\/span> employees:\n            self.table.setItem(row, 0<\/span>, QTableWidgetItem(e['First Name'<\/span>]))\n            self.table.setItem(row, 1<\/span>, QTableWidgetItem(e['Last Name'<\/span>]))\n            self.table.setItem(row, 2<\/span>, QTableWidgetItem(str(e['Age'<\/span>])))\n            row += 1<\/span>\n\n        dock = QDockWidget('New Employee'<\/span>)\n        dock.setFeatures(QDockWidget.DockWidgetFeature.NoDockWidgetFeatures)\n        self.addDockWidget(Qt.DockWidgetArea.RightDockWidgetArea, dock)\n\n        # create form<\/span>\n        form = QWidget()\n        layout = QFormLayout(form)\n        form.setLayout(layout)\n\n\n        self.first_name = QLineEdit(form)\n        self.last_name = QLineEdit(form)\n        self.age = QSpinBox(form, minimum=18<\/span>, maximum=67<\/span>)\n        self.age.clear()\n\n        layout.addRow('First Name:'<\/span>, self.first_name)\n        layout.addRow('Last Name:'<\/span>, self.last_name)\n        layout.addRow('Age:'<\/span>, self.age)\n\n        btn_add = QPushButton('Add'<\/span>)\n        btn_add.clicked.connect(self.add_employee)\n        layout.addRow(btn_add)\n\n        # add delete & edit button<\/span>\n        toolbar = QToolBar('main toolbar'<\/span>)\n        toolbar.setIconSize(QSize(16<\/span>,16<\/span>))\n        self.addToolBar(toolbar)\n\n\n        delete_action = QAction(QIcon('.\/assets\/remove.png'<\/span>), '&Delete'<\/span>, self)\n        delete_action.triggered.connect(self.delete)\n        toolbar.addAction(delete_action)\n        dock.setWidget(form)\n\n\n    def<\/span> delete<\/span>(self)<\/span>:<\/span>\n        current_row = self.table.currentRow()\n        if<\/span> current_row < 0<\/span>:\n            return<\/span> QMessageBox.warning(self, 'Warning'<\/span>,'Please select a record to delete'<\/span>)\n\n        button = QMessageBox.question(\n            self,\n            'Confirmation'<\/span>,\n            'Are you sure that you want to delete the selected row?'<\/span>,\n            QMessageBox.StandardButton.Yes |\n            QMessageBox.StandardButton.No\n        )\n        if<\/span> button == QMessageBox.StandardButton.Yes:\n            self.table.removeRow(current_row)\n\n    def<\/span> valid<\/span>(self)<\/span>:<\/span>\n        first_name = self.first_name.text().strip()\n        last_name = self.last_name.text().strip()\n\n        \n        if<\/span> not<\/span> first_name:\n            QMessageBox.critical(self, 'Error'<\/span>, 'Please enter the first name'<\/span>)\n            self.first_name.setFocus()\n            return<\/span> False<\/span>\n\n        if<\/span> not<\/span> last_name:\n            QMessageBox.critical(self, 'Error'<\/span>, 'Please enter the last name'<\/span>)\n            self.last_name.setFocus()\n            return<\/span> False<\/span>\n\n        try<\/span>:\n            age = int(self.age.text().strip())\n        except<\/span> ValueError:\n            QMessageBox.critical(self, 'Error'<\/span>, 'Please enter a valid age'<\/span>)\n            self.age.setFocus()\n            return<\/span> False<\/span>\n\n        if<\/span> age <= 0<\/span> or<\/span> age >= 67<\/span>:\n            QMessageBox.critical(\n                self, 'Error'<\/span>, 'The valid age is between 1 and 67'<\/span>)\n            return<\/span> False<\/span>\n\n        return<\/span> True<\/span>\n\n    def<\/span> reset<\/span>(self)<\/span>:<\/span>\n        self.first_name.clear()\n        self.last_name.clear()\n        self.age.clear()\n\n    def<\/span> add_employee<\/span>(self)<\/span>:<\/span>\n        if<\/span> not<\/span> self.valid():\n            return<\/span>\n\n        row = self.table.rowCount()\n        self.table.insertRow(row)\n        self.table.setItem(row, 0<\/span>, QTableWidgetItem(\n            self.first_name.text().strip())\n        )\n        self.table.setItem(\n            row, 1<\/span>, QTableWidgetItem(self.last_name.text())\n        )\n        self.table.setItem(\n            row, 2<\/span>, QTableWidgetItem(self.age.text())\n        )\n\n        self.reset()\n\n\nif<\/span> __name__ == '__main__'<\/span>:\n    app = QApplication(sys.argv)\n    window = MainWindow()\n    window.show()\n    sys.exit(app.exec())<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
How it works.<\/p>\n\n\n\n
First, initialize an employee list as a list of dictionaries:<\/p>\n\n\n
employees = [\n    {'First Name'<\/span>: 'John'<\/span>, 'Last Name'<\/span>: 'Doe'<\/span>, 'Age'<\/span>: 25<\/span>},\n    {'First Name'<\/span>: 'Jane'<\/span>, 'Last Name'<\/span>: 'Doe'<\/span>, 'Age'<\/span>: 22<\/span>},\n    {'First Name'<\/span>: 'Alice'<\/span>, 'Last Name'<\/span>: 'Doe'<\/span>, 'Age'<\/span>: 22<\/span>},\n]<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Second, create a new QTableWidget<\/code> and set it as the central widget of the main window:<\/p>\n\n\n
self.table = QTableWidget(self)\nself.setCentralWidget(self.table)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Third, set the number of columns for the table and configure the columns’ width:<\/p>\n\n\n
self.table.setColumnCount(3<\/span>)\nself.table.setColumnWidth(0<\/span>, 150<\/span>)\nself.table.setColumnWidth(1<\/span>, 150<\/span>)\nself.table.setColumnWidth(2<\/span>, 50<\/span>)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Fourth, set the horizontal headers for the table:<\/p>\n\n\n
self.table.setHorizontalHeaderLabels(employees[0<\/span>].keys())<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Fifth, set the row count as the number of items in the employees<\/code> list:<\/p>\n\n\n
self.table.setRowCount(len(employees))<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Sixth, add each employee from the employees to the table:<\/p>\n\n\n
row = 0<\/span>\nfor<\/span> e in<\/span> employees:\n    self.table.setItem(row, 0<\/span>, QTableWidgetItem(e['First Name'<\/span>]))\n    self.table.setItem(row, 1<\/span>, QTableWidgetItem(e['Last Name'<\/span>]))\n    self.table.setItem(row, 2<\/span>, QTableWidgetItem(str(e['Age'<\/span>])))\n    row += 1<\/span>   <\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Seventh, define the delete()<\/code> method that executes when the user selects a row and clicks the delete button on the toolbar<\/a>:<\/p>\n\n\n
def<\/span> delete<\/span>(self)<\/span>:<\/span>\n    current_row = self.table.currentRow()\n    if<\/span> current_row < 0<\/span>:\n        return<\/span> QMessageBox.warning(self, 'Warning'<\/span>,'Please select a record to delete'<\/span>)\n\n    button = QMessageBox.question(\n        self,\n        'Confirmation'<\/span>,\n        'Are you sure that you want to delete the selected row?'<\/span>,\n        QMessageBox.StandardButton.Yes |\n        QMessageBox.StandardButton.No\n    )\n    if<\/span> button == QMessageBox.StandardButton.Yes:\n        self.table.removeRow(current_row)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
The currenRow()<\/code> method returns the currently selected row. It returns -1 if no row is selected. In this case, we use the QMessageBox<\/code> to issue a warning message.<\/p>\n\n\n\n
If the user selects a row, we use the QMessageBox<\/code> to raise a question to confirm the deletion. If the user clicks OK<\/code>, we use the removeRow()<\/code> method of the QTableWidget<\/code> to delete the selected row.<\/p>\n\n\n\n
Eight, define the add_employee()<\/code> method to add a new employee to the table:<\/p>\n\n\n
def<\/span> add_employee<\/span>(self)<\/span>:<\/span>\n    if<\/span> not<\/span> self.valid():\n        return<\/span>\n    row = self.table.rowCount()\n    self.table.insertRow(row)\n    self.table.setItem(row, 0<\/span>, QTableWidgetItem(self.first_name.text().strip()))\n    self.table.setItem(row, 1<\/span>, QTableWidgetItem(self.last_name.text()))\n    self.table.setItem(row, 2<\/span>, QTableWidgetItem(self.age.text()))\n    self.reset()<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
The add_employee()<\/code> method does the following: <\/p>\n\n\n\n
The parent<\/code> is the parent widget or the main window<\/a>.<\/p>\n\n\n\n