Gtk.Menu

Description

A Gtk.Menu.Gtk_Menu is a Gtk.Menu_Shell.Gtk_Menu_Shell that implements a drop down menu consisting of a list of Gtk.Menu_Item.Gtk_Menu_Item objects which can be navigated and activated by the user to perform application functions.

A Gtk.Menu.Gtk_Menu is most commonly dropped down by activating a Gtk.Menu_Item.Gtk_Menu_Item in a Gtk.Menu_Bar.Gtk_Menu_Bar or popped up by activating a Gtk.Menu_Item.Gtk_Menu_Item in another Gtk.Menu.Gtk_Menu.

A Gtk.Menu.Gtk_Menu can also be popped up by activating a Gtk.Combo_Box.Gtk_Combo_Box. Other composite widgets such as the Gtk.Notebook.Gtk_Notebook can pop up a Gtk.Menu.Gtk_Menu as well.

Applications can display a Gtk.Menu.Gtk_Menu 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.

// 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.

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

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.

"+"

function "+"
  (Widget : access Gtk_Menu_Record'Class)
return Gtk.Buildable.Gtk_Buildable

Parameters

Widget

Return Value

"-"

function "-"
  (Interf : Gtk.Buildable.Gtk_Buildable)
return Gtk_Menu

Parameters

Interf

Return Value

Accel_Group_Property

Accel_Group_Property : constant Glib.Properties.Property_Object;

Type: Gtk.Accel_Group.Gtk_Accel_Group The accel group holding accelerators for the menu.

Accel_Path_Property

Accel_Path_Property : constant Glib.Properties.Property_String;

An accel path used to conveniently construct accel paths of child items.

Active_Property

Active_Property : constant Glib.Properties.Property_Int;

The index of the currently selected menu item, or -1 if no menu item is selected.

Anchor_Hints_Property

Anchor_Hints_Property : constant Gdk.Window.Property_Gdk_Anchor_Hints;

Type: Gdk.Window.Gdk_Anchor_Hints Positioning hints for aligning the menu relative to a rectangle.

These hints determine how the menu should be positioned in the case that the menu would fall off-screen if placed in its ideal position.

For example, Gdk.Anchor_Flip_Y will replace Gdk.Gravity_North_West with Gdk.Gravity_South_West and vice versa if the menu extends beyond the bottom edge of the monitor.

See gtk_menu_popup_at_rect (), gtk_menu_popup_at_widget (), gtk_menu_popup_at_pointer (), Gtk.Menu.Gtk_Menu:rect-anchor-dx, Gtk.Menu.Gtk_Menu:rect-anchor-dy, Gtk.Menu.Gtk_Menu:menu-type-hint, and Gtk.Menu.Gtk_Menu::popped-up.

Attach

procedure Attach
   (Menu          : not null access Gtk_Menu_Record;
    Child         : not null access Gtk.Widget.Gtk_Widget_Record'Class;
    Left_Attach   : Guint;
    Right_Attach  : Guint;
    Top_Attach    : Guint;
    Bottom_Attach : Guint)

Adds a new Gtk.Menu_Item.Gtk_Menu_Item to a (table) menu. The number of "cells" that an item will occupy is specified by Left_Attach, Right_Attach, Top_Attach and Bottom_Attach. These each represent the leftmost, rightmost, uppermost and lower column and row numbers of the table. (Columns and rows are indexed from zero). Note that this function is not related to Gtk.Menu.Detach. Since: gtk+ 2.4

Parameters

Menu
Child: a Gtk.Menu_Item.Gtk_Menu_Item
Left_Attach: The column number to attach the left side of the item to
Right_Attach: The column number to attach the right side of the item to
Top_Attach: The row number to attach the top of the item to
Bottom_Attach: The row number to attach the bottom of the item to

Attach_To_Widget

procedure Attach_To_Widget
   (Menu          : not null access Gtk_Menu_Record;
    Attach_Widget : not null access Gtk.Widget.Gtk_Widget_Record'Class;
    Detacher      : Gtk_Menu_Detach_Func)

Attaches the menu to the widget and provides a callback function that will be invoked when the menu calls Gtk.Menu.Detach during its destruction. If the menu is attached to the widget then it will be destroyed when the widget is destroyed, as if it was a child widget. An attached menu will also move between screens correctly if the widgets moves between screens.

Parameters

Menu
Attach_Widget: the Gtk.Widget.Gtk_Widget that the menu will be attached to
Detacher: the user supplied callback function that will be called when the menu calls Gtk.Menu.Detach

Attach_Widget_Property

Attach_Widget_Property : constant Glib.Properties.Property_Object;

Type: Gtk.Widget.Gtk_Widget The widget the menu is attached to. Setting this property attaches the menu without a Gtk_Menu_Detach_Func. If you need to use a detacher, use Gtk.Menu.Attach_To_Widget directly.

Cb_GObject_Address_Address_Boolean_Boolean_Void

type Cb_GObject_Address_Address_Boolean_Boolean_Void is not null access procedure
  (Self         : access Glib.Object.GObject_Record'Class;
   Flipped_Rect : System.Address;
   Final_Rect   : System.Address;
   Flipped_X    : Boolean;
   Flipped_Y    : Boolean);

Parameters

Self
Flipped_Rect
Final_Rect
Flipped_X
Flipped_Y

Cb_GObject_Gtk_Scroll_Type_Void

type Cb_GObject_Gtk_Scroll_Type_Void is not null access procedure
  (Self        : access Glib.Object.GObject_Record'Class;
   Scroll_Type : Gtk.Enums.Gtk_Scroll_Type);

Parameters

Self
Scroll_Type

Cb_Gtk_Menu_Address_Address_Boolean_Boolean_Void

type Cb_Gtk_Menu_Address_Address_Boolean_Boolean_Void is not null access procedure
  (Self         : access Gtk_Menu_Record'Class;
   Flipped_Rect : System.Address;
   Final_Rect   : System.Address;
   Flipped_X    : Boolean;
   Flipped_Y    : Boolean);

Parameters

Self
Flipped_Rect
Final_Rect
Flipped_X
Flipped_Y

Cb_Gtk_Menu_Gtk_Scroll_Type_Void

type Cb_Gtk_Menu_Gtk_Scroll_Type_Void is not null access procedure
  (Self        : access Gtk_Menu_Record'Class;
   Scroll_Type : Gtk.Enums.Gtk_Scroll_Type);

Parameters

Self
Scroll_Type

Detach

procedure Detach (Menu : not null access Gtk_Menu_Record)

Detaches the menu from the widget to which it had been attached. This function will call the callback function, Detacher, provided when the Gtk.Menu.Attach_To_Widget function was called.

Parameters

Menu

Get_Accel_Group

function Get_Accel_Group
   (Menu : not null access Gtk_Menu_Record)
    return Gtk.Accel_Group.Gtk_Accel_Group

Gets the Gtk.Accel_Group.Gtk_Accel_Group which holds global accelerators for the menu. See Gtk.Menu.Set_Accel_Group.

Parameters

Menu

Return Value

the Gtk.Accel_Group.Gtk_Accel_Group associated with the menu

Get_Accel_Path

function Get_Accel_Path
   (Menu : not null access Gtk_Menu_Record) return UTF8_String

Retrieves the accelerator path set on the menu. Since: gtk+ 2.14

Parameters

Menu

Return Value

the accelerator path set on the menu.

Get_Active

function Get_Active
   (Menu : not null access Gtk_Menu_Record)
    return Gtk.Menu_Item.Gtk_Menu_Item

Returns the selected menu item from the menu. This is used by the Gtk.Combo_Box.Gtk_Combo_Box.

Parameters

Menu

Return Value

Get_Attach_Widget

function Get_Attach_Widget
   (Menu : not null access Gtk_Menu_Record) return Gtk.Widget.Gtk_Widget

Returns the Gtk.Widget.Gtk_Widget that the menu is attached to.

Parameters

Menu

Return Value

the Gtk.Widget.Gtk_Widget that the menu is attached to

Get_For_Attach_Widget

function Get_For_Attach_Widget
   (Widget : not null access Gtk.Widget.Gtk_Widget_Record'Class)
    return Gtk.Widget.Widget_List.Glist

Returns a list of the menus which are attached to this widget. This list is owned by GTK+ and must not be modified. Since: gtk+ 2.6

Parameters

Widget: a Gtk.Widget.Gtk_Widget

Return Value

Get_Monitor

function Get_Monitor
   (Menu : not null access Gtk_Menu_Record) return Glib.Gint

Retrieves the number of the monitor on which to show the menu. Since: gtk+ 2.14

Parameters

Menu

Return Value

the number of the monitor on which the menu should be popped up or -1, if no monitor has been set

Get_Reserve_Toggle_Size

function Get_Reserve_Toggle_Size
   (Menu : not null access Gtk_Menu_Record) return Boolean

Returns whether the menu reserves space for toggles and icons, regardless of their actual presence. Since: gtk+ 2.18

Parameters

Menu

Return Value

Whether the menu reserves toggle space

Get_Tearoff_State

function Get_Tearoff_State
   (Menu : not null access Gtk_Menu_Record) return Boolean

Returns whether the menu is torn off. See Gtk.Menu.Set_Tearoff_State. Deprecated since 3.10, 1

Parameters

Menu

Return Value

True if the menu is currently torn off.

Get_Title

function Get_Title
   (Menu : not null access Gtk_Menu_Record) return UTF8_String

Returns the title of the menu. See Gtk.Menu.Set_Title. Deprecated since 3.10, 1

Parameters

Menu

Return Value

the title of the menu, or null if the menu has no title set on it. This string is owned by GTK+ and should not be modified or freed.

Get_Type

function Get_Type return Glib.GType

Return Value

Gtk_Menu

type Gtk_Menu is access all Gtk_Menu_Record'Class;

Gtk_Menu_Detach_Func

type Gtk_Menu_Detach_Func is access procedure (Attach_Widget : System.Address; Menu : System.Address);

A user function supplied when calling Gtk.Menu.Attach_To_Widget which will be called when the menu is later detached from the widget.

Parameters

Attach_Widget: the Gtk.Widget.Gtk_Widget that the menu is being detached from.
Menu: the Gtk.Menu.Gtk_Menu being detached.

Gtk_Menu_New

function Gtk_Menu_New return Gtk_Menu

Creates a new Gtk.Menu.Gtk_Menu

Return Value

Gtk_Menu_New_From_Model

function Gtk_Menu_New_From_Model
   (Model : not null access Glib.Menu_Model.Gmenu_Model_Record'Class)
    return Gtk_Menu

Creates a Gtk.Menu.Gtk_Menu and populates it with menu items and submenus according to Model. The created menu items are connected to actions found in the Gtk.Application_Window.Gtk_Application_Window to which the menu belongs

typically by means of being attached to a widget (see

Parameters

Model: a Glib.Menu_Model.Gmenu_Model

Return Value

Gtk_Menu_Position_Func

type Gtk_Menu_Position_Func is access procedure
  (Menu    : not null access Gtk_Menu_Record'Class;
   X       : out Glib.Gint;
   Y       : out Glib.Gint;
   Push_In : out Boolean);

A user function supplied when calling Gtk.Menu.Popup which controls the positioning of the menu when it is displayed. The function sets the X and Y parameters to the coordinates where the menu is to be drawn. To make the menu appear on a different monitor than the mouse pointer, gtk_menu_set_monitor must be called.

Parameters

Menu: a Gtk.Menu.Gtk_Menu.
X: address of the Glib.Gint representing the horizontal position where the menu shall be drawn.
Y: address of the Glib.Gint representing the vertical position where the menu shall be drawn. This is an output parameter.
Push_In: This parameter controls how menus placed outside the monitor are handled. If this is set to True and part of the menu is outside the monitor then GTK+ pushes the window into the visible area, effectively modifying the popup position. Note that moving and possibly resizing the menu around will alter the scroll position to keep the menu items "in place", i.e. at the same monitor position they would have been without resizing. In practice, this behavior is only useful for combobox popups or option menus and cannot be used to simply confine a menu to monitor boundaries. In that case, changing the scroll offset is not desirable.

Gtk_Menu_Record

type Gtk_Menu_Record is new Gtk_Menu_Shell_Record with null record;

Gtk_New

procedure Gtk_New (Menu : out Gtk_Menu)

Creates a new Gtk.Menu.Gtk_Menu Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters

Menu

Gtk_New_From_Model

procedure Gtk_New_From_Model
   (Menu  : out Gtk_Menu;
    Model : not null access Glib.Menu_Model.Gmenu_Model_Record'Class)

typically by means of being attached to a widget (see

Gtk.Menu.Attach_To_Widget) that is contained within the Gtk_Application_Windows 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. Since: gtk+ 3.4 Initialize_From_Model does nothing if the object was already created with another call to Initialize* or G_New.

Parameters

Menu
Model: a Glib.Menu_Model.Gmenu_Model

Implements_Gtk_Buildable

package Implements_Gtk_Buildable is new Glib.Types.Implements
  (Gtk.Buildable.Gtk_Buildable, Gtk_Menu_Record, Gtk_Menu);

Initialize

procedure Initialize (Menu : not null access Gtk_Menu_Record'Class)

Creates a new Gtk.Menu.Gtk_Menu Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters

Menu

Initialize_From_Model

procedure Initialize_From_Model
   (Menu  : not null access Gtk_Menu_Record'Class;
    Model : not null access Glib.Menu_Model.Gmenu_Model_Record'Class)

typically by means of being attached to a widget (see

Parameters

Menu
Model: a Glib.Menu_Model.Gmenu_Model

Menu_Type_Hint_Property

Menu_Type_Hint_Property : constant Gdk.Window.Property_Gdk_Window_Type_Hint;

Type: Gdk.Window.Gdk_Window_Type_Hint The Gdk.Window.Gdk_Window_Type_Hint to use for the menu's Gdk.Gdk_Window.

See gtk_menu_popup_at_rect (), gtk_menu_popup_at_widget (), gtk_menu_popup_at_pointer (), Gtk.Menu.Gtk_Menu:anchor-hints, Gtk.Menu.Gtk_Menu:rect-anchor-dx, Gtk.Menu.Gtk_Menu:rect-anchor-dy, and Gtk.Menu.Gtk_Menu::popped-up.

Monitor_Property

Monitor_Property : constant Glib.Properties.Property_Int;

The monitor the menu will be popped up on.

On_Move_Scroll

procedure On_Move_Scroll
   (Self  : not null access Gtk_Menu_Record;
    Call  : Cb_GObject_Gtk_Scroll_Type_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Parameters

Self
Call
Slot
After

On_Move_Scroll

procedure On_Move_Scroll
   (Self  : not null access Gtk_Menu_Record;
    Call  : Cb_Gtk_Menu_Gtk_Scroll_Type_Void;
    After : Boolean := False)

Parameters

Self
Call
After

On_Popped_Up

procedure On_Popped_Up
   (Self  : not null access Gtk_Menu_Record;
    Call  : Cb_GObject_Address_Address_Boolean_Boolean_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Emitted when the position of Menu is finalized after being popped up using gtk_menu_popup_at_rect (), gtk_menu_popup_at_widget (), or gtk_menu_popup_at_pointer ().

Menu might be flipped over the anchor rectangle in order to keep it on-screen, in which case Flipped_X and Flipped_Y will be set to True accordingly.

Flipped_Rect is the ideal position of Menu after any possible flipping, but before any possible sliding. Final_Rect is Flipped_Rect, but possibly translated in the case that flipping is still ineffective in keeping Menu on-screen.

The blue menu is Menu's ideal position, the green menu is Flipped_Rect, and the red menu is Final_Rect.

Callback parameters: -- @param Flipped_Rect the position of Menu after any possible flipping or -- null if the backend can't obtain it -- @param Final_Rect the final position of Menu or null if the backend -- can't obtain it -- @param Flipped_X True if the anchors were flipped horizontally -- @param Flipped_Y True if the anchors were flipped vertically

Parameters

Self
Call
Slot
After

On_Popped_Up

procedure On_Popped_Up
   (Self  : not null access Gtk_Menu_Record;
    Call  : Cb_Gtk_Menu_Address_Address_Boolean_Boolean_Void;
    After : Boolean := False)

Emitted when the position of Menu is finalized after being popped up using gtk_menu_popup_at_rect (), gtk_menu_popup_at_widget (), or gtk_menu_popup_at_pointer ().

Menu might be flipped over the anchor rectangle in order to keep it on-screen, in which case Flipped_X and Flipped_Y will be set to True accordingly.

The blue menu is Menu's ideal position, the green menu is Flipped_Rect, and the red menu is Final_Rect.

Parameters

Self
Call
After

Place_On_Monitor

procedure Place_On_Monitor
   (Menu    : not null access Gtk_Menu_Record;
    Monitor : not null access Gdk.Monitor.Gdk_Monitor_Record'Class)

Places Menu on the given monitor. Since: gtk+ 3.22

Parameters

Menu
Monitor: the monitor to place the menu on

Popdown

procedure Popdown (Menu : not null access Gtk_Menu_Record)

Removes the menu from the screen.

Parameters

Menu

Popup

procedure Popup
   (Menu              : not null access Gtk_Menu_Record;
    Parent_Menu_Shell : Gtk.Menu_Shell.Gtk_Menu_Shell := null;
    Parent_Menu_Item  : Gtk.Menu_Item.Gtk_Menu_Item := null;
    Func              : Gtk_Menu_Position_Func := null;
    Button            : Guint := 1;
    Activate_Time     : Guint32 := 0)

Displays a menu and makes it available for selection. Applications can use this function to display context-sensitive menus, and will typically supply null for the Parent_Menu_Shell, Parent_Menu_Item, Func and Data parameters. The default menu positioning function will position the menu at the current mouse cursor position. The Button parameter should be the mouse button pressed to initiate the menu popup. If the menu popup was initiated by something other than a mouse button press, such as a mouse button release or a keypress, Button should be 0. The Activate_Time parameter is used to conflict-resolve initiation of concurrent requests for mouse/keyboard grab requests. To function properly, this needs to be the timestamp of the user event (such as a mouse click or key press) that caused the initiation of the popup. Only if no such event is available, Gtk.Main.Get_Current_Event_Time can be used instead. Note that this function does not work very well on GDK backends that do not have global coordinates, such as Wayland or Mir. You should probably use one of the gtk_menu_popup_at_ variants, which do not have this problem. Deprecated since 3.22, 1

Parameters

Menu
Parent_Menu_Shell: the menu shell containing the triggering menu item, or null
Parent_Menu_Item: the menu item whose activation triggered the popup, or null
Func: a user supplied function used to position the menu, or null
Button: the mouse button which was pressed to initiate the event.
Activate_Time: the time at which the activation event occurred.

Popup_At_Pointer

procedure Popup_At_Pointer
   (Menu          : not null access Gtk_Menu_Record;
    Trigger_Event : Gdk.Event.Gdk_Event)

Displays Menu and makes it available for selection. See gtk_menu_popup_at_widget () to pop up a menu at a widget. gtk_menu_popup_at_rect () also allows you to position a menu at an arbitrary rectangle. Menu will be positioned at the pointer associated with Trigger_Event. Properties that influence the behaviour of this function are Gtk.Menu.Gtk_Menu:anchor-hints, Gtk.Menu.Gtk_Menu:rect-anchor-dx, Gtk.Menu.Gtk_Menu:rect-anchor-dy, and Gtk.Menu.Gtk_Menu:menu-type-hint. Connect to the Gtk.Menu.Gtk_Menu::popped-up signal to find out how it was actually positioned. Since: gtk+ 3.22

Parameters

Menu
Trigger_Event: the Gdk.Event.Gdk_Event that initiated this request or null if it's the current event

Popup_At_Rect

procedure Popup_At_Rect
   (Menu          : not null access Gtk_Menu_Record;
    Rect_Window   : Gdk.Gdk_Window;
    Rect          : Gdk.Rectangle.Gdk_Rectangle;
    Rect_Anchor   : Gdk.Window.Gdk_Gravity;
    Menu_Anchor   : Gdk.Window.Gdk_Gravity;
    Trigger_Event : Gdk.Event.Gdk_Event)

Displays Menu and makes it available for selection. See gtk_menu_popup_at_widget () and gtk_menu_popup_at_pointer (), which handle more common cases for popping up menus. Menu will be positioned at Rect, aligning their anchor points. Rect is relative to the top-left corner of Rect_Window. Rect_Anchor and Menu_Anchor determine anchor points on Rect and Menu to pin together. Menu can optionally be offset by Gtk.Menu.Gtk_Menu:rect-anchor-dx and Gtk.Menu.Gtk_Menu:rect-anchor-dy. Anchors should be specified under the assumption that the text direction is left-to-right; they will be flipped horizontally automatically if the text direction is right-to-left. Other properties that influence the behaviour of this function are Gtk.Menu.Gtk_Menu:anchor-hints and Gtk.Menu.Gtk_Menu:menu-type-hint. Connect to the Gtk.Menu.Gtk_Menu::popped-up signal to find out how it was actually positioned. Since: gtk+ 3.22

Parameters

Menu
Rect_Window: the Gdk.Gdk_Window Rect is relative to
Rect: the Gdk.Rectangle.Gdk_Rectangle to align Menu with
Rect_Anchor: the point on Rect to align with Menu's anchor point
Menu_Anchor: the point on Menu to align with Rect's anchor point
Trigger_Event: the Gdk.Event.Gdk_Event that initiated this request or null if it's the current event

Popup_At_Widget

procedure Popup_At_Widget
   (Menu          : not null access Gtk_Menu_Record;
    Widget        : not null access Gtk.Widget.Gtk_Widget_Record'Class;
    Widget_Anchor : Gdk.Window.Gdk_Gravity;
    Menu_Anchor   : Gdk.Window.Gdk_Gravity;
    Trigger_Event : Gdk.Event.Gdk_Event)

Displays Menu and makes it available for selection. See gtk_menu_popup_at_pointer () to pop up a menu at the master pointer. gtk_menu_popup_at_rect () also allows you to position a menu at an arbitrary rectangle. Menu will be positioned at Widget, aligning their anchor points. Widget_Anchor and Menu_Anchor determine anchor points on Widget and Menu to pin together. Menu can optionally be offset by Gtk.Menu.Gtk_Menu:rect-anchor-dx and Gtk.Menu.Gtk_Menu:rect-anchor-dy. Anchors should be specified under the assumption that the text direction is left-to-right; they will be flipped horizontally automatically if the text direction is right-to-left. Other properties that influence the behaviour of this function are Gtk.Menu.Gtk_Menu:anchor-hints and Gtk.Menu.Gtk_Menu:menu-type-hint. Connect to the Gtk.Menu.Gtk_Menu::popped-up signal to find out how it was actually positioned. Since: gtk+ 3.22

Parameters

Menu
Widget: the Gtk.Widget.Gtk_Widget to align Menu with
Widget_Anchor: the point on Widget to align with Menu's anchor point
Menu_Anchor: the point on Menu to align with Widget's anchor point
Trigger_Event: the Gdk.Event.Gdk_Event that initiated this request or null if it's the current event

Popup_For_Device

procedure Popup_For_Device
   (Menu              : not null access Gtk_Menu_Record;
    Device            : access Gdk.Device.Gdk_Device_Record'Class;
    Parent_Menu_Shell : access Gtk.Widget.Gtk_Widget_Record'Class;
    Parent_Menu_Item  : access Gtk.Widget.Gtk_Widget_Record'Class;
    Func              : Gtk_Menu_Position_Func;
    Button            : Guint;
    Activate_Time     : Guint32)

Displays a menu and makes it available for selection. Applications can use this function to display context-sensitive menus, and will typically supply null for the Parent_Menu_Shell, Parent_Menu_Item, Func, Data and Destroy parameters. The default menu positioning function will position the menu at the current position of Device (or its corresponding pointer). The Button parameter should be the mouse button pressed to initiate the menu popup. If the menu popup was initiated by something other than a mouse button press, such as a mouse button release or a keypress, Button should be 0. The Activate_Time parameter is used to conflict-resolve initiation of concurrent requests for mouse/keyboard grab requests. To function properly, this needs to be the time stamp of the user event (such as a mouse click or key press) that caused the initiation of the popup. Only if no such event is available, Gtk.Main.Get_Current_Event_Time can be used instead. Note that this function does not work very well on GDK backends that do not have global coordinates, such as Wayland or Mir. You should probably use one of the gtk_menu_popup_at_ variants, which do not have this problem. Since: gtk+ 3.0 Deprecated since 3.22, 1

Parameters

Menu
Device: a Gdk.Device.Gdk_Device
Parent_Menu_Shell: the menu shell containing the triggering menu item, or null
Parent_Menu_Item: the menu item whose activation triggered the popup, or null
Func: a user supplied function used to position the menu, or null
Button: the mouse button which was pressed to initiate the event
Activate_Time: the time at which the activation event occurred

Rect_Anchor_Dx_Property

Rect_Anchor_Dx_Property : constant Glib.Properties.Property_Int;

Horizontal offset to apply to the menu, i.e. the rectangle or widget anchor.

See gtk_menu_popup_at_rect (), gtk_menu_popup_at_widget (), gtk_menu_popup_at_pointer (), Gtk.Menu.Gtk_Menu:anchor-hints, Gtk.Menu.Gtk_Menu:rect-anchor-dy, Gtk.Menu.Gtk_Menu:menu-type-hint, and Gtk.Menu.Gtk_Menu::popped-up.

Rect_Anchor_Dy_Property

Rect_Anchor_Dy_Property : constant Glib.Properties.Property_Int;

Vertical offset to apply to the menu, i.e. the rectangle or widget anchor.

Reorder_Child

procedure Reorder_Child
   (Menu     : not null access Gtk_Menu_Record;
    Child    : not null access Gtk.Widget.Gtk_Widget_Record'Class;
    Position : Glib.Gint)

Moves Child to a new Position in the list of Menu children.

Parameters

Menu
Child: the Gtk.Menu_Item.Gtk_Menu_Item to move
Position: the new position to place Child. Positions are numbered from 0 to n - 1

Reposition

procedure Reposition (Menu : not null access Gtk_Menu_Record)

Repositions the menu according to its position function.

Parameters

Menu

Reserve_Toggle_Size_Property

Reserve_Toggle_Size_Property : constant Glib.Properties.Property_Boolean;

A boolean that indicates whether the menu reserves space for toggles and icons, regardless of their actual presence.

This property should only be changed from its default value for special-purposes such as tabular menus. Regular menus that are connected to a menu bar or context menus should reserve toggle space for consistency.

Set_Accel_Group

procedure Set_Accel_Group
   (Menu        : not null access Gtk_Menu_Record;
    Accel_Group : access Gtk.Accel_Group.Gtk_Accel_Group_Record'Class)

Set the Gtk.Accel_Group.Gtk_Accel_Group which holds global accelerators for the menu. This accelerator group needs to also be added to all windows that this menu is being used in with Gtk.Window.Add_Accel_Group, in order for those windows to support all the accelerators contained in this group.

Parameters

Menu
Accel_Group: the Gtk.Accel_Group.Gtk_Accel_Group to be associated with the menu.

Set_Accel_Path

procedure Set_Accel_Path
   (Menu       : not null access Gtk_Menu_Record;
    Accel_Path : UTF8_String := "")

Sets an accelerator path for this menu from which accelerator paths for its immediate children, its menu items, can be constructed. The main purpose of this function is to spare the programmer the inconvenience of having to call Gtk.Menu_Item.Set_Accel_Path on each menu item that should support runtime user changable accelerators. Instead, by just calling Gtk.Menu.Set_Accel_Path on their parent, each menu item of this menu, that contains a label describing its purpose, automatically gets an accel path assigned. For example, a menu containing menu items "New" and "Exit", will, after gtk_menu_set_accel_path (menu, "<Gnumeric-Sheet>/File"); has been called, assign its items the accel paths: "<Gnumeric-Sheet>/File/New" and "<Gnumeric-Sheet>/File/Exit". Assigning accel paths to menu items then enables the user to change their accelerators at runtime. More details about accelerator paths and their default setups can be found at Gtk.Accel_Map.Add_Entry. Note that Accel_Path string will be stored in a Glib.GQuark. Therefore, if you pass a static string, you can save some memory by interning it first with g_intern_static_string.

Parameters

Menu
Accel_Path: a valid accelerator path, or null to unset the path

Set_Active

procedure Set_Active
   (Menu  : not null access Gtk_Menu_Record;
    Index : Guint)

Selects the specified menu item within the menu. This is used by the Gtk.Combo_Box.Gtk_Combo_Box and should not be used by anyone else.

Parameters

Menu
Index: the index of the menu item to select. Index values are from 0 to n-1

Set_Monitor

procedure Set_Monitor
   (Menu        : not null access Gtk_Menu_Record;
    Monitor_Num : Glib.Gint)

Informs GTK+ on which monitor a menu should be popped up. See Gdk.Monitor.Get_Geometry. This function should be called from a Gtk_Menu_Position_Func if the menu should not appear on the same monitor as the pointer. This information can't be reliably inferred from the coordinates returned by a Gtk_Menu_Position_Func, since, for very long menus, these coordinates may extend beyond the monitor boundaries or even the screen boundaries. Since: gtk+ 2.4

Parameters

Menu
Monitor_Num: the number of the monitor on which the menu should be popped up

Set_Reserve_Toggle_Size

procedure Set_Reserve_Toggle_Size
   (Menu                : not null access Gtk_Menu_Record;
    Reserve_Toggle_Size : Boolean)

Sets whether the menu should reserve space for drawing toggles or icons, regardless of their actual presence. Since: gtk+ 2.18

Parameters

Menu
Reserve_Toggle_Size: whether to reserve size for toggles

Set_Screen

procedure Set_Screen
   (Menu   : not null access Gtk_Menu_Record;
    Screen : access Gdk.Screen.Gdk_Screen_Record'Class)

Sets the Gdk.Screen.Gdk_Screen on which the menu will be displayed. Since: gtk+ 2.2

Parameters

Menu
Screen: a Gdk.Screen.Gdk_Screen, or null if the screen should be determined by the widget the menu is attached to

Set_Tearoff_State

procedure Set_Tearoff_State
   (Menu     : not null access Gtk_Menu_Record;
    Torn_Off : Boolean)

Changes the tearoff state of the menu. A menu is normally displayed as drop down menu which persists as long as the menu is active. It can also be displayed as a tearoff menu which persists until it is closed or reattached. Deprecated since 3.10, 1

Parameters

Menu
Torn_Off: If True, menu is displayed as a tearoff menu.

Set_Title

procedure Set_Title
   (Menu  : not null access Gtk_Menu_Record;
    Title : UTF8_String := "")

Sets the title string for the menu. The title is displayed when the menu is shown as a tearoff menu. If Title is null, the menu will see if it is attached to a parent menu item, and if so it will try to use the same text as that menu item's label. Deprecated since 3.10, 1

Parameters

Menu
Title: a string containing the title for the menu, or null to inherit the title of the parent menu item, if any

Signal_Move_Scroll

Signal_Move_Scroll : constant Glib.Signal_Name := "move-scroll";

Signal_Popped_Up

Signal_Popped_Up : constant Glib.Signal_Name := "popped-up";

Emitted when the position of Menu is finalized after being popped up using gtk_menu_popup_at_rect (), gtk_menu_popup_at_widget (), or gtk_menu_popup_at_pointer ().

Menu might be flipped over the anchor rectangle in order to keep it on-screen, in which case Flipped_X and Flipped_Y will be set to True accordingly.

The blue menu is Menu's ideal position, the green menu is Flipped_Rect, and the red menu is Final_Rect.

Tearoff_State_Property

Tearoff_State_Property : constant Glib.Properties.Property_Boolean;

A boolean that indicates whether the menu is torn-off.

Tearoff_Title_Property

Tearoff_Title_Property : constant Glib.Properties.Property_String;

A title that may be displayed by the window manager when this menu is torn-off.