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