{"id":5192,"date":"2022-10-10T09:42:02","date_gmt":"2022-10-10T09:42:02","guid":{"rendered":"https:\/\/www.pythontutorial.net\/?page_id=5192"},"modified":"2022-10-11T01:16:33","modified_gmt":"2022-10-11T01:16:33","slug":"pyqt-qtoolbar","status":"publish","type":"page","link":"https:\/\/www.pythontutorial.net\/pyqt\/pyqt-qtoolbar\/","title":{"rendered":"PyQt QToolBar"},"content":{"rendered":"\n

Summary<\/strong>: in this tutorial, you’ll learn how to use the PyQt QToolBar<\/code> class to create toolbar widgets.<\/p>\n\n\n\n

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

A toolbar is a movable panel that contains a set of controls. To create a toolbar, you use the QToolBar<\/code> class:<\/p>\n\n\n\n

The following creates a new toolbar using the QToolBar<\/code> class and adds it to the main window using the addToolBar()<\/code> method of the QMainWindowObject<\/code>:<\/p>\n\n\n

toolbar = QToolBar('Main ToolBar'<\/span>)\nself.addToolBar(toolbar)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
The setIconSize()<\/code> method of the QToolBar<\/code> object allows you to set the icon size of the icons that appear on the toolbar.<\/p>\n\n\n\n
For example, you can set the size of the icons to (16,16). To do so, you pass a QSize<\/code> object to the setIconSize()<\/code> method like this:<\/p>\n\n\n
toolbar.setIconSize(QSize(16<\/span>, 16<\/span>))<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Typically, you add buttons to the toolbar using the addAction()<\/code> method:<\/p>\n\n\n
toolbar.addAction(my_action)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
To separate between groups of buttons on the toolbar, you use the addSeparator()<\/code> method:<\/p>\n\n\n
toolbar.addSeparator()<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Besides buttons, you can add widgets to the toolbar using the addWidget()<\/code> method.<\/p>\n\n\n\n
A toolbar can be movable between toolbar areas of the main window by default. To make the toolbar fixed in a particular area, you pass False to the setMovable()<\/code> method of the QToolBar<\/code> object.<\/p>\n\n\n\n
To set an area for the toolbar, you can use the setAllowedArea()<\/code> method. The allowed areas are top, bottom, left, and right.<\/p>\n\n\n\n
Using the PyQt QToolBar class to create a toolbar #<\/a><\/h2>\n\n\n\n
We’ll continue the text editor program from the QMenu<\/code> tutorial<\/a> by creating a toolbar widget:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
The following shows the complete program:<\/p>\n\n\n
import<\/span> sys\nfrom<\/span> pathlib import<\/span> Path\nfrom<\/span> PyQt6.QtWidgets import<\/span> QApplication, QMainWindow, QTextEdit, QFileDialog, QMessageBox, QToolBar\nfrom<\/span> PyQt6.QtGui import<\/span> QIcon, QAction\nfrom<\/span> PyQt6.QtCore import<\/span> QSize, Qt\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\n        self.setWindowIcon(QIcon('.\/assets\/editor.png'<\/span>))\n        self.setGeometry(100<\/span>, 100<\/span>, 500<\/span>, 300<\/span>)\n\n        self.title = 'Editor'<\/span>\n        self.filters = 'Text Files (*.txt)'<\/span>\n\n        self.set_title()\n\n        self.path = None<\/span>\n\n        self.text_edit = QTextEdit(self)\n        self.setCentralWidget(self.text_edit)\n\n        menu_bar = self.menuBar()\n\n        file_menu = menu_bar.addMenu('&File'<\/span>)\n        edit_menu = menu_bar.addMenu('&Edit'<\/span>)\n        help_menu = menu_bar.addMenu('&Help'<\/span>)\n\n        # new menu item<\/span>\n        new_action = QAction(QIcon('.\/assets\/new.png'<\/span>), '&New'<\/span>, self)\n        new_action.setStatusTip('Create a new document'<\/span>)\n        new_action.setShortcut('Ctrl+N'<\/span>)\n        new_action.triggered.connect(self.new_document)\n        file_menu.addAction(new_action)\n\n        # open menu item<\/span>\n        open_action = QAction(QIcon('.\/assets\/open.png'<\/span>), '&Open...'<\/span>, self)\n        open_action.triggered.connect(self.open_document)\n        open_action.setStatusTip('Open a document'<\/span>)\n        open_action.setShortcut('Ctrl+O'<\/span>)\n        file_menu.addAction(open_action)\n\n        # save menu item<\/span>\n        save_action = QAction(QIcon('.\/assets\/save.png'<\/span>), '&Save'<\/span>, self)\n        save_action.setStatusTip('Save the document'<\/span>)\n        save_action.setShortcut('Ctrl+S'<\/span>)\n        save_action.triggered.connect(self.save_document)\n        file_menu.addAction(save_action)\n\n        file_menu.addSeparator()\n\n        # exit menu item<\/span>\n        exit_action = QAction(QIcon('.\/assets\/exit.png'<\/span>), '&Exit'<\/span>, self)\n        exit_action.setStatusTip('Exit'<\/span>)\n        exit_action.setShortcut('Alt+F4'<\/span>)\n        exit_action.triggered.connect(self.quit)\n        file_menu.addAction(exit_action)\n\n        # edit menu<\/span>\n        undo_action = QAction(QIcon('.\/assets\/undo.png'<\/span>), '&Undo'<\/span>, self)\n        undo_action.setStatusTip('Undo'<\/span>)\n        undo_action.setShortcut('Ctrl+Z'<\/span>)\n        undo_action.triggered.connect(self.text_edit.undo)\n        edit_menu.addAction(undo_action)\n\n        redo_action = QAction(QIcon('.\/assets\/redo.png'<\/span>), '&Redo'<\/span>, self)\n        redo_action.setStatusTip('Redo'<\/span>)\n        redo_action.setShortcut('Ctrl+Y'<\/span>)\n        redo_action.triggered.connect(self.text_edit.redo)\n        edit_menu.addAction(redo_action)\n\n        about_action = QAction(QIcon('.\/assets\/about.png'<\/span>), 'About'<\/span>, self)\n        help_menu.addAction(about_action)\n        about_action.setStatusTip('About'<\/span>)\n        about_action.setShortcut('F1'<\/span>)\n\n        # toolbar<\/span>\n        toolbar = QToolBar('Main ToolBar'<\/span>)\n        self.addToolBar(toolbar)\n        toolbar.setIconSize(QSize(16<\/span>, 16<\/span>))\n\n        toolbar.addAction(new_action)\n        toolbar.addAction(save_action)\n        toolbar.addAction(open_action)\n        toolbar.addSeparator()\n\n        toolbar.addAction(undo_action)\n        toolbar.addAction(redo_action)\n        toolbar.addSeparator()\n\n        toolbar.addAction(exit_action)\n\n        # status bar<\/span>\n        self.status_bar = self.statusBar()\n        self.show()\n\n    def<\/span> set_title<\/span>(self, filename=None)<\/span>:<\/span>\n        title = f\"{filename if<\/span> filename else<\/span> 'Untitled'<\/span>}<\/span> - {self.title}<\/span>\"<\/span>\n        self.setWindowTitle(title)\n\n    def<\/span> confirm_save<\/span>(self)<\/span>:<\/span>\n        if<\/span> not<\/span> self.text_edit.document().isModified():\n            return<\/span> True<\/span>\n\n        message = f\"Do you want to save changes to {self.path if<\/span> self.path else<\/span> 'Untitled'<\/span>}<\/span>?\"<\/span>\n        MsgBoxBtn = QMessageBox.StandardButton\n        MsgBoxBtn = MsgBoxBtn.Save | MsgBoxBtn.Discard | MsgBoxBtn.Cancel\n\n        button = QMessageBox.question(\n            self, self.title, message, buttons=MsgBoxBtn\n        )\n\n        if<\/span> button == MsgBoxBtn.Cancel:\n            return<\/span> False<\/span>\n\n        if<\/span> button == MsgBoxBtn.Save:\n            self.save_document()\n\n        return<\/span> True<\/span>\n\n    def<\/span> new_document<\/span>(self)<\/span>:<\/span>\n        if<\/span> self.confirm_save():\n            self.text_edit.clear()\n            self.set_title()\n\n    def<\/span> save_document<\/span>(self)<\/span>:<\/span>\n        # save the currently openned file<\/span>\n        if<\/span> (self.path):\n            return<\/span> self.path.write_text(self.text_edit.toPlainText())\n\n        # save a new file<\/span>\n        filename, _ = QFileDialog.getSaveFileName(\n            self, 'Save File'<\/span>, filter=self.filters\n        )\n\n        if<\/span> not<\/span> filename:\n            return<\/span>\n\n        self.path = Path(filename)\n        self.path.write_text(self.text_edit.toPlainText())\n        self.set_title(filename)\n\n    def<\/span> open_document<\/span>(self)<\/span>:<\/span>\n        filename, _ = QFileDialog.getOpenFileName(self, filter=self.filters)\n        if<\/span> filename:\n            self.path = Path(filename)\n            self.text_edit.setText(self.path.read_text())\n            self.set_title(filename)\n\n    def<\/span> quit<\/span>(self)<\/span>:<\/span>\n        if<\/span> self.confirm_save():\n            self.destroy()\n\n\nif<\/span> __name__ == '__main__'<\/span>:\n    try<\/span>:\n        import<\/span> ctypes\n        myappid = 'mycompany.myproduct.subproduct.version'<\/span>\n        ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(myappid)\n    finally<\/span>:\n        app = QApplication(sys.argv)\n        window = MainWindow()\n        sys.exit(app.exec())<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
How it works (We’ll focus on the toolbar part)<\/p>\n\n\n\n
First, create a new toolbar object using the QToolBar<\/code> class and add it to the main window using the addToolBar()<\/code> method.<\/p>\n\n\n
toolbar = QToolBar('Main ToolBar'<\/span>)\nself.addToolBar(toolbar)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Next, set the icon size of the icons on the toolbar to (16,16):<\/p>\n\n\n
toolbar.setIconSize(QSize(16<\/span>, 16<\/span>))<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Then, add new, save, and open actions to the toolbar. Also, add a separator using the addSeparator()<\/code> method:<\/p>\n\n\n
toolbar.addAction(new_action)\ntoolbar.addAction(save_action)\ntoolbar.addAction(open_action)\ntoolbar.addSeparator()<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
After that, add undo and redo actions to the toolbar and another separator:<\/p>\n\n\n
toolbar.addAction(undo_action)\ntoolbar.addAction(redo_action)\ntoolbar.addSeparator()<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Finally, add the exit action:<\/p>\n\n\n
toolbar.addAction(exit_action)<\/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 QToolBar<\/code> class to create a new toolbar.<\/li>
  • Use the addToolBar()<\/code> method to add a toolbar to the main window.<\/li>
  • Use the addAction()<\/code> method to add an item to the toolbar.<\/li>
  • Use the addSeparator()<\/code> method to add a separator to the buttons.<\/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