Menus

Creating a Menu

Before a menu can become visible, some py code must be added manually into the app.py file e.g.:

self.mainmenu = builder.get_object('Menu_1')      # Menu_1 = std name
self.mainwindow.configure(menu=self.mainmenu)

To create a menu, you can use the following widgets: Menu, Menuitem.Command, Menuitem.Checkbutton, Menuitem.Radiobutton, Menuitem.Submenu and Menuitem.Separator.

See the following example:

Interface file: menu.ui

Adding the menu to the main window

    # menu.py
    import tkinter as tk
    from tkinter import messagebox
    import pygubu
  
    class MyApplication:
  
        def __init__(self, master=None):
            #1: Create a builder
            self.builder = builder = pygubu.Builder()
  
            #2: Load an ui file
            builder.add_from_file('menu.ui')
  
            #3: Create the widget using self.master as parent
            self.mainwindow = builder.get_object('mainwindow', master)
  
            # Set main menu
            self.mainmenu = builder.get_object('mainmenu', self.mainwindow)
            self.mainwindow.configure(menu=self.mainmenu)

    ...

    if __name__ == '__main__':
        app = MyApplication()
        app.run()

Reacting to menu clicks

To respond to menu actions, you must set the callback function name on the command property of the Menuitem widget.

Remember to call the function connect_callbacks on the builder object to connect the callbacks defined.

Additionally, for Menuitems, there is an additional property called command_id_arg. If it is set True, the callback function is called with the widget Id as an extra argument. No extra argument is added to the call if it is set False.

Example 1, configuring callback function with extra argument:

Code:

    ...
    class MyApplication:
        def __init__(self, master=None):
            ...
            # Configure callbacks
            builder.connect_callbacks(self)

        def on_mfile_item_clicked(self, itemid):
            if itemid == 'mfile_open':
                messagebox.showinfo('File', 'You clicked Open menuitem')

            if itemid == 'mfile_quit':
                messagebox.showinfo('File', 'You clicked Quit menuitem. Byby')
                self.quit();
    ...

Example 2, configuring callback function with no additional arguments:

Code:

    ...
    class MyApplication:
        def __init__(self, master=None):
            ...
            # Configure callbacks
            builder.connect_callbacks(self)

        def on_about_clicked(self):
                messagebox.showinfo('About', 'You clicked About menuitem')
    ...

Full example code: menu.py