Gtk.PopoverMenu¶

class — extends Popover, Accessible, Buildable, ConstraintTarget, Native, ShortcutManager

A subclass of GtkPopover that implements menu behavior.

GtkPopoverMenu treats its children like menus and allows switching between them. It can open submenus as traditional, nested submenus, or in a more touch-friendly sliding fashion. The property PopoverMenu.flags controls this appearance.

GtkPopoverMenu is meant to be used primarily with menu models, using PopoverMenu.new_from_model. If you need to put other widgets such as a GtkSpinButton or a GtkSwitch into a popover, you can use PopoverMenu.add_child.

For more dialog-like behavior, use a plain GtkPopover.

The XML format understood by GtkBuilder for GMenuModel consists of a toplevel <menu> element, which contains one or more <item> elements. Each <item> element contains <attribute> and <link> elements with a mandatory name attribute. <link> elements have the same content model as <menu>. Instead of <link name="submenu"> or <link name="section">, you can use <submenu> or <section> elements.

<menu id='app-menu'>
  <section>
    <item>
      <attribute name='label' translatable='yes'>_New Window</attribute>
      <attribute name='action'>app.new</attribute>
    </item>
    <item>
      <attribute name='label' translatable='yes'>_About Sunny</attribute>
      <attribute name='action'>app.about</attribute>
    </item>
    <item>
      <attribute name='label' translatable='yes'>_Quit</attribute>
      <attribute name='action'>app.quit</attribute>
    </item>
  </section>
</menu>

Attribute values can be translated using gettext, like other GtkBuilder content. <attribute> elements can be marked for translation with a translatable="yes" attribute. It is also possible to specify message context and translator comments, using the context and comments attributes. To make use of this, the GtkBuilder must have been given the gettext domain to use.

The following attributes are used when constructing menu items:

"label": a user-visible string to display
"use-markup": whether the text in the menu item includes Pango markup
"action": the prefixed name of the action to trigger
"target": the parameter to use when activating the action
"icon" and "verb-icon": names of icons that may be displayed
"submenu-action": name of an action that may be used to track whether a submenu is open
"hidden-when": a string used to determine when the item will be hidden. Possible values include "action-disabled", "action-missing", "macos-menubar". This is mainly useful for exported menus, see Application.set_menubar.
"custom": a string used to match against the ID of a custom child added with PopoverMenu.add_child, PopoverMenuBar.add_child, or in the ui file with <child type="ID">.

The following attributes are used when constructing sections:

"label": a user-visible string to use as section heading
"display-hint": a string used to determine special formatting for the section. Possible values include "horizontal-buttons", "circular-buttons" and "inline-buttons". They all indicate that section should be displayed as a horizontal row of buttons.
"text-direction": a string used to determine the GtkTextDirection to use when "display-hint" is set to "horizontal-buttons". Possible values include "rtl", "ltr", and "none".

The following attributes are used when constructing submenus:

"label": a user-visible string to display
"icon": icon name to display
"gtk-macos-special": (macOS only, ignored by others) Add special meaning to a menu in the macOS menu bar. See Using GTK on Apple macOS.

Menu items will also show accelerators, which are usually associated with actions via Application.set_accels_for_action, WidgetClass.add_binding_action or ShortcutController.add_shortcut.

Shortcuts and Gestures¶

GtkPopoverMenu supports the following keyboard shortcuts:

<kbd>Space</kbd> activates the default widget.

CSS Nodes¶

GtkPopoverMenu is just a subclass of GtkPopover that adds custom content to it, therefore it has the same CSS nodes. It is one of the cases that add a .menu style class to the main popover node.

Menu items have nodes with name button and class .model. If a section display-hint is set, the section gets a node box with class horizontal plus a class with the same text as the display hint. Note that said box may not be the direct ancestor of the item buttons. Thus, for example, to style items in an inline-buttons section, select .inline-buttons button.model. Other things that may be of interest to style in menus include label nodes.

Accessibility¶

GtkPopoverMenu uses the AccessibleRole.menu role, and its items use the AccessibleRole.menu_item, AccessibleRole.checkbox or AccessibleRole.menu_item_radio roles, depending on the action they are connected to.

Constructors¶

new_from_model¶

@classmethod
def new_from_model(cls, model: Gio.MenuModel | None = ...) -> Widget

Creates a GtkPopoverMenu and populates it according to model.

The created buttons are connected to actions found in the GtkApplicationWindow to which the popover belongs - typically by means of being attached to a widget that is contained within the GtkApplicationWindows widget hierarchy.

Actions can also be added using Widget.insert_action_group on the menus attach widget or on any of its parent widgets.

This function creates menus with sliding submenus. See PopoverMenu.new_from_model_full for a way to control this.

Parameters:

model — a GMenuModel

new_from_model_full¶

@classmethod
def new_from_model_full(cls, model: Gio.MenuModel, flags: PopoverMenuFlags | int) -> Widget

Creates a GtkPopoverMenu and populates it according to model.

The created buttons are connected to actions found in the action groups that are accessible from the parent widget. This includes the GtkApplicationWindow to which the popover belongs. Actions can also be added using Widget.insert_action_group on the parent widget or on any of its parent widgets.

Parameters:

model — a GMenuModel
flags — flags that affect how the menu is created

Methods¶

add_child¶

def add_child(self, child: Widget, id: str) -> bool

Adds a custom widget to a generated menu.

For this to work, the menu model of popover must have an item with a custom attribute that matches id.

Parameters:

child — the GtkWidget to add
id — the ID to insert child at

get_flags¶

def get_flags(self) -> PopoverMenuFlags

Returns the flags that popover uses to create/display a menu from its model.

get_menu_model¶

def get_menu_model(self) -> Gio.MenuModel | None

Returns the menu model used to populate the popover.

remove_child¶

def remove_child(self, child: Widget) -> bool

Removes a widget that has previously been added with PopoverMenu.add_child

Parameters:

child — the GtkWidget to remove

set_flags¶

def set_flags(self, flags: PopoverMenuFlags | int) -> None

Sets the flags that popover uses to create/display a menu from its model.

If a model is set and the flags change, contents are rebuilt, so if setting properties individually, set flags before model to avoid a redundant rebuild.

Parameters:

flags — a set of GtkPopoverMenuFlags

set_menu_model¶

def set_menu_model(self, model: Gio.MenuModel | None = ...) -> None

Sets a new menu model on popover.

The existing contents of popover are removed, and the popover is populated with new contents according to model.

Parameters:

model — a GMenuModel

Properties¶

flags¶

flags: PopoverMenuFlags | int  # read/write

The flags that popover uses to create/display a menu from its model.

If a model is set and the flags change, contents are rebuilt, so if setting properties individually, set flags before model to avoid a redundant rebuild.

menu_model¶

menu_model: Gio.MenuModel  # read/write

The model from which the menu is made.

visible_submenu¶

visible_submenu: str  # read/write

The name of the visible submenu.

Gtk.PopoverMenu¶

Menu models¶

Shortcuts and Gestures¶

CSS Nodes¶

Accessibility¶

Constructors¶

new_from_model¶

new_from_model_full¶

Methods¶

add_child¶

get_flags¶

get_menu_model¶

remove_child¶

set_flags¶

set_menu_model¶

Properties¶

flags¶

menu_model¶

visible_submenu¶