6598
|
1 @c -*-texinfo-*-
|
|
2 @c This is part of the GNU Emacs Lisp Reference Manual.
|
27189
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999
|
|
4 @c Free Software Foundation, Inc.
|
6598
|
5 @c See the file elisp.texi for copying conditions.
|
|
6 @setfilename ../info/display
|
21682
|
7 @node Display, Calendar, Processes, Top
|
6598
|
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.
|
25751
|
15 * Forcing Redisplay:: Forcing redisplay.
|
6598
|
16 * Truncation:: Folding or wrapping long text lines.
|
|
17 * The Echo Area:: Where messages are displayed.
|
12067
|
18 * Invisible Text:: Hiding part of the buffer text.
|
|
19 * Selective Display:: Hiding part of the buffer text (the old way).
|
6598
|
20 * Overlay Arrow:: Display of an arrow to indicate position.
|
|
21 * Temporary Displays:: Displays that go away automatically.
|
|
22 * Overlays:: Use overlays to highlight parts of the buffer.
|
25875
|
23 * Width:: How wide a character or string is on the screen.
|
|
24 * Faces:: A face defines a graphics style for text characters:
|
|
25 font, colors, etc.
|
25751
|
26 * Display Property:: Enabling special display features.
|
|
27 * Images:: Displaying images in Emacs buffers.
|
6598
|
28 * Blinking:: How Emacs shows the matching open parenthesis.
|
|
29 * Inverse Video:: Specifying how the screen looks.
|
|
30 * Usual Display:: The usual conventions for displaying nonprinting chars.
|
|
31 * Display Tables:: How to specify other conventions.
|
|
32 * Beeping:: Audible signal to the user.
|
|
33 * Window Systems:: Which window system is being used.
|
|
34 @end menu
|
|
35
|
|
36 @node Refresh Screen
|
|
37 @section Refreshing the Screen
|
|
38
|
|
39 The function @code{redraw-frame} redisplays the entire contents of a
|
22252
|
40 given frame (@pxref{Frames}).
|
6598
|
41
|
|
42 @c Emacs 19 feature
|
|
43 @defun redraw-frame frame
|
|
44 This function clears and redisplays frame @var{frame}.
|
|
45 @end defun
|
|
46
|
|
47 Even more powerful is @code{redraw-display}:
|
|
48
|
|
49 @deffn Command redraw-display
|
|
50 This function clears and redisplays all visible frames.
|
|
51 @end deffn
|
|
52
|
12098
|
53 Processing user input takes absolute priority over redisplay. If you
|
|
54 call these functions when input is available, they do nothing
|
|
55 immediately, but a full redisplay does happen eventually---after all the
|
|
56 input has been processed.
|
|
57
|
6598
|
58 Normally, suspending and resuming Emacs also refreshes the screen.
|
|
59 Some terminal emulators record separate contents for display-oriented
|
|
60 programs such as Emacs and for ordinary sequential display. If you are
|
|
61 using such a terminal, you might want to inhibit the redisplay on
|
9009
|
62 resumption.
|
6598
|
63
|
|
64 @defvar no-redraw-on-reenter
|
|
65 @cindex suspend (cf. @code{no-redraw-on-reenter})
|
|
66 @cindex resume (cf. @code{no-redraw-on-reenter})
|
|
67 This variable controls whether Emacs redraws the entire screen after it
|
21007
|
68 has been suspended and resumed. Non-@code{nil} means there is no need
|
21682
|
69 to redraw, @code{nil} means redrawing is needed. The default is @code{nil}.
|
6598
|
70 @end defvar
|
|
71
|
25751
|
72 @node Forcing Redisplay
|
|
73 @section Forcing Redisplay
|
|
74 @cindex forcing redisplay
|
|
75
|
|
76 Emacs redisplay normally stops if input arrives, and does not happen
|
|
77 at all if input is available before it starts. Most of the time, this
|
|
78 is exactly what you want. However, you can prevent preemption by
|
|
79 binding @code{redisplay-dont-pause} to a non-@code{nil} value.
|
|
80
|
|
81 @tindex redisplay-dont-pause
|
|
82 @defvar redisplay-dont-pause
|
|
83 If this variable is non-@code{nil}, pending input does not
|
|
84 prevent or halt redisplay; redisplay occurs, and finishes,
|
|
85 regardless of whether input is available. This feature is available
|
|
86 as of Emacs 21.
|
|
87 @end defvar
|
|
88
|
|
89 You can request a display update, but only if no input is pending,
|
|
90 with @code{(sit-for 0)}. To force a display update even when input is
|
|
91 pending, do this:
|
|
92
|
|
93 @example
|
|
94 (let ((redisplay-dont-pause t))
|
|
95 (sit-for 0))
|
|
96 @end example
|
|
97
|
6598
|
98 @node Truncation
|
|
99 @section Truncation
|
|
100 @cindex line wrapping
|
|
101 @cindex continuation lines
|
|
102 @cindex @samp{$} in display
|
|
103 @cindex @samp{\} in display
|
|
104
|
|
105 When a line of text extends beyond the right edge of a window, the
|
|
106 line can either be continued on the next screen line, or truncated to
|
|
107 one screen line. The additional screen lines used to display a long
|
|
108 text line are called @dfn{continuation} lines. Normally, a @samp{$} in
|
|
109 the rightmost column of the window indicates truncation; a @samp{\} on
|
21682
|
110 the rightmost column indicates a line that ``wraps'' onto the next line,
|
|
111 which is also called @dfn{continuing} the line. (The display table can
|
|
112 specify alternative indicators; see @ref{Display Tables}.)
|
6598
|
113
|
|
114 Note that continuation is different from filling; continuation happens
|
|
115 on the screen only, not in the buffer contents, and it breaks a line
|
|
116 precisely at the right margin, not at a word boundary. @xref{Filling}.
|
|
117
|
|
118 @defopt truncate-lines
|
|
119 This buffer-local variable controls how Emacs displays lines that extend
|
|
120 beyond the right edge of the window. The default is @code{nil}, which
|
|
121 specifies continuation. If the value is non-@code{nil}, then these
|
|
122 lines are truncated.
|
|
123
|
|
124 If the variable @code{truncate-partial-width-windows} is non-@code{nil},
|
|
125 then truncation is always used for side-by-side windows (within one
|
|
126 frame) regardless of the value of @code{truncate-lines}.
|
|
127 @end defopt
|
|
128
|
12098
|
129 @defopt default-truncate-lines
|
6598
|
130 This variable is the default value for @code{truncate-lines}, for
|
21682
|
131 buffers that do not have buffer-local values for it.
|
12098
|
132 @end defopt
|
6598
|
133
|
|
134 @defopt truncate-partial-width-windows
|
|
135 This variable controls display of lines that extend beyond the right
|
|
136 edge of the window, in side-by-side windows (@pxref{Splitting Windows}).
|
|
137 If it is non-@code{nil}, these lines are truncated; otherwise,
|
|
138 @code{truncate-lines} says what to do with them.
|
|
139 @end defopt
|
|
140
|
22138
|
141 When horizontal scrolling (@pxref{Horizontal Scrolling}) is in use in
|
|
142 a window, that forces truncation.
|
|
143
|
21007
|
144 You can override the glyphs that indicate continuation or truncation
|
|
145 using the display table; see @ref{Display Tables}.
|
6598
|
146
|
22252
|
147 If your buffer contains @emph{very} long lines, and you use
|
12067
|
148 continuation to display them, just thinking about them can make Emacs
|
12098
|
149 redisplay slow. The column computation and indentation functions also
|
|
150 become slow. Then you might find it advisable to set
|
|
151 @code{cache-long-line-scans} to @code{t}.
|
12067
|
152
|
|
153 @defvar cache-long-line-scans
|
|
154 If this variable is non-@code{nil}, various indentation and motion
|
12098
|
155 functions, and Emacs redisplay, cache the results of scanning the
|
|
156 buffer, and consult the cache to avoid rescanning regions of the buffer
|
|
157 unless they are modified.
|
12067
|
158
|
12098
|
159 Turning on the cache slows down processing of short lines somewhat.
|
12067
|
160
|
21682
|
161 This variable is automatically buffer-local in every buffer.
|
12067
|
162 @end defvar
|
|
163
|
6598
|
164 @node The Echo Area
|
|
165 @section The Echo Area
|
|
166 @cindex error display
|
|
167 @cindex echo area
|
|
168
|
12067
|
169 The @dfn{echo area} is used for displaying messages made with the
|
6598
|
170 @code{message} primitive, and for echoing keystrokes. It is not the
|
|
171 same as the minibuffer, despite the fact that the minibuffer appears
|
|
172 (when active) in the same place on the screen as the echo area. The
|
|
173 @cite{GNU Emacs Manual} specifies the rules for resolving conflicts
|
|
174 between the echo area and the minibuffer for use of that screen space
|
|
175 (@pxref{Minibuffer,, The Minibuffer, emacs, The GNU Emacs Manual}).
|
|
176 Error messages appear in the echo area; see @ref{Errors}.
|
|
177
|
|
178 You can write output in the echo area by using the Lisp printing
|
|
179 functions with @code{t} as the stream (@pxref{Output Functions}), or as
|
|
180 follows:
|
|
181
|
|
182 @defun message string &rest arguments
|
12067
|
183 This function displays a one-line message in the echo area. The
|
6598
|
184 argument @var{string} is similar to a C language @code{printf} control
|
|
185 string. See @code{format} in @ref{String Conversion}, for the details
|
|
186 on the conversion specifications. @code{message} returns the
|
|
187 constructed string.
|
|
188
|
7735
|
189 In batch mode, @code{message} prints the message text on the standard
|
|
190 error stream, followed by a newline.
|
|
191
|
25751
|
192 If @var{string}, or strings among the @var{arguments}, have @code{face}
|
|
193 text properties, these affect the way the message is displayed.
|
|
194
|
6598
|
195 @c Emacs 19 feature
|
25751
|
196 If @var{string} is @code{nil}, @code{message} clears the echo area; if
|
|
197 the echo area has been expanded automatically, this brings it back to
|
|
198 its normal size. If the minibuffer is active, this brings the
|
|
199 minibuffer contents back onto the screen immediately.
|
7735
|
200
|
6598
|
201 @example
|
|
202 @group
|
|
203 (message "Minibuffer depth is %d."
|
|
204 (minibuffer-depth))
|
|
205 @print{} Minibuffer depth is 0.
|
|
206 @result{} "Minibuffer depth is 0."
|
|
207 @end group
|
|
208
|
|
209 @group
|
|
210 ---------- Echo Area ----------
|
|
211 Minibuffer depth is 0.
|
|
212 ---------- Echo Area ----------
|
|
213 @end group
|
|
214 @end example
|
|
215 @end defun
|
|
216
|
24951
|
217 @tindex with-temp-message
|
|
218 @defmac with-temp-message message &rest body
|
|
219 This construct displays a message in the echo area temporarily, during
|
|
220 the execution of @var{body}. It displays @var{message}, executes
|
|
221 @var{body}, then returns the value of the last body form while restoring
|
|
222 the previous echo area contents.
|
|
223 @end defmac
|
|
224
|
22843
|
225 @defun message-or-box string &rest arguments
|
|
226 This function displays a message like @code{message}, but may display it
|
|
227 in a dialog box instead of the echo area. If this function is called in
|
|
228 a command that was invoked using the mouse---more precisely, if
|
|
229 @code{last-nonmenu-event} (@pxref{Command Loop Info}) is either
|
|
230 @code{nil} or a list---then it uses a dialog box or pop-up menu to
|
|
231 display the message. Otherwise, it uses the echo area. (This is the
|
|
232 same criterion that @code{y-or-n-p} uses to make a similar decision; see
|
|
233 @ref{Yes-or-No Queries}.)
|
|
234
|
|
235 You can force use of the mouse or of the echo area by binding
|
|
236 @code{last-nonmenu-event} to a suitable value around the call.
|
|
237 @end defun
|
|
238
|
|
239 @defun message-box string &rest arguments
|
|
240 This function displays a message like @code{message}, but uses a dialog
|
|
241 box (or a pop-up menu) whenever that is possible. If it is impossible
|
|
242 to use a dialog box or pop-up menu, because the terminal does not
|
|
243 support them, then @code{message-box} uses the echo area, like
|
|
244 @code{message}.
|
|
245 @end defun
|
|
246
|
22138
|
247 @defun current-message
|
21007
|
248 This function returns the message currently being displayed in the
|
|
249 echo area, or @code{nil} if there is none.
|
|
250 @end defun
|
|
251
|
21682
|
252 @defvar cursor-in-echo-area
|
|
253 This variable controls where the cursor appears when a message is
|
|
254 displayed in the echo area. If it is non-@code{nil}, then the cursor
|
|
255 appears at the end of the message. Otherwise, the cursor appears at
|
|
256 point---not in the echo area at all.
|
|
257
|
|
258 The value is normally @code{nil}; Lisp programs bind it to @code{t}
|
|
259 for brief periods of time.
|
|
260 @end defvar
|
|
261
|
22138
|
262 @defvar echo-area-clear-hook
|
21007
|
263 This normal hook is run whenever the echo area is cleared---either by
|
|
264 @code{(message nil)} or for any other reason.
|
|
265 @end defvar
|
|
266
|
12067
|
267 Almost all the messages displayed in the echo area are also recorded
|
|
268 in the @samp{*Messages*} buffer.
|
|
269
|
|
270 @defopt message-log-max
|
|
271 This variable specifies how many lines to keep in the @samp{*Messages*}
|
|
272 buffer. The value @code{t} means there is no limit on how many lines to
|
|
273 keep. The value @code{nil} disables message logging entirely. Here's
|
|
274 how to display a message and prevent it from being logged:
|
|
275
|
|
276 @example
|
|
277 (let (message-log-max)
|
|
278 (message @dots{}))
|
|
279 @end example
|
|
280 @end defopt
|
|
281
|
12098
|
282 @defvar echo-keystrokes
|
|
283 This variable determines how much time should elapse before command
|
27971
|
284 characters echo. Its value must be an integer or floating point number,
|
|
285 which specifies the
|
12098
|
286 number of seconds to wait before echoing. If the user types a prefix
|
|
287 key (such as @kbd{C-x}) and then delays this many seconds before
|
22138
|
288 continuing, the prefix key is echoed in the echo area. (Once echoing
|
|
289 begins in a key sequence, all subsequent characters in the same key
|
|
290 sequence are echoed immediately.)
|
12098
|
291
|
|
292 If the value is zero, then command input is not echoed.
|
|
293 @end defvar
|
|
294
|
12067
|
295 @node Invisible Text
|
|
296 @section Invisible Text
|
|
297
|
|
298 @cindex invisible text
|
|
299 You can make characters @dfn{invisible}, so that they do not appear on
|
|
300 the screen, with the @code{invisible} property. This can be either a
|
22138
|
301 text property (@pxref{Text Properties}) or a property of an overlay
|
|
302 (@pxref{Overlays}).
|
12067
|
303
|
|
304 In the simplest case, any non-@code{nil} @code{invisible} property makes
|
|
305 a character invisible. This is the default case---if you don't alter
|
|
306 the default value of @code{buffer-invisibility-spec}, this is how the
|
21682
|
307 @code{invisible} property works.
|
12067
|
308
|
|
309 More generally, you can use the variable @code{buffer-invisibility-spec}
|
|
310 to control which values of the @code{invisible} property make text
|
|
311 invisible. This permits you to classify the text into different subsets
|
|
312 in advance, by giving them different @code{invisible} values, and
|
|
313 subsequently make various subsets visible or invisible by changing the
|
|
314 value of @code{buffer-invisibility-spec}.
|
|
315
|
|
316 Controlling visibility with @code{buffer-invisibility-spec} is
|
25875
|
317 especially useful in a program to display the list of entries in a
|
|
318 database. It permits the implementation of convenient filtering
|
|
319 commands to view just a part of the entries in the database. Setting
|
|
320 this variable is very fast, much faster than scanning all the text in
|
|
321 the buffer looking for properties to change.
|
12067
|
322
|
|
323 @defvar buffer-invisibility-spec
|
|
324 This variable specifies which kinds of @code{invisible} properties
|
|
325 actually make a character invisible.
|
|
326
|
|
327 @table @asis
|
|
328 @item @code{t}
|
|
329 A character is invisible if its @code{invisible} property is
|
|
330 non-@code{nil}. This is the default.
|
|
331
|
|
332 @item a list
|
21682
|
333 Each element of the list specifies a criterion for invisibility; if a
|
|
334 character's @code{invisible} property fits any one of these criteria,
|
|
335 the character is invisible. The list can have two kinds of elements:
|
12067
|
336
|
|
337 @table @code
|
|
338 @item @var{atom}
|
21682
|
339 A character is invisible if its @code{invisible} property value
|
12067
|
340 is @var{atom} or if it is a list with @var{atom} as a member.
|
|
341
|
|
342 @item (@var{atom} . t)
|
21682
|
343 A character is invisible if its @code{invisible} property value
|
12067
|
344 is @var{atom} or if it is a list with @var{atom} as a member.
|
|
345 Moreover, if this character is at the end of a line and is followed
|
|
346 by a visible newline, it displays an ellipsis.
|
|
347 @end table
|
|
348 @end table
|
|
349 @end defvar
|
|
350
|
21007
|
351 Two functions are specifically provided for adding elements to
|
|
352 @code{buffer-invisibility-spec} and removing elements from it.
|
|
353
|
22138
|
354 @defun add-to-invisibility-spec element
|
21007
|
355 Add the element @var{element} to @code{buffer-invisibility-spec}
|
|
356 (if it is not already present in that list).
|
|
357 @end defun
|
|
358
|
22138
|
359 @defun remove-from-invisibility-spec element
|
21007
|
360 Remove the element @var{element} from @code{buffer-invisibility-spec}.
|
25875
|
361 This does nothing if @var{element} is not in the list.
|
21007
|
362 @end defun
|
|
363
|
|
364 One convention about the use of @code{buffer-invisibility-spec} is
|
|
365 that a major mode should use the mode's own name as an element of
|
|
366 @code{buffer-invisibility-spec} and as the value of the @code{invisible}
|
|
367 property:
|
|
368
|
|
369 @example
|
21682
|
370 ;; @r{If you want to display an ellipsis:}
|
21007
|
371 (add-to-invisibility-spec '(my-symbol . t))
|
21682
|
372 ;; @r{If you don't want ellipsis:}
|
21007
|
373 (add-to-invisibility-spec 'my-symbol)
|
|
374
|
|
375 (overlay-put (make-overlay beginning end)
|
|
376 'invisible 'my-symbol)
|
|
377
|
21682
|
378 ;; @r{When done with the overlays:}
|
21007
|
379 (remove-from-invisibility-spec '(my-symbol . t))
|
21682
|
380 ;; @r{Or respectively:}
|
21007
|
381 (remove-from-invisibility-spec 'my-symbol)
|
|
382 @end example
|
|
383
|
15761
|
384 @vindex line-move-ignore-invisible
|
12098
|
385 Ordinarily, commands that operate on text or move point do not care
|
15761
|
386 whether the text is invisible. The user-level line motion commands
|
|
387 explicitly ignore invisible newlines if
|
|
388 @code{line-move-ignore-invisible} is non-@code{nil}, but only because
|
|
389 they are explicitly programmed to do so.
|
12098
|
390
|
21007
|
391 Incremental search can make invisible overlays visible temporarily
|
|
392 and/or permanently when a match includes invisible text. To enable
|
|
393 this, the overlay should have a non-@code{nil}
|
|
394 @code{isearch-open-invisible} property. The property value should be a
|
|
395 function to be called with the overlay as an argument. This function
|
|
396 should make the overlay visible permanently; it is used when the match
|
|
397 overlaps the overlay on exit from the search.
|
|
398
|
|
399 During the search, such overlays are made temporarily visible by
|
|
400 temporarily modifying their invisible and intangible properties. If you
|
22267
|
401 want this to be done differently for a certain overlay, give it an
|
21007
|
402 @code{isearch-open-invisible-temporary} property which is a function.
|
|
403 The function is called with two arguments: the first is the overlay, and
|
26986
|
404 the second is @code{nil} to make the overlay visible, or @code{t} to
|
22138
|
405 make it invisible again.
|
21007
|
406
|
6598
|
407 @node Selective Display
|
|
408 @section Selective Display
|
|
409 @cindex selective display
|
|
410
|
21682
|
411 @dfn{Selective display} refers to a pair of related features for
|
|
412 hiding certain lines on the screen.
|
6598
|
413
|
|
414 The first variant, explicit selective display, is designed for use in
|
21682
|
415 a Lisp program: it controls which lines are hidden by altering the text.
|
|
416 The invisible text feature (@pxref{Invisible Text}) has partially
|
|
417 replaced this feature.
|
12067
|
418
|
|
419 In the second variant, the choice of lines to hide is made
|
12098
|
420 automatically based on indentation. This variant is designed to be a
|
12067
|
421 user-level feature.
|
6598
|
422
|
|
423 The way you control explicit selective display is by replacing a
|
9009
|
424 newline (control-j) with a carriage return (control-m). The text that
|
6598
|
425 was formerly a line following that newline is now invisible. Strictly
|
|
426 speaking, it is temporarily no longer a line at all, since only newlines
|
|
427 can separate lines; it is now part of the previous line.
|
|
428
|
|
429 Selective display does not directly affect editing commands. For
|
|
430 example, @kbd{C-f} (@code{forward-char}) moves point unhesitatingly into
|
|
431 invisible text. However, the replacement of newline characters with
|
|
432 carriage return characters affects some editing commands. For example,
|
|
433 @code{next-line} skips invisible lines, since it searches only for
|
|
434 newlines. Modes that use selective display can also define commands
|
|
435 that take account of the newlines, or that make parts of the text
|
|
436 visible or invisible.
|
|
437
|
|
438 When you write a selectively displayed buffer into a file, all the
|
|
439 control-m's are output as newlines. This means that when you next read
|
|
440 in the file, it looks OK, with nothing invisible. The selective display
|
|
441 effect is seen only within Emacs.
|
|
442
|
|
443 @defvar selective-display
|
|
444 This buffer-local variable enables selective display. This means that
|
|
445 lines, or portions of lines, may be made invisible.
|
|
446
|
|
447 @itemize @bullet
|
|
448 @item
|
25875
|
449 If the value of @code{selective-display} is @code{t}, then the character
|
|
450 control-m marks the start of invisible text; the control-m, and the rest
|
|
451 of the line following it, are not displayed. This is explicit selective
|
|
452 display.
|
6598
|
453
|
|
454 @item
|
|
455 If the value of @code{selective-display} is a positive integer, then
|
|
456 lines that start with more than that many columns of indentation are not
|
|
457 displayed.
|
|
458 @end itemize
|
|
459
|
|
460 When some portion of a buffer is invisible, the vertical movement
|
|
461 commands operate as if that portion did not exist, allowing a single
|
|
462 @code{next-line} command to skip any number of invisible lines.
|
|
463 However, character movement commands (such as @code{forward-char}) do
|
|
464 not skip the invisible portion, and it is possible (if tricky) to insert
|
|
465 or delete text in an invisible portion.
|
|
466
|
|
467 In the examples below, we show the @emph{display appearance} of the
|
|
468 buffer @code{foo}, which changes with the value of
|
|
469 @code{selective-display}. The @emph{contents} of the buffer do not
|
|
470 change.
|
|
471
|
|
472 @example
|
|
473 @group
|
|
474 (setq selective-display nil)
|
|
475 @result{} nil
|
|
476
|
|
477 ---------- Buffer: foo ----------
|
|
478 1 on this column
|
|
479 2on this column
|
|
480 3n this column
|
|
481 3n this column
|
|
482 2on this column
|
|
483 1 on this column
|
|
484 ---------- Buffer: foo ----------
|
|
485 @end group
|
|
486
|
|
487 @group
|
|
488 (setq selective-display 2)
|
|
489 @result{} 2
|
|
490
|
|
491 ---------- Buffer: foo ----------
|
|
492 1 on this column
|
|
493 2on this column
|
|
494 2on this column
|
|
495 1 on this column
|
|
496 ---------- Buffer: foo ----------
|
|
497 @end group
|
|
498 @end example
|
|
499 @end defvar
|
|
500
|
|
501 @defvar selective-display-ellipses
|
|
502 If this buffer-local variable is non-@code{nil}, then Emacs displays
|
|
503 @samp{@dots{}} at the end of a line that is followed by invisible text.
|
|
504 This example is a continuation of the previous one.
|
|
505
|
|
506 @example
|
|
507 @group
|
|
508 (setq selective-display-ellipses t)
|
|
509 @result{} t
|
|
510
|
|
511 ---------- Buffer: foo ----------
|
|
512 1 on this column
|
|
513 2on this column ...
|
|
514 2on this column
|
|
515 1 on this column
|
|
516 ---------- Buffer: foo ----------
|
|
517 @end group
|
|
518 @end example
|
|
519
|
|
520 You can use a display table to substitute other text for the ellipsis
|
|
521 (@samp{@dots{}}). @xref{Display Tables}.
|
|
522 @end defvar
|
|
523
|
|
524 @node Overlay Arrow
|
|
525 @section The Overlay Arrow
|
|
526 @cindex overlay arrow
|
|
527
|
|
528 The @dfn{overlay arrow} is useful for directing the user's attention
|
|
529 to a particular line in a buffer. For example, in the modes used for
|
|
530 interface to debuggers, the overlay arrow indicates the line of code
|
|
531 about to be executed.
|
|
532
|
|
533 @defvar overlay-arrow-string
|
9009
|
534 This variable holds the string to display to call attention to a
|
|
535 particular line, or @code{nil} if the arrow feature is not in use.
|
29471
|
536 On a graphical display the contents of the string are ignored; instead a
|
|
537 glyph is displayed in the fringe area to the left of the display area.
|
6598
|
538 @end defvar
|
|
539
|
|
540 @defvar overlay-arrow-position
|
9009
|
541 This variable holds a marker that indicates where to display the overlay
|
29471
|
542 arrow. It should point at the beginning of a line. On a non-graphical
|
|
543 display the arrow text
|
9009
|
544 appears at the beginning of that line, overlaying any text that would
|
|
545 otherwise appear. Since the arrow is usually short, and the line
|
|
546 usually begins with indentation, normally nothing significant is
|
|
547 overwritten.
|
6598
|
548
|
9009
|
549 The overlay string is displayed only in the buffer that this marker
|
6598
|
550 points into. Thus, only one buffer can have an overlay arrow at any
|
|
551 given time.
|
|
552 @c !!! overlay-arrow-position: but the overlay string may remain in the display
|
|
553 @c of some other buffer until an update is required. This should be fixed
|
|
554 @c now. Is it?
|
|
555 @end defvar
|
|
556
|
21682
|
557 You can do a similar job by creating an overlay with a
|
12067
|
558 @code{before-string} property. @xref{Overlay Properties}.
|
|
559
|
6598
|
560 @node Temporary Displays
|
|
561 @section Temporary Displays
|
|
562
|
21682
|
563 Temporary displays are used by Lisp programs to put output into a
|
|
564 buffer and then present it to the user for perusal rather than for
|
|
565 editing. Many help commands use this feature.
|
6598
|
566
|
|
567 @defspec with-output-to-temp-buffer buffer-name forms@dots{}
|
24951
|
568 This function executes @var{forms} while arranging to insert any output
|
|
569 they print into the buffer named @var{buffer-name}, which is first
|
|
570 created if necessary, and put into Help mode. Finally, the buffer is
|
|
571 displayed in some window, but not selected.
|
|
572
|
|
573 If the @var{forms} do not change the major mode in the output buffer, so
|
|
574 that it is still Help mode at the end of their execution, then
|
|
575 @code{with-output-to-temp-buffer} makes this buffer read-only at the
|
|
576 end, and also scans it for function and variable names to make them into
|
|
577 clickable cross-references.
|
6598
|
578
|
|
579 The string @var{buffer-name} specifies the temporary buffer, which
|
|
580 need not already exist. The argument must be a string, not a buffer.
|
|
581 The buffer is erased initially (with no questions asked), and it is
|
|
582 marked as unmodified after @code{with-output-to-temp-buffer} exits.
|
|
583
|
|
584 @code{with-output-to-temp-buffer} binds @code{standard-output} to the
|
|
585 temporary buffer, then it evaluates the forms in @var{forms}. Output
|
|
586 using the Lisp output functions within @var{forms} goes by default to
|
|
587 that buffer (but screen display and messages in the echo area, although
|
|
588 they are ``output'' in the general sense of the word, are not affected).
|
|
589 @xref{Output Functions}.
|
|
590
|
24951
|
591 Several hooks are available for customizing the behavior
|
|
592 of this construct; they are listed below.
|
|
593
|
6598
|
594 The value of the last form in @var{forms} is returned.
|
|
595
|
|
596 @example
|
|
597 @group
|
|
598 ---------- Buffer: foo ----------
|
|
599 This is the contents of foo.
|
|
600 ---------- Buffer: foo ----------
|
|
601 @end group
|
|
602
|
|
603 @group
|
|
604 (with-output-to-temp-buffer "foo"
|
|
605 (print 20)
|
|
606 (print standard-output))
|
|
607 @result{} #<buffer foo>
|
|
608
|
|
609 ---------- Buffer: foo ----------
|
|
610 20
|
|
611
|
|
612 #<buffer foo>
|
|
613
|
|
614 ---------- Buffer: foo ----------
|
|
615 @end group
|
|
616 @end example
|
|
617 @end defspec
|
|
618
|
|
619 @defvar temp-buffer-show-function
|
9009
|
620 If this variable is non-@code{nil}, @code{with-output-to-temp-buffer}
|
6598
|
621 calls it as a function to do the job of displaying a help buffer. The
|
|
622 function gets one argument, which is the buffer it should display.
|
22138
|
623
|
|
624 It is a good idea for this function to run @code{temp-buffer-show-hook}
|
|
625 just as @code{with-output-to-temp-buffer} normally would, inside of
|
24951
|
626 @code{save-selected-window} and with the chosen window and buffer
|
22138
|
627 selected.
|
|
628 @end defvar
|
|
629
|
24951
|
630 @defvar temp-buffer-setup-hook
|
|
631 @tindex temp-buffer-setup-hook
|
|
632 This normal hook is run by @code{with-output-to-temp-buffer} before
|
|
633 evaluating @var{body}. When the hook runs, the help buffer is current.
|
|
634 This hook is normally set up with a function to put the buffer in Help
|
|
635 mode.
|
|
636 @end defvar
|
|
637
|
22138
|
638 @defvar temp-buffer-show-hook
|
|
639 This normal hook is run by @code{with-output-to-temp-buffer} after
|
|
640 displaying the help buffer. When the hook runs, the help buffer is
|
24951
|
641 current, and the window it was displayed in is selected. This hook is
|
|
642 normally set up with a function to make the buffer read only, and find
|
|
643 function names and variable names in it, provided the major mode is
|
|
644 still Help mode.
|
6598
|
645 @end defvar
|
|
646
|
|
647 @defun momentary-string-display string position &optional char message
|
|
648 This function momentarily displays @var{string} in the current buffer at
|
|
649 @var{position}. It has no effect on the undo list or on the buffer's
|
|
650 modification status.
|
|
651
|
|
652 The momentary display remains until the next input event. If the next
|
|
653 input event is @var{char}, @code{momentary-string-display} ignores it
|
|
654 and returns. Otherwise, that event remains buffered for subsequent use
|
|
655 as input. Thus, typing @var{char} will simply remove the string from
|
|
656 the display, while typing (say) @kbd{C-f} will remove the string from
|
|
657 the display and later (presumably) move point forward. The argument
|
|
658 @var{char} is a space by default.
|
|
659
|
|
660 The return value of @code{momentary-string-display} is not meaningful.
|
|
661
|
12098
|
662 If the string @var{string} does not contain control characters, you can
|
21682
|
663 do the same job in a more general way by creating (and then subsequently
|
|
664 deleting) an overlay with a @code{before-string} property.
|
|
665 @xref{Overlay Properties}.
|
12098
|
666
|
6598
|
667 If @var{message} is non-@code{nil}, it is displayed in the echo area
|
|
668 while @var{string} is displayed in the buffer. If it is @code{nil}, a
|
|
669 default message says to type @var{char} to continue.
|
|
670
|
|
671 In this example, point is initially located at the beginning of the
|
|
672 second line:
|
|
673
|
|
674 @example
|
|
675 @group
|
|
676 ---------- Buffer: foo ----------
|
|
677 This is the contents of foo.
|
|
678 @point{}Second line.
|
|
679 ---------- Buffer: foo ----------
|
|
680 @end group
|
|
681
|
|
682 @group
|
|
683 (momentary-string-display
|
|
684 "**** Important Message! ****"
|
|
685 (point) ?\r
|
|
686 "Type RET when done reading")
|
|
687 @result{} t
|
|
688 @end group
|
|
689
|
|
690 @group
|
|
691 ---------- Buffer: foo ----------
|
|
692 This is the contents of foo.
|
|
693 **** Important Message! ****Second line.
|
|
694 ---------- Buffer: foo ----------
|
|
695
|
|
696 ---------- Echo Area ----------
|
|
697 Type RET when done reading
|
|
698 ---------- Echo Area ----------
|
|
699 @end group
|
|
700 @end example
|
|
701 @end defun
|
|
702
|
|
703 @node Overlays
|
|
704 @section Overlays
|
|
705 @cindex overlays
|
|
706
|
|
707 You can use @dfn{overlays} to alter the appearance of a buffer's text on
|
12098
|
708 the screen, for the sake of presentation features. An overlay is an
|
|
709 object that belongs to a particular buffer, and has a specified
|
|
710 beginning and end. It also has properties that you can examine and set;
|
|
711 these affect the display of the text within the overlay.
|
6598
|
712
|
|
713 @menu
|
|
714 * Overlay Properties:: How to read and set properties.
|
|
715 What properties do to the screen display.
|
26698
|
716 * Managing Overlays:: Creating and moving overlays.
|
|
717 * Finding Overlays:: Searching for overlays.
|
6598
|
718 @end menu
|
|
719
|
|
720 @node Overlay Properties
|
|
721 @subsection Overlay Properties
|
|
722
|
25751
|
723 Overlay properties are like text properties in that the properties that
|
22138
|
724 alter how a character is displayed can come from either source. But in
|
|
725 most respects they are different. Text properties are considered a part
|
|
726 of the text; overlays are specifically considered not to be part of the
|
|
727 text. Thus, copying text between various buffers and strings preserves
|
|
728 text properties, but does not try to preserve overlays. Changing a
|
|
729 buffer's text properties marks the buffer as modified, while moving an
|
|
730 overlay or changing its properties does not. Unlike text property
|
|
731 changes, overlay changes are not recorded in the buffer's undo list.
|
|
732 @xref{Text Properties}, for comparison.
|
6598
|
733
|
25751
|
734 These functions are used for reading and writing the properties of an
|
|
735 overlay:
|
|
736
|
|
737 @defun overlay-get overlay prop
|
|
738 This function returns the value of property @var{prop} recorded in
|
|
739 @var{overlay}, if any. If @var{overlay} does not record any value for
|
|
740 that property, but it does have a @code{category} property which is a
|
|
741 symbol, that symbol's @var{prop} property is used. Otherwise, the value
|
|
742 is @code{nil}.
|
|
743 @end defun
|
|
744
|
|
745 @defun overlay-put overlay prop value
|
|
746 This function sets the value of property @var{prop} recorded in
|
|
747 @var{overlay} to @var{value}. It returns @var{value}.
|
|
748 @end defun
|
|
749
|
|
750 See also the function @code{get-char-property} which checks both
|
|
751 overlay properties and text properties for a given character.
|
|
752 @xref{Examining Properties}.
|
|
753
|
|
754 Many overlay properties have special meanings; here is a table
|
|
755 of them:
|
|
756
|
6598
|
757 @table @code
|
|
758 @item priority
|
|
759 @kindex priority @r{(overlay property)}
|
|
760 This property's value (which should be a nonnegative number) determines
|
|
761 the priority of the overlay. The priority matters when two or more
|
|
762 overlays cover the same character and both specify a face for display;
|
|
763 the one whose @code{priority} value is larger takes priority over the
|
|
764 other, and its face attributes override the face attributes of the lower
|
|
765 priority overlay.
|
|
766
|
|
767 Currently, all overlays take priority over text properties. Please
|
|
768 avoid using negative priority values, as we have not yet decided just
|
|
769 what they should mean.
|
|
770
|
|
771 @item window
|
|
772 @kindex window @r{(overlay property)}
|
|
773 If the @code{window} property is non-@code{nil}, then the overlay
|
|
774 applies only on that window.
|
|
775
|
12067
|
776 @item category
|
|
777 @kindex category @r{(overlay property)}
|
|
778 If an overlay has a @code{category} property, we call it the
|
12098
|
779 @dfn{category} of the overlay. It should be a symbol. The properties
|
12067
|
780 of the symbol serve as defaults for the properties of the overlay.
|
|
781
|
6598
|
782 @item face
|
|
783 @kindex face @r{(overlay property)}
|
21007
|
784 This property controls the way text is displayed---for example, which
|
25751
|
785 font and which colors. @xref{Faces}, for more information.
|
|
786
|
|
787 In the simplest case, the value is a face name. It can also be a list;
|
25875
|
788 then each element can be any of these possibilities:
|
25751
|
789
|
|
790 @itemize @bullet
|
|
791 @item
|
|
792 A face name (a symbol or string).
|
|
793
|
|
794 @item
|
|
795 Starting in Emacs 21, a property list of face attributes. This has the
|
|
796 form (@var{keyword} @var{value} @dots{}), where each @var{keyword} is a
|
|
797 face attribute name and @var{value} is a meaningful value for that
|
|
798 attribute. With this feature, you do not need to create a face each
|
|
799 time you want to specify a particular attribute for certain text.
|
|
800 @xref{Face Attributes}.
|
|
801
|
|
802 @item
|
|
803 A cons cell of the form @code{(foreground-color . @var{color-name})} or
|
|
804 @code{(background-color . @var{color-name})}. These elements specify
|
|
805 just the foreground color or just the background color.
|
|
806
|
|
807 @code{(foreground-color . @var{color-name})} is equivalent to
|
|
808 @code{(:foreground @var{color-name})}, and likewise for the background.
|
|
809 @end itemize
|
6598
|
810
|
|
811 @item mouse-face
|
|
812 @kindex mouse-face @r{(overlay property)}
|
|
813 This property is used instead of @code{face} when the mouse is within
|
21007
|
814 the range of the overlay.
|
6598
|
815
|
25751
|
816 @item display
|
|
817 @kindex display @r{(overlay property)}
|
|
818 This property activates various features that change the
|
|
819 way text is displayed. For example, it can make text appear taller
|
|
820 or shorter, higher or lower, wider or narror, or replaced with an image.
|
|
821 @xref{Display Property}.
|
|
822
|
|
823 @item help-echo
|
|
824 @kindex help-echo @r{(text property)}
|
|
825 If an overlay has a string as its @code{help-echo} property, then when
|
|
826 you move the mouse onto the text in the overlay, Emacs displays that
|
25875
|
827 string in the echo area, or in the tooltip window. This feature is
|
|
828 available starting in Emacs 21.
|
25751
|
829
|
6598
|
830 @item modification-hooks
|
|
831 @kindex modification-hooks @r{(overlay property)}
|
|
832 This property's value is a list of functions to be called if any
|
|
833 character within the overlay is changed or if text is inserted strictly
|
12067
|
834 within the overlay.
|
|
835
|
|
836 The hook functions are called both before and after each change.
|
|
837 If the functions save the information they receive, and compare notes
|
|
838 between calls, they can determine exactly what change has been made
|
|
839 in the buffer text.
|
|
840
|
|
841 When called before a change, each function receives four arguments: the
|
|
842 overlay, @code{nil}, and the beginning and end of the text range to be
|
7086
|
843 modified.
|
6598
|
844
|
12067
|
845 When called after a change, each function receives five arguments: the
|
|
846 overlay, @code{t}, the beginning and end of the text range just
|
|
847 modified, and the length of the pre-change text replaced by that range.
|
|
848 (For an insertion, the pre-change length is zero; for a deletion, that
|
|
849 length is the number of characters deleted, and the post-change
|
12098
|
850 beginning and end are equal.)
|
12067
|
851
|
6598
|
852 @item insert-in-front-hooks
|
|
853 @kindex insert-in-front-hooks @r{(overlay property)}
|
12067
|
854 This property's value is a list of functions to be called before and
|
|
855 after inserting text right at the beginning of the overlay. The calling
|
|
856 conventions are the same as for the @code{modification-hooks} functions.
|
6598
|
857
|
|
858 @item insert-behind-hooks
|
|
859 @kindex insert-behind-hooks @r{(overlay property)}
|
12067
|
860 This property's value is a list of functions to be called before and
|
|
861 after inserting text right at the end of the overlay. The calling
|
|
862 conventions are the same as for the @code{modification-hooks} functions.
|
6598
|
863
|
|
864 @item invisible
|
|
865 @kindex invisible @r{(overlay property)}
|
12067
|
866 The @code{invisible} property can make the text in the overlay
|
|
867 invisible, which means that it does not appear on the screen.
|
|
868 @xref{Invisible Text}, for details.
|
|
869
|
|
870 @item intangible
|
|
871 @kindex intangible @r{(overlay property)}
|
|
872 The @code{intangible} property on an overlay works just like the
|
12098
|
873 @code{intangible} text property. @xref{Special Properties}, for details.
|
21007
|
874
|
|
875 @item isearch-open-invisible
|
22138
|
876 This property tells incremental search how to make an invisible overlay
|
|
877 visible, permanently, if the final match overlaps it. @xref{Invisible
|
21007
|
878 Text}.
|
6598
|
879
|
22138
|
880 @item isearch-open-invisible-temporary
|
|
881 This property tells incremental search how to make an invisible overlay
|
|
882 visible, temporarily, during the search. @xref{Invisible Text}.
|
|
883
|
6598
|
884 @item before-string
|
|
885 @kindex before-string @r{(overlay property)}
|
|
886 This property's value is a string to add to the display at the beginning
|
|
887 of the overlay. The string does not appear in the buffer in any
|
25875
|
888 sense---only on the screen.
|
6598
|
889
|
|
890 @item after-string
|
|
891 @kindex after-string @r{(overlay property)}
|
|
892 This property's value is a string to add to the display at the end of
|
|
893 the overlay. The string does not appear in the buffer in any
|
25875
|
894 sense---only on the screen.
|
12067
|
895
|
|
896 @item evaporate
|
|
897 @kindex evaporate @r{(overlay property)}
|
|
898 If this property is non-@code{nil}, the overlay is deleted automatically
|
|
899 if it ever becomes empty (i.e., if it spans no characters).
|
16123
|
900
|
29102
|
901 @item local-map
|
29076
|
902 @cindex keymap of character (and overlays)
|
29102
|
903 @kindex local-map @r{(overlay property)}
|
29076
|
904 If this property is non-@code{nil}, it specifies a keymap for a portion
|
|
905 of the text. The property's value replaces the buffer's local map, when
|
|
906 the character after point is within the overlay. @xref{Active Keymaps}.
|
|
907 @end table
|
|
908
|
6598
|
909 @node Managing Overlays
|
|
910 @subsection Managing Overlays
|
|
911
|
|
912 This section describes the functions to create, delete and move
|
|
913 overlays, and to examine their contents.
|
|
914
|
21007
|
915 @defun make-overlay start end &optional buffer front-advance rear-advance
|
9009
|
916 This function creates and returns an overlay that belongs to
|
6598
|
917 @var{buffer} and ranges from @var{start} to @var{end}. Both @var{start}
|
|
918 and @var{end} must specify buffer positions; they may be integers or
|
|
919 markers. If @var{buffer} is omitted, the overlay is created in the
|
|
920 current buffer.
|
21007
|
921
|
|
922 The arguments @var{front-advance} and @var{rear-advance} specify the
|
|
923 insertion type for the start of the overlay and for the end of the
|
26696
|
924 overlay, respectively. @xref{Marker Insertion Types}.
|
6598
|
925 @end defun
|
|
926
|
|
927 @defun overlay-start overlay
|
21007
|
928 This function returns the position at which @var{overlay} starts,
|
|
929 as an integer.
|
6598
|
930 @end defun
|
|
931
|
|
932 @defun overlay-end overlay
|
21007
|
933 This function returns the position at which @var{overlay} ends,
|
|
934 as an integer.
|
6598
|
935 @end defun
|
|
936
|
|
937 @defun overlay-buffer overlay
|
|
938 This function returns the buffer that @var{overlay} belongs to.
|
|
939 @end defun
|
|
940
|
|
941 @defun delete-overlay overlay
|
|
942 This function deletes @var{overlay}. The overlay continues to exist as
|
26696
|
943 a Lisp object, and its property list is unchanged, but it ceases to be
|
|
944 attached to the buffer it belonged to, and ceases to have any effect on
|
|
945 display.
|
|
946
|
|
947 A deleted overlay is not permanently disconnected. You can give it a
|
|
948 position in a buffer again by calling @code{move-overlay}.
|
6598
|
949 @end defun
|
|
950
|
|
951 @defun move-overlay overlay start end &optional buffer
|
|
952 This function moves @var{overlay} to @var{buffer}, and places its bounds
|
|
953 at @var{start} and @var{end}. Both arguments @var{start} and @var{end}
|
26696
|
954 must specify buffer positions; they may be integers or markers.
|
|
955
|
|
956 If @var{buffer} is omitted, @var{overlay} stays in the same buffer it
|
|
957 was already associated with; if @var{overlay} was deleted, it goes into
|
|
958 the current buffer.
|
6598
|
959
|
|
960 The return value is @var{overlay}.
|
|
961
|
|
962 This is the only valid way to change the endpoints of an overlay. Do
|
|
963 not try modifying the markers in the overlay by hand, as that fails to
|
|
964 update other vital data structures and can cause some overlays to be
|
|
965 ``lost''.
|
|
966 @end defun
|
|
967
|
26696
|
968 Here are some examples:
|
|
969
|
|
970 @example
|
|
971 ;; @r{Create an overlay.}
|
|
972 (setq foo (make-overlay 1 10))
|
|
973 @result{} #<overlay from 1 to 10 in display.texi>
|
|
974 (overlay-start foo)
|
|
975 @result{} 1
|
|
976 (overlay-end foo)
|
|
977 @result{} 10
|
|
978 (overlay-buffer foo)
|
|
979 @result{} #<buffer display.texi>
|
|
980 ;; @r{Give it a property we can check later.}
|
|
981 (overlay-put foo 'happy t)
|
|
982 @result{} t
|
|
983 ;; @r{Verify the property is present.}
|
|
984 (overlay-get foo 'happy)
|
|
985 @result{} t
|
|
986 ;; @r{Move the overlay.}
|
|
987 (move-overlay foo 5 20)
|
|
988 @result{} #<overlay from 5 to 20 in display.texi>
|
|
989 (overlay-start foo)
|
|
990 @result{} 5
|
|
991 (overlay-end foo)
|
|
992 @result{} 20
|
|
993 ;; @r{Delete the overlay.}
|
|
994 (delete-overlay foo)
|
|
995 @result{} nil
|
|
996 ;; @r{Verify it is deleted.}
|
|
997 foo
|
|
998 @result{} #<overlay in no buffer>
|
|
999 ;; @r{A deleted overlay has no position.}
|
|
1000 (overlay-start foo)
|
|
1001 @result{} nil
|
|
1002 (overlay-end foo)
|
|
1003 @result{} nil
|
|
1004 (overlay-buffer foo)
|
|
1005 @result{} nil
|
|
1006 ;; @r{Undelete the overlay.}
|
|
1007 (move-overlay foo 1 20)
|
|
1008 @result{} #<overlay from 1 to 20 in display.texi>
|
|
1009 ;; @r{Verify the results.}
|
|
1010 (overlay-start foo)
|
|
1011 @result{} 1
|
|
1012 (overlay-end foo)
|
|
1013 @result{} 20
|
|
1014 (overlay-buffer foo)
|
|
1015 @result{} #<buffer display.texi>
|
27331
|
1016 ;; @r{Moving and deleting the overlay does not change its properties.}
|
26696
|
1017 (overlay-get foo 'happy)
|
|
1018 @result{} t
|
|
1019 @end example
|
|
1020
|
|
1021 @node Finding Overlays
|
|
1022 @subsection Searching for Overlays
|
|
1023
|
6598
|
1024 @defun overlays-at pos
|
26696
|
1025 This function returns a list of all the overlays that cover the
|
|
1026 character at position @var{pos} in the current buffer. The list is in
|
|
1027 no particular order. An overlay contains position @var{pos} if it
|
|
1028 begins at or before @var{pos}, and ends after @var{pos}.
|
|
1029
|
|
1030 To illustrate usage, here is a Lisp function that returns a list of the
|
|
1031 overlays that specify property @var{prop} for the character at point:
|
|
1032
|
|
1033 @smallexample
|
|
1034 (defun find-overlays-specifying (prop)
|
|
1035 (let ((overlays (overlays-at (point)))
|
|
1036 found)
|
|
1037 (while overlays
|
|
1038 (let ((overlay (cdr overlays)))
|
|
1039 (if (overlay-get overlay prop)
|
|
1040 (setq found (cons overlay found))))
|
|
1041 (setq overlays (cdr overlays)))
|
|
1042 found))
|
|
1043 @end smallexample
|
6598
|
1044 @end defun
|
|
1045
|
22138
|
1046 @defun overlays-in beg end
|
21007
|
1047 This function returns a list of the overlays that overlap the region
|
|
1048 @var{beg} through @var{end}. ``Overlap'' means that at least one
|
|
1049 character is contained within the overlay and also contained within the
|
|
1050 specified region; however, empty overlays are included in the result if
|
26696
|
1051 they are located at @var{beg}, or strictly between @var{beg} and @var{end}.
|
21007
|
1052 @end defun
|
|
1053
|
6598
|
1054 @defun next-overlay-change pos
|
|
1055 This function returns the buffer position of the next beginning or end
|
|
1056 of an overlay, after @var{pos}.
|
|
1057 @end defun
|
|
1058
|
12067
|
1059 @defun previous-overlay-change pos
|
|
1060 This function returns the buffer position of the previous beginning or
|
|
1061 end of an overlay, before @var{pos}.
|
|
1062 @end defun
|
|
1063
|
26696
|
1064 Here's an easy way to use @code{next-overlay-change} to search for the
|
|
1065 next character which gets a non-@code{nil} @code{happy} property from
|
|
1066 either its overlays or its text properties (@pxref{Property Search}):
|
|
1067
|
|
1068 @smallexample
|
|
1069 (defun find-overlay-prop (prop)
|
|
1070 (save-excursion
|
|
1071 (while (and (not (eobp))
|
|
1072 (not (get-char-property (point) 'happy)))
|
|
1073 (goto-char (min (next-overlay-change (point))
|
|
1074 (next-single-property-change (point) 'happy))))
|
|
1075 (point)))
|
|
1076 @end smallexample
|
|
1077
|
21007
|
1078 @node Width
|
|
1079 @section Width
|
|
1080
|
|
1081 Since not all characters have the same width, these functions let you
|
21682
|
1082 check the width of a character. @xref{Primitive Indent}, and
|
|
1083 @ref{Screen Lines}, for related functions.
|
21007
|
1084
|
22138
|
1085 @defun char-width char
|
21007
|
1086 This function returns the width in columns of the character @var{char},
|
|
1087 if it were displayed in the current buffer and the selected window.
|
|
1088 @end defun
|
|
1089
|
22138
|
1090 @defun string-width string
|
21007
|
1091 This function returns the width in columns of the string @var{string},
|
|
1092 if it were displayed in the current buffer and the selected window.
|
|
1093 @end defun
|
|
1094
|
22138
|
1095 @defun truncate-string-to-width string width &optional start-column padding
|
21007
|
1096 This function returns the part of @var{string} that fits within
|
|
1097 @var{width} columns, as a new string.
|
|
1098
|
|
1099 If @var{string} does not reach @var{width}, then the result ends where
|
|
1100 @var{string} ends. If one multi-column character in @var{string}
|
|
1101 extends across the column @var{width}, that character is not included in
|
|
1102 the result. Thus, the result can fall short of @var{width} but cannot
|
|
1103 go beyond it.
|
|
1104
|
|
1105 The optional argument @var{start-column} specifies the starting column.
|
|
1106 If this is non-@code{nil}, then the first @var{start-column} columns of
|
|
1107 the string are omitted from the value. If one multi-column character in
|
|
1108 @var{string} extends across the column @var{start-column}, that
|
|
1109 character is not included.
|
|
1110
|
|
1111 The optional argument @var{padding}, if non-@code{nil}, is a padding
|
|
1112 character added at the beginning and end of the result string, to extend
|
|
1113 it to exactly @var{width} columns. The padding character is used at the
|
|
1114 end of the result if it falls short of @var{width}. It is also used at
|
|
1115 the beginning of the result if one multi-column character in
|
|
1116 @var{string} extends across the column @var{start-column}.
|
|
1117
|
|
1118 @example
|
|
1119 (truncate-string-to-width "\tab\t" 12 4)
|
|
1120 @result{} "ab"
|
|
1121 (truncate-string-to-width "\tab\t" 12 4 ?\ )
|
|
1122 @result{} " ab "
|
|
1123 @end example
|
|
1124 @end defun
|
|
1125
|
6598
|
1126 @node Faces
|
|
1127 @section Faces
|
|
1128 @cindex face
|
|
1129
|
25751
|
1130 A @dfn{face} is a named collection of graphical attributes: font
|
|
1131 family, foreground color, background color, optional underlining, and
|
|
1132 many others. Faces are used in Emacs to control the style of display of
|
|
1133 particular parts of the text or the frame.
|
6598
|
1134
|
|
1135 @cindex face id
|
21682
|
1136 Each face has its own @dfn{face number}, which distinguishes faces at
|
25751
|
1137 low levels within Emacs. However, for most purposes, you refer to
|
6598
|
1138 faces in Lisp programs by their names.
|
|
1139
|
12067
|
1140 @defun facep object
|
|
1141 This function returns @code{t} if @var{object} is a face name symbol (or
|
|
1142 if it is a vector of the kind used internally to record face data). It
|
|
1143 returns @code{nil} otherwise.
|
|
1144 @end defun
|
|
1145
|
6598
|
1146 Each face name is meaningful for all frames, and by default it has the
|
|
1147 same meaning in all frames. But you can arrange to give a particular
|
|
1148 face name a special meaning in one frame if you wish.
|
|
1149
|
|
1150 @menu
|
|
1151 * Standard Faces:: The faces Emacs normally comes with.
|
21682
|
1152 * Defining Faces:: How to define a face with @code{defface}.
|
25751
|
1153 * Face Attributes:: What is in a face?
|
|
1154 * Attribute Functions:: Functions to examine and set face attributes.
|
|
1155 * Merging Faces:: How Emacs combines the faces specified for a character.
|
|
1156 * Font Selection:: Finding the best available font for a face.
|
6598
|
1157 * Face Functions:: How to define and examine faces.
|
25751
|
1158 * Auto Faces:: Hook for automatic face assignment.
|
|
1159 * Font Lookup:: Looking up the names of available fonts
|
|
1160 and information about them.
|
|
1161 * Fontsets:: A fontset is a collection of fonts
|
|
1162 that handle a range of character sets.
|
6598
|
1163 @end menu
|
|
1164
|
|
1165 @node Standard Faces
|
|
1166 @subsection Standard Faces
|
|
1167
|
25751
|
1168 This table lists all the standard faces and their uses. Most of them
|
|
1169 are used for displaying certain parts of the frames or certain kinds of
|
|
1170 text; you can control how those places look by customizing these faces.
|
6598
|
1171
|
|
1172 @table @code
|
|
1173 @item default
|
|
1174 @kindex default @r{(face name)}
|
|
1175 This face is used for ordinary text.
|
|
1176
|
25751
|
1177 @item mode-line
|
|
1178 @kindex mode-line @r{(face name)}
|
25875
|
1179 This face is used for mode lines, and for menu bars when toolkit menus
|
|
1180 are not used---but only if @code{mode-line-inverse-video} is
|
|
1181 non-@code{nil}.
|
25751
|
1182
|
6598
|
1183 @item modeline
|
|
1184 @kindex modeline @r{(face name)}
|
25751
|
1185 This is an alias for the @code{mode-line} face, for compatibility with
|
|
1186 old Emacs versions.
|
|
1187
|
|
1188 @item header-line
|
|
1189 @kindex header-line @r{(face name)}
|
|
1190 This face is used for the header lines of windows that have them.
|
|
1191
|
25875
|
1192 @item menu
|
|
1193 This face controls the display of menus, both their colors and their
|
|
1194 font. (This works only on certain systems.)
|
|
1195
|
25751
|
1196 @item fringe
|
|
1197 @kindex fringe @r{(face name)}
|
|
1198 This face controls the colors of window fringes, the thin areas on
|
|
1199 either side that are used to display continuation and truncation glyphs.
|
|
1200
|
|
1201 @item scroll-bar
|
|
1202 @kindex scroll-bar @r{(face name)}
|
|
1203 This face controls the colors for display of scroll bars.
|
|
1204
|
|
1205 @item tool-bar
|
|
1206 @kindex tool-bar @r{(face name)}
|
|
1207 This face is used for display of the tool bar, if any.
|
6598
|
1208
|
|
1209 @item region
|
|
1210 @kindex region @r{(face name)}
|
|
1211 This face is used for highlighting the region in Transient Mark mode.
|
|
1212
|
|
1213 @item secondary-selection
|
|
1214 @kindex secondary-selection @r{(face name)}
|
|
1215 This face is used to show any secondary selection you have made.
|
|
1216
|
|
1217 @item highlight
|
|
1218 @kindex highlight @r{(face name)}
|
|
1219 This face is meant to be used for highlighting for various purposes.
|
|
1220
|
25751
|
1221 @item trailing-whitespace
|
|
1222 @kindex trailing-whitespace @r{(face name)}
|
25875
|
1223 This face is used to display excess whitespace at the end of a line,
|
|
1224 if @code{show-trailing-whitespace} is non-@code{nil}.
|
25751
|
1225 @end table
|
|
1226
|
|
1227 In contrast, these faces are provided to change the appearance of text
|
|
1228 in specific ways. You can use them on specific text, when you want
|
|
1229 the effects they produce.
|
|
1230
|
|
1231 @table @code
|
6598
|
1232 @item bold
|
|
1233 @kindex bold @r{(face name)}
|
|
1234 This face uses a bold font, if possible. It uses the bold variant of
|
|
1235 the frame's font, if it has one. It's up to you to choose a default
|
|
1236 font that has a bold variant, if you want to use one.
|
|
1237
|
|
1238 @item italic
|
|
1239 @kindex italic @r{(face name)}
|
|
1240 This face uses the italic variant of the frame's font, if it has one.
|
|
1241
|
|
1242 @item bold-italic
|
|
1243 @kindex bold-italic @r{(face name)}
|
|
1244 This face uses the bold italic variant of the frame's font, if it has
|
|
1245 one.
|
25751
|
1246
|
|
1247 @item underline
|
|
1248 @kindex underline @r{(face name)}
|
|
1249 This face underlines text.
|
|
1250
|
|
1251 @item fixed-patch
|
|
1252 @kindex fixed-patch @r{(face name)}
|
|
1253 This face forces use of a particular fixed-width font.
|
|
1254
|
|
1255 @item variable-patch
|
|
1256 @kindex variable-patch @r{(face name)}
|
|
1257 This face forces use of a particular variable-width font. It's
|
25875
|
1258 reasonable to customize this to use a different variable-width font, if
|
25751
|
1259 you like, but you should not make it a fixed-width font.
|
6598
|
1260 @end table
|
|
1261
|
25875
|
1262 @defvar show-trailing-whitespace
|
|
1263 @tindex show-trailing-whitespace
|
|
1264 If this variable is non-@code{nil}, Emacs uses the
|
|
1265 @code{trailing-whitespace} face to display any spaces and tabs at the
|
|
1266 end of a line.
|
|
1267 @end defvar
|
|
1268
|
21682
|
1269 @node Defining Faces
|
22138
|
1270 @subsection Defining Faces
|
21682
|
1271
|
|
1272 The way to define a new face is with @code{defface}. This creates a
|
|
1273 kind of customization item (@pxref{Customization}) which the user can
|
|
1274 customize using the Customization buffer (@pxref{Easy Customization,,,
|
|
1275 emacs, The GNU Emacs Manual}).
|
|
1276
|
22138
|
1277 @defmac defface face spec doc [keyword value]...
|
25875
|
1278 This declares @var{face} as a customizable face that defaults according
|
|
1279 to @var{spec}. You should not quote the symbol @var{face}. The
|
|
1280 argument @var{doc} specifies the face documentation. The keywords you
|
|
1281 can use in @code{defface} are the same ones that are meaningful in both
|
|
1282 @code{defgroup} and @code{defcustom} (@pxref{Common Keywords}).
|
21682
|
1283
|
|
1284 When @code{defface} executes, it defines the face according to
|
22138
|
1285 @var{spec}, then uses any customizations that were read from the
|
25875
|
1286 init file (@pxref{Init File}) to override that specification.
|
21682
|
1287
|
|
1288 The purpose of @var{spec} is to specify how the face should appear on
|
|
1289 different kinds of terminals. It should be an alist whose elements have
|
25875
|
1290 the form @code{(@var{display} @var{atts})}. Each element's @sc{car},
|
|
1291 @var{display}, specifies a class of terminals. The element's second element,
|
21682
|
1292 @var{atts}, is a list of face attributes and their values; it specifies
|
|
1293 what the face should look like on that kind of terminal. The possible
|
|
1294 attributes are defined in the value of @code{custom-face-attributes}.
|
|
1295
|
|
1296 The @var{display} part of an element of @var{spec} determines which
|
|
1297 frames the element applies to. If more than one element of @var{spec}
|
|
1298 matches a given frame, the first matching element is the only one used
|
|
1299 for that frame. There are two possibilities for @var{display}:
|
|
1300
|
|
1301 @table @asis
|
|
1302 @item @code{t}
|
|
1303 This element of @var{spec} matches all frames. Therefore, any
|
|
1304 subsequent elements of @var{spec} are never used. Normally
|
|
1305 @code{t} is used in the last (or only) element of @var{spec}.
|
|
1306
|
22138
|
1307 @item a list
|
22252
|
1308 If @var{display} is a list, each element should have the form
|
21682
|
1309 @code{(@var{characteristic} @var{value}@dots{})}. Here
|
|
1310 @var{characteristic} specifies a way of classifying frames, and the
|
|
1311 @var{value}s are possible classifications which @var{display} should
|
|
1312 apply to. Here are the possible values of @var{characteristic}:
|
|
1313
|
|
1314 @table @code
|
|
1315 @item type
|
|
1316 The kind of window system the frame uses---either @code{x}, @code{pc}
|
|
1317 (for the MS-DOS console), @code{w32} (for MS Windows 9X/NT), or
|
|
1318 @code{tty}.
|
|
1319
|
|
1320 @item class
|
|
1321 What kinds of colors the frame supports---either @code{color},
|
|
1322 @code{grayscale}, or @code{mono}.
|
|
1323
|
|
1324 @item background
|
22252
|
1325 The kind of background---either @code{light} or @code{dark}.
|
21682
|
1326 @end table
|
|
1327
|
|
1328 If an element of @var{display} specifies more than one @var{value} for a
|
|
1329 given @var{characteristic}, any of those values is acceptable. If
|
|
1330 @var{display} has more than one element, each element should specify a
|
|
1331 different @var{characteristic}; then @emph{each} characteristic of the
|
|
1332 frame must match one of the @var{value}s specified for it in
|
|
1333 @var{display}.
|
|
1334 @end table
|
|
1335 @end defmac
|
|
1336
|
25875
|
1337 Here's how the standard face @code{region} is defined:
|
21682
|
1338
|
|
1339 @example
|
25875
|
1340 @group
|
21682
|
1341 (defface region
|
25875
|
1342 `((((type tty) (class color))
|
|
1343 (:background "blue" :foreground "white"))
|
|
1344 @end group
|
|
1345 (((type tty) (class mono))
|
|
1346 (:inverse-video t))
|
|
1347 (((class color) (background dark))
|
|
1348 (:background "blue"))
|
|
1349 (((class color) (background light))
|
|
1350 (:background "lightblue"))
|
|
1351 (t (:background "gray")))
|
|
1352 @group
|
|
1353 "Basic face for highlighting the region."
|
|
1354 :group 'basic-faces)
|
|
1355 @end group
|
21682
|
1356 @end example
|
|
1357
|
|
1358 Internally, @code{defface} uses the symbol property
|
|
1359 @code{face-defface-spec} to record the face attributes specified in
|
|
1360 @code{defface}, @code{saved-face} for the attributes saved by the user
|
|
1361 with the customization buffer, and @code{face-documentation} for the
|
|
1362 documentation string.
|
|
1363
|
22252
|
1364 @defopt frame-background-mode
|
|
1365 This option, if non-@code{nil}, specifies the background type to use for
|
|
1366 interpreting face definitions. If it is @code{dark}, then Emacs treats
|
|
1367 all frames as if they had a dark background, regardless of their actual
|
|
1368 background colors. If it is @code{light}, then Emacs treats all frames
|
|
1369 as if they had a light background.
|
|
1370 @end defopt
|
|
1371
|
25751
|
1372 @node Face Attributes
|
|
1373 @subsection Face Attributes
|
|
1374 @cindex face attributes
|
|
1375
|
|
1376 The effect of using a face is determined by a fixed set of @dfn{face
|
|
1377 attributes}. This table lists all the face attributes, and what they
|
25875
|
1378 mean. Note that in general, more than one face can be specified for a
|
|
1379 given piece of text; when that happens, the attributes of all the faces
|
|
1380 are merged to specify how to display the text. @xref{Merging Faces}.
|
25751
|
1381
|
|
1382 In Emacs 21, any attribute in a face can have the value
|
|
1383 @code{unspecified}. This means the face doesn't specify that attribute.
|
|
1384 In face merging, when the first face fails to specify a particular
|
|
1385 attribute, that means the next face gets a chance. However, the
|
|
1386 @code{default} face must specify all attributes.
|
|
1387
|
25875
|
1388 Some of these font attributes are meaningful only on certain kinds of
|
|
1389 displays---if your display cannot handle a certain attribute, the
|
|
1390 attribute is ignored. (The attributes @code{:family}, @code{:width},
|
|
1391 @code{:height}, @code{:weight}, and @code{:slant} correspond to parts of
|
|
1392 an X Logical Font Descriptor.)
|
25751
|
1393
|
|
1394 @table @code
|
|
1395 @item :family
|
|
1396 Font family name, or fontset name (@pxref{Fontsets}). If you specify a
|
25875
|
1397 font family name, the wild-card characters @samp{*} and @samp{?} are
|
|
1398 allowed.
|
25751
|
1399
|
|
1400 @item :width
|
|
1401 Relative proportionate width, also known as the character set width or
|
|
1402 set width. This should be one of the symbols @code{ultra-condensed},
|
|
1403 @code{extra-condensed}, @code{condensed}, @code{semi-condensed},
|
|
1404 @code{normal}, @code{semi-expanded}, @code{expanded},
|
|
1405 @code{extra-expanded}, or @code{ultra-expanded}.
|
|
1406
|
|
1407 @item :height
|
25875
|
1408 Font height, an integer in units of 1/10 point.
|
25751
|
1409
|
|
1410 @item :weight
|
|
1411 Font weight---a symbol from this series (from most dense to most faint):
|
|
1412 @code{ultra-bold}, @code{extra-bold}, @code{bold}, @code{semi-bold},
|
|
1413 @code{normal}, @code{semi-light}, @code{light}, @code{extra-light},
|
25875
|
1414 or @code{ultra-light}.
|
25809
|
1415
|
|
1416 On a text-only terminal, any weight greater than normal is displayed as
|
|
1417 extra bright, and any weight less than normal is displayed as
|
25875
|
1418 half-bright (provided the terminal supports the feature).
|
|
1419
|
25751
|
1420 @item :slant
|
|
1421 Font slant---one of the symbols @code{italic}, @code{oblique}, @code{normal},
|
|
1422 @code{reverse-italic}, or @code{reverse-oblique}.
|
25809
|
1423
|
|
1424 On a text-only terminal, slanted text is displayed as half-bright, if
|
|
1425 the terminal supports the feature.
|
|
1426
|
25751
|
1427 @item :foreground
|
|
1428 Foreground color, a string.
|
|
1429
|
|
1430 @item :background
|
|
1431 Background color, a string.
|
|
1432
|
|
1433 @item :inverse-video
|
|
1434 Whether or not characters should be displayed in inverse video. The
|
|
1435 value should be @code{t} (yes) or @code{nil} (no).
|
|
1436
|
|
1437 @item :stipple
|
25875
|
1438 The background stipple, a bitmap.
|
|
1439
|
|
1440 The value can be a string; that should be the name of a file containing
|
|
1441 external-format X bitmap data. The file is found in the directories
|
|
1442 listed in the variable @code{x-bitmap-file-path}.
|
|
1443
|
|
1444 Alternatively, the value can specify the bitmap directly, with a list of
|
|
1445 the form @code{(@var{width} @var{height} @var{data})}. Here,
|
|
1446 @var{width} and @var{height} specify the size in pixels, and @var{data}
|
|
1447 is a string containing the raw bits of the bitmap, row by row. Each row
|
|
1448 occupies @math{(@var{width} + 7) / 8} consecutie bytes in the string
|
|
1449 (which should be a unibyte string for best results).
|
25751
|
1450
|
|
1451 If the value is @code{nil}, that means use no stipple pattern.
|
|
1452
|
|
1453 Normally you do not need to set the stipple attribute, because it is
|
|
1454 used automatically to handle certain shades of gray.
|
|
1455
|
|
1456 @item :underline
|
|
1457 Whether or not characters should be underlined, and in what color. If
|
|
1458 the value is @code{t}, underlining uses the foreground color of the
|
|
1459 face. If the value is a string, underlining uses that color. The
|
|
1460 value @code{nil} means do not underline.
|
|
1461
|
|
1462 @item :overline
|
|
1463 Whether or not characters should be overlined, and in what color.
|
|
1464 The value is used like that of @code{:underline}.
|
|
1465
|
|
1466 @item :strike-through
|
|
1467 Whether or not characters should be strike-through, and in what
|
|
1468 color. The value is used like that of @code{:underline}.
|
|
1469
|
|
1470 @item :box
|
|
1471 Whether or not a box should be drawn around characters, its color, the
|
25875
|
1472 width of the box lines, and 3D appearance.
|
25751
|
1473 @end table
|
|
1474
|
|
1475 Here are the possible values of the @code{:box} attribute, and what
|
|
1476 they mean:
|
|
1477
|
|
1478 @table @asis
|
|
1479 @item @code{nil}
|
|
1480 Don't draw a box.
|
|
1481
|
|
1482 @item @code{t}
|
|
1483 Draw a box with lines of width 1, in the foreground color.
|
|
1484
|
|
1485 @item @var{color}
|
|
1486 Draw a box with lines of width 1, in color @var{color}.
|
|
1487
|
|
1488 @item @code{(:line-width @var{width} :color @var{color} :style @var{style})}
|
|
1489 This way you can explicitly specify all aspects of the box. The value
|
|
1490 @var{width} specifies the width of the lines to draw; it defaults to 1.
|
|
1491
|
|
1492 The value @var{color} specifies the color to draw with. The default is
|
|
1493 the foreground color of the face for simple boxes, and the background
|
|
1494 color of the face for 3D boxes.
|
|
1495
|
|
1496 The value @var{style} specifies whether to draw a 3D box. If it is
|
|
1497 @code{released-button}, the box looks like a 3D button that is not being
|
|
1498 pressed. If it is @code{pressed-button}, the box looks like a 3D button
|
|
1499 that is being pressed. If it is @code{nil} or omitted, a plain 2D box
|
|
1500 is used.
|
|
1501 @end table
|
|
1502
|
|
1503 The attributes @code{:overline}, @code{:strike-through} and
|
|
1504 @code{:box} are new in Emacs 21. The attributes @code{:family},
|
|
1505 @code{:height}, @code{:width}, @code{:weight}, @code{:slant} are also
|
25875
|
1506 new; previous versions used the following attributes, now semi-obsolete,
|
|
1507 to specify some of the same information:
|
25751
|
1508
|
|
1509 @table @code
|
|
1510 @item :font
|
25875
|
1511 This attribute specifies the font name.
|
25751
|
1512
|
|
1513 @item :bold
|
|
1514 A non-@code{nil} value specifies a bold font.
|
|
1515
|
|
1516 @item :italic
|
|
1517 A non-@code{nil} value specifies an italic font.
|
|
1518 @end table
|
|
1519
|
|
1520 For compatibility, you can still set these ``attributes'' in Emacs 21,
|
|
1521 even though they are not real face attributes. Here is what that does:
|
|
1522
|
|
1523 @table @code
|
|
1524 @item :font
|
25875
|
1525 You can specify an X font name as the ``value'' of this ``attribute'';
|
|
1526 that sets the @code{:family}, @code{:width}, @code{:height},
|
|
1527 @code{:weight}, and @code{:slant} attributes according to the font name.
|
25751
|
1528
|
|
1529 If the value is a pattern with wildcards, the first font that matches
|
|
1530 the pattern is used to set these attributes.
|
|
1531
|
|
1532 @item :bold
|
|
1533 A non-@code{nil} makes the face bold; @code{nil} makes it normal.
|
|
1534 This actually works by setting the @code{:weight} attribute.
|
|
1535
|
|
1536 @item :italic
|
|
1537 A non-@code{nil} makes the face italic; @code{nil} makes it normal.
|
|
1538 This actually works by setting the @code{:slant} attribute.
|
|
1539 @end table
|
|
1540
|
|
1541 @defvar x-bitmap-file-path
|
|
1542 This variable specifies a list of directories for searching
|
|
1543 for bitmap files, for the @code{:stipple} attribute.
|
|
1544 @end defvar
|
|
1545
|
25911
|
1546 @defun bitmap-spec-p object
|
25875
|
1547 This returns @code{t} if @var{object} is a valid bitmap
|
|
1548 specification, suitable for use with @code{:stipple}.
|
|
1549 It returns @code{nil} otherwise.
|
|
1550 @end defun
|
|
1551
|
25751
|
1552 @node Attribute Functions
|
|
1553 @subsection Face Attribute Functions
|
|
1554
|
|
1555 You can modify the attributes of an existing face with the following
|
|
1556 functions. If you specify @var{frame}, they affect just that frame;
|
|
1557 otherwise, they affect all frames as well as the defaults that apply to
|
|
1558 new frames.
|
|
1559
|
|
1560 @tindex set-face-attribute
|
|
1561 @defun set-face-attribute face frame &rest arguments
|
|
1562 This function sets one or more attributes of face @var{face}
|
|
1563 for frame @var{frame}. If @var{frame} is @code{nil}, it sets
|
|
1564 the attribute for all frames, and the defaults for new frames.
|
|
1565
|
|
1566 The extra arguments @var{arguments} specify the attributes to set, and
|
|
1567 the values for them. They should consist of alternating attribute names
|
25875
|
1568 (such as @code{:family} or @code{:underline}) and corresponding values.
|
25751
|
1569 Thus,
|
|
1570
|
|
1571 @example
|
|
1572 (set-face-attribute 'foo nil
|
|
1573 :width :extended
|
|
1574 :weight :bold
|
|
1575 :underline "red")
|
|
1576 @end example
|
|
1577
|
|
1578 @noindent
|
|
1579 sets the attributes @code{:width}, @code{:weight} and @code{:underline}
|
|
1580 to the corresponding values.
|
|
1581 @end defun
|
|
1582
|
|
1583 @tindex face-attribute
|
|
1584 @defun face-attribute face attribute &optional frame
|
|
1585 This returns the value of the @var{attribute} attribute of face
|
|
1586 @var{face} on @var{frame}. If @var{frame} is @code{nil},
|
|
1587 that means the selected frame.
|
|
1588
|
|
1589 If @var{frame} is @code{t}, the value is the default for
|
|
1590 @var{face} for new frames.
|
|
1591
|
|
1592 For example,
|
|
1593
|
|
1594 @example
|
|
1595 (face-attribute 'bold :weight)
|
|
1596 @result{} bold
|
|
1597 @end example
|
|
1598 @end defun
|
|
1599
|
25875
|
1600 The functions above did not exist before Emacs 21. For compatibility
|
|
1601 with older Emacs versions, you can use the following functions to set
|
25751
|
1602 and examine the face attributes which existed in those versions.
|
|
1603
|
|
1604 @defun set-face-foreground face color &optional frame
|
|
1605 @defunx set-face-background face color &optional frame
|
|
1606 These functions set the foreground (or background, respectively) color
|
|
1607 of face @var{face} to @var{color}. The argument @var{color} should be a
|
|
1608 string, the name of a color.
|
|
1609
|
|
1610 Certain shades of gray are implemented by stipple patterns on
|
|
1611 black-and-white screens.
|
|
1612 @end defun
|
|
1613
|
|
1614 @defun set-face-stipple face pattern &optional frame
|
|
1615 This function sets the background stipple pattern of face @var{face} to
|
|
1616 @var{pattern}. The argument @var{pattern} should be the name of a
|
|
1617 stipple pattern defined by the X server, or @code{nil} meaning don't use
|
|
1618 stipple.
|
|
1619
|
|
1620 Normally there is no need to pay attention to stipple patterns, because
|
|
1621 they are used automatically to handle certain shades of gray.
|
|
1622 @end defun
|
|
1623
|
|
1624 @defun set-face-font face font &optional frame
|
|
1625 This function sets the font of face @var{face}.
|
|
1626
|
|
1627 In Emacs 21, this actually sets the attributes @code{:family},
|
|
1628 @code{:width}, @code{:height}, @code{:weight}, and @code{:slant}
|
|
1629 according to the font name @var{font}.
|
|
1630
|
|
1631 In Emacs 20, this sets the font attribute. Once you set the font
|
|
1632 explicitly, the bold and italic attributes cease to have any effect,
|
|
1633 because the precise font that you specified is used.
|
|
1634 @end defun
|
|
1635
|
|
1636 @defun set-face-bold-p face bold-p &optional frame
|
|
1637 This function specifies whether @var{face} should be bold. If
|
|
1638 @var{bold-p} is non-@code{nil}, that means yes; @code{nil} means no.
|
|
1639
|
|
1640 In Emacs 21, this sets the @code{:weight} attribute.
|
|
1641 In Emacs 20, it sets the @code{:bold} attribute.
|
|
1642 @end defun
|
|
1643
|
|
1644 @defun set-face-italic-p face italic-p &optional frame
|
|
1645 This function specifies whether @var{face} should be italic. If
|
|
1646 @var{italic-p} is non-@code{nil}, that means yes; @code{nil} means no.
|
|
1647
|
|
1648 In Emacs 21, this sets the @code{:slant} attribute.
|
|
1649 In Emacs 20, it sets the @code{:italic} attribute.
|
|
1650 @end defun
|
|
1651
|
|
1652 @defun set-face-underline-p face underline-p &optional frame
|
|
1653 This function sets the underline attribute of face @var{face}.
|
|
1654 Non-@code{nil} means do underline; @code{nil} means don't.
|
|
1655 @end defun
|
|
1656
|
|
1657 @defun invert-face face &optional frame
|
|
1658 This function inverts the @code{:inverse-video} attribute of face
|
|
1659 @var{face}. If the attribute is @code{nil}, this function sets it to
|
|
1660 @code{t}, and vice versa.
|
|
1661 @end defun
|
|
1662
|
|
1663 These functions examine the attributes of a face. If you don't
|
|
1664 specify @var{frame}, they refer to the default data for new frames.
|
25875
|
1665 They return the symbol @code{unspecified} if the face doesn't define any
|
|
1666 value for that attribute.
|
25751
|
1667
|
|
1668 @defun face-foreground face &optional frame
|
|
1669 @defunx face-background face &optional frame
|
|
1670 These functions return the foreground color (or background color,
|
|
1671 respectively) of face @var{face}, as a string.
|
|
1672 @end defun
|
|
1673
|
|
1674 @defun face-stipple face &optional frame
|
|
1675 This function returns the name of the background stipple pattern of face
|
|
1676 @var{face}, or @code{nil} if it doesn't have one.
|
|
1677 @end defun
|
|
1678
|
|
1679 @defun face-font face &optional frame
|
|
1680 This function returns the name of the font of face @var{face}.
|
|
1681 @end defun
|
|
1682
|
|
1683 @defun face-bold-p face &optional frame
|
|
1684 This function returns @code{t} if @var{face} is bold---that is, if it is
|
|
1685 bolder than normal. It returns @code{nil} otherwise.
|
|
1686 @end defun
|
|
1687
|
|
1688 @defun face-italic-p face &optional frame
|
|
1689 This function returns @code{t} if @var{face} is italic or oblique,
|
|
1690 @code{nil} otherwise.
|
|
1691 @end defun
|
|
1692
|
|
1693 @defun face-underline-p face &optional frame
|
|
1694 This function returns the @code{:underline} attribute of face @var{face}.
|
|
1695 @end defun
|
|
1696
|
|
1697 @defun face-inverse-video-p face &optional frame
|
|
1698 This function returns the @code{:inverse-video} attribute of face @var{face}.
|
|
1699 @end defun
|
|
1700
|
6598
|
1701 @node Merging Faces
|
|
1702 @subsection Merging Faces for Display
|
|
1703
|
25751
|
1704 Here are the ways to specify which faces to use for display of text:
|
6598
|
1705
|
|
1706 @itemize @bullet
|
|
1707 @item
|
25751
|
1708 With defaults. The @code{default} face is used as the ultimate
|
|
1709 default for all text. (In Emacs 19 and 20, the @code{default}
|
|
1710 face is used only when no other face is specified.)
|
|
1711
|
|
1712 For a mode line or header line, the face @code{modeline} or
|
|
1713 @code{header-line} is used just before @code{default}.
|
6598
|
1714
|
|
1715 @item
|
25751
|
1716 With text properties. A character can have a @code{face} property; if
|
|
1717 so, the faces and face attributes specified there apply. @xref{Special
|
|
1718 Properties}.
|
6598
|
1719
|
|
1720 If the character has a @code{mouse-face} property, that is used instead
|
|
1721 of the @code{face} property when the mouse is ``near enough'' to the
|
|
1722 character.
|
|
1723
|
|
1724 @item
|
25751
|
1725 With overlays. An overlay can have @code{face} and @code{mouse-face}
|
6598
|
1726 properties too; they apply to all the text covered by the overlay.
|
|
1727
|
|
1728 @item
|
12098
|
1729 With a region that is active. In Transient Mark mode, the region is
|
25751
|
1730 highlighted with the face @code{region} (@pxref{Standard Faces}).
|
12098
|
1731
|
|
1732 @item
|
21682
|
1733 With special glyphs. Each glyph can specify a particular face
|
6598
|
1734 number. @xref{Glyphs}.
|
|
1735 @end itemize
|
|
1736
|
|
1737 If these various sources together specify more than one face for a
|
|
1738 particular character, Emacs merges the attributes of the various faces
|
|
1739 specified. The attributes of the faces of special glyphs come first;
|
12098
|
1740 then comes the face for region highlighting, if appropriate;
|
6598
|
1741 then come attributes of faces from overlays, followed by those from text
|
|
1742 properties, and last the default face.
|
|
1743
|
|
1744 When multiple overlays cover one character, an overlay with higher
|
|
1745 priority overrides those with lower priority. @xref{Overlays}.
|
|
1746
|
25751
|
1747 In Emacs 20, if an attribute such as the font or a color is not
|
|
1748 specified in any of the above ways, the frame's own font or color is
|
|
1749 used. In newer Emacs versions, this cannot happen, because the
|
|
1750 @code{default} face specifies all attributes---in fact, the frame's own
|
|
1751 font and colors are synonymous with those of the default face.
|
|
1752
|
|
1753 @node Font Selection
|
|
1754 @subsection Font Selection
|
|
1755
|
|
1756 @dfn{Selecting a font} means mapping the specified face attributes for
|
|
1757 a character to a font that is available on a particular display. The
|
|
1758 face attributes, as determined by face merging, specify most of the
|
|
1759 font choice, but not all. Part of the choice depends on what character
|
|
1760 it is.
|
|
1761
|
|
1762 For multibyte characters, typically each font covers only one
|
|
1763 character set. So each character set (@pxref{Character Sets}) specifies
|
|
1764 a registry and encoding to use, with the character set's
|
|
1765 @code{x-charset-registry} property. Its value is a string containing
|
|
1766 the registry and the encoding, with a dash between them:
|
|
1767
|
|
1768 @example
|
|
1769 (plist-get (charset-plist 'latin-iso8859-1)
|
|
1770 'x-charset-registry)
|
|
1771 @result{} "ISO8859-1"
|
|
1772 @end example
|
|
1773
|
|
1774 Unibyte text does not have character sets, so displaying a unibyte
|
|
1775 character takes the registry and encoding from the variable
|
|
1776 @code{face-default-registry}.
|
|
1777
|
|
1778 @defvar face-default-registry
|
|
1779 This variable specifies which registry and encoding to use in choosing
|
|
1780 fonts for unibyte characters. The value is initialized at Emacs startup
|
|
1781 time from the font the user specified for Emacs.
|
|
1782 @end defvar
|
|
1783
|
|
1784 If the face specifies a fontset name, that fontset determines a
|
|
1785 pattern for fonts of the given charset. If the face specifies a font
|
|
1786 family, a font pattern is constructed.
|
|
1787
|
|
1788 Emacs tries to find an available font for the given face attributes
|
|
1789 and character's registry and encoding. If there is a font that matches
|
|
1790 exactly, it is used, of course. The hard case is when no available font
|
|
1791 exactly fits the specification. Then Emacs looks for one that is
|
27654
|
1792 ``close''---one attribute at a time. You can specify the order to
|
|
1793 consider the attributes. In the case where a specified font family is
|
|
1794 not available, you can specify a set of mappings for alternatives to
|
|
1795 try.
|
25751
|
1796
|
|
1797 @defvar face-font-selection-order
|
|
1798 @tindex face-font-selection-order
|
|
1799 This variable specifies the order of importance of the face attributes
|
|
1800 @code{:width}, @code{:height}, @code{:weight}, and @code{:slant}. The
|
|
1801 value should be a list containing those four symbols, in order of
|
|
1802 decreasing importance.
|
|
1803
|
|
1804 Font selection first finds the best available matches for the first
|
|
1805 attribute listed; then, among the fonts which are best in that way, it
|
|
1806 searches for the best matches in the second attribute, and so on.
|
|
1807
|
|
1808 The attributes @code{:weight} and @code{:width} have symbolic values in
|
|
1809 a range centered around @code{normal}. Matches that are more extreme
|
|
1810 (farther from @code{normal}) are somewhat preferred to matches that are
|
|
1811 less extreme (closer to @code{normal}); this is designed to ensure that
|
|
1812 non-normal faces contrast with normal ones, whenever possible.
|
|
1813
|
|
1814 The default is @code{(:width :height :weight :slant)}, which means first
|
|
1815 find the fonts closest to the specified @code{:width}, then---among the
|
|
1816 fonts with that width---find a best match for the specified font height,
|
|
1817 and so on.
|
|
1818
|
|
1819 One example of a case where this variable makes a difference is when the
|
|
1820 default font has no italic equivalent. With the default ordering, the
|
|
1821 @code{italic} face will use a non-italic font that is similar to the
|
|
1822 default one. But if you put @code{:slant} before @code{:height}, the
|
|
1823 @code{italic} face will use an italic font, even if its height is not
|
|
1824 quite right.
|
|
1825 @end defvar
|
|
1826
|
|
1827 @defvar face-alternative-font-family-alist
|
|
1828 @tindex face-alternative-font-family-alist
|
|
1829 This variable lets you specify alternative font families to try, if a
|
|
1830 given family is specified and doesn't exist. Each element should have
|
|
1831 this form:
|
|
1832
|
|
1833 @example
|
|
1834 (@var{family} @var{alternate-families}@dots{})
|
|
1835 @end example
|
|
1836
|
|
1837 If @var{family} is specified but not available, Emacs will try the other
|
|
1838 families given in @var{alternate-families}, one by one, until it finds a
|
|
1839 family that does exist.
|
|
1840 @end defvar
|
|
1841
|
|
1842 Emacs can make use of scalable fonts, but by default it does not use
|
|
1843 them, since the use of too many or too big scalable fonts can crash
|
|
1844 XFree86 servers.
|
|
1845
|
|
1846 @defvar scalable-fonts-allowed
|
|
1847 @tindex scalable-fonts-allowed
|
|
1848 This variable controls which scalable fonts to use. A value of
|
|
1849 @code{nil}, the default, means do not use scalable fonts. @code{t}
|
|
1850 means to use any scalable font that seems appropriate for the text.
|
|
1851
|
|
1852 Otherwise, the value must be a list of regular expressions. Then a
|
|
1853 scalable font is enabled for use if its name matches any regular
|
|
1854 expression in the list. For example,
|
|
1855
|
|
1856 @example
|
|
1857 (setq scalable-fonts-allowed '("muleindian-2$"))
|
|
1858 @end example
|
|
1859
|
|
1860 @noindent
|
|
1861 allows the use of scalable fonts with registry @code{muleindian-2}.
|
26698
|
1862 @end defvar
|
25751
|
1863
|
|
1864 @defun clear-face-cache &optional unload-p
|
|
1865 @tindex clear-face-cache
|
|
1866 This function clears the face cache for all frames.
|
|
1867 If @var{unload-p} is non-@code{nil}, that means to unload
|
|
1868 all unused fonts as well.
|
|
1869 @end defun
|
6598
|
1870
|
|
1871 @node Face Functions
|
|
1872 @subsection Functions for Working with Faces
|
|
1873
|
25751
|
1874 Here are additional functions for creating and working with faces.
|
6598
|
1875
|
|
1876 @defun make-face name
|
|
1877 This function defines a new face named @var{name}, initially with all
|
|
1878 attributes @code{nil}. It does nothing if there is already a face named
|
|
1879 @var{name}.
|
|
1880 @end defun
|
|
1881
|
|
1882 @defun face-list
|
|
1883 This function returns a list of all defined face names.
|
|
1884 @end defun
|
|
1885
|
|
1886 @defun copy-face old-face new-name &optional frame new-frame
|
|
1887 This function defines the face @var{new-name} as a copy of the existing
|
|
1888 face named @var{old-face}. It creates the face @var{new-name} if that
|
|
1889 doesn't already exist.
|
|
1890
|
|
1891 If the optional argument @var{frame} is given, this function applies
|
|
1892 only to that frame. Otherwise it applies to each frame individually,
|
|
1893 copying attributes from @var{old-face} in each frame to @var{new-face}
|
|
1894 in the same frame.
|
|
1895
|
|
1896 If the optional argument @var{new-frame} is given, then @code{copy-face}
|
|
1897 copies the attributes of @var{old-face} in @var{frame} to @var{new-name}
|
|
1898 in @var{new-frame}.
|
|
1899 @end defun
|
|
1900
|
12098
|
1901 @defun face-id face
|
21682
|
1902 This function returns the face number of face @var{face}.
|
6598
|
1903 @end defun
|
|
1904
|
22138
|
1905 @defun face-documentation face
|
21007
|
1906 This function returns the documentation string of face @var{face}, or
|
|
1907 @code{nil} if none was specified for it.
|
|
1908 @end defun
|
|
1909
|
6598
|
1910 @defun face-equal face1 face2 &optional frame
|
|
1911 This returns @code{t} if the faces @var{face1} and @var{face2} have the
|
|
1912 same attributes for display.
|
|
1913 @end defun
|
|
1914
|
|
1915 @defun face-differs-from-default-p face &optional frame
|
|
1916 This returns @code{t} if the face @var{face} displays differently from
|
25875
|
1917 the default face. A face is considered to be ``the same'' as the
|
|
1918 default face if each attribute is either the same as that of the default
|
|
1919 face, or unspecified (meaning to inherit from the default).
|
22252
|
1920 @end defun
|
|
1921
|
25751
|
1922 @node Auto Faces
|
|
1923 @subsection Automatic Face Assignment
|
|
1924 @cindex automatic face assignment
|
|
1925 @cindex faces, automatic choice
|
|
1926
|
|
1927 @cindex Font-Lock mode
|
|
1928 Starting with Emacs 21, a hook is available for automatically
|
|
1929 assigning faces to text in the buffer. This hook is used for part of
|
|
1930 the implementation of Font-Lock mode.
|
|
1931
|
|
1932 @tindex fontification-functions
|
|
1933 @defvar fontification-functions
|
|
1934 This variable holds a list of functions that are called by Emacs
|
|
1935 redisplay as needed to assign faces automatically to text in the buffer.
|
|
1936
|
|
1937 The functions are called in the order listed, with one argument, a
|
|
1938 buffer position @var{pos}. Each function should attempt to assign faces
|
|
1939 to the text in the current buffer starting at @var{pos}.
|
|
1940
|
|
1941 Each function should record the faces they assign by setting the
|
|
1942 @code{face} property. It should also add a non-@code{nil}
|
|
1943 @code{fontified} property for all the text it has assigned faces to.
|
|
1944 That property tells redisplay that faces have been assigned to that text
|
|
1945 already.
|
|
1946
|
|
1947 It is probably a good idea for each function to do nothing if the
|
|
1948 character after @var{pos} already has a non-@code{nil} @code{fontified}
|
|
1949 property, but this is not required. If one function overrides the
|
|
1950 assignments made by a previous one, the properties as they are
|
|
1951 after the last function finishes are the ones that really matter.
|
|
1952
|
|
1953 For efficiency, we recommend writing these functions so that they
|
|
1954 usually assign faces to around 400 to 600 characters at each call.
|
|
1955 @end defvar
|
|
1956
|
|
1957 @node Font Lookup
|
|
1958 @subsection Looking Up Fonts
|
|
1959
|
|
1960 @defun x-list-fonts pattern &optional face frame maximum
|
|
1961 This function returns a list of available font names that match
|
|
1962 @var{pattern}. If the optional arguments @var{face} and @var{frame} are
|
|
1963 specified, then the list is limited to fonts that are the same size as
|
|
1964 @var{face} currently is on @var{frame}.
|
|
1965
|
|
1966 The argument @var{pattern} should be a string, perhaps with wildcard
|
|
1967 characters: the @samp{*} character matches any substring, and the
|
|
1968 @samp{?} character matches any single character. Pattern matching
|
|
1969 of font names ignores case.
|
|
1970
|
|
1971 If you specify @var{face} and @var{frame}, @var{face} should be a face name
|
|
1972 (a symbol) and @var{frame} should be a frame.
|
|
1973
|
|
1974 The optional argument @var{maximum} sets a limit on how many fonts to
|
|
1975 return. If this is non-@code{nil}, then the return value is truncated
|
|
1976 after the first @var{maximum} matching fonts. Specifying a small value
|
|
1977 for @var{maximum} can make this function much faster, in cases where
|
|
1978 many fonts match the pattern.
|
|
1979 @end defun
|
|
1980
|
|
1981 These additional functions are available starting in Emacs 21.
|
|
1982
|
|
1983 @defun x-family-fonts &optional family frame
|
|
1984 @tindex x-family-fonts
|
|
1985 This function returns a list describing the available fonts for family
|
|
1986 @var{family} on @var{frame}. If @var{family} is omitted or @code{nil},
|
|
1987 this list applies to all families, and therefore, it contains all
|
|
1988 available fonts. Otherwise, @var{family} must be a string; it may
|
|
1989 contain the wildcards @samp{?} and @samp{*}.
|
|
1990
|
|
1991 The list describes the display that @var{frame} is on; if @var{frame} is
|
|
1992 omitted or @code{nil}, it applies to the selected frame's display.
|
|
1993
|
|
1994 The list contains a vector of the following form for each font:
|
|
1995
|
|
1996 @example
|
|
1997 [@var{family} @var{width} @var{point-size} @var{weight} @var{slant}
|
|
1998 @var{fixed-p} @var{full} @var{registry-and-encoding}]
|
|
1999 @end example
|
|
2000
|
|
2001 The first five elements correspond to face attributes; if you
|
|
2002 specify these attributes for a face, it will use this font.
|
|
2003
|
|
2004 The last three elements give additional information about the font.
|
|
2005 @var{fixed-p} is non-nil if the font is fixed-pitch. @var{full} is the
|
|
2006 full name of the font, and @var{registry-and-encoding} is a string
|
|
2007 giving the registry and encoding of the font.
|
|
2008
|
|
2009 The result list is sorted according to the current face font sort order.
|
|
2010 @end defun
|
|
2011
|
|
2012 @defun x-font-family-list &optional frame
|
|
2013 @tindex x-font-family-list
|
|
2014 This function returns a list of the font families available for
|
|
2015 @var{frame}'s display. If @var{frame} is omitted or @code{nil}, it
|
|
2016 describes the selected frame's display.
|
|
2017
|
|
2018 The value is a list of elements of this form:
|
|
2019
|
|
2020 @example
|
|
2021 (@var{family} . @var{fixed-p})
|
|
2022 @end example
|
|
2023
|
|
2024 @noindent
|
|
2025 Here @var{family} is a font family, and @var{fixed-p} is
|
|
2026 non-@code{nil} if fonts of that family are fixed-pitch.
|
|
2027 @end defun
|
|
2028
|
|
2029 @defvar font-list-limit
|
|
2030 @tindex font-list-limit
|
|
2031 This variable specifies maximum number of fonts to consider in font
|
|
2032 matching. The function @code{x-family-fonts} will not return more than
|
|
2033 that many fonts, and font selection will consider only that many fonts
|
|
2034 when searching a matching font for face attributes. The default is
|
|
2035 currently 100.
|
|
2036 @end defvar
|
|
2037
|
|
2038 @node Fontsets
|
|
2039 @subsection Fontsets
|
|
2040
|
|
2041 A @dfn{fontset} is a list of fonts, each assigned to a range of
|
|
2042 character codes. An individual font cannot display the whole range of
|
|
2043 characters that Emacs supports, but a fontset can. Fontsets have names,
|
|
2044 just as fonts do, and you can use a fontset name in place of a font name
|
|
2045 when you specify the ``font'' for a frame or a face. Here is
|
|
2046 information about defining a fontset under Lisp program control.
|
|
2047
|
|
2048 @defun create-fontset-from-fontset-spec fontset-spec &optional style-variant-p noerror
|
|
2049 This function defines a new fontset according to the specification
|
|
2050 string @var{fontset-spec}. The string should have this format:
|
|
2051
|
|
2052 @smallexample
|
|
2053 @var{fontpattern}, @r{[}@var{charsetname}:@var{fontname}@r{]@dots{}}
|
|
2054 @end smallexample
|
|
2055
|
|
2056 @noindent
|
|
2057 Whitespace characters before and after the commas are ignored.
|
|
2058
|
|
2059 The first part of the string, @var{fontpattern}, should have the form of
|
|
2060 a standard X font name, except that the last two fields should be
|
|
2061 @samp{fontset-@var{alias}}.
|
|
2062
|
|
2063 The new fontset has two names, one long and one short. The long name is
|
|
2064 @var{fontpattern} in its entirety. The short name is
|
|
2065 @samp{fontset-@var{alias}}. You can refer to the fontset by either
|
|
2066 name. If a fontset with the same name already exists, an error is
|
|
2067 signaled, unless @var{noerror} is non-@code{nil}, in which case this
|
|
2068 function does nothing.
|
|
2069
|
|
2070 If optional argument @var{style-variant-p} is non-@code{nil}, that says
|
|
2071 to create bold, italic and bold-italic variants of the fontset as well.
|
|
2072 These variant fontsets do not have a short name, only a long one, which
|
|
2073 is made by altering @var{fontpattern} to indicate the bold or italic
|
|
2074 status.
|
|
2075
|
|
2076 The specification string also says which fonts to use in the fontset.
|
|
2077 See below for the details.
|
|
2078 @end defun
|
|
2079
|
|
2080 The construct @samp{@var{charset}:@var{font}} specifies which font to
|
|
2081 use (in this fontset) for one particular character set. Here,
|
|
2082 @var{charset} is the name of a character set, and @var{font} is the font
|
|
2083 to use for that character set. You can use this construct any number of
|
|
2084 times in the specification string.
|
|
2085
|
|
2086 For the remaining character sets, those that you don't specify
|
|
2087 explicitly, Emacs chooses a font based on @var{fontpattern}: it replaces
|
|
2088 @samp{fontset-@var{alias}} with a value that names one character set.
|
|
2089 For the @sc{ascii} character set, @samp{fontset-@var{alias}} is replaced
|
|
2090 with @samp{ISO8859-1}.
|
|
2091
|
|
2092 In addition, when several consecutive fields are wildcards, Emacs
|
|
2093 collapses them into a single wildcard. This is to prevent use of
|
|
2094 auto-scaled fonts. Fonts made by scaling larger fonts are not usable
|
|
2095 for editing, and scaling a smaller font is not useful because it is
|
|
2096 better to use the smaller font in its own size, which Emacs does.
|
|
2097
|
|
2098 Thus if @var{fontpattern} is this,
|
|
2099
|
|
2100 @example
|
|
2101 -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24
|
|
2102 @end example
|
|
2103
|
|
2104 @noindent
|
27374
|
2105 the font specification for @sc{ascii} characters would be this:
|
25751
|
2106
|
|
2107 @example
|
|
2108 -*-fixed-medium-r-normal-*-24-*-ISO8859-1
|
|
2109 @end example
|
|
2110
|
|
2111 @noindent
|
|
2112 and the font specification for Chinese GB2312 characters would be this:
|
|
2113
|
|
2114 @example
|
|
2115 -*-fixed-medium-r-normal-*-24-*-gb2312*-*
|
|
2116 @end example
|
|
2117
|
|
2118 You may not have any Chinese font matching the above font
|
|
2119 specification. Most X distributions include only Chinese fonts that
|
|
2120 have @samp{song ti} or @samp{fangsong ti} in the @var{family} field. In
|
|
2121 such a case, @samp{Fontset-@var{n}} can be specified as below:
|
|
2122
|
|
2123 @smallexample
|
|
2124 Emacs.Fontset-0: -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24,\
|
|
2125 chinese-gb2312:-*-*-medium-r-normal-*-24-*-gb2312*-*
|
|
2126 @end smallexample
|
|
2127
|
|
2128 @noindent
|
|
2129 Then, the font specifications for all but Chinese GB2312 characters have
|
|
2130 @samp{fixed} in the @var{family} field, and the font specification for
|
|
2131 Chinese GB2312 characters has a wild card @samp{*} in the @var{family}
|
|
2132 field.
|
|
2133
|
|
2134 @node Display Property
|
|
2135 @section The @code{display} Property
|
|
2136 @cindex display specification
|
|
2137 @kindex display @r{(text property)}
|
|
2138
|
25875
|
2139 The @code{display} text property (or overlay property) is used to
|
|
2140 insert images into text, and also control other aspects of how text
|
|
2141 displays. These features are available starting in Emacs 21. The value
|
|
2142 of the @code{display} property should be a display specification, or a
|
|
2143 list or vector containing several display specifications. The rest of
|
|
2144 this section describes several kinds of display specifications and what
|
|
2145 they mean.
|
25751
|
2146
|
|
2147 @menu
|
25875
|
2148 * Specified Space:: Displaying one space with a specified width.
|
|
2149 * Other Display Specs:: Displaying an image; magnifying text; moving it
|
|
2150 up or down on the page; adjusting the width
|
|
2151 of spaces within text.
|
|
2152 * Display Margins:: Displaying text or images to the side of the main text.
|
|
2153 * Conditional Display:: Making any of the above features conditional
|
|
2154 depending on some Lisp expression.
|
25751
|
2155 @end menu
|
|
2156
|
|
2157 @node Specified Space
|
|
2158 @subsection Specified Spaces
|
|
2159 @cindex spaces, specified height or width
|
|
2160 @cindex specified spaces
|
|
2161 @cindex variable-width spaces
|
|
2162
|
|
2163 To display a space of specified width and/or height, use a display
|
25875
|
2164 specification of the form @code{(space . @var{props})}, where
|
|
2165 @var{props} is a property list (a list of alternating properties and
|
|
2166 values). You can put this property on one or more consecutive
|
|
2167 characters; a space of the specified height and width is displayed in
|
|
2168 place of @emph{all} of those characters. These are the properties you
|
|
2169 can use to specify the weight of the space:
|
25751
|
2170
|
|
2171 @table @code
|
|
2172 @item :width @var{width}
|
|
2173 Specifies that the space width should be @var{width} times the normal
|
|
2174 character width. @var{width} can be an integer or floating point
|
|
2175 number.
|
|
2176
|
|
2177 @item :relative-width @var{factor}
|
|
2178 Specifies that the width of the stretch should be computed from the
|
|
2179 first character in the group of consecutive characters that have the
|
|
2180 same @code{display} property. The space width is the width of that
|
|
2181 character, multiplied by @var{factor}.
|
|
2182
|
|
2183 @item :align-to @var{hpos}
|
|
2184 Specifies that the space should be wide enough to reach @var{hpos}. The
|
25875
|
2185 value @var{hpos} is measured in units of the normal character width. It
|
|
2186 may be an interer or a floating point number.
|
25751
|
2187 @end table
|
|
2188
|
|
2189 Exactly one of the above properties should be used. You can also
|
|
2190 specify the height of the space, with other properties:
|
|
2191
|
|
2192 @table @code
|
|
2193 @item :height @var{height}
|
|
2194 Specifies the height of the space, as @var{height},
|
|
2195 measured in terms of the normal line height.
|
|
2196
|
|
2197 @item :relative-height @var{factor}
|
|
2198 Specifies the height of the space, multiplying the ordinary height
|
|
2199 of the text having this display specification by @var{factor}.
|
|
2200
|
|
2201 @item :ascent @var{ascent}
|
|
2202 Specifies that @var{ascent} percent of the height of the space should be
|
25875
|
2203 considered as the ascent of the space---that is, the part above the
|
|
2204 baseline. The value of @var{ascent} must be a non-negative number no
|
|
2205 greater than 100.
|
25751
|
2206 @end table
|
|
2207
|
|
2208 You should not use both @code{:height} and @code{:relative-height}
|
|
2209 together.
|
|
2210
|
|
2211 @node Other Display Specs
|
|
2212 @subsection Other Display Specifications
|
|
2213
|
|
2214 @table @code
|
|
2215 @item (image . @var{image-props})
|
|
2216 This is in fact an image descriptor (@pxref{Images}). When used as a
|
|
2217 display specification, it means to display the image instead of the text
|
|
2218 that has the display specification.
|
|
2219
|
|
2220 @item (space-width @var{factor})
|
25875
|
2221 This display specification affects all the space characters within the
|
|
2222 text that has the specification. It displays all of these spaces
|
|
2223 @var{factor} times as wide as normal. The element @var{factor} should
|
|
2224 be an integer or float. Characters other than spaces are not affected
|
|
2225 at all; in particular, this has no effect on tab characters.
|
25751
|
2226
|
|
2227 @item (height @var{height})
|
|
2228 This display specification makes the text taller or shorter.
|
|
2229 Here are the possibilities for @var{height}:
|
|
2230
|
|
2231 @table @asis
|
|
2232 @item @code{(+ @var{n})}
|
|
2233 This means to use a font that is @var{n} steps larger. A ``step'' is
|
25875
|
2234 defined by the set of available fonts---specifically, those that match
|
|
2235 what was otherwise specified for this text, in all attributes except
|
|
2236 height. Each size for which a suitable font is available counts as
|
|
2237 another step. @var{n} should be an integer.
|
25751
|
2238
|
|
2239 @item @code{(- @var{n})}
|
|
2240 This means to use a font that is @var{n} steps smaller.
|
|
2241
|
|
2242 @item a number, @var{factor}
|
|
2243 A number, @var{factor}, means to use a font that is @var{factor} times
|
|
2244 as tall as the default font.
|
|
2245
|
|
2246 @item a symbol, @var{function}
|
|
2247 A symbol is a function to compute the height. It is called with the
|
|
2248 current height as argument, and should return the new height to use.
|
|
2249
|
|
2250 @item anything else, @var{form}
|
|
2251 If the @var{height} value doesn't fit the previous possibilities, it is
|
|
2252 a form. Emacs evaluates it to get the new height, with the symbol
|
|
2253 @code{height} bound to the current specified font height.
|
|
2254 @end table
|
|
2255
|
|
2256 @item (raise @var{factor})
|
|
2257 This kind of display specification raises or lowers the text
|
|
2258 it applies to, relative to the baseline of the line.
|
|
2259
|
|
2260 @var{factor} must be a number, which is interpreted as a multiple of the
|
|
2261 height of the affected text. If it is positive, that means to display
|
|
2262 the characters raised. If it is negative, that means to display them
|
|
2263 lower down.
|
|
2264
|
|
2265 If the text also has a @code{height} display specification, that does
|
|
2266 not affect the amount of raising or lowering, which is based on the
|
|
2267 faces used for the text.
|
|
2268 @end table
|
|
2269
|
|
2270 @node Display Margins
|
|
2271 @subsection Displaying in the Margins
|
|
2272 @cindex display margins
|
|
2273 @cindex margins, display
|
|
2274
|
|
2275 A buffer can have blank areas called @dfn{display margins} on the left
|
|
2276 and on the right. Ordinary text never appears in these areas, but you
|
|
2277 can put things into the display margins using the @code{display}
|
|
2278 property.
|
|
2279
|
|
2280 To put text in the left or right display margin of the window, use a
|
|
2281 display specification of the form @code{(margin right-margin)} or
|
|
2282 @code{(margin left-margin)} on it. To put an image in a display margin,
|
|
2283 use that display specification along with the display specification for
|
|
2284 the image.
|
|
2285
|
|
2286 Before the display margins can display anything, you must give
|
|
2287 them a nonzero width. The usual way to do that is to set these
|
|
2288 variables:
|
|
2289
|
|
2290 @defvar left-margin-width
|
|
2291 @tindex left-margin-width
|
|
2292 This variable specifies the width of the left margin.
|
|
2293 It is buffer-local in all buffers.
|
|
2294 @end defvar
|
|
2295
|
|
2296 @defvar right-margin-width
|
|
2297 @tindex right-margin-width
|
|
2298 This variable specifies the width of the right margin.
|
|
2299 It is buffer-local in all buffers.
|
|
2300 @end defvar
|
|
2301
|
|
2302 Setting these variables does not immediately affect the window. These
|
|
2303 variables are checked when a new buffer is displayed in the window.
|
|
2304 Thus, you can make changes take effect by calling
|
|
2305 @code{set-window-buffer}.
|
|
2306
|
|
2307 You can also set the margin widths immediately.
|
|
2308
|
|
2309 @defun set-window-margins window left right
|
|
2310 @tindex set-window-margins
|
|
2311 This function specifies the margin widths for window @var{window}.
|
|
2312 The argument @var{left} controls the left margin and
|
|
2313 @var{right} controls the right margin.
|
|
2314 @end defun
|
|
2315
|
|
2316 @defun window-margins &optional window
|
|
2317 @tindex window-margins
|
|
2318 This function returns the left and right margins of @var{window}
|
|
2319 as a cons cell of the form @code{(@var{left} . @var{right})}.
|
|
2320 If @var{window} is @code{nil}, the selected window is used.
|
|
2321 @end defun
|
|
2322
|
|
2323 @node Conditional Display
|
|
2324 @subsection Conditional Display Specifications
|
|
2325 @cindex conditional display specifications
|
|
2326
|
|
2327 You can make any display specification conditional. To do that,
|
29471
|
2328 package it in another list of the form @code{(when @var{condition} .
|
25751
|
2329 @var{spec})}. Then the specification @var{spec} applies only when
|
|
2330 @var{condition} evaluates to a non-@code{nil} value. During the
|
|
2331 evaluation, point is temporarily set at the end position of the text
|
|
2332 having this conditional display specification.
|
|
2333
|
|
2334 @node Images
|
|
2335 @section Images
|
|
2336 @cindex images in buffers
|
|
2337
|
|
2338 To display an image in an Emacs buffer, you must first create an image
|
|
2339 descriptor, then use it as a display specifier in the @code{display}
|
|
2340 property of text that is displayed (@pxref{Display Property}). Like the
|
|
2341 @code{display} property, this feature is available starting in Emacs 21.
|
|
2342
|
|
2343 Emacs can display a number of different image formats; some of them
|
|
2344 are supported only if particular support libraries are installed on your
|
|
2345 machine. The supported image formats include XBM, XPM (needing the
|
|
2346 libraries @code{libXpm} version 3.4k and @code{libz}), GIF (needing
|
|
2347 @code{libungif} 4.1.0), Postscript, PBM, JPEG (needing the
|
|
2348 @code{libjpeg} library version v6a), TIFF (needing @code{libtiff} v3.4),
|
|
2349 and PNG (needing @code{libpng} 1.0.2).
|
|
2350
|
|
2351 You specify one of these formats with an image type symbol. The image
|
|
2352 type symbols are @code{xbm}, @code{xpm}, @code{gif}, @code{postscript},
|
|
2353 @code{pbm}, @code{jpeg}, @code{tiff}, and @code{png}.
|
|
2354
|
|
2355 @defvar image-types
|
|
2356 This variable contains a list of those image type symbols that are
|
|
2357 supported in the current configuration.
|
|
2358 @end defvar
|
|
2359
|
|
2360 @menu
|
25875
|
2361 * Image Descriptors:: How to specify an image for use in @code{:display}.
|
|
2362 * XBM Images:: Special features for XBM format.
|
|
2363 * XPM Images:: Special features for XPM format.
|
|
2364 * GIF Images:: Special features for GIF format.
|
|
2365 * Postscript Images:: Special features for Postscript format.
|
|
2366 * Other Image Types:: Various other formats are supported.
|
|
2367 * Defining Images:: Convenient ways to define an image for later use.
|
|
2368 * Showing Images:: Convenient ways to display an image once it is defined.
|
|
2369 * Image Cache:: Internal mechanisms of image display.
|
25751
|
2370 @end menu
|
|
2371
|
|
2372 @node Image Descriptors
|
|
2373 @subsection Image Descriptors
|
|
2374 @cindex image descriptor
|
|
2375
|
|
2376 An image description is a list of the form @code{(image
|
|
2377 . @var{props})}, where @var{props} is a property list containing
|
|
2378 alternating keyword symbols (symbols whose names start with a colon) and
|
26400
|
2379 their values. You can use any Lisp object as a property, but the only
|
|
2380 properties that have any special meaning are certain symbols, all of
|
|
2381 them keywords.
|
|
2382
|
|
2383 Every image descriptor must contain the property @code{:type
|
|
2384 @var{type}} to specify the format of the image. The value of @var{type}
|
|
2385 should be an image type symbol; for example, @code{xpm} for an image in
|
|
2386 XPM format.
|
25751
|
2387
|
|
2388 Here is a list of other properties that are meaningful for all image
|
|
2389 types:
|
|
2390
|
|
2391 @table @code
|
|
2392 @item :ascent @var{ascent}
|
29151
|
2393 The @code{:ascent} property specifies the amount of the image's
|
|
2394 height to use for its ascent---that is, the part above the baseline.
|
|
2395 The value, @var{ascent}, must be a number in the range 0 to 100, or
|
|
2396 the symbol @code{center}.
|
|
2397
|
|
2398 If @var{ascent} is a number, that percentage of the image's height is
|
|
2399 used for its ascent.
|
|
2400
|
|
2401 If @var{ascent} is @code{center}, the image is vertically centered
|
|
2402 around a centerline which would be the vertical centerline of text drawn
|
|
2403 at the position of the image, in the manner specified by the text
|
|
2404 properties and overlays that apply to the image.
|
|
2405
|
|
2406 If this property is omitted, it defaults to 50.
|
25751
|
2407
|
|
2408 @item :margin @var{margin}
|
|
2409 The @code{:margin} property specifies how many pixels to add as an extra
|
|
2410 margin around the image. The value, @var{margin}, must be a
|
|
2411 non-negative number; if it is not specified, the default is zero.
|
|
2412
|
|
2413 @item :relief @var{relief}
|
|
2414 The @code{:relief} property, if non-@code{nil}, adds a shadow rectangle
|
|
2415 around the image. The value, @var{relief}, specifies the width of the
|
|
2416 shadow lines, in pixels. If @var{relief} is negative, shadows are drawn
|
|
2417 so that the image appears as a pressed button; otherwise, it appears as
|
|
2418 an unpressed button.
|
|
2419
|
|
2420 @item :algorithm @var{algorithm}
|
|
2421 The @code{:algorithm} property, if non-@code{nil}, specifies a
|
|
2422 conversion algorithm that should be applied to the image before it is
|
|
2423 displayed; the value, @var{algorithm}, specifies which algorithm.
|
|
2424
|
|
2425 Currently, the only meaningful value for @var{algorithm} (aside from
|
|
2426 @code{nil}) is @code{laplace}; this applies the Laplace edge detection
|
|
2427 algorithm, which blurs out small differences in color while highlighting
|
|
2428 larger differences. People sometimes consider this useful for
|
|
2429 displaying the image for a ``disabled'' button.
|
|
2430
|
|
2431 @item :heuristic-mask @var{transparent-color}
|
|
2432 The @code{:heuristic-mask} property, if non-@code{nil}, specifies that a
|
|
2433 certain color in the image should be transparent. Each pixel where this
|
|
2434 color appears will actually allow the frame's background to show
|
|
2435 through.
|
|
2436
|
|
2437 If @var{transparent-color} is @code{t}, then determine the transparent
|
|
2438 color by looking at the four corners of the image. This uses the color
|
|
2439 that occurs most frequently near the corners as the transparent color.
|
|
2440
|
|
2441 Otherwise, @var{heuristic-mask} should specify the transparent color
|
|
2442 directly, as a list of three integers in the form @code{(@var{red}
|
|
2443 @var{green} @var{blue})}.
|
|
2444
|
|
2445 @item :file @var{file}
|
|
2446 The @code{:file} property specifies to load the image from file
|
|
2447 @var{file}. If @var{file} is not an absolute file name, it is expanded
|
|
2448 in @code{data-directory}.
|
|
2449
|
|
2450 @item :data @var{data}
|
|
2451 The @code{:data} property specifies the actual contents of the image.
|
|
2452 Each image must use either @code{:data} or @code{:file}, but not both.
|
27093
|
2453 For most image types, the value of the @code{:data} property should be a
|
|
2454 string containing the image data; we recommend using a unibyte string.
|
|
2455
|
|
2456 Before using @code{:data}, look for further information in the section
|
|
2457 below describing the specific image format. For some image types,
|
|
2458 @code{:data} may not be supported; for some, it allows other data types;
|
|
2459 for some, @code{:data} alone is not enough, so you need to use other
|
|
2460 image properties along with @code{:data}.
|
25751
|
2461 @end table
|
|
2462
|
|
2463 @node XBM Images
|
|
2464 @subsection XBM Images
|
|
2465 @cindex XBM
|
|
2466
|
|
2467 To use XBM format, specify @code{xbm} as the image type. This image
|
|
2468 format doesn't require an external library, so images of this type are
|
|
2469 always supported.
|
|
2470
|
|
2471 Additional image properties supported for the @code{xbm} image type are:
|
|
2472
|
|
2473 @table @code
|
|
2474 @item :foreground @var{foreground}
|
|
2475 The value, @var{foreground}, should be a string specifying the image
|
|
2476 foreground color. This color is used for each pixel in the XBM that is
|
|
2477 1. The default is the frame's foreground color.
|
|
2478
|
|
2479 @item :background @var{background}
|
|
2480 The value, @var{background}, should be a string specifying the image
|
|
2481 background color. This color is used for each pixel in the XBM that is
|
|
2482 0. The default is the frame's background color.
|
|
2483 @end table
|
|
2484
|
27093
|
2485 If you specify an XBM image using data within Emacs instead of an
|
28792
|
2486 external file, use the following three properties:
|
25751
|
2487
|
|
2488 @table @code
|
28792
|
2489 @item :data @var{data}
|
|
2490 The value, @var{data}, specifies the contents of the image.
|
|
2491 There are three formats you can use for @var{data}:
|
|
2492
|
|
2493 @itemize @bullet
|
|
2494 @item
|
|
2495 A vector of strings or bool-vectors, each specifying one line of the
|
|
2496 image. Do specify @code{:height} and @code{:width}.
|
|
2497
|
|
2498 @item
|
|
2499 A string containing the same byte sequence as an XBM file would contain.
|
|
2500 You must not specify @code{:height} and @code{:width} in this case,
|
|
2501 because omitting them is what indicates the data has the format of an
|
|
2502 XBM file. The file contents specify the height and width of the image.
|
|
2503
|
|
2504 @item
|
|
2505 A string or a bool-vector containing the bits of the image (plus perhaps
|
|
2506 some extra bits at the end that will not be used). It should contain at
|
|
2507 least @var{width} * @code{height} bits. In this case, you must specify
|
|
2508 @code{:height} and @code{:width}, both to indicate that the string
|
|
2509 contains just the bits rather than a whole XBM file, and to specify the
|
|
2510 size of the image.
|
|
2511 @end itemize
|
|
2512
|
25751
|
2513 @item :width @var{width}
|
28792
|
2514 The value, @var{width}, specifies the width of the image, in pixels.
|
25751
|
2515
|
|
2516 @item :height @var{height}
|
28792
|
2517 The value, @var{height}, specifies the height of the image, in pixels.
|
25751
|
2518 @end table
|
|
2519
|
|
2520 @node XPM Images
|
|
2521 @subsection XPM Images
|
|
2522 @cindex XPM
|
|
2523
|
27093
|
2524 To use XPM format, specify @code{xpm} as the image type. The
|
|
2525 additional image property @code{:color-symbols} is also meaningful with
|
|
2526 the @code{xpm} image type:
|
25751
|
2527
|
|
2528 @table @code
|
|
2529 @item :color-symbols @var{symbols}
|
|
2530 The value, @var{symbols}, should be an alist whose elements have the
|
|
2531 form @code{(@var{name} . @var{color})}. In each element, @var{name} is
|
|
2532 the name of a color as it appears in the image file, and @var{color}
|
|
2533 specifies the actual color to use for displaying that name.
|
|
2534 @end table
|
|
2535
|
|
2536 @node GIF Images
|
|
2537 @subsection GIF Images
|
|
2538 @cindex GIF
|
|
2539
|
|
2540 For GIF images, specify image type @code{gif}. Because of the patents
|
|
2541 in the US covering the LZW algorithm, the continued use of GIF format is
|
|
2542 a problem for the whole Internet; to end this problem, it is a good idea
|
|
2543 for everyone, even outside the US, to stop using GIFS right away
|
|
2544 (@uref{http://www.burnallgifs.org/}). But if you still want to use
|
|
2545 them, Emacs can display them.
|
|
2546
|
|
2547 @table @code
|
|
2548 @item :index @var{index}
|
|
2549 You can use @code{:index} to specify one image from a GIF file that
|
|
2550 contains more than one image. This property specifies use of image
|
|
2551 number @var{index} from the file. An error is signaled if the GIF file
|
|
2552 doesn't contain an image with index @var{index}.
|
|
2553 @end table
|
|
2554
|
|
2555 @ignore
|
|
2556 This could be used to implement limited support for animated GIFs.
|
|
2557 For example, the following function displays a multi-image GIF file
|
|
2558 at point-min in the current buffer, switching between sub-images
|
|
2559 every 0.1 seconds.
|
|
2560
|
|
2561 (defun show-anim (file max)
|
|
2562 "Display multi-image GIF file FILE which contains MAX subimages."
|
|
2563 (display-anim (current-buffer) file 0 max t))
|
|
2564
|
|
2565 (defun display-anim (buffer file idx max first-time)
|
|
2566 (when (= idx max)
|
|
2567 (setq idx 0))
|
|
2568 (let ((img (create-image file nil :image idx)))
|
|
2569 (save-excursion
|
|
2570 (set-buffer buffer)
|
|
2571 (goto-char (point-min))
|
|
2572 (unless first-time (delete-char 1))
|
|
2573 (insert-image img))
|
|
2574 (run-with-timer 0.1 nil 'display-anim buffer file (1+ idx) max nil)))
|
|
2575 @end ignore
|
|
2576
|
|
2577 @node Postscript Images
|
|
2578 @subsection Postscript Images
|
|
2579 @cindex Postscript images
|
|
2580
|
|
2581 To use Postscript for an image, specify image type @code{postscript}.
|
|
2582 This works only if you have Ghostscript installed. You must always use
|
|
2583 these three properties:
|
|
2584
|
|
2585 @table @code
|
|
2586 @item :pt-width @var{width}
|
|
2587 The value, @var{width}, specifies the width of the image measured in
|
|
2588 points (1/72 inch). @var{width} must be an integer.
|
|
2589
|
|
2590 @item :pt-height @var{height}
|
|
2591 The value, @var{height}, specifies the height of the image in points
|
|
2592 (1/72 inch). @var{height} must be an integer.
|
|
2593
|
|
2594 @item :bounding-box @var{box}
|
|
2595 The value, @var{box}, must be a list or vector of four integers, which
|
|
2596 specifying the bounding box of the Postscript image, analogous to the
|
|
2597 @samp{BoundingBox} comment found in Postscript files.
|
|
2598
|
|
2599 @example
|
|
2600 %%BoundingBox: 22 171 567 738
|
|
2601 @end example
|
|
2602 @end table
|
|
2603
|
27093
|
2604 Displaying Postscript images from Lisp data is not currently
|
|
2605 implemented, but it may be implemented by the time you read this.
|
|
2606 See the @file{etc/NEWS} file to make sure.
|
|
2607
|
25751
|
2608 @node Other Image Types
|
|
2609 @subsection Other Image Types
|
|
2610 @cindex PBM
|
|
2611
|
|
2612 For PBM images, specify image type @code{pbm}. Color, gray-scale and
|
|
2613 monochromatic images are supported.
|
|
2614
|
27093
|
2615 For JPEG images, specify image type @code{jpeg}.
|
25751
|
2616
|
|
2617 For TIFF images, specify image type @code{tiff}.
|
|
2618
|
|
2619 For PNG images, specify image type @code{png}.
|
|
2620
|
|
2621 @node Defining Images
|
|
2622 @subsection Defining Images
|
|
2623
|
|
2624 The functions @code{create-image} and @code{defimage} provide
|
|
2625 convenient ways to create image descriptors.
|
|
2626
|
|
2627 @defun create-image file &optional type &rest props
|
|
2628 @tindex create-image
|
|
2629 This function creates and returns an image descriptor which uses the
|
|
2630 data in @var{file}.
|
|
2631
|
|
2632 The optional argument @var{type} is a symbol specifying the image type.
|
|
2633 If @var{type} is omitted or @code{nil}, @code{create-image} tries to
|
|
2634 determine the image type from the file's first few bytes, or else
|
|
2635 from the file's name.
|
|
2636
|
|
2637 The remaining arguments, @var{props}, specify additional image
|
|
2638 properties---for example,
|
|
2639
|
|
2640 @example
|
|
2641 (create-image "foo.xpm" 'xpm :heuristic-mask t)
|
|
2642 @end example
|
|
2643
|
|
2644 The function returns @code{nil} if images of this type are not
|
|
2645 supported. Otherwise it returns an image descriptor.
|
|
2646 @end defun
|
|
2647
|
|
2648 @defmac defimage variable doc &rest specs
|
|
2649 @tindex defimage
|
|
2650 This macro defines @var{variable} as an image name. The second argument,
|
|
2651 @var{doc}, is an optional documentation string. The remaining
|
|
2652 arguments, @var{specs}, specify alternative ways to display the image.
|
|
2653
|
|
2654 Each argument in @var{specs} has the form of a property list, and each
|
|
2655 one should specify at least the @code{:type} property and the
|
|
2656 @code{:file} property. Here is an example:
|
|
2657
|
25875
|
2658 @example
|
|
2659 (defimage test-image
|
|
2660 '((:type xpm :file "~/test1.xpm")
|
|
2661 (:type xbm :file "~/test1.xbm")))
|
|
2662 @end example
|
25751
|
2663
|
|
2664 @code{defimage} tests each argument, one by one, to see if it is
|
|
2665 usable---that is, if the type is supported and the file exists. The
|
|
2666 first usable argument is used to make an image descriptor which is
|
|
2667 stored in the variable @var{variable}.
|
|
2668
|
|
2669 If none of the alternatives will work, then @var{variable} is defined
|
|
2670 as @code{nil}.
|
|
2671 @end defmac
|
|
2672
|
|
2673 @node Showing Images
|
|
2674 @subsection Showing Images
|
|
2675
|
|
2676 You can use an image descriptor by setting up the @code{display}
|
|
2677 property yourself, but it is easier to use the functions in this
|
|
2678 section.
|
|
2679
|
29471
|
2680 @defun insert-image image &optional string area
|
25751
|
2681 This function inserts @var{image} in the current buffer at point. The
|
|
2682 value @var{image} should be an image descriptor; it could be a value
|
|
2683 returned by @code{create-image}, or the value of a symbol defined with
|
25875
|
2684 @code{defimage}. The argument @var{string} specifies the text to put in
|
|
2685 the buffer to hold the image.
|
25751
|
2686
|
|
2687 The argument @var{area} specifies whether to put the image in a margin.
|
|
2688 If it is @code{left-margin}, the image appears in the left margin;
|
|
2689 @code{right-margin} specifies the right margin. If @var{area} is
|
|
2690 @code{nil} or omitted, the image is displayed at point within the
|
|
2691 buffer's text.
|
|
2692
|
25875
|
2693 Internally, this function inserts @var{string} in the buffer, and gives
|
|
2694 it a @code{display} property which specifies @var{image}. @xref{Display
|
25751
|
2695 Property}.
|
|
2696 @end defun
|
|
2697
|
29471
|
2698 @defun put-image image pos &optional string area
|
25751
|
2699 This function puts image @var{image} in front of @var{pos} in the
|
|
2700 current buffer. The argument @var{pos} should be an integer or a
|
|
2701 marker. It specifies the buffer position where the image should appear.
|
29471
|
2702 The argument @var{string} specifies the text that should hold the image
|
|
2703 as an alternative to the default.
|
25751
|
2704
|
|
2705 The argument @var{image} must be an image descriptor, perhaps returned
|
|
2706 by @code{create-image} or stored by @code{defimage}.
|
|
2707
|
|
2708 The argument @var{area} specifies whether to put the image in a margin.
|
|
2709 If it is @code{left-margin}, the image appears in the left margin;
|
|
2710 @code{right-margin} specifies the right margin. If @var{area} is
|
|
2711 @code{nil} or omitted, the image is displayed at point within the
|
|
2712 buffer's text.
|
|
2713
|
|
2714 Internally, this function creates an overlay, and gives it a
|
|
2715 @code{before-string} property containing text that has a @code{display}
|
|
2716 property whose value is the image. (Whew!)
|
|
2717 @end defun
|
|
2718
|
|
2719 @defun remove-images start end &optional buffer
|
|
2720 This function removes images in @var{buffer} between positions
|
|
2721 @var{start} and @var{end}. If @var{buffer} is omitted or @code{nil},
|
|
2722 images are removed from the current buffer.
|
|
2723
|
27331
|
2724 This removes only images that were put into @var{buffer} the way
|
25751
|
2725 @code{put-image} does it, not images that were inserted with
|
|
2726 @code{insert-image} or in other ways.
|
|
2727 @end defun
|
|
2728
|
|
2729 @node Image Cache
|
|
2730 @subsection Image Cache
|
|
2731
|
|
2732 Emacs stores images in an image cache when it displays them, so it can
|
|
2733 display them again more efficiently. It removes an image from the cache
|
|
2734 when it hasn't been displayed for a specified period of time.
|
|
2735
|
28770
|
2736 When an image is looked up in the cache, its specification is compared
|
|
2737 with cached image specifications using @code{equal}. This means that
|
|
2738 all images with equal specifications share the same image in the cache.
|
|
2739
|
25751
|
2740 @defvar image-cache-eviction-delay
|
|
2741 @tindex image-cache-eviction-delay
|
|
2742 This variable specifies the number of seconds an image can remain in the
|
|
2743 cache without being displayed. When an image is not displayed for this
|
|
2744 length of time, Emacs removes it from the image cache.
|
|
2745
|
|
2746 If the value is @code{nil}, Emacs does not remove images from the cache
|
|
2747 except when you explicitly clear it. This mode can be useful for
|
|
2748 debugging.
|
|
2749 @end defvar
|
|
2750
|
|
2751 @defun clear-image-cache &optional frame
|
|
2752 @tindex clear-image-cache
|
|
2753 This function clears the image cache. If @var{frame} is non-@code{nil},
|
|
2754 only the cache for that frame is cleared. Otherwise all frames' caches
|
|
2755 are cleared.
|
|
2756 @end defun
|
27447
|
2757
|
6598
|
2758 @node Blinking
|
|
2759 @section Blinking Parentheses
|
|
2760 @cindex parenthesis matching
|
|
2761 @cindex blinking
|
|
2762 @cindex balancing parentheses
|
|
2763 @cindex close parenthesis
|
|
2764
|
|
2765 This section describes the mechanism by which Emacs shows a matching
|
|
2766 open parenthesis when the user inserts a close parenthesis.
|
|
2767
|
|
2768 @defvar blink-paren-function
|
|
2769 The value of this variable should be a function (of no arguments) to
|
|
2770 be called whenever a character with close parenthesis syntax is inserted.
|
|
2771 The value of @code{blink-paren-function} may be @code{nil}, in which
|
|
2772 case nothing is done.
|
|
2773 @end defvar
|
|
2774
|
22252
|
2775 @defopt blink-matching-paren
|
6598
|
2776 If this variable is @code{nil}, then @code{blink-matching-open} does
|
|
2777 nothing.
|
22252
|
2778 @end defopt
|
6598
|
2779
|
22252
|
2780 @defopt blink-matching-paren-distance
|
6598
|
2781 This variable specifies the maximum distance to scan for a matching
|
|
2782 parenthesis before giving up.
|
22252
|
2783 @end defopt
|
6598
|
2784
|
22252
|
2785 @defopt blink-matching-delay
|
12098
|
2786 This variable specifies the number of seconds for the cursor to remain
|
|
2787 at the matching parenthesis. A fraction of a second often gives
|
|
2788 good results, but the default is 1, which works on all systems.
|
22252
|
2789 @end defopt
|
12098
|
2790
|
22252
|
2791 @deffn Command blink-matching-open
|
6598
|
2792 This function is the default value of @code{blink-paren-function}. It
|
|
2793 assumes that point follows a character with close parenthesis syntax and
|
|
2794 moves the cursor momentarily to the matching opening character. If that
|
|
2795 character is not already on the screen, it displays the character's
|
|
2796 context in the echo area. To avoid long delays, this function does not
|
|
2797 search farther than @code{blink-matching-paren-distance} characters.
|
|
2798
|
|
2799 Here is an example of calling this function explicitly.
|
|
2800
|
|
2801 @smallexample
|
|
2802 @group
|
|
2803 (defun interactive-blink-matching-open ()
|
|
2804 @c Do not break this line! -- rms.
|
|
2805 @c The first line of a doc string
|
|
2806 @c must stand alone.
|
|
2807 "Indicate momentarily the start of sexp before point."
|
|
2808 (interactive)
|
|
2809 @end group
|
|
2810 @group
|
|
2811 (let ((blink-matching-paren-distance
|
|
2812 (buffer-size))
|
|
2813 (blink-matching-paren t))
|
|
2814 (blink-matching-open)))
|
|
2815 @end group
|
|
2816 @end smallexample
|
22252
|
2817 @end deffn
|
6598
|
2818
|
|
2819 @node Inverse Video
|
|
2820 @section Inverse Video
|
|
2821 @cindex Inverse Video
|
|
2822
|
|
2823 @defopt inverse-video
|
|
2824 @cindex highlighting
|
|
2825 This variable controls whether Emacs uses inverse video for all text
|
|
2826 on the screen. Non-@code{nil} means yes, @code{nil} means no. The
|
|
2827 default is @code{nil}.
|
|
2828 @end defopt
|
|
2829
|
|
2830 @defopt mode-line-inverse-video
|
25875
|
2831 This variable controls the use of inverse video for mode lines and menu
|
|
2832 bars. If it is non-@code{nil}, then these lines are displayed in
|
27331
|
2833 inverse video. Otherwise, these lines are displayed normally, just like
|
25875
|
2834 other text. The default is @code{t}.
|
|
2835
|
|
2836 For window frames, this feature actually applies the face named
|
|
2837 @code{mode-line}; that face is normally set up as the inverse of the
|
|
2838 default face, unless you change it.
|
6598
|
2839 @end defopt
|
|
2840
|
|
2841 @node Usual Display
|
|
2842 @section Usual Display Conventions
|
|
2843
|
|
2844 The usual display conventions define how to display each character
|
|
2845 code. You can override these conventions by setting up a display table
|
|
2846 (@pxref{Display Tables}). Here are the usual display conventions:
|
|
2847
|
|
2848 @itemize @bullet
|
|
2849 @item
|
|
2850 Character codes 32 through 126 map to glyph codes 32 through 126.
|
|
2851 Normally this means they display as themselves.
|
|
2852
|
|
2853 @item
|
|
2854 Character code 9 is a horizontal tab. It displays as whitespace
|
|
2855 up to a position determined by @code{tab-width}.
|
|
2856
|
|
2857 @item
|
|
2858 Character code 10 is a newline.
|
|
2859
|
|
2860 @item
|
|
2861 All other codes in the range 0 through 31, and code 127, display in one
|
9009
|
2862 of two ways according to the value of @code{ctl-arrow}. If it is
|
6598
|
2863 non-@code{nil}, these codes map to sequences of two glyphs, where the
|
25751
|
2864 first glyph is the @sc{ascii} code for @samp{^}. (A display table can
|
6598
|
2865 specify a glyph to use instead of @samp{^}.) Otherwise, these codes map
|
|
2866 just like the codes in the range 128 to 255.
|
|
2867
|
25751
|
2868 On MS-DOS terminals, Emacs arranges by default for the character code
|
|
2869 127 to be mapped to the glyph code 127, which normally displays as an
|
|
2870 empty polygon. This glyph is used to display non-@sc{ascii} characters
|
|
2871 that the MS-DOS terminal doesn't support. @xref{MS-DOS and MULE,,,
|
|
2872 emacs, The GNU Emacs Manual}.
|
|
2873
|
6598
|
2874 @item
|
|
2875 Character codes 128 through 255 map to sequences of four glyphs, where
|
25751
|
2876 the first glyph is the @sc{ascii} code for @samp{\}, and the others are
|
22138
|
2877 digit characters representing the character code in octal. (A display
|
21682
|
2878 table can specify a glyph to use instead of @samp{\}.)
|
|
2879
|
|
2880 @item
|
|
2881 Multibyte character codes above 256 are displayed as themselves, or as a
|
|
2882 question mark or empty box if the terminal cannot display that
|
|
2883 character.
|
6598
|
2884 @end itemize
|
|
2885
|
|
2886 The usual display conventions apply even when there is a display
|
|
2887 table, for any character whose entry in the active display table is
|
|
2888 @code{nil}. Thus, when you set up a display table, you need only
|
21682
|
2889 specify the characters for which you want special behavior.
|
6598
|
2890
|
24951
|
2891 These display rules apply to carriage return (character code 13), when
|
|
2892 it appears in the buffer. But that character may not appear in the
|
|
2893 buffer where you expect it, if it was eliminated as part of end-of-line
|
25454
|
2894 conversion (@pxref{Coding System Basics}).
|
24951
|
2895
|
6598
|
2896 These variables affect the way certain characters are displayed on the
|
|
2897 screen. Since they change the number of columns the characters occupy,
|
21007
|
2898 they also affect the indentation functions. These variables also affect
|
|
2899 how the mode line is displayed; if you want to force redisplay of the
|
|
2900 mode line using the new values, call the function
|
|
2901 @code{force-mode-line-update} (@pxref{Mode Line Format}).
|
6598
|
2902
|
|
2903 @defopt ctl-arrow
|
|
2904 @cindex control characters in display
|
|
2905 This buffer-local variable controls how control characters are
|
|
2906 displayed. If it is non-@code{nil}, they are displayed as a caret
|
|
2907 followed by the character: @samp{^A}. If it is @code{nil}, they are
|
|
2908 displayed as a backslash followed by three octal digits: @samp{\001}.
|
|
2909 @end defopt
|
|
2910
|
|
2911 @c Following may have overfull hbox.
|
|
2912 @defvar default-ctl-arrow
|
|
2913 The value of this variable is the default value for @code{ctl-arrow} in
|
|
2914 buffers that do not override it. @xref{Default Value}.
|
|
2915 @end defvar
|
|
2916
|
26696
|
2917 @defopt indicate-empty-lines
|
|
2918 @tindex indicate-empty-lines
|
|
2919 When this is non-@code{nil}, Emacs displays a special glyph in
|
|
2920 each empty line at the end of the buffer, on terminals that
|
|
2921 support it (window systems).
|
|
2922 @end defopt
|
|
2923
|
6598
|
2924 @defopt tab-width
|
|
2925 The value of this variable is the spacing between tab stops used for
|
25875
|
2926 displaying tab characters in Emacs buffers. The value is in units of
|
|
2927 columns, and the default is 8. Note that this feature is completely
|
|
2928 independent of the user-settable tab stops used by the command
|
|
2929 @code{tab-to-tab-stop}. @xref{Indent Tabs}.
|
6598
|
2930 @end defopt
|
|
2931
|
|
2932 @node Display Tables
|
|
2933 @section Display Tables
|
|
2934
|
|
2935 @cindex display table
|
21682
|
2936 You can use the @dfn{display table} feature to control how all possible
|
|
2937 character codes display on the screen. This is useful for displaying
|
25751
|
2938 European languages that have letters not in the @sc{ascii} character
|
21682
|
2939 set.
|
6598
|
2940
|
|
2941 The display table maps each character code into a sequence of
|
25751
|
2942 @dfn{glyphs}, each glyph being a graphic that takes up one character
|
6598
|
2943 position on the screen. You can also define how to display each glyph
|
|
2944 on your terminal, using the @dfn{glyph table}.
|
|
2945
|
21007
|
2946 Display tables affect how the mode line is displayed; if you want to
|
|
2947 force redisplay of the mode line using a new display table, call
|
|
2948 @code{force-mode-line-update} (@pxref{Mode Line Format}).
|
|
2949
|
6598
|
2950 @menu
|
|
2951 * Display Table Format:: What a display table consists of.
|
|
2952 * Active Display Table:: How Emacs selects a display table to use.
|
|
2953 * Glyphs:: How to define a glyph, and what glyphs mean.
|
|
2954 @end menu
|
|
2955
|
|
2956 @node Display Table Format
|
|
2957 @subsection Display Table Format
|
|
2958
|
22138
|
2959 A display table is actually a char-table (@pxref{Char-Tables}) with
|
|
2960 @code{display-table} as its subtype.
|
6598
|
2961
|
|
2962 @defun make-display-table
|
|
2963 This creates and returns a display table. The table initially has
|
|
2964 @code{nil} in all elements.
|
|
2965 @end defun
|
|
2966
|
21007
|
2967 The ordinary elements of the display table are indexed by character
|
|
2968 codes; the element at index @var{c} says how to display the character
|
|
2969 code @var{c}. The value should be @code{nil} or a vector of glyph
|
|
2970 values (@pxref{Glyphs}). If an element is @code{nil}, it says to
|
|
2971 display that character according to the usual display conventions
|
|
2972 (@pxref{Usual Display}).
|
12067
|
2973
|
|
2974 If you use the display table to change the display of newline
|
|
2975 characters, the whole buffer will be displayed as one long ``line.''
|
6598
|
2976
|
21007
|
2977 The display table also has six ``extra slots'' which serve special
|
21682
|
2978 purposes. Here is a table of their meanings; @code{nil} in any slot
|
|
2979 means to use the default for that slot, as stated below.
|
6598
|
2980
|
|
2981 @table @asis
|
21007
|
2982 @item 0
|
6598
|
2983 The glyph for the end of a truncated screen line (the default for this
|
25751
|
2984 is @samp{$}). @xref{Glyphs}. Newer Emacs versions, on some platforms,
|
|
2985 display arrows to indicate truncation---the display table has no effect
|
|
2986 in these situations.
|
21007
|
2987 @item 1
|
6598
|
2988 The glyph for the end of a continued line (the default is @samp{\}).
|
25751
|
2989 Newer Emacs versions, on some platforms, display curved arrows to
|
|
2990 indicate truncation---the display table has no effect in these
|
|
2991 situations.
|
21007
|
2992 @item 2
|
6598
|
2993 The glyph for indicating a character displayed as an octal character
|
|
2994 code (the default is @samp{\}).
|
21007
|
2995 @item 3
|
6598
|
2996 The glyph for indicating a control character (the default is @samp{^}).
|
21007
|
2997 @item 4
|
6598
|
2998 A vector of glyphs for indicating the presence of invisible lines (the
|
|
2999 default is @samp{...}). @xref{Selective Display}.
|
21007
|
3000 @item 5
|
8925
|
3001 The glyph used to draw the border between side-by-side windows (the
|
25751
|
3002 default is @samp{|}). @xref{Splitting Windows}. This takes effect only
|
|
3003 when there are no scroll bars; if scroll bars are supported and in use,
|
|
3004 a scroll bar separates the two windows.
|
6598
|
3005 @end table
|
|
3006
|
|
3007 For example, here is how to construct a display table that mimics the
|
|
3008 effect of setting @code{ctl-arrow} to a non-@code{nil} value:
|
|
3009
|
|
3010 @example
|
|
3011 (setq disptab (make-display-table))
|
|
3012 (let ((i 0))
|
|
3013 (while (< i 32)
|
|
3014 (or (= i ?\t) (= i ?\n)
|
|
3015 (aset disptab i (vector ?^ (+ i 64))))
|
|
3016 (setq i (1+ i)))
|
|
3017 (aset disptab 127 (vector ?^ ??)))
|
|
3018 @end example
|
|
3019
|
22138
|
3020 @defun display-table-slot display-table slot
|
21007
|
3021 This function returns the value of the extra slot @var{slot} of
|
|
3022 @var{display-table}. The argument @var{slot} may be a number from 0 to
|
|
3023 5 inclusive, or a slot name (symbol). Valid symbols are
|
|
3024 @code{truncation}, @code{wrap}, @code{escape}, @code{control},
|
|
3025 @code{selective-display}, and @code{vertical-border}.
|
|
3026 @end defun
|
|
3027
|
22138
|
3028 @defun set-display-table-slot display-table slot value
|
21007
|
3029 This function stores @var{value} in the extra slot @var{slot} of
|
|
3030 @var{display-table}. The argument @var{slot} may be a number from 0 to
|
|
3031 5 inclusive, or a slot name (symbol). Valid symbols are
|
|
3032 @code{truncation}, @code{wrap}, @code{escape}, @code{control},
|
|
3033 @code{selective-display}, and @code{vertical-border}.
|
|
3034 @end defun
|
|
3035
|
25751
|
3036 @defun describe-display-table display-table
|
|
3037 @tindex describe-display-table
|
|
3038 This function displays a description of the display table
|
|
3039 @var{display-table} in a help buffer.
|
|
3040 @end defun
|
|
3041
|
|
3042 @deffn Command describe-current-display-table
|
|
3043 @tindex describe-current-display-table
|
|
3044 This command displays a description of the current display table in a
|
|
3045 help buffer.
|
|
3046 @end deffn
|
|
3047
|
6598
|
3048 @node Active Display Table
|
|
3049 @subsection Active Display Table
|
|
3050 @cindex active display table
|
|
3051
|
|
3052 Each window can specify a display table, and so can each buffer. When
|
|
3053 a buffer @var{b} is displayed in window @var{w}, display uses the
|
|
3054 display table for window @var{w} if it has one; otherwise, the display
|
|
3055 table for buffer @var{b} if it has one; otherwise, the standard display
|
|
3056 table if any. The display table chosen is called the @dfn{active}
|
|
3057 display table.
|
|
3058
|
|
3059 @defun window-display-table window
|
|
3060 This function returns @var{window}'s display table, or @code{nil}
|
|
3061 if @var{window} does not have an assigned display table.
|
|
3062 @end defun
|
|
3063
|
|
3064 @defun set-window-display-table window table
|
|
3065 This function sets the display table of @var{window} to @var{table}.
|
|
3066 The argument @var{table} should be either a display table or
|
|
3067 @code{nil}.
|
|
3068 @end defun
|
|
3069
|
|
3070 @defvar buffer-display-table
|
21682
|
3071 This variable is automatically buffer-local in all buffers; its value in
|
|
3072 a particular buffer specifies the display table for that buffer. If it
|
|
3073 is @code{nil}, that means the buffer does not have an assigned display
|
|
3074 table.
|
6598
|
3075 @end defvar
|
|
3076
|
|
3077 @defvar standard-display-table
|
|
3078 This variable's value is the default display table, used whenever a
|
|
3079 window has no display table and neither does the buffer displayed in
|
|
3080 that window. This variable is @code{nil} by default.
|
|
3081 @end defvar
|
|
3082
|
|
3083 If there is no display table to use for a particular window---that is,
|
21007
|
3084 if the window specifies none, its buffer specifies none, and
|
|
3085 @code{standard-display-table} is @code{nil}---then Emacs uses the usual
|
6598
|
3086 display conventions for all character codes in that window. @xref{Usual
|
|
3087 Display}.
|
|
3088
|
25751
|
3089 A number of functions for changing the standard display table
|
|
3090 are defined in the library @file{disp-table}.
|
|
3091
|
6598
|
3092 @node Glyphs
|
|
3093 @subsection Glyphs
|
|
3094
|
|
3095 @cindex glyph
|
|
3096 A @dfn{glyph} is a generalization of a character; it stands for an
|
|
3097 image that takes up a single character position on the screen. Glyphs
|
|
3098 are represented in Lisp as integers, just as characters are.
|
|
3099
|
|
3100 @cindex glyph table
|
|
3101 The meaning of each integer, as a glyph, is defined by the glyph
|
|
3102 table, which is the value of the variable @code{glyph-table}.
|
|
3103
|
|
3104 @defvar glyph-table
|
|
3105 The value of this variable is the current glyph table. It should be a
|
|
3106 vector; the @var{g}th element defines glyph code @var{g}. If the value
|
|
3107 is @code{nil} instead of a vector, then all glyphs are simple (see
|
|
3108 below).
|
|
3109 @end defvar
|
|
3110
|
|
3111 Here are the possible types of elements in the glyph table:
|
|
3112
|
22252
|
3113 @table @asis
|
|
3114 @item @var{string}
|
6598
|
3115 Send the characters in @var{string} to the terminal to output
|
|
3116 this glyph. This alternative is available on character terminals,
|
21682
|
3117 but not under a window system.
|
6598
|
3118
|
22252
|
3119 @item @var{integer}
|
21682
|
3120 Define this glyph code as an alias for glyph code @var{integer}. You
|
|
3121 can use an alias to specify a face code for the glyph; see below.
|
6598
|
3122
|
|
3123 @item @code{nil}
|
21682
|
3124 This glyph is simple. On an ordinary terminal, the glyph code mod
|
|
3125 524288 is the character to output. In a window system, the glyph code
|
|
3126 mod 524288 is the character to output, and the glyph code divided by
|
|
3127 524288 specifies the face number (@pxref{Face Functions}) to use while
|
|
3128 outputting it. (524288 is
|
27193
|
3129 @ifnottex
|
21682
|
3130 2**19.)
|
27193
|
3131 @end ifnottex
|
21007
|
3132 @tex
|
21682
|
3133 $2^{19}$.)
|
21007
|
3134 @end tex
|
|
3135 @xref{Faces}.
|
6598
|
3136 @end table
|
|
3137
|
|
3138 If a glyph code is greater than or equal to the length of the glyph
|
|
3139 table, that code is automatically simple.
|
|
3140
|
25751
|
3141 @defun create-glyph string
|
|
3142 @tindex create-glyph
|
|
3143 This function returns a newly-allocated glyph code which is set up to
|
|
3144 display by sending @var{string} to the terminal.
|
|
3145 @end defun
|
|
3146
|
6598
|
3147 @node Beeping
|
|
3148 @section Beeping
|
|
3149 @cindex beeping
|
|
3150 @cindex bell
|
|
3151
|
21007
|
3152 This section describes how to make Emacs ring the bell (or blink the
|
|
3153 screen) to attract the user's attention. Be conservative about how
|
|
3154 often you do this; frequent bells can become irritating. Also be
|
|
3155 careful not to use just beeping when signaling an error is more
|
|
3156 appropriate. (@xref{Errors}.)
|
6598
|
3157
|
22138
|
3158 @defun ding &optional do-not-terminate
|
6598
|
3159 @cindex keyboard macro termination
|
|
3160 This function beeps, or flashes the screen (see @code{visible-bell} below).
|
|
3161 It also terminates any keyboard macro currently executing unless
|
22138
|
3162 @var{do-not-terminate} is non-@code{nil}.
|
6598
|
3163 @end defun
|
|
3164
|
22138
|
3165 @defun beep &optional do-not-terminate
|
6598
|
3166 This is a synonym for @code{ding}.
|
|
3167 @end defun
|
|
3168
|
22252
|
3169 @defopt visible-bell
|
6598
|
3170 This variable determines whether Emacs should flash the screen to
|
|
3171 represent a bell. Non-@code{nil} means yes, @code{nil} means no. This
|
21682
|
3172 is effective on a window system, and on a character-only terminal
|
|
3173 provided the terminal's Termcap entry defines the visible bell
|
|
3174 capability (@samp{vb}).
|
22252
|
3175 @end defopt
|
6598
|
3176
|
22138
|
3177 @defvar ring-bell-function
|
21007
|
3178 If this is non-@code{nil}, it specifies how Emacs should ``ring the
|
25875
|
3179 bell.'' Its value should be a function of no arguments. If this is
|
|
3180 non-@code{nil}, it takes precedence over the @code{visible-bell}
|
|
3181 variable.
|
21007
|
3182 @end defvar
|
|
3183
|
6598
|
3184 @node Window Systems
|
|
3185 @section Window Systems
|
|
3186
|
|
3187 Emacs works with several window systems, most notably the X Window
|
|
3188 System. Both Emacs and X use the term ``window'', but use it
|
|
3189 differently. An Emacs frame is a single window as far as X is
|
|
3190 concerned; the individual Emacs windows are not known to X at all.
|
|
3191
|
|
3192 @defvar window-system
|
22252
|
3193 This variable tells Lisp programs what window system Emacs is running
|
|
3194 under. The possible values are
|
|
3195
|
|
3196 @table @code
|
|
3197 @item x
|
6598
|
3198 @cindex X Window System
|
22252
|
3199 Emacs is displaying using X.
|
|
3200 @item pc
|
25751
|
3201 Emacs is displaying using MS-DOS.
|
22252
|
3202 @item w32
|
27332
|
3203 Emacs is displaying using Windows.
|
25751
|
3204 @item mac
|
|
3205 Emacs is displaying using a Macintosh.
|
22252
|
3206 @item nil
|
|
3207 Emacs is using a character-based terminal.
|
|
3208 @end table
|
6598
|
3209 @end defvar
|
|
3210
|
|
3211 @defvar window-setup-hook
|
21007
|
3212 This variable is a normal hook which Emacs runs after handling the
|
|
3213 initialization files. Emacs runs this hook after it has completed
|
25875
|
3214 loading your init file, the default initialization file (if
|
22138
|
3215 any), and the terminal-specific Lisp code, and running the hook
|
6598
|
3216 @code{term-setup-hook}.
|
|
3217
|
|
3218 This hook is used for internal purposes: setting up communication with
|
|
3219 the window system, and creating the initial window. Users should not
|
|
3220 interfere with it.
|
|
3221 @end defvar
|