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