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