|
0
|
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.
|
|
|
4
|
|
|
5 This file is part of XEmacs.
|
|
|
6
|
|
|
7 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
8 under the terms of the GNU General Public License as published by the
|
|
|
9 Free Software Foundation; either version 2, or (at your option) any
|
|
|
10 later version.
|
|
|
11
|
|
|
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
15 for more details.
|
|
|
16
|
|
|
17 You should have received a copy of the GNU General Public License
|
|
|
18 along with XEmacs; see the file COPYING. If not, write to
|
|
|
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
20 Boston, MA 02111-1307, USA. */
|
|
|
21
|
|
|
22 /* Synched up with: Not in FSF. */
|
|
|
23
|
|
|
24 /* #### There ain't much here because menubars have not been
|
|
|
25 properly abstracted yet. */
|
|
|
26
|
|
|
27 #include <config.h>
|
|
|
28 #include "lisp.h"
|
|
|
29
|
|
|
30 #include "device.h"
|
|
|
31 #include "frame.h"
|
|
|
32 #include "menubar.h"
|
|
|
33 #include "redisplay.h"
|
|
|
34 #include "window.h"
|
|
|
35
|
|
|
36 int menubar_show_keybindings;
|
|
|
37 Lisp_Object Vmenubar_configuration;
|
|
|
38
|
|
|
39 Lisp_Object Qcurrent_menubar;
|
|
|
40
|
|
|
41 Lisp_Object Qactivate_menubar_hook, Vactivate_menubar_hook;
|
|
|
42
|
|
|
43 Lisp_Object Vmenubar_visible_p;
|
|
|
44
|
|
|
45 static Lisp_Object Vcurrent_menubar; /* DO NOT ever reference this.
|
|
|
46 Always go through Qcurrent_menubar.
|
|
|
47 See below. */
|
|
|
48 Lisp_Object Vblank_menubar;
|
|
|
49
|
|
|
50 int popup_menu_titles;
|
|
|
51
|
|
|
52 Lisp_Object Vmenubar_pointer_glyph;
|
|
|
53
|
|
|
54 static int
|
|
|
55 menubar_variable_changed (Lisp_Object sym, Lisp_Object *val,
|
|
|
56 Lisp_Object in_object, int flags)
|
|
|
57 {
|
|
|
58 MARK_MENUBAR_CHANGED;
|
|
|
59 return 0;
|
|
|
60 }
|
|
|
61
|
|
|
62 void
|
|
|
63 update_frame_menubars (struct frame *f)
|
|
|
64 {
|
|
|
65 if (f->menubar_changed || f->windows_changed)
|
|
|
66 MAYBE_FRAMEMETH (f, update_frame_menubars, (f));
|
|
|
67
|
|
|
68 f->menubar_changed = 0;
|
|
|
69 }
|
|
|
70
|
|
|
71 void
|
|
|
72 free_frame_menubars (struct frame *f)
|
|
|
73 {
|
|
|
74 /* If we had directly allocated any memory for the menubars instead
|
|
|
75 of using all Lisp_Objects this is where we would now free it. */
|
|
|
76
|
|
|
77 MAYBE_FRAMEMETH (f, free_frame_menubars, (f));
|
|
|
78 }
|
|
|
79
|
|
|
80 static void
|
|
|
81 menubar_visible_p_changed (Lisp_Object specifier, struct window *w,
|
|
|
82 Lisp_Object oldval)
|
|
|
83 {
|
|
|
84 MARK_MENUBAR_CHANGED;
|
|
|
85 }
|
|
|
86
|
|
|
87 static void
|
|
|
88 menubar_visible_p_changed_in_frame (Lisp_Object specifier, struct frame *f,
|
|
|
89 Lisp_Object oldval)
|
|
|
90 {
|
|
|
91 update_frame_menubars (f);
|
|
|
92 }
|
|
|
93
|
|
20
|
94 DEFUN ("popup-menu", Fpopup_menu, 1, 2, 0, /*
|
|
0
|
95 Pop up the given menu.
|
|
|
96 A menu description is a list of menu items, strings, and submenus.
|
|
|
97
|
|
|
98 The first element of a menu must be a string, which is the name of the menu.
|
|
|
99 This is the string that will be displayed in the parent menu, if any. For
|
|
|
100 toplevel menus, it is ignored. This string is not displayed in the menu
|
|
|
101 itself.
|
|
|
102
|
|
|
103 If an element of a menu is a string, then that string will be presented in
|
|
|
104 the menu as unselectable text.
|
|
|
105
|
|
|
106 If an element of a menu is a string consisting solely of hyphens, then that
|
|
|
107 item will be presented as a solid horizontal line.
|
|
|
108
|
|
|
109 If an element of a menu is a list, it is treated as a submenu. The name of
|
|
|
110 that submenu (the first element in the list) will be used as the name of the
|
|
|
111 item representing this menu on the parent.
|
|
|
112
|
|
|
113 Otherwise, the element must be a vector, which describes a menu item.
|
|
|
114 A menu item can have any of the following forms:
|
|
|
115
|
|
|
116 [ \"name\" callback <active-p> ]
|
|
|
117 [ \"name\" callback <active-p> \"suffix\" ]
|
|
|
118 [ \"name\" callback :<keyword> <value> :<keyword> <value> ... ]
|
|
|
119
|
|
|
120 The name is the string to display on the menu; it is filtered through the
|
|
|
121 resource database, so it is possible for resources to override what string
|
|
|
122 is actually displayed.
|
|
|
123
|
|
|
124 If the `callback' of a menu item is a symbol, then it must name a command.
|
|
|
125 It will be invoked with `call-interactively'. If it is a list, then it is
|
|
|
126 evaluated with `eval'.
|
|
|
127
|
|
|
128 The possible keywords are this:
|
|
|
129
|
|
|
130 :active <form> Same as <active-p> in the first two forms: the
|
|
|
131 expression is evaluated just before the menu is
|
|
|
132 displayed, and the menu will be selectable only if
|
|
|
133 the result is non-nil.
|
|
|
134
|
|
|
135 :suffix \"string\" Same as \"suffix\" in the second form: the suffix is
|
|
|
136 appended to the displayed name, providing a convenient
|
|
|
137 way of adding the name of a command's ``argument'' to
|
|
|
138 the menu, like ``Kill Buffer NAME''.
|
|
|
139
|
|
|
140 :keys \"string\" Normally, the keyboard equivalents of commands in
|
|
|
141 menus are displayed when the `callback' is a symbol.
|
|
|
142 This can be used to specify keys for more complex menu
|
|
|
143 items. It is passed through `substitute-command-keys'
|
|
|
144 first.
|
|
|
145
|
|
|
146 :style <style> Specifies what kind of object this menu item is:
|
|
|
147
|
|
|
148 nil A normal menu item.
|
|
|
149 toggle A toggle button.
|
|
|
150 radio A radio button.
|
|
|
151
|
|
|
152 The only difference between toggle and radio buttons is
|
|
|
153 how they are displayed. But for consistency, a toggle
|
|
|
154 button should be used when there is one option whose
|
|
|
155 value can be turned on or off, and radio buttons should
|
|
|
156 be used when there is a set of mutually exclusive
|
|
|
157 options. When using a group of radio buttons, you
|
|
|
158 should arrange for no more than one to be marked as
|
|
|
159 selected at a time.
|
|
|
160
|
|
|
161 :selected <form> Meaningful only when STYLE is `toggle' or `radio'.
|
|
|
162 This specifies whether the button will be in the
|
|
|
163 selected or unselected state.
|
|
|
164
|
|
|
165 For example:
|
|
|
166
|
|
|
167 [ \"Save As...\" write-file t ]
|
|
|
168 [ \"Revert Buffer\" revert-buffer (buffer-modified-p) ]
|
|
|
169 [ \"Read Only\" toggle-read-only :style toggle :selected buffer-read-only ]
|
|
|
170
|
|
|
171 See menubar.el for many more examples.
|
|
20
|
172 */
|
|
|
173 (menu_desc, event))
|
|
0
|
174 {
|
|
|
175 struct frame *f = decode_frame(Qnil);
|
|
|
176 MAYBE_FRAMEMETH (f, popup_menu, (menu_desc,event));
|
|
|
177 return Qnil;
|
|
|
178 }
|
|
|
179
|
|
|
180 void
|
|
|
181 syms_of_menubar (void)
|
|
|
182 {
|
|
|
183 defsymbol (&Qcurrent_menubar, "current-menubar");
|
|
20
|
184 DEFSUBR (Fpopup_menu);
|
|
0
|
185 }
|
|
|
186
|
|
|
187 void
|
|
|
188 vars_of_menubar (void)
|
|
|
189 {
|
|
|
190 {
|
|
|
191 /* put in Vblank_menubar a menubar value which has no visible
|
|
|
192 * items. This is a bit tricky due to various quirks. We
|
|
|
193 * could use '(["" nil nil]), but this is apparently equivalent
|
|
|
194 * to '(nil), and a new frame created with this menubar will
|
|
|
195 * get a vertically-squished menubar. If we use " " as the
|
|
|
196 * button title instead of "", we get an etched button border.
|
|
|
197 * So we use
|
|
|
198 * '(("No active menubar" ["" nil nil]))
|
|
|
199 * which creates a menu whose title is "No active menubar",
|
|
|
200 * and this works fine.
|
|
|
201 */
|
|
|
202
|
|
|
203 Lisp_Object menu_item[3];
|
|
|
204 static CONST char *blank_msg = "No active menubar";
|
|
|
205
|
|
|
206 menu_item[0] = build_string ("");
|
|
|
207 menu_item[1] = Qnil;
|
|
|
208 menu_item[2] = Qnil;
|
|
|
209 Vblank_menubar = Fcons (Fcons (build_string (blank_msg),
|
|
|
210 Fcons (Fvector (3, &menu_item[0]),
|
|
|
211 Qnil)),
|
|
|
212 Qnil);
|
|
|
213 Vblank_menubar = Fpurecopy (Vblank_menubar);
|
|
|
214 staticpro (&Vblank_menubar);
|
|
|
215 }
|
|
|
216
|
|
|
217 DEFVAR_BOOL ("popup-menu-titles", &popup_menu_titles /*
|
|
|
218 If true, popup menus will have title bars at the top.
|
|
|
219 */ );
|
|
|
220 popup_menu_titles = 1;
|
|
|
221
|
|
|
222 /* #### Replace current menubar with a specifier. */
|
|
|
223
|
|
|
224 /* All C code must access the menubar via Qcurrent_menubar
|
|
|
225 because it can be buffer-local. Note that Vcurrent_menubar
|
|
|
226 doesn't need to exist at all, except for the magic function. */
|
|
|
227
|
|
|
228 DEFVAR_LISP_MAGIC ("current-menubar", &Vcurrent_menubar /*
|
|
|
229 The current menubar. This may be buffer-local.
|
|
|
230
|
|
|
231 When the menubar is changed, the function `set-menubar-dirty-flag' has to
|
|
|
232 be called for the menubar to be updated on the frame. See `set-menubar'
|
|
|
233 and `set-buffer-menubar'.
|
|
|
234
|
|
|
235 A menubar is a list of menus and menu-items.
|
|
|
236 A menu is a list of menu items, keyword-value pairs, strings, and submenus.
|
|
|
237
|
|
|
238 The first element of a menu must be a string, which is the name of the menu.
|
|
|
239 This is the string that will be displayed in the parent menu, if any. For
|
|
|
240 toplevel menus, it is ignored. This string is not displayed in the menu
|
|
|
241 itself.
|
|
|
242
|
|
|
243 Immediately following the name string of the menu, any of three
|
|
|
244 optional keyword-value pairs is permitted.
|
|
|
245
|
|
|
246 If an element of a menu (or menubar) is a string, then that string will be
|
|
|
247 presented 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 If an element of a menubar is `nil', then it is used to represent the
|
|
|
257 division between the set of menubar-items which are flushleft and those
|
|
|
258 which are flushright.
|
|
|
259
|
|
|
260 Otherwise, the element must be a vector, which describes a menu item.
|
|
|
261 A menu item can have any of the following forms:
|
|
|
262
|
|
|
263 [ \"name\" callback <active-p> ]
|
|
|
264 [ \"name\" callback <active-p> \"suffix\" ]
|
|
|
265 [ \"name\" callback :<keyword> <value> :<keyword> <value> ... ]
|
|
|
266
|
|
|
267 The name is the string to display on the menu; it is filtered through the
|
|
|
268 resource database, so it is possible for resources to override what string
|
|
|
269 is actually displayed.
|
|
|
270
|
|
|
271 If the `callback' of a menu item is a symbol, then it must name a command.
|
|
|
272 It will be invoked with `call-interactively'. If it is a list, then it is
|
|
|
273 evaluated with `eval'.
|
|
|
274
|
|
|
275 The possible keywords are this:
|
|
|
276
|
|
|
277 :active <form> Same as <active-p> in the first two forms: the
|
|
|
278 expression is evaluated just before the menu is
|
|
|
279 displayed, and the menu will be selectable only if
|
|
|
280 the result is non-nil.
|
|
|
281
|
|
|
282 :suffix \"string\" Same as \"suffix\" in the second form: the suffix is
|
|
|
283 appended to the displayed name, providing a convenient
|
|
|
284 way of adding the name of a command's ``argument'' to
|
|
|
285 the menu, like ``Kill Buffer NAME''.
|
|
|
286
|
|
|
287 :keys \"string\" Normally, the keyboard equivalents of commands in
|
|
|
288 menus are displayed when the `callback' is a symbol.
|
|
|
289 This can be used to specify keys for more complex menu
|
|
|
290 items. It is passed through `substitute-command-keys'
|
|
|
291 first.
|
|
|
292
|
|
|
293 :style <style> Specifies what kind of object this menu item is:
|
|
|
294
|
|
|
295 nil A normal menu item.
|
|
|
296 toggle A toggle button.
|
|
|
297 radio A radio button.
|
|
|
298 button A menubar button.
|
|
|
299
|
|
|
300 The only difference between toggle and radio buttons is
|
|
|
301 how they are displayed. But for consistency, a toggle
|
|
|
302 button should be used when there is one option whose
|
|
|
303 value can be turned on or off, and radio buttons should
|
|
|
304 be used when there is a set of mutually exclusive
|
|
|
305 options. When using a group of radio buttons, you
|
|
|
306 should arrange for no more than one to be marked as
|
|
|
307 selected at a time.
|
|
|
308
|
|
|
309 :selected <form> Meaningful only when STYLE is `toggle', `radio' or
|
|
|
310 `button'. This specifies whether the button will be in
|
|
|
311 the selected or unselected state.
|
|
|
312
|
|
|
313 :included <form> This can be used to control the visibility of a menu or
|
|
|
314 menu item. The form is evaluated and the menu or menu
|
|
|
315 item is only displayed if the result is non-nil.
|
|
|
316
|
|
|
317 :config <symbol> This is an efficient shorthand for
|
|
|
318 :included (memq symbol menubar-configuration)
|
|
|
319 See the variable `menubar-configuration'.
|
|
|
320
|
|
|
321 :filter <function> A menu filter can only be used in a menu item list.
|
|
|
322 (i.e.: not in a menu item itself). It is used to
|
|
|
323 sensitize or incrementally create a submenu only when
|
|
|
324 it is selected by the user and not every time the
|
|
|
325 menubar is activated. The filter function is passed
|
|
|
326 the list of menu items in the submenu and must return a
|
|
|
327 list of menu items to be used for the menu. It is
|
|
|
328 called only when the menu is about to be displayed, so
|
|
|
329 other menus may already be displayed. Vile and
|
|
|
330 terrible things will happen if a menu filter function
|
|
|
331 changes the current buffer, window, or frame. It
|
|
|
332 also should not raise, lower, or iconify any frames.
|
|
|
333 Basically, the filter function should have no
|
|
|
334 side-effects.
|
|
|
335
|
|
|
336 For example:
|
|
|
337
|
|
|
338 (\"File\"
|
|
|
339 :filter file-menu-filter ; file-menu-filter is a function that takes
|
|
|
340 ; one argument (a list of menu items) and
|
|
|
341 ; returns a list of menu items
|
|
|
342 [ \"Save As...\" write-file t ]
|
|
|
343 [ \"Revert Buffer\" revert-buffer (buffer-modified-p) ]
|
|
|
344 [ \"Read Only\" toggle-read-only :style toggle
|
|
|
345 :selected buffer-read-only ]
|
|
|
346 )
|
|
|
347
|
|
|
348 See x-menubar.el for many more examples.
|
|
|
349
|
|
|
350 After the menubar is clicked upon, but before any menus are popped up,
|
|
|
351 the functions on the `activate-menubar-hook' are invoked to make top-level
|
|
|
352 changes to the menus and menubar. Note, however, that the use of menu
|
|
|
353 filters (using the :filter keyword) is usually a more efficient way to
|
|
|
354 dynamically alter or sensitize menus.
|
|
|
355 */, menubar_variable_changed);
|
|
|
356
|
|
|
357 Vcurrent_menubar = Qnil;
|
|
|
358
|
|
|
359 DEFVAR_LISP ("activate-menubar-hook", &Vactivate_menubar_hook /*
|
|
|
360 Function or functions called before a menubar menu is pulled down.
|
|
|
361 These functions are called with no arguments, and should interrogate and
|
|
|
362 modify the value of `current-menubar' as desired.
|
|
|
363
|
|
|
364 The functions on this hook are invoked after the mouse goes down, but before
|
|
|
365 the menu is mapped, and may be used to activate, deactivate, add, or delete
|
|
|
366 items from the menus. However, it is probably the case that using a :filter
|
|
|
367 keyword in a submenu would be a more efficient way of updating menus. See
|
|
|
368 the documentation of `current-menubar'.
|
|
|
369
|
|
|
370 These functions may return the symbol `t' to assert that they have made
|
|
|
371 no changes to the menubar. If any other value is returned, the menubar is
|
|
|
372 recomputed. If `t' is returned but the menubar has been changed, then the
|
|
|
373 changes may not show up right away. Returning `nil' when the menubar has
|
|
|
374 not changed is not so bad; more computation will be done, but redisplay of
|
|
|
375 the menubar will still be performed optimally.
|
|
|
376 */ );
|
|
|
377 Vactivate_menubar_hook = Qnil;
|
|
|
378 defsymbol (&Qactivate_menubar_hook, "activate-menubar-hook");
|
|
|
379
|
|
|
380 DEFVAR_BOOL ("menubar-show-keybindings", &menubar_show_keybindings /*
|
|
|
381 If true, the menubar will display keyboard equivalents.
|
|
|
382 If false, only the command names will be displayed.
|
|
|
383 */ );
|
|
|
384 menubar_show_keybindings = 1;
|
|
|
385
|
|
|
386 DEFVAR_LISP_MAGIC ("menubar-configuration", &Vmenubar_configuration /*
|
|
|
387 A list of symbols, against which the value of the :config tag for each
|
|
|
388 menubar item will be compared. If a menubar item has a :config tag, then
|
|
|
389 it is omitted from the menubar if that tag is not a member of the
|
|
|
390 `menubar-configuration' list.
|
|
|
391 */ , menubar_variable_changed);
|
|
|
392 Vmenubar_configuration = Qnil;
|
|
|
393
|
|
|
394 DEFVAR_LISP ("menubar-pointer-glyph", &Vmenubar_pointer_glyph /*
|
|
|
395 *The shape of the mouse-pointer when over the menubar.
|
|
|
396 This is a glyph; use `set-glyph-image' to change it.
|
|
|
397 If unspecified in a particular domain, the window-system-provided
|
|
|
398 default pointer is used.
|
|
|
399 */ );
|
|
|
400
|
|
|
401 Fprovide (intern ("menubar"));
|
|
|
402 }
|
|
|
403
|
|
|
404 void
|
|
|
405 specifier_vars_of_menubar (void)
|
|
|
406 {
|
|
|
407 DEFVAR_SPECIFIER ("menubar-visible-p", &Vmenubar_visible_p /*
|
|
|
408 *Whether the menubar is visible.
|
|
|
409 This is a specifier; use `set-specifier' to change it.
|
|
|
410 */ );
|
|
|
411 Vmenubar_visible_p = Fmake_specifier (Qboolean);
|
|
|
412
|
|
|
413 set_specifier_fallback (Vmenubar_visible_p, list1 (Fcons (Qnil, Qt)));
|
|
|
414 set_specifier_caching (Vmenubar_visible_p,
|
|
|
415 slot_offset (struct window,
|
|
|
416 menubar_visible_p),
|
|
|
417 menubar_visible_p_changed,
|
|
|
418 slot_offset (struct frame,
|
|
|
419 menubar_visible_p),
|
|
|
420 menubar_visible_p_changed_in_frame);
|
|
|
421 }
|
|
|
422
|
|
|
423 void
|
|
|
424 complex_vars_of_menubar (void)
|
|
|
425 {
|
|
|
426 Vmenubar_pointer_glyph = Fmake_glyph_internal (Qpointer);
|
|
|
427 }
|
