Gtk.PopoverMenu¶

Gtk.PopoverMenu is a subclass of Gtk.Popover that treats its children like menus and allows switching between them. It is meant to be used primarily together with Gtk.ModelButton, but any widget can be used, such as Gtk.SpinButton or Gtk.Scale. In this respect, Gtk.PopoverMenu is more flexible than popovers that are created from a Gio.MenuModel with Gtk.Popover.new_from_model().

To add a child as a submenu, set the Gtk.PopoverMenu :submenu child property to the name of the submenu. To let the user open this submenu, add a Gtk.ModelButton whose Gtk.ModelButton :menu-name property is set to the name you’ve given to the submenu.

By convention, the first child of a submenu should be a Gtk.ModelButton to switch back to the parent menu. Such a button should use the Gtk.ModelButton :inverted and Gtk.ModelButton :centered properties to achieve a title-like appearance and place the submenu indicator at the opposite side. To switch back to the main menu, use “main” as the menu name.

Example

<object class="GtkPopoverMenu">
  <child>
    <object class="GtkBox">
      <property name="visible">True</property>
      <property name="margin">10</property>
      <child>
        <object class="GtkModelButton">
          <property name="visible">True</property>
          <property name="action-name">win.frob</property>
          <property name="text" translatable="yes">Frob</property>
        </object>
      </child>
      <child>
        <object class="GtkModelButton">
          <property name="visible">True</property>
          <property name="menu-name">more</property>
          <property name="text" translatable="yes">More</property>
        </object>
      </child>
    </object>
  </child>
  <child>
    <object class="GtkBox">
      <property name="visible">True</property>
      <property name="margin">10</property>
      <child>
        <object class="GtkModelButton">
          <property name="visible">True</property>
          <property name="action-name">win.foo</property>
          <property name="text" translatable="yes">Foo</property>
        </object>
      </child>
      <child>
        <object class="GtkModelButton">
          <property name="visible">True</property>
          <property name="action-name">win.bar</property>
          <property name="text" translatable="yes">Bar</property>
        </object>
      </child>
    </object>
    <packing>
      <property name="submenu">more</property>
    </packing>
  </child>
</object>

Just like normal popovers created using Gtk.Popover.new_from_model, Gtk.PopoverMenu instances have a single css node called “popover” and get the .menu style class.

classmethod new()[source]¶

Returns:: a new Gtk.PopoverMenu
Return type:: Gtk.Widget

Creates a new popover menu.

New in version 3.16.

open_submenu(name)[source]¶

Parameters:: name (str) – the name of the menu to switch to

Opens a submenu of the self. The name must be one of the names given to the submenus of self with Gtk.PopoverMenu :submenu, or “main” to switch back to the main menu.

Gtk.ModelButton will open submenus automatically when the Gtk.ModelButton :menu-name property is set, so this function is only needed when you are using other kinds of widgets to initiate menu changes.

New in version 3.16.

Property Details¶

Gtk.PopoverMenu.props.visible_submenu¶

Name:: visible-submenu
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The name of the visible submenu