Class
GtkMenuButton
Description [src]
final class Gtk.MenuButton : Gtk.Widget
implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
/* No available fields */
}The GtkMenuButton widget is used to display a popup when clicked.
This popup can be provided either as a GtkPopover or as an abstract
GMenuModel.
The GtkMenuButton widget can show either an icon (set with the
GtkMenuButton:icon-name property) or a label (set with the
GtkMenuButton:label property). If neither is explicitly set,
a GtkImage is automatically created, using an arrow image oriented
according to GtkMenuButton:direction or the generic
“open-menu-symbolic” icon if the direction is not set.
The positioning of the popup is determined by the
GtkMenuButton:direction property of the menu button.
For menus, the GtkWidget:halign and GtkWidget:valign
properties of the menu are also taken into account. For example, when the
direction is GTK_ARROW_DOWN and the horizontal alignment is GTK_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]
GtkMenuButton 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
GtkMenuButton uses the GTK_ACCESSIBLE_ROLE_BUTTON role.
Constructors
gtk_menu_button_new
Creates a new GtkMenuButton widget with downwards-pointing
arrow as the only child.
Instance methods
gtk_menu_button_get_always_show_arrow
Gets whether to show a dropdown arrow even when using an icon or a custom child.
since: 4.4
gtk_menu_button_get_can_shrink
Retrieves whether the button can be smaller than the natural size of its contents.
since: 4.12
gtk_menu_button_get_use_underline
Returns whether an embedded underline in the text indicates a mnemonic.
gtk_menu_button_set_always_show_arrow
Sets whether to show a dropdown arrow even when using an icon or a custom child.
since: 4.4
gtk_menu_button_set_can_shrink
Sets whether the button size can be smaller than the natural size of its contents.
since: 4.12
gtk_menu_button_set_popover
Sets the GtkPopover that will be popped up when the menu_button is clicked.
Methods inherited from GtkAccessible (19)
Methods inherited from GtkBuildable (1)
Properties
Gtk.MenuButton:always-show-arrow
Whether to show a dropdown arrow even when using an icon or a custom child.
since: 4.4
Gtk.MenuButton:can-shrink
Whether the size of the button can be made smaller than the natural size of its contents.
since: 4.12
Gtk.MenuButton:direction
The GtkArrowType representing the direction in which the
menu or popover will be popped out.