Menu

open class Menu : MenuShell, MenuProtocol

A GtkMenu is a GtkMenuShell that implements a drop down menu consisting of a list of GtkMenuItem objects which can be navigated and activated by the user to perform application functions.

A GtkMenu is most commonly dropped down by activating a GtkMenuItem in a GtkMenuBar or popped up by activating a GtkMenuItem in another GtkMenu.

A GtkMenu can also be popped up by activating a GtkComboBox. Other composite widgets such as the GtkNotebook can pop up a GtkMenu as well.

Applications can display a GtkMenu as a popup menu by calling the gtk_menu_popup() function. The example below shows how an application can pop up a menu when the 3rd mouse button is pressed.

Connecting the popup signal handler.

(C Language Example):

  // connect our handler which will popup the menu
  g_signal_connect_swapped (window, "button_press_event",
G_CALLBACK (my_popup_handler), menu);

Signal handler which displays a popup menu.

(C Language Example):

static gint
my_popup_handler (GtkWidget *widget, GdkEvent *event)
{
  GtkMenu *menu;
  GdkEventButton *event_button;

  g_return_val_if_fail (widget != NULL, FALSE);
  g_return_val_if_fail (GTK_IS_MENU (widget), FALSE);
  g_return_val_if_fail (event != NULL, FALSE);

  // The "widget" is the menu that was supplied when
  // g_signal_connect_swapped() was called.
  menu = GTK_MENU (widget);

  if (event->type == GDK_BUTTON_PRESS)
    {
      event_button = (GdkEventButton *) event;
      if (event_button->button == GDK_BUTTON_SECONDARY)
        {
          gtk_menu_popup (menu, NULL, NULL, NULL, NULL,
                          event_button->button, event_button->time);
          return TRUE;
        }
    }

  return FALSE;
}

CSS nodes

(plain Language Example):

menu
├── arrow.top
├── <child>
┊
├── <child>
╰── arrow.bottom

The main CSS node of GtkMenu has name menu, and there are two subnodes with name arrow, for scrolling menu arrows. These subnodes get the .top and .bottom style classes.

The Menu type acts as a reference-counted owner of an underlying GtkMenu instance. It provides the methods that can operate on this data type through MenuProtocol conformance. Use Menu as a strong reference or owner of a GtkMenu instance.

Show on GitHub 
  • Designated initialiser from the underlying `C` data type.

    This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Menu instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafeMutablePointer<GtkMenu>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Menu instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafePointer<GtkMenu>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Menu instance.

    Declaration

    Swift

    @inlinable
override public init!(gpointer op: gpointer?)

    Parameters

    op

    gpointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gconstpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Menu instance.

    Declaration

    Swift

    @inlinable
override public init!(gconstpointer op: gconstpointer?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Menu instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafePointer<GtkMenu>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Menu instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafeMutablePointer<GtkMenu>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from the underlying C data type. Will retain GtkMenu. i.e., ownership is transferred to the Menu instance.

    Declaration

    Swift

    @inlinable
public init(retaining op: UnsafeMutablePointer<GtkMenu>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Reference intialiser for a related type that implements MenuProtocol Will retain GtkMenu.

    Declaration

    Swift

    @inlinable
public init<T>(menu other: T) where T : MenuProtocol

    Parameters

    other

    an instance of a related type that implements MenuProtocol
    Show on GitHub

  • Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to MenuProtocol.

    Declaration

    Swift

    @inlinable
override public init<T>(cPointer p: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe typed, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to MenuProtocol.

    Declaration

    Swift

    @inlinable
override public init<T>(retainingCPointer cPointer: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to MenuProtocol.

    Declaration

    Swift

    @inlinable
override public init(raw p: UnsafeRawPointer)

    Parameters

    p

    raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to MenuProtocol.

    Declaration

    Swift

    @inlinable
override public init(retainingRaw raw: UnsafeRawPointer)
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to MenuProtocol.

    Declaration

    Swift

    @inlinable
public required init(raw p: UnsafeMutableRawPointer)

    Parameters

    p

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to MenuProtocol.

    Declaration

    Swift

    @inlinable
required public init(retainingRaw raw: UnsafeMutableRawPointer)

    Parameters

    raw

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to MenuProtocol.

    Declaration

    Swift

    @inlinable
override public init(opaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to MenuProtocol.

    Declaration

    Swift

    @inlinable
override public init(retainingOpaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Creates a new GtkMenu

    Declaration

    Swift

    @inlinable
public init()
    Show on GitHub

  • Creates a GtkMenu and populates it with menu items and submenus according to model.

    The created menu items are connected to actions found in the GtkApplicationWindow to which the menu belongs - typically by means of being attached to a widget (see gtk_menu_attach_to_widget()) that is contained within the GtkApplicationWindows widget hierarchy.

    Actions can also be added using gtk_widget_insert_action_group() on the menu’s attach widget or on any of its parent widgets.

    Declaration

    Swift

    @inlinable
public init<MenuModelT>(model: MenuModelT) where MenuModelT : MenuModelProtocol
    Show on GitHub

  • Creates a GtkMenu and populates it with menu items and submenus according to model.

    The created menu items are connected to actions found in the GtkApplicationWindow to which the menu belongs - typically by means of being attached to a widget (see gtk_menu_attach_to_widget()) that is contained within the GtkApplicationWindows widget hierarchy.

    Actions can also be added using gtk_widget_insert_action_group() on the menu’s attach widget or on any of its parent widgets.

    Declaration

    Swift

    @inlinable
public static func newFrom<MenuModelT>(model: MenuModelT) -> Widget! where MenuModelT : MenuModelProtocol
    Show on GitHub