1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
|
\alias{GtkMenuShell}
\alias{GtkMenuDirectionType}
\name{GtkMenuShell}
\title{GtkMenuShell}
\description{A base class for menu objects}
\section{Methods and Functions}{
\code{\link{gtkMenuShellAppend}(object, child)}\cr
\code{\link{gtkMenuShellPrepend}(object, child)}\cr
\code{\link{gtkMenuShellInsert}(object, child, position)}\cr
\code{\link{gtkMenuShellDeactivate}(object)}\cr
\code{\link{gtkMenuShellSelectItem}(object, menu.item)}\cr
\code{\link{gtkMenuShellSelectFirst}(object, search.sensitive)}\cr
\code{\link{gtkMenuShellDeselect}(object)}\cr
\code{\link{gtkMenuShellActivateItem}(object, menu.item, force.deactivate)}\cr
\code{\link{gtkMenuShellCancel}(object)}\cr
\code{\link{gtkMenuShellSetTakeFocus}(object, take.focus)}\cr
\code{\link{gtkMenuShellGetTakeFocus}(object)}\cr
}
\section{Hierarchy}{\preformatted{GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkMenuShell
+----GtkMenuBar
+----GtkMenu}}
\section{Interfaces}{GtkMenuShell implements
AtkImplementorIface and \code{\link{GtkBuildable}}.}
\section{Detailed Description}{A \code{\link{GtkMenuShell}} is the abstract base class used to derive the
\code{\link{GtkMenu}} and \code{\link{GtkMenuBar}} subclasses.
A \code{\link{GtkMenuShell}} is a container of \code{\link{GtkMenuItem}} objects arranged in a
list which can be navigated, selected, and activated by the user to perform
application functions. A \code{\link{GtkMenuItem}} can have a submenu associated with it,
allowing for nested hierarchical menus.}
\section{Structures}{\describe{\item{\verb{GtkMenuShell}}{
The \code{\link{GtkMenuShell}} struct contains the following fields.
(These fields should be considered read-only. They should never be set by
an application.)
\tabular{ll}{\verb{list} *children; \tab The list of \code{\link{GtkMenuItem}} objects contained by this \code{\link{GtkMenuShell}} . \cr}
}}}
\section{Enums and Flags}{\describe{\item{\verb{GtkMenuDirectionType}}{
An enumeration representing directional movements within a menu.
\describe{
\item{\verb{parent}}{To the parent menu shell.}
\item{\verb{child}}{To the submenu, if any, associated with the item.}
\item{\verb{next}}{To the next menu item.}
\item{\verb{prev}}{To the previous menu item.}
}
}}}
\section{Signals}{\describe{
\item{\code{activate-current(menushell, force.hide, user.data)}}{
An action signal that activates the current menu item within the menu
shell.
\describe{
\item{\code{menushell}}{the object which received the signal.}
\item{\code{force.hide}}{if TRUE, hide the menu after activating the menu item.}
\item{\code{user.data}}{user data set when the signal handler was connected.}
}
}
\item{\code{cancel(menushell, user.data)}}{
An action signal which cancels the selection within the menu shell.
Causes the GtkMenuShell::selection-done signal to be emitted.
\describe{
\item{\code{menushell}}{the object which received the signal.}
\item{\code{user.data}}{user data set when the signal handler was connected.}
}
}
\item{\code{cycle-focus(menushell, user.data)}}{
\emph{undocumented
}
\describe{
\item{\code{menushell}}{the object which received the signal.}
\item{\code{user.data}}{user data set when the signal handler was connected.}
}
}
\item{\code{deactivate(menushell, user.data)}}{
This signal is emitted when a menu shell is deactivated.
\describe{
\item{\code{menushell}}{the object which received the signal.}
\item{\code{user.data}}{user data set when the signal handler was connected.}
}
}
\item{\code{move-current(menushell, direction, user.data)}}{
An action signal which moves the current menu item in the direction
specified by \code{direction}.
\describe{
\item{\code{menushell}}{the object which received the signal.}
\item{\code{direction}}{the direction to move.}
\item{\code{user.data}}{user data set when the signal handler was connected.}
}
}
\item{\code{move-selected(menu.shell, distance, user.data)}}{
The ::move-selected signal is emitted to move the selection to
another item.
Since 2.12
\describe{
\item{\code{menu.shell}}{the object on which the signal is emitted}
\item{\code{distance}}{+1 to move to the next item, -1 to move to the previous}
\item{\code{user.data}}{user data set when the signal handler was connected.}
}
\emph{Returns:} [logical] \code{TRUE} to stop the signal emission, \code{FALSE} to continue
}
\item{\code{selection-done(menushell, user.data)}}{
This signal is emitted when a selection has been completed within a menu
shell.
\describe{
\item{\code{menushell}}{the object which received the signal.}
\item{\code{user.data}}{user data set when the signal handler was connected.}
}
}
}}
\section{Properties}{\describe{\item{\verb{take-focus} [logical : Read / Write]}{
A boolean that determines whether the menu and its submenus grab the
keyboard focus. See \code{\link{gtkMenuShellSetTakeFocus}} and
\code{\link{gtkMenuShellGetTakeFocus}}.
Default value: TRUE Since 2.8
}}}
\references{\url{https://developer.gnome.org/gtk2/stable/GtkMenuShell.html}}
\author{Derived by RGtkGen from GTK+ documentation}
\keyword{internal}
|