MenuButton

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_menu_button_get_type ()" ) ]
public class MenuButton : ToggleButton, Implementor, Actionable, Activatable, Buildable

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

This popup can be provided either as a Menu, a Popover or an abstract MenuModel.

The MenuButton widget can hold any valid child widget. That is, it can hold almost any other standard Widget. The most commonly used child is Image. If no widget is explicitely added to the MenuButton, 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 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”.

Direction = Down

halign = start
![](down-start.png)
halign = center
![](down-center.png)
halign = end
![](down-end.png)

Direction = Up

halign = start
![](up-start.png)
halign = center
![](up-center.png)
halign = end
![](up-end.png)

Direction = Left

valign = start
![](left-start.png)
valign = center
![](left-center.png)
valign = end
![](left-end.png)

Direction = Right

valign = start
![](right-start.png)
valign = center
![](right-center.png)
valign = end
![](right-end.png)

CSS nodes

GtkMenuButton has a single CSS node with name button. To differentiate it from a plain Button , it gets the .popup style class.

Namespace: Gtk

Package: gtk+-3.0

Content:

Properties:

public Container align_widget { get; set; }
The Widget to use to align the menu with.
public ArrowType direction { get; set; }
The ArrowType representing the direction in which the menu or popover will be popped out.
public MenuModel menu_model { get; set; }
The MenuModel from which the popup will be created.
public Popover popover { get; set; }
The Popover that will be popped up when the button is clicked.
public Menu popup { get; set; }
The Menu that will be popped up when the button is clicked.
public bool use_popover { get; set; }
Whether to construct a Popover from the menu model, or a Menu.

Creation methods:

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

Methods:

public unowned Widget? get_align_widget ()
Returns the parent Widget to use to line up with menu.
public ArrowType get_direction ()
Returns the direction the popup will be pointing at when popped up.
public unowned MenuModel? get_menu_model ()
Returns the MenuModel used to generate the popup.
public unowned Popover? get_popover ()
Returns the Popover that pops out of the button.
public unowned Menu? get_popup ()
Returns the Menu that pops out of the button.
public bool get_use_popover ()
Returns whether a Popover or a Menu will be constructed from the menu model.
public void set_align_widget (Widget? align_widget)
Sets the Widget to use to line the menu with when popped up.
public void set_direction (ArrowType direction)
Sets the direction in which the popup will be popped up, as well as changing the arrow’s direction.
public void set_menu_model (MenuModel? menu_model)
Sets the MenuModel from which the popup will be constructed, or null to dissociate any existing menu model and disable the button.
public void set_popover (Widget? popover)
Sets the Popover that will be popped up when the this is clicked, or null to dissociate any existing popover and disable the button.
public void set_popup (Widget? menu)
Sets the Menu that will be popped up when the this is clicked, or null to dissociate any existing menu and disable the button.
public void set_use_popover (bool use_popover)
Sets whether to construct a Popover instead of Menu when set_menu_model is called.

Inherited Members:

All known members inherited from class Gtk.ToggleButton

All known members inherited from class Gtk.Button

All known members inherited from class Gtk.Bin

get_child

All known members inherited from class Gtk.Container

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Atk.Implementor

ref_accessible

All known members inherited from interface Gtk.Actionable

All known members inherited from interface Gtk.Activatable

All known members inherited from interface Gtk.Buildable