Struct gtk4::MenuButton[][src]

pub struct MenuButton(_);
Expand description

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

An example GtkMenuButton

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

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

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

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

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.

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

Returns

a ArrowType value

Returns whether the button has a frame.

Returns

true if the button has a frame

Gets the name of the icon shown in the button.

Returns

the name of the icon shown in the button

Gets the label shown in the button

Returns

the label shown in the button

Returns the GMenuModel used to generate the popup.

Returns

a GMenuModel or None

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

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.

Dismiss the menu.

Pop up the menu.

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

func should use one of

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

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

Sets the style of the button.

has_frame

whether the button should have a visible frame

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

icon_name

the icon name

Sets the label to show inside the menu button.

label

the label

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.

a GMenuModel, or None to unset and disable the button

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

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

use_underline

true if underlines in the text indicate mnemonics

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Formats the value using the given formatter. Read more

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

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

This method tests for !=.

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

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

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

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

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

Returns the type identifier of Self.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Upcasts an object to a superclass or interface T. Read more

Upcasts an object to a reference of its superclass or interface T. Read more

Tries to downcast to a subclass or interface implementor T. Read more

Tries to downcast to a reference of its subclass or interface implementor T. Read more

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

Casts to T unconditionally. Read more

Casts to &T unconditionally. Read more

Performs the conversion.

Performs the conversion.

Returns true if the object is an instance of (can be cast to) T.

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Same as connect but takes a SignalId instead of a signal name.

Same as connect_local but takes a SignalId instead of a signal name.

Same as connect_unsafe but takes a SignalId instead of a signal name.

Emit signal by signal id.

Same as emit but takes Value for the arguments.

Emit signal by its name.

Same as emit_by_name but takes Value for the arguments.

Emit signal with details by signal id.

Same as emit_with_details but takes Value for the arguments.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

Returns a SendValue clone of self.

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.