Menu

A gtk.Menu is a gtk.MenuShell that implements a drop down menu consisting of a list of gtk.MenuItem objects which can be navigated and activated by the user to perform application functions.

A gtk.Menu is most commonly dropped down by activating a gtk.MenuItem in a gtk.MenuBar or popped up by activating a gtk.MenuItem in another gtk.Menu

A gtk.Menu can also be popped up by activating a gtk.ComboBox Other composite widgets such as the gtk.Notebook can pop up a gtk.Menu as well.

Applications can display a gtk.Menu as a popup menu by calling the 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

|[<!-- language="plain" --> 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.
class Menu : MenuShell {}

Constructors

this
this(GtkMenu* gtkMenu, bool ownedRef)

Sets our main struct and passes it to the parent class.

this
this()

Creates a new gtk.Menu

this
this(MenuModel model)

Creates a gtk.Menu and populates it with menu items and submenus according to model.

Members

Functions

addOnMoveScroll
gulong addOnMoveScroll(void delegate(GtkScrollType, Menu) dlg, ConnectFlags connectFlags)
addOnPoppedUp
gulong addOnPoppedUp(void delegate(void*, void*, bool, bool, Menu) dlg, ConnectFlags connectFlags)

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

appendSubmenu
Menu appendSubmenu(string label)

Creates and append a submenu to this menu. This menu item that actualy has the sub menu is also created.

appendSubmenu
void appendSubmenu(string label, Menu submenu)
attach
void attach(Widget child, uint leftAttach, uint rightAttach, uint topAttach, uint bottomAttach)

Adds a new gtk.MenuItem 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).

attachToWidget
void attachToWidget(Widget attachWidget, GtkMenuDetachFunc detacher)

Attaches the menu to the widget and provides a callback function that will be invoked when the menu calls Menu.detach during its destruction.

detach
void detach()

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

getAccelGroup
AccelGroup getAccelGroup()

Gets the gtk.AccelGroup which holds global accelerators for the menu. See Menu.setAccelGroup.

getAccelPath
string getAccelPath()

Retrieves the accelerator path set on the menu.

getActive
Widget getActive()

Returns the selected menu item from the menu. This is used by the gtk.ComboBox

getAttachWidget
Widget getAttachWidget()

Returns the gtk.Widget that the menu is attached to.

getMenuStruct
GtkMenu* getMenuStruct(bool transferOwnership)

Get the main Gtk struct

getMonitor
int getMonitor()

Retrieves the number of the monitor on which to show the menu.

getReserveToggleSize
bool getReserveToggleSize()

Returns whether the menu reserves space for toggles and icons, regardless of their actual presence.

getStruct
void* getStruct()

the main Gtk struct as a void*

getTearoffState
bool getTearoffState()

Returns whether the menu is torn off. See Menu.setTearoffState.

getTitle
string getTitle()

Returns the title of the menu. See Menu.setTitle.

placeOnMonitor
void placeOnMonitor(MonitorG monitor)

Places menu on the given monitor.

popdown
void popdown()

Removes the menu from the screen.

popup
void popup(uint button, uint activateTime)

Popups up this menu

popup
void popup(Widget parentMenuShell, Widget parentMenuItem, GtkMenuPositionFunc func, void* data, uint button, uint activateTime)

Displays a menu and makes it available for selection.

popupAtPointer
void popupAtPointer(Event triggerEvent)

Displays menu and makes it available for selection.

popupAtRect
void popupAtRect(Window rectWindow, GdkRectangle* rect, GdkGravity rectAnchor, GdkGravity menuAnchor, Event triggerEvent)

Displays menu and makes it available for selection.

popupAtWidget
void popupAtWidget(Widget widget, GdkGravity widgetAnchor, GdkGravity menuAnchor, Event triggerEvent)

Displays menu and makes it available for selection.

popupForDevice
void popupForDevice(Device device, Widget parentMenuShell, Widget parentMenuItem, GtkMenuPositionFunc func, void* data, GDestroyNotify destroy, uint button, uint activateTime)

Displays a menu and makes it available for selection.

prependSubmenu
Menu prependSubmenu(string label)
reorderChild
void reorderChild(Widget child, int position)

Moves child to a new position in the list of menu children.

reposition
void reposition()

Repositions the menu according to its position function.

setAccelGroup
void setAccelGroup(AccelGroup accelGroup)

Set the gtk.AccelGroup 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 Window.addAccelGroup, in order for those windows to support all the accelerators contained in this group.

setAccelPath
void setAccelPath(string accelPath)

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 Menu.itemSetAccelPath on each menu item that should support runtime user changable accelerators. Instead, by just calling Menu.setAccelPath on their parent, each menu item of this menu, that contains a label describing its purpose, automatically gets an accel path assigned.

setActive
void setActive(uint index)

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

setMonitor
void setMonitor(int monitorNum)

Informs GTK+ on which monitor a menu should be popped up. See gdk_monitor_get_geometry().

setReserveToggleSize
void setReserveToggleSize(bool reserveToggleSize)

Sets whether the menu should reserve space for drawing toggles or icons, regardless of their actual presence.

setScreen
void setScreen(Screen screen)

Sets the gdk.Screen on which the menu will be displayed.

setTearoffState
void setTearoffState(bool tornOff)

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.

setTitle
void setTitle(string title)

Sets the title string for the menu.

Static functions

getForAttachWidget
ListG getForAttachWidget(Widget widget)

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

getType
GType getType()

Variables

gtkMenu
GtkMenu* gtkMenu;

the main Gtk struct

Inherited Members

From MenuShell

gtkMenuShell
GtkMenuShell* gtkMenuShell;

the main Gtk struct

getMenuShellStruct
GtkMenuShell* getMenuShellStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
activateItem
void activateItem(Widget menuItem, bool forceDeactivate)

Activates the menu item within the menu shell.

append
void append(MenuItem child)

Adds a new gtk.MenuItem to the end of the menu shell's item list.

bindModel
void bindModel(MenuModel model, string actionNamespace, bool withSeparators)

Establishes a binding between a gtk.MenuShell and a gio.MenuModel

cancel
void cancel()

Cancels the selection within the menu shell.

deactivate
void deactivate()

Deactivates the menu shell.

deselect
void deselect()

Deselects the currently selected item from the menu shell, if any.

getParentShell
Widget getParentShell()

Gets the parent menu shell.

getSelectedItem
Widget getSelectedItem()

Gets the currently selected item.

getTakeFocus
bool getTakeFocus()

Returns TRUE if the menu shell will take the keyboard focus on popup.

insert
void insert(Widget child, int position)

Adds a new gtk.MenuItem to the menu shell’s item list at the position indicated by position.

prepend
void prepend(Widget child)

Adds a new gtk.MenuItem to the beginning of the menu shell's item list.

selectFirst
void selectFirst(bool searchSensitive)

Select the first visible or selectable child of the menu shell; don’t select tearoff items unless the only item is a tearoff item.

selectItem
void selectItem(Widget menuItem)

Selects the menu item from the menu shell.

setTakeFocus
void setTakeFocus(bool takeFocus)

If take_focus is TRUE (the default) the menu shell will take the keyboard focus so that it will receive all keyboard events which is needed to enable keyboard navigation in menus.

addOnActivateCurrent
gulong addOnActivateCurrent(void delegate(bool, MenuShell) dlg, ConnectFlags connectFlags)

An action signal that activates the current menu item within the menu shell.

addOnCancel
gulong addOnCancel(void delegate(MenuShell) dlg, ConnectFlags connectFlags)

An action signal which cancels the selection within the menu shell. Causes the selection-done signal to be emitted.

addOnCycleFocus
gulong addOnCycleFocus(void delegate(GtkDirectionType, MenuShell) dlg, ConnectFlags connectFlags)

A keybinding signal which moves the focus in the given direction.

addOnDeactivate
gulong addOnDeactivate(void delegate(MenuShell) dlg, ConnectFlags connectFlags)

This signal is emitted when a menu shell is deactivated.

addOnInsert
gulong addOnInsert(void delegate(Widget, int, MenuShell) dlg, ConnectFlags connectFlags)

The ::insert signal is emitted when a new gtk.MenuItem is added to a gtk.MenuShell A separate signal is used instead of GtkContainer::add because of the need for an additional position parameter.

addOnMoveCurrent
gulong addOnMoveCurrent(void delegate(GtkMenuDirectionType, MenuShell) dlg, ConnectFlags connectFlags)

An keybinding signal which moves the current menu item in the direction specified by direction.

addOnMoveSelected
gulong addOnMoveSelected(bool delegate(int, MenuShell) dlg, ConnectFlags connectFlags)

The ::move-selected signal is emitted to move the selection to another item.

addOnSelectionDone
gulong addOnSelectionDone(void delegate(MenuShell) dlg, ConnectFlags connectFlags)

This signal is emitted when a selection has been completed within a menu shell.