PopoverMenu

class PopoverMenu(**properties: Any)

Superclasses: Popover, Widget, InitiallyUnowned, Object

Implemented Interfaces: Accessible, Buildable, ConstraintTarget, Native, ShortcutManager

GtkPopoverMenu is 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 flags controls this appearance.

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

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

Menu models

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 set_menubar.

• “custom”: a string used to match against the ID of a custom child added with

  add_child, 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

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

Shortcuts and Gestures

GtkPopoverMenu supports the following keyboard shortcuts:

• Space 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 button’s. 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 MENU role, and its items use the MENU_ITEM, MENU_ITEM_CHECKBOX or MENU_ITEM_RADIO roles, depending on the action they are connected to.

Constructors

class PopoverMenu

classmethod new_from_model(model: MenuModel | None = 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 GtkApplicationWindow’s widget hierarchy.

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

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

Parameters:

model – a GMenuModel

classmethod new_from_model_full(model: MenuModel, flags: PopoverMenuFlags) → 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 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

class PopoverMenu

add_child(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() → PopoverMenuFlags

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

Added in version 4.14.

get_menu_model() → MenuModel | None

Returns the menu model used to populate the popover.

remove_child(child: Widget) → bool

Removes a widget that has previously been added with add_child()

Parameters:

child – the GtkWidget to remove

set_flags(flags: PopoverMenuFlags) → 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.

Added in version 4.14.

Parameters:

flags – a set of GtkPopoverMenuFlags

set_menu_model(model: MenuModel | None = 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

class PopoverMenu

props.flags: PopoverMenuFlags

The type of the None singleton.

Added in version 4.14.

props.menu_model: MenuModel

The type of the None singleton.

props.visible_submenu: str

The type of the None singleton.