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.

Constructors

this
this(void* ptr, Flag!"Take" take)

Members

Functions

activateItem
void activateItem(gtk.widget.Widget menuItem, bool forceDeactivate)

Activates the menu item within the menu shell.

append
void append(gtk.menu_item.MenuItem child)

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

bindModel
void bindModel(gio.menu_model.MenuModel model, string actionNamespace, bool withSeparators)

Establishes a binding between a #GtkMenuShell and a #GMenuModel.

cancel
void cancel()

Cancels the selection within the menu shell.

connectActivateCurrent
gulong connectActivateCurrent(T callback, Flag!"After" after)

Connect to ActivateCurrent signal.

connectCancel
gulong connectCancel(T callback, Flag!"After" after)

Connect to Cancel signal.

connectCycleFocus
gulong connectCycleFocus(T callback, Flag!"After" after)

Connect to CycleFocus signal.

connectDeactivate
gulong connectDeactivate(T callback, Flag!"After" after)

Connect to Deactivate signal.

connectInsert
gulong connectInsert(T callback, Flag!"After" after)

Connect to Insert signal.

connectMoveCurrent
gulong connectMoveCurrent(T callback, Flag!"After" after)

Connect to MoveCurrent signal.

connectMoveSelected
gulong connectMoveSelected(T callback, Flag!"After" after)

Connect to MoveSelected signal.

connectSelectionDone
gulong connectSelectionDone(T callback, Flag!"After" after)

Connect to SelectionDone signal.

deactivate
void deactivate()

Deactivates the menu shell.

deselect
void deselect()

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

getParentShell
gtk.widget.Widget getParentShell()

Gets the parent menu shell.

getSelectedItem
gtk.widget.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(gtk.widget.Widget child, int position)

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

prepend
void prepend(gtk.widget.Widget child)

Adds a new #GtkMenuItem 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(gtk.widget.Widget menuItem)

Selects the menu item from the menu shell.

self
MenuShell self()

Returns this, for use in with statements.

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.

Properties

_gType
GType _gType [@property getter]
takeFocus
bool takeFocus [@property getter]

Get takeFocus property.

takeFocus
bool takeFocus [@property setter]

Set takeFocus property.

Static functions

_getGType
GType _getGType()
builder
MenuShellGidBuilder builder()

Get builder for gtk.menu_shell.MenuShell

Inherited Members

From Container

_getGType
GType _getGType()
_gType
GType _gType [@property getter]
self
Container self()

Returns this, for use in with statements.

builder
ContainerGidBuilder builder()

Get builder for gtk.container.Container

borderWidth
uint borderWidth [@property getter]
borderWidth
uint borderWidth [@property setter]
child
gtk.widget.Widget child [@property setter]
resizeMode
gtk.types.ResizeMode resizeMode [@property getter]
resizeMode
gtk.types.ResizeMode resizeMode [@property setter]
add
void add(gtk.widget.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.Box.packStart and gtk.grid.Grid.attach as an alternative to gtk.container.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.

checkResize
void checkResize()
childGetProperty
void childGetProperty(gtk.widget.Widget child, string propertyName, gobject.value.Value value)

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

childNotify
void childNotify(gtk.widget.Widget child, string childProperty)

Emits a #GtkWidget::child-notify signal for the [child property][child-properties] child_property on the child.

childNotifyByPspec
void childNotifyByPspec(gtk.widget.Widget child, gobject.param_spec.ParamSpec pspec)

Emits a #GtkWidget::child-notify signal for the [child property][child-properties] specified by pspec on the child.

childSetProperty
void childSetProperty(gtk.widget.Widget child, string propertyName, gobject.value.Value value)

Sets a child property for child and container.

childType
gobject.types.GType childType()

Returns the type of the children supported by the container.

forall
void forall(gtk.types.Callback callback)

Invokes callback on each direct 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.

foreach_
void foreach_(gtk.types.Callback callback)

Invokes callback on each non-internal child of container. See gtk.container.Container.forall for details on what constitutes an “internal” child. For all practical purposes, this function should iterate over precisely those child widgets that were added to the container by the application with explicit add() calls.

getBorderWidth
uint getBorderWidth()

Retrieves the border width of the container. See gtk.container.Container.setBorderWidth.

getChildren
gtk.widget.Widget[] getChildren()

Returns the container’s non-internal children. See gtk.container.Container.forall for details on what constitutes an "internal" child.

getFocusChain
bool getFocusChain(gtk.widget.Widget[] 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.

getFocusChild
gtk.widget.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.Window.getFocus.

getFocusHadjustment
gtk.adjustment.Adjustment getFocusHadjustment()

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

getFocusVadjustment
gtk.adjustment.Adjustment getFocusVadjustment()

Retrieves the vertical focus adjustment for the container. See gtk.container.Container.setFocusVadjustment.

getPathForChild
gtk.widget_path.WidgetPath getPathForChild(gtk.widget.Widget child)

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

getResizeMode
gtk.types.ResizeMode getResizeMode()

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

propagateDraw
void propagateDraw(gtk.widget.Widget child, cairo.context.Context cr)

When a container receives a call to the draw function, it must send synthetic #GtkWidget::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 #GtkWidget::draw function, calls gtk.container.Container.propagateDraw once for each child, passing in the cr the container received.

remove
void remove(gtk.widget.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 before removing it from a container, using gobject.object.ObjectWrap.ref_. If you don’t want to use widget again it’s usually more efficient to simply destroy it directly using gtk.widget.Widget.destroy since this will remove it from the container and help break any circular reference count cycles.

resizeChildren
void resizeChildren()
setBorderWidth
void setBorderWidth(uint borderWidth)

Sets the border width of the container.

setFocusChain
void setFocusChain(gtk.widget.Widget[] focusableWidgets)

Sets a focus chain, overriding the one computed automatically by GTK+.

setFocusChild
void setFocusChild(gtk.widget.Widget child)

Sets, or unsets if child is null, the focused child of container.

setFocusHadjustment
void setFocusHadjustment(gtk.adjustment.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.ScrolledWindow.getHadjustment for a typical way of obtaining the adjustment and gtk.container.Container.setFocusVadjustment for setting the vertical adjustment.

setFocusVadjustment
void setFocusVadjustment(gtk.adjustment.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.ScrolledWindow.getVadjustment for a typical way of obtaining the adjustment and gtk.container.Container.setFocusHadjustment for setting the horizontal adjustment.

setReallocateRedraws
void setReallocateRedraws(bool needsRedraws)

Sets the reallocate_redraws flag of the container to the given value.

setResizeMode
void setResizeMode(gtk.types.ResizeMode resizeMode)

Sets the resize mode for the container.

unsetFocusChain
void unsetFocusChain()

Removes a focus chain explicitly set with gtk.container.Container.setFocusChain.

connectAdd
gulong connectAdd(T callback, Flag!"After" after)

Connect to Add signal.

connectCheckResize
gulong connectCheckResize(T callback, Flag!"After" after)

Connect to CheckResize signal.

connectRemove
gulong connectRemove(T callback, Flag!"After" after)

Connect to Remove signal.

connectSetFocusChild
gulong connectSetFocusChild(T callback, Flag!"After" after)

Connect to SetFocusChild signal.