Struct gtk4::PopoverMenu

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. The property flags controls this appearance.

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(), WidgetClassExt::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 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

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.

Properties

flags

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.

Readable | Writeable

menu-model

The model from which the menu is made.

Readable | Writeable

visible-submenu

The name of the visible submenu.

Readable | Writeable

Popover

autohide

Whether to dismiss the popover on outside clicks.

Readable | Writeable

cascade-popdown

Whether the popover pops down after a child popover.

This is used to implement the expected behavior of submenus.

Readable | Writeable

child

The child widget.

Readable | Writeable

default-widget

The default widget inside the popover.

Readable | Writeable

has-arrow

Whether to draw an arrow.

Readable | Writeable

mnemonics-visible

Whether mnemonics are currently visible in this popover.

Readable | Writeable

pointing-to

Rectangle in the parent widget that the popover points to.

Readable | Writeable

position

How to place the popover, relative to its parent.

Readable | Writeable

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Implements

PopoverExt, WidgetExt, [trait@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.

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 flags(&self) -> PopoverMenuFlags

Available on crate feature v4_14 only.

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

Returns

the PopoverMenuFlags

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_flags(&self, flags: PopoverMenuFlags)

Available on crate feature v4_14 only.

Sets the flags that @self 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.

flags

a set of PopoverMenuFlags

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_flags_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Available on crate feature v4_14 only.

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 HasParamSpec for PopoverMenu

type ParamSpec = ParamSpecObject

type SetValue = PopoverMenu

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, PopoverMenu>

fn param_spec_builder() -> Self::BuilderFn

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) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

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