@c -*-texinfo-*-
@c This is part of the XEmacs Lisp Reference Manual.
-@c Copyright (C) 1990, 1991, 1992, 1993, 1997 Free Software Foundation, Inc.
+@c Copyright (C) 1990, 1991, 1992, 1993, 1997 Free Software Foundation, Inc.
@c Copyright (C) 1995 Sun Microsystems.
@c See the file lispref.texi for copying conditions.
@setfilename ../../info/menu.info
top-level ``File'' menu. @code{("Menu" "Foo" "Item")} means the menu
item called ``Item'' under the ``Foo'' submenu of ``Menu''.
-@defun add-submenu menu-path submenu &optional before
+@defun add-submenu menu-path submenu &optional before in-menu
This function adds a menu to the menubar or one of its submenus. If the
named menu exists already, it is changed.
@var{before}, if provided, is the name of a menu before which this menu
should be added, if this menu is not on its parent already. If the menu
is already present, it will not be moved.
+
+If @var{in-menu} is present use that instead of @code{current-menubar}
+as the menu to change.
@end defun
-@defun add-menu-button menu-path menu-leaf &optional before
+@defun add-menu-button menu-path menu-leaf &optional before in-menu
This function adds a menu item to some menu, creating the menu first if
necessary. If the named item exists already, it is changed.
@var{before}, if provided, is the name of a menu before which this item
should be added, if this item is not on the menu already. If the item
is already present, it will not be moved.
+
+If @var{in-menu} is present use that instead of @code{current-menubar}
+as the menu to change.
@end defun
-@defun delete-menu-item menu-item-path
+@defun delete-menu-item menu-item-path &optional from-menu
This function removes the menu item specified by @var{menu-item-path}
from the menu hierarchy.
+
+If @var{from-menu} is present use that instead of @code{current-menubar}
+as the menu to change.
@end defun
@defun enable-menu-item menu-item-path
@section Pop-Up Menus
@cindex pop-up menu
-@defun popup-menu menu-desc
-This function pops up a menu specified by @var{menu-desc}, which is a
-menu description (@pxref{Menu Format}). The menu is displayed at the
-current mouse position.
+@defun popup-menu menu-description &optional event
+This function pops up a menu specified by @var{menu-description}, which
+is a menu description (@pxref{Menu Format}). The menu is displayed at
+the current mouse position.
@end defun
@defun popup-menu-up-p
The following convenience functions are provided for displaying
pop-up menus.
-@defun popup-buffer-menu event
+@deffn Command popup-buffer-menu event
This function pops up a copy of the @samp{Buffers} menu (from the menubar)
-where the mouse is clicked.
-@end defun
+where the mouse is clicked. It should be bound to a mouse button event.
+@end deffn
-@defun popup-menubar-menu event
+@deffn Command popup-menubar-menu event
This function pops up a copy of menu that also appears in the menubar.
-@end defun
+It should be bound to a mouse button event.
+@end deffn
@node Menu Accelerators
@section Menu Accelerators
@node Menu Accelerator Functions
@subsection Menu Accelerator Functions
-@defun accelerate-menu
+@deffn Command accelerate-menu
Make the menubar immediately active and place the cursor on the left most entry
in the top level menu. Menu items can be selected as usual.
-@end defun
+@end deffn
@defvar menu-accelerator-enabled
Whether menu accelerator keys can cause the menubar to become active.
precedence over bindings in the current keymap(s). @code{menu-fallback} means
that bindings in the current keymap take precedence over menu accelerator keys.
Thus a top level menu with an accelerator of "T" would be activated on a
-keypress of Meta-t if @var{menu-accelerator-enabled} is @code{menu-force}.
-However, if @var{menu-accelerator-enabled} is @code{menu-fallback}, then
+keypress of Meta-t if @code{menu-accelerator-enabled} is @code{menu-force}.
+However, if @code{menu-accelerator-enabled} is @code{menu-fallback}, then
Meta-t will not activate the menubar and will instead run the function
transpose-words, to which it is normally bound.
The default value is @code{nil}.
-See also @var{menu-accelerator-modifiers} and @var{menu-accelerator-prefix}.
+See also @code{menu-accelerator-modifiers} and @code{menu-accelerator-prefix}.
@end defvar
@defvar menu-accelerator-map
a keystroke. The default value of @code{(meta)} mirrors the usage of the alt key
as a menu accelerator in popular PC operating systems.
-The modifier keys in @var{menu-accelerator-modifiers} must match exactly the
+The modifier keys in @code{menu-accelerator-modifiers} must match exactly the
modifiers present in the keypress. The only exception is that the shift
-modifier is accepted in conjunction with alphabetic keys even if it is not
-a menu accelerator modifier.
+modifier is accepted in conjunction with alphabetic keys even if it is not a
+menu accelerator modifier.
-See also @var{menu-accelerator-enabled} and @var{menu-accelerator-prefix}.
+See also @code{menu-accelerator-enabled} and @code{menu-accelerator-prefix}.
@end defvar
@defvar menu-accelerator-prefix
projects / chise / xemacs-chise.git.1 / blobdiff