Struct gtk4::MenuButton

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 icon-name property) or a label (set with the label property). If neither is explicitly set, a Image is automatically created, using an arrow image oriented according to direction or the generic “open-menu-symbolic” icon if the direction is not set.

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

For menus, the halign and 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.

Properties

active

Whether the menu button is active.

Readable | Writeable

always-show-arrow

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

Readable | Writeable

can-shrink

Whether the size of the button can be made smaller than the natural size of its contents.

Readable | Writeable

child

The child widget.

Readable | Writeable

direction

The ArrowType representing the direction in which the menu or popover will be popped out.

Readable | Writeable

has-frame

Whether the button has a frame.

Readable | Writeable

icon-name

The name of the icon used to automatically populate the button.

Readable | Writeable

label

The label for the button.

Readable | Writeable

menu-model

The GMenuModel from which the popup will be created.

See MenuButton::set_menu_model() for the interaction with the popover property.

Readable | Writeable

popover

The Popover that will be popped up when the button is clicked.

Readable | Writeable

primary

Whether the menu button acts as a primary menu.

Primary menus can be opened using the F10 key

Readable | Writeable

use-underline

If set an underscore in the text indicates a mnemonic.

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

Signals

activate

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.

Action

Widget

destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when @widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See WidgetExt::keynav_failed() for details.

map

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

move-focus

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

Action

query-tooltip

Emitted when the widget’s tooltip is about to be shown.

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering “above” @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

realize

Emitted when @widget is associated with a gdk::Surface.

This means that WidgetExt::realize() has been called or the widget has been mapped (that is, it is going to be drawn).

show

Emitted when @widget is shown.

state-flags-changed

Emitted when the widget state changes.

See WidgetExt::state_flags().

unmap

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize

Emitted when the gdk::Surface associated with @widget is destroyed.

This means that WidgetExt::unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

Implements

WidgetExt, [trait@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 is_active(&self) -> bool

Available on crate feature v4_10 only.

Returns whether the menu button is active.

Returns

TRUE if the button is active

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 or a custom child.

Returns

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

pub fn can_shrink(&self) -> bool

Available on crate feature v4_12 only.

Retrieves whether the button can be smaller than the natural size of its contents.

Returns

true if the button can shrink, and false otherwise

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_active(&self, active: bool)

Available on crate feature v4_10 only.

Sets whether the menu button is active.

active

whether the menu button is active

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

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

pub fn set_can_shrink(&self, can_shrink: bool)

Available on crate feature v4_12 only.

Sets whether the button size can be smaller than the natural size of its contents.

For text buttons, setting @can_shrink to true will ellipsize the label.

For icon buttons, this function has no effect.

can_shrink

whether the button can shrink

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 label and icon-name.

If always-show-arrow is set to TRUE and 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 label and child.

If always-show-arrow is set to TRUE and 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 icon-name and child.

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

Available on crate feature v4_10 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_can_shrink_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Available on crate feature v4_12 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 HasParamSpec for MenuButton

type ParamSpec = ParamSpecObject

type SetValue = MenuButton

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

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

fn param_spec_builder() -> Self::BuilderFn

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, Self: Sized,

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

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 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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