如何使用 Gtk.Builder 创建带有菜单栏的 PyGObject 应用程序？

Question

没有关于如何在PyGObject 中使用Gtk.Builder 创建菜单栏的完整文档。

我不使用 Gtk.UIManager，因为它已被弃用。 下面的示例代码基于我使用Gtk.UIManager 的经验。

在示例中应该出现一个菜单栏，其中 Foo 作为顶部菜单组，具有可点击的项目 Bar。

#!/usr/bin/env python3
import gi
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk
from gi.repository import Gio

class Window(Gtk.ApplicationWindow):
    def __init__(self):
        Gtk.Window.__init__(self)
        self.set_default_size(200, 100)

        #
        self.interface_info = """
        <interface>
          <menu id='TheMenu'>
            <section>
              <attribute name='foo'>Foo</attribute>
              <item>
                <attribute name='bar'>Bar</attribute>
              </item>
            </section>
          </menu>
        </interface>
        """

        builder = Gtk.Builder.new_from_string(self.interface_info, -1)

        action_bar = Gio.SimpleAction.new('bar', None)
        action_bar.connect('activate', self.on_menu)
        self.add_action(action_bar)

        menubar = builder.get_object('TheMenu')

        # layout
        self.layout = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)
        self.layout.pack_start(menubar, True, True, 0)
        self.add(self.layout)

        self.connect('destroy', Gtk.main_quit)
        self.show_all()

    def on_menu(self, widget):
        print(widget)

if __name__ == '__main__':
    win = Window()
    Gtk.main()

当前的错误是

Traceback (most recent call last):
  File "./_menubar.py", line 46, in <module>
    win = Window()
  File "./_menubar.py", line 36, in __init__
    self.layout.pack_start(menubar, True, True, 0)
TypeError: argument child: Expected Gtk.Widget, but got gi.repository.Gio.Menu

我不确定

• 如何创建 XML 字符串。
• 如何获取菜单栏小部件。
• 如何为菜单项创建操作/点击处理程序。

当然这个问题可以扩展到工具栏，但我不会让它变得复杂。

顺便说一句：我不想使用Gtk.Application.set_menubar()。因为没有Gtk.Application.set_toolbar()，目前我认为拥有基于 Gtk 的应用程序对象没有任何优势。

编辑：我也试过这个变种（没有任何成功）：

gio_menu = builder.get_object('TheMenu')
menubar = Gtk.Menubar.new_from_model(gio_menu)

Answer 1

我的回答基于 gtk-dev-app 邮件列表中的foreign answer。

我更喜欢变体 3。

变体 1：使用 XML 字符串

请注意 action 在 XML 字符串 (win.bar) 和 Gio.SimpleAction(bar) 之间的不同命名。

#!/usr/bin/env python3
import gi
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk
from gi.repository import Gio

class Window(Gtk.ApplicationWindow):
    def __init__(self):
        Gtk.Window.__init__(self)
        self.set_default_size(200, 100)

        #
        self.interface_info = """
        <interface>
          <menu id='TheMenu'>
            <submenu>
              <attribute name='label'>Foo</attribute>
              <item>
                <attribute name='label'>Bar</attribute>
                <attribute name='action'>win.bar</attribute>
              </item>
            </submenu>
          </menu>
        </interface>
        """

        builder = Gtk.Builder.new_from_string(self.interface_info, -1)

        action_bar = Gio.SimpleAction.new('bar', None)
        action_bar.connect('activate', self.on_menu)
        self.add_action(action_bar)

        menumodel = builder.get_object('TheMenu')
        menubar = Gtk.MenuBar.new_from_model(menumodel)

        # layout
        self.layout = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)
        self.layout.pack_start(menubar, False, False, 0)
        self.add(self.layout)

        self.connect('destroy', Gtk.main_quit)
        self.show_all()

    def on_menu(self, action, value):
        print('Action: {}\nValue: {}'.format(action, value))

if __name__ == '__main__':
    win = Window()
    Gtk.main()

变体 2：没有 XML 但有操作

我更喜欢这个变体，因为它不使用（人类不可读的 XML）和Gtk.Builder。 在这里，您将菜单的结构创建为基于Gio.Menu 的数据结构，并将Action（它本身连接到事件处理程序）连接到它的项目。从这些信息中生成了菜单栏的小部件。

#!/usr/bin/env python3
import gi
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk
from gi.repository import Gio

class Window(Gtk.ApplicationWindow):
    def __init__(self):
        Gtk.Window.__init__(self)
        self.set_default_size(200, 100)

        action_bar = Gio.SimpleAction.new('bar', None)
        action_bar.connect('activate', self.on_menu)
        self.add_action(action_bar)

        # root of the menu
        menu_model = Gio.Menu.new()

        # menu item "Bar"
        menu_item = Gio.MenuItem.new('Bar', 'win.bar')

        # sub-menu "Foo" with item "Bar"
        menu_foo = Gio.Menu.new()
        menu_foo.append_item(menu_item)
        menu_model.append_submenu('Foo', menu_foo)

        # create menubar widget from the model
        menubar = Gtk.MenuBar.new_from_model(menu_model)

        # layout
        self.layout = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)
        self.layout.pack_start(menubar, False, False, 0)
        self.add(self.layout)

        self.connect('destroy', Gtk.main_quit)
        self.show_all()

    def on_menu(self, action, value):
        print('Action: {}\nValue: {}'.format(action, value))

if __name__ == '__main__':
    win = Window()
    Gtk.main()

变体 3：老派，无需 XML、Actions 或 Gio 层即可轻松

这种变体有点“老派”，因为您只需将菜单小部件构建在一起并将信号直接连接到它们。这可以在不使用底层和抽象数据结构（例如Gio.MenuModel 或 XML 字符串）和应用程序类的情况下工作。

#!/usr/bin/env python3
import gi
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk

class Window(Gtk.Window):
    def __init__(self):
        Gtk.Window.__init__(self)
        self.set_default_size(200, 100)

        # create menubar
        menubar = self._create_menubar()

        # create a toolbar
        toolbar = self._create_toolbar()

        # layout
        self.layout = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)
        self.layout.pack_start(menubar, False, False, 0)
        self.layout.pack_start(toolbar, False, False, 0)
        self.add(self.layout)

        self.connect('destroy', Gtk.main_quit)
        self.show_all()

    def _create_menubar(self):
        # menu item 'Bar'
        item_bar = Gtk.MenuItem.new_with_label('Bar')
        item_bar.connect('activate', self.on_menu)

        # sub menu for 'Bar'
        menu_foo = Gtk.Menu.new()
        menu_foo.append(item_bar)

        # main menu 'Foo' with attached sub menu
        item_foo = Gtk.MenuItem.new_with_label('Foo')
        item_foo.set_submenu(menu_foo)

        # the menubar itself
        menubar = Gtk.MenuBar.new()
        menubar.append(item_foo)

        return menubar

    def _create_toolbar(self):
        toolbar = Gtk.Toolbar.new()

        # button with label
        bar_item = Gtk.ToolButton.new(None, 'Bar')
        bar_item.connect('clicked', self.on_menu)
        toolbar.insert(bar_item, -1)

        # button with icon
        bar_item = Gtk.ToolButton.new_from_stock(Gtk.STOCK_OK)
        bar_item.connect('clicked', self.on_menu)
        toolbar.insert(bar_item, -1)

        return toolbar

    def on_menu(self, caller):
        print(caller)

if __name__ == '__main__':
    win = Window()
    Gtk.main()