|
0
|
1 @c -*-texinfo-*-
|
|
|
2 @c This is part of the XEmacs Lisp Reference Manual.
|
|
175
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1997 Free Software Foundation, Inc.
|
|
0
|
4 @c Copyright (C) 1995 Sun Microsystems.
|
|
|
5 @c See the file lispref.texi for copying conditions.
|
|
|
6 @setfilename ../../info/menu.info
|
|
|
7 @node Menus, Dialog Boxes, Keymaps, Top
|
|
|
8 @chapter Menus
|
|
|
9 @cindex menu
|
|
|
10
|
|
|
11 @menu
|
|
|
12 * Menu Format:: Format of a menu description.
|
|
|
13 * Menubar Format:: How to specify a menubar.
|
|
|
14 * Menubar:: Functions for controlling the menubar.
|
|
|
15 * Modifying Menus:: Modifying a menu description.
|
|
|
16 * Pop-Up Menus:: Functions for specifying pop-up menus.
|
|
|
17 * Menu Filters:: Filter functions for the default menubar.
|
|
175
|
18 * Menu Accelerators:: Using and controlling menu accelerator keys
|
|
0
|
19 * Buffers Menu:: The menu that displays the list of buffers.
|
|
|
20 @end menu
|
|
|
21
|
|
|
22 @node Menu Format
|
|
|
23 @section Format of Menus
|
|
|
24 @cindex menu format
|
|
|
25 @cindex format of menus
|
|
|
26
|
|
|
27 A menu is described using a @dfn{menu description}, which is a list of
|
|
|
28 menu items, keyword-value pairs, strings, and submenus. The menu
|
|
|
29 description specifies which items are present in the menu, what function
|
|
|
30 each item invokes, and whether the item is selectable or not. Pop-up
|
|
|
31 menus are directly described with a menu description, while menubars are
|
|
|
32 described slightly differently (see below).
|
|
|
33
|
|
|
34 The first element of a menu must be a string, which is the name of the
|
|
|
35 menu. This is the string that will be displayed in the parent menu or
|
|
|
36 menubar, if any. This string is not displayed in the menu itself,
|
|
|
37 except in the case of the top level pop-up menu, where there is no
|
|
|
38 parent. In this case, the string will be displayed at the top of the
|
|
|
39 menu if @code{popup-menu-titles} is non-@code{nil}.
|
|
|
40
|
|
|
41 Immediately following the first element there may optionally be up
|
|
175
|
42 to four keyword-value pairs, as follows:
|
|
0
|
43
|
|
|
44 @table @code
|
|
|
45 @item :included @var{form}
|
|
|
46 This can be used to control the visibility of a menu. The form is
|
|
|
47 evaluated and the menu will be omitted if the result is @code{nil}.
|
|
|
48
|
|
|
49 @item :config @var{symbol}
|
|
|
50 This is an efficient shorthand for @code{:included (memq @var{symbol}
|
|
|
51 menubar-configuration)}. See the variable @code{menubar-configuration}.
|
|
|
52
|
|
|
53 @item :filter @var{function}
|
|
|
54 A menu filter is used to sensitize or incrementally create a submenu
|
|
|
55 only when it is selected by the user and not every time the menubar is
|
|
|
56 activated. The filter function is passed the list of menu items in the
|
|
|
57 submenu and must return a list of menu items to be used for the menu.
|
|
|
58 It is called only when the menu is about to be displayed, so other menus
|
|
|
59 may already be displayed. Vile and terrible things will happen if a
|
|
|
60 menu filter function changes the current buffer, window, or frame. It
|
|
|
61 also should not raise, lower, or iconify any frames. Basically, the
|
|
|
62 filter function should have no side-effects.
|
|
175
|
63
|
|
|
64 @item :accelerator @var{key}
|
|
|
65 A menu accelerator is a keystroke which can be pressed while the menu is
|
|
|
66 visible which will immediately activate the item. @var{key} must be a char
|
|
|
67 or the symbol name of a key. @xref{Menu Accelerators}.
|
|
0
|
68 @end table
|
|
|
69
|
|
|
70 The rest of the menu consists of elements as follows:
|
|
|
71
|
|
|
72 @itemize @bullet
|
|
|
73 @item
|
|
|
74 A @dfn{menu item}, which is a vector in the following form:
|
|
|
75
|
|
|
76 @example
|
|
|
77 @code{[ @var{name} @var{callback} @var{:keyword} @var{value} @var{:keyword} @var{value} ... ]}
|
|
|
78 @end example
|
|
|
79
|
|
|
80 @var{name} is a string, the name of the menu item; it is the string to
|
|
|
81 display on the menu. It is filtered through the resource database, so
|
|
|
82 it is possible for resources to override what string is actually
|
|
|
83 displayed.
|
|
|
84
|
|
|
85 @var{callback} is a form that will be invoked when the menu item is
|
|
|
86 selected. If the callback of a menu item is a symbol, then it must name
|
|
|
87 a command. It will be invoked with @code{call-interactively}. If it is
|
|
|
88 a list, then it is evaluated with @code{eval}.
|
|
|
89
|
|
|
90 The valid keywords and their meanings are described below.
|
|
|
91
|
|
|
92 Note that for compatibility purposes, the form
|
|
|
93
|
|
|
94 @example
|
|
|
95 @code{[ @var{name} @var{callback} @var{active-p} ]}
|
|
|
96 @end example
|
|
|
97
|
|
|
98 is also accepted and is equivalent to
|
|
|
99
|
|
|
100 @example
|
|
|
101 @code{[ @var{name} @var{callback} :active @var{active-p} ]}
|
|
|
102 @end example
|
|
|
103
|
|
|
104 and the form
|
|
|
105
|
|
|
106 @example
|
|
|
107 @code{[ @var{name} @var{callback} @var{active-p} @var{suffix}]}
|
|
|
108 @end example
|
|
|
109
|
|
|
110 is accepted and is equivalent to
|
|
|
111
|
|
|
112 @example
|
|
|
113 @code{[ @var{name} @var{callback} :active @var{active-p} :suffix @var{suffix}]}
|
|
|
114 @end example
|
|
|
115
|
|
|
116 However, these older forms are deprecated and should generally not be used.
|
|
|
117
|
|
|
118 @item
|
|
|
119 If an element of a menu is a string, then that string will be presented
|
|
|
120 in the menu as unselectable text.
|
|
|
121
|
|
|
122 @item
|
|
|
123 If an element of a menu is a string consisting solely of hyphens, then
|
|
|
124 that item will be presented as a solid horizontal line.
|
|
|
125
|
|
|
126 @item
|
|
|
127 If an element of a menu is a string beginning with @samp{--:}, then
|
|
|
128 a particular sort of horizontal line will be displayed, as follows:
|
|
|
129
|
|
|
130 @table @samp
|
|
|
131 @item "--:singleLine"
|
|
|
132 A solid horizontal line. This is equivalent to a string consisting
|
|
|
133 solely of hyphens.
|
|
|
134 @item "--:doubleLine"
|
|
|
135 A solid double horizontal line.
|
|
|
136 @item "--:singleDashedLine"
|
|
|
137 A dashed horizontal line.
|
|
|
138 @item "--:doubleDashedLine"
|
|
|
139 A dashed double horizontal line.
|
|
|
140 @item "--:noLine"
|
|
|
141 No line (but a small space is left).
|
|
|
142 @item "--:shadowEtchedIn"
|
|
|
143 A solid horizontal line with a 3-d recessed appearance.
|
|
|
144 @item "--:shadowEtchedOut"
|
|
|
145 A solid horizontal line with a 3-d pushed-out appearance.
|
|
|
146 @item "--:shadowDoubleEtchedIn"
|
|
|
147 A solid double horizontal line with a 3-d recessed appearance.
|
|
|
148 @item "--:shadowDoubleEtchedOut"
|
|
|
149 A solid double horizontal line with a 3-d pushed-out appearance.
|
|
|
150 @item "--:shadowEtchedInDash"
|
|
|
151 A dashed horizontal line with a 3-d recessed appearance.
|
|
|
152 @item "--:shadowEtchedOutDash"
|
|
|
153 A dashed horizontal line with a 3-d pushed-out appearance.
|
|
|
154 @item "--:shadowDoubleEtchedInDash"
|
|
|
155 A dashed double horizontal line with a 3-d recessed appearance.
|
|
|
156 @item "--:shadowDoubleEtchedOutDash"
|
|
|
157 A dashed double horizontal line with a 3-d pushed-out appearance.
|
|
|
158 @end table
|
|
|
159
|
|
|
160 @item
|
|
|
161 If an element of a menu is a list, it is treated as a submenu. The name
|
|
|
162 of that submenu (the first element in the list) will be used as the name
|
|
|
163 of the item representing this menu on the parent.
|
|
|
164 @end itemize
|
|
|
165
|
|
|
166 The possible keywords are as follows:
|
|
|
167
|
|
|
168 @table @asis
|
|
|
169 @item :active @var{form}
|
|
|
170 @var{form} will be evaluated when the menu that this item is a part of
|
|
|
171 is about to be displayed, and the item will be selectable only if the
|
|
|
172 result is non-@code{nil}. If the item is unselectable, it will
|
|
|
173 usually be displayed grayed-out to indicate this.
|
|
|
174
|
|
|
175 @item :suffix @var{string}
|
|
|
176 The string is appended to the displayed name. This provides a
|
|
|
177 convenient way of adding the name of a command's ``argument'' to the
|
|
2
|
178 menu, like @samp{Kill Buffer NAME}.
|
|
0
|
179
|
|
|
180 @item :keys @var{string}
|
|
|
181 Normally, the keyboard equivalents of commands in menus are displayed
|
|
|
182 when the ``callback'' is a symbol. This can be used to specify keys for
|
|
|
183 more complex menu items. It is passed through
|
|
|
184 @code{substitute-command-keys} first.
|
|
|
185
|
|
|
186 @item :style @var{style}
|
|
|
187 Specifies what kind of object this menu item is. @var{style} be one
|
|
|
188 of the symbols
|
|
|
189
|
|
|
190 @table @code
|
|
|
191 @item nil
|
|
|
192 A normal menu item.
|
|
|
193 @item toggle
|
|
|
194 A toggle button.
|
|
|
195 @item radio
|
|
|
196 A radio button.
|
|
|
197 @item button
|
|
|
198 A menubar button.
|
|
|
199 @end table
|
|
|
200
|
|
|
201 The only difference between toggle and radio buttons is how they are
|
|
|
202 displayed. But for consistency, a toggle button should be used when
|
|
|
203 there is one option whose value can be turned on or off, and radio
|
|
|
204 buttons should be used when there is a set of mutually exclusive options.
|
|
|
205 When using a group of radio buttons, you should arrange for no more than
|
|
|
206 one to be marked as selected at a time.
|
|
|
207
|
|
|
208 @item :selected @var{form}
|
|
|
209 Meaningful only when @var{style} is @code{toggle}, @code{radio} or
|
|
|
210 @code{button}. This specifies whether the button will be in the
|
|
|
211 selected or unselected state. @var{form} is evaluated, as for
|
|
|
212 @code{:active}.
|
|
|
213
|
|
|
214 @item :included @var{form}
|
|
|
215 This can be used to control the visibility of a menu item. The form is
|
|
|
216 evaluated and the menu item is only displayed if the result is
|
|
|
217 non-@code{nil}. Note that this is different from @code{:active}: If
|
|
|
218 @code{:active} evaluates to @code{nil}, the item will be displayed
|
|
|
219 grayed out, while if @code{:included} evaluates to @code{nil}, the item
|
|
|
220 will be omitted entirely.
|
|
|
221
|
|
|
222 @item :config @var{symbol}
|
|
|
223 This is an efficient shorthand for @code{:included (memq @var{symbol}
|
|
|
224 menubar-configuration)}. See the variable @code{menubar-configuration}.
|
|
175
|
225
|
|
|
226 @item :accelerator @var{key}
|
|
|
227 A menu accelerator is a keystroke which can be pressed while the menu is
|
|
|
228 visible which will immediately activate the item. @var{key} must be a char
|
|
|
229 or the symbol name of a key. @xref{Menu Accelerators}.
|
|
0
|
230 @end table
|
|
|
231
|
|
|
232 @defvar menubar-configuration
|
|
|
233 This variable holds a list of symbols, against which the value of the
|
|
|
234 @code{:config} tag for each menubar item will be compared. If a menubar
|
|
|
235 item has a @code{:config} tag, then it is omitted from the menubar if
|
|
|
236 that tag is not a member of the @code{menubar-configuration} list.
|
|
|
237 @end defvar
|
|
|
238
|
|
|
239 For example:
|
|
|
240
|
|
|
241 @example
|
|
|
242 ("File"
|
|
|
243 :filter file-menu-filter ; file-menu-filter is a function that takes
|
|
|
244 ; one argument (a list of menu items) and
|
|
|
245 ; returns a list of menu items
|
|
|
246 [ "Save As..." write-file t ]
|
|
|
247 [ "Revert Buffer" revert-buffer (buffer-modified-p) ]
|
|
|
248 [ "Read Only" toggle-read-only :style toggle :selected buffer-read-only ]
|
|
|
249 )
|
|
|
250 @end example
|
|
|
251
|
|
|
252 @node Menubar Format
|
|
|
253 @section Format of the Menubar
|
|
|
254 @cindex menubar format
|
|
|
255 @cindex format of the menubar
|
|
|
256
|
|
|
257 A menubar is a list of menus, menu items, and strings. The format is
|
|
|
258 similar to that of a menu, except:
|
|
|
259
|
|
|
260 @itemize @bullet
|
|
|
261 @item
|
|
|
262 The first item need not be a string, and is not treated specially.
|
|
|
263
|
|
|
264 @item
|
|
|
265 A string consisting solely of hyphens is not treated specially.
|
|
|
266
|
|
|
267 @item
|
|
|
268 If an element of a menubar is @code{nil}, then it is used to represent
|
|
|
269 the division between the set of menubar items which are flush-left and
|
|
|
270 those which are flush-right. (Note: this isn't completely implemented
|
|
|
271 yet.)
|
|
|
272 @end itemize
|
|
|
273
|
|
|
274 @node Menubar
|
|
|
275 @section Menubar
|
|
|
276 @cindex menubar
|
|
|
277
|
|
|
278 @defvar current-menubar
|
|
|
279 This variable holds the description of the current menubar. This may be
|
|
|
280 buffer-local. When the menubar is changed, the function
|
|
|
281 @code{set-menubar-dirty-flag} has to be called in order for the menubar
|
|
|
282 to be updated on the screen.
|
|
|
283 @end defvar
|
|
|
284
|
|
|
285 @defvr Constant default-menubar
|
|
|
286 This variable holds the menubar description of the menubar that is
|
|
|
287 visible at startup. This is the value that @code{current-menubar}
|
|
|
288 has at startup.
|
|
|
289 @end defvr
|
|
|
290
|
|
|
291 @defun set-menubar-dirty-flag
|
|
|
292 This function tells XEmacs that the menubar widget has to be updated.
|
|
|
293 Changes to the menubar will generally not be visible until this function
|
|
|
294 is called.
|
|
|
295 @end defun
|
|
|
296
|
|
|
297 The following convenience functions are provided for setting the
|
|
|
298 menubar. They are equivalent to doing the appropriate action to change
|
|
|
299 @code{current-menubar}, and then calling @code{set-menubar-dirty-flag}.
|
|
|
300 Note that these functions copy their argument using
|
|
|
301 @code{copy-sequence}.
|
|
|
302
|
|
|
303 @defun set-menubar menubar
|
|
|
304 This function sets the default menubar to be @var{menubar} (@pxref{Menu
|
|
|
305 Format}). This is the menubar that will be visible in buffers that
|
|
|
306 have not defined their own, buffer-local menubar.
|
|
|
307 @end defun
|
|
|
308
|
|
|
309 @defun set-buffer-menubar menubar
|
|
|
310 This function sets the buffer-local menubar to be @var{menubar}. This
|
|
|
311 does not change the menubar in any buffers other than the current one.
|
|
|
312 @end defun
|
|
|
313
|
|
|
314 Miscellaneous:
|
|
|
315
|
|
|
316 @defvar menubar-show-keybindings
|
|
|
317 If true, the menubar will display keyboard equivalents. If false, only
|
|
|
318 the command names will be displayed.
|
|
|
319 @end defvar
|
|
|
320
|
|
|
321 @defvar activate-menubar-hook
|
|
|
322 Function or functions called before a menubar menu is pulled down.
|
|
|
323 These functions are called with no arguments, and should interrogate and
|
|
|
324 modify the value of @code{current-menubar} as desired.
|
|
|
325
|
|
|
326 The functions on this hook are invoked after the mouse goes down, but
|
|
|
327 before the menu is mapped, and may be used to activate, deactivate, add,
|
|
|
328 or delete items from the menus. However, using a filter (with the
|
|
|
329 @code{:filter} keyword in a menu description) is generally a more
|
|
|
330 efficient way of accomplishing the same thing, because the filter is
|
|
|
331 invoked only when the actual menu goes down. With a complex menu,
|
|
|
332 there can be a quite noticeable and sometimes aggravating delay if
|
|
|
333 all menu modification is implemented using the @code{activate-menubar-hook}.
|
|
|
334 See above.
|
|
|
335
|
|
|
336 These functions may return the symbol @code{t} to assert that they have
|
|
|
337 made no changes to the menubar. If any other value is returned, the
|
|
|
338 menubar is recomputed. If @code{t} is returned but the menubar has been
|
|
|
339 changed, then the changes may not show up right away. Returning
|
|
|
340 @code{nil} when the menubar has not changed is not so bad; more
|
|
|
341 computation will be done, but redisplay of the menubar will still be
|
|
|
342 performed optimally.
|
|
|
343 @end defvar
|
|
|
344
|
|
|
345 @defvar menu-no-selection-hook
|
|
|
346 Function or functions to call when a menu or dialog box is dismissed
|
|
|
347 without a selection having been made.
|
|
|
348 @end defvar
|
|
|
349
|
|
|
350 @node Modifying Menus
|
|
|
351 @section Modifying Menus
|
|
|
352
|
|
|
353 The following functions are provided to modify the menubar of one of its
|
|
|
354 submenus. Note that these functions modify the menu in-place, rather
|
|
|
355 than copying it and making a new menu.
|
|
|
356
|
|
|
357 Some of these functions take a @dfn{menu path}, which is a list of
|
|
|
358 strings identifying the menu to be modified. For example,
|
|
|
359 @code{("File")} names the top-level ``File'' menu. @code{("File"
|
|
|
360 "Foo")} names a hypothetical submenu of ``File''.
|
|
|
361
|
|
|
362 Others take a @dfn{menu item path}, which is similar to a menu path but
|
|
|
363 also specifies a particular item to be modified. For example,
|
|
|
364 @code{("File" "Save")} means the menu item called ``Save'' under the
|
|
|
365 top-level ``File'' menu. @code{("Menu" "Foo" "Item")} means the menu
|
|
|
366 item called ``Item'' under the ``Foo'' submenu of ``Menu''.
|
|
|
367
|
|
|
368 @defun add-submenu menu-path submenu &optional before
|
|
|
369 This function adds a menu to the menubar or one of its submenus. If the
|
|
|
370 named menu exists already, it is changed.
|
|
|
371
|
|
|
372 @var{menu-path} identifies the menu under which the new menu should be
|
|
|
373 inserted. If @var{menu-path} is @code{nil}, then the menu will be added
|
|
|
374 to the menubar itself.
|
|
|
375
|
|
|
376 @var{submenu} is the new menu to add (@pxref{Menu Format}).
|
|
|
377
|
|
|
378 @var{before}, if provided, is the name of a menu before which this menu
|
|
|
379 should be added, if this menu is not on its parent already. If the menu
|
|
|
380 is already present, it will not be moved.
|
|
|
381 @end defun
|
|
|
382
|
|
|
383 @defun add-menu-button menu-path menu-leaf &optional before
|
|
|
384 This function adds a menu item to some menu, creating the menu first if
|
|
|
385 necessary. If the named item exists already, it is changed.
|
|
|
386
|
|
|
387 @var{menu-path} identifies the menu under which the new menu item should
|
|
|
388 be inserted.
|
|
|
389
|
|
|
390 @var{menu-leaf} is a menubar leaf node (@pxref{Menu Format}).
|
|
|
391
|
|
|
392 @var{before}, if provided, is the name of a menu before which this item
|
|
|
393 should be added, if this item is not on the menu already. If the item
|
|
|
394 is already present, it will not be moved.
|
|
|
395 @end defun
|
|
|
396
|
|
|
397 @defun delete-menu-item menu-item-path
|
|
|
398 This function removes the menu item specified by @var{menu-item-path}
|
|
|
399 from the menu hierarchy.
|
|
|
400 @end defun
|
|
|
401
|
|
|
402 @defun enable-menu-item menu-item-path
|
|
|
403 This function makes the menu item specified by @var{menu-item-path} be
|
|
|
404 selectable.
|
|
|
405 @end defun
|
|
|
406
|
|
|
407 @defun disable-menu-item menu-item-path
|
|
|
408 This function makes the menu item specified by @var{menu-item-path} be
|
|
|
409 unselectable.
|
|
|
410 @end defun
|
|
|
411
|
|
|
412 @defun relabel-menu-item menu-item-path new-name
|
|
|
413 This function changes the string of the menu item specified by
|
|
|
414 @var{menu-item-path}. @var{new-name} is the string that the menu item
|
|
|
415 will be printed as from now on.
|
|
|
416 @end defun
|
|
|
417
|
|
|
418 The following function can be used to search for a particular item in
|
|
|
419 a menubar specification, given a path to the item.
|
|
|
420
|
|
|
421 @defun find-menu-item menubar menu-item-path &optional parent
|
|
|
422 This function searches @var{menubar} for the item given by
|
|
|
423 @var{menu-item-path} starting from @var{parent} (@code{nil} means start
|
|
|
424 at the top of @var{menubar}). This function returns @code{(@var{item}
|
|
|
425 . @var{parent})}, where @var{parent} is the immediate parent of the item
|
|
|
426 found (a menu description), and @var{item} is either a vector, list, or
|
|
|
427 string, depending on the nature of the menu item.
|
|
|
428
|
|
|
429 This function signals an error if the item is not found.
|
|
|
430 @end defun
|
|
|
431
|
|
|
432 The following deprecated functions are also documented, so that
|
|
|
433 existing code can be understood. You should not use these functions
|
|
|
434 in new code.
|
|
|
435
|
|
|
436 @defun add-menu menu-path menu-name menu-items &optional before
|
|
|
437 This function adds a menu to the menubar or one of its submenus. If the
|
|
|
438 named menu exists already, it is changed. This is obsolete; use
|
|
|
439 @code{add-submenu} instead.
|
|
|
440
|
|
|
441 @var{menu-path} identifies the menu under which the new menu should be
|
|
|
442 inserted. If @var{menu-path} is @code{nil}, then the menu will be added
|
|
|
443 to the menubar itself.
|
|
|
444
|
|
|
445 @var{menu-name} is the string naming the menu to be added;
|
|
|
446 @var{menu-items} is a list of menu items, strings, and submenus. These
|
|
|
447 two arguments are the same as the first and following elements of a menu
|
|
|
448 description (@pxref{Menu Format}).
|
|
|
449
|
|
|
450 @var{before}, if provided, is the name of a menu before which this
|
|
|
451 menu should be added, if this menu is not on its parent already. If the
|
|
|
452 menu is already present, it will not be moved.
|
|
|
453 @end defun
|
|
|
454
|
|
|
455 @defun add-menu-item menu-path item-name function enabled-p &optional before
|
|
|
456 This function adds a menu item to some menu, creating the menu first if
|
|
|
457 necessary. If the named item exists already, it is changed. This is
|
|
|
458 obsolete; use @code{add-menu-button} instead.
|
|
|
459
|
|
|
460 @var{menu-path} identifies the menu under which the new menu item should
|
|
|
461 be inserted. @var{item-name}, @var{function}, and @var{enabled-p} are
|
|
|
462 the first, second, and third elements of a menu item vector (@pxref{Menu
|
|
|
463 Format}).
|
|
|
464
|
|
|
465 @var{before}, if provided, is the name of a menu item before which this
|
|
|
466 item should be added, if this item is not on the menu already. If the
|
|
|
467 item is already present, it will not be moved.
|
|
|
468 @end defun
|
|
|
469
|
|
|
470 @node Menu Filters
|
|
|
471 @section Menu Filters
|
|
|
472 @cindex menu filters
|
|
|
473
|
|
|
474 The following filter functions are provided for use in
|
|
|
475 @code{default-menubar}. You may want to use them in your own menubar
|
|
|
476 description.
|
|
|
477
|
|
|
478 @defun file-menu-filter menu-items
|
|
|
479 This function changes the arguments and sensitivity of these File menu items:
|
|
|
480
|
|
|
481 @table @samp
|
|
|
482 @item Delete Buffer
|
|
|
483 Has the name of the current buffer appended to it.
|
|
|
484 @item Print Buffer
|
|
|
485 Has the name of the current buffer appended to it.
|
|
|
486 @item Pretty-Print Buffer
|
|
|
487 Has the name of the current buffer appended to it.
|
|
|
488 @item Save Buffer
|
|
|
489 Has the name of the current buffer appended to it, and is sensitive only
|
|
|
490 when the current buffer is modified.
|
|
|
491 @item Revert Buffer
|
|
|
492 Has the name of the current buffer appended to it, and is sensitive only
|
|
|
493 when the current buffer has a file.
|
|
|
494 @item Delete Frame
|
|
|
495 Sensitive only when there is more than one visible frame.
|
|
|
496 @end table
|
|
|
497 @end defun
|
|
|
498
|
|
|
499 @defun edit-menu-filter menu-items
|
|
|
500 This function changes the arguments and sensitivity of these Edit menu items:
|
|
|
501
|
|
|
502 @table @samp
|
|
|
503 @item Cut
|
|
|
504 Sensitive only when XEmacs owns the primary X Selection (if
|
|
|
505 @code{zmacs-regions} is @code{t}, this is equivalent to saying that
|
|
|
506 there is a region selected).
|
|
|
507 @item Copy
|
|
|
508 Sensitive only when XEmacs owns the primary X Selection.
|
|
|
509 @item Clear
|
|
|
510 Sensitive only when XEmacs owns the primary X Selection.
|
|
|
511 @item Paste
|
|
|
512 Sensitive only when there is an owner for the X Clipboard Selection.
|
|
|
513 @item Undo
|
|
|
514 Sensitive only when there is undo information. While in the midst of an
|
|
|
515 undo, this is changed to @samp{Undo More}.
|
|
|
516 @end table
|
|
|
517 @end defun
|
|
|
518
|
|
|
519 @defun buffers-menu-filter menu-items
|
|
|
520 This function sets up the Buffers menu. @xref{Buffers Menu} for
|
|
|
521 more information.
|
|
|
522 @end defun
|
|
|
523
|
|
|
524 @node Pop-Up Menus
|
|
|
525 @section Pop-Up Menus
|
|
|
526 @cindex pop-up menu
|
|
|
527
|
|
|
528 @defun popup-menu menu-desc
|
|
|
529 This function pops up a menu specified by @var{menu-desc}, which is a
|
|
|
530 menu description (@pxref{Menu Format}). The menu is displayed at the
|
|
|
531 current mouse position.
|
|
|
532 @end defun
|
|
|
533
|
|
|
534 @defun popup-menu-up-p
|
|
|
535 This function returns @code{t} if a pop-up menu is up, @code{nil}
|
|
|
536 otherwise.
|
|
|
537 @end defun
|
|
|
538
|
|
|
539 @defvar popup-menu-titles
|
|
|
540 If true (the default), pop-up menus will have title bars at the top.
|
|
|
541 @end defvar
|
|
|
542
|
|
|
543 Some machinery is provided that attempts to provide a higher-level
|
|
|
544 mechanism onto pop-up menus. This only works if you do not redefine
|
|
|
545 the binding for button3.
|
|
|
546
|
|
|
547 @deffn Command popup-mode-menu
|
|
|
548 This function pops up a menu of global and mode-specific commands. The
|
|
|
549 menu is computed by combining @code{global-popup-menu} and
|
|
|
550 @code{mode-popup-menu}. This is the default binding for button3.
|
|
|
551 You should generally not change this binding.
|
|
|
552 @end deffn
|
|
|
553
|
|
|
554 @defvar global-popup-menu
|
|
|
555 This holds the global popup menu. This is present in all modes.
|
|
|
556 (This is @code{nil} by default.)
|
|
|
557 @end defvar
|
|
|
558
|
|
|
559 @defvar mode-popup-menu
|
|
|
560 The mode-specific popup menu. Automatically buffer local.
|
|
|
561 This is appended to the default items in @code{global-popup-menu}.
|
|
|
562 @end defvar
|
|
|
563
|
|
|
564 @defvr Constant default-popup-menu
|
|
|
565 This holds the default value of @code{mode-popup-menu}.
|
|
|
566 @end defvr
|
|
|
567
|
|
|
568 @defvar activate-popup-menu-hook
|
|
|
569 Function or functions run before a mode-specific popup menu is made
|
|
|
570 visible. These functions are called with no arguments, and should
|
|
|
571 interrogate and modify the value of @code{global-popup-menu} or
|
|
|
572 @code{mode-popup-menu} as desired. Note: this hook is only run if you
|
|
|
573 use @code{popup-mode-menu} for activating the global and mode-specific
|
|
|
574 commands; if you have your own binding for button3, this hook won't be
|
|
|
575 run.
|
|
|
576 @end defvar
|
|
|
577
|
|
|
578 The following convenience functions are provided for displaying
|
|
|
579 pop-up menus.
|
|
|
580
|
|
|
581 @defun popup-buffer-menu event
|
|
|
582 This function pops up a copy of the @samp{Buffers} menu (from the menubar)
|
|
|
583 where the mouse is clicked.
|
|
|
584 @end defun
|
|
|
585
|
|
|
586 @defun popup-menubar-menu event
|
|
|
587 This function pops up a copy of menu that also appears in the menubar.
|
|
|
588 @end defun
|
|
|
589
|
|
175
|
590 @node Menu Accelerators
|
|
|
591 @section Menu Accelerators
|
|
|
592 @cindex menu accelerators
|
|
|
593 @cindex keyboard menu accelerators
|
|
|
594
|
|
|
595 Menu accelerators are keyboard shortcuts for accessing the menubar.
|
|
|
596 Accelerator keys can be specified for menus as well as for menu items. An
|
|
|
597 accelerator key for a menu is used to activate that menu when it appears as a
|
|
|
598 submenu of another menu. An accelerator key for a menu item is used to
|
|
|
599 activate that item.
|
|
|
600
|
|
|
601 @menu
|
|
|
602 * Creating Menu Accelerators:: How to add accelerator keys to a menu.
|
|
|
603 * Keyboard Menu Traversal:: How to use and modify the keys which are used
|
|
|
604 to traverse the menu structure.
|
|
|
605 * Menu Accelerator Functions:: Functions for working with menu accelerators.
|
|
|
606 @end menu
|
|
|
607
|
|
|
608 @node Creating Menu Accelerators
|
|
|
609 @subsection Creating Menu Accelerators
|
|
|
610
|
|
|
611 Menu accelerators are specified as part of the menubar format using the
|
|
|
612 :accelerator tag to specify a key or by placing "%_" in the menu or menu item
|
|
|
613 name prior to the letter which is to be used as the accelerator key. The
|
|
|
614 advantage of the second method is that the menu rendering code then knows to
|
|
|
615 draw an underline under that character, which is the canonical way of
|
|
|
616 indicating an accelerator key to a user.
|
|
|
617
|
|
|
618 For example, the command
|
|
|
619
|
|
|
620 @example
|
|
|
621 (add-submenu nil '("%_Test"
|
|
|
622 ["One" (insert "1") :accelerator ?1 :active t]
|
|
|
623 ["%_Two" (insert "2") t]
|
|
|
624 ["%_3" (insert "3") t]))
|
|
|
625 @end example
|
|
|
626
|
|
|
627 will add a new menu to the top level menubar. The new menu can be reached
|
|
|
628 by pressing "t" while the top level menubar is active. When the menu is
|
|
|
629 active, pressing "1" will activate the first item and insert the character
|
|
|
630 "1" into the buffer. Pressing "2" will activate the second item and insert
|
|
|
631 the character "2" into the buffer. Pressing "3" will activate the third item
|
|
|
632 and insert the character "3" into the buffer.
|
|
|
633
|
|
|
634 It is possible to activate the top level menubar itself using accelerator keys.
|
|
|
635 @xref{Menu Accelerator Functions}.
|
|
|
636
|
|
|
637 @node Keyboard Menu Traversal
|
|
|
638 @subsection Keyboard Menu Traversal
|
|
|
639
|
|
|
640 In addition to immediately activating a menu or menu item, the keyboard can
|
|
|
641 be used to traverse the menus without activating items. The keyboard arrow
|
|
|
642 keys, the return key and the escape key are defined to traverse the menus in a
|
|
|
643 way that should be familiar to users of any of a certain family of popular PC
|
|
|
644 operating systems.
|
|
|
645
|
|
|
646 This behaviour can be changed by modifying the bindings in
|
|
|
647 menu-accelerator-map. At this point, the online help is your best bet
|
|
|
648 for more information about how to modify the menu traversal keys.
|
|
|
649
|
|
|
650 @node Menu Accelerator Functions
|
|
|
651 @subsection Menu Accelerator Functions
|
|
|
652
|
|
|
653 @defun accelerate-menu
|
|
|
654 Make the menubar immediately active and place the cursor on the left most entry
|
|
|
655 in the top level menu. Menu items can be selected as usual.
|
|
|
656 @end defun
|
|
|
657
|
|
|
658 @defvar menu-accelerator-enabled
|
|
|
659 Whether menu accelerator keys can cause the menubar to become active.
|
|
|
660
|
|
|
661 If @code{menu-force} or @code{menu-fallback}, then menu accelerator keys can
|
|
|
662 be used to activate the top level menu. Once the menubar becomes active, the
|
|
|
663 accelerator keys can be used regardless of the value of this variable.
|
|
|
664
|
|
|
665 @code{menu-force} is used to indicate that the menu accelerator key takes
|
|
|
666 precedence over bindings in the current keymap(s). @code{menu-fallback} means
|
|
|
667 that bindings in the current keymap take precedence over menu accelerator keys.
|
|
|
668 Thus a top level menu with an accelerator of "T" would be activated on a
|
|
|
669 keypress of Meta-t if @var{menu-accelerator-enabled} is @code{menu-force}.
|
|
|
670 However, if @var{menu-accelerator-enabled} is @code{menu-fallback}, then
|
|
|
671 Meta-t will not activate the menubar and will instead run the function
|
|
|
672 transpose-words, to which it is normally bound.
|
|
|
673
|
|
|
674 The default value is @code{nil}.
|
|
|
675
|
|
|
676 See also @var{menu-accelerator-modifiers} and @var{menu-accelerator-prefix}.
|
|
|
677 @end defvar
|
|
|
678
|
|
|
679 @defvar menu-accelerator-map
|
|
|
680 Keymap consulted to determine the commands to run in response to keypresses
|
|
|
681 occurring while the menubar is active. @xref{Keyboard Menu Traversal}.
|
|
|
682 @end defvar
|
|
|
683
|
|
|
684 @defvar menu-accelerator-modifiers
|
|
|
685 A list of modifier keys which must be pressed in addition to a valid menu
|
|
|
686 accelerator in order for the top level menu to be activated in response to
|
|
|
687 a keystroke. The default value of @code{(meta)} mirrors the useage of the alt key
|
|
|
688 as a menu accelerator in popular PC operating systems.
|
|
|
689
|
|
|
690 The modifier keys in @var{menu-accelerator-modifiers} must match exactly the
|
|
|
691 modifiers present in the keypress. The only exception is that the shift
|
|
|
692 modifier is accepted in conjunction with alphabetic keys even if it is not
|
|
|
693 a menu accelerator modifier.
|
|
|
694
|
|
|
695 See also @var{menu-accelerator-enabled} and @var{menu-accelerator-prefix}.
|
|
|
696 @end defvar
|
|
|
697
|
|
|
698 @defvar menu-accelerator-prefix
|
|
|
699 Prefix key(s) that must be typed before menu accelerators will be activated.
|
|
|
700 Must be a valid key descriptor.
|
|
|
701
|
|
|
702 The default value is @code{nil}.
|
|
|
703 @end defvar
|
|
|
704
|
|
|
705 @example
|
|
|
706 (setq menu-accelerator-prefix ?\C-x)
|
|
|
707 (setq menu-accelerator-modifiers '(meta control))
|
|
|
708 (setq menu-accelerator-enabled 'menu-force)
|
|
|
709 (add-submenu nil '("%_Test"
|
|
|
710 ["One" (insert "1") :accelerator ?1 :active t]
|
|
|
711 ["%_Two" (insert "2") t]
|
|
|
712 ["%_3" (insert "3") t]))
|
|
|
713 @end example
|
|
|
714
|
|
|
715 will add the menu "Test" to the top level menubar. Pressing C-x followed by
|
|
|
716 C-M-T will activate the menubar and display the "Test" menu. Pressing
|
|
|
717 C-M-T by itself will not activate the menubar. Neither will pressing C-x
|
|
|
718 followed by anything else.
|
|
|
719
|
|
0
|
720 @node Buffers Menu
|
|
|
721 @section Buffers Menu
|
|
|
722 @cindex buffers menu
|
|
|
723
|
|
|
724 The following options control how the @samp{Buffers} menu is displayed.
|
|
|
725 This is a list of all (or a subset of) the buffers currently in existence,
|
|
|
726 and is updated dynamically.
|
|
|
727
|
|
|
728 @defopt buffers-menu-max-size
|
|
|
729 This user option holds the maximum number of entries which may appear on
|
|
|
730 the @samp{Buffers} menu. If this is 10, then only the ten
|
|
|
731 most-recently-selected buffers will be shown. If this is @code{nil},
|
|
|
732 then all buffers will be shown. Setting this to a large number or
|
|
|
733 @code{nil} will slow down menu responsiveness.
|
|
|
734 @end defopt
|
|
|
735
|
|
|
736 @defun format-buffers-menu-line buffer
|
|
|
737 This function returns a string to represent @var{buffer} in the
|
|
|
738 @samp{Buffers} menu. @code{nil} means the buffer shouldn't be listed.
|
|
|
739 You can redefine this.
|
|
|
740 @end defun
|
|
|
741
|
|
|
742 @defopt complex-buffers-menu-p
|
|
|
743 If true, the @samp{Buffers} menu will contain several commands, as submenus
|
|
|
744 of each buffer line. If this is false, then there will be only one command:
|
|
|
745 select that buffer.
|
|
|
746 @end defopt
|
|
|
747
|
|
|
748 @defopt buffers-menu-switch-to-buffer-function
|
|
|
749 This user option holds the function to call to select a buffer from the
|
|
|
750 @samp{Buffers} menu. @code{switch-to-buffer} is a good choice, as is
|
|
|
751 @code{pop-to-buffer}.
|
|
|
752 @end defopt
|
|
|
753
|
