Struct gtk::PopoverMenu

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

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

To add a child as a submenu, set the property::PopoverMenu::submenu child property to the name of the submenu. To let the user open this submenu, add a ModelButton whose property::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 ModelButton to switch back to the parent menu. Such a button should use the property::ModelButton::inverted and property::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

⚠️ The following code is in xml ⚠️

<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, PopoverMenu instances have a single css node called “popover” and get the .menu style class.

Implements

PopoverExt, BinExt, ContainerExt, WidgetExt, glib::ObjectExt, BuildableExt, ContainerExtManual, WidgetExtManual, BuildableExtManual

Implementations

impl PopoverMenu

pub fn new() -> PopoverMenu

Creates a new popover menu.

Returns

a 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 open_submenu(&self, name: &str)

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

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

name

the name of the menu to switch to

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

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

pub fn child_position<T: IsA<Widget>>(&self, item: &T) -> i32

pub fn set_child_position<T: IsA<Widget>>(&self, item: &T, position: i32)

pub fn child_submenu<T: IsA<Widget>>(&self, item: &T) -> Option<GString>

pub fn set_child_submenu<T: IsA<Widget>>(&self, item: &T, submenu: Option<&str>)

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.

const 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 Default for PopoverMenu

fn default() -> Self

Returns the “default value” for a type.

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,

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.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: 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 ==.

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

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

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

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

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

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

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

const 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<Bin> for PopoverMenu

impl IsA<Buildable> for PopoverMenu

impl IsA<Container> for PopoverMenu

impl IsA<Popover> for PopoverMenu

impl IsA<Widget> for PopoverMenu