Struct gtk4::PopoverMenu

#[repr(transparent)]
pub struct PopoverMenu { /* private fields */ }

PopoverMenu is a subclass of Popover that implements menu behavior.

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

PopoverMenu is meant to be used primarily with menu models, using from_model(). If you need to put other widgets such as a SpinButton or a Switch into a popover, you can use add_child().

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

Menu models

The XML format understood by Builder 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 Builder 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 Builder 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 GtkApplicationExt::set_menubar().
• “custom”: a string used to match against the ID of a custom child added with 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 TextDirection 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 GtkApplicationExt::set_accels_for_action(), [WidgetClass::add_binding_action][crate::WidgetClass::add_binding_action] or ShortcutController::add_shortcut().

CSS Nodes

PopoverMenu is just a subclass of Popover 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 popover’s main node.

Accessibility

PopoverMenu uses the AccessibleRole::Menu role, and its items use the AccessibleRole::MenuItem, AccessibleRole::MenuItemCheckbox or AccessibleRole::MenuItemRadio roles, depending on the action they are connected to.

Implements

PopoverExt, WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, NativeExt, ShortcutManagerExt, WidgetExtManual, AccessibleExtManual

Implementations

impl PopoverMenu

pub fn from_model(model: Option<&impl IsA<MenuModel>>) -> PopoverMenu

Creates a PopoverMenu and populates it according to @model.

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

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

This function creates menus with sliding submenus. See from_model_full() for a way to control this.

model

a GMenuModel

Returns

the new PopoverMenu

pub fn from_model_full(
    model: &impl IsA<MenuModel>,
    flags: PopoverMenuFlags
) -> PopoverMenu

Creates a PopoverMenu 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 ApplicationWindow to which the popover belongs. Actions can also be added using WidgetExt::insert_action_group() on the parent widget or on any of its parent widgets.

The only flag that is supported currently is PopoverMenuFlags::NESTED, which makes GTK create traditional, nested submenus instead of the default sliding submenus.

model

a GMenuModel

flags

flags that affect how the menu is created

Returns

the new PopoverMenu

pub fn builder() -> PopoverMenuBuilder

Creates a new builder-pattern struct instance to construct PopoverMenu objects.

This method returns an instance of PopoverMenuBuilder which can be used to create PopoverMenu objects.

pub fn add_child(&self, child: &impl IsA<Widget>, id: &str) -> bool

Adds a custom widget to a generated menu.

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

child

the Widget to add

id

the ID to insert @child at

Returns

true if @id was found and the widget added

pub fn menu_model(&self) -> Option<MenuModel>

Returns the menu model used to populate the popover.

Returns

the menu model of @self

pub fn remove_child(&self, child: &impl IsA<Widget>) -> bool

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

child

the Widget to remove

Returns

true if the widget was removed

pub fn set_menu_model(&self, model: Option<&impl IsA<MenuModel>>)

Sets a new menu model on @self.

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

model

a GMenuModel

pub fn visible_submenu(&self) -> Option<GString>

The name of the visible submenu.

pub fn set_visible_submenu(&self, visible_submenu: Option<&str>)

The name of the visible submenu.

pub fn connect_menu_model_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_visible_submenu_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Trait Implementations

impl Clone for PopoverMenu

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PopoverMenu

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for PopoverMenu

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for PopoverMenu

fn hash<H>(&self, state: &mut H)where
    H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PopoverMenu

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for PopoverMenu

type Parent = Popover

impl<OT: ObjectType> PartialEq<OT> for PopoverMenu

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for PopoverMenu

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for PopoverMenu

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PopoverMenu

impl IsA<Accessible> for PopoverMenu

impl IsA<Buildable> for PopoverMenu

impl IsA<ConstraintTarget> for PopoverMenu

impl IsA<Native> for PopoverMenu

impl IsA<Popover> for PopoverMenu

impl IsA<ShortcutManager> for PopoverMenu

impl IsA<Widget> for PopoverMenu