- activateItem
void activateItem(Widget menuItem, bool forceDeactivate)
Activates the menu item within the menu shell.
- 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 #GtkMenuShell::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 #GtkMenuItem is added to
a #GtkMenuShell. 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.
- append
void append(MenuItem child)
Adds a new #GtkMenuItem to the end of the menu shell's
item list.
- bindModel
void bindModel(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.
- deactivate
void deactivate()
Deactivates the menu shell.
- deselect
void deselect()
Deselects the currently selected item from the menu shell,
if any.
- getMenuShellStruct
GtkMenuShell* getMenuShellStruct(bool transferOwnership)
- getParentShell
Widget getParentShell()
Gets the parent menu shell.
- getSelectedItem
Widget getSelectedItem()
Gets the currently selected item.
- getStruct
void* getStruct()
the main Gtk struct as a void*
- 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 #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(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.
- setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
- 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.
- callBackActivateCurrent
void callBackActivateCurrent(GtkMenuShell* menushellStruct, bool forceHide, OnActivateCurrentDelegateWrapper wrapper)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackActivateCurrentDestroy
void callBackActivateCurrentDestroy(OnActivateCurrentDelegateWrapper wrapper, GClosure* closure)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackCancel
void callBackCancel(GtkMenuShell* menushellStruct, OnCancelDelegateWrapper wrapper)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackCancelDestroy
void callBackCancelDestroy(OnCancelDelegateWrapper wrapper, GClosure* closure)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackCycleFocus
void callBackCycleFocus(GtkMenuShell* menushellStruct, GtkDirectionType direction, OnCycleFocusDelegateWrapper wrapper)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackCycleFocusDestroy
void callBackCycleFocusDestroy(OnCycleFocusDelegateWrapper wrapper, GClosure* closure)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackDeactivate
void callBackDeactivate(GtkMenuShell* menushellStruct, OnDeactivateDelegateWrapper wrapper)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackDeactivateDestroy
void callBackDeactivateDestroy(OnDeactivateDelegateWrapper wrapper, GClosure* closure)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackInsert
void callBackInsert(GtkMenuShell* menushellStruct, GtkWidget* child, int position, OnInsertDelegateWrapper wrapper)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackInsertDestroy
void callBackInsertDestroy(OnInsertDelegateWrapper wrapper, GClosure* closure)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackMoveCurrent
void callBackMoveCurrent(GtkMenuShell* menushellStruct, GtkMenuDirectionType direction, OnMoveCurrentDelegateWrapper wrapper)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackMoveCurrentDestroy
void callBackMoveCurrentDestroy(OnMoveCurrentDelegateWrapper wrapper, GClosure* closure)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackMoveSelected
int callBackMoveSelected(GtkMenuShell* menushellStruct, int distance, OnMoveSelectedDelegateWrapper wrapper)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackMoveSelectedDestroy
void callBackMoveSelectedDestroy(OnMoveSelectedDelegateWrapper wrapper, GClosure* closure)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackSelectionDone
void callBackSelectionDone(GtkMenuShell* menushellStruct, OnSelectionDoneDelegateWrapper wrapper)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackSelectionDoneDestroy
void callBackSelectionDoneDestroy(OnSelectionDoneDelegateWrapper wrapper, GClosure* closure)
Undocumented in source. Be warned that the author may not have intended to support it.
- getType
GType getType()
- gtkContainer
GtkContainer* gtkContainer;
- getContainerStruct
GtkContainer* getContainerStruct(bool transferOwnership)
- 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
- getType
GType getType()
- 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.
- checkResize
void checkResize()
- childGetProperty
void childGetProperty(Widget child, string propertyName, Value value)
Gets the value of 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.
- childNotify
void childNotify(Widget child, string childProperty)
Emits a #GtkWidget::child-notify signal for the
[child property][child-properties]
@child_property on the child.
- childNotifyByPspec
void childNotifyByPspec(Widget child, ParamSpec pspec)
Emits a #GtkWidget::child-notify signal for the
[child property][child-properties] specified by
@pspec on the child.
- childSetProperty
void childSetProperty(Widget child, string propertyName, Value value)
Sets a child property for @child and @container.
- childSetValist
void childSetValist(Widget child, string firstPropertyName, void* varArgs)
Sets one or more child properties for @child and @container.
- childType
GType childType()
Returns the type of the children supported by the container.
- forall
void forall(GtkCallback callback, void* callbackData)
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.
- 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. 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_set_border_width().
- getChildren
ListG getChildren()
Returns the container’s non-internal children. See
gtk_container_forall() for details on what constitutes an "internal" child.
- getFocusChain
bool 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.
- 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().
- getFocusHadjustment
Adjustment getFocusHadjustment()
Retrieves the horizontal focus adjustment for the container. See
gtk_container_set_focus_hadjustment ().
- getFocusVadjustment
Adjustment getFocusVadjustment()
Retrieves the vertical focus adjustment for the container. See
gtk_container_set_focus_vadjustment().
- getPathForChild
WidgetPath getPathForChild(Widget child)
Returns a newly created widget path representing all the widget hierarchy
from the toplevel down to and including @child.
- getResizeMode
GtkResizeMode getResizeMode()
Returns the resize mode for the container. See
gtk_container_set_resize_mode ().
- propagateDraw
void propagateDraw(Widget child, 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_propagate_draw() once for each child, passing in
the @cr the container received.
- 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 before removing it from
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.
- resizeChildren
void resizeChildren()
- setBorderWidth
void setBorderWidth(uint borderWidth)
Sets the border width of the container.
- setFocusChain
void setFocusChain(ListG focusableWidgets)
Sets a focus chain, overriding the one computed automatically by GTK+.
- setFocusChild
void setFocusChild(Widget child)
Sets, or unsets if @child is %NULL, the focused child of @container.
- 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.
- 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.
- setReallocateRedraws
void setReallocateRedraws(bool needsRedraws)
Sets the @reallocate_redraws flag of the container to the given value.
- setResizeMode
void setResizeMode(GtkResizeMode resizeMode)
Sets the resize mode for the container.
- unsetFocusChain
void unsetFocusChain()
Removes a focus chain explicitly set with gtk_container_set_focus_chain().
- OnAddDelegateWrapper
class OnAddDelegateWrapper
Undocumented in source.
- onAddListeners
OnAddDelegateWrapper[] onAddListeners;
Undocumented in source.
- addOnAdd
gulong addOnAdd(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
- callBackAdd
void callBackAdd(GtkContainer* containerStruct, GtkWidget* object, OnAddDelegateWrapper wrapper)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackAddDestroy
void callBackAddDestroy(OnAddDelegateWrapper wrapper, GClosure* closure)
Undocumented in source. Be warned that the author may not have intended to support it.
- OnCheckResizeDelegateWrapper
class OnCheckResizeDelegateWrapper
Undocumented in source.
- onCheckResizeListeners
OnCheckResizeDelegateWrapper[] onCheckResizeListeners;
Undocumented in source.
- addOnCheckResize
gulong addOnCheckResize(void delegate(Container) dlg, ConnectFlags connectFlags)
- callBackCheckResize
void callBackCheckResize(GtkContainer* containerStruct, OnCheckResizeDelegateWrapper wrapper)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackCheckResizeDestroy
void callBackCheckResizeDestroy(OnCheckResizeDelegateWrapper wrapper, GClosure* closure)
Undocumented in source. Be warned that the author may not have intended to support it.
- OnRemoveDelegateWrapper
class OnRemoveDelegateWrapper
Undocumented in source.
- onRemoveListeners
OnRemoveDelegateWrapper[] onRemoveListeners;
Undocumented in source.
- addOnRemove
gulong addOnRemove(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
- callBackRemove
void callBackRemove(GtkContainer* containerStruct, GtkWidget* object, OnRemoveDelegateWrapper wrapper)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackRemoveDestroy
void callBackRemoveDestroy(OnRemoveDelegateWrapper wrapper, GClosure* closure)
Undocumented in source. Be warned that the author may not have intended to support it.
- OnSetFocusChildDelegateWrapper
class OnSetFocusChildDelegateWrapper
Undocumented in source.
- onSetFocusChildListeners
OnSetFocusChildDelegateWrapper[] onSetFocusChildListeners;
Undocumented in source.
- addOnSetFocusChild
gulong addOnSetFocusChild(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
- callBackSetFocusChild
void callBackSetFocusChild(GtkContainer* containerStruct, GtkWidget* object, OnSetFocusChildDelegateWrapper wrapper)
Undocumented in source. Be warned that the author may not have intended to support it.
- callBackSetFocusChildDestroy
void callBackSetFocusChildDestroy(OnSetFocusChildDelegateWrapper wrapper, GClosure* closure)
Undocumented in source. Be warned that the author may not have intended to support it.
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.