{"id":4920,"date":"2022-09-19T10:22:16","date_gmt":"2022-09-19T10:22:16","guid":{"rendered":"https:\/\/www.pythontutorial.net\/?page_id=4920"},"modified":"2022-10-29T07:43:06","modified_gmt":"2022-10-29T07:43:06","slug":"pyqt-qpushbutton","status":"publish","type":"page","link":"https:\/\/www.pythontutorial.net\/pyqt\/pyqt-qpushbutton\/","title":{"rendered":"PyQt QPushButton"},"content":{"rendered":"\n

Summary<\/strong>: in this tutorial, you’ll learn how to use the PyQt QPushButton<\/code> widget to create a push button.<\/p>\n\n\n\n

Introduction to the PyQt QPushButton widget #<\/a><\/h2>\n\n\n\n

The PyQt QPushButton<\/code> class allows you to create a button widget, which can be a push button or a toggle button.<\/p>\n\n\n\n

To create a push button, you follow these steps:<\/p>\n\n\n\n

First, import QPushButton<\/code> from PyQt6.QtWidgets<\/code> module:<\/p>\n\n\n

from PyQt6.QtWidgets import QPushButton<\/span><\/code><\/span>Code language:<\/span> Parser3<\/span> (<\/span>parser3<\/span>)<\/span><\/small><\/pre>\n\n\n
Second, call the QPushButton<\/code>()<\/code> with a text that appears on the button:<\/p>\n\n\n
button = QPushButton('Click Me'<\/span>)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Third, connect the clicked<\/code> signal to a callable:<\/p>\n\n\n
button.clicked.connect(self.on_clicked)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
The on_clicked<\/code> is a method that executes when the button is clicked. <\/p>\n\n\n\n
The following shows the complete program that displays a button on a window:<\/p>\n\n\n
import<\/span> sys\nfrom<\/span> PyQt6.QtWidgets import<\/span> QApplication, QWidget, QPushButton, QVBoxLayout\n\n\nclass<\/span> MainWindow<\/span>(QWidget)<\/span>:<\/span>\n    def<\/span> __init__<\/span>(self, *args, **kwargs)<\/span>:<\/span>\n        super().__init__(*args, **kwargs)\n\n        self.setWindowTitle('PyQt QPushButton Widget'<\/span>)\n        self.setGeometry(100<\/span>, 100<\/span>, 320<\/span>, 210<\/span>)\n\n        button = QPushButton('Click Me'<\/span>)\n\n        # place the widget on the window<\/span>\n        layout = QVBoxLayout()\n        layout.addWidget(button)\n        self.setLayout(layout)\n\n        # show the window<\/span>\n        self.show()\n\n\nif<\/span> __name__ == '__main__'<\/span>:\n    app = QApplication(sys.argv)\n\n    # create the main window<\/span>\n    window = MainWindow()\n\n    # start the event loop<\/span>\n    sys.exit(app.exec())<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Output:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Creating a push button with an icon #<\/a><\/h2>\n\n\n\n
To create a button with an icon, you use the following steps:<\/p>\n\n\n\n
First, import QIcon<\/code> from PyQt6.QtGui<\/code> module:<\/p>\n\n\n
from<\/span> PyQt6.QtGui import<\/span> QIcon<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Second, create a QPushButton<\/code> object:<\/p>\n\n\n
button = QPushButton('Delete'<\/span>)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Third, add the icon of the button by calling the setIcon()<\/code> method of the QPushButton<\/code> with the QIcon<\/code> object:<\/p>\n\n\n
button.setIcon(QIcon('trash.png'<\/span>))<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Note that the QIcon<\/code> object accepts a path to the icon file. To show the trash.png<\/code> icon, you can download it here:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
To make the button nicer, you can set its size by calling setFixedSize()<\/code> method. <\/p>\n\n\n\n
The size is determined by the QSize<\/code> object with two arguments width and height. Note that you need to import QSize<\/code> class from PyQt6.QtCore<\/code> module.<\/p>\n\n\n\n
The following program shows how to display a button with an icon:<\/p>\n\n\n
import<\/span> sys\nfrom<\/span> PyQt6.QtWidgets import<\/span> QApplication, QWidget, QPushButton, QVBoxLayout\nfrom<\/span> PyQt6.QtCore import<\/span> QSize\nfrom<\/span> PyQt6.QtGui import<\/span> QIcon\n\n\nclass<\/span> MainWindow<\/span>(QWidget)<\/span>:<\/span>\n    def<\/span> __init__<\/span>(self, *args, **kwargs)<\/span>:<\/span>\n        super().__init__(*args, **kwargs)\n\n        self.setWindowTitle('PyQt QPushButton Widget'<\/span>)\n        self.setGeometry(100<\/span>, 100<\/span>, 320<\/span>, 210<\/span>)\n\n        button = QPushButton('Delete'<\/span>)\n        button.setIcon(QIcon('trash.png'<\/span>))\n\n        button.setFixedSize(QSize(100<\/span>, 30<\/span>))\n\n        # place the widget on the window<\/span>\n        layout = QVBoxLayout()\n        layout.addWidget(button)\n        self.setLayout(layout)\n\n        # show the window<\/span>\n        self.show()\n\n\nif<\/span> __name__ == '__main__'<\/span>:\n    app = QApplication(sys.argv)\n\n    # create the main window<\/span>\n    window = MainWindow()\n\n    # start the event loop<\/span>\n    sys.exit(app.exec())<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Output:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Creating a toggle button #<\/a><\/h2>\n\n\n\n
The QPushButton<\/code> class has the checkable<\/code> property that allows you to use the button as a toggle button.<\/p>\n\n\n\n
A toggle button has an on\/off state. If the button is on, the checked button is true. Otherwise, it is false.<\/p>\n\n\n\n
For a toggle button, the clicked<\/code> signal sends the status of the button, either on or off.<\/p>\n\n\n\n
The following program displays a window that has a toggle button:<\/p>\n\n\n
import<\/span> sys\nfrom<\/span> PyQt6.QtWidgets import<\/span> QApplication, QWidget, QPushButton, QVBoxLayout\n\n\nclass<\/span> MainWindow<\/span>(QWidget)<\/span>:<\/span>\n    def<\/span> __init__<\/span>(self, *args, **kwargs)<\/span>:<\/span>\n        super().__init__(*args, **kwargs)\n\n        self.setWindowTitle('PyQt QPushButton Widget'<\/span>)\n        self.setGeometry(100<\/span>, 100<\/span>, 320<\/span>, 210<\/span>)\n\n        button = QPushButton('Toggle Me'<\/span>)\n        button.setCheckable(True<\/span>)\n        button.clicked.connect(self.on_toggle)\n\n        # place the button on the window<\/span>\n        layout = QVBoxLayout()\n        layout.addWidget(button)\n        self.setLayout(layout)\n\n        # show the window<\/span>\n        self.show()\n\n    def<\/span> on_toggle<\/span>(self, checked)<\/span>:<\/span>\n        print(checked)\n\n\nif<\/span> __name__ == '__main__'<\/span>:\n    app = QApplication(sys.argv)\n\n    # create the main window<\/span>\n    window = MainWindow()\n\n    # start the event loop<\/span>\n    sys.exit(app.exec())<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Summary #<\/a><\/h2>\n\n\n\n
  • Use the PyQt QPushButton<\/code> widget to create a push button or a toggle button.<\/li><\/ul>\n
    \n\t
    \n\t\t
    Was this tutorial helpful ?<\/div>\n\t\t
    \n\t\t\t\n\t\t\t\t\n\t\t\t\t\t<\/path>\n\t\t\t\t<\/svg>\n\t\t\t\t Yes <\/span>\n\t\t\t<\/button>\n\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t<\/path>\n\t\t\t\t<\/svg>\n\t\t\t\t No <\/span>\n\t\t\t<\/button>\n\t\t<\/div>\n\t<\/header>\n\n\t
    \n\t\t
    \n\t\t\t
    <\/div>\n\t\t\t