Mercurial > emacs
comparison src/xmenu.c @ 62012:76ffd04afaae
(Fx_popup_menu): Doc fix.
author | Luc Teirlinck <teirllm@auburn.edu> |
---|---|
date | Mon, 02 May 2005 01:39:30 +0000 |
parents | 2ce055c7db65 |
children | cd1e4bc8e488 08185296b491 |
comparison
equal
deleted
inserted
replaced
62011:e182525cc42f | 62012:76ffd04afaae |
---|---|
735 DEFUN ("x-popup-menu", Fx_popup_menu, Sx_popup_menu, 2, 2, 0, | 735 DEFUN ("x-popup-menu", Fx_popup_menu, Sx_popup_menu, 2, 2, 0, |
736 doc: /* Pop up a deck-of-cards menu and return user's selection. | 736 doc: /* Pop up a deck-of-cards menu and return user's selection. |
737 POSITION is a position specification. This is either a mouse button event | 737 POSITION is a position specification. This is either a mouse button event |
738 or a list ((XOFFSET YOFFSET) WINDOW) | 738 or a list ((XOFFSET YOFFSET) WINDOW) |
739 where XOFFSET and YOFFSET are positions in pixels from the top left | 739 where XOFFSET and YOFFSET are positions in pixels from the top left |
740 corner of WINDOW's frame. (WINDOW may be a frame object instead of a window.) | 740 corner of WINDOW. (WINDOW may be a window or a frame object.) |
741 This controls the position of the top left of the menu as a whole. | 741 This controls the position of the top left of the menu as a whole. |
742 If POSITION is t, it means to use the current mouse position. | 742 If POSITION is t, it means to use the current mouse position. |
743 | 743 |
744 MENU is a specifier for a menu. For the simplest case, MENU is a keymap. | 744 MENU is a specifier for a menu. For the simplest case, MENU is a keymap. |
745 The menu items come from key bindings that have a menu string as well as | 745 The menu items come from key bindings that have a menu string as well as |
750 If REAL-DEFINITION is nil, that puts a nonselectable string in the menu. | 750 If REAL-DEFINITION is nil, that puts a nonselectable string in the menu. |
751 Otherwise, REAL-DEFINITION should be a valid key binding definition. | 751 Otherwise, REAL-DEFINITION should be a valid key binding definition. |
752 | 752 |
753 You can also use a list of keymaps as MENU. | 753 You can also use a list of keymaps as MENU. |
754 Then each keymap makes a separate pane. | 754 Then each keymap makes a separate pane. |
755 When MENU is a keymap or a list of keymaps, the return value | 755 |
756 is a list of events. | 756 When MENU is a keymap or a list of keymaps, the return value is the |
757 list of events corresponding to the user's choice. Note that | |
758 `x-popup-menu' does not actually execute the command bound to that | |
759 sequence of events. | |
757 | 760 |
758 Alternatively, you can specify a menu of multiple panes | 761 Alternatively, you can specify a menu of multiple panes |
759 with a list of the form (TITLE PANE1 PANE2...), | 762 with a list of the form (TITLE PANE1 PANE2...), |
760 where each pane is a list of form (TITLE ITEM1 ITEM2...). | 763 where each pane is a list of form (TITLE ITEM1 ITEM2...). |
761 Each ITEM is normally a cons cell (STRING . VALUE); | 764 Each ITEM is normally a cons cell (STRING . VALUE); |