@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
@cindex menu
@menu
-* Menu Format:: Format of a menu description.
-* Menubar Format:: How to specify a menubar.
-* Menubar:: Functions for controlling the menubar.
-* Modifying Menus:: Modifying a menu description.
-* Pop-Up Menus:: Functions for specifying pop-up menus.
-* Menu Filters:: Filter functions for the default menubar.
-* Menu Accelerators:: Using and controlling menu accelerator keys
-* Buffers Menu:: The menu that displays the list of buffers.
+* Menu Format:: Format of a menu description.
+* Menubar Format:: How to specify a menubar.
+* Menubar:: Functions for controlling the menubar.
+* Modifying Menus:: Modifying a menu description.
+* Pop-Up Menus:: Functions for specifying pop-up menus.
+* Menu Filters:: Filter functions for the default menubar.
+* Menu Accelerators:: Using and controlling menu accelerator keys
+* Buffers Menu:: The menu that displays the list of buffers.
@end menu
@node Menu Format
@example
("File"
- :filter file-menu-filter ; file-menu-filter is a function that takes
- ; one argument (a list of menu items) and
- ; returns a list of menu items
+ :filter file-menu-filter ; file-menu-filter is a function that takes
+ ; one argument (a list of menu items) and
+ ; returns a list of menu items
[ "Save As..." write-file]
[ "Revert Buffer" revert-buffer :active (buffer-modified-p) ]
[ "Read Only" toggle-read-only :style toggle :selected buffer-read-only ]
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
@end defun
@defun buffers-menu-filter menu-items
-This function sets up the Buffers menu. @xref{Buffers Menu} for
+This function sets up the Buffers menu. @xref{Buffers Menu}, for
more information.
@end defun
@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
activate that item.
@menu
-* Creating Menu Accelerators:: How to add accelerator keys to a menu.
-* Keyboard Menu Traversal:: How to use and modify the keys which are used
- to traverse the menu structure.
-* Menu Accelerator Functions:: Functions for working with menu accelerators.
+* Creating Menu Accelerators:: How to add accelerator keys to a menu.
+* Keyboard Menu Traversal:: How to use and modify the keys which are used
+ to traverse the menu structure.
+* Menu Accelerator Functions:: Functions for working with menu accelerators.
@end menu
@node Creating Menu Accelerators
@example
(add-submenu nil '("%_Test"
- ["One" (insert "1") :accelerator ?1 :active t]
- ["%_Two" (insert "2")]
- ["%_3" (insert "3")]))
+ ["One" (insert "1") :accelerator ?1 :active t]
+ ["%_Two" (insert "2")]
+ ["%_3" (insert "3")]))
@end example
will add a new menu to the top level menubar. The new menu can be reached
@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.
(setq menu-accelerator-modifiers '(meta control))
(setq menu-accelerator-enabled 'menu-force)
(add-submenu nil '("%_Test"
- ["One" (insert "1") :accelerator ?1 :active t]
- ["%_Two" (insert "2")]
- ["%_3" (insert "3")]))
+ ["One" (insert "1") :accelerator ?1 :active t]
+ ["%_Two" (insert "2")]
+ ["%_3" (insert "3")]))
@end example
will add the menu "Test" to the top level menubar. Pressing C-x followed by
projects / chise / xemacs-chise.git.1 / blobdiff