## GtkMenu

GtkMenu — a drop down menu widget.

## Synopsis

    #include <gtk/gtk.h>

    struct      GtkMenu;
    GtkWidget*  gtk_menu_new                    (void);
    void        gtk_menu_set_screen             (GtkMenu *menu,
                                                 GdkScreen *screen);
    #define     gtk_menu_append                 (menu,child)
    #define     gtk_menu_prepend                (menu,child)
    #define     gtk_menu_insert                 (menu,child,pos)
    void        gtk_menu_reorder_child          (GtkMenu *menu,
                                                 GtkWidget *child,
                                                 gint position);
    void        gtk_menu_popup                  (GtkMenu *menu,
                                                 GtkWidget *parent_menu_shell,
                                                 GtkWidget *parent_menu_item,
                                                 GtkMenuPositionFunc func,
                                                 gpointer data,
                                                 guint button,
                                                 guint32 activate_time);
    void        gtk_menu_set_accel_group        (GtkMenu *menu,
                                                 GtkAccelGroup *accel_group);
    GtkAccelGroup* gtk_menu_get_accel_group     (GtkMenu *menu);
    void        gtk_menu_set_accel_path         (GtkMenu *menu,
                                                 const gchar *accel_path);
    void        gtk_menu_set_title              (GtkMenu *menu,
                                                 const gchar *title);
    gboolean    gtk_menu_get_tearoff_state      (GtkMenu *menu);
    G_CONST_RETURN gchar* gtk_menu_get_title    (GtkMenu *menu);

    void        gtk_menu_popdown                (GtkMenu *menu);
    void        gtk_menu_reposition             (GtkMenu *menu);
    GtkWidget*  gtk_menu_get_active             (GtkMenu *menu);
    void        gtk_menu_set_active             (GtkMenu *menu,
                                                 guint index_);
    void        gtk_menu_set_tearoff_state      (GtkMenu *menu,
                                                 gboolean torn_off);
    void        gtk_menu_attach_to_widget       (GtkMenu *menu,
                                                 GtkWidget *attach_widget,
                                                 GtkMenuDetachFunc detacher);
    void        gtk_menu_detach                 (GtkMenu *menu);
    GtkWidget*  gtk_menu_get_attach_widget      (GtkMenu *menu);
    void        (*GtkMenuPositionFunc)          (GtkMenu *menu,
                                                 gint *x,
                                                 gint *y,
                                                 gboolean *push_in,
                                                 gpointer user_data);
    void        (*GtkMenuDetachFunc)            (GtkWidget *attach_widget,
                                                 GtkMenu *menu);

## Object Hierarchy

      GObject
       +----GtkObject
             +----GtkWidget
                   +----GtkContainer
                         +----GtkMenuShell
                               +----GtkMenu

## Implemented Interfaces

GtkMenu implements AtkImplementorIface.

## Properties

      "tearoff-title"        gchararray           : Read / Write

## Signal Prototypes

    "move-scroll"
                void        user_function      (GtkMenu *menu,
                                                GtkScrollType arg1,
                                                gpointer user_data);

## Description

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

Example 3. Connecting the popup signal handler.

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

Example 4. 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 == 3)
    	{
    	  gtk_menu_popup (menu, NULL, NULL, NULL, NULL,
    			  event_button->button, event_button->time);
    	  return TRUE;
    	}
        }

      return FALSE;
    }

## Details

### struct GtkMenu

    struct GtkMenu;

The GtkMenu struct contains private data only, and should be accessed using the functions below.

### gtk_menu_new ()

    GtkWidget*  gtk_menu_new                    (void);

Creates a new GtkMenu.

Returns : | a new GtkMenu.

### gtk_menu_set_screen ()

    void        gtk_menu_set_screen             (GtkMenu *menu,
                                                 GdkScreen *screen);

Sets the GdkScreen on which the menu will be displayed.

`menu` : | a GtkMenu.
`screen` : | a GdkScreen, or `NULL` if the screen should be determined by the widget the menu is attached to.

Since 2.2

### gtk_menu_append()

    #define gtk_menu_append(menu,child)	gtk_menu_shell_append  ((GtkMenuShell *)(menu),(child))

### Warning

`gtk_menu_append` is deprecated and should not be used in newly-written code.

Adds a new GtkMenuItem to the end of the menu's item list.

`menu` : | a GtkMenu.
`child` : | The GtkMenuItem to add.

### gtk_menu_prepend()

    #define gtk_menu_prepend(menu,child)    gtk_menu_shell_prepend ((GtkMenuShell *)(menu),(child))

### Warning

`gtk_menu_prepend` is deprecated and should not be used in newly-written code.

Adds a new GtkMenuItem to the beginning of the menu's item list.

`menu` : | a GtkMenu.
`child` : | The GtkMenuItem to add.

### gtk_menu_insert()

    #define gtk_menu_insert(menu,child,pos)	gtk_menu_shell_insert ((GtkMenuShell *)(menu),(child),(pos))

### Warning

`gtk_menu_insert` is deprecated and should not be used in newly-written code.

Adds a new GtkMenuItem to the menu's item list at the position indicated by `position`.

`menu` : | a GtkMenu.
`child` : | The GtkMenuItem to add.
`pos` : |

### gtk_menu_reorder_child ()

    void        gtk_menu_reorder_child          (GtkMenu *menu,
                                                 GtkWidget *child,
                                                 gint position);

Moves a GtkMenuItem to a new position within the GtkMenu.

`menu` : | a GtkMenu.
`child` : | the GtkMenuItem to move.
`position` : | the new position to place `child`. Positions are numbered from 0 to n-1.

### gtk_menu_popup ()

    void        gtk_menu_popup                  (GtkMenu *menu,
                                                 GtkWidget *parent_menu_shell,
                                                 GtkWidget *parent_menu_item,
                                                 GtkMenuPositionFunc func,
                                                 gpointer data,
                                                 guint button,
                                                 guint32 activate_time);

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 should be the time stamp of the event that initiated the popup. If such an event is not available, use `gtk_get_current_event_time()` instead.

`menu` : | a GtkMenu.
`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`
`data` : | user supplied data to be passed to `func`.
`button` : | the mouse button which was pressed to initiate the event.
`activate_time` : | the time at which the activation event occurred.

### gtk_menu_set_accel_group ()

    void        gtk_menu_set_accel_group        (GtkMenu *menu,
                                                 GtkAccelGroup *accel_group);

Set the GtkAccelGroup 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.

`menu` : | a GtkMenu.
`accel_group` : | the GtkAccelGroup to be associated with the menu.

### gtk_menu_get_accel_group ()

    GtkAccelGroup* gtk_menu_get_accel_group     (GtkMenu *menu);

Gets the GtkAccelGroup which holds global accelerators for the menu. See `gtk_menu_set_accel_group()`.

`menu` : | a GtkMenu.
Returns : | the GtkAccelGroup associated with the menu.

### gtk_menu_set_accel_path ()

    void        gtk_menu_set_accel_path         (GtkMenu *menu,
                                                 const gchar *accel_path);

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()`.

`menu` : | a valid GtkMenu
`accel_path` : | a valid accelerator path

### gtk_menu_set_title ()

    void        gtk_menu_set_title              (GtkMenu *menu,
                                                 const gchar *title);

Sets the title string for the menu. The title is displayed when the menu is shown as a tearoff menu.

`menu` : | a GtkMenu
`title` : | a string containing the title for the menu.

### gtk_menu_get_tearoff_state ()

    gboolean    gtk_menu_get_tearoff_state      (GtkMenu *menu);

Returns whether the menu is torn off. See `gtk_menu_set_tearoff_state()`.

`menu` : | a GtkMenu
Returns : | `TRUE` if the menu is currently torn off.

### gtk_menu_get_title ()

    G_CONST_RETURN gchar* gtk_menu_get_title    (GtkMenu *menu);

Returns the title of the menu. See `gtk_menu_set_title()`.

`menu` : | a GtkMenu
Returns : | the title of the menu, or `NULL` if the menu has no title set on it. This string is owned by the widget and should not be modified or freed.

### gtk_menu_popdown ()

    void        gtk_menu_popdown                (GtkMenu *menu);

Removes the menu from the screen.

`menu` : | a GtkMenu.

### gtk_menu_reposition ()

    void        gtk_menu_reposition             (GtkMenu *menu);

Repositions the menu according to its position function.

`menu` : | a GtkMenu.

### gtk_menu_get_active ()

    GtkWidget*  gtk_menu_get_active             (GtkMenu *menu);

Returns the selected menu item from the menu. This is used by the GtkOptionMenu.

`menu` : | a GtkMenu.
Returns : | the GtkMenuItem that was last selected in the menu. If a selection has not yet been made, the first menu item is selected.

### gtk_menu_set_active ()

    void        gtk_menu_set_active             (GtkMenu *menu,
                                                 guint index_);

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

`menu` : | a GtkMenu.
`index_` : | the index of the menu item to select. Index values are from 0 to n-1.

### gtk_menu_set_tearoff_state ()

    void        gtk_menu_set_tearoff_state      (GtkMenu *menu,
                                                 gboolean torn_off);

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.

`menu` : | a GtkMenu.
`torn_off` : | If `TRUE`, menu is displayed as a tearoff menu.

### gtk_menu_attach_to_widget ()

    void        gtk_menu_attach_to_widget       (GtkMenu *menu,
                                                 GtkWidget *attach_widget,
                                                 GtkMenuDetachFunc detacher);

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.

`menu` : | a GtkMenu.
`attach_widget` : | the GtkWidget that the menu will be attached to.
`detacher` : | the user supplied callback function that will be called when the menu calls `gtk_menu_detach()`.

### gtk_menu_detach ()

    void        gtk_menu_detach                 (GtkMenu *menu);

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.

`menu` : | a GtkMenu.

### gtk_menu_get_attach_widget ()

    GtkWidget*  gtk_menu_get_attach_widget      (GtkMenu *menu);

Returns the GtkWidget that the menu is attached to.

`menu` : | a GtkMenu.
Returns : | the GtkWidget that the menu is attached to.

### GtkMenuPositionFunc ()

    void        (*GtkMenuPositionFunc)          (GtkMenu *menu,
                                                 gint *x,
                                                 gint *y,
                                                 gboolean *push_in,
                                                 gpointer user_data);

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.

`menu` : | a GtkMenu.
`x` : | address of the gint representing the horizontal position where the menu shall be drawn. This is an output parameter.
`y` : | address of the gint representing the vertical position where the menu shall be drawn. This is an output parameter.
`push_in` : |
`user_data` : | the data supplied by the user in the `gtk_menu_popup()` `data` parameter.

### GtkMenuDetachFunc ()

    void        (*GtkMenuDetachFunc)            (GtkWidget *attach_widget,
                                                 GtkMenu *menu);

A user function supplied when calling `gtk_menu_attach_to_widget()` which will be called when the menu is later detached from the widget.

`attach_widget` : | the GtkWidget that the menu is being detached from.
`menu` : | the GtkMenu being detached.

## Properties

"`tearoff-title`" (gchararray : Read / Write) | A title that may be displayed by the window manager when this menu is torn-off.

## Signals

### The "move-scroll" signal

    void        user_function                  (GtkMenu *menu,
                                                GtkScrollType arg1,
                                                gpointer user_data);

`menu` : | the object which received the signal.
`arg1` : |
`user_data` : | user data set when the signal handler was connected.