Class

Gtk.MenuButton

Description [src]

final class Gtk.MenuButton : Gtk.Widget {
  /* No available fields */
}

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

An example GtkMenuButton

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 toggle button node.

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.

Hierarchy

Hierarchy for Gtk.MenuButton

Ancestors

Constructors

gtk_menu_button_new

Creates a new GtkMenuButton widget with downwards-pointing arrow as the only child.

Instance methods

gtk_menu_button_get_direction

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

gtk_menu_button_get_has_frame

Returns whether the button has a frame.

gtk_menu_button_get_icon_name

Gets the name of the icon shown in the button.

gtk_menu_button_get_label

Gets the label shown in the button

gtk_menu_button_get_menu_model

Returns the GMenuModel used to generate the popup.

gtk_menu_button_get_popover

Returns the GtkPopover that pops out of the button.

gtk_menu_button_get_use_underline

Returns whether an embedded underline in the text indicates a mnemonic.

gtk_menu_button_popdown

Dismiss the menu.

gtk_menu_button_popup

Pop up the menu.

gtk_menu_button_set_create_popup_func

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

gtk_menu_button_set_direction

Sets the direction in which the popup will be popped up.

gtk_menu_button_set_has_frame

Sets the style of the button.

gtk_menu_button_set_icon_name

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

gtk_menu_button_set_label

Sets the label to show inside the menu button.

gtk_menu_button_set_menu_model

Sets the GMenuModel from which the popup will be constructed.

gtk_menu_button_set_popover

Sets the GtkPopover that will be popped up when the menu_button is clicked.

gtk_menu_button_set_use_underline

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

Methods inherited from GtkWidget (159)
Methods inherited from GtkAccessible (10)
gtk_accessible_get_accessible_role

Retrieves the GtkAccessibleRole for the given GtkAccessible.

gtk_accessible_reset_property

Resets the accessible property to its default value.

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

gtk_accessible_reset_state

Resets the accessible state to its default value.

gtk_accessible_update_property

Updates a list of accessible properties.

gtk_accessible_update_property_value

Updates an array of accessible properties.

gtk_accessible_update_relation

Updates a list of accessible relations.

gtk_accessible_update_relation_value

Updates an array of accessible relations.

gtk_accessible_update_state

Updates a list of accessible states. See the GtkAccessibleState documentation for the value types of accessible states.

gtk_accessible_update_state_value

Updates an array of accessible states.

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

Properties

Gtk.MenuButton:direction

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

Gtk.MenuButton:has-frame

Whether the button has a frame.

Gtk.MenuButton:icon-name

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

Gtk.MenuButton:label

The label for the button.

Gtk.MenuButton:menu-model

The GMenuModel from which the popup will be created.

Gtk.MenuButton:popover

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

Gtk.MenuButton:use-underline

If set an underscore in the text indicates a mnemonic.

Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

Gtk.Widget:can-target

Whether the widget can receive pointer events.

Gtk.Widget:css-classes

A list of css classes applied to this widget.

Gtk.Widget:css-name

The name of this widget in the CSS tree.

Gtk.Widget:cursor

The cursor used by widget.

Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

Gtk.Widget:has-default

Whether the widget is the default widget.

Gtk.Widget:has-focus

Whether the widget has the input focus.

Gtk.Widget:has-tooltip

Enables or disables the emission of the ::query-tooltip signal on widget.

Gtk.Widget:height-request

Override for height request of the widget.

Gtk.Widget:hexpand

Whether to expand horizontally.

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

Gtk.Widget:layout-manager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

Gtk.Widget:margin-top

Margin on top side of widget.

Gtk.Widget:name

The name of the widget.

Gtk.Widget:opacity

The requested opacity of the widget.

Gtk.Widget:overflow

How content outside the widget’s content area is treated.

Gtk.Widget:parent

The parent widget of this widget.

Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

Gtk.Widget:scale-factor

The scale factor of the widget.

Gtk.Widget:sensitive

Whether the widget responds to input.

Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

Gtk.Widget:vexpand

Whether to expand vertically.

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

Gtk.Widget:visible

Whether the widget is visible.

Gtk.Widget:width-request

Override for width request of the widget.

Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.