Struct gtk4::MenuButton

source ·
#[repr(transparent)]
pub struct MenuButton { /* private fields */ }
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.

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

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.

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

Available on crate feature v4_6 only.

Gets the child widget of @self.

Returns

the child widget of @self

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

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

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

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.

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

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

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.

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

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

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

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

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

use_underline

true if underlines in the text indicate mnemonics

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.

Available on crate feature v4_4 only.
Available on crate feature v4_4 only.
Available on crate feature v4_6 only.
Available on crate feature v4_4 only.

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

Updates an array of accessible properties. Read more
Updates an array of accessible relations. Read more
Updates an array of accessible states. Read more
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

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Returns true if the object is an instance of (can be cast to) T.
Returns the type of the object.
Returns the ObjectClass of the object. Read more
Returns the class of the object.
Returns the class of the object in the given type T. Read more
Returns the interface T of the object. Read more
Sets the property property_name of the object to value value. Read more
Sets the property property_name of the object to value value. Read more
Sets multiple properties of the object at once. Read more
Sets multiple properties of the object at once. Read more
Gets the property property_name of the object and cast it to the type V. Read more
Gets the property property_name of the object. Read more
Check if the object has a property property_name of the given type_. Read more
Get the type of the property property_name of this object. Read more
Get the ParamSpec of the property property_name of this object.
Return all ParamSpec of the properties of this object.
Freeze all property notifications until the return guard object is dropped. Read more
Set arbitrary data on this object with the given key. Read more
Return previously set arbitrary data of this object with the given key. Read more
Retrieve previously set arbitrary data of this object with the given key. Read more
Set arbitrary data on this object with the given key. Read more
Return previously set arbitrary data of this object with the given key. Read more
Retrieve previously set arbitrary data of this object with the given key. Read more
Block a given signal handler. Read more
Unblock a given signal handler.
Stop emission of the currently emitted signal.
Stop emission of the currently emitted signal by the (possibly detailed) signal name.
Connect to the signal signal_name on this object. Read more
Connect to the signal signal_id on this object. Read more
Connect to the signal signal_name on this object. Read more
Connect to the signal signal_id on this object. Read more
Connect to the signal signal_name on this object. Read more
Connect to the signal signal_id on this object. Read more
Connect a closure to the signal signal_name on this object. Read more
Connect a closure to the signal signal_id on this object. Read more
Limits the lifetime of closure to the lifetime of the object. When the object’s reference count drops to zero, the closure will be invalidated. An invalidated closure will ignore any calls to invoke_with_values, or invoke when using Rust closures. Read more
Emit signal by signal id. Read more
Same as Self::emit but takes Value for the arguments.
Emit signal by its name. Read more
Emit signal by its name. Read more
Emit signal by its name with details. Read more
Emit signal by its name with details. Read more
Emit signal by signal id with details. Read more
Emit signal by signal id with details. Read more
Disconnect a previously connected signal handler.
Connect to the notify signal of the object. Read more
Connect to the notify signal of the object. Read more
Connect to the notify signal of the object. Read more
Notify that the given property has changed its value. Read more
Notify that the given property has changed its value. Read more
Downgrade this object to a weak reference.
Add a callback to be notified when the Object is disposed.
Add a callback to be notified when the Object is disposed. Read more
Bind property source_property on this object to the target_property on the target object. Read more
Returns the strong reference count of this object.
Runs the dispose mechanism of the object. Read more
Ensures that the type has been registered with the type system.
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
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.