MenuShell

A GtkMenuShell is the abstract base class used to derive the GtkMenu and GtkMenuBar subclasses.

A GtkMenuShell is a container of GtkMenuItem objects arranged in a list which can be navigated, selected, and activated by the user to perform application functions. A GtkMenuItem can have a submenu associated with it, allowing for nested hierarchical menus.

Terminology

A menu item can be "selected", this means that it is displayed in the prelight state, and if it has a submenu, that submenu will be popped up.

A menu is "active" when it is visible onscreen and the user is selecting from it. A menubar is not active until the user clicks on one of its menuitems. When a menu is active, passing the mouse over a submenu will pop it up.

There is also is a concept of the current menu and a current menu item. The current menu item is the selected menu item that is furthest down in the hierarchy. (Every active menu shell does not necessarily contain a selected menu item, but if it does, then the parent menu shell must also contain a selected menu item.) The current menu is the menu that contains the current menu item. It will always have a GTK grab and receive all key presses.

class MenuShell : Container {}

Constructors

this
this(GtkMenuShell* gtkMenuShell)

Sets our main struct and passes it to the parent class

Members

Functions

activateItem
void activateItem(Widget menuItem, int forceDeactivate)

Activates the menu item within the menu shell.

addOnActivateCurrent
void addOnActivateCurrent(void delegate(gboolean, MenuShell) dlg, ConnectFlags connectFlags)

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

addOnCancel
void 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
void addOnCycleFocus(void delegate(GtkDirectionType, MenuShell) dlg, ConnectFlags connectFlags)

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

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

This signal is emitted when a menu shell is deactivated.

addOnInsert
void addOnInsert(void delegate(Widget, gint, MenuShell) dlg, ConnectFlags connectFlags)

The ::insert signal is emitted when a new GtkMenuItem is added to a GtkMenuShell. A separate signal is used instead of GtkContainer::add because of the need for an additional position parameter. The inverse of this signal is the GtkContainer::removed signal. Since 3.2

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

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

addOnMoveSelected
void addOnMoveSelected(bool delegate(gint, MenuShell) dlg, ConnectFlags connectFlags)

The ::move-selected signal is emitted to move the selection to another item. TRUE to stop the signal emission, FALSE to continue Since 2.12

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

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

append
void append(Widget child)

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

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

Establishes a binding between a GtkMenuShell and a GMenuModel. The contents of shell are removed and then refilled with menu items according to model. When model changes, shell is updated. Calling this function twice on shell with different model will cause the first binding to be replaced with a binding to the new model. If model is NULL then any previous binding is undone and all children are removed. with_separators determines if toplevel items (eg: sections) have separators inserted between them. This is typically desired for menus but doesn't make sense for menubars. If action_namespace is non-NULL then the effect is as if all actions mentioned in the model have their names prefixed with the namespace, plus a dot. For example, if the action "quit" is mentioned and action_namespace is "app" then the effective action name is "app.quit". This function uses GtkActionable to define the action name and target values on the created menu items. If you want to use an action group other than "app" and "win", or if you want to use a GtkMenuShell outside of a GtkApplicationWindow, then you will need to attach your own action group to the widget hierarchy using gtk_widget_insert_action_group(). As an example, if you created a group with a "quit" action and inserted it with the name "mygroup" then you would use the action name "mygroup.quit" in your GMenuModel. For most cases you are probably better off using gtk_menu_new_from_model() or gtk_menu_bar_new_from_model() or just directly passing the GMenuModel to gtk_application_set_app_menu() or gtk_application_set_menu_bar().

cancel
void cancel()

Cancels the selection within the menu shell. Since 2.4

deactivate
void deactivate()

Deactivates the menu shell. Typically this results in the menu shell being erased from the screen.

deselect
void deselect()

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

getMenuShellStruct
GtkMenuShell* getMenuShellStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getParentShell
Widget getParentShell()

Gets the parent menu shell. The parent menu shell of a submenu is the GtkMenu or GtkMenuBar from which it was opened up.

getSelectedItem
Widget getSelectedItem()

Gets the currently selected item.

getStruct
void* getStruct()

the main Gtk struct as a void*

getTakeFocus
int getTakeFocus()

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

insert
void insert(Widget child, int position)

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

prepend
void prepend(Widget child)

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

selectFirst
void selectFirst(int 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. Since 2.2

selectItem
void selectItem(Widget menuItem)

Selects the menu item from the menu shell.

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
setTakeFocus
void setTakeFocus(int 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. Setting take_focus to FALSE is useful only for special applications like virtual keyboard implementations which should not take keyboard focus. The take_focus state of a menu or menu bar is automatically propagated to submenus whenever a submenu is popped up, so you don't have to worry about recursively setting it for your entire menu hierarchy. Only when programmatically picking a submenu and popping it up manually, the take_focus property of the submenu needs to be set explicitely. Since 2.8

Static functions

callBackActivateCurrent
void callBackActivateCurrent(GtkMenuShell* menushellStruct, gboolean forceHide, MenuShell _menuShell)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackCancel
void callBackCancel(GtkMenuShell* menushellStruct, MenuShell _menuShell)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackCycleFocus
void callBackCycleFocus(GtkMenuShell* menushellStruct, GtkDirectionType direction, MenuShell _menuShell)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackDeactivate
void callBackDeactivate(GtkMenuShell* menushellStruct, MenuShell _menuShell)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackInsert
void callBackInsert(GtkMenuShell* menuShellStruct, GtkWidget* child, gint position, MenuShell _menuShell)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackMoveCurrent
void callBackMoveCurrent(GtkMenuShell* menushellStruct, GtkMenuDirectionType direction, MenuShell _menuShell)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackMoveSelected
gboolean callBackMoveSelected(GtkMenuShell* menuShellStruct, gint distance, MenuShell _menuShell)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackSelectionDone
void callBackSelectionDone(GtkMenuShell* menushellStruct, MenuShell _menuShell)
Undocumented in source. Be warned that the author may not have intended to support it.

Variables

connectedSignals
int[string] connectedSignals;
gtkMenuShell
GtkMenuShell* gtkMenuShell;

the main Gtk struct

onActivateCurrentListeners
void delegate(gboolean, MenuShell)[] onActivateCurrentListeners;
Undocumented in source.
onCancelListeners
void delegate(MenuShell)[] onCancelListeners;
Undocumented in source.
onCycleFocusListeners
void delegate(GtkDirectionType, MenuShell)[] onCycleFocusListeners;
Undocumented in source.
onDeactivateListeners
void delegate(MenuShell)[] onDeactivateListeners;
Undocumented in source.
onInsertListeners
void delegate(Widget, gint, MenuShell)[] onInsertListeners;
Undocumented in source.
onMoveCurrentListeners
void delegate(GtkMenuDirectionType, MenuShell)[] onMoveCurrentListeners;
Undocumented in source.
onMoveSelectedListeners
bool delegate(gint, MenuShell)[] onMoveSelectedListeners;
Undocumented in source.
onSelectionDoneListeners
void delegate(MenuShell)[] onSelectionDoneListeners;
Undocumented in source.

Inherited Members

From Container

gtkContainer
GtkContainer* gtkContainer;

the main Gtk struct

getContainerStruct
GtkContainer* getContainerStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
removeAll
void removeAll()

Removes all widgets from the container

connectedSignals
int[string] connectedSignals;
onAddListeners
void delegate(Widget, Container)[] onAddListeners;
Undocumented in source.
addOnAdd
void addOnAdd(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackAdd
void callBackAdd(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onCheckResizeListeners
void delegate(Container)[] onCheckResizeListeners;
Undocumented in source.
addOnCheckResize
void addOnCheckResize(void delegate(Container) dlg, ConnectFlags connectFlags)
callBackCheckResize
void callBackCheckResize(GtkContainer* containerStruct, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onRemoveListeners
void delegate(Widget, Container)[] onRemoveListeners;
Undocumented in source.
addOnRemove
void addOnRemove(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackRemove
void callBackRemove(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onSetFocusChildListeners
void delegate(Widget, Container)[] onSetFocusChildListeners;
Undocumented in source.
addOnSetFocusChild
void addOnSetFocusChild(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackSetFocusChild
void callBackSetFocusChild(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
add
void add(Widget widget)

Adds widget to container. Typically used for simple containers such as GtkWindow, GtkFrame, or GtkButton; for more complicated layout containers such as GtkBox or GtkGrid, this function will pick default packing parameters that may not be correct. So consider functions such as gtk_box_pack_start() and gtk_grid_attach() as an alternative to gtk_container_add() in those cases. A widget may be added to only one container at a time; you can't place the same widget inside two different containers.

remove
void remove(Widget widget)

Removes widget from container. widget must be inside container. Note that container will own a reference to widget, and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use widget again, you need to add a reference to it while it's not inside a container, using g_object_ref(). If you don't want to use widget again it's usually more efficient to simply destroy it directly using gtk_widget_destroy() since this will remove it from the container and help break any circular reference count cycles.

getResizeMode
GtkResizeMode getResizeMode()

Returns the resize mode for the container. See gtk_container_set_resize_mode().

setResizeMode
void setResizeMode(GtkResizeMode resizeMode)

Sets the resize mode for the container. The resize mode of a container determines whether a resize request will be passed to the container's parent, queued for later execution or executed immediately.

checkResize
void checkResize()
foreac
void foreac(GtkCallback callback, void* callbackData)

Invokes callback on each non-internal child of container. See gtk_container_forall() for details on what constitutes an "internal" child. Most applications should use gtk_container_foreach(), rather than gtk_container_forall().

getChildren
ListG getChildren()

Returns the container's non-internal children. See gtk_container_forall() for details on what constitutes an "internal" child.

getPathForChild
WidgetPath getPathForChild(Widget child)

Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child.

setReallocateRedraws
void setReallocateRedraws(int needsRedraws)

Sets the reallocate_redraws flag of the container to the given value. Containers requesting reallocation redraws get automatically redrawn if any of their children changed allocation.

getFocusChild
Widget getFocusChild()

Returns the current focus child widget inside container. This is not the currently focused widget. That can be obtained by calling gtk_window_get_focus(). Since 2.14

setFocusChild
void setFocusChild(Widget child)

Sets, or unsets if child is NULL, the focused child of container. This function emits the GtkContainer::set_focus_child signal of container. Implementations of GtkContainer can override the default behaviour by overriding the class closure of this signal. This is function is mostly meant to be used by widgets. Applications can use gtk_widget_grab_focus() to manualy set the focus to a specific widget.

getFocusVadjustment
Adjustment getFocusVadjustment()

Retrieves the vertical focus adjustment for the container. See gtk_container_set_focus_vadjustment().

setFocusVadjustment
void setFocusVadjustment(Adjustment adjustment)

Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the vertical alignment. See gtk_scrolled_window_get_vadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_hadjustment() for setting the horizontal adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

getFocusHadjustment
Adjustment getFocusHadjustment()

Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment().

setFocusHadjustment
void setFocusHadjustment(Adjustment adjustment)

Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the horizontal alignment. See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_vadjustment() for setting the vertical adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

resizeChildren
void resizeChildren()

Warning gtk_container_resize_children is deprecated and should not be used in newly-written code. 3.10

childType
GType childType()

Returns the type of the children supported by the container. Note that this may return G_TYPE_NONE to indicate that no more children can be added, e.g. for a GtkPaned which already has two children.

childGetProperty
void childGetProperty(Widget child, string propertyName, Value value)

Gets the value of a child property for child and container.

childSetProperty
void childSetProperty(Widget child, string propertyName, Value value)

Sets a child property for child and container.

childGetValist
void childGetValist(Widget child, string firstPropertyName, void* varArgs)

Gets the values of one or more child properties for child and container.

childSetValist
void childSetValist(Widget child, string firstPropertyName, void* varArgs)

Sets one or more child properties for child and container.

childNotify
void childNotify(Widget child, string childProperty)

Emits a "child-notify" signal for the child property child_property on widget. This is an analogue of g_object_notify() for child properties. Also see gtk_widget_child_notify().

forall
void forall(GtkCallback callback, void* callbackData)

Invokes callback on each child of container, including children that are considered "internal" (implementation details of the container). "Internal" children generally weren't added by the user of the container, but were added by the container implementation itself. Most applications should use gtk_container_foreach(), rather than gtk_container_forall(). Virtual: forall

getBorderWidth
uint getBorderWidth()

Retrieves the border width of the container. See gtk_container_set_border_width().

setBorderWidth
void setBorderWidth(uint borderWidth)

Sets the border width of the container. The border width of a container is the amount of space to leave around the outside of the container. The only exception to this is GtkWindow; because toplevel windows can't leave space outside, they leave the space inside. The border is added on all sides of the container. To add space to only one side, one approach is to create a GtkAlignment widget, call gtk_widget_set_size_request() to give it a size, and place it on the side of the container as a spacer.

propagateDraw
void propagateDraw(Widget child, Context cr)

When a container receives a call to the draw function, it must send synthetic "draw" calls to all children that don't have their own GdkWindows. This function provides a convenient way of doing this. A container, when it receives a call to its "draw" function, calls gtk_container_propagate_draw() once for each child, passing in the cr the container received. gtk_container_propagate_draw() takes care of translating the origin of cr, and deciding whether the draw needs to be sent to the child. It is a convenient and optimized way of getting the same effect as calling gtk_widget_draw() on the child directly. In most cases, a container can simply either inherit the "draw" implementation from GtkContainer, or do some drawing and then chain to the ::draw implementation from GtkContainer.

getFocusChain
int getFocusChain(ListG focusableWidgets)

Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, GTK+ computes the focus chain based on the positions of the children. In that case, GTK+ stores NULL in focusable_widgets and returns FALSE.

setFocusChain
void setFocusChain(ListG focusableWidgets)

Sets a focus chain, overriding the one computed automatically by GTK+. In principle each widget in the chain should be a descendant of the container, but this is not enforced by this method, since it's allowed to set the focus chain before you pack the widgets, or have a widget in the chain that isn't always packed. The necessary checks are done when the focus chain is actually traversed.

unsetFocusChain
void unsetFocusChain()

Removes a focus chain explicitly set with gtk_container_set_focus_chain().

classFindChildProperty
ParamSpec classFindChildProperty(GObjectClass* cclass, string propertyName)

Finds a child property of a container class by name.

classInstallChildProperty
void classInstallChildProperty(GtkContainerClass* cclass, uint propertyId, ParamSpec pspec)

Installs a child property on a container class.

classListChildProperties
ParamSpec[] classListChildProperties(GObjectClass* cclass)

Returns all child properties of a container class.

classHandleBorderWidth
void classHandleBorderWidth(GtkContainerClass* klass)

Modifies a subclass of GtkContainerClass to automatically add and remove the border-width setting on GtkContainer. This allows the subclass to ignore the border width in its size request and allocate methods. The intent is for a subclass to invoke this in its class_init function. gtk_container_class_handle_border_width() is necessary because it would break API too badly to make this behavior the default. So subclasses must "opt in" to the parent class handling border_width for them.

Meta