|
428
|
1 /* Implements an elisp-programmable menubar.
|
|
|
2 Copyright (C) 1993, 1994 Free Software Foundation, Inc.
|
|
|
3 Copyright (C) 1995 Tinker Systems and INS Engineering Corp.
|
|
771
|
4 Copyright (C) 2001 Ben Wing.
|
|
428
|
5
|
|
|
6 This file is part of XEmacs.
|
|
|
7
|
|
|
8 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
9 under the terms of the GNU General Public License as published by the
|
|
|
10 Free Software Foundation; either version 2, or (at your option) any
|
|
|
11 later version.
|
|
|
12
|
|
|
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
16 for more details.
|
|
|
17
|
|
|
18 You should have received a copy of the GNU General Public License
|
|
|
19 along with XEmacs; see the file COPYING. If not, write to
|
|
|
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
21 Boston, MA 02111-1307, USA. */
|
|
|
22
|
|
|
23 /* Synched up with: Not in FSF. */
|
|
|
24
|
|
442
|
25 /* Authorship:
|
|
|
26
|
|
|
27 Created by Ben Wing as part of device-abstraction work for 19.12.
|
|
|
28 Menu filters and many other keywords added by Stig for 19.12.
|
|
|
29 Menu accelerators c. 1997? by ??. Moved here from event-stream.c.
|
|
|
30 Much other work post-1996 by ??.
|
|
|
31 */
|
|
428
|
32
|
|
|
33 #include <config.h>
|
|
|
34 #include "lisp.h"
|
|
|
35
|
|
|
36 #include "buffer.h"
|
|
|
37 #include "device.h"
|
|
|
38 #include "frame.h"
|
|
|
39 #include "gui.h"
|
|
442
|
40 #include "keymap.h"
|
|
428
|
41 #include "menubar.h"
|
|
|
42 #include "redisplay.h"
|
|
|
43 #include "window.h"
|
|
|
44
|
|
|
45 int menubar_show_keybindings;
|
|
|
46 Lisp_Object Vmenubar_configuration;
|
|
|
47
|
|
|
48 Lisp_Object Qcurrent_menubar;
|
|
|
49
|
|
|
50 Lisp_Object Qactivate_menubar_hook, Vactivate_menubar_hook;
|
|
|
51
|
|
|
52 Lisp_Object Vmenubar_visible_p;
|
|
|
53
|
|
|
54 static Lisp_Object Vcurrent_menubar; /* DO NOT ever reference this.
|
|
|
55 Always go through Qcurrent_menubar.
|
|
|
56 See below. */
|
|
|
57
|
|
|
58 Lisp_Object Vblank_menubar;
|
|
|
59
|
|
|
60 int popup_menu_titles;
|
|
|
61
|
|
|
62 Lisp_Object Vmenubar_pointer_glyph;
|
|
|
63
|
|
442
|
64 /* prefix key(s) that must match in order to activate menu.
|
|
|
65 This is ugly. fix me.
|
|
|
66 */
|
|
|
67 Lisp_Object Vmenu_accelerator_prefix;
|
|
|
68
|
|
|
69 /* list of modifier keys to match accelerator for top level menus */
|
|
|
70 Lisp_Object Vmenu_accelerator_modifiers;
|
|
|
71
|
|
|
72 /* whether menu accelerators are enabled */
|
|
|
73 Lisp_Object Vmenu_accelerator_enabled;
|
|
|
74
|
|
|
75 /* keymap for auxiliary menu accelerator functions */
|
|
|
76 Lisp_Object Vmenu_accelerator_map;
|
|
|
77
|
|
|
78 Lisp_Object Qmenu_force;
|
|
|
79 Lisp_Object Qmenu_fallback;
|
|
|
80 Lisp_Object Qmenu_quit;
|
|
|
81 Lisp_Object Qmenu_up;
|
|
|
82 Lisp_Object Qmenu_down;
|
|
|
83 Lisp_Object Qmenu_left;
|
|
|
84 Lisp_Object Qmenu_right;
|
|
|
85 Lisp_Object Qmenu_select;
|
|
|
86 Lisp_Object Qmenu_escape;
|
|
|
87
|
|
428
|
88 static int
|
|
|
89 menubar_variable_changed (Lisp_Object sym, Lisp_Object *val,
|
|
|
90 Lisp_Object in_object, int flags)
|
|
|
91 {
|
|
|
92 MARK_MENUBAR_CHANGED;
|
|
|
93 return 0;
|
|
|
94 }
|
|
|
95
|
|
|
96 void
|
|
|
97 update_frame_menubars (struct frame *f)
|
|
|
98 {
|
|
|
99 if (f->menubar_changed || f->windows_changed)
|
|
|
100 MAYBE_FRAMEMETH (f, update_frame_menubars, (f));
|
|
|
101
|
|
|
102 f->menubar_changed = 0;
|
|
|
103 }
|
|
|
104
|
|
|
105 void
|
|
|
106 free_frame_menubars (struct frame *f)
|
|
|
107 {
|
|
|
108 /* If we had directly allocated any memory for the menubars instead
|
|
|
109 of using all Lisp_Objects this is where we would now free it. */
|
|
|
110
|
|
|
111 MAYBE_FRAMEMETH (f, free_frame_menubars, (f));
|
|
|
112 }
|
|
|
113
|
|
|
114 static void
|
|
|
115 menubar_visible_p_changed (Lisp_Object specifier, struct window *w,
|
|
|
116 Lisp_Object oldval)
|
|
|
117 {
|
|
|
118 MARK_MENUBAR_CHANGED;
|
|
|
119 }
|
|
|
120
|
|
|
121 static void
|
|
|
122 menubar_visible_p_changed_in_frame (Lisp_Object specifier, struct frame *f,
|
|
|
123 Lisp_Object oldval)
|
|
|
124 {
|
|
|
125 update_frame_menubars (f);
|
|
|
126 }
|
|
|
127
|
|
|
128 Lisp_Object
|
|
442
|
129 current_frame_menubar (const struct frame* f)
|
|
428
|
130 {
|
|
|
131 struct window *w = XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f));
|
|
|
132 return symbol_value_in_buffer (Qcurrent_menubar, w->buffer);
|
|
|
133 }
|
|
|
134
|
|
|
135 Lisp_Object
|
|
|
136 menu_parse_submenu_keywords (Lisp_Object desc, Lisp_Object gui_item)
|
|
|
137 {
|
|
442
|
138 Lisp_Gui_Item *pgui_item = XGUI_ITEM (gui_item);
|
|
428
|
139
|
|
|
140 /* Menu descriptor should be a list */
|
|
|
141 CHECK_CONS (desc);
|
|
|
142
|
|
|
143 /* First element may be menu name, although can be omitted.
|
|
|
144 Let's think that if stuff begins with anything than a keyword
|
|
|
145 or a list (submenu), this is a menu name, expected to be a string */
|
|
|
146 if (!KEYWORDP (XCAR (desc)) && !CONSP (XCAR (desc)))
|
|
|
147 {
|
|
|
148 CHECK_STRING (XCAR (desc));
|
|
|
149 pgui_item->name = XCAR (desc);
|
|
|
150 desc = XCDR (desc);
|
|
|
151 if (!NILP (desc))
|
|
|
152 CHECK_CONS (desc);
|
|
|
153 }
|
|
|
154
|
|
|
155 /* Walk along all key-value pairs */
|
|
|
156 while (!NILP(desc) && KEYWORDP (XCAR (desc)))
|
|
|
157 {
|
|
|
158 Lisp_Object key, val;
|
|
|
159 key = XCAR (desc);
|
|
|
160 desc = XCDR (desc);
|
|
|
161 CHECK_CONS (desc);
|
|
|
162 val = XCAR (desc);
|
|
|
163 desc = XCDR (desc);
|
|
|
164 if (!NILP (desc))
|
|
|
165 CHECK_CONS (desc);
|
|
|
166 gui_item_add_keyval_pair (gui_item, key, val, ERROR_ME);
|
|
|
167 }
|
|
|
168
|
|
|
169 /* Return the rest - supposed to be a list of items */
|
|
|
170 return desc;
|
|
|
171 }
|
|
|
172
|
|
|
173 DEFUN ("menu-find-real-submenu", Fmenu_find_real_submenu, 2, 2, 0, /*
|
|
|
174 Find a submenu descriptor within DESC by following PATH.
|
|
|
175 This function finds a submenu descriptor, either from the description
|
|
|
176 DESC or generated by a filter within DESC. The function regards :config
|
|
|
177 and :included keywords in the DESC, and expands submenus along the
|
|
|
178 PATH using :filter functions. Return value is a descriptor for the
|
|
|
179 submenu, NOT expanded and NOT checked against :config and :included.
|
|
|
180 Also, individual menu items are not looked for, only submenus.
|
|
|
181
|
|
|
182 See also 'find-menu-item'.
|
|
|
183 */
|
|
|
184 (desc, path))
|
|
|
185 {
|
|
|
186 Lisp_Object path_entry, submenu_desc, submenu;
|
|
442
|
187 struct gcpro gcpro1, gcpro2;
|
|
428
|
188 Lisp_Object gui_item = allocate_gui_item ();
|
|
440
|
189 Lisp_Gui_Item* pgui_item = XGUI_ITEM (gui_item);
|
|
428
|
190
|
|
442
|
191 GCPRO2 (gui_item, desc);
|
|
428
|
192
|
|
|
193 EXTERNAL_LIST_LOOP (path_entry, path)
|
|
|
194 {
|
|
|
195 /* Verify that DESC describes a menu, not single item */
|
|
|
196 if (!CONSP (desc))
|
|
|
197 RETURN_UNGCPRO (Qnil);
|
|
|
198
|
|
|
199 /* Parse this menu */
|
|
|
200 desc = menu_parse_submenu_keywords (desc, gui_item);
|
|
|
201
|
|
|
202 /* Check that this (sub)menu is active */
|
|
|
203 if (!gui_item_active_p (gui_item))
|
|
|
204 RETURN_UNGCPRO (Qnil);
|
|
|
205
|
|
|
206 /* Apply :filter */
|
|
|
207 if (!NILP (pgui_item->filter))
|
|
|
208 desc = call1 (pgui_item->filter, desc);
|
|
|
209
|
|
|
210 /* Find the next menu on the path inside this one */
|
|
|
211 EXTERNAL_LIST_LOOP (submenu_desc, desc)
|
|
|
212 {
|
|
|
213 submenu = XCAR (submenu_desc);
|
|
|
214 if (CONSP (submenu)
|
|
|
215 && STRINGP (XCAR (submenu))
|
|
|
216 && !NILP (Fstring_equal (XCAR (submenu), XCAR (path_entry))))
|
|
|
217 {
|
|
|
218 desc = submenu;
|
|
|
219 goto descend;
|
|
|
220 }
|
|
|
221 }
|
|
|
222 /* Submenu not found */
|
|
|
223 RETURN_UNGCPRO (Qnil);
|
|
|
224
|
|
|
225 descend:
|
|
|
226 /* Prepare for the next iteration */
|
|
|
227 gui_item_init (gui_item);
|
|
|
228 }
|
|
|
229
|
|
|
230 /* We have successfully descended down the end of the path */
|
|
|
231 UNGCPRO;
|
|
|
232 return desc;
|
|
|
233 }
|
|
|
234
|
|
|
235 DEFUN ("popup-menu", Fpopup_menu, 1, 2, 0, /*
|
|
444
|
236 Pop up the menu described by MENU-DESCRIPTION.
|
|
428
|
237 A menu description is a list of menu items, strings, and submenus.
|
|
|
238
|
|
|
239 The first element of a menu must be a string, which is the name of the menu.
|
|
|
240 This is the string that will be displayed in the parent menu, if any. For
|
|
|
241 toplevel menus, it is ignored. This string is not displayed in the menu
|
|
|
242 itself.
|
|
|
243
|
|
|
244 If an element of a menu is a string, then that string will be presented in
|
|
|
245 the menu as unselectable text.
|
|
|
246
|
|
|
247 If an element of a menu is a string consisting solely of hyphens, then that
|
|
|
248 item will be presented as a solid horizontal line.
|
|
|
249
|
|
|
250 If an element of a menu is a list, it is treated as a submenu. The name of
|
|
|
251 that submenu (the first element in the list) will be used as the name of the
|
|
|
252 item representing this menu on the parent.
|
|
|
253
|
|
|
254 Otherwise, the element must be a vector, which describes a menu item.
|
|
|
255 A menu item can have any of the following forms:
|
|
|
256
|
|
|
257 [ "name" callback <active-p> ]
|
|
|
258 [ "name" callback <active-p> <suffix> ]
|
|
|
259 [ "name" callback :<keyword> <value> :<keyword> <value> ... ]
|
|
|
260
|
|
|
261 The name is the string to display on the menu; it is filtered through the
|
|
|
262 resource database, so it is possible for resources to override what string
|
|
|
263 is actually displayed.
|
|
|
264
|
|
|
265 If the `callback' of a menu item is a symbol, then it must name a command.
|
|
|
266 It will be invoked with `call-interactively'. If it is a list, then it is
|
|
|
267 evaluated with `eval'.
|
|
|
268
|
|
|
269 The possible keywords are this:
|
|
|
270
|
|
|
271 :active <form> Same as <active-p> in the first two forms: the
|
|
|
272 expression is evaluated just before the menu is
|
|
|
273 displayed, and the menu will be selectable only if
|
|
|
274 the result is non-nil.
|
|
|
275
|
|
|
276 :suffix <form> Same as <suffix> in the second form: the expression
|
|
|
277 is evaluated just before the menu is displayed and
|
|
|
278 resulting string is appended to the displayed name,
|
|
|
279 providing a convenient way of adding the name of a
|
|
|
280 command's ``argument'' to the menu, like
|
|
|
281 ``Kill Buffer NAME''.
|
|
|
282
|
|
|
283 :keys "string" Normally, the keyboard equivalents of commands in
|
|
|
284 menus are displayed when the `callback' is a symbol.
|
|
|
285 This can be used to specify keys for more complex menu
|
|
|
286 items. It is passed through `substitute-command-keys'
|
|
|
287 first.
|
|
|
288
|
|
|
289 :style <style> Specifies what kind of object this menu item is:
|
|
|
290
|
|
|
291 nil A normal menu item.
|
|
|
292 toggle A toggle button.
|
|
|
293 radio A radio button.
|
|
|
294
|
|
|
295 The only difference between toggle and radio buttons is
|
|
|
296 how they are displayed. But for consistency, a toggle
|
|
|
297 button should be used when there is one option whose
|
|
|
298 value can be turned on or off, and radio buttons should
|
|
|
299 be used when there is a set of mutually exclusive
|
|
|
300 options. When using a group of radio buttons, you
|
|
|
301 should arrange for no more than one to be marked as
|
|
|
302 selected at a time.
|
|
|
303
|
|
|
304 :selected <form> Meaningful only when STYLE is `toggle' or `radio'.
|
|
|
305 This specifies whether the button will be in the
|
|
|
306 selected or unselected state.
|
|
|
307
|
|
|
308 For example:
|
|
|
309
|
|
|
310 [ "Save As..." write-file t ]
|
|
|
311 [ "Revert Buffer" revert-buffer (buffer-modified-p) ]
|
|
|
312 [ "Read Only" toggle-read-only :style toggle :selected buffer-read-only ]
|
|
|
313
|
|
|
314 See menubar.el for many more examples.
|
|
|
315 */
|
|
444
|
316 (menu_description, event))
|
|
428
|
317 {
|
|
444
|
318 struct frame *f = decode_frame (Qnil);
|
|
|
319 MAYBE_FRAMEMETH (f, popup_menu, (menu_description, event));
|
|
428
|
320 return Qnil;
|
|
|
321 }
|
|
|
322
|
|
|
323 DEFUN ("normalize-menu-item-name", Fnormalize_menu_item_name, 1, 2, 0, /*
|
|
|
324 Convert a menu item name string into normal form, and return the new string.
|
|
|
325 Menu item names should be converted to normal form before being compared.
|
|
442
|
326 This removes %_'s (accelerator indications) and converts %% to %.
|
|
428
|
327 */
|
|
|
328 (name, buffer))
|
|
|
329 {
|
|
|
330 struct buffer *buf = decode_buffer (buffer, 0);
|
|
|
331 Charcount end;
|
|
|
332 int i;
|
|
665
|
333 Intbyte *name_data;
|
|
|
334 Intbyte *string_result;
|
|
|
335 Intbyte *string_result_ptr;
|
|
428
|
336 Emchar elt;
|
|
|
337 int expecting_underscore = 0;
|
|
|
338
|
|
|
339 CHECK_STRING (name);
|
|
|
340
|
|
793
|
341 end = XSTRING_CHAR_LENGTH (name);
|
|
|
342 name_data = XSTRING_DATA (name);
|
|
428
|
343
|
|
665
|
344 string_result = (Intbyte *) alloca (end * MAX_EMCHAR_LEN);
|
|
428
|
345 string_result_ptr = string_result;
|
|
|
346 for (i = 0; i < end; i++)
|
|
|
347 {
|
|
|
348 elt = charptr_emchar (name_data);
|
|
|
349 elt = DOWNCASE (buf, elt);
|
|
|
350 if (expecting_underscore)
|
|
|
351 {
|
|
|
352 expecting_underscore = 0;
|
|
|
353 switch (elt)
|
|
|
354 {
|
|
|
355 case '%':
|
|
|
356 /* Allow `%%' to mean `%'. */
|
|
|
357 string_result_ptr += set_charptr_emchar (string_result_ptr, '%');
|
|
|
358 break;
|
|
|
359 case '_':
|
|
|
360 break;
|
|
|
361 default:
|
|
|
362 string_result_ptr += set_charptr_emchar (string_result_ptr, '%');
|
|
|
363 string_result_ptr += set_charptr_emchar (string_result_ptr, elt);
|
|
|
364 }
|
|
|
365 }
|
|
|
366 else if (elt == '%')
|
|
|
367 expecting_underscore = 1;
|
|
|
368 else
|
|
|
369 string_result_ptr += set_charptr_emchar (string_result_ptr, elt);
|
|
|
370 INC_CHARPTR (name_data);
|
|
|
371 }
|
|
|
372
|
|
442
|
373 if (string_result_ptr - string_result == XSTRING_LENGTH (name)
|
|
|
374 && !memcmp (string_result, XSTRING_DATA (name), XSTRING_LENGTH (name)))
|
|
|
375 return name;
|
|
|
376
|
|
428
|
377 return make_string (string_result, string_result_ptr - string_result);
|
|
|
378 }
|
|
|
379
|
|
|
380 void
|
|
|
381 syms_of_menubar (void)
|
|
|
382 {
|
|
563
|
383 DEFSYMBOL (Qcurrent_menubar);
|
|
442
|
384
|
|
563
|
385 DEFSYMBOL (Qmenu_force);
|
|
|
386 DEFSYMBOL (Qmenu_fallback);
|
|
442
|
387
|
|
563
|
388 DEFSYMBOL (Qmenu_quit);
|
|
|
389 DEFSYMBOL (Qmenu_up);
|
|
|
390 DEFSYMBOL (Qmenu_down);
|
|
|
391 DEFSYMBOL (Qmenu_left);
|
|
|
392 DEFSYMBOL (Qmenu_right);
|
|
|
393 DEFSYMBOL (Qmenu_select);
|
|
|
394 DEFSYMBOL (Qmenu_escape);
|
|
442
|
395
|
|
428
|
396 DEFSUBR (Fpopup_menu);
|
|
|
397 DEFSUBR (Fnormalize_menu_item_name);
|
|
|
398 DEFSUBR (Fmenu_find_real_submenu);
|
|
|
399 }
|
|
|
400
|
|
|
401 void
|
|
|
402 vars_of_menubar (void)
|
|
|
403 {
|
|
440
|
404 /* put in Vblank_menubar a menubar value which has no visible
|
|
|
405 * items. This is a bit tricky due to various quirks. We
|
|
|
406 * could use '(["" nil nil]), but this is apparently equivalent
|
|
|
407 * to '(nil), and a new frame created with this menubar will
|
|
|
408 * get a vertically-squished menubar. If we use " " as the
|
|
|
409 * button title instead of "", we get an etched button border.
|
|
|
410 * So we use
|
|
|
411 * '(("No active menubar" ["" nil nil]))
|
|
|
412 * which creates a menu whose title is "No active menubar",
|
|
|
413 * and this works fine.
|
|
|
414 */
|
|
428
|
415
|
|
771
|
416 Vblank_menubar = list1 (list2 (build_msg_string ("No active menubar"),
|
|
440
|
417 vector3 (build_string (""), Qnil, Qnil)));
|
|
|
418 staticpro (&Vblank_menubar);
|
|
428
|
419
|
|
|
420 DEFVAR_BOOL ("popup-menu-titles", &popup_menu_titles /*
|
|
|
421 If true, popup menus will have title bars at the top.
|
|
|
422 */ );
|
|
|
423 popup_menu_titles = 1;
|
|
|
424
|
|
|
425 /* #### Replace current menubar with a specifier. */
|
|
|
426
|
|
|
427 /* All C code must access the menubar via Qcurrent_menubar
|
|
|
428 because it can be buffer-local. Note that Vcurrent_menubar
|
|
|
429 doesn't need to exist at all, except for the magic function. */
|
|
|
430
|
|
|
431 DEFVAR_LISP_MAGIC ("current-menubar", &Vcurrent_menubar /*
|
|
|
432 The current menubar. This may be buffer-local.
|
|
|
433
|
|
|
434 When the menubar is changed, the function `set-menubar-dirty-flag' has to
|
|
|
435 be called for the menubar to be updated on the frame. See `set-menubar'
|
|
|
436 and `set-buffer-menubar'.
|
|
|
437
|
|
|
438 A menubar is a list of menus and menu-items.
|
|
|
439 A menu is a list of menu items, keyword-value pairs, strings, and submenus.
|
|
|
440
|
|
|
441 The first element of a menu must be a string, which is the name of the menu.
|
|
|
442 This is the string that will be displayed in the parent menu, if any. For
|
|
|
443 toplevel menus, it is ignored. This string is not displayed in the menu
|
|
|
444 itself.
|
|
|
445
|
|
442
|
446 Menu accelerators can be indicated in the string by putting the
|
|
|
447 sequence "%_" before the character corresponding to the key that will
|
|
|
448 invoke the menu or menu item. Uppercase and lowercase accelerators
|
|
|
449 are equivalent. The sequence "%%" is also special, and is translated
|
|
|
450 into a single %.
|
|
|
451
|
|
|
452 If no menu accelerator is present in the string, XEmacs will act as if
|
|
|
453 the first character has been tagged as an accelerator.
|
|
|
454
|
|
|
455 Immediately following the name string of the menu, various optional
|
|
|
456 keyword-value pairs are permitted: currently, :filter, :active, :included,
|
|
|
457 and :config. (See below.)
|
|
428
|
458
|
|
|
459 If an element of a menu (or menubar) is a string, then that string will be
|
|
|
460 presented as unselectable text.
|
|
|
461
|
|
|
462 If an element of a menu is a string consisting solely of hyphens, then that
|
|
|
463 item will be presented as a solid horizontal line.
|
|
|
464
|
|
442
|
465 If an element of a menu is a string beginning with "--:", it will be
|
|
|
466 presented as a line whose appearance is controlled by the rest of the
|
|
|
467 text in the string. The allowed line specs are system-dependent, and
|
|
|
468 currently work only under X Windows (with Lucid and Motif menubars);
|
|
|
469 otherwise, a solid horizontal line is presented, as if the string were
|
|
|
470 all hyphens.
|
|
|
471
|
|
|
472 The possibilities are:
|
|
|
473
|
|
|
474 "--:singleLine"
|
|
|
475 "--:doubleLine"
|
|
|
476 "--:singleDashedLine"
|
|
|
477 "--:doubleDashedLine"
|
|
|
478 "--:noLine"
|
|
|
479 "--:shadowEtchedIn"
|
|
|
480 "--:shadowEtchedOut"
|
|
|
481 "--:shadowEtchedInDash"
|
|
|
482 "--:shadowEtchedOutDash"
|
|
|
483 "--:shadowDoubleEtchedIn" (Lucid menubars only)
|
|
|
484 "--:shadowDoubleEtchedOut" (Lucid menubars only)
|
|
|
485 "--:shadowDoubleEtchedInDash" (Lucid menubars only)
|
|
|
486 "--:shadowDoubleEtchedOutDash" (Lucid menubars only)
|
|
|
487
|
|
428
|
488 If an element of a menu is a list, it is treated as a submenu. The name of
|
|
|
489 that submenu (the first element in the list) will be used as the name of the
|
|
|
490 item representing this menu on the parent.
|
|
|
491
|
|
|
492 If an element of a menubar is `nil', then it is used to represent the
|
|
|
493 division between the set of menubar-items which are flushleft and those
|
|
|
494 which are flushright.
|
|
|
495
|
|
|
496 Otherwise, the element must be a vector, which describes a menu item.
|
|
442
|
497 A menu item is of the following form:
|
|
|
498
|
|
|
499 [ "name" callback :<keyword> <value> :<keyword> <value> ... ]
|
|
|
500
|
|
|
501 The following forms are also accepted for compatibility, but deprecated:
|
|
428
|
502
|
|
|
503 [ "name" callback <active-p> ]
|
|
|
504 [ "name" callback <active-p> <suffix> ]
|
|
|
505
|
|
|
506 The name is the string to display on the menu; it is filtered through the
|
|
|
507 resource database, so it is possible for resources to override what string
|
|
442
|
508 is actually displayed. Menu accelerator indicators (the sequence `%_') are
|
|
|
509 also processed; see above. If the name is not a string, it will be
|
|
|
510 evaluated with `eval', and the result should be a string.
|
|
428
|
511
|
|
|
512 If the `callback' of a menu item is a symbol, then it must name a command.
|
|
|
513 It will be invoked with `call-interactively'. If it is a list, then it is
|
|
|
514 evaluated with `eval'.
|
|
|
515
|
|
442
|
516 In the deprecated forms, <active-p> is equivalent to using the :active
|
|
|
517 keyword, and <suffix> is equivalent to using the :suffix keyword.
|
|
428
|
518
|
|
442
|
519 The possible keywords are:
|
|
|
520
|
|
|
521 :active <form> The expression is evaluated just before the menu is
|
|
428
|
522 displayed, and the menu will be selectable only if
|
|
|
523 the result is non-nil.
|
|
|
524
|
|
442
|
525 :suffix <form> The expression is evaluated just before the menu is
|
|
|
526 displayed and the resulting string is appended to
|
|
|
527 the displayed name, providing a convenient way of
|
|
|
528 adding the name of a command's ``argument'' to the
|
|
|
529 menu, like ``Kill Buffer NAME''.
|
|
428
|
530
|
|
|
531 :keys "string" Normally, the keyboard equivalents of commands in
|
|
|
532 menus are displayed when the `callback' is a symbol.
|
|
|
533 This can be used to specify keys for more complex menu
|
|
|
534 items. It is passed through `substitute-command-keys'
|
|
|
535 first.
|
|
|
536
|
|
|
537 :style <style> Specifies what kind of object this menu item is:
|
|
|
538
|
|
|
539 nil A normal menu item.
|
|
|
540 toggle A toggle button.
|
|
|
541 radio A radio button.
|
|
|
542 button A menubar button.
|
|
|
543
|
|
|
544 The only difference between toggle and radio buttons is
|
|
|
545 how they are displayed. But for consistency, a toggle
|
|
|
546 button should be used when there is one option whose
|
|
|
547 value can be turned on or off, and radio buttons should
|
|
|
548 be used when there is a set of mutually exclusive
|
|
|
549 options. When using a group of radio buttons, you
|
|
|
550 should arrange for no more than one to be marked as
|
|
|
551 selected at a time.
|
|
|
552
|
|
|
553 :selected <form> Meaningful only when STYLE is `toggle', `radio' or
|
|
|
554 `button'. This specifies whether the button will be in
|
|
|
555 the selected or unselected state.
|
|
|
556
|
|
|
557 :included <form> This can be used to control the visibility of a menu or
|
|
|
558 menu item. The form is evaluated and the menu or menu
|
|
|
559 item is only displayed if the result is non-nil.
|
|
|
560
|
|
|
561 :config <symbol> This is an efficient shorthand for
|
|
|
562 :included (memq symbol menubar-configuration)
|
|
|
563 See the variable `menubar-configuration'.
|
|
|
564
|
|
442
|
565 :filter <function> A menu filter can only be used at the beginning of a
|
|
|
566 submenu description (i.e. not in a menu item itself).
|
|
|
567 (Remember that most of the keywords can take evaluated
|
|
|
568 expressions as well as constants.) The filter is used to
|
|
|
569 incrementally create a submenu only when it is selected
|
|
|
570 by the user and not every time the menubar is activated.
|
|
|
571 The filter function is passed the list of menu items in
|
|
|
572 the submenu and must return the modified list to be
|
|
|
573 actually used. The filter MUST NOT destructively modify
|
|
|
574 the list of menu items passed to it. It is called only
|
|
|
575 when the menu is about to be displayed, so other menus
|
|
|
576 may already be displayed. Vile and terrible things will
|
|
|
577 happen if a menu filter function changes the current
|
|
|
578 buffer, window, or frame. It also should not raise,
|
|
|
579 lower, or iconify any frames. Basically, the filter
|
|
|
580 function should have no side-effects.
|
|
428
|
581
|
|
|
582 :key-sequence keys Used in FSF Emacs as an hint to an equivalent keybinding.
|
|
442
|
583 Ignored by XEmacs for easymenu.el compatibility.
|
|
|
584 (XEmacs computes this information automatically.)
|
|
428
|
585
|
|
|
586 For example:
|
|
|
587
|
|
442
|
588 ("%_File"
|
|
428
|
589 :filter file-menu-filter ; file-menu-filter is a function that takes
|
|
|
590 ; one argument (a list of menu items) and
|
|
|
591 ; returns a list of menu items
|
|
442
|
592 [ "Save %_As..." write-file t ]
|
|
|
593 [ "%_Revert Buffer" revert-buffer (buffer-modified-p) ]
|
|
|
594 [ "R%_ead Only" toggle-read-only :style toggle
|
|
428
|
595 :selected buffer-read-only ]
|
|
|
596 )
|
|
|
597
|
|
442
|
598 See menubar-items.el for many more examples.
|
|
428
|
599
|
|
|
600 After the menubar is clicked upon, but before any menus are popped up,
|
|
|
601 the functions on the `activate-menubar-hook' are invoked to make top-level
|
|
|
602 changes to the menus and menubar. Note, however, that the use of menu
|
|
|
603 filters (using the :filter keyword) is usually a more efficient way to
|
|
442
|
604 dynamically alter or sensitize menus. */, menubar_variable_changed);
|
|
428
|
605
|
|
|
606 Vcurrent_menubar = Qnil;
|
|
|
607
|
|
|
608 DEFVAR_LISP ("activate-menubar-hook", &Vactivate_menubar_hook /*
|
|
|
609 Function or functions called before a menubar menu is pulled down.
|
|
|
610 These functions are called with no arguments, and should interrogate and
|
|
|
611 modify the value of `current-menubar' as desired.
|
|
|
612
|
|
|
613 The functions on this hook are invoked after the mouse goes down, but before
|
|
|
614 the menu is mapped, and may be used to activate, deactivate, add, or delete
|
|
|
615 items from the menus. However, it is probably the case that using a :filter
|
|
|
616 keyword in a submenu would be a more efficient way of updating menus. See
|
|
|
617 the documentation of `current-menubar'.
|
|
|
618
|
|
|
619 These functions may return the symbol `t' to assert that they have made
|
|
|
620 no changes to the menubar. If any other value is returned, the menubar is
|
|
|
621 recomputed. If `t' is returned but the menubar has been changed, then the
|
|
|
622 changes may not show up right away. Returning `nil' when the menubar has
|
|
|
623 not changed is not so bad; more computation will be done, but redisplay of
|
|
|
624 the menubar will still be performed optimally.
|
|
|
625 */ );
|
|
|
626 Vactivate_menubar_hook = Qnil;
|
|
563
|
627 DEFSYMBOL (Qactivate_menubar_hook);
|
|
428
|
628
|
|
|
629 DEFVAR_BOOL ("menubar-show-keybindings", &menubar_show_keybindings /*
|
|
|
630 If true, the menubar will display keyboard equivalents.
|
|
|
631 If false, only the command names will be displayed.
|
|
|
632 */ );
|
|
|
633 menubar_show_keybindings = 1;
|
|
|
634
|
|
|
635 DEFVAR_LISP_MAGIC ("menubar-configuration", &Vmenubar_configuration /*
|
|
|
636 A list of symbols, against which the value of the :config tag for each
|
|
|
637 menubar item will be compared. If a menubar item has a :config tag, then
|
|
|
638 it is omitted from the menubar if that tag is not a member of the
|
|
|
639 `menubar-configuration' list.
|
|
|
640 */ , menubar_variable_changed);
|
|
|
641 Vmenubar_configuration = Qnil;
|
|
|
642
|
|
|
643 DEFVAR_LISP ("menubar-pointer-glyph", &Vmenubar_pointer_glyph /*
|
|
|
644 *The shape of the mouse-pointer when over the menubar.
|
|
|
645 This is a glyph; use `set-glyph-image' to change it.
|
|
|
646 If unspecified in a particular domain, the window-system-provided
|
|
|
647 default pointer is used.
|
|
|
648 */ );
|
|
|
649
|
|
442
|
650 DEFVAR_LISP ("menu-accelerator-prefix", &Vmenu_accelerator_prefix /*
|
|
|
651 Prefix key(s) that must be typed before menu accelerators will be activated.
|
|
|
652 Set this to a value acceptable by define-key.
|
|
|
653
|
|
|
654 NOTE: This currently only has any effect under X Windows.
|
|
|
655 */ );
|
|
|
656 Vmenu_accelerator_prefix = Qnil;
|
|
|
657
|
|
|
658 DEFVAR_LISP ("menu-accelerator-modifiers", &Vmenu_accelerator_modifiers /*
|
|
|
659 Modifier keys which must be pressed to get to the top level menu accelerators.
|
|
|
660 This is a list of modifier key symbols. All modifier keys must be held down
|
|
|
661 while a valid menu accelerator key is pressed in order for the top level
|
|
|
662 menu to become active.
|
|
|
663
|
|
|
664 NOTE: This currently only has any effect under X Windows.
|
|
|
665
|
|
|
666 See also menu-accelerator-enabled and menu-accelerator-prefix.
|
|
|
667 */ );
|
|
|
668 Vmenu_accelerator_modifiers = list1 (Qmeta);
|
|
|
669
|
|
|
670 DEFVAR_LISP ("menu-accelerator-enabled", &Vmenu_accelerator_enabled /*
|
|
|
671 Whether menu accelerator keys can cause the menubar to become active.
|
|
|
672 If 'menu-force or 'menu-fallback, then menu accelerator keys can
|
|
|
673 be used to activate the top level menu. Once the menubar becomes active, the
|
|
|
674 accelerator keys can be used regardless of the value of this variable.
|
|
|
675
|
|
|
676 menu-force is used to indicate that the menu accelerator key takes
|
|
|
677 precedence over bindings in the current keymap(s). menu-fallback means
|
|
|
678 that bindings in the current keymap take precedence over menu accelerator keys.
|
|
|
679 Thus a top level menu with an accelerator of "T" would be activated on a
|
|
|
680 keypress of Meta-t if menu-accelerator-enabled is menu-force.
|
|
|
681 However, if menu-accelerator-enabled is menu-fallback, then
|
|
|
682 Meta-t will not activate the menubar and will instead run the function
|
|
|
683 transpose-words, to which it is normally bound.
|
|
|
684
|
|
|
685 See also menu-accelerator-modifiers and menu-accelerator-prefix.
|
|
|
686 */ );
|
|
|
687 Vmenu_accelerator_enabled = Qnil;
|
|
|
688
|
|
|
689 DEFVAR_LISP ("menu-accelerator-map", &Vmenu_accelerator_map /*
|
|
|
690 Keymap for use when the menubar is active.
|
|
|
691 The actions menu-quit, menu-up, menu-down, menu-left, menu-right,
|
|
|
692 menu-select and menu-escape can be mapped to keys in this map.
|
|
|
693 NOTE: This currently only has any effect under X Windows.
|
|
|
694
|
|
|
695 menu-quit Immediately deactivate the menubar and any open submenus without
|
|
|
696 selecting an item.
|
|
|
697 menu-up Move the menu cursor up one row in the current menu. If the
|
|
|
698 move extends past the top of the menu, wrap around to the bottom.
|
|
|
699 menu-down Move the menu cursor down one row in the current menu. If the
|
|
|
700 move extends past the bottom of the menu, wrap around to the top.
|
|
|
701 If executed while the cursor is in the top level menu, move down
|
|
|
702 into the selected menu.
|
|
|
703 menu-left Move the cursor from a submenu into the parent menu. If executed
|
|
|
704 while the cursor is in the top level menu, move the cursor to the
|
|
|
705 left. If the move extends past the left edge of the menu, wrap
|
|
|
706 around to the right edge.
|
|
|
707 menu-right Move the cursor into a submenu. If the cursor is located in the
|
|
|
708 top level menu or is not currently on a submenu heading, then move
|
|
|
709 the cursor to the next top level menu entry. If the move extends
|
|
|
710 past the right edge of the menu, wrap around to the left edge.
|
|
|
711 menu-select Activate the item under the cursor. If the cursor is located on
|
|
|
712 a submenu heading, then move the cursor into the submenu.
|
|
|
713 menu-escape Pop up to the next level of menus. Moves from a submenu into its
|
|
|
714 parent menu. From the top level menu, this deactivates the
|
|
|
715 menubar.
|
|
|
716
|
|
|
717 This keymap can also contain normal key-command bindings, in which case the
|
|
|
718 menubar is deactivated and the corresponding command is executed.
|
|
|
719
|
|
|
720 The action bindings used by the menu accelerator code are designed to mimic
|
|
|
721 the actions of menu traversal keys in a commonly used PC operating system.
|
|
|
722 */ );
|
|
|
723
|
|
428
|
724 Fprovide (intern ("menubar"));
|
|
464
|
725 Fprovide (intern ("menu-accelerator-support"));
|
|
428
|
726 }
|
|
|
727
|
|
|
728 void
|
|
|
729 specifier_vars_of_menubar (void)
|
|
|
730 {
|
|
|
731 DEFVAR_SPECIFIER ("menubar-visible-p", &Vmenubar_visible_p /*
|
|
|
732 *Whether the menubar is visible.
|
|
|
733 This is a specifier; use `set-specifier' to change it.
|
|
|
734 */ );
|
|
|
735 Vmenubar_visible_p = Fmake_specifier (Qboolean);
|
|
|
736
|
|
|
737 set_specifier_fallback (Vmenubar_visible_p, list1 (Fcons (Qnil, Qt)));
|
|
|
738 set_specifier_caching (Vmenubar_visible_p,
|
|
438
|
739 offsetof (struct window, menubar_visible_p),
|
|
428
|
740 menubar_visible_p_changed,
|
|
438
|
741 offsetof (struct frame, menubar_visible_p),
|
|
444
|
742 menubar_visible_p_changed_in_frame, 0);
|
|
428
|
743 }
|
|
|
744
|
|
|
745 void
|
|
|
746 complex_vars_of_menubar (void)
|
|
|
747 {
|
|
|
748 Vmenubar_pointer_glyph = Fmake_glyph_internal (Qpointer);
|
|
442
|
749
|
|
|
750 Vmenu_accelerator_map = Fmake_keymap (Qnil);
|
|
428
|
751 }
|
