Mercurial > emacs
annotate doc/lispref/display.texi @ 91121:1805a65e7746
(read1): Undo the previous change.
author | Kenichi Handa <handa@m17n.org> |
---|---|
date | Wed, 21 Nov 2007 12:12:06 +0000 |
parents | 591c29778a30 |
children | ec0ef12211d9 |
rev | line source |
---|---|
84060 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2000, 2001, | |
4 @c 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. | |
5 @c See the file elisp.texi for copying conditions. | |
84116
0ba80d073e27
(setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents:
84060
diff
changeset
|
6 @setfilename ../../info/display |
84060 | 7 @node Display, System Interface, Processes, Top |
8 @chapter Emacs Display | |
9 | |
10 This chapter describes a number of features related to the display | |
11 that Emacs presents to the user. | |
12 | |
13 @menu | |
14 * Refresh Screen:: Clearing the screen and redrawing everything on it. | |
15 * Forcing Redisplay:: Forcing redisplay. | |
16 * Truncation:: Folding or wrapping long text lines. | |
17 * The Echo Area:: Displaying messages at the bottom of the screen. | |
18 * Warnings:: Displaying warning messages for the user. | |
19 * Invisible Text:: Hiding part of the buffer text. | |
20 * Selective Display:: Hiding part of the buffer text (the old way). | |
21 * Temporary Displays:: Displays that go away automatically. | |
22 * Overlays:: Use overlays to highlight parts of the buffer. | |
23 * Width:: How wide a character or string is on the screen. | |
24 * Line Height:: Controlling the height of lines. | |
25 * Faces:: A face defines a graphics style for text characters: | |
26 font, colors, etc. | |
27 * Fringes:: Controlling window fringes. | |
28 * Scroll Bars:: Controlling vertical scroll bars. | |
29 * Display Property:: Enabling special display features. | |
30 * Images:: Displaying images in Emacs buffers. | |
31 * Buttons:: Adding clickable buttons to Emacs buffers. | |
32 * Abstract Display:: Emacs' Widget for Object Collections. | |
33 * Blinking:: How Emacs shows the matching open parenthesis. | |
34 * Usual Display:: The usual conventions for displaying nonprinting chars. | |
35 * Display Tables:: How to specify other conventions. | |
36 * Beeping:: Audible signal to the user. | |
37 * Window Systems:: Which window system is being used. | |
38 @end menu | |
39 | |
40 @node Refresh Screen | |
41 @section Refreshing the Screen | |
42 | |
43 The function @code{redraw-frame} clears and redisplays the entire | |
44 contents of a given frame (@pxref{Frames}). This is useful if the | |
45 screen is corrupted. | |
46 | |
47 @c Emacs 19 feature | |
48 @defun redraw-frame frame | |
49 This function clears and redisplays frame @var{frame}. | |
50 @end defun | |
51 | |
52 Even more powerful is @code{redraw-display}: | |
53 | |
54 @deffn Command redraw-display | |
55 This function clears and redisplays all visible frames. | |
56 @end deffn | |
57 | |
58 This function calls for redisplay of certain windows, the next time | |
59 redisplay is done, but does not clear them first. | |
60 | |
61 @defun force-window-update &optional object | |
62 This function forces some or all windows to be updated on next redisplay. | |
63 If @var{object} is a window, it forces redisplay of that window. If | |
64 @var{object} is a buffer or buffer name, it forces redisplay of all | |
65 windows displaying that buffer. If @var{object} is @code{nil} (or | |
66 omitted), it forces redisplay of all windows. | |
67 @end defun | |
68 | |
69 Processing user input takes absolute priority over redisplay. If you | |
70 call these functions when input is available, they do nothing | |
71 immediately, but a full redisplay does happen eventually---after all the | |
72 input has been processed. | |
73 | |
74 Normally, suspending and resuming Emacs also refreshes the screen. | |
75 Some terminal emulators record separate contents for display-oriented | |
76 programs such as Emacs and for ordinary sequential display. If you are | |
77 using such a terminal, you might want to inhibit the redisplay on | |
78 resumption. | |
79 | |
80 @defvar no-redraw-on-reenter | |
81 @cindex suspend (cf. @code{no-redraw-on-reenter}) | |
82 @cindex resume (cf. @code{no-redraw-on-reenter}) | |
83 This variable controls whether Emacs redraws the entire screen after it | |
84 has been suspended and resumed. Non-@code{nil} means there is no need | |
85 to redraw, @code{nil} means redrawing is needed. The default is @code{nil}. | |
86 @end defvar | |
87 | |
88 @node Forcing Redisplay | |
89 @section Forcing Redisplay | |
90 @cindex forcing redisplay | |
91 | |
92 Emacs redisplay normally stops if input arrives, and does not happen | |
93 at all if input is available before it starts. Most of the time, this | |
94 is exactly what you want. However, you can prevent preemption by | |
95 binding @code{redisplay-dont-pause} to a non-@code{nil} value. | |
96 | |
97 @defvar redisplay-preemption-period | |
98 This variable specifies how many seconds Emacs waits between checks | |
99 for new input during redisplay. (The default is 0.1 seconds.) If | |
100 input has arrived when Emacs checks, it pre-empts redisplay and | |
101 processes the available input before trying again to redisplay. | |
102 | |
103 If this variable is @code{nil}, Emacs does not check for input during | |
104 redisplay, and redisplay cannot be preempted by input. | |
105 | |
106 This variable is only obeyed on graphical terminals. For | |
107 text terminals, see @ref{Terminal Output}. | |
108 @end defvar | |
109 | |
110 @defvar redisplay-dont-pause | |
111 If this variable is non-@code{nil}, pending input does not | |
112 prevent or halt redisplay; redisplay occurs, and finishes, | |
113 regardless of whether input is available. | |
114 @end defvar | |
115 | |
116 @defun redisplay &optional force | |
117 This function performs an immediate redisplay provided there are no | |
118 pending input events. This is equivalent to @code{(sit-for 0)}. | |
119 | |
120 If the optional argument @var{force} is non-@code{nil}, it forces an | |
121 immediate and complete redisplay even if input is available. | |
122 | |
123 Returns @code{t} if redisplay was performed, or @code{nil} otherwise. | |
124 @end defun | |
125 | |
126 @node Truncation | |
127 @section Truncation | |
128 @cindex line wrapping | |
129 @cindex line truncation | |
130 @cindex continuation lines | |
131 @cindex @samp{$} in display | |
132 @cindex @samp{\} in display | |
133 | |
134 When a line of text extends beyond the right edge of a window, Emacs | |
135 can @dfn{continue} the line (make it ``wrap'' to the next screen | |
136 line), or @dfn{truncate} the line (limit it to one screen line). The | |
137 additional screen lines used to display a long text line are called | |
138 @dfn{continuation} lines. Continuation is not the same as filling; | |
139 continuation happens on the screen only, not in the buffer contents, | |
140 and it breaks a line precisely at the right margin, not at a word | |
141 boundary. @xref{Filling}. | |
142 | |
143 On a graphical display, tiny arrow images in the window fringes | |
144 indicate truncated and continued lines (@pxref{Fringes}). On a text | |
145 terminal, a @samp{$} in the rightmost column of the window indicates | |
146 truncation; a @samp{\} on the rightmost column indicates a line that | |
147 ``wraps.'' (The display table can specify alternate characters to use | |
148 for this; @pxref{Display Tables}). | |
149 | |
150 @defopt truncate-lines | |
151 This buffer-local variable controls how Emacs displays lines that extend | |
152 beyond the right edge of the window. The default is @code{nil}, which | |
153 specifies continuation. If the value is non-@code{nil}, then these | |
154 lines are truncated. | |
155 | |
156 If the variable @code{truncate-partial-width-windows} is non-@code{nil}, | |
157 then truncation is always used for side-by-side windows (within one | |
158 frame) regardless of the value of @code{truncate-lines}. | |
159 @end defopt | |
160 | |
161 @defopt default-truncate-lines | |
162 This variable is the default value for @code{truncate-lines}, for | |
163 buffers that do not have buffer-local values for it. | |
164 @end defopt | |
165 | |
166 @defopt truncate-partial-width-windows | |
167 This variable controls display of lines that extend beyond the right | |
168 edge of the window, in side-by-side windows (@pxref{Splitting Windows}). | |
169 If it is non-@code{nil}, these lines are truncated; otherwise, | |
170 @code{truncate-lines} says what to do with them. | |
171 @end defopt | |
172 | |
173 When horizontal scrolling (@pxref{Horizontal Scrolling}) is in use in | |
174 a window, that forces truncation. | |
175 | |
176 If your buffer contains @emph{very} long lines, and you use | |
177 continuation to display them, just thinking about them can make Emacs | |
178 redisplay slow. The column computation and indentation functions also | |
179 become slow. Then you might find it advisable to set | |
180 @code{cache-long-line-scans} to @code{t}. | |
181 | |
182 @defvar cache-long-line-scans | |
183 If this variable is non-@code{nil}, various indentation and motion | |
184 functions, and Emacs redisplay, cache the results of scanning the | |
185 buffer, and consult the cache to avoid rescanning regions of the buffer | |
186 unless they are modified. | |
187 | |
188 Turning on the cache slows down processing of short lines somewhat. | |
189 | |
190 This variable is automatically buffer-local in every buffer. | |
191 @end defvar | |
192 | |
193 @node The Echo Area | |
194 @section The Echo Area | |
195 @cindex error display | |
196 @cindex echo area | |
197 | |
198 The @dfn{echo area} is used for displaying error messages | |
199 (@pxref{Errors}), for messages made with the @code{message} primitive, | |
200 and for echoing keystrokes. It is not the same as the minibuffer, | |
201 despite the fact that the minibuffer appears (when active) in the same | |
202 place on the screen as the echo area. The @cite{GNU Emacs Manual} | |
203 specifies the rules for resolving conflicts between the echo area and | |
204 the minibuffer for use of that screen space (@pxref{Minibuffer,, The | |
205 Minibuffer, emacs, The GNU Emacs Manual}). | |
206 | |
207 You can write output in the echo area by using the Lisp printing | |
208 functions with @code{t} as the stream (@pxref{Output Functions}), or | |
209 explicitly. | |
210 | |
211 @menu | |
212 * Displaying Messages:: Explicitly displaying text in the echo area. | |
213 * Progress:: Informing user about progress of a long operation. | |
214 * Logging Messages:: Echo area messages are logged for the user. | |
215 * Echo Area Customization:: Controlling the echo area. | |
216 @end menu | |
217 | |
218 @node Displaying Messages | |
219 @subsection Displaying Messages in the Echo Area | |
220 @cindex display message in echo area | |
221 | |
222 This section describes the functions for explicitly producing echo | |
223 area messages. Many other Emacs features display messages there, too. | |
224 | |
225 @defun message format-string &rest arguments | |
226 This function displays a message in the echo area. The argument | |
227 @var{format-string} is similar to a C language @code{printf} format | |
228 string. See @code{format} in @ref{Formatting Strings}, for the details | |
229 on the conversion specifications. @code{message} returns the | |
230 constructed string. | |
231 | |
232 In batch mode, @code{message} prints the message text on the standard | |
233 error stream, followed by a newline. | |
234 | |
235 If @var{format-string}, or strings among the @var{arguments}, have | |
236 @code{face} text properties, these affect the way the message is displayed. | |
237 | |
238 @c Emacs 19 feature | |
239 If @var{format-string} is @code{nil} or the empty string, | |
240 @code{message} clears the echo area; if the echo area has been | |
241 expanded automatically, this brings it back to its normal size. | |
242 If the minibuffer is active, this brings the minibuffer contents back | |
243 onto the screen immediately. | |
244 | |
245 @example | |
246 @group | |
247 (message "Minibuffer depth is %d." | |
248 (minibuffer-depth)) | |
249 @print{} Minibuffer depth is 0. | |
250 @result{} "Minibuffer depth is 0." | |
251 @end group | |
252 | |
253 @group | |
254 ---------- Echo Area ---------- | |
255 Minibuffer depth is 0. | |
256 ---------- Echo Area ---------- | |
257 @end group | |
258 @end example | |
259 | |
260 To automatically display a message in the echo area or in a pop-buffer, | |
261 depending on its size, use @code{display-message-or-buffer} (see below). | |
262 @end defun | |
263 | |
264 @defmac with-temp-message message &rest body | |
265 This construct displays a message in the echo area temporarily, during | |
266 the execution of @var{body}. It displays @var{message}, executes | |
267 @var{body}, then returns the value of the last body form while restoring | |
268 the previous echo area contents. | |
269 @end defmac | |
270 | |
271 @defun message-or-box format-string &rest arguments | |
272 This function displays a message like @code{message}, but may display it | |
273 in a dialog box instead of the echo area. If this function is called in | |
274 a command that was invoked using the mouse---more precisely, if | |
275 @code{last-nonmenu-event} (@pxref{Command Loop Info}) is either | |
276 @code{nil} or a list---then it uses a dialog box or pop-up menu to | |
277 display the message. Otherwise, it uses the echo area. (This is the | |
278 same criterion that @code{y-or-n-p} uses to make a similar decision; see | |
279 @ref{Yes-or-No Queries}.) | |
280 | |
281 You can force use of the mouse or of the echo area by binding | |
282 @code{last-nonmenu-event} to a suitable value around the call. | |
283 @end defun | |
284 | |
285 @defun message-box format-string &rest arguments | |
286 @anchor{message-box} | |
287 This function displays a message like @code{message}, but uses a dialog | |
288 box (or a pop-up menu) whenever that is possible. If it is impossible | |
289 to use a dialog box or pop-up menu, because the terminal does not | |
290 support them, then @code{message-box} uses the echo area, like | |
291 @code{message}. | |
292 @end defun | |
293 | |
294 @defun display-message-or-buffer message &optional buffer-name not-this-window frame | |
295 This function displays the message @var{message}, which may be either a | |
296 string or a buffer. If it is shorter than the maximum height of the | |
297 echo area, as defined by @code{max-mini-window-height}, it is displayed | |
298 in the echo area, using @code{message}. Otherwise, | |
299 @code{display-buffer} is used to show it in a pop-up buffer. | |
300 | |
301 Returns either the string shown in the echo area, or when a pop-up | |
302 buffer is used, the window used to display it. | |
303 | |
304 If @var{message} is a string, then the optional argument | |
305 @var{buffer-name} is the name of the buffer used to display it when a | |
306 pop-up buffer is used, defaulting to @samp{*Message*}. In the case | |
307 where @var{message} is a string and displayed in the echo area, it is | |
308 not specified whether the contents are inserted into the buffer anyway. | |
309 | |
310 The optional arguments @var{not-this-window} and @var{frame} are as for | |
311 @code{display-buffer}, and only used if a buffer is displayed. | |
312 @end defun | |
313 | |
314 @defun current-message | |
315 This function returns the message currently being displayed in the | |
316 echo area, or @code{nil} if there is none. | |
317 @end defun | |
318 | |
319 @node Progress | |
320 @subsection Reporting Operation Progress | |
321 @cindex progress reporting | |
322 | |
323 When an operation can take a while to finish, you should inform the | |
324 user about the progress it makes. This way the user can estimate | |
325 remaining time and clearly see that Emacs is busy working, not hung. | |
326 | |
327 Functions listed in this section provide simple and efficient way of | |
328 reporting operation progress. Here is a working example that does | |
329 nothing useful: | |
330 | |
331 @smallexample | |
332 (let ((progress-reporter | |
333 (make-progress-reporter "Collecting mana for Emacs..." | |
334 0 500))) | |
335 (dotimes (k 500) | |
336 (sit-for 0.01) | |
337 (progress-reporter-update progress-reporter k)) | |
338 (progress-reporter-done progress-reporter)) | |
339 @end smallexample | |
340 | |
341 @defun make-progress-reporter message min-value max-value &optional current-value min-change min-time | |
342 This function creates and returns a @dfn{progress reporter}---an | |
343 object you will use as an argument for all other functions listed | |
344 here. The idea is to precompute as much data as possible to make | |
345 progress reporting very fast. | |
346 | |
347 When this progress reporter is subsequently used, it will display | |
348 @var{message} in the echo area, followed by progress percentage. | |
349 @var{message} is treated as a simple string. If you need it to depend | |
350 on a filename, for instance, use @code{format} before calling this | |
351 function. | |
352 | |
353 @var{min-value} and @var{max-value} arguments stand for starting and | |
354 final states of your operation. For instance, if you scan a buffer, | |
355 they should be the results of @code{point-min} and @code{point-max} | |
356 correspondingly. It is required that @var{max-value} is greater than | |
357 @var{min-value}. If you create progress reporter when some part of | |
358 the operation has already been completed, then specify | |
359 @var{current-value} argument. But normally you should omit it or set | |
360 it to @code{nil}---it will default to @var{min-value} then. | |
361 | |
362 Remaining arguments control the rate of echo area updates. Progress | |
363 reporter will wait for at least @var{min-change} more percents of the | |
364 operation to be completed before printing next message. | |
365 @var{min-time} specifies the minimum time in seconds to pass between | |
366 successive prints. It can be fractional. Depending on Emacs and | |
367 system capabilities, progress reporter may or may not respect this | |
368 last argument or do it with varying precision. Default value for | |
369 @var{min-change} is 1 (one percent), for @var{min-time}---0.2 | |
370 (seconds.) | |
371 | |
372 This function calls @code{progress-reporter-update}, so the first | |
373 message is printed immediately. | |
374 @end defun | |
375 | |
376 @defun progress-reporter-update reporter value | |
377 This function does the main work of reporting progress of your | |
378 operation. It displays the message of @var{reporter}, followed by | |
379 progress percentage determined by @var{value}. If percentage is zero, | |
380 or close enough according to the @var{min-change} and @var{min-time} | |
381 arguments, then it is omitted from the output. | |
382 | |
383 @var{reporter} must be the result of a call to | |
384 @code{make-progress-reporter}. @var{value} specifies the current | |
385 state of your operation and must be between @var{min-value} and | |
386 @var{max-value} (inclusive) as passed to | |
387 @code{make-progress-reporter}. For instance, if you scan a buffer, | |
388 then @var{value} should be the result of a call to @code{point}. | |
389 | |
390 This function respects @var{min-change} and @var{min-time} as passed | |
391 to @code{make-progress-reporter} and so does not output new messages | |
392 on every invocation. It is thus very fast and normally you should not | |
393 try to reduce the number of calls to it: resulting overhead will most | |
394 likely negate your effort. | |
395 @end defun | |
396 | |
397 @defun progress-reporter-force-update reporter value &optional new-message | |
398 This function is similar to @code{progress-reporter-update} except | |
399 that it prints a message in the echo area unconditionally. | |
400 | |
401 The first two arguments have the same meaning as for | |
402 @code{progress-reporter-update}. Optional @var{new-message} allows | |
403 you to change the message of the @var{reporter}. Since this functions | |
404 always updates the echo area, such a change will be immediately | |
405 presented to the user. | |
406 @end defun | |
407 | |
408 @defun progress-reporter-done reporter | |
409 This function should be called when the operation is finished. It | |
410 prints the message of @var{reporter} followed by word ``done'' in the | |
411 echo area. | |
412 | |
413 You should always call this function and not hope for | |
414 @code{progress-reporter-update} to print ``100%.'' Firstly, it may | |
415 never print it, there are many good reasons for this not to happen. | |
416 Secondly, ``done'' is more explicit. | |
417 @end defun | |
418 | |
419 @defmac dotimes-with-progress-reporter (var count [result]) message body@dots{} | |
420 This is a convenience macro that works the same way as @code{dotimes} | |
421 does, but also reports loop progress using the functions described | |
422 above. It allows you to save some typing. | |
423 | |
424 You can rewrite the example in the beginning of this node using | |
425 this macro this way: | |
426 | |
427 @example | |
428 (dotimes-with-progress-reporter | |
429 (k 500) | |
430 "Collecting some mana for Emacs..." | |
431 (sit-for 0.01)) | |
432 @end example | |
433 @end defmac | |
434 | |
435 @node Logging Messages | |
436 @subsection Logging Messages in @samp{*Messages*} | |
437 @cindex logging echo-area messages | |
438 | |
439 Almost all the messages displayed in the echo area are also recorded | |
440 in the @samp{*Messages*} buffer so that the user can refer back to | |
441 them. This includes all the messages that are output with | |
442 @code{message}. | |
443 | |
444 @defopt message-log-max | |
445 This variable specifies how many lines to keep in the @samp{*Messages*} | |
446 buffer. The value @code{t} means there is no limit on how many lines to | |
447 keep. The value @code{nil} disables message logging entirely. Here's | |
448 how to display a message and prevent it from being logged: | |
449 | |
450 @example | |
451 (let (message-log-max) | |
452 (message @dots{})) | |
453 @end example | |
454 @end defopt | |
455 | |
456 To make @samp{*Messages*} more convenient for the user, the logging | |
457 facility combines successive identical messages. It also combines | |
458 successive related messages for the sake of two cases: question | |
459 followed by answer, and a series of progress messages. | |
460 | |
461 A ``question followed by an answer'' means two messages like the | |
462 ones produced by @code{y-or-n-p}: the first is @samp{@var{question}}, | |
463 and the second is @samp{@var{question}...@var{answer}}. The first | |
464 message conveys no additional information beyond what's in the second, | |
465 so logging the second message discards the first from the log. | |
466 | |
467 A ``series of progress messages'' means successive messages like | |
468 those produced by @code{make-progress-reporter}. They have the form | |
469 @samp{@var{base}...@var{how-far}}, where @var{base} is the same each | |
470 time, while @var{how-far} varies. Logging each message in the series | |
471 discards the previous one, provided they are consecutive. | |
472 | |
473 The functions @code{make-progress-reporter} and @code{y-or-n-p} | |
474 don't have to do anything special to activate the message log | |
475 combination feature. It operates whenever two consecutive messages | |
476 are logged that share a common prefix ending in @samp{...}. | |
477 | |
478 @node Echo Area Customization | |
479 @subsection Echo Area Customization | |
480 | |
481 These variables control details of how the echo area works. | |
482 | |
483 @defvar cursor-in-echo-area | |
484 This variable controls where the cursor appears when a message is | |
485 displayed in the echo area. If it is non-@code{nil}, then the cursor | |
486 appears at the end of the message. Otherwise, the cursor appears at | |
487 point---not in the echo area at all. | |
488 | |
489 The value is normally @code{nil}; Lisp programs bind it to @code{t} | |
490 for brief periods of time. | |
491 @end defvar | |
492 | |
493 @defvar echo-area-clear-hook | |
494 This normal hook is run whenever the echo area is cleared---either by | |
495 @code{(message nil)} or for any other reason. | |
496 @end defvar | |
497 | |
498 @defvar echo-keystrokes | |
499 This variable determines how much time should elapse before command | |
500 characters echo. Its value must be an integer or floating point number, | |
501 which specifies the | |
502 number of seconds to wait before echoing. If the user types a prefix | |
503 key (such as @kbd{C-x}) and then delays this many seconds before | |
504 continuing, the prefix key is echoed in the echo area. (Once echoing | |
505 begins in a key sequence, all subsequent characters in the same key | |
506 sequence are echoed immediately.) | |
507 | |
508 If the value is zero, then command input is not echoed. | |
509 @end defvar | |
510 | |
511 @defvar message-truncate-lines | |
512 Normally, displaying a long message resizes the echo area to display | |
513 the entire message. But if the variable @code{message-truncate-lines} | |
514 is non-@code{nil}, the echo area does not resize, and the message is | |
515 truncated to fit it, as in Emacs 20 and before. | |
516 @end defvar | |
517 | |
518 The variable @code{max-mini-window-height}, which specifies the | |
519 maximum height for resizing minibuffer windows, also applies to the | |
520 echo area (which is really a special use of the minibuffer window. | |
521 @xref{Minibuffer Misc}. | |
522 | |
523 @node Warnings | |
524 @section Reporting Warnings | |
525 @cindex warnings | |
526 | |
527 @dfn{Warnings} are a facility for a program to inform the user of a | |
528 possible problem, but continue running. | |
529 | |
530 @menu | |
531 * Warning Basics:: Warnings concepts and functions to report them. | |
532 * Warning Variables:: Variables programs bind to customize their warnings. | |
533 * Warning Options:: Variables users set to control display of warnings. | |
534 @end menu | |
535 | |
536 @node Warning Basics | |
537 @subsection Warning Basics | |
538 @cindex severity level | |
539 | |
540 Every warning has a textual message, which explains the problem for | |
541 the user, and a @dfn{severity level} which is a symbol. Here are the | |
542 possible severity levels, in order of decreasing severity, and their | |
543 meanings: | |
544 | |
545 @table @code | |
546 @item :emergency | |
547 A problem that will seriously impair Emacs operation soon | |
548 if you do not attend to it promptly. | |
549 @item :error | |
550 A report of data or circumstances that are inherently wrong. | |
551 @item :warning | |
552 A report of data or circumstances that are not inherently wrong, but | |
553 raise suspicion of a possible problem. | |
554 @item :debug | |
555 A report of information that may be useful if you are debugging. | |
556 @end table | |
557 | |
558 When your program encounters invalid input data, it can either | |
559 signal a Lisp error by calling @code{error} or @code{signal} or report | |
560 a warning with severity @code{:error}. Signaling a Lisp error is the | |
561 easiest thing to do, but it means the program cannot continue | |
562 processing. If you want to take the trouble to implement a way to | |
563 continue processing despite the bad data, then reporting a warning of | |
564 severity @code{:error} is the right way to inform the user of the | |
565 problem. For instance, the Emacs Lisp byte compiler can report an | |
566 error that way and continue compiling other functions. (If the | |
567 program signals a Lisp error and then handles it with | |
568 @code{condition-case}, the user won't see the error message; it could | |
569 show the message to the user by reporting it as a warning.) | |
570 | |
571 @cindex warning type | |
572 Each warning has a @dfn{warning type} to classify it. The type is a | |
573 list of symbols. The first symbol should be the custom group that you | |
574 use for the program's user options. For example, byte compiler | |
575 warnings use the warning type @code{(bytecomp)}. You can also | |
576 subcategorize the warnings, if you wish, by using more symbols in the | |
577 list. | |
578 | |
579 @defun display-warning type message &optional level buffer-name | |
580 This function reports a warning, using @var{message} as the message | |
581 and @var{type} as the warning type. @var{level} should be the | |
582 severity level, with @code{:warning} being the default. | |
583 | |
584 @var{buffer-name}, if non-@code{nil}, specifies the name of the buffer | |
585 for logging the warning. By default, it is @samp{*Warnings*}. | |
586 @end defun | |
587 | |
588 @defun lwarn type level message &rest args | |
589 This function reports a warning using the value of @code{(format | |
590 @var{message} @var{args}...)} as the message. In other respects it is | |
591 equivalent to @code{display-warning}. | |
592 @end defun | |
593 | |
594 @defun warn message &rest args | |
595 This function reports a warning using the value of @code{(format | |
596 @var{message} @var{args}...)} as the message, @code{(emacs)} as the | |
597 type, and @code{:warning} as the severity level. It exists for | |
598 compatibility only; we recommend not using it, because you should | |
599 specify a specific warning type. | |
600 @end defun | |
601 | |
602 @node Warning Variables | |
603 @subsection Warning Variables | |
604 | |
605 Programs can customize how their warnings appear by binding | |
606 the variables described in this section. | |
607 | |
608 @defvar warning-levels | |
609 This list defines the meaning and severity order of the warning | |
610 severity levels. Each element defines one severity level, | |
611 and they are arranged in order of decreasing severity. | |
612 | |
613 Each element has the form @code{(@var{level} @var{string} | |
614 @var{function})}, where @var{level} is the severity level it defines. | |
615 @var{string} specifies the textual description of this level. | |
616 @var{string} should use @samp{%s} to specify where to put the warning | |
617 type information, or it can omit the @samp{%s} so as not to include | |
618 that information. | |
619 | |
620 The optional @var{function}, if non-@code{nil}, is a function to call | |
621 with no arguments, to get the user's attention. | |
622 | |
623 Normally you should not change the value of this variable. | |
624 @end defvar | |
625 | |
626 @defvar warning-prefix-function | |
627 If non-@code{nil}, the value is a function to generate prefix text for | |
628 warnings. Programs can bind the variable to a suitable function. | |
629 @code{display-warning} calls this function with the warnings buffer | |
630 current, and the function can insert text in it. That text becomes | |
631 the beginning of the warning message. | |
632 | |
633 The function is called with two arguments, the severity level and its | |
634 entry in @code{warning-levels}. It should return a list to use as the | |
635 entry (this value need not be an actual member of | |
636 @code{warning-levels}). By constructing this value, the function can | |
637 change the severity of the warning, or specify different handling for | |
638 a given severity level. | |
639 | |
640 If the variable's value is @code{nil} then there is no function | |
641 to call. | |
642 @end defvar | |
643 | |
644 @defvar warning-series | |
645 Programs can bind this variable to @code{t} to say that the next | |
646 warning should begin a series. When several warnings form a series, | |
647 that means to leave point on the first warning of the series, rather | |
648 than keep moving it for each warning so that it appears on the last one. | |
649 The series ends when the local binding is unbound and | |
650 @code{warning-series} becomes @code{nil} again. | |
651 | |
652 The value can also be a symbol with a function definition. That is | |
653 equivalent to @code{t}, except that the next warning will also call | |
654 the function with no arguments with the warnings buffer current. The | |
655 function can insert text which will serve as a header for the series | |
656 of warnings. | |
657 | |
658 Once a series has begun, the value is a marker which points to the | |
659 buffer position in the warnings buffer of the start of the series. | |
660 | |
661 The variable's normal value is @code{nil}, which means to handle | |
662 each warning separately. | |
663 @end defvar | |
664 | |
665 @defvar warning-fill-prefix | |
666 When this variable is non-@code{nil}, it specifies a fill prefix to | |
667 use for filling each warning's text. | |
668 @end defvar | |
669 | |
670 @defvar warning-type-format | |
671 This variable specifies the format for displaying the warning type | |
672 in the warning message. The result of formatting the type this way | |
673 gets included in the message under the control of the string in the | |
674 entry in @code{warning-levels}. The default value is @code{" (%s)"}. | |
675 If you bind it to @code{""} then the warning type won't appear at | |
676 all. | |
677 @end defvar | |
678 | |
679 @node Warning Options | |
680 @subsection Warning Options | |
681 | |
682 These variables are used by users to control what happens | |
683 when a Lisp program reports a warning. | |
684 | |
685 @defopt warning-minimum-level | |
686 This user option specifies the minimum severity level that should be | |
687 shown immediately to the user. The default is @code{:warning}, which | |
688 means to immediately display all warnings except @code{:debug} | |
689 warnings. | |
690 @end defopt | |
691 | |
692 @defopt warning-minimum-log-level | |
693 This user option specifies the minimum severity level that should be | |
694 logged in the warnings buffer. The default is @code{:warning}, which | |
695 means to log all warnings except @code{:debug} warnings. | |
696 @end defopt | |
697 | |
698 @defopt warning-suppress-types | |
699 This list specifies which warning types should not be displayed | |
700 immediately for the user. Each element of the list should be a list | |
701 of symbols. If its elements match the first elements in a warning | |
702 type, then that warning is not displayed immediately. | |
703 @end defopt | |
704 | |
705 @defopt warning-suppress-log-types | |
706 This list specifies which warning types should not be logged in the | |
707 warnings buffer. Each element of the list should be a list of | |
708 symbols. If it matches the first few elements in a warning type, then | |
709 that warning is not logged. | |
710 @end defopt | |
711 | |
712 @node Invisible Text | |
713 @section Invisible Text | |
714 | |
715 @cindex invisible text | |
716 You can make characters @dfn{invisible}, so that they do not appear on | |
717 the screen, with the @code{invisible} property. This can be either a | |
718 text property (@pxref{Text Properties}) or a property of an overlay | |
719 (@pxref{Overlays}). Cursor motion also partly ignores these | |
720 characters; if the command loop finds point within them, it moves | |
721 point to the other side of them. | |
722 | |
723 In the simplest case, any non-@code{nil} @code{invisible} property makes | |
724 a character invisible. This is the default case---if you don't alter | |
725 the default value of @code{buffer-invisibility-spec}, this is how the | |
726 @code{invisible} property works. You should normally use @code{t} | |
727 as the value of the @code{invisible} property if you don't plan | |
728 to set @code{buffer-invisibility-spec} yourself. | |
729 | |
730 More generally, you can use the variable @code{buffer-invisibility-spec} | |
731 to control which values of the @code{invisible} property make text | |
732 invisible. This permits you to classify the text into different subsets | |
733 in advance, by giving them different @code{invisible} values, and | |
734 subsequently make various subsets visible or invisible by changing the | |
735 value of @code{buffer-invisibility-spec}. | |
736 | |
737 Controlling visibility with @code{buffer-invisibility-spec} is | |
738 especially useful in a program to display the list of entries in a | |
739 database. It permits the implementation of convenient filtering | |
740 commands to view just a part of the entries in the database. Setting | |
741 this variable is very fast, much faster than scanning all the text in | |
742 the buffer looking for properties to change. | |
743 | |
744 @defvar buffer-invisibility-spec | |
745 This variable specifies which kinds of @code{invisible} properties | |
746 actually make a character invisible. Setting this variable makes it | |
747 buffer-local. | |
748 | |
749 @table @asis | |
750 @item @code{t} | |
751 A character is invisible if its @code{invisible} property is | |
752 non-@code{nil}. This is the default. | |
753 | |
754 @item a list | |
755 Each element of the list specifies a criterion for invisibility; if a | |
756 character's @code{invisible} property fits any one of these criteria, | |
757 the character is invisible. The list can have two kinds of elements: | |
758 | |
759 @table @code | |
760 @item @var{atom} | |
761 A character is invisible if its @code{invisible} property value | |
762 is @var{atom} or if it is a list with @var{atom} as a member. | |
763 | |
764 @item (@var{atom} . t) | |
765 A character is invisible if its @code{invisible} property value is | |
766 @var{atom} or if it is a list with @var{atom} as a member. Moreover, | |
767 a sequence of such characters displays as an ellipsis. | |
768 @end table | |
769 @end table | |
770 @end defvar | |
771 | |
772 Two functions are specifically provided for adding elements to | |
773 @code{buffer-invisibility-spec} and removing elements from it. | |
774 | |
775 @defun add-to-invisibility-spec element | |
776 This function adds the element @var{element} to | |
777 @code{buffer-invisibility-spec}. If @code{buffer-invisibility-spec} | |
778 was @code{t}, it changes to a list, @code{(t)}, so that text whose | |
779 @code{invisible} property is @code{t} remains invisible. | |
780 @end defun | |
781 | |
782 @defun remove-from-invisibility-spec element | |
783 This removes the element @var{element} from | |
784 @code{buffer-invisibility-spec}. This does nothing if @var{element} | |
785 is not in the list. | |
786 @end defun | |
787 | |
788 A convention for use of @code{buffer-invisibility-spec} is that a | |
789 major mode should use the mode's own name as an element of | |
790 @code{buffer-invisibility-spec} and as the value of the | |
791 @code{invisible} property: | |
792 | |
793 @example | |
794 ;; @r{If you want to display an ellipsis:} | |
795 (add-to-invisibility-spec '(my-symbol . t)) | |
796 ;; @r{If you don't want ellipsis:} | |
797 (add-to-invisibility-spec 'my-symbol) | |
798 | |
799 (overlay-put (make-overlay beginning end) | |
800 'invisible 'my-symbol) | |
801 | |
802 ;; @r{When done with the overlays:} | |
803 (remove-from-invisibility-spec '(my-symbol . t)) | |
804 ;; @r{Or respectively:} | |
805 (remove-from-invisibility-spec 'my-symbol) | |
806 @end example | |
807 | |
808 @vindex line-move-ignore-invisible | |
809 Ordinarily, functions that operate on text or move point do not care | |
810 whether the text is invisible. The user-level line motion commands | |
811 explicitly ignore invisible newlines if | |
812 @code{line-move-ignore-invisible} is non-@code{nil} (the default), but | |
813 only because they are explicitly programmed to do so. | |
814 | |
815 However, if a command ends with point inside or immediately before | |
816 invisible text, the main editing loop moves point further forward or | |
817 further backward (in the same direction that the command already moved | |
818 it) until that condition is no longer true. Thus, if the command | |
819 moved point back into an invisible range, Emacs moves point back to | |
820 the beginning of that range, and then back one more character. If the | |
821 command moved point forward into an invisible range, Emacs moves point | |
822 forward up to the first visible character that follows the invisible | |
823 text. | |
824 | |
825 Incremental search can make invisible overlays visible temporarily | |
826 and/or permanently when a match includes invisible text. To enable | |
827 this, the overlay should have a non-@code{nil} | |
828 @code{isearch-open-invisible} property. The property value should be a | |
829 function to be called with the overlay as an argument. This function | |
830 should make the overlay visible permanently; it is used when the match | |
831 overlaps the overlay on exit from the search. | |
832 | |
833 During the search, such overlays are made temporarily visible by | |
834 temporarily modifying their invisible and intangible properties. If you | |
835 want this to be done differently for a certain overlay, give it an | |
836 @code{isearch-open-invisible-temporary} property which is a function. | |
837 The function is called with two arguments: the first is the overlay, and | |
838 the second is @code{nil} to make the overlay visible, or @code{t} to | |
839 make it invisible again. | |
840 | |
841 @node Selective Display | |
842 @section Selective Display | |
843 @c @cindex selective display Duplicates selective-display | |
844 | |
845 @dfn{Selective display} refers to a pair of related features for | |
846 hiding certain lines on the screen. | |
847 | |
848 The first variant, explicit selective display, is designed for use | |
849 in a Lisp program: it controls which lines are hidden by altering the | |
850 text. This kind of hiding in some ways resembles the effect of the | |
851 @code{invisible} property (@pxref{Invisible Text}), but the two | |
852 features are different and do not work the same way. | |
853 | |
854 In the second variant, the choice of lines to hide is made | |
855 automatically based on indentation. This variant is designed to be a | |
856 user-level feature. | |
857 | |
858 The way you control explicit selective display is by replacing a | |
859 newline (control-j) with a carriage return (control-m). The text that | |
860 was formerly a line following that newline is now hidden. Strictly | |
861 speaking, it is temporarily no longer a line at all, since only | |
862 newlines can separate lines; it is now part of the previous line. | |
863 | |
864 Selective display does not directly affect editing commands. For | |
865 example, @kbd{C-f} (@code{forward-char}) moves point unhesitatingly | |
866 into hidden text. However, the replacement of newline characters with | |
867 carriage return characters affects some editing commands. For | |
868 example, @code{next-line} skips hidden lines, since it searches only | |
869 for newlines. Modes that use selective display can also define | |
870 commands that take account of the newlines, or that control which | |
871 parts of the text are hidden. | |
872 | |
873 When you write a selectively displayed buffer into a file, all the | |
874 control-m's are output as newlines. This means that when you next read | |
875 in the file, it looks OK, with nothing hidden. The selective display | |
876 effect is seen only within Emacs. | |
877 | |
878 @defvar selective-display | |
879 This buffer-local variable enables selective display. This means that | |
880 lines, or portions of lines, may be made hidden. | |
881 | |
882 @itemize @bullet | |
883 @item | |
884 If the value of @code{selective-display} is @code{t}, then the character | |
885 control-m marks the start of hidden text; the control-m, and the rest | |
886 of the line following it, are not displayed. This is explicit selective | |
887 display. | |
888 | |
889 @item | |
890 If the value of @code{selective-display} is a positive integer, then | |
891 lines that start with more than that many columns of indentation are not | |
892 displayed. | |
893 @end itemize | |
894 | |
895 When some portion of a buffer is hidden, the vertical movement | |
896 commands operate as if that portion did not exist, allowing a single | |
897 @code{next-line} command to skip any number of hidden lines. | |
898 However, character movement commands (such as @code{forward-char}) do | |
899 not skip the hidden portion, and it is possible (if tricky) to insert | |
900 or delete text in an hidden portion. | |
901 | |
902 In the examples below, we show the @emph{display appearance} of the | |
903 buffer @code{foo}, which changes with the value of | |
904 @code{selective-display}. The @emph{contents} of the buffer do not | |
905 change. | |
906 | |
907 @example | |
908 @group | |
909 (setq selective-display nil) | |
910 @result{} nil | |
911 | |
912 ---------- Buffer: foo ---------- | |
913 1 on this column | |
914 2on this column | |
915 3n this column | |
916 3n this column | |
917 2on this column | |
918 1 on this column | |
919 ---------- Buffer: foo ---------- | |
920 @end group | |
921 | |
922 @group | |
923 (setq selective-display 2) | |
924 @result{} 2 | |
925 | |
926 ---------- Buffer: foo ---------- | |
927 1 on this column | |
928 2on this column | |
929 2on this column | |
930 1 on this column | |
931 ---------- Buffer: foo ---------- | |
932 @end group | |
933 @end example | |
934 @end defvar | |
935 | |
936 @defvar selective-display-ellipses | |
937 If this buffer-local variable is non-@code{nil}, then Emacs displays | |
938 @samp{@dots{}} at the end of a line that is followed by hidden text. | |
939 This example is a continuation of the previous one. | |
940 | |
941 @example | |
942 @group | |
943 (setq selective-display-ellipses t) | |
944 @result{} t | |
945 | |
946 ---------- Buffer: foo ---------- | |
947 1 on this column | |
948 2on this column ... | |
949 2on this column | |
950 1 on this column | |
951 ---------- Buffer: foo ---------- | |
952 @end group | |
953 @end example | |
954 | |
955 You can use a display table to substitute other text for the ellipsis | |
956 (@samp{@dots{}}). @xref{Display Tables}. | |
957 @end defvar | |
958 | |
959 @node Temporary Displays | |
960 @section Temporary Displays | |
961 | |
962 Temporary displays are used by Lisp programs to put output into a | |
963 buffer and then present it to the user for perusal rather than for | |
964 editing. Many help commands use this feature. | |
965 | |
966 @defspec with-output-to-temp-buffer buffer-name forms@dots{} | |
967 This function executes @var{forms} while arranging to insert any output | |
968 they print into the buffer named @var{buffer-name}, which is first | |
969 created if necessary, and put into Help mode. Finally, the buffer is | |
970 displayed in some window, but not selected. | |
971 | |
972 If the @var{forms} do not change the major mode in the output buffer, | |
973 so that it is still Help mode at the end of their execution, then | |
974 @code{with-output-to-temp-buffer} makes this buffer read-only at the | |
975 end, and also scans it for function and variable names to make them | |
976 into clickable cross-references. @xref{Docstring hyperlinks, , Tips | |
977 for Documentation Strings}, in particular the item on hyperlinks in | |
978 documentation strings, for more details. | |
979 | |
980 The string @var{buffer-name} specifies the temporary buffer, which | |
981 need not already exist. The argument must be a string, not a buffer. | |
982 The buffer is erased initially (with no questions asked), and it is | |
983 marked as unmodified after @code{with-output-to-temp-buffer} exits. | |
984 | |
985 @code{with-output-to-temp-buffer} binds @code{standard-output} to the | |
986 temporary buffer, then it evaluates the forms in @var{forms}. Output | |
987 using the Lisp output functions within @var{forms} goes by default to | |
988 that buffer (but screen display and messages in the echo area, although | |
989 they are ``output'' in the general sense of the word, are not affected). | |
990 @xref{Output Functions}. | |
991 | |
992 Several hooks are available for customizing the behavior | |
993 of this construct; they are listed below. | |
994 | |
995 The value of the last form in @var{forms} is returned. | |
996 | |
997 @example | |
998 @group | |
999 ---------- Buffer: foo ---------- | |
1000 This is the contents of foo. | |
1001 ---------- Buffer: foo ---------- | |
1002 @end group | |
1003 | |
1004 @group | |
1005 (with-output-to-temp-buffer "foo" | |
1006 (print 20) | |
1007 (print standard-output)) | |
1008 @result{} #<buffer foo> | |
1009 | |
1010 ---------- Buffer: foo ---------- | |
1011 20 | |
1012 | |
1013 #<buffer foo> | |
1014 | |
1015 ---------- Buffer: foo ---------- | |
1016 @end group | |
1017 @end example | |
1018 @end defspec | |
1019 | |
1020 @defvar temp-buffer-show-function | |
1021 If this variable is non-@code{nil}, @code{with-output-to-temp-buffer} | |
1022 calls it as a function to do the job of displaying a help buffer. The | |
1023 function gets one argument, which is the buffer it should display. | |
1024 | |
1025 It is a good idea for this function to run @code{temp-buffer-show-hook} | |
1026 just as @code{with-output-to-temp-buffer} normally would, inside of | |
1027 @code{save-selected-window} and with the chosen window and buffer | |
1028 selected. | |
1029 @end defvar | |
1030 | |
1031 @defvar temp-buffer-setup-hook | |
1032 This normal hook is run by @code{with-output-to-temp-buffer} before | |
1033 evaluating @var{body}. When the hook runs, the temporary buffer is | |
1034 current. This hook is normally set up with a function to put the | |
1035 buffer in Help mode. | |
1036 @end defvar | |
1037 | |
1038 @defvar temp-buffer-show-hook | |
1039 This normal hook is run by @code{with-output-to-temp-buffer} after | |
1040 displaying the temporary buffer. When the hook runs, the temporary buffer | |
1041 is current, and the window it was displayed in is selected. This hook | |
1042 is normally set up with a function to make the buffer read only, and | |
1043 find function names and variable names in it, provided the major mode | |
1044 is Help mode. | |
1045 @end defvar | |
1046 | |
1047 @defun momentary-string-display string position &optional char message | |
1048 This function momentarily displays @var{string} in the current buffer at | |
1049 @var{position}. It has no effect on the undo list or on the buffer's | |
1050 modification status. | |
1051 | |
1052 The momentary display remains until the next input event. If the next | |
1053 input event is @var{char}, @code{momentary-string-display} ignores it | |
1054 and returns. Otherwise, that event remains buffered for subsequent use | |
1055 as input. Thus, typing @var{char} will simply remove the string from | |
1056 the display, while typing (say) @kbd{C-f} will remove the string from | |
1057 the display and later (presumably) move point forward. The argument | |
1058 @var{char} is a space by default. | |
1059 | |
1060 The return value of @code{momentary-string-display} is not meaningful. | |
1061 | |
1062 If the string @var{string} does not contain control characters, you can | |
1063 do the same job in a more general way by creating (and then subsequently | |
1064 deleting) an overlay with a @code{before-string} property. | |
1065 @xref{Overlay Properties}. | |
1066 | |
1067 If @var{message} is non-@code{nil}, it is displayed in the echo area | |
1068 while @var{string} is displayed in the buffer. If it is @code{nil}, a | |
1069 default message says to type @var{char} to continue. | |
1070 | |
1071 In this example, point is initially located at the beginning of the | |
1072 second line: | |
1073 | |
1074 @example | |
1075 @group | |
1076 ---------- Buffer: foo ---------- | |
1077 This is the contents of foo. | |
1078 @point{}Second line. | |
1079 ---------- Buffer: foo ---------- | |
1080 @end group | |
1081 | |
1082 @group | |
1083 (momentary-string-display | |
1084 "**** Important Message! ****" | |
1085 (point) ?\r | |
1086 "Type RET when done reading") | |
1087 @result{} t | |
1088 @end group | |
1089 | |
1090 @group | |
1091 ---------- Buffer: foo ---------- | |
1092 This is the contents of foo. | |
1093 **** Important Message! ****Second line. | |
1094 ---------- Buffer: foo ---------- | |
1095 | |
1096 ---------- Echo Area ---------- | |
1097 Type RET when done reading | |
1098 ---------- Echo Area ---------- | |
1099 @end group | |
1100 @end example | |
1101 @end defun | |
1102 | |
1103 @node Overlays | |
1104 @section Overlays | |
1105 @cindex overlays | |
1106 | |
1107 You can use @dfn{overlays} to alter the appearance of a buffer's text on | |
1108 the screen, for the sake of presentation features. An overlay is an | |
1109 object that belongs to a particular buffer, and has a specified | |
1110 beginning and end. It also has properties that you can examine and set; | |
1111 these affect the display of the text within the overlay. | |
1112 | |
1113 An overlay uses markers to record its beginning and end; thus, | |
1114 editing the text of the buffer adjusts the beginning and end of each | |
1115 overlay so that it stays with the text. When you create the overlay, | |
1116 you can specify whether text inserted at the beginning should be | |
1117 inside the overlay or outside, and likewise for the end of the overlay. | |
1118 | |
1119 @menu | |
1120 * Managing Overlays:: Creating and moving overlays. | |
1121 * Overlay Properties:: How to read and set properties. | |
1122 What properties do to the screen display. | |
1123 * Finding Overlays:: Searching for overlays. | |
1124 @end menu | |
1125 | |
1126 @node Managing Overlays | |
1127 @subsection Managing Overlays | |
1128 | |
1129 This section describes the functions to create, delete and move | |
1130 overlays, and to examine their contents. Overlay changes are not | |
1131 recorded in the buffer's undo list, since the overlays are not | |
1132 part of the buffer's contents. | |
1133 | |
1134 @defun overlayp object | |
1135 This function returns @code{t} if @var{object} is an overlay. | |
1136 @end defun | |
1137 | |
1138 @defun make-overlay start end &optional buffer front-advance rear-advance | |
1139 This function creates and returns an overlay that belongs to | |
1140 @var{buffer} and ranges from @var{start} to @var{end}. Both @var{start} | |
1141 and @var{end} must specify buffer positions; they may be integers or | |
1142 markers. If @var{buffer} is omitted, the overlay is created in the | |
1143 current buffer. | |
1144 | |
1145 The arguments @var{front-advance} and @var{rear-advance} specify the | |
1146 marker insertion type for the start of the overlay and for the end of | |
1147 the overlay, respectively. @xref{Marker Insertion Types}. If they | |
1148 are both @code{nil}, the default, then the overlay extends to include | |
1149 any text inserted at the beginning, but not text inserted at the end. | |
1150 If @var{front-advance} is non-@code{nil}, text inserted at the | |
1151 beginning of the overlay is excluded from the overlay. If | |
1152 @var{rear-advance} is non-@code{nil}, text inserted at the end of the | |
1153 overlay is included in the overlay. | |
1154 @end defun | |
1155 | |
1156 @defun overlay-start overlay | |
1157 This function returns the position at which @var{overlay} starts, | |
1158 as an integer. | |
1159 @end defun | |
1160 | |
1161 @defun overlay-end overlay | |
1162 This function returns the position at which @var{overlay} ends, | |
1163 as an integer. | |
1164 @end defun | |
1165 | |
1166 @defun overlay-buffer overlay | |
1167 This function returns the buffer that @var{overlay} belongs to. It | |
1168 returns @code{nil} if @var{overlay} has been deleted. | |
1169 @end defun | |
1170 | |
1171 @defun delete-overlay overlay | |
1172 This function deletes @var{overlay}. The overlay continues to exist as | |
1173 a Lisp object, and its property list is unchanged, but it ceases to be | |
1174 attached to the buffer it belonged to, and ceases to have any effect on | |
1175 display. | |
1176 | |
1177 A deleted overlay is not permanently disconnected. You can give it a | |
1178 position in a buffer again by calling @code{move-overlay}. | |
1179 @end defun | |
1180 | |
1181 @defun move-overlay overlay start end &optional buffer | |
1182 This function moves @var{overlay} to @var{buffer}, and places its bounds | |
1183 at @var{start} and @var{end}. Both arguments @var{start} and @var{end} | |
1184 must specify buffer positions; they may be integers or markers. | |
1185 | |
1186 If @var{buffer} is omitted, @var{overlay} stays in the same buffer it | |
1187 was already associated with; if @var{overlay} was deleted, it goes into | |
1188 the current buffer. | |
1189 | |
1190 The return value is @var{overlay}. | |
1191 | |
1192 This is the only valid way to change the endpoints of an overlay. Do | |
1193 not try modifying the markers in the overlay by hand, as that fails to | |
1194 update other vital data structures and can cause some overlays to be | |
1195 ``lost.'' | |
1196 @end defun | |
1197 | |
1198 @defun remove-overlays &optional start end name value | |
1199 This function removes all the overlays between @var{start} and | |
1200 @var{end} whose property @var{name} has the value @var{value}. It can | |
1201 move the endpoints of the overlays in the region, or split them. | |
1202 | |
1203 If @var{name} is omitted or @code{nil}, it means to delete all overlays in | |
1204 the specified region. If @var{start} and/or @var{end} are omitted or | |
1205 @code{nil}, that means the beginning and end of the buffer respectively. | |
1206 Therefore, @code{(remove-overlays)} removes all the overlays in the | |
1207 current buffer. | |
1208 @end defun | |
1209 | |
1210 Here are some examples: | |
1211 | |
1212 @example | |
1213 ;; @r{Create an overlay.} | |
1214 (setq foo (make-overlay 1 10)) | |
1215 @result{} #<overlay from 1 to 10 in display.texi> | |
1216 (overlay-start foo) | |
1217 @result{} 1 | |
1218 (overlay-end foo) | |
1219 @result{} 10 | |
1220 (overlay-buffer foo) | |
1221 @result{} #<buffer display.texi> | |
1222 ;; @r{Give it a property we can check later.} | |
1223 (overlay-put foo 'happy t) | |
1224 @result{} t | |
1225 ;; @r{Verify the property is present.} | |
1226 (overlay-get foo 'happy) | |
1227 @result{} t | |
1228 ;; @r{Move the overlay.} | |
1229 (move-overlay foo 5 20) | |
1230 @result{} #<overlay from 5 to 20 in display.texi> | |
1231 (overlay-start foo) | |
1232 @result{} 5 | |
1233 (overlay-end foo) | |
1234 @result{} 20 | |
1235 ;; @r{Delete the overlay.} | |
1236 (delete-overlay foo) | |
1237 @result{} nil | |
1238 ;; @r{Verify it is deleted.} | |
1239 foo | |
1240 @result{} #<overlay in no buffer> | |
1241 ;; @r{A deleted overlay has no position.} | |
1242 (overlay-start foo) | |
1243 @result{} nil | |
1244 (overlay-end foo) | |
1245 @result{} nil | |
1246 (overlay-buffer foo) | |
1247 @result{} nil | |
1248 ;; @r{Undelete the overlay.} | |
1249 (move-overlay foo 1 20) | |
1250 @result{} #<overlay from 1 to 20 in display.texi> | |
1251 ;; @r{Verify the results.} | |
1252 (overlay-start foo) | |
1253 @result{} 1 | |
1254 (overlay-end foo) | |
1255 @result{} 20 | |
1256 (overlay-buffer foo) | |
1257 @result{} #<buffer display.texi> | |
1258 ;; @r{Moving and deleting the overlay does not change its properties.} | |
1259 (overlay-get foo 'happy) | |
1260 @result{} t | |
1261 @end example | |
1262 | |
1263 Emacs stores the overlays of each buffer in two lists, divided | |
1264 around an arbitrary ``center position.'' One list extends backwards | |
1265 through the buffer from that center position, and the other extends | |
1266 forwards from that center position. The center position can be anywhere | |
1267 in the buffer. | |
1268 | |
1269 @defun overlay-recenter pos | |
1270 This function recenters the overlays of the current buffer around | |
1271 position @var{pos}. That makes overlay lookup faster for positions | |
1272 near @var{pos}, but slower for positions far away from @var{pos}. | |
1273 @end defun | |
1274 | |
1275 A loop that scans the buffer forwards, creating overlays, can run | |
1276 faster if you do @code{(overlay-recenter (point-max))} first. | |
1277 | |
1278 @node Overlay Properties | |
1279 @subsection Overlay Properties | |
1280 | |
1281 Overlay properties are like text properties in that the properties that | |
1282 alter how a character is displayed can come from either source. But in | |
1283 most respects they are different. @xref{Text Properties}, for comparison. | |
1284 | |
1285 Text properties are considered a part of the text; overlays and | |
1286 their properties are specifically considered not to be part of the | |
1287 text. Thus, copying text between various buffers and strings | |
1288 preserves text properties, but does not try to preserve overlays. | |
1289 Changing a buffer's text properties marks the buffer as modified, | |
1290 while moving an overlay or changing its properties does not. Unlike | |
1291 text property changes, overlay property changes are not recorded in | |
1292 the buffer's undo list. | |
1293 | |
85004
b516a4e62b87
(Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents:
84116
diff
changeset
|
1294 Since more than one overlay can specify a property value for the |
b516a4e62b87
(Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents:
84116
diff
changeset
|
1295 same character, Emacs lets you specify a priority value of each |
b516a4e62b87
(Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents:
84116
diff
changeset
|
1296 overlay. You should not make assumptions about which overlay will |
b516a4e62b87
(Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents:
84116
diff
changeset
|
1297 prevail when there is a conflict and they have the same priority. |
b516a4e62b87
(Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents:
84116
diff
changeset
|
1298 |
84060 | 1299 These functions read and set the properties of an overlay: |
1300 | |
1301 @defun overlay-get overlay prop | |
1302 This function returns the value of property @var{prop} recorded in | |
1303 @var{overlay}, if any. If @var{overlay} does not record any value for | |
1304 that property, but it does have a @code{category} property which is a | |
1305 symbol, that symbol's @var{prop} property is used. Otherwise, the value | |
1306 is @code{nil}. | |
1307 @end defun | |
1308 | |
1309 @defun overlay-put overlay prop value | |
1310 This function sets the value of property @var{prop} recorded in | |
1311 @var{overlay} to @var{value}. It returns @var{value}. | |
1312 @end defun | |
1313 | |
1314 @defun overlay-properties overlay | |
1315 This returns a copy of the property list of @var{overlay}. | |
1316 @end defun | |
1317 | |
1318 See also the function @code{get-char-property} which checks both | |
1319 overlay properties and text properties for a given character. | |
1320 @xref{Examining Properties}. | |
1321 | |
1322 Many overlay properties have special meanings; here is a table | |
1323 of them: | |
1324 | |
1325 @table @code | |
1326 @item priority | |
1327 @kindex priority @r{(overlay property)} | |
1328 This property's value (which should be a nonnegative integer number) | |
85004
b516a4e62b87
(Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents:
84116
diff
changeset
|
1329 determines the priority of the overlay. No priority, or @code{nil}, |
b516a4e62b87
(Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents:
84116
diff
changeset
|
1330 means zero. |
b516a4e62b87
(Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents:
84116
diff
changeset
|
1331 |
b516a4e62b87
(Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents:
84116
diff
changeset
|
1332 The priority matters when two or more overlays cover the same |
b516a4e62b87
(Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents:
84116
diff
changeset
|
1333 character and both specify the same property; the one whose |
b516a4e62b87
(Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents:
84116
diff
changeset
|
1334 @code{priority} value is larger overrides the other. For the |
b516a4e62b87
(Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents:
84116
diff
changeset
|
1335 @code{face} property, the higher priority overlay's value does not |
b516a4e62b87
(Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents:
84116
diff
changeset
|
1336 completely override the other value; instead, its face attributes |
b516a4e62b87
(Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents:
84116
diff
changeset
|
1337 override the face attributes of the lower priority @code{face} |
b516a4e62b87
(Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents:
84116
diff
changeset
|
1338 property. |
84060 | 1339 |
1340 Currently, all overlays take priority over text properties. Please | |
1341 avoid using negative priority values, as we have not yet decided just | |
1342 what they should mean. | |
1343 | |
1344 @item window | |
1345 @kindex window @r{(overlay property)} | |
1346 If the @code{window} property is non-@code{nil}, then the overlay | |
1347 applies only on that window. | |
1348 | |
1349 @item category | |
1350 @kindex category @r{(overlay property)} | |
1351 If an overlay has a @code{category} property, we call it the | |
1352 @dfn{category} of the overlay. It should be a symbol. The properties | |
1353 of the symbol serve as defaults for the properties of the overlay. | |
1354 | |
1355 @item face | |
1356 @kindex face @r{(overlay property)} | |
1357 This property controls the way text is displayed---for example, which | |
1358 font and which colors. @xref{Faces}, for more information. | |
1359 | |
1360 In the simplest case, the value is a face name. It can also be a list; | |
1361 then each element can be any of these possibilities: | |
1362 | |
1363 @itemize @bullet | |
1364 @item | |
1365 A face name (a symbol or string). | |
1366 | |
1367 @item | |
1368 A property list of face attributes. This has the form (@var{keyword} | |
1369 @var{value} @dots{}), where each @var{keyword} is a face attribute | |
1370 name and @var{value} is a meaningful value for that attribute. With | |
1371 this feature, you do not need to create a face each time you want to | |
1372 specify a particular attribute for certain text. @xref{Face | |
1373 Attributes}. | |
1374 | |
1375 @item | |
1376 A cons cell, either of the form @code{(foreground-color . @var{color-name})} or | |
1377 @code{(background-color . @var{color-name})}. These elements specify | |
1378 just the foreground color or just the background color. | |
1379 | |
1380 @code{(foreground-color . @var{color-name})} has the same effect as | |
1381 @code{(:foreground @var{color-name})}; likewise for the background. | |
1382 @end itemize | |
1383 | |
1384 @item mouse-face | |
1385 @kindex mouse-face @r{(overlay property)} | |
1386 This property is used instead of @code{face} when the mouse is within | |
1387 the range of the overlay. | |
1388 | |
1389 @item display | |
1390 @kindex display @r{(overlay property)} | |
1391 This property activates various features that change the | |
1392 way text is displayed. For example, it can make text appear taller | |
1393 or shorter, higher or lower, wider or narrower, or replaced with an image. | |
1394 @xref{Display Property}. | |
1395 | |
1396 @item help-echo | |
1397 @kindex help-echo @r{(overlay property)} | |
1398 If an overlay has a @code{help-echo} property, then when you move the | |
1399 mouse onto the text in the overlay, Emacs displays a help string in the | |
1400 echo area, or in the tooltip window. For details see @ref{Text | |
1401 help-echo}. | |
1402 | |
1403 @item modification-hooks | |
1404 @kindex modification-hooks @r{(overlay property)} | |
1405 This property's value is a list of functions to be called if any | |
1406 character within the overlay is changed or if text is inserted strictly | |
1407 within the overlay. | |
1408 | |
1409 The hook functions are called both before and after each change. | |
1410 If the functions save the information they receive, and compare notes | |
1411 between calls, they can determine exactly what change has been made | |
1412 in the buffer text. | |
1413 | |
1414 When called before a change, each function receives four arguments: the | |
1415 overlay, @code{nil}, and the beginning and end of the text range to be | |
1416 modified. | |
1417 | |
1418 When called after a change, each function receives five arguments: the | |
1419 overlay, @code{t}, the beginning and end of the text range just | |
1420 modified, and the length of the pre-change text replaced by that range. | |
1421 (For an insertion, the pre-change length is zero; for a deletion, that | |
1422 length is the number of characters deleted, and the post-change | |
1423 beginning and end are equal.) | |
1424 | |
1425 If these functions modify the buffer, they should bind | |
1426 @code{inhibit-modification-hooks} to @code{t} around doing so, to | |
1427 avoid confusing the internal mechanism that calls these hooks. | |
1428 | |
1429 Text properties also support the @code{modification-hooks} property, | |
1430 but the details are somewhat different (@pxref{Special Properties}). | |
1431 | |
1432 @item insert-in-front-hooks | |
1433 @kindex insert-in-front-hooks @r{(overlay property)} | |
1434 This property's value is a list of functions to be called before and | |
1435 after inserting text right at the beginning of the overlay. The calling | |
1436 conventions are the same as for the @code{modification-hooks} functions. | |
1437 | |
1438 @item insert-behind-hooks | |
1439 @kindex insert-behind-hooks @r{(overlay property)} | |
1440 This property's value is a list of functions to be called before and | |
1441 after inserting text right at the end of the overlay. The calling | |
1442 conventions are the same as for the @code{modification-hooks} functions. | |
1443 | |
1444 @item invisible | |
1445 @kindex invisible @r{(overlay property)} | |
1446 The @code{invisible} property can make the text in the overlay | |
1447 invisible, which means that it does not appear on the screen. | |
1448 @xref{Invisible Text}, for details. | |
1449 | |
1450 @item intangible | |
1451 @kindex intangible @r{(overlay property)} | |
1452 The @code{intangible} property on an overlay works just like the | |
1453 @code{intangible} text property. @xref{Special Properties}, for details. | |
1454 | |
1455 @item isearch-open-invisible | |
1456 This property tells incremental search how to make an invisible overlay | |
1457 visible, permanently, if the final match overlaps it. @xref{Invisible | |
1458 Text}. | |
1459 | |
1460 @item isearch-open-invisible-temporary | |
1461 This property tells incremental search how to make an invisible overlay | |
1462 visible, temporarily, during the search. @xref{Invisible Text}. | |
1463 | |
1464 @item before-string | |
1465 @kindex before-string @r{(overlay property)} | |
1466 This property's value is a string to add to the display at the beginning | |
1467 of the overlay. The string does not appear in the buffer in any | |
1468 sense---only on the screen. | |
1469 | |
1470 @item after-string | |
1471 @kindex after-string @r{(overlay property)} | |
1472 This property's value is a string to add to the display at the end of | |
1473 the overlay. The string does not appear in the buffer in any | |
1474 sense---only on the screen. | |
1475 | |
1476 @item evaporate | |
1477 @kindex evaporate @r{(overlay property)} | |
1478 If this property is non-@code{nil}, the overlay is deleted automatically | |
1479 if it becomes empty (i.e., if its length becomes zero). If you give | |
1480 an empty overlay a non-@code{nil} @code{evaporate} property, that deletes | |
1481 it immediately. | |
1482 | |
1483 @item local-map | |
1484 @cindex keymap of character (and overlays) | |
1485 @kindex local-map @r{(overlay property)} | |
1486 If this property is non-@code{nil}, it specifies a keymap for a portion | |
1487 of the text. The property's value replaces the buffer's local map, when | |
1488 the character after point is within the overlay. @xref{Active Keymaps}. | |
1489 | |
1490 @item keymap | |
1491 @kindex keymap @r{(overlay property)} | |
1492 The @code{keymap} property is similar to @code{local-map} but overrides the | |
1493 buffer's local map (and the map specified by the @code{local-map} | |
1494 property) rather than replacing it. | |
1495 @end table | |
1496 | |
1497 @node Finding Overlays | |
1498 @subsection Searching for Overlays | |
1499 | |
1500 @defun overlays-at pos | |
1501 This function returns a list of all the overlays that cover the | |
1502 character at position @var{pos} in the current buffer. The list is in | |
1503 no particular order. An overlay contains position @var{pos} if it | |
1504 begins at or before @var{pos}, and ends after @var{pos}. | |
1505 | |
1506 To illustrate usage, here is a Lisp function that returns a list of the | |
1507 overlays that specify property @var{prop} for the character at point: | |
1508 | |
1509 @smallexample | |
1510 (defun find-overlays-specifying (prop) | |
1511 (let ((overlays (overlays-at (point))) | |
1512 found) | |
1513 (while overlays | |
1514 (let ((overlay (car overlays))) | |
1515 (if (overlay-get overlay prop) | |
1516 (setq found (cons overlay found)))) | |
1517 (setq overlays (cdr overlays))) | |
1518 found)) | |
1519 @end smallexample | |
1520 @end defun | |
1521 | |
1522 @defun overlays-in beg end | |
1523 This function returns a list of the overlays that overlap the region | |
1524 @var{beg} through @var{end}. ``Overlap'' means that at least one | |
1525 character is contained within the overlay and also contained within the | |
1526 specified region; however, empty overlays are included in the result if | |
1527 they are located at @var{beg}, or strictly between @var{beg} and @var{end}. | |
1528 @end defun | |
1529 | |
1530 @defun next-overlay-change pos | |
1531 This function returns the buffer position of the next beginning or end | |
1532 of an overlay, after @var{pos}. If there is none, it returns | |
1533 @code{(point-max)}. | |
1534 @end defun | |
1535 | |
1536 @defun previous-overlay-change pos | |
1537 This function returns the buffer position of the previous beginning or | |
1538 end of an overlay, before @var{pos}. If there is none, it returns | |
1539 @code{(point-min)}. | |
1540 @end defun | |
1541 | |
1542 As an example, here's a simplified (and inefficient) version of the | |
1543 primitive function @code{next-single-char-property-change} | |
1544 (@pxref{Property Search}). It searches forward from position | |
1545 @var{pos} for the next position where the value of a given property | |
1546 @code{prop}, as obtained from either overlays or text properties, | |
1547 changes. | |
1548 | |
1549 @smallexample | |
1550 (defun next-single-char-property-change (position prop) | |
1551 (save-excursion | |
1552 (goto-char position) | |
1553 (let ((propval (get-char-property (point) prop))) | |
1554 (while (and (not (eobp)) | |
1555 (eq (get-char-property (point) prop) propval)) | |
1556 (goto-char (min (next-overlay-change (point)) | |
1557 (next-single-property-change (point) prop))))) | |
1558 (point))) | |
1559 @end smallexample | |
1560 | |
1561 @node Width | |
1562 @section Width | |
1563 | |
1564 Since not all characters have the same width, these functions let you | |
1565 check the width of a character. @xref{Primitive Indent}, and | |
1566 @ref{Screen Lines}, for related functions. | |
1567 | |
1568 @defun char-width char | |
1569 This function returns the width in columns of the character @var{char}, | |
1570 if it were displayed in the current buffer and the selected window. | |
1571 @end defun | |
1572 | |
1573 @defun string-width string | |
1574 This function returns the width in columns of the string @var{string}, | |
1575 if it were displayed in the current buffer and the selected window. | |
1576 @end defun | |
1577 | |
1578 @defun truncate-string-to-width string width &optional start-column padding ellipsis | |
1579 This function returns the part of @var{string} that fits within | |
1580 @var{width} columns, as a new string. | |
1581 | |
1582 If @var{string} does not reach @var{width}, then the result ends where | |
1583 @var{string} ends. If one multi-column character in @var{string} | |
1584 extends across the column @var{width}, that character is not included in | |
1585 the result. Thus, the result can fall short of @var{width} but cannot | |
1586 go beyond it. | |
1587 | |
1588 The optional argument @var{start-column} specifies the starting column. | |
1589 If this is non-@code{nil}, then the first @var{start-column} columns of | |
1590 the string are omitted from the value. If one multi-column character in | |
1591 @var{string} extends across the column @var{start-column}, that | |
1592 character is not included. | |
1593 | |
1594 The optional argument @var{padding}, if non-@code{nil}, is a padding | |
1595 character added at the beginning and end of the result string, to extend | |
1596 it to exactly @var{width} columns. The padding character is used at the | |
1597 end of the result if it falls short of @var{width}. It is also used at | |
1598 the beginning of the result if one multi-column character in | |
1599 @var{string} extends across the column @var{start-column}. | |
1600 | |
1601 If @var{ellipsis} is non-@code{nil}, it should be a string which will | |
1602 replace the end of @var{str} (including any padding) if it extends | |
1603 beyond @var{end-column}, unless the display width of @var{str} is | |
1604 equal to or less than the display width of @var{ellipsis}. If | |
1605 @var{ellipsis} is non-@code{nil} and not a string, it stands for | |
1606 @code{"..."}. | |
1607 | |
1608 @example | |
1609 (truncate-string-to-width "\tab\t" 12 4) | |
1610 @result{} "ab" | |
1611 (truncate-string-to-width "\tab\t" 12 4 ?\s) | |
1612 @result{} " ab " | |
1613 @end example | |
1614 @end defun | |
1615 | |
1616 @node Line Height | |
1617 @section Line Height | |
1618 @cindex line height | |
1619 | |
1620 The total height of each display line consists of the height of the | |
1621 contents of the line, plus optional additional vertical line spacing | |
1622 above or below the display line. | |
1623 | |
1624 The height of the line contents is the maximum height of any | |
1625 character or image on that display line, including the final newline | |
1626 if there is one. (A display line that is continued doesn't include a | |
1627 final newline.) That is the default line height, if you do nothing to | |
1628 specify a greater height. (In the most common case, this equals the | |
1629 height of the default frame font.) | |
1630 | |
1631 There are several ways to explicitly specify a larger line height, | |
1632 either by specifying an absolute height for the display line, or by | |
1633 specifying vertical space. However, no matter what you specify, the | |
1634 actual line height can never be less than the default. | |
1635 | |
1636 @kindex line-height @r{(text property)} | |
1637 A newline can have a @code{line-height} text or overlay property | |
1638 that controls the total height of the display line ending in that | |
1639 newline. | |
1640 | |
1641 If the property value is @code{t}, the newline character has no | |
1642 effect on the displayed height of the line---the visible contents | |
1643 alone determine the height. This is useful for tiling small images | |
1644 (or image slices) without adding blank areas between the images. | |
1645 | |
1646 If the property value is a list of the form @code{(@var{height} | |
1647 @var{total})}, that adds extra space @emph{below} the display line. | |
1648 First Emacs uses @var{height} as a height spec to control extra space | |
1649 @emph{above} the line; then it adds enough space @emph{below} the line | |
1650 to bring the total line height up to @var{total}. In this case, the | |
1651 other ways to specify the line spacing are ignored. | |
1652 | |
1653 Any other kind of property value is a height spec, which translates | |
1654 into a number---the specified line height. There are several ways to | |
1655 write a height spec; here's how each of them translates into a number: | |
1656 | |
1657 @table @code | |
1658 @item @var{integer} | |
1659 If the height spec is a positive integer, the height value is that integer. | |
1660 @item @var{float} | |
1661 If the height spec is a float, @var{float}, the numeric height value | |
1662 is @var{float} times the frame's default line height. | |
1663 @item (@var{face} . @var{ratio}) | |
1664 If the height spec is a cons of the format shown, the numeric height | |
1665 is @var{ratio} times the height of face @var{face}. @var{ratio} can | |
1666 be any type of number, or @code{nil} which means a ratio of 1. | |
1667 If @var{face} is @code{t}, it refers to the current face. | |
1668 @item (nil . @var{ratio}) | |
1669 If the height spec is a cons of the format shown, the numeric height | |
1670 is @var{ratio} times the height of the contents of the line. | |
1671 @end table | |
1672 | |
1673 Thus, any valid height spec determines the height in pixels, one way | |
1674 or another. If the line contents' height is less than that, Emacs | |
1675 adds extra vertical space above the line to achieve the specified | |
1676 total height. | |
1677 | |
1678 If you don't specify the @code{line-height} property, the line's | |
1679 height consists of the contents' height plus the line spacing. | |
1680 There are several ways to specify the line spacing for different | |
1681 parts of Emacs text. | |
1682 | |
1683 @vindex default-line-spacing | |
1684 You can specify the line spacing for all lines in a frame with the | |
1685 @code{line-spacing} frame parameter (@pxref{Layout Parameters}). | |
1686 However, if the variable @code{default-line-spacing} is | |
1687 non-@code{nil}, it overrides the frame's @code{line-spacing} | |
1688 parameter. An integer value specifies the number of pixels put below | |
1689 lines on graphical displays. A floating point number specifies the | |
1690 spacing relative to the frame's default line height. | |
1691 | |
1692 @vindex line-spacing | |
1693 You can specify the line spacing for all lines in a buffer via the | |
1694 buffer-local @code{line-spacing} variable. An integer value specifies | |
1695 the number of pixels put below lines on graphical displays. A floating | |
1696 point number specifies the spacing relative to the default frame line | |
1697 height. This overrides line spacings specified for the frame. | |
1698 | |
1699 @kindex line-spacing @r{(text property)} | |
1700 Finally, a newline can have a @code{line-spacing} text or overlay | |
1701 property that overrides the default frame line spacing and the buffer | |
1702 local @code{line-spacing} variable, for the display line ending in | |
1703 that newline. | |
1704 | |
1705 One way or another, these mechanisms specify a Lisp value for the | |
1706 spacing of each line. The value is a height spec, and it translates | |
1707 into a Lisp value as described above. However, in this case the | |
1708 numeric height value specifies the line spacing, rather than the line | |
1709 height. | |
1710 | |
1711 @node Faces | |
1712 @section Faces | |
1713 @cindex faces | |
1714 | |
1715 A @dfn{face} is a named collection of graphical attributes: font | |
1716 family, foreground color, background color, optional underlining, and | |
1717 many others. Faces are used in Emacs to control the style of display of | |
1718 particular parts of the text or the frame. @xref{Standard Faces,,, | |
1719 emacs, The GNU Emacs Manual}, for the list of faces Emacs normally | |
1720 comes with. | |
1721 | |
1722 @cindex face id | |
1723 Each face has its own @dfn{face number}, which distinguishes faces at | |
1724 low levels within Emacs. However, for most purposes, you refer to | |
1725 faces in Lisp programs by the symbols that name them. | |
1726 | |
1727 @defun facep object | |
1728 This function returns @code{t} if @var{object} is a face name string | |
1729 or symbol (or if it is a vector of the kind used internally to record | |
1730 face data). It returns @code{nil} otherwise. | |
1731 @end defun | |
1732 | |
1733 Each face name is meaningful for all frames, and by default it has the | |
1734 same meaning in all frames. But you can arrange to give a particular | |
1735 face name a special meaning in one frame if you wish. | |
1736 | |
1737 @menu | |
1738 * Defining Faces:: How to define a face with @code{defface}. | |
1739 * Face Attributes:: What is in a face? | |
1740 * Attribute Functions:: Functions to examine and set face attributes. | |
1741 * Displaying Faces:: How Emacs combines the faces specified for a character. | |
1742 * Font Selection:: Finding the best available font for a face. | |
1743 * Face Functions:: How to define and examine faces. | |
1744 * Auto Faces:: Hook for automatic face assignment. | |
1745 * Font Lookup:: Looking up the names of available fonts | |
1746 and information about them. | |
1747 * Fontsets:: A fontset is a collection of fonts | |
1748 that handle a range of character sets. | |
1749 @end menu | |
1750 | |
1751 @node Defining Faces | |
1752 @subsection Defining Faces | |
1753 | |
1754 The way to define a new face is with @code{defface}. This creates a | |
1755 kind of customization item (@pxref{Customization}) which the user can | |
1756 customize using the Customization buffer (@pxref{Easy Customization,,, | |
1757 emacs, The GNU Emacs Manual}). | |
1758 | |
1759 @defmac defface face spec doc [keyword value]@dots{} | |
1760 This declares @var{face} as a customizable face that defaults | |
1761 according to @var{spec}. You should not quote the symbol @var{face}, | |
1762 and it should not end in @samp{-face} (that would be redundant). The | |
1763 argument @var{doc} specifies the face documentation. The keywords you | |
1764 can use in @code{defface} are the same as in @code{defgroup} and | |
1765 @code{defcustom} (@pxref{Common Keywords}). | |
1766 | |
1767 When @code{defface} executes, it defines the face according to | |
1768 @var{spec}, then uses any customizations that were read from the | |
1769 init file (@pxref{Init File}) to override that specification. | |
1770 | |
1771 When you evaluate a @code{defface} form with @kbd{C-M-x} in Emacs | |
1772 Lisp mode (@code{eval-defun}), a special feature of @code{eval-defun} | |
1773 overrides any customizations of the face. This way, the face reflects | |
1774 exactly what the @code{defface} says. | |
1775 | |
1776 The purpose of @var{spec} is to specify how the face should appear on | |
1777 different kinds of terminals. It should be an alist whose elements | |
1778 have the form @code{(@var{display} @var{atts})}. Each element's | |
1779 @sc{car}, @var{display}, specifies a class of terminals. (The first | |
1780 element, if its @sc{car} is @code{default}, is special---it specifies | |
1781 defaults for the remaining elements). The element's @sc{cadr}, | |
1782 @var{atts}, is a list of face attributes and their values; it | |
1783 specifies what the face should look like on that kind of terminal. | |
1784 The possible attributes are defined in the value of | |
1785 @code{custom-face-attributes}. | |
1786 | |
1787 The @var{display} part of an element of @var{spec} determines which | |
1788 frames the element matches. If more than one element of @var{spec} | |
1789 matches a given frame, the first element that matches is the one used | |
1790 for that frame. There are three possibilities for @var{display}: | |
1791 | |
1792 @table @asis | |
1793 @item @code{default} | |
1794 This element of @var{spec} doesn't match any frames; instead, it | |
1795 specifies defaults that apply to all frames. This kind of element, if | |
1796 used, must be the first element of @var{spec}. Each of the following | |
1797 elements can override any or all of these defaults. | |
1798 | |
1799 @item @code{t} | |
1800 This element of @var{spec} matches all frames. Therefore, any | |
1801 subsequent elements of @var{spec} are never used. Normally | |
1802 @code{t} is used in the last (or only) element of @var{spec}. | |
1803 | |
1804 @item a list | |
1805 If @var{display} is a list, each element should have the form | |
1806 @code{(@var{characteristic} @var{value}@dots{})}. Here | |
1807 @var{characteristic} specifies a way of classifying frames, and the | |
1808 @var{value}s are possible classifications which @var{display} should | |
1809 apply to. Here are the possible values of @var{characteristic}: | |
1810 | |
1811 @table @code | |
1812 @item type | |
1813 The kind of window system the frame uses---either @code{graphic} (any | |
1814 graphics-capable display), @code{x}, @code{pc} (for the MS-DOS console), | |
1815 @code{w32} (for MS Windows 9X/NT/2K/XP), @code{mac} (for the Macintosh | |
1816 display), or @code{tty} (a non-graphics-capable display). | |
1817 @xref{Window Systems, window-system}. | |
1818 | |
1819 @item class | |
1820 What kinds of colors the frame supports---either @code{color}, | |
1821 @code{grayscale}, or @code{mono}. | |
1822 | |
1823 @item background | |
1824 The kind of background---either @code{light} or @code{dark}. | |
1825 | |
1826 @item min-colors | |
1827 An integer that represents the minimum number of colors the frame | |
1828 should support. This matches a frame if its | |
1829 @code{display-color-cells} value is at least the specified integer. | |
1830 | |
1831 @item supports | |
1832 Whether or not the frame can display the face attributes given in | |
1833 @var{value}@dots{} (@pxref{Face Attributes}). See the documentation | |
1834 for the function @code{display-supports-face-attributes-p} for more | |
1835 information on exactly how this testing is done. @xref{Display Face | |
1836 Attribute Testing}. | |
1837 @end table | |
1838 | |
1839 If an element of @var{display} specifies more than one @var{value} for a | |
1840 given @var{characteristic}, any of those values is acceptable. If | |
1841 @var{display} has more than one element, each element should specify a | |
1842 different @var{characteristic}; then @emph{each} characteristic of the | |
1843 frame must match one of the @var{value}s specified for it in | |
1844 @var{display}. | |
1845 @end table | |
1846 @end defmac | |
1847 | |
1848 Here's how the standard face @code{region} is defined: | |
1849 | |
1850 @example | |
1851 @group | |
1852 (defface region | |
1853 '((((class color) (min-colors 88) (background dark)) | |
1854 :background "blue3") | |
1855 @end group | |
1856 (((class color) (min-colors 88) (background light)) | |
1857 :background "lightgoldenrod2") | |
1858 (((class color) (min-colors 16) (background dark)) | |
1859 :background "blue3") | |
1860 (((class color) (min-colors 16) (background light)) | |
1861 :background "lightgoldenrod2") | |
1862 (((class color) (min-colors 8)) | |
1863 :background "blue" :foreground "white") | |
1864 (((type tty) (class mono)) | |
1865 :inverse-video t) | |
1866 (t :background "gray")) | |
1867 @group | |
1868 "Basic face for highlighting the region." | |
1869 :group 'basic-faces) | |
1870 @end group | |
1871 @end example | |
1872 | |
1873 Internally, @code{defface} uses the symbol property | |
1874 @code{face-defface-spec} to record the face attributes specified in | |
1875 @code{defface}, @code{saved-face} for the attributes saved by the user | |
1876 with the customization buffer, @code{customized-face} for the | |
1877 attributes customized by the user for the current session, but not | |
1878 saved, and @code{face-documentation} for the documentation string. | |
1879 | |
1880 @defopt frame-background-mode | |
1881 This option, if non-@code{nil}, specifies the background type to use for | |
1882 interpreting face definitions. If it is @code{dark}, then Emacs treats | |
1883 all frames as if they had a dark background, regardless of their actual | |
1884 background colors. If it is @code{light}, then Emacs treats all frames | |
1885 as if they had a light background. | |
1886 @end defopt | |
1887 | |
1888 @node Face Attributes | |
1889 @subsection Face Attributes | |
1890 @cindex face attributes | |
1891 | |
1892 The effect of using a face is determined by a fixed set of @dfn{face | |
1893 attributes}. This table lists all the face attributes, and what they | |
1894 mean. You can specify more than one face for a given piece of text; | |
1895 Emacs merges the attributes of all the faces to determine how to | |
1896 display the text. @xref{Displaying Faces}. | |
1897 | |
1898 Any attribute in a face can have the value @code{unspecified}. This | |
1899 means the face doesn't specify that attribute. In face merging, when | |
1900 the first face fails to specify a particular attribute, that means the | |
1901 next face gets a chance. However, the @code{default} face must | |
1902 specify all attributes. | |
1903 | |
1904 Some of these font attributes are meaningful only on certain kinds of | |
1905 displays---if your display cannot handle a certain attribute, the | |
1906 attribute is ignored. (The attributes @code{:family}, @code{:width}, | |
1907 @code{:height}, @code{:weight}, and @code{:slant} correspond to parts of | |
1908 an X Logical Font Descriptor.) | |
1909 | |
1910 @table @code | |
1911 @item :family | |
1912 Font family name, or fontset name (@pxref{Fontsets}). If you specify a | |
1913 font family name, the wild-card characters @samp{*} and @samp{?} are | |
1914 allowed. | |
1915 | |
1916 @item :width | |
1917 Relative proportionate width, also known as the character set width or | |
1918 set width. This should be one of the symbols @code{ultra-condensed}, | |
1919 @code{extra-condensed}, @code{condensed}, @code{semi-condensed}, | |
1920 @code{normal}, @code{semi-expanded}, @code{expanded}, | |
1921 @code{extra-expanded}, or @code{ultra-expanded}. | |
1922 | |
1923 @item :height | |
1924 Either the font height, an integer in units of 1/10 point, a floating | |
1925 point number specifying the amount by which to scale the height of any | |
1926 underlying face, or a function, which is called with the old height | |
1927 (from the underlying face), and should return the new height. | |
1928 | |
1929 @item :weight | |
1930 Font weight---a symbol from this series (from most dense to most faint): | |
1931 @code{ultra-bold}, @code{extra-bold}, @code{bold}, @code{semi-bold}, | |
1932 @code{normal}, @code{semi-light}, @code{light}, @code{extra-light}, | |
1933 or @code{ultra-light}. | |
1934 | |
1935 On a text-only terminal, any weight greater than normal is displayed as | |
1936 extra bright, and any weight less than normal is displayed as | |
1937 half-bright (provided the terminal supports the feature). | |
1938 | |
1939 @item :slant | |
1940 Font slant---one of the symbols @code{italic}, @code{oblique}, @code{normal}, | |
1941 @code{reverse-italic}, or @code{reverse-oblique}. | |
1942 | |
1943 On a text-only terminal, slanted text is displayed as half-bright, if | |
1944 the terminal supports the feature. | |
1945 | |
1946 @item :foreground | |
1947 Foreground color, a string. The value can be a system-defined color | |
1948 name, or a hexadecimal color specification of the form | |
1949 @samp{#@var{rr}@var{gg}@var{bb}}. (@samp{#000000} is black, | |
1950 @samp{#ff0000} is red, @samp{#00ff00} is green, @samp{#0000ff} is | |
1951 blue, and @samp{#ffffff} is white.) | |
1952 | |
1953 @item :background | |
1954 Background color, a string, like the foreground color. | |
1955 | |
1956 @item :inverse-video | |
1957 Whether or not characters should be displayed in inverse video. The | |
1958 value should be @code{t} (yes) or @code{nil} (no). | |
1959 | |
1960 @item :stipple | |
1961 The background stipple, a bitmap. | |
1962 | |
1963 The value can be a string; that should be the name of a file containing | |
1964 external-format X bitmap data. The file is found in the directories | |
1965 listed in the variable @code{x-bitmap-file-path}. | |
1966 | |
1967 Alternatively, the value can specify the bitmap directly, with a list | |
1968 of the form @code{(@var{width} @var{height} @var{data})}. Here, | |
1969 @var{width} and @var{height} specify the size in pixels, and | |
1970 @var{data} is a string containing the raw bits of the bitmap, row by | |
1971 row. Each row occupies @math{(@var{width} + 7) / 8} consecutive bytes | |
1972 in the string (which should be a unibyte string for best results). | |
1973 This means that each row always occupies at least one whole byte. | |
1974 | |
1975 If the value is @code{nil}, that means use no stipple pattern. | |
1976 | |
1977 Normally you do not need to set the stipple attribute, because it is | |
1978 used automatically to handle certain shades of gray. | |
1979 | |
1980 @item :underline | |
1981 Whether or not characters should be underlined, and in what color. If | |
1982 the value is @code{t}, underlining uses the foreground color of the | |
1983 face. If the value is a string, underlining uses that color. The | |
1984 value @code{nil} means do not underline. | |
1985 | |
1986 @item :overline | |
1987 Whether or not characters should be overlined, and in what color. | |
1988 The value is used like that of @code{:underline}. | |
1989 | |
1990 @item :strike-through | |
1991 Whether or not characters should be strike-through, and in what | |
1992 color. The value is used like that of @code{:underline}. | |
1993 | |
1994 @item :inherit | |
1995 The name of a face from which to inherit attributes, or a list of face | |
1996 names. Attributes from inherited faces are merged into the face like an | |
1997 underlying face would be, with higher priority than underlying faces. | |
1998 If a list of faces is used, attributes from faces earlier in the list | |
1999 override those from later faces. | |
2000 | |
2001 @item :box | |
2002 Whether or not a box should be drawn around characters, its color, the | |
2003 width of the box lines, and 3D appearance. | |
2004 @end table | |
2005 | |
2006 Here are the possible values of the @code{:box} attribute, and what | |
2007 they mean: | |
2008 | |
2009 @table @asis | |
2010 @item @code{nil} | |
2011 Don't draw a box. | |
2012 | |
2013 @item @code{t} | |
2014 Draw a box with lines of width 1, in the foreground color. | |
2015 | |
2016 @item @var{color} | |
2017 Draw a box with lines of width 1, in color @var{color}. | |
2018 | |
2019 @item @code{(:line-width @var{width} :color @var{color} :style @var{style})} | |
2020 This way you can explicitly specify all aspects of the box. The value | |
2021 @var{width} specifies the width of the lines to draw; it defaults to 1. | |
2022 | |
2023 The value @var{color} specifies the color to draw with. The default is | |
2024 the foreground color of the face for simple boxes, and the background | |
2025 color of the face for 3D boxes. | |
2026 | |
2027 The value @var{style} specifies whether to draw a 3D box. If it is | |
2028 @code{released-button}, the box looks like a 3D button that is not being | |
2029 pressed. If it is @code{pressed-button}, the box looks like a 3D button | |
2030 that is being pressed. If it is @code{nil} or omitted, a plain 2D box | |
2031 is used. | |
2032 @end table | |
2033 | |
2034 In older versions of Emacs, before @code{:family}, @code{:height}, | |
2035 @code{:width}, @code{:weight}, and @code{:slant} existed, these | |
2036 attributes were used to specify the type face. They are now | |
2037 semi-obsolete, but they still work: | |
2038 | |
2039 @table @code | |
2040 @item :font | |
2041 This attribute specifies the font name. | |
2042 | |
2043 @item :bold | |
2044 A non-@code{nil} value specifies a bold font. | |
2045 | |
2046 @item :italic | |
2047 A non-@code{nil} value specifies an italic font. | |
2048 @end table | |
2049 | |
2050 For compatibility, you can still set these ``attributes,'' even | |
2051 though they are not real face attributes. Here is what that does: | |
2052 | |
2053 @table @code | |
2054 @item :font | |
2055 You can specify an X font name as the ``value'' of this ``attribute''; | |
2056 that sets the @code{:family}, @code{:width}, @code{:height}, | |
2057 @code{:weight}, and @code{:slant} attributes according to the font name. | |
2058 | |
2059 If the value is a pattern with wildcards, the first font that matches | |
2060 the pattern is used to set these attributes. | |
2061 | |
2062 @item :bold | |
2063 A non-@code{nil} makes the face bold; @code{nil} makes it normal. | |
2064 This actually works by setting the @code{:weight} attribute. | |
2065 | |
2066 @item :italic | |
2067 A non-@code{nil} makes the face italic; @code{nil} makes it normal. | |
2068 This actually works by setting the @code{:slant} attribute. | |
2069 @end table | |
2070 | |
2071 @defvar x-bitmap-file-path | |
2072 This variable specifies a list of directories for searching | |
2073 for bitmap files, for the @code{:stipple} attribute. | |
2074 @end defvar | |
2075 | |
2076 @defun bitmap-spec-p object | |
2077 This returns @code{t} if @var{object} is a valid bitmap specification, | |
2078 suitable for use with @code{:stipple} (see above). It returns | |
2079 @code{nil} otherwise. | |
2080 @end defun | |
2081 | |
2082 @node Attribute Functions | |
2083 @subsection Face Attribute Functions | |
2084 | |
2085 This section describes the functions for accessing and modifying the | |
2086 attributes of an existing face. | |
2087 | |
2088 @defun set-face-attribute face frame &rest arguments | |
2089 This function sets one or more attributes of face @var{face} for frame | |
2090 @var{frame}. The attributes you specify this way override whatever | |
2091 the @code{defface} says. | |
2092 | |
2093 The extra arguments @var{arguments} specify the attributes to set, and | |
2094 the values for them. They should consist of alternating attribute names | |
2095 (such as @code{:family} or @code{:underline}) and corresponding values. | |
2096 Thus, | |
2097 | |
2098 @example | |
2099 (set-face-attribute 'foo nil | |
2100 :width 'extended | |
2101 :weight 'bold | |
2102 :underline "red") | |
2103 @end example | |
2104 | |
2105 @noindent | |
2106 sets the attributes @code{:width}, @code{:weight} and @code{:underline} | |
2107 to the corresponding values. | |
2108 | |
2109 If @var{frame} is @code{t}, this function sets the default attributes | |
2110 for new frames. Default attribute values specified this way override | |
2111 the @code{defface} for newly created frames. | |
2112 | |
2113 If @var{frame} is @code{nil}, this function sets the attributes for | |
2114 all existing frames, and the default for new frames. | |
2115 @end defun | |
2116 | |
2117 @defun face-attribute face attribute &optional frame inherit | |
2118 This returns the value of the @var{attribute} attribute of face | |
2119 @var{face} on @var{frame}. If @var{frame} is @code{nil}, | |
2120 that means the selected frame (@pxref{Input Focus}). | |
2121 | |
2122 If @var{frame} is @code{t}, this returns whatever new-frames default | |
2123 value you previously specified with @code{set-face-attribute} for the | |
2124 @var{attribute} attribute of @var{face}. If you have not specified | |
2125 one, it returns @code{nil}. | |
2126 | |
2127 If @var{inherit} is @code{nil}, only attributes directly defined by | |
2128 @var{face} are considered, so the return value may be | |
2129 @code{unspecified}, or a relative value. If @var{inherit} is | |
2130 non-@code{nil}, @var{face}'s definition of @var{attribute} is merged | |
2131 with the faces specified by its @code{:inherit} attribute; however the | |
2132 return value may still be @code{unspecified} or relative. If | |
2133 @var{inherit} is a face or a list of faces, then the result is further | |
2134 merged with that face (or faces), until it becomes specified and | |
2135 absolute. | |
2136 | |
2137 To ensure that the return value is always specified and absolute, use | |
2138 a value of @code{default} for @var{inherit}; this will resolve any | |
2139 unspecified or relative values by merging with the @code{default} face | |
2140 (which is always completely specified). | |
2141 | |
2142 For example, | |
2143 | |
2144 @example | |
2145 (face-attribute 'bold :weight) | |
2146 @result{} bold | |
2147 @end example | |
2148 @end defun | |
2149 | |
2150 @defun face-attribute-relative-p attribute value | |
2151 This function returns non-@code{nil} if @var{value}, when used as the | |
2152 value of the face attribute @var{attribute}, is relative. This means | |
2153 it would modify, rather than completely override, any value that comes | |
2154 from a subsequent face in the face list or that is inherited from | |
2155 another face. | |
2156 | |
2157 @code{unspecified} is a relative value for all attributes. | |
2158 For @code{:height}, floating point values are also relative. | |
2159 | |
2160 For example: | |
2161 | |
2162 @example | |
2163 (face-attribute-relative-p :height 2.0) | |
2164 @result{} t | |
2165 @end example | |
2166 @end defun | |
2167 | |
2168 @defun merge-face-attribute attribute value1 value2 | |
2169 If @var{value1} is a relative value for the face attribute | |
2170 @var{attribute}, returns it merged with the underlying value | |
2171 @var{value2}; otherwise, if @var{value1} is an absolute value for the | |
2172 face attribute @var{attribute}, returns @var{value1} unchanged. | |
2173 @end defun | |
2174 | |
2175 The functions above did not exist before Emacs 21. For compatibility | |
2176 with older Emacs versions, you can use the following functions to set | |
2177 and examine the face attributes which existed in those versions. | |
2178 They use values of @code{t} and @code{nil} for @var{frame} | |
2179 just like @code{set-face-attribute} and @code{face-attribute}. | |
2180 | |
2181 @defun set-face-foreground face color &optional frame | |
2182 @defunx set-face-background face color &optional frame | |
2183 These functions set the foreground (or background, respectively) color | |
2184 of face @var{face} to @var{color}. The argument @var{color} should be a | |
2185 string, the name of a color. | |
2186 | |
2187 Certain shades of gray are implemented by stipple patterns on | |
2188 black-and-white screens. | |
2189 @end defun | |
2190 | |
2191 @defun set-face-stipple face pattern &optional frame | |
2192 This function sets the background stipple pattern of face @var{face} | |
2193 to @var{pattern}. The argument @var{pattern} should be the name of a | |
2194 stipple pattern defined by the X server, or actual bitmap data | |
2195 (@pxref{Face Attributes}), or @code{nil} meaning don't use stipple. | |
2196 | |
2197 Normally there is no need to pay attention to stipple patterns, because | |
2198 they are used automatically to handle certain shades of gray. | |
2199 @end defun | |
2200 | |
2201 @defun set-face-font face font &optional frame | |
2202 This function sets the font of face @var{face}. This actually sets | |
2203 the attributes @code{:family}, @code{:width}, @code{:height}, | |
2204 @code{:weight}, and @code{:slant} according to the font name | |
2205 @var{font}. | |
2206 @end defun | |
2207 | |
2208 @defun set-face-bold-p face bold-p &optional frame | |
2209 This function specifies whether @var{face} should be bold. If | |
2210 @var{bold-p} is non-@code{nil}, that means yes; @code{nil} means no. | |
2211 This actually sets the @code{:weight} attribute. | |
2212 @end defun | |
2213 | |
2214 @defun set-face-italic-p face italic-p &optional frame | |
2215 This function specifies whether @var{face} should be italic. If | |
2216 @var{italic-p} is non-@code{nil}, that means yes; @code{nil} means no. | |
2217 This actually sets the @code{:slant} attribute. | |
2218 @end defun | |
2219 | |
2220 @defun set-face-underline-p face underline &optional frame | |
2221 This function sets the underline attribute of face @var{face}. | |
2222 Non-@code{nil} means do underline; @code{nil} means don't. | |
2223 If @var{underline} is a string, underline with that color. | |
2224 @end defun | |
2225 | |
2226 @defun set-face-inverse-video-p face inverse-video-p &optional frame | |
2227 This function sets the @code{:inverse-video} attribute of face | |
2228 @var{face}. | |
2229 @end defun | |
2230 | |
2231 @defun invert-face face &optional frame | |
2232 This function swaps the foreground and background colors of face | |
2233 @var{face}. | |
2234 @end defun | |
2235 | |
2236 These functions examine the attributes of a face. If you don't | |
2237 specify @var{frame}, they refer to the selected frame; @code{t} refers | |
2238 to the default data for new frames. They return the symbol | |
2239 @code{unspecified} if the face doesn't define any value for that | |
2240 attribute. | |
2241 | |
2242 @defun face-foreground face &optional frame inherit | |
2243 @defunx face-background face &optional frame inherit | |
2244 These functions return the foreground color (or background color, | |
2245 respectively) of face @var{face}, as a string. | |
2246 | |
2247 If @var{inherit} is @code{nil}, only a color directly defined by the face is | |
2248 returned. If @var{inherit} is non-@code{nil}, any faces specified by its | |
2249 @code{:inherit} attribute are considered as well, and if @var{inherit} | |
2250 is a face or a list of faces, then they are also considered, until a | |
2251 specified color is found. To ensure that the return value is always | |
2252 specified, use a value of @code{default} for @var{inherit}. | |
2253 @end defun | |
2254 | |
2255 @defun face-stipple face &optional frame inherit | |
2256 This function returns the name of the background stipple pattern of face | |
2257 @var{face}, or @code{nil} if it doesn't have one. | |
2258 | |
2259 If @var{inherit} is @code{nil}, only a stipple directly defined by the | |
2260 face is returned. If @var{inherit} is non-@code{nil}, any faces | |
2261 specified by its @code{:inherit} attribute are considered as well, and | |
2262 if @var{inherit} is a face or a list of faces, then they are also | |
2263 considered, until a specified stipple is found. To ensure that the | |
2264 return value is always specified, use a value of @code{default} for | |
2265 @var{inherit}. | |
2266 @end defun | |
2267 | |
2268 @defun face-font face &optional frame | |
2269 This function returns the name of the font of face @var{face}. | |
2270 @end defun | |
2271 | |
2272 @defun face-bold-p face &optional frame | |
2273 This function returns @code{t} if @var{face} is bold---that is, if it is | |
2274 bolder than normal. It returns @code{nil} otherwise. | |
2275 @end defun | |
2276 | |
2277 @defun face-italic-p face &optional frame | |
2278 This function returns @code{t} if @var{face} is italic or oblique, | |
2279 @code{nil} otherwise. | |
2280 @end defun | |
2281 | |
2282 @defun face-underline-p face &optional frame | |
2283 This function returns the @code{:underline} attribute of face @var{face}. | |
2284 @end defun | |
2285 | |
2286 @defun face-inverse-video-p face &optional frame | |
2287 This function returns the @code{:inverse-video} attribute of face @var{face}. | |
2288 @end defun | |
2289 | |
2290 @node Displaying Faces | |
2291 @subsection Displaying Faces | |
2292 | |
2293 Here are the ways to specify which faces to use for display of text: | |
2294 | |
2295 @itemize @bullet | |
2296 @item | |
2297 With defaults. The @code{default} face is used as the ultimate | |
2298 default for all text. (In Emacs 19 and 20, the @code{default} | |
2299 face is used only when no other face is specified.) | |
2300 | |
2301 @item | |
2302 For a mode line or header line, the face @code{mode-line} or | |
2303 @code{mode-line-inactive}, or @code{header-line}, is merged in just | |
2304 before @code{default}. | |
2305 | |
2306 @item | |
2307 With text properties. A character can have a @code{face} property; if | |
2308 so, the faces and face attributes specified there apply. @xref{Special | |
2309 Properties}. | |
2310 | |
2311 If the character has a @code{mouse-face} property, that is used instead | |
2312 of the @code{face} property when the mouse is ``near enough'' to the | |
2313 character. | |
2314 | |
2315 @item | |
2316 With overlays. An overlay can have @code{face} and @code{mouse-face} | |
2317 properties too; they apply to all the text covered by the overlay. | |
2318 | |
2319 @item | |
2320 With a region that is active. In Transient Mark mode, the region is | |
2321 highlighted with the face @code{region} (@pxref{Standard Faces,,, | |
2322 emacs, The GNU Emacs Manual}). | |
2323 | |
2324 @item | |
2325 With special glyphs. Each glyph can specify a particular face | |
2326 number. @xref{Glyphs}. | |
2327 @end itemize | |
2328 | |
2329 If these various sources together specify more than one face for a | |
2330 particular character, Emacs merges the attributes of the various faces | |
2331 specified. For each attribute, Emacs tries first the face of any | |
2332 special glyph; then the face for region highlighting, if appropriate; | |
2333 then the faces specified by overlays, followed by those specified by | |
2334 text properties, then the @code{mode-line} or | |
2335 @code{mode-line-inactive} or @code{header-line} face (if in a mode | |
2336 line or a header line), and last the @code{default} face. | |
2337 | |
2338 When multiple overlays cover one character, an overlay with higher | |
2339 priority overrides those with lower priority. @xref{Overlays}. | |
2340 | |
2341 @node Font Selection | |
2342 @subsection Font Selection | |
2343 | |
2344 @dfn{Selecting a font} means mapping the specified face attributes for | |
2345 a character to a font that is available on a particular display. The | |
2346 face attributes, as determined by face merging, specify most of the | |
2347 font choice, but not all. Part of the choice depends on what character | |
2348 it is. | |
2349 | |
2350 If the face specifies a fontset name, that fontset determines a | |
2351 pattern for fonts of the given charset. If the face specifies a font | |
2352 family, a font pattern is constructed. | |
2353 | |
2354 Emacs tries to find an available font for the given face attributes | |
2355 and character's registry and encoding. If there is a font that matches | |
2356 exactly, it is used, of course. The hard case is when no available font | |
2357 exactly fits the specification. Then Emacs looks for one that is | |
2358 ``close''---one attribute at a time. You can specify the order to | |
2359 consider the attributes. In the case where a specified font family is | |
2360 not available, you can specify a set of mappings for alternatives to | |
2361 try. | |
2362 | |
2363 @defvar face-font-selection-order | |
2364 This variable specifies the order of importance of the face attributes | |
2365 @code{:width}, @code{:height}, @code{:weight}, and @code{:slant}. The | |
2366 value should be a list containing those four symbols, in order of | |
2367 decreasing importance. | |
2368 | |
2369 Font selection first finds the best available matches for the first | |
2370 attribute listed; then, among the fonts which are best in that way, it | |
2371 searches for the best matches in the second attribute, and so on. | |
2372 | |
2373 The attributes @code{:weight} and @code{:width} have symbolic values in | |
2374 a range centered around @code{normal}. Matches that are more extreme | |
2375 (farther from @code{normal}) are somewhat preferred to matches that are | |
2376 less extreme (closer to @code{normal}); this is designed to ensure that | |
2377 non-normal faces contrast with normal ones, whenever possible. | |
2378 | |
2379 The default is @code{(:width :height :weight :slant)}, which means first | |
2380 find the fonts closest to the specified @code{:width}, then---among the | |
2381 fonts with that width---find a best match for the specified font height, | |
2382 and so on. | |
2383 | |
2384 One example of a case where this variable makes a difference is when the | |
2385 default font has no italic equivalent. With the default ordering, the | |
2386 @code{italic} face will use a non-italic font that is similar to the | |
2387 default one. But if you put @code{:slant} before @code{:height}, the | |
2388 @code{italic} face will use an italic font, even if its height is not | |
2389 quite right. | |
2390 @end defvar | |
2391 | |
2392 @defvar face-font-family-alternatives | |
2393 This variable lets you specify alternative font families to try, if a | |
2394 given family is specified and doesn't exist. Each element should have | |
2395 this form: | |
2396 | |
2397 @example | |
2398 (@var{family} @var{alternate-families}@dots{}) | |
2399 @end example | |
2400 | |
2401 If @var{family} is specified but not available, Emacs will try the other | |
2402 families given in @var{alternate-families}, one by one, until it finds a | |
2403 family that does exist. | |
2404 @end defvar | |
2405 | |
2406 @defvar face-font-registry-alternatives | |
2407 This variable lets you specify alternative font registries to try, if a | |
2408 given registry is specified and doesn't exist. Each element should have | |
2409 this form: | |
2410 | |
2411 @example | |
2412 (@var{registry} @var{alternate-registries}@dots{}) | |
2413 @end example | |
2414 | |
2415 If @var{registry} is specified but not available, Emacs will try the | |
2416 other registries given in @var{alternate-registries}, one by one, | |
2417 until it finds a registry that does exist. | |
2418 @end defvar | |
2419 | |
2420 Emacs can make use of scalable fonts, but by default it does not use | |
2421 them, since the use of too many or too big scalable fonts can crash | |
2422 XFree86 servers. | |
2423 | |
2424 @defvar scalable-fonts-allowed | |
2425 This variable controls which scalable fonts to use. A value of | |
2426 @code{nil}, the default, means do not use scalable fonts. @code{t} | |
2427 means to use any scalable font that seems appropriate for the text. | |
2428 | |
2429 Otherwise, the value must be a list of regular expressions. Then a | |
2430 scalable font is enabled for use if its name matches any regular | |
2431 expression in the list. For example, | |
2432 | |
2433 @example | |
2434 (setq scalable-fonts-allowed '("muleindian-2$")) | |
2435 @end example | |
2436 | |
2437 @noindent | |
2438 allows the use of scalable fonts with registry @code{muleindian-2}. | |
2439 @end defvar | |
2440 | |
2441 @defvar face-font-rescale-alist | |
2442 This variable specifies scaling for certain faces. Its value should | |
2443 be a list of elements of the form | |
2444 | |
2445 @example | |
2446 (@var{fontname-regexp} . @var{scale-factor}) | |
2447 @end example | |
2448 | |
2449 If @var{fontname-regexp} matches the font name that is about to be | |
2450 used, this says to choose a larger similar font according to the | |
2451 factor @var{scale-factor}. You would use this feature to normalize | |
2452 the font size if certain fonts are bigger or smaller than their | |
2453 nominal heights and widths would suggest. | |
2454 @end defvar | |
2455 | |
2456 @node Face Functions | |
2457 @subsection Functions for Working with Faces | |
2458 | |
2459 Here are additional functions for creating and working with faces. | |
2460 | |
2461 @defun make-face name | |
2462 This function defines a new face named @var{name}, initially with all | |
2463 attributes @code{nil}. It does nothing if there is already a face named | |
2464 @var{name}. | |
2465 @end defun | |
2466 | |
2467 @defun face-list | |
2468 This function returns a list of all defined face names. | |
2469 @end defun | |
2470 | |
2471 @defun copy-face old-face new-name &optional frame new-frame | |
2472 This function defines a face named @var{new-name} as a copy of the existing | |
2473 face named @var{old-face}. It creates the face @var{new-name} if that | |
2474 doesn't already exist. | |
2475 | |
2476 If the optional argument @var{frame} is given, this function applies | |
2477 only to that frame. Otherwise it applies to each frame individually, | |
2478 copying attributes from @var{old-face} in each frame to @var{new-face} | |
2479 in the same frame. | |
2480 | |
2481 If the optional argument @var{new-frame} is given, then @code{copy-face} | |
2482 copies the attributes of @var{old-face} in @var{frame} to @var{new-name} | |
2483 in @var{new-frame}. | |
2484 @end defun | |
2485 | |
2486 @defun face-id face | |
2487 This function returns the face number of face @var{face}. | |
2488 @end defun | |
2489 | |
2490 @defun face-documentation face | |
2491 This function returns the documentation string of face @var{face}, or | |
2492 @code{nil} if none was specified for it. | |
2493 @end defun | |
2494 | |
2495 @defun face-equal face1 face2 &optional frame | |
2496 This returns @code{t} if the faces @var{face1} and @var{face2} have the | |
2497 same attributes for display. | |
2498 @end defun | |
2499 | |
2500 @defun face-differs-from-default-p face &optional frame | |
2501 This returns non-@code{nil} if the face @var{face} displays | |
2502 differently from the default face. | |
2503 @end defun | |
2504 | |
2505 @cindex face alias | |
2506 A @dfn{face alias} provides an equivalent name for a face. You can | |
2507 define a face alias by giving the alias symbol the @code{face-alias} | |
2508 property, with a value of the target face name. The following example | |
2509 makes @code{modeline} an alias for the @code{mode-line} face. | |
2510 | |
2511 @example | |
2512 (put 'modeline 'face-alias 'mode-line) | |
2513 @end example | |
2514 | |
2515 | |
2516 @node Auto Faces | |
2517 @subsection Automatic Face Assignment | |
2518 @cindex automatic face assignment | |
2519 @cindex faces, automatic choice | |
2520 | |
85048
bbb0d5d8d60f
(Auto Faces): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents:
85004
diff
changeset
|
2521 This hook is used for automatically assigning faces to text in the |
84060 | 2522 buffer. It is part of the implementation of Jit-Lock mode, used by |
2523 Font-Lock. | |
2524 | |
2525 @defvar fontification-functions | |
2526 This variable holds a list of functions that are called by Emacs | |
2527 redisplay as needed to assign faces automatically to text in the buffer. | |
2528 | |
2529 The functions are called in the order listed, with one argument, a | |
2530 buffer position @var{pos}. Each function should attempt to assign faces | |
2531 to the text in the current buffer starting at @var{pos}. | |
2532 | |
2533 Each function should record the faces they assign by setting the | |
2534 @code{face} property. It should also add a non-@code{nil} | |
2535 @code{fontified} property for all the text it has assigned faces to. | |
2536 That property tells redisplay that faces have been assigned to that text | |
2537 already. | |
2538 | |
2539 It is probably a good idea for each function to do nothing if the | |
2540 character after @var{pos} already has a non-@code{nil} @code{fontified} | |
2541 property, but this is not required. If one function overrides the | |
2542 assignments made by a previous one, the properties as they are | |
2543 after the last function finishes are the ones that really matter. | |
2544 | |
2545 For efficiency, we recommend writing these functions so that they | |
2546 usually assign faces to around 400 to 600 characters at each call. | |
2547 @end defvar | |
2548 | |
2549 @node Font Lookup | |
2550 @subsection Looking Up Fonts | |
2551 | |
2552 @defun x-list-fonts pattern &optional face frame maximum | |
2553 This function returns a list of available font names that match | |
2554 @var{pattern}. If the optional arguments @var{face} and @var{frame} are | |
2555 specified, then the list is limited to fonts that are the same size as | |
2556 @var{face} currently is on @var{frame}. | |
2557 | |
2558 The argument @var{pattern} should be a string, perhaps with wildcard | |
2559 characters: the @samp{*} character matches any substring, and the | |
2560 @samp{?} character matches any single character. Pattern matching | |
2561 of font names ignores case. | |
2562 | |
2563 If you specify @var{face} and @var{frame}, @var{face} should be a face name | |
2564 (a symbol) and @var{frame} should be a frame. | |
2565 | |
2566 The optional argument @var{maximum} sets a limit on how many fonts to | |
2567 return. If this is non-@code{nil}, then the return value is truncated | |
2568 after the first @var{maximum} matching fonts. Specifying a small value | |
2569 for @var{maximum} can make this function much faster, in cases where | |
2570 many fonts match the pattern. | |
2571 @end defun | |
2572 | |
2573 @defun x-family-fonts &optional family frame | |
2574 This function returns a list describing the available fonts for family | |
2575 @var{family} on @var{frame}. If @var{family} is omitted or @code{nil}, | |
2576 this list applies to all families, and therefore, it contains all | |
2577 available fonts. Otherwise, @var{family} must be a string; it may | |
2578 contain the wildcards @samp{?} and @samp{*}. | |
2579 | |
2580 The list describes the display that @var{frame} is on; if @var{frame} is | |
2581 omitted or @code{nil}, it applies to the selected frame's display | |
2582 (@pxref{Input Focus}). | |
2583 | |
2584 The list contains a vector of the following form for each font: | |
2585 | |
2586 @example | |
2587 [@var{family} @var{width} @var{point-size} @var{weight} @var{slant} | |
2588 @var{fixed-p} @var{full} @var{registry-and-encoding}] | |
2589 @end example | |
2590 | |
2591 The first five elements correspond to face attributes; if you | |
2592 specify these attributes for a face, it will use this font. | |
2593 | |
2594 The last three elements give additional information about the font. | |
2595 @var{fixed-p} is non-@code{nil} if the font is fixed-pitch. | |
2596 @var{full} is the full name of the font, and | |
2597 @var{registry-and-encoding} is a string giving the registry and | |
2598 encoding of the font. | |
2599 | |
2600 The result list is sorted according to the current face font sort order. | |
2601 @end defun | |
2602 | |
2603 @defun x-font-family-list &optional frame | |
2604 This function returns a list of the font families available for | |
2605 @var{frame}'s display. If @var{frame} is omitted or @code{nil}, it | |
2606 describes the selected frame's display (@pxref{Input Focus}). | |
2607 | |
2608 The value is a list of elements of this form: | |
2609 | |
2610 @example | |
2611 (@var{family} . @var{fixed-p}) | |
2612 @end example | |
2613 | |
2614 @noindent | |
2615 Here @var{family} is a font family, and @var{fixed-p} is | |
2616 non-@code{nil} if fonts of that family are fixed-pitch. | |
2617 @end defun | |
2618 | |
2619 @defvar font-list-limit | |
2620 This variable specifies maximum number of fonts to consider in font | |
2621 matching. The function @code{x-family-fonts} will not return more than | |
2622 that many fonts, and font selection will consider only that many fonts | |
2623 when searching a matching font for face attributes. The default is | |
2624 currently 100. | |
2625 @end defvar | |
2626 | |
2627 @node Fontsets | |
2628 @subsection Fontsets | |
2629 | |
2630 A @dfn{fontset} is a list of fonts, each assigned to a range of | |
2631 character codes. An individual font cannot display the whole range of | |
2632 characters that Emacs supports, but a fontset can. Fontsets have names, | |
2633 just as fonts do, and you can use a fontset name in place of a font name | |
2634 when you specify the ``font'' for a frame or a face. Here is | |
2635 information about defining a fontset under Lisp program control. | |
2636 | |
2637 @defun create-fontset-from-fontset-spec fontset-spec &optional style-variant-p noerror | |
2638 This function defines a new fontset according to the specification | |
2639 string @var{fontset-spec}. The string should have this format: | |
2640 | |
2641 @smallexample | |
2642 @var{fontpattern}, @r{[}@var{charsetname}:@var{fontname}@r{]@dots{}} | |
2643 @end smallexample | |
2644 | |
2645 @noindent | |
2646 Whitespace characters before and after the commas are ignored. | |
2647 | |
2648 The first part of the string, @var{fontpattern}, should have the form of | |
2649 a standard X font name, except that the last two fields should be | |
2650 @samp{fontset-@var{alias}}. | |
2651 | |
2652 The new fontset has two names, one long and one short. The long name is | |
2653 @var{fontpattern} in its entirety. The short name is | |
2654 @samp{fontset-@var{alias}}. You can refer to the fontset by either | |
2655 name. If a fontset with the same name already exists, an error is | |
2656 signaled, unless @var{noerror} is non-@code{nil}, in which case this | |
2657 function does nothing. | |
2658 | |
2659 If optional argument @var{style-variant-p} is non-@code{nil}, that says | |
2660 to create bold, italic and bold-italic variants of the fontset as well. | |
2661 These variant fontsets do not have a short name, only a long one, which | |
2662 is made by altering @var{fontpattern} to indicate the bold or italic | |
2663 status. | |
2664 | |
2665 The specification string also says which fonts to use in the fontset. | |
2666 See below for the details. | |
2667 @end defun | |
2668 | |
2669 The construct @samp{@var{charset}:@var{font}} specifies which font to | |
2670 use (in this fontset) for one particular character set. Here, | |
2671 @var{charset} is the name of a character set, and @var{font} is the font | |
2672 to use for that character set. You can use this construct any number of | |
2673 times in the specification string. | |
2674 | |
2675 For the remaining character sets, those that you don't specify | |
2676 explicitly, Emacs chooses a font based on @var{fontpattern}: it replaces | |
2677 @samp{fontset-@var{alias}} with a value that names one character set. | |
2678 For the @acronym{ASCII} character set, @samp{fontset-@var{alias}} is replaced | |
2679 with @samp{ISO8859-1}. | |
2680 | |
2681 In addition, when several consecutive fields are wildcards, Emacs | |
2682 collapses them into a single wildcard. This is to prevent use of | |
2683 auto-scaled fonts. Fonts made by scaling larger fonts are not usable | |
2684 for editing, and scaling a smaller font is not useful because it is | |
2685 better to use the smaller font in its own size, which Emacs does. | |
2686 | |
2687 Thus if @var{fontpattern} is this, | |
2688 | |
2689 @example | |
2690 -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24 | |
2691 @end example | |
2692 | |
2693 @noindent | |
2694 the font specification for @acronym{ASCII} characters would be this: | |
2695 | |
2696 @example | |
2697 -*-fixed-medium-r-normal-*-24-*-ISO8859-1 | |
2698 @end example | |
2699 | |
2700 @noindent | |
2701 and the font specification for Chinese GB2312 characters would be this: | |
2702 | |
2703 @example | |
2704 -*-fixed-medium-r-normal-*-24-*-gb2312*-* | |
2705 @end example | |
2706 | |
2707 You may not have any Chinese font matching the above font | |
2708 specification. Most X distributions include only Chinese fonts that | |
2709 have @samp{song ti} or @samp{fangsong ti} in the @var{family} field. In | |
2710 such a case, @samp{Fontset-@var{n}} can be specified as below: | |
2711 | |
2712 @smallexample | |
2713 Emacs.Fontset-0: -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24,\ | |
2714 chinese-gb2312:-*-*-medium-r-normal-*-24-*-gb2312*-* | |
2715 @end smallexample | |
2716 | |
2717 @noindent | |
2718 Then, the font specifications for all but Chinese GB2312 characters have | |
2719 @samp{fixed} in the @var{family} field, and the font specification for | |
2720 Chinese GB2312 characters has a wild card @samp{*} in the @var{family} | |
2721 field. | |
2722 | |
2723 @defun set-fontset-font name character fontname &optional frame | |
2724 This function modifies the existing fontset @var{name} to | |
2725 use the font name @var{fontname} for the character @var{character}. | |
2726 | |
2727 If @var{name} is @code{nil}, this function modifies the default | |
2728 fontset, whose short name is @samp{fontset-default}. | |
2729 | |
2730 @var{character} may be a cons; @code{(@var{from} . @var{to})}, where | |
2731 @var{from} and @var{to} are non-generic characters. In that case, use | |
2732 @var{fontname} for all characters in the range @var{from} and @var{to} | |
2733 (inclusive). | |
2734 | |
2735 @var{character} may be a charset. In that case, use | |
2736 @var{fontname} for all character in the charsets. | |
2737 | |
2738 @var{fontname} may be a cons; @code{(@var{family} . @var{registry})}, | |
2739 where @var{family} is a family name of a font (possibly including a | |
2740 foundry name at the head), @var{registry} is a registry name of a font | |
2741 (possibly including an encoding name at the tail). | |
2742 | |
2743 For instance, this changes the default fontset to use a font of which | |
2744 registry name is @samp{JISX0208.1983} for all characters belonging to | |
2745 the charset @code{japanese-jisx0208}. | |
2746 | |
2747 @smallexample | |
2748 (set-fontset-font nil 'japanese-jisx0208 '(nil . "JISX0208.1983")) | |
2749 @end smallexample | |
2750 @end defun | |
2751 | |
2752 @defun char-displayable-p char | |
2753 This function returns @code{t} if Emacs ought to be able to display | |
2754 @var{char}. More precisely, if the selected frame's fontset has a | |
2755 font to display the character set that @var{char} belongs to. | |
2756 | |
2757 Fontsets can specify a font on a per-character basis; when the fontset | |
2758 does that, this function's value may not be accurate. | |
2759 @end defun | |
2760 | |
2761 @node Fringes | |
2762 @section Fringes | |
2763 @cindex fringes | |
2764 | |
2765 The @dfn{fringes} of a window are thin vertical strips down the | |
2766 sides that are used for displaying bitmaps that indicate truncation, | |
2767 continuation, horizontal scrolling, and the overlay arrow. | |
2768 | |
2769 @menu | |
2770 * Fringe Size/Pos:: Specifying where to put the window fringes. | |
2771 * Fringe Indicators:: Displaying indicator icons in the window fringes. | |
2772 * Fringe Cursors:: Displaying cursors in the right fringe. | |
2773 * Fringe Bitmaps:: Specifying bitmaps for fringe indicators. | |
2774 * Customizing Bitmaps:: Specifying your own bitmaps to use in the fringes. | |
2775 * Overlay Arrow:: Display of an arrow to indicate position. | |
2776 @end menu | |
2777 | |
2778 @node Fringe Size/Pos | |
2779 @subsection Fringe Size and Position | |
2780 | |
2781 The following buffer-local variables control the position and width | |
2782 of the window fringes. | |
2783 | |
2784 @defvar fringes-outside-margins | |
2785 The fringes normally appear between the display margins and the window | |
2786 text. If the value is non-@code{nil}, they appear outside the display | |
2787 margins. @xref{Display Margins}. | |
2788 @end defvar | |
2789 | |
2790 @defvar left-fringe-width | |
2791 This variable, if non-@code{nil}, specifies the width of the left | |
2792 fringe in pixels. A value of @code{nil} means to use the left fringe | |
2793 width from the window's frame. | |
2794 @end defvar | |
2795 | |
2796 @defvar right-fringe-width | |
2797 This variable, if non-@code{nil}, specifies the width of the right | |
2798 fringe in pixels. A value of @code{nil} means to use the right fringe | |
2799 width from the window's frame. | |
2800 @end defvar | |
2801 | |
2802 The values of these variables take effect when you display the | |
2803 buffer in a window. If you change them while the buffer is visible, | |
2804 you can call @code{set-window-buffer} to display it once again in the | |
2805 same window, to make the changes take effect. | |
2806 | |
2807 @defun set-window-fringes window left &optional right outside-margins | |
2808 This function sets the fringe widths of window @var{window}. | |
2809 If @var{window} is @code{nil}, the selected window is used. | |
2810 | |
2811 The argument @var{left} specifies the width in pixels of the left | |
2812 fringe, and likewise @var{right} for the right fringe. A value of | |
2813 @code{nil} for either one stands for the default width. If | |
2814 @var{outside-margins} is non-@code{nil}, that specifies that fringes | |
2815 should appear outside of the display margins. | |
2816 @end defun | |
2817 | |
2818 @defun window-fringes &optional window | |
2819 This function returns information about the fringes of a window | |
2820 @var{window}. If @var{window} is omitted or @code{nil}, the selected | |
2821 window is used. The value has the form @code{(@var{left-width} | |
2822 @var{right-width} @var{outside-margins})}. | |
2823 @end defun | |
2824 | |
2825 | |
2826 @node Fringe Indicators | |
2827 @subsection Fringe Indicators | |
2828 @cindex fringe indicators | |
2829 @cindex indicators, fringe | |
2830 | |
2831 The @dfn{fringe indicators} are tiny icons Emacs displays in the | |
2832 window fringe (on a graphic display) to indicate truncated or | |
2833 continued lines, buffer boundaries, overlay arrow, etc. | |
2834 | |
2835 @defopt indicate-empty-lines | |
2836 @cindex fringes, and empty line indication | |
2837 When this is non-@code{nil}, Emacs displays a special glyph in the | |
2838 fringe of each empty line at the end of the buffer, on graphical | |
2839 displays. @xref{Fringes}. This variable is automatically | |
2840 buffer-local in every buffer. | |
2841 @end defopt | |
2842 | |
2843 @defvar indicate-buffer-boundaries | |
2844 This buffer-local variable controls how the buffer boundaries and | |
2845 window scrolling are indicated in the window fringes. | |
2846 | |
2847 Emacs can indicate the buffer boundaries---that is, the first and last | |
2848 line in the buffer---with angle icons when they appear on the screen. | |
2849 In addition, Emacs can display an up-arrow in the fringe to show | |
2850 that there is text above the screen, and a down-arrow to show | |
2851 there is text below the screen. | |
2852 | |
2853 There are three kinds of basic values: | |
2854 | |
2855 @table @asis | |
2856 @item @code{nil} | |
2857 Don't display any of these fringe icons. | |
2858 @item @code{left} | |
2859 Display the angle icons and arrows in the left fringe. | |
2860 @item @code{right} | |
2861 Display the angle icons and arrows in the right fringe. | |
2862 @item any non-alist | |
2863 Display the angle icons in the left fringe | |
2864 and don't display the arrows. | |
2865 @end table | |
2866 | |
2867 Otherwise the value should be an alist that specifies which fringe | |
2868 indicators to display and where. Each element of the alist should | |
2869 have the form @code{(@var{indicator} . @var{position})}. Here, | |
2870 @var{indicator} is one of @code{top}, @code{bottom}, @code{up}, | |
2871 @code{down}, and @code{t} (which covers all the icons not yet | |
2872 specified), while @var{position} is one of @code{left}, @code{right} | |
2873 and @code{nil}. | |
2874 | |
2875 For example, @code{((top . left) (t . right))} places the top angle | |
2876 bitmap in left fringe, and the bottom angle bitmap as well as both | |
2877 arrow bitmaps in right fringe. To show the angle bitmaps in the left | |
2878 fringe, and no arrow bitmaps, use @code{((top . left) (bottom . left))}. | |
2879 @end defvar | |
2880 | |
2881 @defvar default-indicate-buffer-boundaries | |
2882 The value of this variable is the default value for | |
2883 @code{indicate-buffer-boundaries} in buffers that do not override it. | |
2884 @end defvar | |
2885 | |
2886 @defvar fringe-indicator-alist | |
2887 This buffer-local variable specifies the mapping from logical fringe | |
2888 indicators to the actual bitmaps displayed in the window fringes. | |
2889 | |
2890 These symbols identify the logical fringe indicators: | |
2891 | |
2892 @table @asis | |
2893 @item Truncation and continuation line indicators: | |
2894 @code{truncation}, @code{continuation}. | |
2895 | |
2896 @item Buffer position indicators: | |
2897 @code{up}, @code{down}, | |
2898 @code{top}, @code{bottom}, | |
2899 @code{top-bottom}. | |
2900 | |
2901 @item Empty line indicator: | |
2902 @code{empty-line}. | |
2903 | |
2904 @item Overlay arrow indicator: | |
2905 @code{overlay-arrow}. | |
2906 | |
2907 @item Unknown bitmap indicator: | |
2908 @code{unknown}. | |
2909 @end table | |
2910 | |
2911 The value is an alist where each element @code{(@var{indicator} . @var{bitmaps})} | |
2912 specifies the fringe bitmaps used to display a specific logical | |
2913 fringe indicator. | |
2914 | |
2915 Here, @var{indicator} specifies the logical indicator type, and | |
2916 @var{bitmaps} is list of symbols @code{(@var{left} @var{right} | |
2917 [@var{left1} @var{right1}])} which specifies the actual bitmap shown | |
2918 in the left or right fringe for the logical indicator. | |
2919 | |
2920 The @var{left} and @var{right} symbols specify the bitmaps shown in | |
2921 the left and/or right fringe for the specific indicator. The | |
2922 @var{left1} or @var{right1} bitmaps are used only for the `bottom' and | |
2923 `top-bottom indicators when the last (only) line in has no final | |
2924 newline. Alternatively, @var{bitmaps} may be a single symbol which is | |
2925 used in both left and right fringes. | |
2926 | |
2927 When @code{fringe-indicator-alist} has a buffer-local value, and there | |
2928 is no bitmap defined for a logical indicator, or the bitmap is | |
2929 @code{t}, the corresponding value from the (non-local) | |
2930 @code{default-fringe-indicator-alist} is used. | |
2931 | |
2932 To completely hide a specific indicator, set the bitmap to @code{nil}. | |
2933 @end defvar | |
2934 | |
2935 @defvar default-fringe-indicator-alist | |
2936 The value of this variable is the default value for | |
2937 @code{fringe-indicator-alist} in buffers that do not override it. | |
2938 @end defvar | |
2939 | |
2940 Standard fringe bitmaps for indicators: | |
2941 @example | |
2942 left-arrow right-arrow up-arrow down-arrow | |
2943 left-curly-arrow right-curly-arrow | |
2944 left-triangle right-triangle | |
2945 top-left-angle top-right-angle | |
2946 bottom-left-angle bottom-right-angle | |
2947 left-bracket right-bracket | |
2948 filled-rectangle hollow-rectangle | |
2949 filled-square hollow-square | |
2950 vertical-bar horizontal-bar | |
2951 empty-line question-mark | |
2952 @end example | |
2953 | |
2954 @node Fringe Cursors | |
2955 @subsection Fringe Cursors | |
2956 @cindex fringe cursors | |
2957 @cindex cursor, fringe | |
2958 | |
2959 When a line is exactly as wide as the window, Emacs displays the | |
2960 cursor in the right fringe instead of using two lines. Different | |
2961 bitmaps are used to represent the cursor in the fringe depending on | |
2962 the current buffer's cursor type. | |
2963 | |
2964 @table @asis | |
2965 @item Logical cursor types: | |
2966 @code{box} , @code{hollow}, @code{bar}, | |
2967 @code{hbar}, @code{hollow-small}. | |
2968 @end table | |
2969 | |
2970 The @code{hollow-small} type is used instead of @code{hollow} when the | |
2971 normal @code{hollow-rectangle} bitmap is too tall to fit on a specific | |
2972 display line. | |
2973 | |
2974 @defvar overflow-newline-into-fringe | |
2975 If this is non-@code{nil}, lines exactly as wide as the window (not | |
2976 counting the final newline character) are not continued. Instead, | |
2977 when point is at the end of the line, the cursor appears in the right | |
2978 fringe. | |
2979 @end defvar | |
2980 | |
2981 @defvar fringe-cursor-alist | |
2982 This variable specifies the mapping from logical cursor type to the | |
2983 actual fringe bitmaps displayed in the right fringe. The value is an | |
2984 alist where each element @code{(@var{cursor} . @var{bitmap})} specifies | |
2985 the fringe bitmaps used to display a specific logical cursor type in | |
2986 the fringe. Here, @var{cursor} specifies the logical cursor type and | |
2987 @var{bitmap} is a symbol specifying the fringe bitmap to be displayed | |
2988 for that logical cursor type. | |
2989 | |
2990 When @code{fringe-cursor-alist} has a buffer-local value, and there is | |
2991 no bitmap defined for a cursor type, the corresponding value from the | |
2992 (non-local) @code{default-fringes-indicator-alist} is used. | |
2993 @end defvar | |
2994 | |
2995 @defvar default-fringes-cursor-alist | |
2996 The value of this variable is the default value for | |
2997 @code{fringe-cursor-alist} in buffers that do not override it. | |
2998 @end defvar | |
2999 | |
3000 Standard bitmaps for displaying the cursor in right fringe: | |
3001 @example | |
3002 filled-rectangle hollow-rectangle filled-square hollow-square | |
3003 vertical-bar horizontal-bar | |
3004 @end example | |
3005 | |
3006 | |
3007 @node Fringe Bitmaps | |
3008 @subsection Fringe Bitmaps | |
3009 @cindex fringe bitmaps | |
3010 @cindex bitmaps, fringe | |
3011 | |
3012 The @dfn{fringe bitmaps} are the actual bitmaps which represent the | |
3013 logical fringe indicators for truncated or continued lines, buffer | |
3014 boundaries, overlay arrow, etc. Fringe bitmap symbols have their own | |
3015 name space. The fringe bitmaps are shared by all frames and windows. | |
3016 You can redefine the built-in fringe bitmaps, and you can define new | |
3017 fringe bitmaps. | |
3018 | |
3019 The way to display a bitmap in the left or right fringes for a given | |
3020 line in a window is by specifying the @code{display} property for one | |
3021 of the characters that appears in it. Use a display specification of | |
3022 the form @code{(left-fringe @var{bitmap} [@var{face}])} or | |
3023 @code{(right-fringe @var{bitmap} [@var{face}])} (@pxref{Display | |
3024 Property}). Here, @var{bitmap} is a symbol identifying the bitmap you | |
3025 want, and @var{face} (which is optional) is the name of the face whose | |
3026 colors should be used for displaying the bitmap, instead of the | |
3027 default @code{fringe} face. @var{face} is automatically merged with | |
3028 the @code{fringe} face, so normally @var{face} need only specify the | |
3029 foreground color for the bitmap. | |
3030 | |
3031 @defun fringe-bitmaps-at-pos &optional pos window | |
3032 This function returns the fringe bitmaps of the display line | |
3033 containing position @var{pos} in window @var{window}. The return | |
3034 value has the form @code{(@var{left} @var{right} @var{ov})}, where @var{left} | |
3035 is the symbol for the fringe bitmap in the left fringe (or @code{nil} | |
3036 if no bitmap), @var{right} is similar for the right fringe, and @var{ov} | |
3037 is non-@code{nil} if there is an overlay arrow in the left fringe. | |
3038 | |
3039 The value is @code{nil} if @var{pos} is not visible in @var{window}. | |
3040 If @var{window} is @code{nil}, that stands for the selected window. | |
3041 If @var{pos} is @code{nil}, that stands for the value of point in | |
3042 @var{window}. | |
3043 @end defun | |
3044 | |
3045 @node Customizing Bitmaps | |
3046 @subsection Customizing Fringe Bitmaps | |
3047 | |
3048 @defun define-fringe-bitmap bitmap bits &optional height width align | |
3049 This function defines the symbol @var{bitmap} as a new fringe bitmap, | |
3050 or replaces an existing bitmap with that name. | |
3051 | |
3052 The argument @var{bits} specifies the image to use. It should be | |
3053 either a string or a vector of integers, where each element (an | |
3054 integer) corresponds to one row of the bitmap. Each bit of an integer | |
3055 corresponds to one pixel of the bitmap, where the low bit corresponds | |
3056 to the rightmost pixel of the bitmap. | |
3057 | |
3058 The height is normally the length of @var{bits}. However, you | |
3059 can specify a different height with non-@code{nil} @var{height}. The width | |
3060 is normally 8, but you can specify a different width with non-@code{nil} | |
3061 @var{width}. The width must be an integer between 1 and 16. | |
3062 | |
3063 The argument @var{align} specifies the positioning of the bitmap | |
3064 relative to the range of rows where it is used; the default is to | |
3065 center the bitmap. The allowed values are @code{top}, @code{center}, | |
3066 or @code{bottom}. | |
3067 | |
3068 The @var{align} argument may also be a list @code{(@var{align} | |
3069 @var{periodic})} where @var{align} is interpreted as described above. | |
3070 If @var{periodic} is non-@code{nil}, it specifies that the rows in | |
3071 @code{bits} should be repeated enough times to reach the specified | |
3072 height. | |
3073 @end defun | |
3074 | |
3075 @defun destroy-fringe-bitmap bitmap | |
3076 This function destroy the fringe bitmap identified by @var{bitmap}. | |
3077 If @var{bitmap} identifies a standard fringe bitmap, it actually | |
3078 restores the standard definition of that bitmap, instead of | |
3079 eliminating it entirely. | |
3080 @end defun | |
3081 | |
3082 @defun set-fringe-bitmap-face bitmap &optional face | |
3083 This sets the face for the fringe bitmap @var{bitmap} to @var{face}. | |
3084 If @var{face} is @code{nil}, it selects the @code{fringe} face. The | |
3085 bitmap's face controls the color to draw it in. | |
3086 | |
3087 @var{face} is merged with the @code{fringe} face, so normally | |
3088 @var{face} should specify only the foreground color. | |
3089 @end defun | |
3090 | |
3091 @node Overlay Arrow | |
3092 @subsection The Overlay Arrow | |
3093 @c @cindex overlay arrow Duplicates variable names | |
3094 | |
3095 The @dfn{overlay arrow} is useful for directing the user's attention | |
3096 to a particular line in a buffer. For example, in the modes used for | |
3097 interface to debuggers, the overlay arrow indicates the line of code | |
3098 about to be executed. This feature has nothing to do with | |
3099 @dfn{overlays} (@pxref{Overlays}). | |
3100 | |
3101 @defvar overlay-arrow-string | |
3102 This variable holds the string to display to call attention to a | |
3103 particular line, or @code{nil} if the arrow feature is not in use. | |
3104 On a graphical display the contents of the string are ignored; instead a | |
3105 glyph is displayed in the fringe area to the left of the display area. | |
3106 @end defvar | |
3107 | |
3108 @defvar overlay-arrow-position | |
3109 This variable holds a marker that indicates where to display the overlay | |
3110 arrow. It should point at the beginning of a line. On a non-graphical | |
3111 display the arrow text | |
3112 appears at the beginning of that line, overlaying any text that would | |
3113 otherwise appear. Since the arrow is usually short, and the line | |
3114 usually begins with indentation, normally nothing significant is | |
3115 overwritten. | |
3116 | |
3117 The overlay-arrow string is displayed in any given buffer if the value | |
3118 of @code{overlay-arrow-position} in that buffer points into that | |
3119 buffer. Thus, it is possible to display multiple overlay arrow strings | |
3120 by creating buffer-local bindings of @code{overlay-arrow-position}. | |
3121 However, it is usually cleaner to use | |
3122 @code{overlay-arrow-variable-list} to achieve this result. | |
3123 @c !!! overlay-arrow-position: but the overlay string may remain in the display | |
3124 @c of some other buffer until an update is required. This should be fixed | |
3125 @c now. Is it? | |
3126 @end defvar | |
3127 | |
3128 You can do a similar job by creating an overlay with a | |
3129 @code{before-string} property. @xref{Overlay Properties}. | |
3130 | |
3131 You can define multiple overlay arrows via the variable | |
3132 @code{overlay-arrow-variable-list}. | |
3133 | |
3134 @defvar overlay-arrow-variable-list | |
3135 This variable's value is a list of variables, each of which specifies | |
3136 the position of an overlay arrow. The variable | |
3137 @code{overlay-arrow-position} has its normal meaning because it is on | |
3138 this list. | |
3139 @end defvar | |
3140 | |
3141 Each variable on this list can have properties | |
3142 @code{overlay-arrow-string} and @code{overlay-arrow-bitmap} that | |
3143 specify an overlay arrow string (for text-only terminals) or fringe | |
3144 bitmap (for graphical terminals) to display at the corresponding | |
3145 overlay arrow position. If either property is not set, the default | |
3146 @code{overlay-arrow-string} or @code{overlay-arrow} fringe indicator | |
3147 is used. | |
3148 | |
3149 @node Scroll Bars | |
3150 @section Scroll Bars | |
3151 @cindex scroll bars | |
3152 | |
3153 Normally the frame parameter @code{vertical-scroll-bars} controls | |
3154 whether the windows in the frame have vertical scroll bars, and | |
3155 whether they are on the left or right. The frame parameter | |
3156 @code{scroll-bar-width} specifies how wide they are (@code{nil} | |
3157 meaning the default). @xref{Layout Parameters}. | |
3158 | |
3159 @defun frame-current-scroll-bars &optional frame | |
3160 This function reports the scroll bar type settings for frame | |
3161 @var{frame}. The value is a cons cell | |
3162 @code{(@var{vertical-type} .@: @var{horizontal-type})}, where | |
3163 @var{vertical-type} is either @code{left}, @code{right}, or @code{nil} | |
3164 (which means no scroll bar.) @var{horizontal-type} is meant to | |
3165 specify the horizontal scroll bar type, but since they are not | |
3166 implemented, it is always @code{nil}. | |
3167 @end defun | |
3168 | |
3169 @vindex vertical-scroll-bar | |
3170 You can enable or disable scroll bars for a particular buffer, | |
3171 by setting the variable @code{vertical-scroll-bar}. This variable | |
3172 automatically becomes buffer-local when set. The possible values are | |
3173 @code{left}, @code{right}, @code{t}, which means to use the | |
3174 frame's default, and @code{nil} for no scroll bar. | |
3175 | |
3176 You can also control this for individual windows. Call the function | |
3177 @code{set-window-scroll-bars} to specify what to do for a specific window: | |
3178 | |
3179 @defun set-window-scroll-bars window width &optional vertical-type horizontal-type | |
3180 This function sets the width and type of scroll bars for window | |
3181 @var{window}. | |
3182 | |
3183 @var{width} specifies the scroll bar width in pixels (@code{nil} means | |
3184 use the width specified for the frame). @var{vertical-type} specifies | |
3185 whether to have a vertical scroll bar and, if so, where. The possible | |
3186 values are @code{left}, @code{right} and @code{nil}, just like the | |
3187 values of the @code{vertical-scroll-bars} frame parameter. | |
3188 | |
3189 The argument @var{horizontal-type} is meant to specify whether and | |
3190 where to have horizontal scroll bars, but since they are not | |
3191 implemented, it has no effect. If @var{window} is @code{nil}, the | |
3192 selected window is used. | |
3193 @end defun | |
3194 | |
3195 @defun window-scroll-bars &optional window | |
3196 Report the width and type of scroll bars specified for @var{window}. | |
3197 If @var{window} is omitted or @code{nil}, the selected window is used. | |
3198 The value is a list of the form @code{(@var{width} | |
3199 @var{cols} @var{vertical-type} @var{horizontal-type})}. The value | |
3200 @var{width} is the value that was specified for the width (which may | |
3201 be @code{nil}); @var{cols} is the number of columns that the scroll | |
3202 bar actually occupies. | |
3203 | |
3204 @var{horizontal-type} is not actually meaningful. | |
3205 @end defun | |
3206 | |
3207 If you don't specify these values for a window with | |
3208 @code{set-window-scroll-bars}, the buffer-local variables | |
3209 @code{scroll-bar-mode} and @code{scroll-bar-width} in the buffer being | |
3210 displayed control the window's vertical scroll bars. The function | |
3211 @code{set-window-buffer} examines these variables. If you change them | |
3212 in a buffer that is already visible in a window, you can make the | |
3213 window take note of the new values by calling @code{set-window-buffer} | |
3214 specifying the same buffer that is already displayed. | |
3215 | |
3216 @defvar scroll-bar-mode | |
3217 This variable, always local in all buffers, controls whether and where | |
3218 to put scroll bars in windows displaying the buffer. The possible values | |
3219 are @code{nil} for no scroll bar, @code{left} to put a scroll bar on | |
3220 the left, and @code{right} to put a scroll bar on the right. | |
3221 @end defvar | |
3222 | |
3223 @defun window-current-scroll-bars &optional window | |
3224 This function reports the scroll bar type for window @var{window}. | |
3225 If @var{window} is omitted or @code{nil}, the selected window is used. | |
3226 The value is a cons cell | |
3227 @code{(@var{vertical-type} .@: @var{horizontal-type})}. Unlike | |
3228 @code{window-scroll-bars}, this reports the scroll bar type actually | |
3229 used, once frame defaults and @code{scroll-bar-mode} are taken into | |
3230 account. | |
3231 @end defun | |
3232 | |
3233 @defvar scroll-bar-width | |
3234 This variable, always local in all buffers, specifies the width of the | |
3235 buffer's scroll bars, measured in pixels. A value of @code{nil} means | |
3236 to use the value specified by the frame. | |
3237 @end defvar | |
3238 | |
3239 @node Display Property | |
3240 @section The @code{display} Property | |
3241 @cindex display specification | |
3242 @kindex display @r{(text property)} | |
3243 | |
3244 The @code{display} text property (or overlay property) is used to | |
3245 insert images into text, and also control other aspects of how text | |
3246 displays. The value of the @code{display} property should be a | |
3247 display specification, or a list or vector containing several display | |
85311 | 3248 specifications. Display specifications in the same @code{display} |
3249 property value generally apply in parallel to the text they cover. | |
3250 | |
3251 If several sources (overlays and/or a text property) specify values | |
3252 for the @code{display} property, only one of the values takes effect, | |
3253 following the rules of @code{get-char-property}. @xref{Examining | |
3254 Properties}. | |
3255 | |
3256 The rest of this section describes several kinds of | |
3257 display specifications and what they mean. | |
3258 | |
3259 @menu | |
3260 * Replacing Specs:: Display specs that replace the text. | |
3261 * Specified Space:: Displaying one space with a specified width. | |
3262 * Pixel Specification:: Specifying space width or height in pixels. | |
3263 * Other Display Specs:: Displaying an image; magnifying text; moving it | |
3264 up or down on the page; adjusting the width | |
3265 of spaces within text. | |
3266 * Display Margins:: Displaying text or images to the side of the main text. | |
3267 @end menu | |
3268 | |
3269 @node Replacing Specs | |
3270 @subsection Display Specs That Replace The Text | |
85114 | 3271 |
3272 Some kinds of @code{display} specifications specify something to | |
85311 | 3273 display instead of the text that has the property. These are called |
3274 @dfn{replacing} display specifications. Emacs does not allow the user | |
3275 to interactively move point into the middle of buffer text that is | |
3276 replaced in this way. | |
3277 | |
3278 If a list of display specifications includes more than one replacing | |
3279 display specification, the first overrides the rest. Replacing | |
3280 display specifications make most other display specifications | |
3281 irrelevant, since those don't apply to the replacement. | |
3282 | |
3283 For replacing display specifications, ``the text that has the | |
3284 property'' means all the consecutive characters that have the same | |
3285 Lisp object as their @code{display} property; these characters are | |
3286 replaced as a single unit. By contrast, characters that have similar | |
3287 but distinct Lisp objects as their @code{display} properties are | |
3288 handled separately. Here's a function that illustrates this point: | |
84060 | 3289 |
3290 @smallexample | |
3291 (defun foo () | |
3292 (goto-char (point-min)) | |
3293 (dotimes (i 5) | |
3294 (let ((string (concat "A"))) | |
3295 (put-text-property (point) (1+ (point)) 'display string) | |
3296 (forward-char 1) | |
3297 (put-text-property (point) (1+ (point)) 'display string) | |
3298 (forward-char 1)))) | |
3299 @end smallexample | |
3300 | |
3301 @noindent | |
3302 It gives each of the first ten characters in the buffer string | |
3303 @code{"A"} as the @code{display} property, but they don't all get the | |
3304 same string. The first two characters get the same string, so they | |
3305 together are replaced with one @samp{A}. The next two characters get | |
3306 a second string, so they together are replaced with one @samp{A}. | |
3307 Likewise for each following pair of characters. Thus, the ten | |
3308 characters appear as five A's. This function would have the same | |
3309 results: | |
3310 | |
3311 @smallexample | |
3312 (defun foo () | |
3313 (goto-char (point-min)) | |
3314 (dotimes (i 5) | |
3315 (let ((string (concat "A"))) | |
85114 | 3316 (put-text-property (point) (+ 2 (point)) 'display string) |
84060 | 3317 (put-text-property (point) (1+ (point)) 'display string) |
3318 (forward-char 2)))) | |
3319 @end smallexample | |
3320 | |
3321 @noindent | |
3322 This illustrates that what matters is the property value for | |
3323 each character. If two consecutive characters have the same | |
3324 object as the @code{display} property value, it's irrelevant | |
3325 whether they got this property from a single call to | |
3326 @code{put-text-property} or from two different calls. | |
3327 | |
3328 @node Specified Space | |
3329 @subsection Specified Spaces | |
3330 @cindex spaces, specified height or width | |
3331 @cindex variable-width spaces | |
3332 | |
3333 To display a space of specified width and/or height, use a display | |
3334 specification of the form @code{(space . @var{props})}, where | |
3335 @var{props} is a property list (a list of alternating properties and | |
3336 values). You can put this property on one or more consecutive | |
3337 characters; a space of the specified height and width is displayed in | |
3338 place of @emph{all} of those characters. These are the properties you | |
3339 can use in @var{props} to specify the weight of the space: | |
3340 | |
3341 @table @code | |
3342 @item :width @var{width} | |
3343 If @var{width} is an integer or floating point number, it specifies | |
3344 that the space width should be @var{width} times the normal character | |
3345 width. @var{width} can also be a @dfn{pixel width} specification | |
3346 (@pxref{Pixel Specification}). | |
3347 | |
3348 @item :relative-width @var{factor} | |
3349 Specifies that the width of the stretch should be computed from the | |
3350 first character in the group of consecutive characters that have the | |
3351 same @code{display} property. The space width is the width of that | |
3352 character, multiplied by @var{factor}. | |
3353 | |
3354 @item :align-to @var{hpos} | |
3355 Specifies that the space should be wide enough to reach @var{hpos}. | |
3356 If @var{hpos} is a number, it is measured in units of the normal | |
3357 character width. @var{hpos} can also be a @dfn{pixel width} | |
3358 specification (@pxref{Pixel Specification}). | |
3359 @end table | |
3360 | |
3361 You should use one and only one of the above properties. You can | |
3362 also specify the height of the space, with these properties: | |
3363 | |
3364 @table @code | |
3365 @item :height @var{height} | |
3366 Specifies the height of the space. | |
3367 If @var{height} is an integer or floating point number, it specifies | |
3368 that the space height should be @var{height} times the normal character | |
3369 height. The @var{height} may also be a @dfn{pixel height} specification | |
3370 (@pxref{Pixel Specification}). | |
3371 | |
3372 @item :relative-height @var{factor} | |
3373 Specifies the height of the space, multiplying the ordinary height | |
3374 of the text having this display specification by @var{factor}. | |
3375 | |
3376 @item :ascent @var{ascent} | |
3377 If the value of @var{ascent} is a non-negative number no greater than | |
3378 100, it specifies that @var{ascent} percent of the height of the space | |
3379 should be considered as the ascent of the space---that is, the part | |
3380 above the baseline. The ascent may also be specified in pixel units | |
3381 with a @dfn{pixel ascent} specification (@pxref{Pixel Specification}). | |
3382 | |
3383 @end table | |
3384 | |
3385 Don't use both @code{:height} and @code{:relative-height} together. | |
3386 | |
3387 The @code{:width} and @code{:align-to} properties are supported on | |
3388 non-graphic terminals, but the other space properties in this section | |
3389 are not. | |
3390 | |
3391 @node Pixel Specification | |
3392 @subsection Pixel Specification for Spaces | |
3393 @cindex spaces, pixel specification | |
3394 | |
3395 The value of the @code{:width}, @code{:align-to}, @code{:height}, | |
3396 and @code{:ascent} properties can be a special kind of expression that | |
3397 is evaluated during redisplay. The result of the evaluation is used | |
3398 as an absolute number of pixels. | |
3399 | |
3400 The following expressions are supported: | |
3401 | |
3402 @smallexample | |
3403 @group | |
3404 @var{expr} ::= @var{num} | (@var{num}) | @var{unit} | @var{elem} | @var{pos} | @var{image} | @var{form} | |
3405 @var{num} ::= @var{integer} | @var{float} | @var{symbol} | |
3406 @var{unit} ::= in | mm | cm | width | height | |
3407 @end group | |
3408 @group | |
3409 @var{elem} ::= left-fringe | right-fringe | left-margin | right-margin | |
3410 | scroll-bar | text | |
3411 @var{pos} ::= left | center | right | |
3412 @var{form} ::= (@var{num} . @var{expr}) | (@var{op} @var{expr} ...) | |
3413 @var{op} ::= + | - | |
3414 @end group | |
3415 @end smallexample | |
3416 | |
3417 The form @var{num} specifies a fraction of the default frame font | |
3418 height or width. The form @code{(@var{num})} specifies an absolute | |
3419 number of pixels. If @var{num} is a symbol, @var{symbol}, its | |
3420 buffer-local variable binding is used. | |
3421 | |
3422 The @code{in}, @code{mm}, and @code{cm} units specify the number of | |
3423 pixels per inch, millimeter, and centimeter, respectively. The | |
3424 @code{width} and @code{height} units correspond to the default width | |
3425 and height of the current face. An image specification @code{image} | |
3426 corresponds to the width or height of the image. | |
3427 | |
3428 The @code{left-fringe}, @code{right-fringe}, @code{left-margin}, | |
3429 @code{right-margin}, @code{scroll-bar}, and @code{text} elements | |
3430 specify to the width of the corresponding area of the window. | |
3431 | |
3432 The @code{left}, @code{center}, and @code{right} positions can be | |
3433 used with @code{:align-to} to specify a position relative to the left | |
3434 edge, center, or right edge of the text area. | |
3435 | |
3436 Any of the above window elements (except @code{text}) can also be | |
3437 used with @code{:align-to} to specify that the position is relative to | |
3438 the left edge of the given area. Once the base offset for a relative | |
3439 position has been set (by the first occurrence of one of these | |
3440 symbols), further occurrences of these symbols are interpreted as the | |
3441 width of the specified area. For example, to align to the center of | |
3442 the left-margin, use | |
3443 | |
3444 @example | |
3445 :align-to (+ left-margin (0.5 . left-margin)) | |
3446 @end example | |
3447 | |
3448 If no specific base offset is set for alignment, it is always relative | |
3449 to the left edge of the text area. For example, @samp{:align-to 0} in a | |
3450 header-line aligns with the first text column in the text area. | |
3451 | |
3452 A value of the form @code{(@var{num} . @var{expr})} stands for the | |
3453 product of the values of @var{num} and @var{expr}. For example, | |
3454 @code{(2 . in)} specifies a width of 2 inches, while @code{(0.5 . | |
3455 @var{image})} specifies half the width (or height) of the specified | |
3456 image. | |
3457 | |
3458 The form @code{(+ @var{expr} ...)} adds up the value of the | |
3459 expressions. The form @code{(- @var{expr} ...)} negates or subtracts | |
3460 the value of the expressions. | |
3461 | |
3462 @node Other Display Specs | |
3463 @subsection Other Display Specifications | |
3464 | |
3465 Here are the other sorts of display specifications that you can use | |
3466 in the @code{display} text property. | |
3467 | |
3468 @table @code | |
3469 @item @var{string} | |
3470 Display @var{string} instead of the text that has this property. | |
3471 | |
3472 Recursive display specifications are not supported---@var{string}'s | |
3473 @code{display} properties, if any, are not used. | |
3474 | |
3475 @item (image . @var{image-props}) | |
3476 This kind of display specification is an image descriptor (@pxref{Images}). | |
3477 When used as a display specification, it means to display the image | |
3478 instead of the text that has the display specification. | |
3479 | |
3480 @item (slice @var{x} @var{y} @var{width} @var{height}) | |
3481 This specification together with @code{image} specifies a @dfn{slice} | |
3482 (a partial area) of the image to display. The elements @var{y} and | |
3483 @var{x} specify the top left corner of the slice, within the image; | |
3484 @var{width} and @var{height} specify the width and height of the | |
3485 slice. Integer values are numbers of pixels. A floating point number | |
3486 in the range 0.0--1.0 stands for that fraction of the width or height | |
3487 of the entire image. | |
3488 | |
3489 @item ((margin nil) @var{string}) | |
3490 A display specification of this form means to display @var{string} | |
3491 instead of the text that has the display specification, at the same | |
3492 position as that text. It is equivalent to using just @var{string}, | |
3493 but it is done as a special case of marginal display (@pxref{Display | |
3494 Margins}). | |
3495 | |
3496 @item (space-width @var{factor}) | |
3497 This display specification affects all the space characters within the | |
3498 text that has the specification. It displays all of these spaces | |
3499 @var{factor} times as wide as normal. The element @var{factor} should | |
3500 be an integer or float. Characters other than spaces are not affected | |
3501 at all; in particular, this has no effect on tab characters. | |
3502 | |
3503 @item (height @var{height}) | |
3504 This display specification makes the text taller or shorter. | |
3505 Here are the possibilities for @var{height}: | |
3506 | |
3507 @table @asis | |
3508 @item @code{(+ @var{n})} | |
3509 This means to use a font that is @var{n} steps larger. A ``step'' is | |
3510 defined by the set of available fonts---specifically, those that match | |
3511 what was otherwise specified for this text, in all attributes except | |
3512 height. Each size for which a suitable font is available counts as | |
3513 another step. @var{n} should be an integer. | |
3514 | |
3515 @item @code{(- @var{n})} | |
3516 This means to use a font that is @var{n} steps smaller. | |
3517 | |
3518 @item a number, @var{factor} | |
3519 A number, @var{factor}, means to use a font that is @var{factor} times | |
3520 as tall as the default font. | |
3521 | |
3522 @item a symbol, @var{function} | |
3523 A symbol is a function to compute the height. It is called with the | |
3524 current height as argument, and should return the new height to use. | |
3525 | |
3526 @item anything else, @var{form} | |
3527 If the @var{height} value doesn't fit the previous possibilities, it is | |
3528 a form. Emacs evaluates it to get the new height, with the symbol | |
3529 @code{height} bound to the current specified font height. | |
3530 @end table | |
3531 | |
3532 @item (raise @var{factor}) | |
3533 This kind of display specification raises or lowers the text | |
3534 it applies to, relative to the baseline of the line. | |
3535 | |
3536 @var{factor} must be a number, which is interpreted as a multiple of the | |
3537 height of the affected text. If it is positive, that means to display | |
3538 the characters raised. If it is negative, that means to display them | |
3539 lower down. | |
3540 | |
3541 If the text also has a @code{height} display specification, that does | |
3542 not affect the amount of raising or lowering, which is based on the | |
3543 faces used for the text. | |
3544 @end table | |
3545 | |
3546 @c We put all the `@code{(when ...)}' on one line to encourage | |
3547 @c makeinfo's end-of-sentence heuristics to DTRT. Previously, the dot | |
3548 @c was at eol; the info file ended up w/ two spaces rendered after it. | |
3549 You can make any display specification conditional. To do that, | |
3550 package it in another list of the form | |
3551 @code{(when @var{condition} . @var{spec})}. | |
3552 Then the specification @var{spec} applies only when | |
3553 @var{condition} evaluates to a non-@code{nil} value. During the | |
3554 evaluation, @code{object} is bound to the string or buffer having the | |
3555 conditional @code{display} property. @code{position} and | |
3556 @code{buffer-position} are bound to the position within @code{object} | |
3557 and the buffer position where the @code{display} property was found, | |
3558 respectively. Both positions can be different when @code{object} is a | |
3559 string. | |
3560 | |
3561 @node Display Margins | |
3562 @subsection Displaying in the Margins | |
3563 @cindex display margins | |
3564 @cindex margins, display | |
3565 | |
85311 | 3566 A buffer can have blank areas called @dfn{display margins} on the |
3567 left and on the right. Ordinary text never appears in these areas, | |
3568 but you can put things into the display margins using the | |
3569 @code{display} property. There is currently no way to make text or | |
3570 images in the margin mouse-sensitive. | |
3571 | |
3572 The way to display something in the margins is to specify it in a | |
3573 margin display specification in the @code{display} property of some | |
3574 text. This is a replacing display specification, meaning that the | |
3575 text you put it on does not get displayed; the margin display appears, | |
3576 but that text does not. | |
3577 | |
3578 A margin display specification looks like @code{((margin | |
3579 right-margin) @var{spec}} or @code{((margin left-margin) @var{spec})}. | |
3580 Here, @var{spec} is another display specification that says what to | |
3581 display in the margin. Typically it is a string of text to display, | |
3582 or an image descriptor. | |
3583 | |
3584 To display something in the margin @emph{in association with} | |
3585 certain buffer text, without altering or preventing the display of | |
3586 that text, put a @code{before-string} property on the text and put the | |
3587 margin display specification on the contents of the before-string. | |
84060 | 3588 |
3589 Before the display margins can display anything, you must give | |
3590 them a nonzero width. The usual way to do that is to set these | |
3591 variables: | |
3592 | |
3593 @defvar left-margin-width | |
3594 This variable specifies the width of the left margin. | |
3595 It is buffer-local in all buffers. | |
3596 @end defvar | |
3597 | |
3598 @defvar right-margin-width | |
3599 This variable specifies the width of the right margin. | |
3600 It is buffer-local in all buffers. | |
3601 @end defvar | |
3602 | |
3603 Setting these variables does not immediately affect the window. These | |
3604 variables are checked when a new buffer is displayed in the window. | |
3605 Thus, you can make changes take effect by calling | |
3606 @code{set-window-buffer}. | |
3607 | |
3608 You can also set the margin widths immediately. | |
3609 | |
3610 @defun set-window-margins window left &optional right | |
3611 This function specifies the margin widths for window @var{window}. | |
3612 The argument @var{left} controls the left margin and | |
3613 @var{right} controls the right margin (default @code{0}). | |
3614 @end defun | |
3615 | |
3616 @defun window-margins &optional window | |
3617 This function returns the left and right margins of @var{window} | |
3618 as a cons cell of the form @code{(@var{left} . @var{right})}. | |
3619 If @var{window} is @code{nil}, the selected window is used. | |
3620 @end defun | |
3621 | |
3622 @node Images | |
3623 @section Images | |
3624 @cindex images in buffers | |
3625 | |
3626 To display an image in an Emacs buffer, you must first create an image | |
3627 descriptor, then use it as a display specifier in the @code{display} | |
3628 property of text that is displayed (@pxref{Display Property}). | |
3629 | |
3630 Emacs is usually able to display images when it is run on a | |
3631 graphical terminal. Images cannot be displayed in a text terminal, on | |
3632 certain graphical terminals that lack the support for this, or if | |
3633 Emacs is compiled without image support. You can use the function | |
3634 @code{display-images-p} to determine if images can in principle be | |
3635 displayed (@pxref{Display Feature Testing}). | |
3636 | |
3637 @menu | |
3638 * Image Formats:: Supported image formats. | |
3639 * Image Descriptors:: How to specify an image for use in @code{:display}. | |
3640 * XBM Images:: Special features for XBM format. | |
3641 * XPM Images:: Special features for XPM format. | |
3642 * GIF Images:: Special features for GIF format. | |
3643 * PostScript Images:: Special features for PostScript format. | |
3644 * Other Image Types:: Various other formats are supported. | |
3645 * Defining Images:: Convenient ways to define an image for later use. | |
3646 * Showing Images:: Convenient ways to display an image once it is defined. | |
3647 * Image Cache:: Internal mechanisms of image display. | |
3648 @end menu | |
3649 | |
3650 @node Image Formats | |
3651 @subsection Image Formats | |
3652 @cindex image formats | |
3653 @cindex image types | |
3654 | |
3655 Emacs can display a number of different image formats; some of them | |
3656 are supported only if particular support libraries are installed on | |
3657 your machine. In some environments, Emacs can load image | |
3658 libraries on demand; if so, the variable @code{image-library-alist} | |
3659 can be used to modify the set of known names for these dynamic | |
3660 libraries (though it is not possible to add new image formats). | |
3661 | |
3662 The supported image formats include XBM, XPM (this requires the | |
3663 libraries @code{libXpm} version 3.4k and @code{libz}), GIF (requiring | |
3664 @code{libungif} 4.1.0), PostScript, PBM, JPEG (requiring the | |
3665 @code{libjpeg} library version v6a), TIFF (requiring @code{libtiff} | |
3666 v3.4), PNG (requiring @code{libpng} 1.0.2), and SVG (requiring | |
3667 @code{librsvg} 2.0.0). | |
3668 | |
3669 You specify one of these formats with an image type symbol. The image | |
3670 type symbols are @code{xbm}, @code{xpm}, @code{gif}, @code{postscript}, | |
3671 @code{pbm}, @code{jpeg}, @code{tiff}, @code{png}, and @code{svg}. | |
3672 | |
3673 @defvar image-types | |
3674 This variable contains a list of those image type symbols that are | |
3675 potentially supported in the current configuration. | |
3676 @emph{Potentially} here means that Emacs knows about the image types, | |
3677 not necessarily that they can be loaded (they could depend on | |
3678 unavailable dynamic libraries, for example). | |
3679 | |
3680 To know which image types are really available, use | |
3681 @code{image-type-available-p}. | |
3682 @end defvar | |
3683 | |
3684 @defvar image-library-alist | |
3685 This in an alist of image types vs external libraries needed to | |
3686 display them. | |
3687 | |
3688 Each element is a list @code{(@var{image-type} @var{library}...)}, | |
3689 where the car is a supported image format from @code{image-types}, and | |
3690 the rest are strings giving alternate filenames for the corresponding | |
3691 external libraries to load. | |
3692 | |
3693 Emacs tries to load the libraries in the order they appear on the | |
3694 list; if none is loaded, the running session of Emacs won't support | |
3695 the image type. @code{pbm} and @code{xbm} don't need to be listed; | |
3696 they're always supported. | |
3697 | |
3698 This variable is ignored if the image libraries are statically linked | |
3699 into Emacs. | |
3700 @end defvar | |
3701 | |
3702 @defun image-type-available-p type | |
3703 This function returns non-@code{nil} if image type @var{type} is | |
3704 available, i.e., if images of this type can be loaded and displayed in | |
3705 Emacs. @var{type} should be one of the types contained in | |
3706 @code{image-types}. | |
3707 | |
3708 For image types whose support libraries are statically linked, this | |
3709 function always returns @code{t}; for other image types, it returns | |
3710 @code{t} if the dynamic library could be loaded, @code{nil} otherwise. | |
3711 @end defun | |
3712 | |
3713 @node Image Descriptors | |
3714 @subsection Image Descriptors | |
3715 @cindex image descriptor | |
3716 | |
3717 An image description is a list of the form @code{(image . @var{props})}, | |
3718 where @var{props} is a property list containing alternating keyword | |
3719 symbols (symbols whose names start with a colon) and their values. | |
3720 You can use any Lisp object as a property, but the only properties | |
3721 that have any special meaning are certain symbols, all of them keywords. | |
3722 | |
3723 Every image descriptor must contain the property @code{:type | |
3724 @var{type}} to specify the format of the image. The value of @var{type} | |
3725 should be an image type symbol; for example, @code{xpm} for an image in | |
3726 XPM format. | |
3727 | |
3728 Here is a list of other properties that are meaningful for all image | |
3729 types: | |
3730 | |
3731 @table @code | |
3732 @item :file @var{file} | |
3733 The @code{:file} property says to load the image from file | |
3734 @var{file}. If @var{file} is not an absolute file name, it is expanded | |
3735 in @code{data-directory}. | |
3736 | |
3737 @item :data @var{data} | |
3738 The @code{:data} property says the actual contents of the image. | |
3739 Each image must use either @code{:data} or @code{:file}, but not both. | |
3740 For most image types, the value of the @code{:data} property should be a | |
3741 string containing the image data; we recommend using a unibyte string. | |
3742 | |
3743 Before using @code{:data}, look for further information in the section | |
3744 below describing the specific image format. For some image types, | |
3745 @code{:data} may not be supported; for some, it allows other data types; | |
3746 for some, @code{:data} alone is not enough, so you need to use other | |
3747 image properties along with @code{:data}. | |
3748 | |
3749 @item :margin @var{margin} | |
3750 The @code{:margin} property specifies how many pixels to add as an | |
3751 extra margin around the image. The value, @var{margin}, must be a | |
3752 non-negative number, or a pair @code{(@var{x} . @var{y})} of such | |
3753 numbers. If it is a pair, @var{x} specifies how many pixels to add | |
3754 horizontally, and @var{y} specifies how many pixels to add vertically. | |
3755 If @code{:margin} is not specified, the default is zero. | |
3756 | |
3757 @item :ascent @var{ascent} | |
3758 The @code{:ascent} property specifies the amount of the image's | |
3759 height to use for its ascent---that is, the part above the baseline. | |
3760 The value, @var{ascent}, must be a number in the range 0 to 100, or | |
3761 the symbol @code{center}. | |
3762 | |
3763 If @var{ascent} is a number, that percentage of the image's height is | |
3764 used for its ascent. | |
3765 | |
3766 If @var{ascent} is @code{center}, the image is vertically centered | |
3767 around a centerline which would be the vertical centerline of text drawn | |
3768 at the position of the image, in the manner specified by the text | |
3769 properties and overlays that apply to the image. | |
3770 | |
3771 If this property is omitted, it defaults to 50. | |
3772 | |
3773 @item :relief @var{relief} | |
3774 The @code{:relief} property, if non-@code{nil}, adds a shadow rectangle | |
3775 around the image. The value, @var{relief}, specifies the width of the | |
3776 shadow lines, in pixels. If @var{relief} is negative, shadows are drawn | |
3777 so that the image appears as a pressed button; otherwise, it appears as | |
3778 an unpressed button. | |
3779 | |
3780 @item :conversion @var{algorithm} | |
3781 The @code{:conversion} property, if non-@code{nil}, specifies a | |
3782 conversion algorithm that should be applied to the image before it is | |
3783 displayed; the value, @var{algorithm}, specifies which algorithm. | |
3784 | |
3785 @table @code | |
3786 @item laplace | |
3787 @itemx emboss | |
3788 Specifies the Laplace edge detection algorithm, which blurs out small | |
3789 differences in color while highlighting larger differences. People | |
3790 sometimes consider this useful for displaying the image for a | |
3791 ``disabled'' button. | |
3792 | |
3793 @item (edge-detection :matrix @var{matrix} :color-adjust @var{adjust}) | |
3794 Specifies a general edge-detection algorithm. @var{matrix} must be | |
3795 either a nine-element list or a nine-element vector of numbers. A pixel | |
3796 at position @math{x/y} in the transformed image is computed from | |
3797 original pixels around that position. @var{matrix} specifies, for each | |
3798 pixel in the neighborhood of @math{x/y}, a factor with which that pixel | |
3799 will influence the transformed pixel; element @math{0} specifies the | |
3800 factor for the pixel at @math{x-1/y-1}, element @math{1} the factor for | |
3801 the pixel at @math{x/y-1} etc., as shown below: | |
3802 @iftex | |
3803 @tex | |
3804 $$\pmatrix{x-1/y-1 & x/y-1 & x+1/y-1 \cr | |
3805 x-1/y & x/y & x+1/y \cr | |
3806 x-1/y+1& x/y+1 & x+1/y+1 \cr}$$ | |
3807 @end tex | |
3808 @end iftex | |
3809 @ifnottex | |
3810 @display | |
3811 (x-1/y-1 x/y-1 x+1/y-1 | |
3812 x-1/y x/y x+1/y | |
3813 x-1/y+1 x/y+1 x+1/y+1) | |
3814 @end display | |
3815 @end ifnottex | |
3816 | |
3817 The resulting pixel is computed from the color intensity of the color | |
3818 resulting from summing up the RGB values of surrounding pixels, | |
3819 multiplied by the specified factors, and dividing that sum by the sum | |
3820 of the factors' absolute values. | |
3821 | |
3822 Laplace edge-detection currently uses a matrix of | |
3823 @iftex | |
3824 @tex | |
3825 $$\pmatrix{1 & 0 & 0 \cr | |
3826 0& 0 & 0 \cr | |
3827 9 & 9 & -1 \cr}$$ | |
3828 @end tex | |
3829 @end iftex | |
3830 @ifnottex | |
3831 @display | |
3832 (1 0 0 | |
3833 0 0 0 | |
3834 9 9 -1) | |
3835 @end display | |
3836 @end ifnottex | |
3837 | |
3838 Emboss edge-detection uses a matrix of | |
3839 @iftex | |
3840 @tex | |
3841 $$\pmatrix{ 2 & -1 & 0 \cr | |
3842 -1 & 0 & 1 \cr | |
3843 0 & 1 & -2 \cr}$$ | |
3844 @end tex | |
3845 @end iftex | |
3846 @ifnottex | |
3847 @display | |
3848 ( 2 -1 0 | |
3849 -1 0 1 | |
3850 0 1 -2) | |
3851 @end display | |
3852 @end ifnottex | |
3853 | |
3854 @item disabled | |
3855 Specifies transforming the image so that it looks ``disabled.'' | |
3856 @end table | |
3857 | |
3858 @item :mask @var{mask} | |
3859 If @var{mask} is @code{heuristic} or @code{(heuristic @var{bg})}, build | |
3860 a clipping mask for the image, so that the background of a frame is | |
3861 visible behind the image. If @var{bg} is not specified, or if @var{bg} | |
3862 is @code{t}, determine the background color of the image by looking at | |
3863 the four corners of the image, assuming the most frequently occurring | |
3864 color from the corners is the background color of the image. Otherwise, | |
3865 @var{bg} must be a list @code{(@var{red} @var{green} @var{blue})} | |
3866 specifying the color to assume for the background of the image. | |
3867 | |
3868 If @var{mask} is @code{nil}, remove a mask from the image, if it has | |
3869 one. Images in some formats include a mask which can be removed by | |
3870 specifying @code{:mask nil}. | |
3871 | |
3872 @item :pointer @var{shape} | |
3873 This specifies the pointer shape when the mouse pointer is over this | |
3874 image. @xref{Pointer Shape}, for available pointer shapes. | |
3875 | |
3876 @item :map @var{map} | |
3877 This associates an image map of @dfn{hot spots} with this image. | |
3878 | |
3879 An image map is an alist where each element has the format | |
3880 @code{(@var{area} @var{id} @var{plist})}. An @var{area} is specified | |
3881 as either a rectangle, a circle, or a polygon. | |
3882 | |
3883 A rectangle is a cons | |
3884 @code{(rect . ((@var{x0} . @var{y0}) . (@var{x1} . @var{y1})))} | |
3885 which specifies the pixel coordinates of the upper left and bottom right | |
3886 corners of the rectangle area. | |
3887 | |
3888 A circle is a cons | |
3889 @code{(circle . ((@var{x0} . @var{y0}) . @var{r}))} | |
3890 which specifies the center and the radius of the circle; @var{r} may | |
3891 be a float or integer. | |
3892 | |
3893 A polygon is a cons | |
3894 @code{(poly . [@var{x0} @var{y0} @var{x1} @var{y1} ...])} | |
3895 where each pair in the vector describes one corner in the polygon. | |
3896 | |
3897 When the mouse pointer lies on a hot-spot area of an image, the | |
3898 @var{plist} of that hot-spot is consulted; if it contains a @code{help-echo} | |
3899 property, that defines a tool-tip for the hot-spot, and if it contains | |
3900 a @code{pointer} property, that defines the shape of the mouse cursor when | |
3901 it is on the hot-spot. | |
3902 @xref{Pointer Shape}, for available pointer shapes. | |
3903 | |
3904 When you click the mouse when the mouse pointer is over a hot-spot, an | |
3905 event is composed by combining the @var{id} of the hot-spot with the | |
3906 mouse event; for instance, @code{[area4 mouse-1]} if the hot-spot's | |
3907 @var{id} is @code{area4}. | |
3908 @end table | |
3909 | |
3910 @defun image-mask-p spec &optional frame | |
3911 This function returns @code{t} if image @var{spec} has a mask bitmap. | |
3912 @var{frame} is the frame on which the image will be displayed. | |
3913 @var{frame} @code{nil} or omitted means to use the selected frame | |
3914 (@pxref{Input Focus}). | |
3915 @end defun | |
3916 | |
3917 @node XBM Images | |
3918 @subsection XBM Images | |
3919 @cindex XBM | |
3920 | |
3921 To use XBM format, specify @code{xbm} as the image type. This image | |
3922 format doesn't require an external library, so images of this type are | |
3923 always supported. | |
3924 | |
3925 Additional image properties supported for the @code{xbm} image type are: | |
3926 | |
3927 @table @code | |
3928 @item :foreground @var{foreground} | |
3929 The value, @var{foreground}, should be a string specifying the image | |
3930 foreground color, or @code{nil} for the default color. This color is | |
3931 used for each pixel in the XBM that is 1. The default is the frame's | |
3932 foreground color. | |
3933 | |
3934 @item :background @var{background} | |
3935 The value, @var{background}, should be a string specifying the image | |
3936 background color, or @code{nil} for the default color. This color is | |
3937 used for each pixel in the XBM that is 0. The default is the frame's | |
3938 background color. | |
3939 @end table | |
3940 | |
3941 If you specify an XBM image using data within Emacs instead of an | |
3942 external file, use the following three properties: | |
3943 | |
3944 @table @code | |
3945 @item :data @var{data} | |
3946 The value, @var{data}, specifies the contents of the image. | |
3947 There are three formats you can use for @var{data}: | |
3948 | |
3949 @itemize @bullet | |
3950 @item | |
3951 A vector of strings or bool-vectors, each specifying one line of the | |
3952 image. Do specify @code{:height} and @code{:width}. | |
3953 | |
3954 @item | |
3955 A string containing the same byte sequence as an XBM file would contain. | |
3956 You must not specify @code{:height} and @code{:width} in this case, | |
3957 because omitting them is what indicates the data has the format of an | |
3958 XBM file. The file contents specify the height and width of the image. | |
3959 | |
3960 @item | |
3961 A string or a bool-vector containing the bits of the image (plus perhaps | |
3962 some extra bits at the end that will not be used). It should contain at | |
3963 least @var{width} * @code{height} bits. In this case, you must specify | |
3964 @code{:height} and @code{:width}, both to indicate that the string | |
3965 contains just the bits rather than a whole XBM file, and to specify the | |
3966 size of the image. | |
3967 @end itemize | |
3968 | |
3969 @item :width @var{width} | |
3970 The value, @var{width}, specifies the width of the image, in pixels. | |
3971 | |
3972 @item :height @var{height} | |
3973 The value, @var{height}, specifies the height of the image, in pixels. | |
3974 @end table | |
3975 | |
3976 @node XPM Images | |
3977 @subsection XPM Images | |
3978 @cindex XPM | |
3979 | |
3980 To use XPM format, specify @code{xpm} as the image type. The | |
3981 additional image property @code{:color-symbols} is also meaningful with | |
3982 the @code{xpm} image type: | |
3983 | |
3984 @table @code | |
3985 @item :color-symbols @var{symbols} | |
3986 The value, @var{symbols}, should be an alist whose elements have the | |
3987 form @code{(@var{name} . @var{color})}. In each element, @var{name} is | |
3988 the name of a color as it appears in the image file, and @var{color} | |
3989 specifies the actual color to use for displaying that name. | |
3990 @end table | |
3991 | |
3992 @node GIF Images | |
3993 @subsection GIF Images | |
3994 @cindex GIF | |
3995 | |
3996 For GIF images, specify image type @code{gif}. | |
3997 | |
3998 @table @code | |
3999 @item :index @var{index} | |
4000 You can use @code{:index} to specify one image from a GIF file that | |
4001 contains more than one image. This property specifies use of image | |
4002 number @var{index} from the file. If the GIF file doesn't contain an | |
4003 image with index @var{index}, the image displays as a hollow box. | |
4004 @end table | |
4005 | |
4006 @ignore | |
4007 This could be used to implement limited support for animated GIFs. | |
4008 For example, the following function displays a multi-image GIF file | |
4009 at point-min in the current buffer, switching between sub-images | |
4010 every 0.1 seconds. | |
4011 | |
4012 (defun show-anim (file max) | |
4013 "Display multi-image GIF file FILE which contains MAX subimages." | |
4014 (display-anim (current-buffer) file 0 max t)) | |
4015 | |
4016 (defun display-anim (buffer file idx max first-time) | |
4017 (when (= idx max) | |
4018 (setq idx 0)) | |
4019 (let ((img (create-image file nil :image idx))) | |
4020 (save-excursion | |
4021 (set-buffer buffer) | |
4022 (goto-char (point-min)) | |
4023 (unless first-time (delete-char 1)) | |
4024 (insert-image img)) | |
4025 (run-with-timer 0.1 nil 'display-anim buffer file (1+ idx) max nil))) | |
4026 @end ignore | |
4027 | |
4028 @node PostScript Images | |
4029 @subsection PostScript Images | |
4030 @cindex postscript images | |
4031 | |
4032 To use PostScript for an image, specify image type @code{postscript}. | |
4033 This works only if you have Ghostscript installed. You must always use | |
4034 these three properties: | |
4035 | |
4036 @table @code | |
4037 @item :pt-width @var{width} | |
4038 The value, @var{width}, specifies the width of the image measured in | |
4039 points (1/72 inch). @var{width} must be an integer. | |
4040 | |
4041 @item :pt-height @var{height} | |
4042 The value, @var{height}, specifies the height of the image in points | |
4043 (1/72 inch). @var{height} must be an integer. | |
4044 | |
4045 @item :bounding-box @var{box} | |
4046 The value, @var{box}, must be a list or vector of four integers, which | |
4047 specifying the bounding box of the PostScript image, analogous to the | |
4048 @samp{BoundingBox} comment found in PostScript files. | |
4049 | |
4050 @example | |
4051 %%BoundingBox: 22 171 567 738 | |
4052 @end example | |
4053 @end table | |
4054 | |
4055 Displaying PostScript images from Lisp data is not currently | |
4056 implemented, but it may be implemented by the time you read this. | |
4057 See the @file{etc/NEWS} file to make sure. | |
4058 | |
4059 @node Other Image Types | |
4060 @subsection Other Image Types | |
4061 @cindex PBM | |
4062 | |
4063 For PBM images, specify image type @code{pbm}. Color, gray-scale and | |
4064 monochromatic images are supported. For mono PBM images, two additional | |
4065 image properties are supported. | |
4066 | |
4067 @table @code | |
4068 @item :foreground @var{foreground} | |
4069 The value, @var{foreground}, should be a string specifying the image | |
4070 foreground color, or @code{nil} for the default color. This color is | |
4071 used for each pixel in the XBM that is 1. The default is the frame's | |
4072 foreground color. | |
4073 | |
4074 @item :background @var{background} | |
4075 The value, @var{background}, should be a string specifying the image | |
4076 background color, or @code{nil} for the default color. This color is | |
4077 used for each pixel in the XBM that is 0. The default is the frame's | |
4078 background color. | |
4079 @end table | |
4080 | |
4081 For JPEG images, specify image type @code{jpeg}. | |
4082 | |
4083 For TIFF images, specify image type @code{tiff}. | |
4084 | |
4085 For PNG images, specify image type @code{png}. | |
4086 | |
4087 For SVG images, specify image type @code{svg}. | |
4088 | |
4089 @node Defining Images | |
4090 @subsection Defining Images | |
4091 | |
4092 The functions @code{create-image}, @code{defimage} and | |
4093 @code{find-image} provide convenient ways to create image descriptors. | |
4094 | |
4095 @defun create-image file-or-data &optional type data-p &rest props | |
4096 This function creates and returns an image descriptor which uses the | |
4097 data in @var{file-or-data}. @var{file-or-data} can be a file name or | |
4098 a string containing the image data; @var{data-p} should be @code{nil} | |
4099 for the former case, non-@code{nil} for the latter case. | |
4100 | |
4101 The optional argument @var{type} is a symbol specifying the image type. | |
4102 If @var{type} is omitted or @code{nil}, @code{create-image} tries to | |
4103 determine the image type from the file's first few bytes, or else | |
4104 from the file's name. | |
4105 | |
4106 The remaining arguments, @var{props}, specify additional image | |
4107 properties---for example, | |
4108 | |
4109 @example | |
4110 (create-image "foo.xpm" 'xpm nil :heuristic-mask t) | |
4111 @end example | |
4112 | |
4113 The function returns @code{nil} if images of this type are not | |
4114 supported. Otherwise it returns an image descriptor. | |
4115 @end defun | |
4116 | |
4117 @defmac defimage symbol specs &optional doc | |
4118 This macro defines @var{symbol} as an image name. The arguments | |
4119 @var{specs} is a list which specifies how to display the image. | |
4120 The third argument, @var{doc}, is an optional documentation string. | |
4121 | |
4122 Each argument in @var{specs} has the form of a property list, and each | |
4123 one should specify at least the @code{:type} property and either the | |
4124 @code{:file} or the @code{:data} property. The value of @code{:type} | |
4125 should be a symbol specifying the image type, the value of | |
4126 @code{:file} is the file to load the image from, and the value of | |
4127 @code{:data} is a string containing the actual image data. Here is an | |
4128 example: | |
4129 | |
4130 @example | |
4131 (defimage test-image | |
4132 ((:type xpm :file "~/test1.xpm") | |
4133 (:type xbm :file "~/test1.xbm"))) | |
4134 @end example | |
4135 | |
4136 @code{defimage} tests each argument, one by one, to see if it is | |
4137 usable---that is, if the type is supported and the file exists. The | |
4138 first usable argument is used to make an image descriptor which is | |
4139 stored in @var{symbol}. | |
4140 | |
4141 If none of the alternatives will work, then @var{symbol} is defined | |
4142 as @code{nil}. | |
4143 @end defmac | |
4144 | |
4145 @defun find-image specs | |
4146 This function provides a convenient way to find an image satisfying one | |
4147 of a list of image specifications @var{specs}. | |
4148 | |
4149 Each specification in @var{specs} is a property list with contents | |
4150 depending on image type. All specifications must at least contain the | |
4151 properties @code{:type @var{type}} and either @w{@code{:file @var{file}}} | |
4152 or @w{@code{:data @var{DATA}}}, where @var{type} is a symbol specifying | |
4153 the image type, e.g.@: @code{xbm}, @var{file} is the file to load the | |
4154 image from, and @var{data} is a string containing the actual image data. | |
4155 The first specification in the list whose @var{type} is supported, and | |
4156 @var{file} exists, is used to construct the image specification to be | |
4157 returned. If no specification is satisfied, @code{nil} is returned. | |
4158 | |
4159 The image is looked for in @code{image-load-path}. | |
4160 @end defun | |
4161 | |
4162 @defvar image-load-path | |
4163 This variable's value is a list of locations in which to search for | |
4164 image files. If an element is a string or a variable symbol whose | |
4165 value is a string, the string is taken to be the name of a directory | |
4166 to search. If an element is a variable symbol whose value is a list, | |
4167 that is taken to be a list of directory names to search. | |
4168 | |
4169 The default is to search in the @file{images} subdirectory of the | |
4170 directory specified by @code{data-directory}, then the directory | |
4171 specified by @code{data-directory}, and finally in the directories in | |
4172 @code{load-path}. Subdirectories are not automatically included in | |
4173 the search, so if you put an image file in a subdirectory, you have to | |
4174 supply the subdirectory name explicitly. For example, to find the | |
4175 image @file{images/foo/bar.xpm} within @code{data-directory}, you | |
4176 should specify the image as follows: | |
4177 | |
4178 @example | |
4179 (defimage foo-image '((:type xpm :file "foo/bar.xpm"))) | |
4180 @end example | |
4181 @end defvar | |
4182 | |
4183 @defun image-load-path-for-library library image &optional path no-error | |
4184 This function returns a suitable search path for images used by the | |
4185 Lisp package @var{library}. | |
4186 | |
4187 The function searches for @var{image} first using @code{image-load-path}, | |
4188 excluding @file{@code{data-directory}/images}, and then in | |
4189 @code{load-path}, followed by a path suitable for @var{library}, which | |
4190 includes @file{../../etc/images} and @file{../etc/images} relative to | |
4191 the library file itself, and finally in | |
4192 @file{@code{data-directory}/images}. | |
4193 | |
4194 Then this function returns a list of directories which contains first | |
4195 the directory in which @var{image} was found, followed by the value of | |
4196 @code{load-path}. If @var{path} is given, it is used instead of | |
4197 @code{load-path}. | |
4198 | |
4199 If @var{no-error} is non-@code{nil} and a suitable path can't be | |
4200 found, don't signal an error. Instead, return a list of directories as | |
4201 before, except that @code{nil} appears in place of the image directory. | |
4202 | |
4203 Here is an example that uses a common idiom to provide compatibility | |
4204 with versions of Emacs that lack the variable @code{image-load-path}: | |
4205 | |
4206 @example | |
4207 (defvar image-load-path) ; shush compiler | |
4208 (let* ((load-path (image-load-path-for-library | |
4209 "mh-e" "mh-logo.xpm")) | |
4210 (image-load-path (cons (car load-path) | |
4211 (when (boundp 'image-load-path) | |
4212 image-load-path)))) | |
4213 (mh-tool-bar-folder-buttons-init)) | |
4214 @end example | |
4215 @end defun | |
4216 | |
4217 @node Showing Images | |
4218 @subsection Showing Images | |
4219 | |
4220 You can use an image descriptor by setting up the @code{display} | |
4221 property yourself, but it is easier to use the functions in this | |
4222 section. | |
4223 | |
4224 @defun insert-image image &optional string area slice | |
4225 This function inserts @var{image} in the current buffer at point. The | |
4226 value @var{image} should be an image descriptor; it could be a value | |
4227 returned by @code{create-image}, or the value of a symbol defined with | |
4228 @code{defimage}. The argument @var{string} specifies the text to put | |
4229 in the buffer to hold the image. If it is omitted or @code{nil}, | |
4230 @code{insert-image} uses @code{" "} by default. | |
4231 | |
4232 The argument @var{area} specifies whether to put the image in a margin. | |
4233 If it is @code{left-margin}, the image appears in the left margin; | |
4234 @code{right-margin} specifies the right margin. If @var{area} is | |
4235 @code{nil} or omitted, the image is displayed at point within the | |
4236 buffer's text. | |
4237 | |
4238 The argument @var{slice} specifies a slice of the image to insert. If | |
4239 @var{slice} is @code{nil} or omitted the whole image is inserted. | |
4240 Otherwise, @var{slice} is a list @code{(@var{x} @var{y} @var{width} | |
4241 @var{height})} which specifies the @var{x} and @var{y} positions and | |
4242 @var{width} and @var{height} of the image area to insert. Integer | |
4243 values are in units of pixels. A floating point number in the range | |
4244 0.0--1.0 stands for that fraction of the width or height of the entire | |
4245 image. | |
4246 | |
4247 Internally, this function inserts @var{string} in the buffer, and gives | |
4248 it a @code{display} property which specifies @var{image}. @xref{Display | |
4249 Property}. | |
4250 @end defun | |
4251 | |
4252 @defun insert-sliced-image image &optional string area rows cols | |
4253 This function inserts @var{image} in the current buffer at point, like | |
4254 @code{insert-image}, but splits the image into @var{rows}x@var{cols} | |
4255 equally sized slices. | |
4256 @end defun | |
4257 | |
4258 @defun put-image image pos &optional string area | |
4259 This function puts image @var{image} in front of @var{pos} in the | |
4260 current buffer. The argument @var{pos} should be an integer or a | |
4261 marker. It specifies the buffer position where the image should appear. | |
4262 The argument @var{string} specifies the text that should hold the image | |
4263 as an alternative to the default. | |
4264 | |
4265 The argument @var{image} must be an image descriptor, perhaps returned | |
4266 by @code{create-image} or stored by @code{defimage}. | |
4267 | |
4268 The argument @var{area} specifies whether to put the image in a margin. | |
4269 If it is @code{left-margin}, the image appears in the left margin; | |
4270 @code{right-margin} specifies the right margin. If @var{area} is | |
4271 @code{nil} or omitted, the image is displayed at point within the | |
4272 buffer's text. | |
4273 | |
4274 Internally, this function creates an overlay, and gives it a | |
4275 @code{before-string} property containing text that has a @code{display} | |
4276 property whose value is the image. (Whew!) | |
4277 @end defun | |
4278 | |
4279 @defun remove-images start end &optional buffer | |
4280 This function removes images in @var{buffer} between positions | |
4281 @var{start} and @var{end}. If @var{buffer} is omitted or @code{nil}, | |
4282 images are removed from the current buffer. | |
4283 | |
4284 This removes only images that were put into @var{buffer} the way | |
4285 @code{put-image} does it, not images that were inserted with | |
4286 @code{insert-image} or in other ways. | |
4287 @end defun | |
4288 | |
4289 @defun image-size spec &optional pixels frame | |
4290 This function returns the size of an image as a pair | |
4291 @w{@code{(@var{width} . @var{height})}}. @var{spec} is an image | |
4292 specification. @var{pixels} non-@code{nil} means return sizes | |
4293 measured in pixels, otherwise return sizes measured in canonical | |
4294 character units (fractions of the width/height of the frame's default | |
4295 font). @var{frame} is the frame on which the image will be displayed. | |
4296 @var{frame} null or omitted means use the selected frame (@pxref{Input | |
4297 Focus}). | |
4298 @end defun | |
4299 | |
4300 @defvar max-image-size | |
4301 This variable is used to define the maximum size of image that Emacs | |
4302 will load. Emacs will refuse to load (and display) any image that is | |
4303 larger than this limit. | |
4304 | |
4305 If the value is an integer, it directly specifies the maximum | |
4306 image height and width, measured in pixels. If it is a floating | |
4307 point number, it specifies the maximum image height and width | |
4308 as a ratio to the frame height and width. If the value is | |
4309 non-numeric, there is no explicit limit on the size of images. | |
4310 | |
4311 The purpose of this variable is to prevent unreasonably large images | |
4312 from accidentally being loaded into Emacs. It only takes effect the | |
4313 first time an image is loaded. Once an image is placed in the image | |
4314 cache, it can always be displayed, even if the value of | |
4315 @var{max-image-size} is subsequently changed (@pxref{Image Cache}). | |
4316 @end defvar | |
4317 | |
4318 @node Image Cache | |
4319 @subsection Image Cache | |
4320 @cindex image cache | |
4321 | |
4322 Emacs stores images in an image cache so that it can display them | |
4323 again more efficiently. When Emacs displays an image, it searches the | |
4324 image cache for an existing image specification @code{equal} to the | |
4325 desired specification. If a match is found, the image is displayed | |
4326 from the cache; otherwise, Emacs loads the image normally. | |
4327 | |
4328 Occasionally, you may need to tell Emacs to refresh the images | |
4329 associated with a given image specification. For example, suppose you | |
4330 display an image using a specification that contains a @code{:file} | |
4331 property. The image is loaded from the given file and stored in the | |
4332 image cache. If you later display the image again, using the same | |
4333 image specification, the image is displayed from the image cache. | |
4334 Normally, this is not a problem. However, if the image file has | |
4335 changed in the meantime, Emacs would be displaying the old version of | |
4336 the image. In such a situation, it is necessary to ``refresh'' the | |
4337 image using @code{image-refresh}. | |
4338 | |
4339 @defun image-refresh spec &optional frame | |
4340 This function refreshes any images having image specifications | |
4341 @code{equal} to @var{spec} on frame @var{frame}. If @var{frame} is | |
4342 @code{nil}, the selected frame is used. If @var{frame} is @code{t}, | |
4343 the refresh is applied to all existing frames. | |
4344 | |
4345 This works by removing all image with image specifications matching | |
4346 @var{spec} from the image cache. Thus, the next time the image is | |
4347 displayed, Emacs will load the image again. | |
4348 @end defun | |
4349 | |
4350 @defun clear-image-cache &optional frame | |
4351 This function clears the entire image cache. If @var{frame} is | |
4352 non-@code{nil}, only the cache for that frame is cleared. Otherwise, | |
4353 all frames' caches are cleared. | |
4354 @end defun | |
4355 | |
4356 If an image in the image cache has not been displayed for a specified | |
4357 period of time, Emacs removes it from the cache and frees the | |
4358 associated memory. | |
4359 | |
4360 @defvar image-cache-eviction-delay | |
4361 This variable specifies the number of seconds an image can remain in the | |
4362 cache without being displayed. When an image is not displayed for this | |
4363 length of time, Emacs removes it from the image cache. | |
4364 | |
4365 If the value is @code{nil}, Emacs does not remove images from the cache | |
4366 except when you explicitly clear it. This mode can be useful for | |
4367 debugging. | |
4368 @end defvar | |
4369 | |
4370 @node Buttons | |
4371 @section Buttons | |
4372 @cindex buttons in buffers | |
4373 @cindex clickable buttons in buffers | |
4374 | |
4375 The @emph{button} package defines functions for inserting and | |
4376 manipulating clickable (with the mouse, or via keyboard commands) | |
4377 buttons in Emacs buffers, such as might be used for help hyper-links, | |
4378 etc. Emacs uses buttons for the hyper-links in help text and the like. | |
4379 | |
4380 A button is essentially a set of properties attached (via text | |
4381 properties or overlays) to a region of text in an Emacs buffer. These | |
4382 properties are called @dfn{button properties}. | |
4383 | |
4384 One of these properties (@code{action}) is a function, which will | |
4385 be called when the user invokes it using the keyboard or the mouse. | |
4386 The invoked function may then examine the button and use its other | |
4387 properties as desired. | |
4388 | |
4389 In some ways the Emacs button package duplicates functionality offered | |
4390 by the widget package (@pxref{Top, , Introduction, widget, The Emacs | |
4391 Widget Library}), but the button package has the advantage that it is | |
4392 much faster, much smaller, and much simpler to use (for elisp | |
4393 programmers---for users, the result is about the same). The extra | |
4394 speed and space savings are useful mainly if you need to create many | |
4395 buttons in a buffer (for instance an @code{*Apropos*} buffer uses | |
4396 buttons to make entries clickable, and may contain many thousands of | |
4397 entries). | |
4398 | |
4399 @menu | |
4400 * Button Properties:: Button properties with special meanings. | |
4401 * Button Types:: Defining common properties for classes of buttons. | |
4402 * Making Buttons:: Adding buttons to Emacs buffers. | |
4403 * Manipulating Buttons:: Getting and setting properties of buttons. | |
4404 * Button Buffer Commands:: Buffer-wide commands and bindings for buttons. | |
4405 @end menu | |
4406 | |
4407 @node Button Properties | |
4408 @subsection Button Properties | |
4409 @cindex button properties | |
4410 | |
4411 Buttons have an associated list of properties defining their | |
4412 appearance and behavior, and other arbitrary properties may be used | |
4413 for application specific purposes. Some properties that have special | |
4414 meaning to the button package include: | |
4415 | |
4416 @table @code | |
4417 @item action | |
4418 @kindex action @r{(button property)} | |
4419 The function to call when the user invokes the button, which is passed | |
4420 the single argument @var{button}. By default this is @code{ignore}, | |
4421 which does nothing. | |
4422 | |
4423 @item mouse-action | |
4424 @kindex mouse-action @r{(button property)} | |
4425 This is similar to @code{action}, and when present, will be used | |
4426 instead of @code{action} for button invocations resulting from | |
4427 mouse-clicks (instead of the user hitting @key{RET}). If not | |
4428 present, mouse-clicks use @code{action} instead. | |
4429 | |
4430 @item face | |
4431 @kindex face @r{(button property)} | |
4432 This is an Emacs face controlling how buttons of this type are | |
4433 displayed; by default this is the @code{button} face. | |
4434 | |
4435 @item mouse-face | |
4436 @kindex mouse-face @r{(button property)} | |
4437 This is an additional face which controls appearance during | |
4438 mouse-overs (merged with the usual button face); by default this is | |
4439 the usual Emacs @code{highlight} face. | |
4440 | |
4441 @item keymap | |
4442 @kindex keymap @r{(button property)} | |
4443 The button's keymap, defining bindings active within the button | |
4444 region. By default this is the usual button region keymap, stored | |
4445 in the variable @code{button-map}, which defines @key{RET} and | |
4446 @key{mouse-2} to invoke the button. | |
4447 | |
4448 @item type | |
4449 @kindex type @r{(button property)} | |
4450 The button-type of the button. When creating a button, this is | |
4451 usually specified using the @code{:type} keyword argument. | |
4452 @xref{Button Types}. | |
4453 | |
4454 @item help-echo | |
4455 @kindex help-index @r{(button property)} | |
4456 A string displayed by the Emacs tool-tip help system; by default, | |
4457 @code{"mouse-2, RET: Push this button"}. | |
4458 | |
4459 @item follow-link | |
4460 @kindex follow-link @r{(button property)} | |
4461 The follow-link property, defining how a @key{Mouse-1} click behaves | |
4462 on this button, @xref{Links and Mouse-1}. | |
4463 | |
4464 @item button | |
4465 @kindex button @r{(button property)} | |
4466 All buttons have a non-@code{nil} @code{button} property, which may be useful | |
4467 in finding regions of text that comprise buttons (which is what the | |
4468 standard button functions do). | |
4469 @end table | |
4470 | |
4471 There are other properties defined for the regions of text in a | |
4472 button, but these are not generally interesting for typical uses. | |
4473 | |
4474 @node Button Types | |
4475 @subsection Button Types | |
4476 @cindex button types | |
4477 | |
4478 Every button has a button @emph{type}, which defines default values | |
4479 for the button's properties. Button types are arranged in a | |
4480 hierarchy, with specialized types inheriting from more general types, | |
4481 so that it's easy to define special-purpose types of buttons for | |
4482 specific tasks. | |
4483 | |
4484 @defun define-button-type name &rest properties | |
4485 Define a `button type' called @var{name}. The remaining arguments | |
4486 form a sequence of @var{property value} pairs, specifying default | |
4487 property values for buttons with this type (a button's type may be set | |
4488 by giving it a @code{type} property when creating the button, using | |
4489 the @code{:type} keyword argument). | |
4490 | |
4491 In addition, the keyword argument @code{:supertype} may be used to | |
4492 specify a button-type from which @var{name} inherits its default | |
4493 property values. Note that this inheritance happens only when | |
4494 @var{name} is defined; subsequent changes to a supertype are not | |
4495 reflected in its subtypes. | |
4496 @end defun | |
4497 | |
4498 Using @code{define-button-type} to define default properties for | |
4499 buttons is not necessary---buttons without any specified type use the | |
4500 built-in button-type @code{button}---but it is encouraged, since | |
4501 doing so usually makes the resulting code clearer and more efficient. | |
4502 | |
4503 @node Making Buttons | |
4504 @subsection Making Buttons | |
4505 @cindex making buttons | |
4506 | |
4507 Buttons are associated with a region of text, using an overlay or | |
4508 text properties to hold button-specific information, all of which are | |
4509 initialized from the button's type (which defaults to the built-in | |
4510 button type @code{button}). Like all Emacs text, the appearance of | |
4511 the button is governed by the @code{face} property; by default (via | |
4512 the @code{face} property inherited from the @code{button} button-type) | |
4513 this is a simple underline, like a typical web-page link. | |
4514 | |
4515 For convenience, there are two sorts of button-creation functions, | |
4516 those that add button properties to an existing region of a buffer, | |
4517 called @code{make-...button}, and those that also insert the button | |
4518 text, called @code{insert-...button}. | |
4519 | |
4520 The button-creation functions all take the @code{&rest} argument | |
4521 @var{properties}, which should be a sequence of @var{property value} | |
4522 pairs, specifying properties to add to the button; see @ref{Button | |
4523 Properties}. In addition, the keyword argument @code{:type} may be | |
4524 used to specify a button-type from which to inherit other properties; | |
4525 see @ref{Button Types}. Any properties not explicitly specified | |
4526 during creation will be inherited from the button's type (if the type | |
4527 defines such a property). | |
4528 | |
4529 The following functions add a button using an overlay | |
4530 (@pxref{Overlays}) to hold the button properties: | |
4531 | |
4532 @defun make-button beg end &rest properties | |
4533 This makes a button from @var{beg} to @var{end} in the | |
4534 current buffer, and returns it. | |
4535 @end defun | |
4536 | |
4537 @defun insert-button label &rest properties | |
4538 This insert a button with the label @var{label} at point, | |
4539 and returns it. | |
4540 @end defun | |
4541 | |
4542 The following functions are similar, but use Emacs text properties | |
4543 (@pxref{Text Properties}) to hold the button properties, making the | |
4544 button actually part of the text instead of being a property of the | |
4545 buffer. Buttons using text properties do not create markers into the | |
4546 buffer, which is important for speed when you use extremely large | |
4547 numbers of buttons. Both functions return the position of the start | |
4548 of the new button: | |
4549 | |
4550 @defun make-text-button beg end &rest properties | |
4551 This makes a button from @var{beg} to @var{end} in the current buffer, using | |
4552 text properties. | |
4553 @end defun | |
4554 | |
4555 @defun insert-text-button label &rest properties | |
4556 This inserts a button with the label @var{label} at point, using text | |
4557 properties. | |
4558 @end defun | |
4559 | |
4560 @node Manipulating Buttons | |
4561 @subsection Manipulating Buttons | |
4562 @cindex manipulating buttons | |
4563 | |
4564 These are functions for getting and setting properties of buttons. | |
4565 Often these are used by a button's invocation function to determine | |
4566 what to do. | |
4567 | |
4568 Where a @var{button} parameter is specified, it means an object | |
4569 referring to a specific button, either an overlay (for overlay | |
4570 buttons), or a buffer-position or marker (for text property buttons). | |
4571 Such an object is passed as the first argument to a button's | |
4572 invocation function when it is invoked. | |
4573 | |
4574 @defun button-start button | |
4575 Return the position at which @var{button} starts. | |
4576 @end defun | |
4577 | |
4578 @defun button-end button | |
4579 Return the position at which @var{button} ends. | |
4580 @end defun | |
4581 | |
4582 @defun button-get button prop | |
4583 Get the property of button @var{button} named @var{prop}. | |
4584 @end defun | |
4585 | |
4586 @defun button-put button prop val | |
4587 Set @var{button}'s @var{prop} property to @var{val}. | |
4588 @end defun | |
4589 | |
4590 @defun button-activate button &optional use-mouse-action | |
4591 Call @var{button}'s @code{action} property (i.e., invoke it). If | |
4592 @var{use-mouse-action} is non-@code{nil}, try to invoke the button's | |
4593 @code{mouse-action} property instead of @code{action}; if the button | |
4594 has no @code{mouse-action} property, use @code{action} as normal. | |
4595 @end defun | |
4596 | |
4597 @defun button-label button | |
4598 Return @var{button}'s text label. | |
4599 @end defun | |
4600 | |
4601 @defun button-type button | |
4602 Return @var{button}'s button-type. | |
4603 @end defun | |
4604 | |
4605 @defun button-has-type-p button type | |
4606 Return @code{t} if @var{button} has button-type @var{type}, or one of | |
4607 @var{type}'s subtypes. | |
4608 @end defun | |
4609 | |
4610 @defun button-at pos | |
4611 Return the button at position @var{pos} in the current buffer, or @code{nil}. | |
4612 @end defun | |
4613 | |
4614 @defun button-type-put type prop val | |
4615 Set the button-type @var{type}'s @var{prop} property to @var{val}. | |
4616 @end defun | |
4617 | |
4618 @defun button-type-get type prop | |
4619 Get the property of button-type @var{type} named @var{prop}. | |
4620 @end defun | |
4621 | |
4622 @defun button-type-subtype-p type supertype | |
4623 Return @code{t} if button-type @var{type} is a subtype of @var{supertype}. | |
4624 @end defun | |
4625 | |
4626 @node Button Buffer Commands | |
4627 @subsection Button Buffer Commands | |
4628 @cindex button buffer commands | |
4629 | |
4630 These are commands and functions for locating and operating on | |
4631 buttons in an Emacs buffer. | |
4632 | |
4633 @code{push-button} is the command that a user uses to actually `push' | |
4634 a button, and is bound by default in the button itself to @key{RET} | |
4635 and to @key{mouse-2} using a region-specific keymap. Commands | |
4636 that are useful outside the buttons itself, such as | |
4637 @code{forward-button} and @code{backward-button} are additionally | |
4638 available in the keymap stored in @code{button-buffer-map}; a mode | |
4639 which uses buttons may want to use @code{button-buffer-map} as a | |
4640 parent keymap for its keymap. | |
4641 | |
4642 If the button has a non-@code{nil} @code{follow-link} property, and | |
4643 @var{mouse-1-click-follows-link} is set, a quick @key{Mouse-1} click | |
4644 will also activate the @code{push-button} command. | |
4645 @xref{Links and Mouse-1}. | |
4646 | |
4647 @deffn Command push-button &optional pos use-mouse-action | |
4648 Perform the action specified by a button at location @var{pos}. | |
4649 @var{pos} may be either a buffer position or a mouse-event. If | |
4650 @var{use-mouse-action} is non-@code{nil}, or @var{pos} is a | |
4651 mouse-event (@pxref{Mouse Events}), try to invoke the button's | |
4652 @code{mouse-action} property instead of @code{action}; if the button | |
4653 has no @code{mouse-action} property, use @code{action} as normal. | |
4654 @var{pos} defaults to point, except when @code{push-button} is invoked | |
4655 interactively as the result of a mouse-event, in which case, the mouse | |
4656 event's position is used. If there's no button at @var{pos}, do | |
4657 nothing and return @code{nil}, otherwise return @code{t}. | |
4658 @end deffn | |
4659 | |
4660 @deffn Command forward-button n &optional wrap display-message | |
4661 Move to the @var{n}th next button, or @var{n}th previous button if | |
4662 @var{n} is negative. If @var{n} is zero, move to the start of any | |
4663 button at point. If @var{wrap} is non-@code{nil}, moving past either | |
4664 end of the buffer continues from the other end. If | |
4665 @var{display-message} is non-@code{nil}, the button's help-echo string | |
4666 is displayed. Any button with a non-@code{nil} @code{skip} property | |
4667 is skipped over. Returns the button found. | |
4668 @end deffn | |
4669 | |
4670 @deffn Command backward-button n &optional wrap display-message | |
4671 Move to the @var{n}th previous button, or @var{n}th next button if | |
4672 @var{n} is negative. If @var{n} is zero, move to the start of any | |
4673 button at point. If @var{wrap} is non-@code{nil}, moving past either | |
4674 end of the buffer continues from the other end. If | |
4675 @var{display-message} is non-@code{nil}, the button's help-echo string | |
4676 is displayed. Any button with a non-@code{nil} @code{skip} property | |
4677 is skipped over. Returns the button found. | |
4678 @end deffn | |
4679 | |
4680 @defun next-button pos &optional count-current | |
4681 @defunx previous-button pos &optional count-current | |
4682 Return the next button after (for @code{next-button} or before (for | |
4683 @code{previous-button}) position @var{pos} in the current buffer. If | |
4684 @var{count-current} is non-@code{nil}, count any button at @var{pos} | |
4685 in the search, instead of starting at the next button. | |
4686 @end defun | |
4687 | |
4688 @node Abstract Display | |
4689 @section Abstract Display | |
4690 @cindex ewoc | |
4691 @cindex display, abstract | |
4692 @cindex display, arbitrary objects | |
4693 @cindex model/view/controller | |
4694 @cindex view part, model/view/controller | |
4695 | |
4696 The Ewoc package constructs buffer text that represents a structure | |
4697 of Lisp objects, and updates the text to follow changes in that | |
4698 structure. This is like the ``view'' component in the | |
4699 ``model/view/controller'' design paradigm. | |
4700 | |
4701 An @dfn{ewoc} is a structure that organizes information required to | |
4702 construct buffer text that represents certain Lisp data. The buffer | |
4703 text of the ewoc has three parts, in order: first, fixed @dfn{header} | |
4704 text; next, textual descriptions of a series of data elements (Lisp | |
4705 objects that you specify); and last, fixed @dfn{footer} text. | |
4706 Specifically, an ewoc contains information on: | |
4707 | |
4708 @itemize @bullet | |
4709 @item | |
4710 The buffer which its text is generated in. | |
4711 | |
4712 @item | |
4713 The text's start position in the buffer. | |
4714 | |
4715 @item | |
4716 The header and footer strings. | |
4717 | |
4718 @item | |
4719 A doubly-linked chain of @dfn{nodes}, each of which contains: | |
4720 | |
4721 @itemize | |
4722 @item | |
4723 A @dfn{data element}, a single Lisp object. | |
4724 | |
4725 @item | |
4726 Links to the preceding and following nodes in the chain. | |
4727 @end itemize | |
4728 | |
4729 @item | |
4730 A @dfn{pretty-printer} function which is responsible for | |
4731 inserting the textual representation of a data | |
4732 element value into the current buffer. | |
4733 @end itemize | |
4734 | |
4735 Typically, you define an ewoc with @code{ewoc-create}, and then pass | |
4736 the resulting ewoc structure to other functions in the Ewoc package to | |
4737 build nodes within it, and display it in the buffer. Once it is | |
4738 displayed in the buffer, other functions determine the correspondance | |
4739 between buffer positions and nodes, move point from one node's textual | |
4740 representation to another, and so forth. @xref{Abstract Display | |
4741 Functions}. | |
4742 | |
4743 A node @dfn{encapsulates} a data element much the way a variable | |
4744 holds a value. Normally, encapsulation occurs as a part of adding a | |
4745 node to the ewoc. You can retrieve the data element value and place a | |
4746 new value in its place, like so: | |
4747 | |
4748 @lisp | |
4749 (ewoc-data @var{node}) | |
4750 @result{} value | |
4751 | |
4752 (ewoc-set-data @var{node} @var{new-value}) | |
4753 @result{} @var{new-value} | |
4754 @end lisp | |
4755 | |
4756 @noindent | |
4757 You can also use, as the data element value, a Lisp object (list or | |
4758 vector) that is a container for the ``real'' value, or an index into | |
4759 some other structure. The example (@pxref{Abstract Display Example}) | |
4760 uses the latter approach. | |
4761 | |
4762 When the data changes, you will want to update the text in the | |
4763 buffer. You can update all nodes by calling @code{ewoc-refresh}, or | |
4764 just specific nodes using @code{ewoc-invalidate}, or all nodes | |
4765 satisfying a predicate using @code{ewoc-map}. Alternatively, you can | |
4766 delete invalid nodes using @code{ewoc-delete} or @code{ewoc-filter}, | |
4767 and add new nodes in their place. Deleting a node from an ewoc deletes | |
4768 its associated textual description from buffer, as well. | |
4769 | |
4770 @menu | |
4771 * Abstract Display Functions:: | |
4772 * Abstract Display Example:: | |
4773 @end menu | |
4774 | |
4775 @node Abstract Display Functions | |
4776 @subsection Abstract Display Functions | |
4777 | |
4778 In this subsection, @var{ewoc} and @var{node} stand for the | |
4779 structures described above (@pxref{Abstract Display}), while | |
4780 @var{data} stands for an arbitrary Lisp object used as a data element. | |
4781 | |
4782 @defun ewoc-create pretty-printer &optional header footer nosep | |
4783 This constructs and returns a new ewoc, with no nodes (and thus no data | |
4784 elements). @var{pretty-printer} should be a function that takes one | |
4785 argument, a data element of the sort you plan to use in this ewoc, and | |
4786 inserts its textual description at point using @code{insert} (and never | |
4787 @code{insert-before-markers}, because that would interfere with the | |
4788 Ewoc package's internal mechanisms). | |
4789 | |
4790 Normally, a newline is automatically inserted after the header, | |
4791 the footer and every node's textual description. If @var{nosep} | |
4792 is non-@code{nil}, no newline is inserted. This may be useful for | |
4793 displaying an entire ewoc on a single line, for example, or for | |
4794 making nodes ``invisible'' by arranging for @var{pretty-printer} | |
4795 to do nothing for those nodes. | |
4796 | |
4797 An ewoc maintains its text in the buffer that is current when | |
4798 you create it, so switch to the intended buffer before calling | |
4799 @code{ewoc-create}. | |
4800 @end defun | |
4801 | |
4802 @defun ewoc-buffer ewoc | |
4803 This returns the buffer where @var{ewoc} maintains its text. | |
4804 @end defun | |
4805 | |
4806 @defun ewoc-get-hf ewoc | |
4807 This returns a cons cell @code{(@var{header} . @var{footer})} | |
4808 made from @var{ewoc}'s header and footer. | |
4809 @end defun | |
4810 | |
4811 @defun ewoc-set-hf ewoc header footer | |
4812 This sets the header and footer of @var{ewoc} to the strings | |
4813 @var{header} and @var{footer}, respectively. | |
4814 @end defun | |
4815 | |
4816 @defun ewoc-enter-first ewoc data | |
4817 @defunx ewoc-enter-last ewoc data | |
4818 These add a new node encapsulating @var{data}, putting it, respectively, | |
4819 at the beginning or end of @var{ewoc}'s chain of nodes. | |
4820 @end defun | |
4821 | |
4822 @defun ewoc-enter-before ewoc node data | |
4823 @defunx ewoc-enter-after ewoc node data | |
4824 These add a new node encapsulating @var{data}, adding it to | |
4825 @var{ewoc} before or after @var{node}, respectively. | |
4826 @end defun | |
4827 | |
4828 @defun ewoc-prev ewoc node | |
4829 @defunx ewoc-next ewoc node | |
4830 These return, respectively, the previous node and the next node of @var{node} | |
4831 in @var{ewoc}. | |
4832 @end defun | |
4833 | |
4834 @defun ewoc-nth ewoc n | |
4835 This returns the node in @var{ewoc} found at zero-based index @var{n}. | |
4836 A negative @var{n} means count from the end. @code{ewoc-nth} returns | |
4837 @code{nil} if @var{n} is out of range. | |
4838 @end defun | |
4839 | |
4840 @defun ewoc-data node | |
4841 This extracts the data encapsulated by @var{node} and returns it. | |
4842 @end defun | |
4843 | |
4844 @defun ewoc-set-data node data | |
4845 This sets the data encapsulated by @var{node} to @var{data}. | |
4846 @end defun | |
4847 | |
4848 @defun ewoc-locate ewoc &optional pos guess | |
4849 This determines the node in @var{ewoc} which contains point (or | |
4850 @var{pos} if specified), and returns that node. If @var{ewoc} has no | |
4851 nodes, it returns @code{nil}. If @var{pos} is before the first node, | |
4852 it returns the first node; if @var{pos} is after the last node, it returns | |
4853 the last node. The optional third arg @var{guess} | |
4854 should be a node that is likely to be near @var{pos}; this doesn't | |
4855 alter the result, but makes the function run faster. | |
4856 @end defun | |
4857 | |
4858 @defun ewoc-location node | |
4859 This returns the start position of @var{node}. | |
4860 @end defun | |
4861 | |
4862 @defun ewoc-goto-prev ewoc arg | |
4863 @defunx ewoc-goto-next ewoc arg | |
4864 These move point to the previous or next, respectively, @var{arg}th node | |
4865 in @var{ewoc}. @code{ewoc-goto-prev} does not move if it is already at | |
4866 the first node or if @var{ewoc} is empty, whereas @code{ewoc-goto-next} | |
4867 moves past the last node, returning @code{nil}. Excepting this special | |
4868 case, these functions return the node moved to. | |
4869 @end defun | |
4870 | |
4871 @defun ewoc-goto-node ewoc node | |
4872 This moves point to the start of @var{node} in @var{ewoc}. | |
4873 @end defun | |
4874 | |
4875 @defun ewoc-refresh ewoc | |
4876 This function regenerates the text of @var{ewoc}. It works by | |
4877 deleting the text between the header and the footer, i.e., all the | |
4878 data elements' representations, and then calling the pretty-printer | |
4879 function for each node, one by one, in order. | |
4880 @end defun | |
4881 | |
4882 @defun ewoc-invalidate ewoc &rest nodes | |
4883 This is similar to @code{ewoc-refresh}, except that only @var{nodes} in | |
4884 @var{ewoc} are updated instead of the entire set. | |
4885 @end defun | |
4886 | |
4887 @defun ewoc-delete ewoc &rest nodes | |
4888 This deletes each node in @var{nodes} from @var{ewoc}. | |
4889 @end defun | |
4890 | |
4891 @defun ewoc-filter ewoc predicate &rest args | |
4892 This calls @var{predicate} for each data element in @var{ewoc} and | |
4893 deletes those nodes for which @var{predicate} returns @code{nil}. | |
4894 Any @var{args} are passed to @var{predicate}. | |
4895 @end defun | |
4896 | |
4897 @defun ewoc-collect ewoc predicate &rest args | |
4898 This calls @var{predicate} for each data element in @var{ewoc} | |
4899 and returns a list of those elements for which @var{predicate} | |
4900 returns non-@code{nil}. The elements in the list are ordered | |
4901 as in the buffer. Any @var{args} are passed to @var{predicate}. | |
4902 @end defun | |
4903 | |
4904 @defun ewoc-map map-function ewoc &rest args | |
4905 This calls @var{map-function} for each data element in @var{ewoc} and | |
4906 updates those nodes for which @var{map-function} returns non-@code{nil}. | |
4907 Any @var{args} are passed to @var{map-function}. | |
4908 @end defun | |
4909 | |
4910 @node Abstract Display Example | |
4911 @subsection Abstract Display Example | |
4912 | |
4913 Here is a simple example using functions of the ewoc package to | |
4914 implement a ``color components display,'' an area in a buffer that | |
4915 represents a vector of three integers (itself representing a 24-bit RGB | |
4916 value) in various ways. | |
4917 | |
4918 @example | |
4919 (setq colorcomp-ewoc nil | |
4920 colorcomp-data nil | |
4921 colorcomp-mode-map nil | |
4922 colorcomp-labels ["Red" "Green" "Blue"]) | |
4923 | |
4924 (defun colorcomp-pp (data) | |
4925 (if data | |
4926 (let ((comp (aref colorcomp-data data))) | |
4927 (insert (aref colorcomp-labels data) "\t: #x" | |
4928 (format "%02X" comp) " " | |
4929 (make-string (ash comp -2) ?#) "\n")) | |
4930 (let ((cstr (format "#%02X%02X%02X" | |
4931 (aref colorcomp-data 0) | |
4932 (aref colorcomp-data 1) | |
4933 (aref colorcomp-data 2))) | |
4934 (samp " (sample text) ")) | |
4935 (insert "Color\t: " | |
4936 (propertize samp 'face `(foreground-color . ,cstr)) | |
4937 (propertize samp 'face `(background-color . ,cstr)) | |
4938 "\n")))) | |
4939 | |
4940 (defun colorcomp (color) | |
4941 "Allow fiddling with COLOR in a new buffer. | |
4942 The buffer is in Color Components mode." | |
4943 (interactive "sColor (name or #RGB or #RRGGBB): ") | |
4944 (when (string= "" color) | |
4945 (setq color "green")) | |
4946 (unless (color-values color) | |
4947 (error "No such color: %S" color)) | |
4948 (switch-to-buffer | |
4949 (generate-new-buffer (format "originally: %s" color))) | |
4950 (kill-all-local-variables) | |
4951 (setq major-mode 'colorcomp-mode | |
4952 mode-name "Color Components") | |
4953 (use-local-map colorcomp-mode-map) | |
4954 (erase-buffer) | |
4955 (buffer-disable-undo) | |
4956 (let ((data (apply 'vector (mapcar (lambda (n) (ash n -8)) | |
4957 (color-values color)))) | |
4958 (ewoc (ewoc-create 'colorcomp-pp | |
4959 "\nColor Components\n\n" | |
4960 (substitute-command-keys | |
4961 "\n\\@{colorcomp-mode-map@}")))) | |
4962 (set (make-local-variable 'colorcomp-data) data) | |
4963 (set (make-local-variable 'colorcomp-ewoc) ewoc) | |
4964 (ewoc-enter-last ewoc 0) | |
4965 (ewoc-enter-last ewoc 1) | |
4966 (ewoc-enter-last ewoc 2) | |
4967 (ewoc-enter-last ewoc nil))) | |
4968 @end example | |
4969 | |
4970 @cindex controller part, model/view/controller | |
4971 This example can be extended to be a ``color selection widget'' (in | |
4972 other words, the controller part of the ``model/view/controller'' | |
4973 design paradigm) by defining commands to modify @code{colorcomp-data} | |
4974 and to ``finish'' the selection process, and a keymap to tie it all | |
4975 together conveniently. | |
4976 | |
4977 @smallexample | |
4978 (defun colorcomp-mod (index limit delta) | |
4979 (let ((cur (aref colorcomp-data index))) | |
4980 (unless (= limit cur) | |
4981 (aset colorcomp-data index (+ cur delta))) | |
4982 (ewoc-invalidate | |
4983 colorcomp-ewoc | |
4984 (ewoc-nth colorcomp-ewoc index) | |
4985 (ewoc-nth colorcomp-ewoc -1)))) | |
4986 | |
4987 (defun colorcomp-R-more () (interactive) (colorcomp-mod 0 255 1)) | |
4988 (defun colorcomp-G-more () (interactive) (colorcomp-mod 1 255 1)) | |
4989 (defun colorcomp-B-more () (interactive) (colorcomp-mod 2 255 1)) | |
4990 (defun colorcomp-R-less () (interactive) (colorcomp-mod 0 0 -1)) | |
4991 (defun colorcomp-G-less () (interactive) (colorcomp-mod 1 0 -1)) | |
4992 (defun colorcomp-B-less () (interactive) (colorcomp-mod 2 0 -1)) | |
4993 | |
4994 (defun colorcomp-copy-as-kill-and-exit () | |
4995 "Copy the color components into the kill ring and kill the buffer. | |
4996 The string is formatted #RRGGBB (hash followed by six hex digits)." | |
4997 (interactive) | |
4998 (kill-new (format "#%02X%02X%02X" | |
4999 (aref colorcomp-data 0) | |
5000 (aref colorcomp-data 1) | |
5001 (aref colorcomp-data 2))) | |
5002 (kill-buffer nil)) | |
5003 | |
5004 (setq colorcomp-mode-map | |
5005 (let ((m (make-sparse-keymap))) | |
5006 (suppress-keymap m) | |
5007 (define-key m "i" 'colorcomp-R-less) | |
5008 (define-key m "o" 'colorcomp-R-more) | |
5009 (define-key m "k" 'colorcomp-G-less) | |
5010 (define-key m "l" 'colorcomp-G-more) | |
5011 (define-key m "," 'colorcomp-B-less) | |
5012 (define-key m "." 'colorcomp-B-more) | |
5013 (define-key m " " 'colorcomp-copy-as-kill-and-exit) | |
5014 m)) | |
5015 @end smallexample | |
5016 | |
5017 Note that we never modify the data in each node, which is fixed when the | |
5018 ewoc is created to be either @code{nil} or an index into the vector | |
5019 @code{colorcomp-data}, the actual color components. | |
5020 | |
5021 @node Blinking | |
5022 @section Blinking Parentheses | |
5023 @cindex parenthesis matching | |
5024 @cindex blinking parentheses | |
5025 @cindex balancing parentheses | |
5026 | |
5027 This section describes the mechanism by which Emacs shows a matching | |
5028 open parenthesis when the user inserts a close parenthesis. | |
5029 | |
5030 @defvar blink-paren-function | |
5031 The value of this variable should be a function (of no arguments) to | |
5032 be called whenever a character with close parenthesis syntax is inserted. | |
5033 The value of @code{blink-paren-function} may be @code{nil}, in which | |
5034 case nothing is done. | |
5035 @end defvar | |
5036 | |
5037 @defopt blink-matching-paren | |
5038 If this variable is @code{nil}, then @code{blink-matching-open} does | |
5039 nothing. | |
5040 @end defopt | |
5041 | |
5042 @defopt blink-matching-paren-distance | |
5043 This variable specifies the maximum distance to scan for a matching | |
5044 parenthesis before giving up. | |
5045 @end defopt | |
5046 | |
5047 @defopt blink-matching-delay | |
5048 This variable specifies the number of seconds for the cursor to remain | |
5049 at the matching parenthesis. A fraction of a second often gives | |
5050 good results, but the default is 1, which works on all systems. | |
5051 @end defopt | |
5052 | |
5053 @deffn Command blink-matching-open | |
5054 This function is the default value of @code{blink-paren-function}. It | |
5055 assumes that point follows a character with close parenthesis syntax and | |
5056 moves the cursor momentarily to the matching opening character. If that | |
5057 character is not already on the screen, it displays the character's | |
5058 context in the echo area. To avoid long delays, this function does not | |
5059 search farther than @code{blink-matching-paren-distance} characters. | |
5060 | |
5061 Here is an example of calling this function explicitly. | |
5062 | |
5063 @smallexample | |
5064 @group | |
5065 (defun interactive-blink-matching-open () | |
5066 @c Do not break this line! -- rms. | |
5067 @c The first line of a doc string | |
5068 @c must stand alone. | |
5069 "Indicate momentarily the start of sexp before point." | |
5070 (interactive) | |
5071 @end group | |
5072 @group | |
5073 (let ((blink-matching-paren-distance | |
5074 (buffer-size)) | |
5075 (blink-matching-paren t)) | |
5076 (blink-matching-open))) | |
5077 @end group | |
5078 @end smallexample | |
5079 @end deffn | |
5080 | |
5081 @node Usual Display | |
5082 @section Usual Display Conventions | |
5083 | |
5084 The usual display conventions define how to display each character | |
5085 code. You can override these conventions by setting up a display table | |
5086 (@pxref{Display Tables}). Here are the usual display conventions: | |
5087 | |
5088 @itemize @bullet | |
5089 @item | |
5090 Character codes 32 through 126 map to glyph codes 32 through 126. | |
5091 Normally this means they display as themselves. | |
5092 | |
5093 @item | |
5094 Character code 9 is a horizontal tab. It displays as whitespace | |
5095 up to a position determined by @code{tab-width}. | |
5096 | |
5097 @item | |
5098 Character code 10 is a newline. | |
5099 | |
5100 @item | |
5101 All other codes in the range 0 through 31, and code 127, display in one | |
5102 of two ways according to the value of @code{ctl-arrow}. If it is | |
5103 non-@code{nil}, these codes map to sequences of two glyphs, where the | |
5104 first glyph is the @acronym{ASCII} code for @samp{^}. (A display table can | |
5105 specify a glyph to use instead of @samp{^}.) Otherwise, these codes map | |
5106 just like the codes in the range 128 to 255. | |
5107 | |
5108 On MS-DOS terminals, Emacs arranges by default for the character code | |
5109 127 to be mapped to the glyph code 127, which normally displays as an | |
5110 empty polygon. This glyph is used to display non-@acronym{ASCII} characters | |
5111 that the MS-DOS terminal doesn't support. @xref{MS-DOS and MULE,,, | |
5112 emacs, The GNU Emacs Manual}. | |
5113 | |
5114 @item | |
5115 Character codes 128 through 255 map to sequences of four glyphs, where | |
5116 the first glyph is the @acronym{ASCII} code for @samp{\}, and the others are | |
5117 digit characters representing the character code in octal. (A display | |
5118 table can specify a glyph to use instead of @samp{\}.) | |
5119 | |
5120 @item | |
5121 Multibyte character codes above 256 are displayed as themselves, or as a | |
5122 question mark or empty box if the terminal cannot display that | |
5123 character. | |
5124 @end itemize | |
5125 | |
5126 The usual display conventions apply even when there is a display | |
5127 table, for any character whose entry in the active display table is | |
5128 @code{nil}. Thus, when you set up a display table, you need only | |
5129 specify the characters for which you want special behavior. | |
5130 | |
5131 These display rules apply to carriage return (character code 13), when | |
5132 it appears in the buffer. But that character may not appear in the | |
5133 buffer where you expect it, if it was eliminated as part of end-of-line | |
5134 conversion (@pxref{Coding System Basics}). | |
5135 | |
5136 These variables affect the way certain characters are displayed on the | |
5137 screen. Since they change the number of columns the characters occupy, | |
5138 they also affect the indentation functions. These variables also affect | |
5139 how the mode line is displayed; if you want to force redisplay of the | |
5140 mode line using the new values, call the function | |
5141 @code{force-mode-line-update} (@pxref{Mode Line Format}). | |
5142 | |
5143 @defopt ctl-arrow | |
5144 @cindex control characters in display | |
5145 This buffer-local variable controls how control characters are | |
5146 displayed. If it is non-@code{nil}, they are displayed as a caret | |
5147 followed by the character: @samp{^A}. If it is @code{nil}, they are | |
5148 displayed as a backslash followed by three octal digits: @samp{\001}. | |
5149 @end defopt | |
5150 | |
5151 @c Following may have overfull hbox. | |
5152 @defvar default-ctl-arrow | |
5153 The value of this variable is the default value for @code{ctl-arrow} in | |
5154 buffers that do not override it. @xref{Default Value}. | |
5155 @end defvar | |
5156 | |
5157 @defopt tab-width | |
5158 The value of this buffer-local variable is the spacing between tab | |
5159 stops used for displaying tab characters in Emacs buffers. The value | |
5160 is in units of columns, and the default is 8. Note that this feature | |
5161 is completely independent of the user-settable tab stops used by the | |
5162 command @code{tab-to-tab-stop}. @xref{Indent Tabs}. | |
5163 @end defopt | |
5164 | |
5165 @node Display Tables | |
5166 @section Display Tables | |
5167 | |
5168 @cindex display table | |
5169 You can use the @dfn{display table} feature to control how all possible | |
5170 character codes display on the screen. This is useful for displaying | |
5171 European languages that have letters not in the @acronym{ASCII} character | |
5172 set. | |
5173 | |
5174 The display table maps each character code into a sequence of | |
5175 @dfn{glyphs}, each glyph being a graphic that takes up one character | |
5176 position on the screen. You can also define how to display each glyph | |
5177 on your terminal, using the @dfn{glyph table}. | |
5178 | |
5179 Display tables affect how the mode line is displayed; if you want to | |
5180 force redisplay of the mode line using a new display table, call | |
5181 @code{force-mode-line-update} (@pxref{Mode Line Format}). | |
5182 | |
5183 @menu | |
5184 * Display Table Format:: What a display table consists of. | |
5185 * Active Display Table:: How Emacs selects a display table to use. | |
5186 * Glyphs:: How to define a glyph, and what glyphs mean. | |
5187 @end menu | |
5188 | |
5189 @node Display Table Format | |
5190 @subsection Display Table Format | |
5191 | |
5192 A display table is actually a char-table (@pxref{Char-Tables}) with | |
5193 @code{display-table} as its subtype. | |
5194 | |
5195 @defun make-display-table | |
5196 This creates and returns a display table. The table initially has | |
5197 @code{nil} in all elements. | |
5198 @end defun | |
5199 | |
5200 The ordinary elements of the display table are indexed by character | |
5201 codes; the element at index @var{c} says how to display the character | |
5202 code @var{c}. The value should be @code{nil} or a vector of the | |
5203 glyphs to be output (@pxref{Glyphs}). @code{nil} says to display the | |
5204 character @var{c} according to the usual display conventions | |
5205 (@pxref{Usual Display}). | |
5206 | |
5207 @strong{Warning:} if you use the display table to change the display | |
5208 of newline characters, the whole buffer will be displayed as one long | |
5209 ``line.'' | |
5210 | |
5211 The display table also has six ``extra slots'' which serve special | |
5212 purposes. Here is a table of their meanings; @code{nil} in any slot | |
5213 means to use the default for that slot, as stated below. | |
5214 | |
5215 @table @asis | |
5216 @item 0 | |
5217 The glyph for the end of a truncated screen line (the default for this | |
5218 is @samp{$}). @xref{Glyphs}. On graphical terminals, Emacs uses | |
5219 arrows in the fringes to indicate truncation, so the display table has | |
5220 no effect. | |
5221 | |
5222 @item 1 | |
5223 The glyph for the end of a continued line (the default is @samp{\}). | |
5224 On graphical terminals, Emacs uses curved arrows in the fringes to | |
5225 indicate continuation, so the display table has no effect. | |
5226 | |
5227 @item 2 | |
5228 The glyph for indicating a character displayed as an octal character | |
5229 code (the default is @samp{\}). | |
5230 | |
5231 @item 3 | |
5232 The glyph for indicating a control character (the default is @samp{^}). | |
5233 | |
5234 @item 4 | |
5235 A vector of glyphs for indicating the presence of invisible lines (the | |
5236 default is @samp{...}). @xref{Selective Display}. | |
5237 | |
5238 @item 5 | |
5239 The glyph used to draw the border between side-by-side windows (the | |
5240 default is @samp{|}). @xref{Splitting Windows}. This takes effect only | |
5241 when there are no scroll bars; if scroll bars are supported and in use, | |
5242 a scroll bar separates the two windows. | |
5243 @end table | |
5244 | |
5245 For example, here is how to construct a display table that mimics the | |
5246 effect of setting @code{ctl-arrow} to a non-@code{nil} value: | |
5247 | |
5248 @example | |
5249 (setq disptab (make-display-table)) | |
5250 (let ((i 0)) | |
5251 (while (< i 32) | |
5252 (or (= i ?\t) (= i ?\n) | |
5253 (aset disptab i (vector ?^ (+ i 64)))) | |
5254 (setq i (1+ i))) | |
5255 (aset disptab 127 (vector ?^ ??))) | |
5256 @end example | |
5257 | |
5258 @defun display-table-slot display-table slot | |
5259 This function returns the value of the extra slot @var{slot} of | |
5260 @var{display-table}. The argument @var{slot} may be a number from 0 to | |
5261 5 inclusive, or a slot name (symbol). Valid symbols are | |
5262 @code{truncation}, @code{wrap}, @code{escape}, @code{control}, | |
5263 @code{selective-display}, and @code{vertical-border}. | |
5264 @end defun | |
5265 | |
5266 @defun set-display-table-slot display-table slot value | |
5267 This function stores @var{value} in the extra slot @var{slot} of | |
5268 @var{display-table}. The argument @var{slot} may be a number from 0 to | |
5269 5 inclusive, or a slot name (symbol). Valid symbols are | |
5270 @code{truncation}, @code{wrap}, @code{escape}, @code{control}, | |
5271 @code{selective-display}, and @code{vertical-border}. | |
5272 @end defun | |
5273 | |
5274 @defun describe-display-table display-table | |
5275 This function displays a description of the display table | |
5276 @var{display-table} in a help buffer. | |
5277 @end defun | |
5278 | |
5279 @deffn Command describe-current-display-table | |
5280 This command displays a description of the current display table in a | |
5281 help buffer. | |
5282 @end deffn | |
5283 | |
5284 @node Active Display Table | |
5285 @subsection Active Display Table | |
5286 @cindex active display table | |
5287 | |
5288 Each window can specify a display table, and so can each buffer. When | |
5289 a buffer @var{b} is displayed in window @var{w}, display uses the | |
5290 display table for window @var{w} if it has one; otherwise, the display | |
5291 table for buffer @var{b} if it has one; otherwise, the standard display | |
5292 table if any. The display table chosen is called the @dfn{active} | |
5293 display table. | |
5294 | |
5295 @defun window-display-table &optional window | |
5296 This function returns @var{window}'s display table, or @code{nil} | |
5297 if @var{window} does not have an assigned display table. The default | |
5298 for @var{window} is the selected window. | |
5299 @end defun | |
5300 | |
5301 @defun set-window-display-table window table | |
5302 This function sets the display table of @var{window} to @var{table}. | |
5303 The argument @var{table} should be either a display table or | |
5304 @code{nil}. | |
5305 @end defun | |
5306 | |
5307 @defvar buffer-display-table | |
5308 This variable is automatically buffer-local in all buffers; its value in | |
5309 a particular buffer specifies the display table for that buffer. If it | |
5310 is @code{nil}, that means the buffer does not have an assigned display | |
5311 table. | |
5312 @end defvar | |
5313 | |
5314 @defvar standard-display-table | |
5315 This variable's value is the default display table, used whenever a | |
5316 window has no display table and neither does the buffer displayed in | |
5317 that window. This variable is @code{nil} by default. | |
5318 @end defvar | |
5319 | |
5320 If there is no display table to use for a particular window---that is, | |
5321 if the window specifies none, its buffer specifies none, and | |
5322 @code{standard-display-table} is @code{nil}---then Emacs uses the usual | |
5323 display conventions for all character codes in that window. @xref{Usual | |
5324 Display}. | |
5325 | |
5326 A number of functions for changing the standard display table | |
5327 are defined in the library @file{disp-table}. | |
5328 | |
5329 @node Glyphs | |
5330 @subsection Glyphs | |
5331 | |
5332 @cindex glyph | |
5333 A @dfn{glyph} is a generalization of a character; it stands for an | |
5334 image that takes up a single character position on the screen. Normally | |
5335 glyphs come from vectors in the display table (@pxref{Display Tables}). | |
5336 | |
5337 A glyph is represented in Lisp as a @dfn{glyph code}. A glyph code | |
5338 can be @dfn{simple} or it can be defined by the @dfn{glyph table}. A | |
5339 simple glyph code is just a way of specifying a character and a face | |
5340 to output it in. @xref{Faces}. | |
5341 | |
5342 The following functions are used to manipulate simple glyph codes: | |
5343 | |
5344 @defun make-glyph-code char &optional face | |
5345 This function returns a simple glyph code representing char @var{char} | |
5346 with face @var{face}. | |
5347 @end defun | |
5348 | |
5349 @defun glyph-char glyph | |
5350 This function returns the character of simple glyph code @var{glyph}. | |
5351 @end defun | |
5352 | |
5353 @defun glyph-face glyph | |
5354 This function returns face of simple glyph code @var{glyph}, or | |
5355 @code{nil} if @var{glyph} has the default face (face-id 0). | |
5356 @end defun | |
5357 | |
5358 On character terminals, you can set up a @dfn{glyph table} to define | |
5359 the meaning of glyph codes (represented as small integers). | |
5360 | |
5361 @defvar glyph-table | |
5362 The value of this variable is the current glyph table. It should be | |
5363 @code{nil} or a vector whose @var{g}th element defines glyph code | |
5364 @var{g}. | |
5365 | |
5366 If a glyph code is greater than or equal to the length of the glyph | |
5367 table, that code is automatically simple. If @code{glyph-table} is | |
5368 @code{nil} then all glyph codes are simple. | |
5369 | |
5370 The glyph table is used only on character terminals. On graphical | |
5371 displays, all glyph codes are simple. | |
5372 @end defvar | |
5373 | |
5374 Here are the meaningful types of elements in the glyph table: | |
5375 | |
5376 @table @asis | |
5377 @item @var{string} | |
5378 Send the characters in @var{string} to the terminal to output | |
5379 this glyph code. | |
5380 | |
5381 @item @var{code} | |
5382 Define this glyph code as an alias for glyph code @var{code} created | |
5383 by @code{make-glyph-code}. You can use such an alias to define a | |
5384 small-numbered glyph code which specifies a character with a face. | |
5385 | |
5386 @item @code{nil} | |
5387 This glyph code is simple. | |
5388 @end table | |
5389 | |
5390 @defun create-glyph string | |
5391 This function returns a newly-allocated glyph code which is set up to | |
5392 display by sending @var{string} to the terminal. | |
5393 @end defun | |
5394 | |
5395 @node Beeping | |
5396 @section Beeping | |
5397 @c @cindex beeping "beep" is adjacent | |
5398 @cindex bell | |
5399 | |
5400 This section describes how to make Emacs ring the bell (or blink the | |
5401 screen) to attract the user's attention. Be conservative about how | |
5402 often you do this; frequent bells can become irritating. Also be | |
5403 careful not to use just beeping when signaling an error is more | |
5404 appropriate. (@xref{Errors}.) | |
5405 | |
5406 @defun ding &optional do-not-terminate | |
5407 @cindex keyboard macro termination | |
5408 This function beeps, or flashes the screen (see @code{visible-bell} below). | |
5409 It also terminates any keyboard macro currently executing unless | |
5410 @var{do-not-terminate} is non-@code{nil}. | |
5411 @end defun | |
5412 | |
5413 @defun beep &optional do-not-terminate | |
5414 This is a synonym for @code{ding}. | |
5415 @end defun | |
5416 | |
5417 @defopt visible-bell | |
5418 This variable determines whether Emacs should flash the screen to | |
5419 represent a bell. Non-@code{nil} means yes, @code{nil} means no. This | |
5420 is effective on graphical displays, and on text-only terminals | |
5421 provided the terminal's Termcap entry defines the visible bell | |
5422 capability (@samp{vb}). | |
5423 @end defopt | |
5424 | |
5425 @defvar ring-bell-function | |
5426 If this is non-@code{nil}, it specifies how Emacs should ``ring the | |
5427 bell.'' Its value should be a function of no arguments. If this is | |
5428 non-@code{nil}, it takes precedence over the @code{visible-bell} | |
5429 variable. | |
5430 @end defvar | |
5431 | |
5432 @node Window Systems | |
5433 @section Window Systems | |
5434 | |
5435 Emacs works with several window systems, most notably the X Window | |
5436 System. Both Emacs and X use the term ``window,'' but use it | |
5437 differently. An Emacs frame is a single window as far as X is | |
5438 concerned; the individual Emacs windows are not known to X at all. | |
5439 | |
5440 @defvar window-system | |
5441 This variable tells Lisp programs what window system Emacs is running | |
5442 under. The possible values are | |
5443 | |
5444 @table @code | |
5445 @item x | |
5446 @cindex X Window System | |
5447 Emacs is displaying using X. | |
5448 @item pc | |
5449 Emacs is displaying using MS-DOS. | |
5450 @item w32 | |
5451 Emacs is displaying using Windows. | |
5452 @item mac | |
5453 Emacs is displaying using a Macintosh. | |
5454 @item nil | |
5455 Emacs is using a character-based terminal. | |
5456 @end table | |
5457 @end defvar | |
5458 | |
5459 @defvar window-setup-hook | |
5460 This variable is a normal hook which Emacs runs after handling the | |
5461 initialization files. Emacs runs this hook after it has completed | |
5462 loading your init file, the default initialization file (if | |
5463 any), and the terminal-specific Lisp code, and running the hook | |
5464 @code{term-setup-hook}. | |
5465 | |
5466 This hook is used for internal purposes: setting up communication with | |
5467 the window system, and creating the initial window. Users should not | |
5468 interfere with it. | |
5469 @end defvar | |
5470 | |
5471 @ignore | |
5472 arch-tag: ffdf5714-7ecf-415b-9023-fbc6b409c2c6 | |
5473 @end ignore |