Struct gtk4::MenuButton

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

The MenuButton widget is used to display a popup when clicked.

This popup can be provided either as a Popover or as an abstract GMenuModel.

The MenuButton widget can show either an icon (set with the property::MenuButton::icon-name property) or a label (set with the property::MenuButton::label property). If neither is explicitly set, a Image is automatically created, using an arrow image oriented according to property::MenuButton::direction or the generic “open-menu-symbolic” icon if the direction is not set.

The positioning of the popup is determined by the property::MenuButton::direction property of the menu button.

For menus, the property::Widget::halign and property::Widget::valign properties of the menu are also taken into account. For example, when the direction is ArrowType::Down and the horizontal alignment is Align::Start, the menu will be positioned below the button, with the starting edge (depending on the text direction) of the menu aligned with the starting edge of the button. If there is not enough space below the button, the menu is popped up above the button instead. If the alignment would move part of the menu offscreen, it is “pushed in”.

	start	center	end
down
up
left
right

CSS nodes

menubutton
╰── button.toggle
    ╰── <content>
         ╰── [arrow]

MenuButton has a single CSS node with name menubutton which contains a button node with a .toggle style class.

If the button contains an icon, it will have the .image-button style class, if it contains text, it will have .text-button style class. If an arrow is visible in addition to an icon, text or a custom child, it will also have .arrow-button style class.

Inside the toggle button content, there is an arrow node for the indicator, which will carry one of the .none, .up, .down, .left or .right style classes to indicate the direction that the menu will appear in. The CSS is expected to provide a suitable image for each of these cases using the -gtk-icon-source property.

Optionally, the menubutton node can carry the .circular style class to request a round appearance.

Accessibility

MenuButton uses the AccessibleRole::Button role.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

Implementations

impl MenuButton

pub fn new() -> MenuButton

Creates a new MenuButton widget with downwards-pointing arrow as the only child.

You can replace the child widget with another Widget should you wish to.

Returns

The newly created MenuButton

pub fn builder() -> MenuButtonBuilder

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

This method returns an instance of MenuButtonBuilder which can be used to create MenuButton objects.

pub fn must_always_show_arrow(&self) -> bool

Available on crate feature v4_4 only.

Gets whether to show a dropdown arrow even when using an icon.

Returns

whether to show a dropdown arrow even when using an icon

pub fn child(&self) -> Option<Widget>

Available on crate feature v4_6 only.

Gets the child widget of @self.

Returns

the child widget of @self

pub fn direction(&self) -> ArrowType

Returns the direction the popup will be pointing at when popped up.

Returns

a ArrowType value

pub fn has_frame(&self) -> bool

Returns whether the button has a frame.

Returns

true if the button has a frame

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

Gets the name of the icon shown in the button.

Returns

the name of the icon shown in the button

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

Gets the label shown in the button

Returns

the label shown in the button

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

Returns the GMenuModel used to generate the popup.

Returns

a GMenuModel

pub fn popover(&self) -> Option<Popover>

Returns the Popover that pops out of the button.

If the button is not using a Popover, this function returns None.

Returns

a Popover or None

pub fn is_primary(&self) -> bool

Available on crate feature v4_4 only.

Returns whether the menu button acts as a primary menu.

Returns

true if the button is a primary menu

pub fn uses_underline(&self) -> bool

Returns whether an embedded underline in the text indicates a mnemonic.

Returns

true whether an embedded underline in the text indicates the mnemonic accelerator keys.

pub fn popdown(&self)

Dismiss the menu.

pub fn popup(&self)

Pop up the menu.

pub fn set_always_show_arrow(&self, always_show_arrow: bool)

Available on crate feature v4_4 only.

Sets whether to show a dropdown arrow even when using an icon or a custom child.

always_show_arrow

hether to show a dropdown arrow even when using an icon

pub fn set_child(&self, child: Option<&impl IsA<Widget>>)

Available on crate feature v4_6 only.

Sets the child widget of @self.

Setting a child resets property::MenuButton::label and property::MenuButton::icon-name.

If property::MenuButton::always-show-arrow is set to TRUE and property::MenuButton::direction is not GTK_ARROW_NONE, a dropdown arrow will be shown next to the child.

child

the child widget

pub fn set_create_popup_func<P: Fn(&MenuButton) + 'static>(&self, func: P)

Sets @func to be called when a popup is about to be shown.

@func should use one of

• set_popover()
• set_menu_model()

to set a popup for @self. If @func is non-None, @self will always be sensitive.

Using this function will not reset the menu widget attached to @self. Instead, this can be done manually in @func.

func

function to call when a popup is about to be shown, but none has been provided via other means, or None to reset to default behavior.

destroy_notify

destroy notify for @user_data

pub fn set_direction(&self, direction: ArrowType)

Sets the direction in which the popup will be popped up.

If the button is automatically populated with an arrow icon, its direction will be changed to match.

If the does not fit in the available space in the given direction, GTK will its best to keep it inside the screen and fully visible.

If you pass ArrowType::None for a @direction, the popup will behave as if you passed ArrowType::Down (although you won’t see any arrows).

direction

a ArrowType

pub fn set_has_frame(&self, has_frame: bool)

Sets the style of the button.

has_frame

whether the button should have a visible frame

pub fn set_icon_name(&self, icon_name: &str)

Sets the name of an icon to show inside the menu button.

Setting icon name resets property::MenuButton::label and property::MenuButton::child.

If property::MenuButton::always-show-arrow is set to TRUE and property::MenuButton::direction is not GTK_ARROW_NONE, a dropdown arrow will be shown next to the icon.

icon_name

the icon name

pub fn set_label(&self, label: &str)

Sets the label to show inside the menu button.

Setting a label resets property::MenuButton::icon-name and property::MenuButton::child.

If property::MenuButton::direction is not GTK_ARROW_NONE, a dropdown arrow will be shown next to the label.

label

the label

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

Sets the GMenuModel from which the popup will be constructed.

If @menu_model is None, the button is disabled.

A Popover will be created from the menu model with PopoverMenu::from_model(). Actions will be connected as documented for this function.

If property::MenuButton::popover is already set, it will be dissociated from the @self, and the property is set to None.

menu_model

a GMenuModel, or None to unset and disable the button

pub fn set_popover(&self, popover: Option<&impl IsA<Widget>>)

Sets the Popover that will be popped up when the @self is clicked.

If @popover is None, the button is disabled.

If property::MenuButton::menu-model is set, the menu model is dissociated from the @self, and the property is set to None.

popover

a Popover, or None to unset and disable the button

pub fn set_primary(&self, primary: bool)

Available on crate feature v4_4 only.

Sets whether menu button acts as a primary menu.

Primary menus can be opened with the F10 key.

primary

whether the menubutton should act as a primary menu

pub fn set_use_underline(&self, use_underline: bool)

If true, an underline in the text indicates a mnemonic.

use_underline

true if underlines in the text indicate mnemonics

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

Available on crate feature v4_4 only.

Emitted to when the menu button is activated.

The ::activate signal on MenuButton is an action signal and emitting it causes the button to pop up its menu.

pub fn emit_activate(&self)

Available on crate feature v4_4 only.

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

Available on crate feature v4_4 only.

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

Available on crate feature v4_6 only.

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

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

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

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

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

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

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

Available on crate feature v4_4 only.

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

impl MenuButton

pub fn unset_create_popup_func(&self)

Trait Implementations

impl Clone for MenuButton

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 MenuButton

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

Formats the value using the given formatter.

impl Default for MenuButton

fn default() -> Self

Returns the “default value” for a type.

impl Display for MenuButton

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

Formats the value using the given formatter.

impl Hash for MenuButton

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 MenuButton

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl ParentClassIs for MenuButton

type Parent = Widget

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

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 !=.

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

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 MenuButton

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for MenuButton

impl IsA<Accessible> for MenuButton

impl IsA<Buildable> for MenuButton

impl IsA<ConstraintTarget> for MenuButton

impl IsA<Widget> for MenuButton