Mercurial > hg > xemacs-beta

comparison man/lispref/menus.texi @ 5791:9fae6227ede5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Silence texinfo 5.2 warnings, primarily by adding next, prev, and up pointers to all nodes. See xemacs-patches message with ID <5315f7bf.sHpFD7lXYR05GH6E%james@xemacs.org>.
author Jerry James <james@xemacs.org>
date Thu, 27 Mar 2014 08:59:03 -0600
parents 68f8d295be49
children
comparison
equal deleted inserted replaced
5790:dcf9067f26bb 5791:9fae6227ede5
17 * Menu Filters:: Filter functions for the default menubar. 17 * Menu Filters:: Filter functions for the default menubar.
18 * Menu Accelerators:: Using and controlling menu accelerator keys 18 * Menu Accelerators:: Using and controlling menu accelerator keys
19 * Buffers Menu:: The menu that displays the list of buffers. 19 * Buffers Menu:: The menu that displays the list of buffers.
20 @end menu 20 @end menu
21 21
22 @node Menu Format 22 @node Menu Format, Menubar Format, Menus, Menus
23 @section Format of Menus 23 @section Format of Menus
24 @cindex menu format 24 @cindex menu format
25 @cindex format of menus 25 @cindex format of menus
26 26
27 A menu is described using a @dfn{menu description}, which is a list of 27 A menu is described using a @dfn{menu description}, which is a list of
256 [ "Revert Buffer" revert-buffer :active (buffer-modified-p) ] 256 [ "Revert Buffer" revert-buffer :active (buffer-modified-p) ]
257 [ "Read Only" toggle-read-only :style toggle :selected buffer-read-only ] 257 [ "Read Only" toggle-read-only :style toggle :selected buffer-read-only ]
258 ) 258 )
259 @end example 259 @end example
260 260
261 @node Menubar Format 261 @node Menubar Format, Menubar, Menu Format, Menus
262 @section Format of the Menubar 262 @section Format of the Menubar
263 @cindex menubar format 263 @cindex menubar format
264 @cindex format of the menubar 264 @cindex format of the menubar
265 265
266 A menubar is a list of menus, menu items, and strings. The format is 266 A menubar is a list of menus, menu items, and strings. The format is
278 the division between the set of menubar items which are flush-left and 278 the division between the set of menubar items which are flush-left and
279 those which are flush-right. (Note: this isn't completely implemented 279 those which are flush-right. (Note: this isn't completely implemented
280 yet.) 280 yet.)
281 @end itemize 281 @end itemize
282 282
283 @node Menubar 283 @node Menubar, Modifying Menus, Menubar Format, Menus
284 @section Menubar 284 @section Menubar
285 @cindex menubar 285 @cindex menubar
286 286
287 @defvar current-menubar 287 @defvar current-menubar
288 This variable holds the description of the current menubar. This may be 288 This variable holds the description of the current menubar. This may be
354 @defvar menu-no-selection-hook 354 @defvar menu-no-selection-hook
355 Function or functions to call when a menu or dialog box is dismissed 355 Function or functions to call when a menu or dialog box is dismissed
356 without a selection having been made. 356 without a selection having been made.
357 @end defvar 357 @end defvar
358 358
359 @node Modifying Menus 359 @node Modifying Menus, Menu Filters, Menubar, Menus
360 @section Modifying Menus 360 @section Modifying Menus
361 361
362 The following functions are provided to modify the menubar of one of its 362 The following functions are provided to modify the menubar of one of its
363 submenus. Note that these functions modify the menu in-place, rather 363 submenus. Note that these functions modify the menu in-place, rather
364 than copying it and making a new menu. 364 than copying it and making a new menu.
483 @var{before}, if provided, is the name of a menu item before which this 483 @var{before}, if provided, is the name of a menu item before which this
484 item should be added, if this item is not on the menu already. If the 484 item should be added, if this item is not on the menu already. If the
485 item is already present, it will not be moved. 485 item is already present, it will not be moved.
486 @end defun 486 @end defun
487 487
488 @node Menu Filters 488 @node Menu Filters, Pop-Up Menus, Modifying Menus, Menus
489 @section Menu Filters 489 @section Menu Filters
490 @cindex menu filters 490 @cindex menu filters
491 491
492 The following filter functions are provided for use in 492 The following filter functions are provided for use in
493 @code{default-menubar}. You may want to use them in your own menubar 493 @code{default-menubar}. You may want to use them in your own menubar
537 @defun buffers-menu-filter menu-items 537 @defun buffers-menu-filter menu-items
538 This function sets up the Buffers menu. @xref{Buffers Menu}, for 538 This function sets up the Buffers menu. @xref{Buffers Menu}, for
539 more information. 539 more information.
540 @end defun 540 @end defun
541 541
542 @node Pop-Up Menus 542 @node Pop-Up Menus, Menu Accelerators, Menu Filters, Menus
543 @section Pop-Up Menus 543 @section Pop-Up Menus
544 @cindex pop-up menu 544 @cindex pop-up menu
545 545
546 @defun popup-menu menu-description &optional event 546 @defun popup-menu menu-description &optional event
547 This function pops up a menu specified by @var{menu-description}, which 547 This function pops up a menu specified by @var{menu-description}, which
604 @deffn Command popup-menubar-menu event 604 @deffn Command popup-menubar-menu event
605 This function pops up a copy of menu that also appears in the menubar. 605 This function pops up a copy of menu that also appears in the menubar.
606 It should be bound to a mouse button event. 606 It should be bound to a mouse button event.
607 @end deffn 607 @end deffn
608 608
609 @node Menu Accelerators 609 @node Menu Accelerators, Buffers Menu, Pop-Up Menus, Menus
610 @section Menu Accelerators 610 @section Menu Accelerators
611 @cindex menu accelerators 611 @cindex menu accelerators
612 @cindex keyboard menu accelerators 612 @cindex keyboard menu accelerators
613 613
614 Menu accelerators are keyboard shortcuts for accessing the menubar. 614 Menu accelerators are keyboard shortcuts for accessing the menubar.
622 * Keyboard Menu Traversal:: How to use and modify the keys which are used 622 * Keyboard Menu Traversal:: How to use and modify the keys which are used
623 to traverse the menu structure. 623 to traverse the menu structure.
624 * Menu Accelerator Functions:: Functions for working with menu accelerators. 624 * Menu Accelerator Functions:: Functions for working with menu accelerators.
625 @end menu 625 @end menu
626 626
627 @node Creating Menu Accelerators 627 @node Creating Menu Accelerators, Keyboard Menu Traversal, Menu Accelerators, Menu Accelerators
628 @subsection Creating Menu Accelerators 628 @subsection Creating Menu Accelerators
629 629
630 Menu accelerators are specified as part of the menubar format using the 630 Menu accelerators are specified as part of the menubar format using the
631 :accelerator tag to specify a key or by placing "%_" in the menu or menu item 631 :accelerator tag to specify a key or by placing "%_" in the menu or menu item
632 name prior to the letter which is to be used as the accelerator key. The 632 name prior to the letter which is to be used as the accelerator key. The
652 into the buffer. 652 into the buffer.
653 653
654 It is possible to activate the top level menubar itself using accelerator keys. 654 It is possible to activate the top level menubar itself using accelerator keys.
655 @xref{Menu Accelerator Functions}. 655 @xref{Menu Accelerator Functions}.
656 656
657 @node Keyboard Menu Traversal 657 @node Keyboard Menu Traversal, Menu Accelerator Functions, Creating Menu Accelerators, Menu Accelerators
658 @subsection Keyboard Menu Traversal 658 @subsection Keyboard Menu Traversal
659 659
660 In addition to immediately activating a menu or menu item, the keyboard can 660 In addition to immediately activating a menu or menu item, the keyboard can
661 be used to traverse the menus without activating items. The keyboard arrow 661 be used to traverse the menus without activating items. The keyboard arrow
662 keys, the return key and the escape key are defined to traverse the menus in a 662 keys, the return key and the escape key are defined to traverse the menus in a
665 665
666 This behavior can be changed by modifying the bindings in 666 This behavior can be changed by modifying the bindings in
667 menu-accelerator-map. At this point, the online help is your best bet 667 menu-accelerator-map. At this point, the online help is your best bet
668 for more information about how to modify the menu traversal keys. 668 for more information about how to modify the menu traversal keys.
669 669
670 @node Menu Accelerator Functions 670 @node Menu Accelerator Functions, , Keyboard Menu Traversal, Menu Accelerators
671 @subsection Menu Accelerator Functions 671 @subsection Menu Accelerator Functions
672 672
673 @deffn Command accelerate-menu 673 @deffn Command accelerate-menu
674 Make the menubar immediately active and place the cursor on the left most entry 674 Make the menubar immediately active and place the cursor on the left most entry
675 in the top level menu. Menu items can be selected as usual. 675 in the top level menu. Menu items can be selected as usual.
735 will add the menu "Test" to the top level menubar. Pressing C-x followed by 735 will add the menu "Test" to the top level menubar. Pressing C-x followed by
736 C-M-T will activate the menubar and display the "Test" menu. Pressing 736 C-M-T will activate the menubar and display the "Test" menu. Pressing
737 C-M-T by itself will not activate the menubar. Neither will pressing C-x 737 C-M-T by itself will not activate the menubar. Neither will pressing C-x
738 followed by anything else. 738 followed by anything else.
739 739
740 @node Buffers Menu 740 @node Buffers Menu, , Menu Accelerators, Menus
741 @section Buffers Menu 741 @section Buffers Menu
742 @cindex buffers menu 742 @cindex buffers menu
743 743
744 The following options control how the @samp{Buffers} menu is displayed. 744 The following options control how the @samp{Buffers} menu is displayed.
745 This is a list of all (or a subset of) the buffers currently in existence, 745 This is a list of all (or a subset of) the buffers currently in existence,