annotate lisp/easymenu.el @ 502:7039e6323819

[xemacs-hg @ 2001-05-04 22:41:46 by ben] ----------------------- byte-comp warning fixes ----------------- New functions for cleanly eliminating byte-compiler warnings. Their definitions require no changes at all in bytecomp.el, meaning that any package that wants to use them and be compatible with older versions of XEmacs need only copy the code and rename the functions (i.e. prefix them with the package name). Eliminate byte-compiler warnings using the new functions in bytecomp-runtime.el. Move coding-system-put,get,category, since they're not Mule-specific and are used in prefer-coding-system. font.el was incredibly ugly. Clean it up. Avoid using defsubst for any exported functions, to avoid possible compatibility problems if we later change the internal interface. (It happened before, with face accessors, between 19.8 and 19.9). Fix tons of warnings. Clean up (new function gpm-is-supported-p eliminates duplicate code in gpm-create/delete-device-hook) and eliminate warnings. ---------- make byte-recompile-directory work in the --------- core `lisp' dir, even in the absence of a Mule XEmacs (i.e. make it skip the Mule files rather than trying to compile them). now you should be able to do `touch *.el' in the `lisp' dir, then M-x byte-recompile-directory, and get no warnings. Avoid trying to compile Mule files in byte-recompile-directory when we're not in a Mule XEmacs, since we're highly likely to get syntax errors. Add a coding-system cookie to all Mule files so that byte-recompile-directory ignores them. Magic cookie function moved to files.el from code-files.el (for use by bytecomp even in a non-coding-system XEmacs), and changed names and semantics for use by bytecomp. NOTE: IMO this is an internal function that we can change as we like (and there is absolutely no code anywhere else using the function). ---------------- GUI improvements: menus, help ------------------- Rearrange order of keymap declarations to be alphabetical. Improve help on help to include all bindings, and group by category. Add bindings for new Info commands. Remove warnings. Use command-hyper-apropos in place of command-apropos. Add a function to do the equivalent of command-apropos. Evals its help-text argument so you can put expressions there. Used now by help-for-help. Add binding to continue text searches. Expand index searches to work over multiple info documents. Add commands to search text/index in User and Lispref. Add new entry, "Uncomment Region" (parallels "Comment Out Region"). Redo Help menu; add bindings for new Info commands to search the index or text of the User and Lispref manuals. Add command for mark-paragraph, activate-region. Make Edit->R accelerator be rectangle, not register (more commonly used), and put rectangle first. Fix the Edit Init File entry to never load the .elc file. Simplify the default-popup-menu. Add Cmds->Tabs menu. Use kp-left not kp_left, etc. ---------------- Miscellaneous bug fixes/cleanup ------------------- byte-compiler-options: Correct doc string. easy-menu-do-define: fix extra quote. fill-paragraph-or-region:Rewrite to be more correct -- use call-interactively so that we always get exactly the same behavior as if the functions were called directly. No need to fiddle with zmacs-region-stays, now that bogus clearing of it (2001-04-28 src/ChangeLog) is removed. Put dialog titles back in -- this time correctly. Fix various other problems with leaks and such. key-sequence-list-description: Clean up fun to always correctly canonicalize. Clean up Kinsoku comments, synch comment-region with FSF 20.7. * simple.el (region-exists-p): * simple.el (region-active-p): Add comment about which one is correct to use in menu specs. * sound.el (load-sound-file): Minor code clean up. * startup.el: * startup.el (command-line-early): * startup.el (initial-scratch-message): Comment changes. Add info about sample.init.el to splash screen. Improve initial-scratch-message and clarify purpose of Scratch buffer. Fix byte-compile warning. ------------------------ Added features ------------------------- Add new variable to control whether etags checks all parent directories for tag files. (On by default.) * hash-table.el: New file, useful utility functions. * dumped-lisp.el (preloaded-file-list): Dump hash-table.el. ------------ notable bug fix: Windows event code -------------- Get critical quit working. ------------ notable bug fix and new feature: regex code -------------- Shy groups were implemented in a horrible, half-assed way that would cause them to screw up regex searching in most cases. Fixed to work correctly. Also extended back-reference syntax past 9. Only is recognized as such if there are at least that many non-shy groups; and optionally will warn about such uses, to catch old code that might be using them differently. (Added variable to control this in search.c -- `warn-about-possibly-incompatible-back- references', on by default for the moment. Declared in lisp.h. ---------------- process/SIGIO improvements ------------------- define USE_GETADDRINFO to replace more complex conditional, and use it. the code conditionalized on this in unix_open_network_stream had *serious* problems handling errors. it's now fixed, and major amounts of duplicate code between the two versions were combined. don't disable SIGIO and other interrupts unless CONNECT_NEEDS_SLOWED_INTERRUPTS is defined -- don't penalize OS's without bugs. similarly for a freebsd bug that was affecting all OS's. * s\ultrix.h: define CONNECT_NEEDS_SLOWED_INTERRUPTS, since that's the OS mentioned as having a kernel bug. * sysdep.c (request_sigio_on_device): * sysdep.c (unrequest_sigio_on_device): fix SIGIO problems on Linux. add check for O_ASYNC in case it's defined and FASYNC isn't. add comment about other ways to do SIGIO on Linux. * callproc.c (Fold_call_process_internal): * process.c (Fstart_process_internal): Deal with the possibility that `default-directory' doesn't have terminating slash. Correct comments about vfork. ---------------- Miscellaneous bug fixes/cleanup ------------------- * callint.c (Finteractive): Add lots of documentation -- exactly what the Lisp equivalents of all the interactive specs are. * console.h (struct console): change type of quit_char to Emchar. * event-msw.c (lstream_type_create_mswindows_selectable): spacing change. Eliminate events-mod.h and combine into events.h. * emacs.c: * emacs.c (make_arg_list_1): * emacs.c (main_1): A couple of char->Extbyte changes, add a comment. * glyphs-msw.c: Correct indentation of function defns to not exceed 80 cols. Try (sort of) to fix some code that sets the colors of the progress gauge. (Commented out) * keymap.c (syms_of_keymap): use DEFSYMBOL. * process.c (read_process_output): No need to fiddle with zmacs_region_stays, now that bogus clearing of it (see below) is removed. * search.c (Freplace_match): warning fix.
author ben
date Fri, 04 May 2001 22:42:35 +0000
parents abe6d1db359e
children 9caf26dd924f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1 ;;; easymenu.el - Easy menu support for Emacs 19 and XEmacs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
2
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
3 ;; Copyright (C) 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6 ;; Maintainer: XEmacs Development Team
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
7 ;; Keywords: internal, extensions, dumped
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 ;; This file is part of XEmacs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11 ;; XEmacs is free software; you can redistribute it and/or modify
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
12 ;; it under the terms of the GNU General Public License as published by
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13 ;; the Free Software Foundation; either version 2, or (at your option)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14 ;; any later version.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
16 ;; XEmacs is distributed in the hope that it will be useful,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19 ;; GNU General Public License for more details.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21 ;; You should have received a copy of the GNU General Public License
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
22 ;; along with XEmacs; if not, write to the Free Software
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
23 ;; Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24 ;; 02111-1307, USA.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26 ;;; Synched up with: Not synched with FSF but coordinated with the FSF
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
27 ;;; easymenu maintainer for compatibility with FSF 20.4.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
28 ;;; Please: Coordinate changes with Inge Frick <inge@nada.kth.se>
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
30 ;; Commentary:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
31
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
32 ;; This file is dumped with XEmacs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
33
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
34 ;; Easymenu allows you to define menus for both Emacs 19 and XEmacs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
36 ;; This file
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 ;; The advantages of using easymenu are:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39 ;; - Easier to use than either the Emacs 19 and XEmacs menu syntax.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
41 ;; - Common interface for Emacs 18, Emacs 19, and XEmacs.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42 ;; (The code does nothing when run under Emacs 18).
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
44 ;; The public functions are:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
45
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
46 ;; - Function: easy-menu-define SYMBOL MAPS DOC MENU
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47 ;; SYMBOL is both the name of the variable that holds the menu and
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
48 ;; the name of a function that will present the menu.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
49 ;; MAPS is a list of keymaps where the menu should appear in the menubar.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
50 ;; DOC is the documentation string for the variable.
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
51 ;; MENU is an XEmacs style menu description.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
52
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
53 ;; See the documentation for easy-menu-define for details.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
54
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
55 ;; - Function: easy-menu-change PATH NAME ITEMS
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
56 ;; Change an existing menu.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
57 ;; The menu must already exist and be visible on the menu bar.
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
58 ;; PATH is a list of strings used for locating the menu on the menu bar.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
59 ;; NAME is the name of the menu.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
60 ;; ITEMS is a list of menu items, as defined in `easy-menu-define'.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
61
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
62 ;; - Function: easy-menu-add MENU [ MAP ]
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
63 ;; Add MENU to the current menubar in MAP.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
64
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65 ;; - Function: easy-menu-remove MENU
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
66 ;; Remove MENU from the current menubar.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
67
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
68 ;; - Function: easy-menu-add-item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
69 ;; Add item or submenu to existing menu
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
70
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
71 ;; - Function: easy-menu-item-present-p
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
72 ;; Locate item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
73
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
74 ;; - Function: easy-menu-remove-item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
75 ;; Delete item from menu.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
76
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
77 ;; Emacs 19 never uses `easy-menu-add' or `easy-menu-remove', menus
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
78 ;; automatically appear and disappear when the keymaps specified by
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
79 ;; the MAPS argument to `easy-menu-define' are activated.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
80
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
81 ;; XEmacs will bind the map to button3 in each MAPS, but you must
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
82 ;; explicitly call `easy-menu-add' and `easy-menu-remove' to add and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
83 ;; remove menus from the menu bar.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
84
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
85 ;;; Code:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
86
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
87 ;; ;;;###autoload
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
88 (defmacro easy-menu-define (symbol maps doc menu)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
89 "Define a menu bar submenu in maps MAPS, according to MENU.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
90 The arguments SYMBOL and DOC are ignored; they are present for
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
91 compatibility only. SYMBOL is not evaluated. In other Emacs versions
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
92 these arguments may be used as a variable to hold the menu data, and a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
93 doc string for that variable.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
94
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
95 The first element of MENU must be a string. It is the menu bar item name.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
96 The rest of the elements are menu items.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
97
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
98 A menu item is usually a vector of three elements: [NAME CALLBACK ENABLE]
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
99
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
100 NAME is a string--the menu item name.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
101
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
102 CALLBACK is a command to run when the item is chosen,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
103 or a list to evaluate when the item is chosen.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
104
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
105 ENABLE is an expression; the item is enabled for selection
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
106 whenever this expression's value is non-nil.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
107
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
108 Alternatively, a menu item may have the form:
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
109
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
110 [ NAME CALLBACK [ KEYWORD ARG ] ... ]
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
111
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
112 Where KEYWORD is one of the symbol defined below.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
113
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
114 :keys KEYS
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
115
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
116 KEYS is a string; a complex keyboard equivalent to this menu item.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
117
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
118 :active ENABLE
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
119
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
120 ENABLE is an expression; the item is enabled for selection
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
121 whenever this expression's value is non-nil.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
122
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
123 :suffix NAME
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
124
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
125 NAME is a string; the name of an argument to CALLBACK.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
126
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
127 :style STYLE
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
128
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
129 STYLE is a symbol describing the type of menu item. The following are
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
130 defined:
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
131
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
132 toggle: A checkbox.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
133 Currently just prepend the name with the string \"Toggle \".
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
134 radio: A radio button.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
135 nil: An ordinary menu item.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
136
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
137 :selected SELECTED
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
138
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
139 SELECTED is an expression; the checkbox or radio button is selected
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
140 whenever this expression's value is non-nil.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
141 Currently just disable radio buttons, no effect on checkboxes.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
142
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
143 A menu item can be a string. Then that string appears in the menu as
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
144 unselectable text. A string consisting solely of hyphens is displayed
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
145 as a solid horizontal line.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
146
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
147 A menu item can be a list. It is treated as a submenu.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
148 The first element should be the submenu name. That's used as the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
149 menu item in the top-level menu. The cdr of the submenu list
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
150 is a list of menu items, as above."
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
151 `(progn
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
152 (defvar ,symbol nil ,doc)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
153 (easy-menu-do-define (quote ,symbol) ,maps ,doc ,menu)))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
154
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
155 (defun easy-menu-do-define (symbol maps doc menu)
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
156 (when (featurep 'menubar)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
157 (set symbol menu)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
158 (fset symbol `(lambda (e)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
159 ,doc
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
160 (interactive "@e")
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
161 (run-hooks 'activate-menubar-hook)
502
7039e6323819 [xemacs-hg @ 2001-05-04 22:41:46 by ben]
ben
parents: 442
diff changeset
162 (setq zmacs-region-stays t)
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
163 (popup-menu ,symbol)))))
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
164
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
165 (defun easy-menu-change (&rest args)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
166 (when (featurep 'menubar)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
167 (apply 'add-menu args)))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
168
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
169 ;; This variable hold the easy-menu mode menus of all major and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
170 ;; minor modes currently in effect in the current buffer.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
171 (defvar easy-menu-all-popups nil)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
172 (make-variable-buffer-local 'easy-menu-all-popups)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
173
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
174 (defun easy-menu-add (menu &optional map)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
175 "Add MENU to the current menu bar."
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
176 (when (featurep 'menubar)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
177 (unless (member menu easy-menu-all-popups)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
178 (push menu easy-menu-all-popups))
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
179 (setq mode-popup-menu (if (> (length easy-menu-all-popups) 1)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
180 (cons (easy-menu-title)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
181 (reverse easy-menu-all-popups))
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
182 (let ((same-as-menu
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
183 (car easy-menu-all-popups)))
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
184 (cons (normalize-menu-item-name
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
185 (car same-as-menu))
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
186 (cdr same-as-menu)))))
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
187
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
188 (cond ((null current-menubar)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
189 ;; Don't add it to a non-existing menubar.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
190 nil)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
191 ((assoc (car menu) current-menubar)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
192 ;; Already present.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
193 nil)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
194 ((equal current-menubar '(nil))
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
195 ;; Set at left if only contains right marker.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
196 (set-buffer-menubar (list menu nil)))
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
197 (t
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
198 ;; Add at right.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
199 (set-buffer-menubar (copy-sequence current-menubar))
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
200 (add-menu nil (car menu) (cdr menu))))))
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
201
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
202 (defun easy-menu-remove (menu)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
203 "Remove MENU from the current menu bar."
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
204 (when (featurep 'menubar)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
205 (setq easy-menu-all-popups (delq menu easy-menu-all-popups)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
206 mode-popup-menu (if (< (length easy-menu-all-popups) 1)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
207 (cons (easy-menu-title)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
208 (reverse easy-menu-all-popups))
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
209 (let ((same-as-menu
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
210 (car easy-menu-all-popups)))
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
211 (cons (normalize-menu-item-name
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
212 (car same-as-menu))
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
213 (cdr same-as-menu)))))
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
214
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
215 (and current-menubar
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
216 (assoc (car menu) current-menubar)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
217 (delete-menu-item (list (car menu))))))
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
218
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
219 (defsubst easy-menu-normalize (menu)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
220 (if (symbolp menu)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
221 (symbol-value menu)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
222 menu))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
223
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
224 (defun easy-menu-add-item (menu path item &optional before)
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
225 "At the end of the submenu of MENU with path PATH, add ITEM.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
226 If ITEM is already present in this submenu, then this item will be changed.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
227 otherwise ITEM will be added at the end of the submenu, unless the optional
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
228 argument BEFORE is present, in which case ITEM will instead be added
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
229 before the item named BEFORE.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
230 MENU is either a symbol, which have earlier been used as the first
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
231 argument in a call to `easy-menu-define', or the value of such a symbol
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
232 i.e. a menu, or nil, which stands for the current menubar.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
233 PATH is a list of strings for locating the submenu where ITEM is to be
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
234 added. If PATH is nil, MENU itself is used. Otherwise, the first
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
235 element should be the name of a submenu directly under MENU. This
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
236 submenu is then traversed recursively with the remaining elements of PATH.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
237 ITEM is either defined as in `easy-menu-define', a menu defined earlier
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
238 by `easy-menu-define' or `easy-menu-create-menu' or an item returned
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
239 from `easy-menu-item-present-p' or `easy-menu-remove-item'."
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
240 (when (featurep 'menubar)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
241 (add-menu-button path item before (easy-menu-normalize menu))))
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
242
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
243 (defun easy-menu-item-present-p (menu path name)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
244 "In submenu of MENU with path PATH, return true iff item NAME is present.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
245 MENU and PATH are defined as in `easy-menu-add-item'.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
246 NAME should be a string, the name of the element to be looked for.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
247
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
248 The return value can be used as an argument to `easy-menu-add-item'."
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
249 (if (featurep 'menubar)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
250 (car (find-menu-item (or (easy-menu-normalize menu) current-menubar)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
251 (append path (list name))))
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
252 nil))
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
253
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
254 (defun easy-menu-remove-item (menu path name)
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
255 "From submenu of MENU with path PATH, remove item NAME.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
256 MENU and PATH are defined as in `easy-menu-add-item'.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
257 NAME should be a string, the name of the element to be removed.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
258
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
259 The return value can be used as an argument to `easy-menu-add-item'."
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
260 (when (featurep 'menubar)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
261 (delete-menu-item (append path (list name))
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
262 (easy-menu-normalize menu))))
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
263
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
264
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
265
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
266
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
267 ;; Think up a good title for the menu. Take the major-mode of the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
268 ;; buffer, strip the -mode part, convert hyphens to spaces, and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
269 ;; capitalize it.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
270 ;;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
271 ;; If you can think of something smarter, feel free to replace it.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
272 ;; Don't forget to mail the change to xemacs@xemacs.org where everyone
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
273 ;; can flame, er, praise your changes.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
274 (defun easy-menu-title ()
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
275 (capitalize (replace-in-string (replace-in-string
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
276 (symbol-name major-mode) "-mode$" "")
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
277 "-" " ")))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
278
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
279 (provide 'easymenu)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
280
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
281 ;;; easymenu.el ends here