annotate lispref/display.texi @ 88768:f91d6a22179b

*** empty log message ***
author Dave Love <fx@gnu.org>
date Fri, 14 Jun 2002 23:23:39 +0000
parents 3198ecb4e71f
children dfabb11c1e1a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2 @c This is part of the GNU Emacs Lisp Reference Manual.
35364
19c93f3ebdce *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 35278
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2000, 2001
27189
d2e5f1b7d8e2 Update copyrights.
Gerd Moellmann <gerd@gnu.org>
parents: 27187
diff changeset
4 @c Free Software Foundation, Inc.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5 @c See the file elisp.texi for copying conditions.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6 @setfilename ../info/display
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
7 @node Display, Calendar, Processes, Top
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8 @chapter Emacs Display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 This chapter describes a number of features related to the display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 that Emacs presents to the user.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 @menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 * Refresh Screen:: Clearing the screen and redrawing everything on it.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
15 * Forcing Redisplay:: Forcing redisplay.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 * Truncation:: Folding or wrapping long text lines.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 * The Echo Area:: Where messages are displayed.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
18 * Invisible Text:: Hiding part of the buffer text.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
19 * Selective Display:: Hiding part of the buffer text (the old way).
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 * Overlay Arrow:: Display of an arrow to indicate position.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 * Temporary Displays:: Displays that go away automatically.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22 * Overlays:: Use overlays to highlight parts of the buffer.
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
23 * Width:: How wide a character or string is on the screen.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
24 * Faces:: A face defines a graphics style for text characters:
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
25 font, colors, etc.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
26 * Display Property:: Enabling special display features.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
27 * Images:: Displaying images in Emacs buffers.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28 * Blinking:: How Emacs shows the matching open parenthesis.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29 * Inverse Video:: Specifying how the screen looks.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30 * Usual Display:: The usual conventions for displaying nonprinting chars.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 * Display Tables:: How to specify other conventions.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32 * Beeping:: Audible signal to the user.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 * Window Systems:: Which window system is being used.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 @end menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 @node Refresh Screen
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 @section Refreshing the Screen
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 The function @code{redraw-frame} redisplays the entire contents of a
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
40 given frame (@pxref{Frames}).
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
41
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
42 @c Emacs 19 feature
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
43 @defun redraw-frame frame
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 This function clears and redisplays frame @var{frame}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 Even more powerful is @code{redraw-display}:
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
48
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 @deffn Command redraw-display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50 This function clears and redisplays all visible frames.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51 @end deffn
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
53 Processing user input takes absolute priority over redisplay. If you
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
54 call these functions when input is available, they do nothing
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
55 immediately, but a full redisplay does happen eventually---after all the
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
56 input has been processed.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
57
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58 Normally, suspending and resuming Emacs also refreshes the screen.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59 Some terminal emulators record separate contents for display-oriented
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60 programs such as Emacs and for ordinary sequential display. If you are
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 using such a terminal, you might want to inhibit the redisplay on
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
62 resumption.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 @defvar no-redraw-on-reenter
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65 @cindex suspend (cf. @code{no-redraw-on-reenter})
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66 @cindex resume (cf. @code{no-redraw-on-reenter})
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
67 This variable controls whether Emacs redraws the entire screen after it
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
68 has been suspended and resumed. Non-@code{nil} means there is no need
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
69 to redraw, @code{nil} means redrawing is needed. The default is @code{nil}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
72 @node Forcing Redisplay
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
73 @section Forcing Redisplay
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
74 @cindex forcing redisplay
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
75
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
76 Emacs redisplay normally stops if input arrives, and does not happen
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
77 at all if input is available before it starts. Most of the time, this
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
78 is exactly what you want. However, you can prevent preemption by
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
79 binding @code{redisplay-dont-pause} to a non-@code{nil} value.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
80
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
81 @tindex redisplay-dont-pause
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
82 @defvar redisplay-dont-pause
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
83 If this variable is non-@code{nil}, pending input does not
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
84 prevent or halt redisplay; redisplay occurs, and finishes,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
85 regardless of whether input is available. This feature is available
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
86 as of Emacs 21.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
87 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
88
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
89 You can request a display update, but only if no input is pending,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
90 with @code{(sit-for 0)}. To force a display update even when input is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
91 pending, do this:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
92
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
93 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
94 (let ((redisplay-dont-pause t))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
95 (sit-for 0))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
96 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
97
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
98 @node Truncation
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
99 @section Truncation
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
100 @cindex line wrapping
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
101 @cindex continuation lines
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
102 @cindex @samp{$} in display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
103 @cindex @samp{\} in display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
105 When a line of text extends beyond the right edge of a window, the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
106 line can either be continued on the next screen line, or truncated to
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
107 one screen line. The additional screen lines used to display a long
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
108 text line are called @dfn{continuation} lines. Normally, a @samp{$} in
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
109 the rightmost column of the window indicates truncation; a @samp{\} on
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
110 the rightmost column indicates a line that ``wraps'' onto the next line,
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
111 which is also called @dfn{continuing} the line. (The display table can
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
112 specify alternative indicators; see @ref{Display Tables}.)
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
113
42905
09cd352a779e (Truncation, Overlay Arrow, Usual Display): Add index entries for fringe
Eli Zaretskii <eliz@gnu.org>
parents: 42888
diff changeset
114 @cindex fringes, and line continuation/truncation indicators
09cd352a779e (Truncation, Overlay Arrow, Usual Display): Add index entries for fringe
Eli Zaretskii <eliz@gnu.org>
parents: 42888
diff changeset
115 On a windowed display, the @samp{$} and @samp{\} indicators are
09cd352a779e (Truncation, Overlay Arrow, Usual Display): Add index entries for fringe
Eli Zaretskii <eliz@gnu.org>
parents: 42888
diff changeset
116 replaced with graphics bitmaps displayed on the thin areas right near
09cd352a779e (Truncation, Overlay Arrow, Usual Display): Add index entries for fringe
Eli Zaretskii <eliz@gnu.org>
parents: 42888
diff changeset
117 the window edges, called the @dfn{fringes}.
09cd352a779e (Truncation, Overlay Arrow, Usual Display): Add index entries for fringe
Eli Zaretskii <eliz@gnu.org>
parents: 42888
diff changeset
118
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
119 Note that continuation is different from filling; continuation happens
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
120 on the screen only, not in the buffer contents, and it breaks a line
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
121 precisely at the right margin, not at a word boundary. @xref{Filling}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
122
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
123 @defopt truncate-lines
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
124 This buffer-local variable controls how Emacs displays lines that extend
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125 beyond the right edge of the window. The default is @code{nil}, which
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
126 specifies continuation. If the value is non-@code{nil}, then these
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
127 lines are truncated.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
128
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
129 If the variable @code{truncate-partial-width-windows} is non-@code{nil},
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
130 then truncation is always used for side-by-side windows (within one
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
131 frame) regardless of the value of @code{truncate-lines}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
132 @end defopt
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
133
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
134 @defopt default-truncate-lines
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
135 This variable is the default value for @code{truncate-lines}, for
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
136 buffers that do not have buffer-local values for it.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
137 @end defopt
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
138
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
139 @defopt truncate-partial-width-windows
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
140 This variable controls display of lines that extend beyond the right
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
141 edge of the window, in side-by-side windows (@pxref{Splitting Windows}).
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
142 If it is non-@code{nil}, these lines are truncated; otherwise,
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
143 @code{truncate-lines} says what to do with them.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
144 @end defopt
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
145
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
146 When horizontal scrolling (@pxref{Horizontal Scrolling}) is in use in
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
147 a window, that forces truncation.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
148
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
149 You can override the glyphs that indicate continuation or truncation
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
150 using the display table; see @ref{Display Tables}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
151
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
152 If your buffer contains @emph{very} long lines, and you use
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
153 continuation to display them, just thinking about them can make Emacs
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
154 redisplay slow. The column computation and indentation functions also
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
155 become slow. Then you might find it advisable to set
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
156 @code{cache-long-line-scans} to @code{t}.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
157
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
158 @defvar cache-long-line-scans
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
159 If this variable is non-@code{nil}, various indentation and motion
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
160 functions, and Emacs redisplay, cache the results of scanning the
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
161 buffer, and consult the cache to avoid rescanning regions of the buffer
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
162 unless they are modified.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
163
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
164 Turning on the cache slows down processing of short lines somewhat.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
165
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
166 This variable is automatically buffer-local in every buffer.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
167 @end defvar
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
168
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
169 @node The Echo Area
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
170 @section The Echo Area
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
171 @cindex error display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
172 @cindex echo area
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
173
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
174 The @dfn{echo area} is used for displaying messages made with the
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
175 @code{message} primitive, and for echoing keystrokes. It is not the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
176 same as the minibuffer, despite the fact that the minibuffer appears
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
177 (when active) in the same place on the screen as the echo area. The
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
178 @cite{GNU Emacs Manual} specifies the rules for resolving conflicts
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
179 between the echo area and the minibuffer for use of that screen space
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
180 (@pxref{Minibuffer,, The Minibuffer, emacs, The GNU Emacs Manual}).
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
181 Error messages appear in the echo area; see @ref{Errors}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
182
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
183 You can write output in the echo area by using the Lisp printing
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
184 functions with @code{t} as the stream (@pxref{Output Functions}), or as
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
185 follows:
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
186
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
187 @defun message string &rest arguments
39205
cb857398a0e0 (The Echo Area) <message>: Document message-truncate-lines.
Eli Zaretskii <eliz@gnu.org>
parents: 39032
diff changeset
188 This function displays a message in the echo area. The
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
189 argument @var{string} is similar to a C language @code{printf} control
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
190 string. See @code{format} in @ref{String Conversion}, for the details
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
191 on the conversion specifications. @code{message} returns the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
192 constructed string.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
193
7735
7db892210924 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7086
diff changeset
194 In batch mode, @code{message} prints the message text on the standard
7db892210924 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7086
diff changeset
195 error stream, followed by a newline.
7db892210924 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7086
diff changeset
196
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
197 If @var{string}, or strings among the @var{arguments}, have @code{face}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
198 text properties, these affect the way the message is displayed.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
199
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
200 @c Emacs 19 feature
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
201 If @var{string} is @code{nil}, @code{message} clears the echo area; if
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
202 the echo area has been expanded automatically, this brings it back to
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
203 its normal size. If the minibuffer is active, this brings the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
204 minibuffer contents back onto the screen immediately.
7735
7db892210924 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7086
diff changeset
205
39205
cb857398a0e0 (The Echo Area) <message>: Document message-truncate-lines.
Eli Zaretskii <eliz@gnu.org>
parents: 39032
diff changeset
206 @vindex message-truncate-lines
39221
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39217
diff changeset
207 Normally, displaying a long message resizes the echo area to display
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39217
diff changeset
208 the entire message. But if the variable @code{message-truncate-lines}
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39217
diff changeset
209 is non-@code{nil}, the echo area does not resize, and the message is
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39217
diff changeset
210 truncated to fit it, as in Emacs 20 and before.
39205
cb857398a0e0 (The Echo Area) <message>: Document message-truncate-lines.
Eli Zaretskii <eliz@gnu.org>
parents: 39032
diff changeset
211
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
212 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
213 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
214 (message "Minibuffer depth is %d."
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
215 (minibuffer-depth))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
216 @print{} Minibuffer depth is 0.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
217 @result{} "Minibuffer depth is 0."
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
218 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
219
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
220 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
221 ---------- Echo Area ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
222 Minibuffer depth is 0.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
223 ---------- Echo Area ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
224 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
225 @end example
32261
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
226
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
227 To automatically display a message in the echo area or in a pop-buffer,
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
228 depending on its size, use @code{display-message-or-buffer}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
229 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
230
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
231 @tindex with-temp-message
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
232 @defmac with-temp-message message &rest body
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
233 This construct displays a message in the echo area temporarily, during
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
234 the execution of @var{body}. It displays @var{message}, executes
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
235 @var{body}, then returns the value of the last body form while restoring
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
236 the previous echo area contents.
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
237 @end defmac
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
238
22843
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
239 @defun message-or-box string &rest arguments
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
240 This function displays a message like @code{message}, but may display it
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
241 in a dialog box instead of the echo area. If this function is called in
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
242 a command that was invoked using the mouse---more precisely, if
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
243 @code{last-nonmenu-event} (@pxref{Command Loop Info}) is either
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
244 @code{nil} or a list---then it uses a dialog box or pop-up menu to
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
245 display the message. Otherwise, it uses the echo area. (This is the
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
246 same criterion that @code{y-or-n-p} uses to make a similar decision; see
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
247 @ref{Yes-or-No Queries}.)
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
248
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
249 You can force use of the mouse or of the echo area by binding
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
250 @code{last-nonmenu-event} to a suitable value around the call.
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
251 @end defun
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
252
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
253 @defun message-box string &rest arguments
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
254 This function displays a message like @code{message}, but uses a dialog
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
255 box (or a pop-up menu) whenever that is possible. If it is impossible
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
256 to use a dialog box or pop-up menu, because the terminal does not
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
257 support them, then @code{message-box} uses the echo area, like
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
258 @code{message}.
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
259 @end defun
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
260
32261
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
261 @defun display-message-or-buffer message &optional buffer-name not-this-window frame
32840
07d490290ba8 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 32802
diff changeset
262 @tindex display-message-or-buffer
32261
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
263 This function displays the message @var{message}, which may be either a
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
264 string or a buffer. If it is shorter than the maximum height of the
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
265 echo area, as defined by @code{max-mini-window-height}, it is displayed
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
266 in the echo area, using @code{message}. Otherwise,
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
267 @code{display-buffer} is used to show it in a pop-up buffer.
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
268
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
269 Returns either the string shown in the echo area, or when a pop-up
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
270 buffer is used, the window used to display it.
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
271
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
272 If @var{message} is a string, then the optional argument
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
273 @var{buffer-name} is the name of the buffer used to display it when a
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
274 pop-up buffer is used, defaulting to @samp{*Message*}. In the case
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
275 where @var{message} is a string and displayed in the echo area, it is
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
276 not specified whether the contents are inserted into the buffer anyway.
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
277
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
278 The optional arguments @var{not-this-window} and @var{frame} are as for
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
279 @code{display-buffer}, and only used if a buffer is displayed.
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
280 @end defun
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
281
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
282 @defun current-message
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
283 This function returns the message currently being displayed in the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
284 echo area, or @code{nil} if there is none.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
285 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
286
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
287 @defvar cursor-in-echo-area
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
288 This variable controls where the cursor appears when a message is
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
289 displayed in the echo area. If it is non-@code{nil}, then the cursor
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
290 appears at the end of the message. Otherwise, the cursor appears at
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
291 point---not in the echo area at all.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
292
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
293 The value is normally @code{nil}; Lisp programs bind it to @code{t}
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
294 for brief periods of time.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
295 @end defvar
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
296
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
297 @defvar echo-area-clear-hook
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
298 This normal hook is run whenever the echo area is cleared---either by
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
299 @code{(message nil)} or for any other reason.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
300 @end defvar
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
301
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
302 Almost all the messages displayed in the echo area are also recorded
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
303 in the @samp{*Messages*} buffer.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
304
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
305 @defopt message-log-max
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
306 This variable specifies how many lines to keep in the @samp{*Messages*}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
307 buffer. The value @code{t} means there is no limit on how many lines to
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
308 keep. The value @code{nil} disables message logging entirely. Here's
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
309 how to display a message and prevent it from being logged:
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
310
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
311 @example
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
312 (let (message-log-max)
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
313 (message @dots{}))
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
314 @end example
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
315 @end defopt
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
316
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
317 @defvar echo-keystrokes
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
318 This variable determines how much time should elapse before command
27971
b10a9716fb38 echo-keystrokes change.
Dave Love <fx@gnu.org>
parents: 27654
diff changeset
319 characters echo. Its value must be an integer or floating point number,
b10a9716fb38 echo-keystrokes change.
Dave Love <fx@gnu.org>
parents: 27654
diff changeset
320 which specifies the
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
321 number of seconds to wait before echoing. If the user types a prefix
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
322 key (such as @kbd{C-x}) and then delays this many seconds before
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
323 continuing, the prefix key is echoed in the echo area. (Once echoing
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
324 begins in a key sequence, all subsequent characters in the same key
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
325 sequence are echoed immediately.)
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
326
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
327 If the value is zero, then command input is not echoed.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
328 @end defvar
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
329
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
330 @node Invisible Text
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
331 @section Invisible Text
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
332
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
333 @cindex invisible text
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
334 You can make characters @dfn{invisible}, so that they do not appear on
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
335 the screen, with the @code{invisible} property. This can be either a
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
336 text property (@pxref{Text Properties}) or a property of an overlay
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
337 (@pxref{Overlays}).
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
338
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
339 In the simplest case, any non-@code{nil} @code{invisible} property makes
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
340 a character invisible. This is the default case---if you don't alter
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
341 the default value of @code{buffer-invisibility-spec}, this is how the
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
342 @code{invisible} property works.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
343
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
344 More generally, you can use the variable @code{buffer-invisibility-spec}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
345 to control which values of the @code{invisible} property make text
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
346 invisible. This permits you to classify the text into different subsets
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
347 in advance, by giving them different @code{invisible} values, and
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
348 subsequently make various subsets visible or invisible by changing the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
349 value of @code{buffer-invisibility-spec}.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
350
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
351 Controlling visibility with @code{buffer-invisibility-spec} is
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
352 especially useful in a program to display the list of entries in a
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
353 database. It permits the implementation of convenient filtering
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
354 commands to view just a part of the entries in the database. Setting
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
355 this variable is very fast, much faster than scanning all the text in
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
356 the buffer looking for properties to change.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
357
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
358 @defvar buffer-invisibility-spec
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
359 This variable specifies which kinds of @code{invisible} properties
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
360 actually make a character invisible.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
361
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
362 @table @asis
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
363 @item @code{t}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
364 A character is invisible if its @code{invisible} property is
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
365 non-@code{nil}. This is the default.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
366
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
367 @item a list
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
368 Each element of the list specifies a criterion for invisibility; if a
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
369 character's @code{invisible} property fits any one of these criteria,
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
370 the character is invisible. The list can have two kinds of elements:
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
371
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
372 @table @code
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
373 @item @var{atom}
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
374 A character is invisible if its @code{invisible} property value
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
375 is @var{atom} or if it is a list with @var{atom} as a member.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
376
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
377 @item (@var{atom} . t)
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
378 A character is invisible if its @code{invisible} property value
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
379 is @var{atom} or if it is a list with @var{atom} as a member.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
380 Moreover, if this character is at the end of a line and is followed
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
381 by a visible newline, it displays an ellipsis.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
382 @end table
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
383 @end table
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
384 @end defvar
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
385
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
386 Two functions are specifically provided for adding elements to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
387 @code{buffer-invisibility-spec} and removing elements from it.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
388
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
389 @defun add-to-invisibility-spec element
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
390 Add the element @var{element} to @code{buffer-invisibility-spec}
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
391 (if it is not already present in that list).
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
392 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
393
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
394 @defun remove-from-invisibility-spec element
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
395 Remove the element @var{element} from @code{buffer-invisibility-spec}.
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
396 This does nothing if @var{element} is not in the list.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
397 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
398
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
399 One convention about the use of @code{buffer-invisibility-spec} is
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
400 that a major mode should use the mode's own name as an element of
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
401 @code{buffer-invisibility-spec} and as the value of the @code{invisible}
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
402 property:
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
403
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
404 @example
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
405 ;; @r{If you want to display an ellipsis:}
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
406 (add-to-invisibility-spec '(my-symbol . t))
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
407 ;; @r{If you don't want ellipsis:}
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
408 (add-to-invisibility-spec 'my-symbol)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
409
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
410 (overlay-put (make-overlay beginning end)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
411 'invisible 'my-symbol)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
412
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
413 ;; @r{When done with the overlays:}
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
414 (remove-from-invisibility-spec '(my-symbol . t))
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
415 ;; @r{Or respectively:}
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
416 (remove-from-invisibility-spec 'my-symbol)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
417 @end example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
418
15761
77d451c08a30 Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents: 15074
diff changeset
419 @vindex line-move-ignore-invisible
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
420 Ordinarily, commands that operate on text or move point do not care
15761
77d451c08a30 Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents: 15074
diff changeset
421 whether the text is invisible. The user-level line motion commands
77d451c08a30 Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents: 15074
diff changeset
422 explicitly ignore invisible newlines if
77d451c08a30 Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents: 15074
diff changeset
423 @code{line-move-ignore-invisible} is non-@code{nil}, but only because
77d451c08a30 Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents: 15074
diff changeset
424 they are explicitly programmed to do so.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
425
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
426 Incremental search can make invisible overlays visible temporarily
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
427 and/or permanently when a match includes invisible text. To enable
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
428 this, the overlay should have a non-@code{nil}
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
429 @code{isearch-open-invisible} property. The property value should be a
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
430 function to be called with the overlay as an argument. This function
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
431 should make the overlay visible permanently; it is used when the match
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
432 overlaps the overlay on exit from the search.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
433
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
434 During the search, such overlays are made temporarily visible by
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
435 temporarily modifying their invisible and intangible properties. If you
22267
dfac7398266b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22252
diff changeset
436 want this to be done differently for a certain overlay, give it an
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
437 @code{isearch-open-invisible-temporary} property which is a function.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
438 The function is called with two arguments: the first is the overlay, and
26986
491102e8acc4 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 26698
diff changeset
439 the second is @code{nil} to make the overlay visible, or @code{t} to
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
440 make it invisible again.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
441
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
442 @node Selective Display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
443 @section Selective Display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
444 @cindex selective display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
445
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
446 @dfn{Selective display} refers to a pair of related features for
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
447 hiding certain lines on the screen.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
448
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
449 The first variant, explicit selective display, is designed for use in
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
450 a Lisp program: it controls which lines are hidden by altering the text.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
451 The invisible text feature (@pxref{Invisible Text}) has partially
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
452 replaced this feature.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
453
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
454 In the second variant, the choice of lines to hide is made
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
455 automatically based on indentation. This variant is designed to be a
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
456 user-level feature.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
457
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
458 The way you control explicit selective display is by replacing a
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
459 newline (control-j) with a carriage return (control-m). The text that
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
460 was formerly a line following that newline is now invisible. Strictly
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
461 speaking, it is temporarily no longer a line at all, since only newlines
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
462 can separate lines; it is now part of the previous line.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
463
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
464 Selective display does not directly affect editing commands. For
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
465 example, @kbd{C-f} (@code{forward-char}) moves point unhesitatingly into
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
466 invisible text. However, the replacement of newline characters with
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
467 carriage return characters affects some editing commands. For example,
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
468 @code{next-line} skips invisible lines, since it searches only for
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
469 newlines. Modes that use selective display can also define commands
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
470 that take account of the newlines, or that make parts of the text
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
471 visible or invisible.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
472
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
473 When you write a selectively displayed buffer into a file, all the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
474 control-m's are output as newlines. This means that when you next read
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
475 in the file, it looks OK, with nothing invisible. The selective display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
476 effect is seen only within Emacs.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
477
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
478 @defvar selective-display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
479 This buffer-local variable enables selective display. This means that
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
480 lines, or portions of lines, may be made invisible.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
481
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
482 @itemize @bullet
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
483 @item
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
484 If the value of @code{selective-display} is @code{t}, then the character
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
485 control-m marks the start of invisible text; the control-m, and the rest
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
486 of the line following it, are not displayed. This is explicit selective
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
487 display.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
488
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
489 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
490 If the value of @code{selective-display} is a positive integer, then
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
491 lines that start with more than that many columns of indentation are not
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
492 displayed.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
493 @end itemize
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
494
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
495 When some portion of a buffer is invisible, the vertical movement
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
496 commands operate as if that portion did not exist, allowing a single
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
497 @code{next-line} command to skip any number of invisible lines.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
498 However, character movement commands (such as @code{forward-char}) do
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
499 not skip the invisible portion, and it is possible (if tricky) to insert
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
500 or delete text in an invisible portion.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
501
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
502 In the examples below, we show the @emph{display appearance} of the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
503 buffer @code{foo}, which changes with the value of
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
504 @code{selective-display}. The @emph{contents} of the buffer do not
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
505 change.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
506
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
507 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
508 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
509 (setq selective-display nil)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
510 @result{} nil
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
511
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
512 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
513 1 on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
514 2on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
515 3n this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
516 3n this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
517 2on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
518 1 on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
519 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
520 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
521
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
522 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
523 (setq selective-display 2)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
524 @result{} 2
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
525
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
526 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
527 1 on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
528 2on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
529 2on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
530 1 on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
531 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
532 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
533 @end example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
534 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
535
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
536 @defvar selective-display-ellipses
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
537 If this buffer-local variable is non-@code{nil}, then Emacs displays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
538 @samp{@dots{}} at the end of a line that is followed by invisible text.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
539 This example is a continuation of the previous one.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
540
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
541 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
542 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
543 (setq selective-display-ellipses t)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
544 @result{} t
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
545
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
546 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
547 1 on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
548 2on this column ...
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
549 2on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
550 1 on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
551 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
552 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
553 @end example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
554
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
555 You can use a display table to substitute other text for the ellipsis
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
556 (@samp{@dots{}}). @xref{Display Tables}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
557 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
558
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
559 @node Overlay Arrow
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
560 @section The Overlay Arrow
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
561 @cindex overlay arrow
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
562
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
563 The @dfn{overlay arrow} is useful for directing the user's attention
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
564 to a particular line in a buffer. For example, in the modes used for
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
565 interface to debuggers, the overlay arrow indicates the line of code
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
566 about to be executed.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
567
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
568 @defvar overlay-arrow-string
42905
09cd352a779e (Truncation, Overlay Arrow, Usual Display): Add index entries for fringe
Eli Zaretskii <eliz@gnu.org>
parents: 42888
diff changeset
569 @cindex fringe, and overlay arrow display
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
570 This variable holds the string to display to call attention to a
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
571 particular line, or @code{nil} if the arrow feature is not in use.
29471
215b57502518 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 29151
diff changeset
572 On a graphical display the contents of the string are ignored; instead a
215b57502518 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 29151
diff changeset
573 glyph is displayed in the fringe area to the left of the display area.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
574 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
575
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
576 @defvar overlay-arrow-position
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
577 This variable holds a marker that indicates where to display the overlay
29471
215b57502518 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 29151
diff changeset
578 arrow. It should point at the beginning of a line. On a non-graphical
215b57502518 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 29151
diff changeset
579 display the arrow text
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
580 appears at the beginning of that line, overlaying any text that would
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
581 otherwise appear. Since the arrow is usually short, and the line
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
582 usually begins with indentation, normally nothing significant is
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
583 overwritten.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
584
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
585 The overlay string is displayed only in the buffer that this marker
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
586 points into. Thus, only one buffer can have an overlay arrow at any
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
587 given time.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
588 @c !!! overlay-arrow-position: but the overlay string may remain in the display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
589 @c of some other buffer until an update is required. This should be fixed
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
590 @c now. Is it?
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
591 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
592
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
593 You can do a similar job by creating an overlay with a
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
594 @code{before-string} property. @xref{Overlay Properties}.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
595
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
596 @node Temporary Displays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
597 @section Temporary Displays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
598
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
599 Temporary displays are used by Lisp programs to put output into a
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
600 buffer and then present it to the user for perusal rather than for
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
601 editing. Many help commands use this feature.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
602
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
603 @defspec with-output-to-temp-buffer buffer-name forms@dots{}
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
604 This function executes @var{forms} while arranging to insert any output
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
605 they print into the buffer named @var{buffer-name}, which is first
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
606 created if necessary, and put into Help mode. Finally, the buffer is
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
607 displayed in some window, but not selected.
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
608
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
609 If the @var{forms} do not change the major mode in the output buffer, so
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
610 that it is still Help mode at the end of their execution, then
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
611 @code{with-output-to-temp-buffer} makes this buffer read-only at the
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
612 end, and also scans it for function and variable names to make them into
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
613 clickable cross-references.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
614
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
615 The string @var{buffer-name} specifies the temporary buffer, which
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
616 need not already exist. The argument must be a string, not a buffer.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
617 The buffer is erased initially (with no questions asked), and it is
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
618 marked as unmodified after @code{with-output-to-temp-buffer} exits.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
619
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
620 @code{with-output-to-temp-buffer} binds @code{standard-output} to the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
621 temporary buffer, then it evaluates the forms in @var{forms}. Output
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
622 using the Lisp output functions within @var{forms} goes by default to
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
623 that buffer (but screen display and messages in the echo area, although
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
624 they are ``output'' in the general sense of the word, are not affected).
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
625 @xref{Output Functions}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
626
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
627 Several hooks are available for customizing the behavior
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
628 of this construct; they are listed below.
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
629
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
630 The value of the last form in @var{forms} is returned.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
631
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
632 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
633 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
634 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
635 This is the contents of foo.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
636 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
637 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
638
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
639 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
640 (with-output-to-temp-buffer "foo"
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
641 (print 20)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
642 (print standard-output))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
643 @result{} #<buffer foo>
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
644
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
645 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
646 20
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
647
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
648 #<buffer foo>
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
649
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
650 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
651 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
652 @end example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
653 @end defspec
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
654
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
655 @defvar temp-buffer-show-function
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
656 If this variable is non-@code{nil}, @code{with-output-to-temp-buffer}
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
657 calls it as a function to do the job of displaying a help buffer. The
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
658 function gets one argument, which is the buffer it should display.
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
659
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
660 It is a good idea for this function to run @code{temp-buffer-show-hook}
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
661 just as @code{with-output-to-temp-buffer} normally would, inside of
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
662 @code{save-selected-window} and with the chosen window and buffer
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
663 selected.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
664 @end defvar
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
665
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
666 @defvar temp-buffer-setup-hook
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
667 @tindex temp-buffer-setup-hook
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
668 This normal hook is run by @code{with-output-to-temp-buffer} before
42082
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
669 evaluating @var{body}. When the hook runs, the temporary buffer is
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
670 current. This hook is normally set up with a function to put the
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
671 buffer in Help mode.
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
672 @end defvar
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
673
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
674 @defvar temp-buffer-show-hook
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
675 This normal hook is run by @code{with-output-to-temp-buffer} after
42082
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
676 displaying the temporary buffer. When the hook runs, the temporary buffer
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
677 is current, and the window it was displayed in is selected. This hook
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
678 is normally set up with a function to make the buffer read only, and
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
679 find function names and variable names in it, provided the major mode
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
680 is Help mode.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
681 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
682
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
683 @defun momentary-string-display string position &optional char message
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
684 This function momentarily displays @var{string} in the current buffer at
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
685 @var{position}. It has no effect on the undo list or on the buffer's
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
686 modification status.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
687
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
688 The momentary display remains until the next input event. If the next
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
689 input event is @var{char}, @code{momentary-string-display} ignores it
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
690 and returns. Otherwise, that event remains buffered for subsequent use
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
691 as input. Thus, typing @var{char} will simply remove the string from
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
692 the display, while typing (say) @kbd{C-f} will remove the string from
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
693 the display and later (presumably) move point forward. The argument
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
694 @var{char} is a space by default.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
695
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
696 The return value of @code{momentary-string-display} is not meaningful.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
697
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
698 If the string @var{string} does not contain control characters, you can
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
699 do the same job in a more general way by creating (and then subsequently
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
700 deleting) an overlay with a @code{before-string} property.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
701 @xref{Overlay Properties}.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
702
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
703 If @var{message} is non-@code{nil}, it is displayed in the echo area
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
704 while @var{string} is displayed in the buffer. If it is @code{nil}, a
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
705 default message says to type @var{char} to continue.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
706
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
707 In this example, point is initially located at the beginning of the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
708 second line:
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
709
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
710 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
711 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
712 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
713 This is the contents of foo.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
714 @point{}Second line.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
715 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
716 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
717
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
718 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
719 (momentary-string-display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
720 "**** Important Message! ****"
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
721 (point) ?\r
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
722 "Type RET when done reading")
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
723 @result{} t
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
724 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
725
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
726 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
727 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
728 This is the contents of foo.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
729 **** Important Message! ****Second line.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
730 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
731
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
732 ---------- Echo Area ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
733 Type RET when done reading
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
734 ---------- Echo Area ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
735 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
736 @end example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
737 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
738
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
739 @node Overlays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
740 @section Overlays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
741 @cindex overlays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
742
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
743 You can use @dfn{overlays} to alter the appearance of a buffer's text on
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
744 the screen, for the sake of presentation features. An overlay is an
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
745 object that belongs to a particular buffer, and has a specified
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
746 beginning and end. It also has properties that you can examine and set;
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
747 these affect the display of the text within the overlay.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
748
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
749 @menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
750 * Overlay Properties:: How to read and set properties.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
751 What properties do to the screen display.
26698
73f718a9df4b (Overlays): Add menu entry for Finding Overlays.
Dave Love <fx@gnu.org>
parents: 26696
diff changeset
752 * Managing Overlays:: Creating and moving overlays.
73f718a9df4b (Overlays): Add menu entry for Finding Overlays.
Dave Love <fx@gnu.org>
parents: 26696
diff changeset
753 * Finding Overlays:: Searching for overlays.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
754 @end menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
755
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
756 @node Overlay Properties
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
757 @subsection Overlay Properties
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
758
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
759 Overlay properties are like text properties in that the properties that
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
760 alter how a character is displayed can come from either source. But in
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
761 most respects they are different. Text properties are considered a part
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
762 of the text; overlays are specifically considered not to be part of the
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
763 text. Thus, copying text between various buffers and strings preserves
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
764 text properties, but does not try to preserve overlays. Changing a
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
765 buffer's text properties marks the buffer as modified, while moving an
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
766 overlay or changing its properties does not. Unlike text property
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
767 changes, overlay changes are not recorded in the buffer's undo list.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
768 @xref{Text Properties}, for comparison.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
769
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
770 These functions are used for reading and writing the properties of an
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
771 overlay:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
772
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
773 @defun overlay-get overlay prop
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
774 This function returns the value of property @var{prop} recorded in
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
775 @var{overlay}, if any. If @var{overlay} does not record any value for
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
776 that property, but it does have a @code{category} property which is a
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
777 symbol, that symbol's @var{prop} property is used. Otherwise, the value
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
778 is @code{nil}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
779 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
780
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
781 @defun overlay-put overlay prop value
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
782 This function sets the value of property @var{prop} recorded in
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
783 @var{overlay} to @var{value}. It returns @var{value}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
784 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
785
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
786 See also the function @code{get-char-property} which checks both
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
787 overlay properties and text properties for a given character.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
788 @xref{Examining Properties}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
789
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
790 Many overlay properties have special meanings; here is a table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
791 of them:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
792
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
793 @table @code
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
794 @item priority
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
795 @kindex priority @r{(overlay property)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
796 This property's value (which should be a nonnegative number) determines
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
797 the priority of the overlay. The priority matters when two or more
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
798 overlays cover the same character and both specify a face for display;
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
799 the one whose @code{priority} value is larger takes priority over the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
800 other, and its face attributes override the face attributes of the lower
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
801 priority overlay.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
802
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
803 Currently, all overlays take priority over text properties. Please
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
804 avoid using negative priority values, as we have not yet decided just
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
805 what they should mean.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
806
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
807 @item window
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
808 @kindex window @r{(overlay property)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
809 If the @code{window} property is non-@code{nil}, then the overlay
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
810 applies only on that window.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
811
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
812 @item category
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
813 @kindex category @r{(overlay property)}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
814 If an overlay has a @code{category} property, we call it the
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
815 @dfn{category} of the overlay. It should be a symbol. The properties
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
816 of the symbol serve as defaults for the properties of the overlay.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
817
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
818 @item face
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
819 @kindex face @r{(overlay property)}
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
820 This property controls the way text is displayed---for example, which
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
821 font and which colors. @xref{Faces}, for more information.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
822
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
823 In the simplest case, the value is a face name. It can also be a list;
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
824 then each element can be any of these possibilities:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
825
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
826 @itemize @bullet
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
827 @item
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
828 A face name (a symbol or string).
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
829
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
830 @item
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
831 Starting in Emacs 21, a property list of face attributes. This has the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
832 form (@var{keyword} @var{value} @dots{}), where each @var{keyword} is a
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
833 face attribute name and @var{value} is a meaningful value for that
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
834 attribute. With this feature, you do not need to create a face each
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
835 time you want to specify a particular attribute for certain text.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
836 @xref{Face Attributes}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
837
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
838 @item
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
839 A cons cell of the form @code{(foreground-color . @var{color-name})} or
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
840 @code{(background-color . @var{color-name})}. These elements specify
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
841 just the foreground color or just the background color.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
842
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
843 @code{(foreground-color . @var{color-name})} is equivalent to
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
844 @code{(:foreground @var{color-name})}, and likewise for the background.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
845 @end itemize
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
846
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
847 @item mouse-face
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
848 @kindex mouse-face @r{(overlay property)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
849 This property is used instead of @code{face} when the mouse is within
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
850 the range of the overlay.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
851
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
852 @item display
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
853 @kindex display @r{(overlay property)}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
854 This property activates various features that change the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
855 way text is displayed. For example, it can make text appear taller
38278
9e543d761717 Fix several typos.
Gerd Moellmann <gerd@gnu.org>
parents: 37949
diff changeset
856 or shorter, higher or lower, wider or narrower, or replaced with an image.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
857 @xref{Display Property}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
858
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
859 @item help-echo
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
860 @kindex help-echo @r{(text property)}
31373
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
861 If an overlay has a @code{help-echo} property, then when you move the
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
862 mouse onto the text in the overlay, Emacs displays a help string in the
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
863 echo area, or in the tooltip window. For details see @ref{Text
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
864 help-echo}. This feature is available starting in Emacs 21.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
865
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
866 @item modification-hooks
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
867 @kindex modification-hooks @r{(overlay property)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
868 This property's value is a list of functions to be called if any
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
869 character within the overlay is changed or if text is inserted strictly
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
870 within the overlay.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
871
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
872 The hook functions are called both before and after each change.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
873 If the functions save the information they receive, and compare notes
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
874 between calls, they can determine exactly what change has been made
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
875 in the buffer text.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
876
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
877 When called before a change, each function receives four arguments: the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
878 overlay, @code{nil}, and the beginning and end of the text range to be
7086
075343a6b32b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6598
diff changeset
879 modified.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
880
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
881 When called after a change, each function receives five arguments: the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
882 overlay, @code{t}, the beginning and end of the text range just
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
883 modified, and the length of the pre-change text replaced by that range.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
884 (For an insertion, the pre-change length is zero; for a deletion, that
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
885 length is the number of characters deleted, and the post-change
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
886 beginning and end are equal.)
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
887
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
888 @item insert-in-front-hooks
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
889 @kindex insert-in-front-hooks @r{(overlay property)}
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
890 This property's value is a list of functions to be called before and
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
891 after inserting text right at the beginning of the overlay. The calling
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
892 conventions are the same as for the @code{modification-hooks} functions.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
893
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
894 @item insert-behind-hooks
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
895 @kindex insert-behind-hooks @r{(overlay property)}
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
896 This property's value is a list of functions to be called before and
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
897 after inserting text right at the end of the overlay. The calling
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
898 conventions are the same as for the @code{modification-hooks} functions.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
899
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
900 @item invisible
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
901 @kindex invisible @r{(overlay property)}
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
902 The @code{invisible} property can make the text in the overlay
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
903 invisible, which means that it does not appear on the screen.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
904 @xref{Invisible Text}, for details.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
905
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
906 @item intangible
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
907 @kindex intangible @r{(overlay property)}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
908 The @code{intangible} property on an overlay works just like the
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
909 @code{intangible} text property. @xref{Special Properties}, for details.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
910
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
911 @item isearch-open-invisible
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
912 This property tells incremental search how to make an invisible overlay
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
913 visible, permanently, if the final match overlaps it. @xref{Invisible
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
914 Text}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
915
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
916 @item isearch-open-invisible-temporary
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
917 This property tells incremental search how to make an invisible overlay
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
918 visible, temporarily, during the search. @xref{Invisible Text}.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
919
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
920 @item before-string
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
921 @kindex before-string @r{(overlay property)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
922 This property's value is a string to add to the display at the beginning
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
923 of the overlay. The string does not appear in the buffer in any
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
924 sense---only on the screen.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
925
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
926 @item after-string
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
927 @kindex after-string @r{(overlay property)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
928 This property's value is a string to add to the display at the end of
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
929 the overlay. The string does not appear in the buffer in any
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
930 sense---only on the screen.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
931
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
932 @item evaporate
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
933 @kindex evaporate @r{(overlay property)}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
934 If this property is non-@code{nil}, the overlay is deleted automatically
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
935 if it ever becomes empty (i.e., if it spans no characters).
16123
ec5f48fe0320 Mention local-value property on an overlay.
Richard M. Stallman <rms@gnu.org>
parents: 15761
diff changeset
936
29102
ba9cfbfc601e *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29076
diff changeset
937 @item local-map
29076
c7c150b377c0 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28792
diff changeset
938 @cindex keymap of character (and overlays)
29102
ba9cfbfc601e *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29076
diff changeset
939 @kindex local-map @r{(overlay property)}
29076
c7c150b377c0 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28792
diff changeset
940 If this property is non-@code{nil}, it specifies a keymap for a portion
c7c150b377c0 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28792
diff changeset
941 of the text. The property's value replaces the buffer's local map, when
c7c150b377c0 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28792
diff changeset
942 the character after point is within the overlay. @xref{Active Keymaps}.
33996
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
943
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
944 @item keymap
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
945 @kindex keymap @r{(overlay property)}
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
946 The @code{keymap} property is similar to @code{local-map} but overrides the
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
947 buffer's local map (and the map specified by the @code{local-map}
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
948 property) rather than replacing it.
29076
c7c150b377c0 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28792
diff changeset
949 @end table
c7c150b377c0 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28792
diff changeset
950
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
951 @node Managing Overlays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
952 @subsection Managing Overlays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
953
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
954 This section describes the functions to create, delete and move
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
955 overlays, and to examine their contents.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
956
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
957 @defun make-overlay start end &optional buffer front-advance rear-advance
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
958 This function creates and returns an overlay that belongs to
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
959 @var{buffer} and ranges from @var{start} to @var{end}. Both @var{start}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
960 and @var{end} must specify buffer positions; they may be integers or
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
961 markers. If @var{buffer} is omitted, the overlay is created in the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
962 current buffer.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
963
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
964 The arguments @var{front-advance} and @var{rear-advance} specify the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
965 insertion type for the start of the overlay and for the end of the
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
966 overlay, respectively. @xref{Marker Insertion Types}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
967 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
968
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
969 @defun overlay-start overlay
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
970 This function returns the position at which @var{overlay} starts,
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
971 as an integer.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
972 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
973
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
974 @defun overlay-end overlay
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
975 This function returns the position at which @var{overlay} ends,
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
976 as an integer.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
977 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
978
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
979 @defun overlay-buffer overlay
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
980 This function returns the buffer that @var{overlay} belongs to.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
981 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
982
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
983 @defun delete-overlay overlay
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
984 This function deletes @var{overlay}. The overlay continues to exist as
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
985 a Lisp object, and its property list is unchanged, but it ceases to be
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
986 attached to the buffer it belonged to, and ceases to have any effect on
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
987 display.
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
988
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
989 A deleted overlay is not permanently disconnected. You can give it a
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
990 position in a buffer again by calling @code{move-overlay}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
991 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
992
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
993 @defun move-overlay overlay start end &optional buffer
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
994 This function moves @var{overlay} to @var{buffer}, and places its bounds
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
995 at @var{start} and @var{end}. Both arguments @var{start} and @var{end}
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
996 must specify buffer positions; they may be integers or markers.
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
997
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
998 If @var{buffer} is omitted, @var{overlay} stays in the same buffer it
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
999 was already associated with; if @var{overlay} was deleted, it goes into
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1000 the current buffer.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1001
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1002 The return value is @var{overlay}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1003
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1004 This is the only valid way to change the endpoints of an overlay. Do
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1005 not try modifying the markers in the overlay by hand, as that fails to
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1006 update other vital data structures and can cause some overlays to be
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1007 ``lost''.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1008 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1009
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1010 Here are some examples:
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1011
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1012 @example
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1013 ;; @r{Create an overlay.}
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1014 (setq foo (make-overlay 1 10))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1015 @result{} #<overlay from 1 to 10 in display.texi>
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1016 (overlay-start foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1017 @result{} 1
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1018 (overlay-end foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1019 @result{} 10
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1020 (overlay-buffer foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1021 @result{} #<buffer display.texi>
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1022 ;; @r{Give it a property we can check later.}
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1023 (overlay-put foo 'happy t)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1024 @result{} t
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1025 ;; @r{Verify the property is present.}
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1026 (overlay-get foo 'happy)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1027 @result{} t
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1028 ;; @r{Move the overlay.}
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1029 (move-overlay foo 5 20)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1030 @result{} #<overlay from 5 to 20 in display.texi>
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1031 (overlay-start foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1032 @result{} 5
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1033 (overlay-end foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1034 @result{} 20
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1035 ;; @r{Delete the overlay.}
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1036 (delete-overlay foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1037 @result{} nil
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1038 ;; @r{Verify it is deleted.}
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1039 foo
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1040 @result{} #<overlay in no buffer>
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1041 ;; @r{A deleted overlay has no position.}
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1042 (overlay-start foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1043 @result{} nil
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1044 (overlay-end foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1045 @result{} nil
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1046 (overlay-buffer foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1047 @result{} nil
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1048 ;; @r{Undelete the overlay.}
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1049 (move-overlay foo 1 20)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1050 @result{} #<overlay from 1 to 20 in display.texi>
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1051 ;; @r{Verify the results.}
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1052 (overlay-start foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1053 @result{} 1
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1054 (overlay-end foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1055 @result{} 20
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1056 (overlay-buffer foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1057 @result{} #<buffer display.texi>
27331
be0a552c8320 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27193
diff changeset
1058 ;; @r{Moving and deleting the overlay does not change its properties.}
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1059 (overlay-get foo 'happy)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1060 @result{} t
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1061 @end example
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1062
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1063 @node Finding Overlays
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1064 @subsection Searching for Overlays
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1065
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1066 @defun overlays-at pos
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1067 This function returns a list of all the overlays that cover the
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1068 character at position @var{pos} in the current buffer. The list is in
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1069 no particular order. An overlay contains position @var{pos} if it
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1070 begins at or before @var{pos}, and ends after @var{pos}.
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1071
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1072 To illustrate usage, here is a Lisp function that returns a list of the
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1073 overlays that specify property @var{prop} for the character at point:
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1074
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1075 @smallexample
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1076 (defun find-overlays-specifying (prop)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1077 (let ((overlays (overlays-at (point)))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1078 found)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1079 (while overlays
37170
29f2615d958f (Finding Overlays): Fix example code.
Gerd Moellmann <gerd@gnu.org>
parents: 36935
diff changeset
1080 (let ((overlay (car overlays)))
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1081 (if (overlay-get overlay prop)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1082 (setq found (cons overlay found))))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1083 (setq overlays (cdr overlays)))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1084 found))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1085 @end smallexample
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1086 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1087
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1088 @defun overlays-in beg end
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1089 This function returns a list of the overlays that overlap the region
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1090 @var{beg} through @var{end}. ``Overlap'' means that at least one
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1091 character is contained within the overlay and also contained within the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1092 specified region; however, empty overlays are included in the result if
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1093 they are located at @var{beg}, or strictly between @var{beg} and @var{end}.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1094 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1095
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1096 @defun next-overlay-change pos
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1097 This function returns the buffer position of the next beginning or end
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1098 of an overlay, after @var{pos}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1099 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1100
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1101 @defun previous-overlay-change pos
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1102 This function returns the buffer position of the previous beginning or
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1103 end of an overlay, before @var{pos}.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1104 @end defun
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1105
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1106 Here's an easy way to use @code{next-overlay-change} to search for the
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1107 next character which gets a non-@code{nil} @code{happy} property from
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1108 either its overlays or its text properties (@pxref{Property Search}):
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1109
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1110 @smallexample
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1111 (defun find-overlay-prop (prop)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1112 (save-excursion
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1113 (while (and (not (eobp))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1114 (not (get-char-property (point) 'happy)))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1115 (goto-char (min (next-overlay-change (point))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1116 (next-single-property-change (point) 'happy))))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1117 (point)))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1118 @end smallexample
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1119
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1120 @node Width
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1121 @section Width
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1122
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1123 Since not all characters have the same width, these functions let you
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1124 check the width of a character. @xref{Primitive Indent}, and
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1125 @ref{Screen Lines}, for related functions.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1126
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1127 @defun char-width char
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1128 This function returns the width in columns of the character @var{char},
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1129 if it were displayed in the current buffer and the selected window.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1130 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1131
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1132 @defun string-width string
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1133 This function returns the width in columns of the string @var{string},
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1134 if it were displayed in the current buffer and the selected window.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1135 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1136
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1137 @defun truncate-string-to-width string width &optional start-column padding
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1138 This function returns the part of @var{string} that fits within
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1139 @var{width} columns, as a new string.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1140
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1141 If @var{string} does not reach @var{width}, then the result ends where
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1142 @var{string} ends. If one multi-column character in @var{string}
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1143 extends across the column @var{width}, that character is not included in
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1144 the result. Thus, the result can fall short of @var{width} but cannot
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1145 go beyond it.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1146
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1147 The optional argument @var{start-column} specifies the starting column.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1148 If this is non-@code{nil}, then the first @var{start-column} columns of
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1149 the string are omitted from the value. If one multi-column character in
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1150 @var{string} extends across the column @var{start-column}, that
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1151 character is not included.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1152
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1153 The optional argument @var{padding}, if non-@code{nil}, is a padding
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1154 character added at the beginning and end of the result string, to extend
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1155 it to exactly @var{width} columns. The padding character is used at the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1156 end of the result if it falls short of @var{width}. It is also used at
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1157 the beginning of the result if one multi-column character in
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1158 @var{string} extends across the column @var{start-column}.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1159
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1160 @example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1161 (truncate-string-to-width "\tab\t" 12 4)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1162 @result{} "ab"
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1163 (truncate-string-to-width "\tab\t" 12 4 ?\ )
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1164 @result{} " ab "
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1165 @end example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1166 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1167
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1168 @node Faces
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1169 @section Faces
40469
aa8474236e9e Index "faces" instead of "face".
Richard M. Stallman <rms@gnu.org>
parents: 40310
diff changeset
1170 @cindex faces
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1171
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1172 A @dfn{face} is a named collection of graphical attributes: font
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1173 family, foreground color, background color, optional underlining, and
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1174 many others. Faces are used in Emacs to control the style of display of
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1175 particular parts of the text or the frame.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1176
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1177 @cindex face id
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1178 Each face has its own @dfn{face number}, which distinguishes faces at
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1179 low levels within Emacs. However, for most purposes, you refer to
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1180 faces in Lisp programs by their names.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1181
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1182 @defun facep object
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1183 This function returns @code{t} if @var{object} is a face name symbol (or
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1184 if it is a vector of the kind used internally to record face data). It
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1185 returns @code{nil} otherwise.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1186 @end defun
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1187
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1188 Each face name is meaningful for all frames, and by default it has the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1189 same meaning in all frames. But you can arrange to give a particular
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1190 face name a special meaning in one frame if you wish.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1191
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1192 @menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1193 * Standard Faces:: The faces Emacs normally comes with.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1194 * Defining Faces:: How to define a face with @code{defface}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1195 * Face Attributes:: What is in a face?
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1196 * Attribute Functions:: Functions to examine and set face attributes.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1197 * Merging Faces:: How Emacs combines the faces specified for a character.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1198 * Font Selection:: Finding the best available font for a face.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1199 * Face Functions:: How to define and examine faces.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1200 * Auto Faces:: Hook for automatic face assignment.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1201 * Font Lookup:: Looking up the names of available fonts
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1202 and information about them.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1203 * Fontsets:: A fontset is a collection of fonts
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1204 that handle a range of character sets.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1205 @end menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1206
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1207 @node Standard Faces
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1208 @subsection Standard Faces
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1209
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1210 This table lists all the standard faces and their uses. Most of them
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1211 are used for displaying certain parts of the frames or certain kinds of
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1212 text; you can control how those places look by customizing these faces.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1213
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1214 @table @code
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1215 @item default
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1216 @kindex default @r{(face name)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1217 This face is used for ordinary text.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1218
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1219 @item mode-line
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1220 @kindex mode-line @r{(face name)}
43262
af1ba8f61638 (Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents: 43099
diff changeset
1221 This face is used for the mode line of the selected window, and for
af1ba8f61638 (Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents: 43099
diff changeset
1222 menu bars when toolkit menus are not used---but only if
af1ba8f61638 (Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents: 43099
diff changeset
1223 @code{mode-line-inverse-video} is non-@code{nil}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1224
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1225 @item modeline
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1226 @kindex modeline @r{(face name)}
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1227 This is an alias for the @code{mode-line} face, for compatibility with
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1228 old Emacs versions.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1229
43262
af1ba8f61638 (Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents: 43099
diff changeset
1230 @item mode-line-inactive
af1ba8f61638 (Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents: 43099
diff changeset
1231 @kindex mode-line-inactive @r{(face name)}
af1ba8f61638 (Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents: 43099
diff changeset
1232 This face is used for mode lines of non-selected windows.
43290
3198ecb4e71f Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 43262
diff changeset
1233 This face inherits from @code{mode-line}, so changes
3198ecb4e71f Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 43262
diff changeset
1234 in that face affect all windows.
43262
af1ba8f61638 (Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents: 43099
diff changeset
1235
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1236 @item header-line
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1237 @kindex header-line @r{(face name)}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1238 This face is used for the header lines of windows that have them.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1239
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1240 @item menu
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1241 This face controls the display of menus, both their colors and their
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1242 font. (This works only on certain systems.)
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1243
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1244 @item fringe
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1245 @kindex fringe @r{(face name)}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1246 This face controls the colors of window fringes, the thin areas on
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1247 either side that are used to display continuation and truncation glyphs.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1248
43099
761d92c0f64e (Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents: 42905
diff changeset
1249 @item minibuffer-prompt
761d92c0f64e (Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents: 42905
diff changeset
1250 @kindex minibuffer-prompt @r{(face name)}
761d92c0f64e (Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents: 42905
diff changeset
1251 @vindex minibuffer-prompt-properties
761d92c0f64e (Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents: 42905
diff changeset
1252 This face is used for the text of minibuffer prompts. By default,
761d92c0f64e (Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents: 42905
diff changeset
1253 Emacs automatically adds this face to the value of
761d92c0f64e (Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents: 42905
diff changeset
1254 @code{minibuffer-prompt-properties}, which is a list of text
761d92c0f64e (Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents: 42905
diff changeset
1255 properties used to display the prompt text.
761d92c0f64e (Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents: 42905
diff changeset
1256
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1257 @item scroll-bar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1258 @kindex scroll-bar @r{(face name)}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1259 This face controls the colors for display of scroll bars.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1260
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1261 @item tool-bar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1262 @kindex tool-bar @r{(face name)}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1263 This face is used for display of the tool bar, if any.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1264
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1265 @item region
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1266 @kindex region @r{(face name)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1267 This face is used for highlighting the region in Transient Mark mode.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1268
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1269 @item secondary-selection
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1270 @kindex secondary-selection @r{(face name)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1271 This face is used to show any secondary selection you have made.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1272
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1273 @item highlight
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1274 @kindex highlight @r{(face name)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1275 This face is meant to be used for highlighting for various purposes.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1276
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1277 @item trailing-whitespace
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1278 @kindex trailing-whitespace @r{(face name)}
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1279 This face is used to display excess whitespace at the end of a line,
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1280 if @code{show-trailing-whitespace} is non-@code{nil}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1281 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1282
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1283 In contrast, these faces are provided to change the appearance of text
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1284 in specific ways. You can use them on specific text, when you want
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1285 the effects they produce.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1286
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1287 @table @code
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1288 @item bold
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1289 @kindex bold @r{(face name)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1290 This face uses a bold font, if possible. It uses the bold variant of
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1291 the frame's font, if it has one. It's up to you to choose a default
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1292 font that has a bold variant, if you want to use one.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1293
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1294 @item italic
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1295 @kindex italic @r{(face name)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1296 This face uses the italic variant of the frame's font, if it has one.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1297
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1298 @item bold-italic
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1299 @kindex bold-italic @r{(face name)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1300 This face uses the bold italic variant of the frame's font, if it has
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1301 one.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1302
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1303 @item underline
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1304 @kindex underline @r{(face name)}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1305 This face underlines text.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1306
38278
9e543d761717 Fix several typos.
Gerd Moellmann <gerd@gnu.org>
parents: 37949
diff changeset
1307 @item fixed-pitch
9e543d761717 Fix several typos.
Gerd Moellmann <gerd@gnu.org>
parents: 37949
diff changeset
1308 @kindex fixed-pitch @r{(face name)}
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1309 This face forces use of a particular fixed-width font.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1310
38278
9e543d761717 Fix several typos.
Gerd Moellmann <gerd@gnu.org>
parents: 37949
diff changeset
1311 @item variable-pitch
9e543d761717 Fix several typos.
Gerd Moellmann <gerd@gnu.org>
parents: 37949
diff changeset
1312 @kindex variable-pitch @r{(face name)}
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1313 This face forces use of a particular variable-width font. It's
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1314 reasonable to customize this to use a different variable-width font, if
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1315 you like, but you should not make it a fixed-width font.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1316 @end table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1317
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1318 @defvar show-trailing-whitespace
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1319 @tindex show-trailing-whitespace
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1320 If this variable is non-@code{nil}, Emacs uses the
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1321 @code{trailing-whitespace} face to display any spaces and tabs at the
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1322 end of a line.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1323 @end defvar
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1324
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1325 @node Defining Faces
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1326 @subsection Defining Faces
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1327
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1328 The way to define a new face is with @code{defface}. This creates a
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1329 kind of customization item (@pxref{Customization}) which the user can
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1330 customize using the Customization buffer (@pxref{Easy Customization,,,
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1331 emacs, The GNU Emacs Manual}).
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1332
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1333 @defmac defface face spec doc [keyword value]...
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1334 This declares @var{face} as a customizable face that defaults according
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1335 to @var{spec}. You should not quote the symbol @var{face}. The
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1336 argument @var{doc} specifies the face documentation. The keywords you
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1337 can use in @code{defface} are the same ones that are meaningful in both
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1338 @code{defgroup} and @code{defcustom} (@pxref{Common Keywords}).
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1339
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1340 When @code{defface} executes, it defines the face according to
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1341 @var{spec}, then uses any customizations that were read from the
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1342 init file (@pxref{Init File}) to override that specification.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1343
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1344 The purpose of @var{spec} is to specify how the face should appear on
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1345 different kinds of terminals. It should be an alist whose elements have
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1346 the form @code{(@var{display} @var{atts})}. Each element's @sc{car},
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1347 @var{display}, specifies a class of terminals. The element's second element,
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1348 @var{atts}, is a list of face attributes and their values; it specifies
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1349 what the face should look like on that kind of terminal. The possible
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1350 attributes are defined in the value of @code{custom-face-attributes}.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1351
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1352 The @var{display} part of an element of @var{spec} determines which
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1353 frames the element applies to. If more than one element of @var{spec}
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1354 matches a given frame, the first matching element is the only one used
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1355 for that frame. There are two possibilities for @var{display}:
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1356
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1357 @table @asis
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1358 @item @code{t}
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1359 This element of @var{spec} matches all frames. Therefore, any
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1360 subsequent elements of @var{spec} are never used. Normally
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1361 @code{t} is used in the last (or only) element of @var{spec}.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1362
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1363 @item a list
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1364 If @var{display} is a list, each element should have the form
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1365 @code{(@var{characteristic} @var{value}@dots{})}. Here
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1366 @var{characteristic} specifies a way of classifying frames, and the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1367 @var{value}s are possible classifications which @var{display} should
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1368 apply to. Here are the possible values of @var{characteristic}:
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1369
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1370 @table @code
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1371 @item type
32802
66f219c7e8ca (Defining Faces): Document `graphic' display type in face specs.
Miles Bader <miles@gnu.org>
parents: 32552
diff changeset
1372 The kind of window system the frame uses---either @code{graphic} (any
66f219c7e8ca (Defining Faces): Document `graphic' display type in face specs.
Miles Bader <miles@gnu.org>
parents: 32552
diff changeset
1373 graphics-capable display), @code{x}, @code{pc} (for the MS-DOS console),
66f219c7e8ca (Defining Faces): Document `graphic' display type in face specs.
Miles Bader <miles@gnu.org>
parents: 32552
diff changeset
1374 @code{w32} (for MS Windows 9X/NT), or @code{tty} (a non-graphics-capable
66f219c7e8ca (Defining Faces): Document `graphic' display type in face specs.
Miles Bader <miles@gnu.org>
parents: 32552
diff changeset
1375 display).
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1376
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1377 @item class
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1378 What kinds of colors the frame supports---either @code{color},
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1379 @code{grayscale}, or @code{mono}.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1380
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1381 @item background
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1382 The kind of background---either @code{light} or @code{dark}.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1383 @end table
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1384
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1385 If an element of @var{display} specifies more than one @var{value} for a
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1386 given @var{characteristic}, any of those values is acceptable. If
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1387 @var{display} has more than one element, each element should specify a
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1388 different @var{characteristic}; then @emph{each} characteristic of the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1389 frame must match one of the @var{value}s specified for it in
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1390 @var{display}.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1391 @end table
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1392 @end defmac
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1393
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1394 Here's how the standard face @code{region} is defined:
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1395
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1396 @example
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1397 @group
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1398 (defface region
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1399 `((((type tty) (class color))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1400 (:background "blue" :foreground "white"))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1401 @end group
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1402 (((type tty) (class mono))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1403 (:inverse-video t))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1404 (((class color) (background dark))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1405 (:background "blue"))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1406 (((class color) (background light))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1407 (:background "lightblue"))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1408 (t (:background "gray")))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1409 @group
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1410 "Basic face for highlighting the region."
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1411 :group 'basic-faces)
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1412 @end group
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1413 @end example
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1414
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1415 Internally, @code{defface} uses the symbol property
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1416 @code{face-defface-spec} to record the face attributes specified in
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1417 @code{defface}, @code{saved-face} for the attributes saved by the user
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1418 with the customization buffer, and @code{face-documentation} for the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1419 documentation string.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1420
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1421 @defopt frame-background-mode
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1422 This option, if non-@code{nil}, specifies the background type to use for
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1423 interpreting face definitions. If it is @code{dark}, then Emacs treats
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1424 all frames as if they had a dark background, regardless of their actual
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1425 background colors. If it is @code{light}, then Emacs treats all frames
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1426 as if they had a light background.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1427 @end defopt
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1428
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1429 @node Face Attributes
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1430 @subsection Face Attributes
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1431 @cindex face attributes
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1432
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1433 The effect of using a face is determined by a fixed set of @dfn{face
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1434 attributes}. This table lists all the face attributes, and what they
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1435 mean. Note that in general, more than one face can be specified for a
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1436 given piece of text; when that happens, the attributes of all the faces
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1437 are merged to specify how to display the text. @xref{Merging Faces}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1438
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1439 In Emacs 21, any attribute in a face can have the value
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1440 @code{unspecified}. This means the face doesn't specify that attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1441 In face merging, when the first face fails to specify a particular
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1442 attribute, that means the next face gets a chance. However, the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1443 @code{default} face must specify all attributes.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1444
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1445 Some of these font attributes are meaningful only on certain kinds of
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1446 displays---if your display cannot handle a certain attribute, the
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1447 attribute is ignored. (The attributes @code{:family}, @code{:width},
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1448 @code{:height}, @code{:weight}, and @code{:slant} correspond to parts of
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1449 an X Logical Font Descriptor.)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1450
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1451 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1452 @item :family
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1453 Font family name, or fontset name (@pxref{Fontsets}). If you specify a
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1454 font family name, the wild-card characters @samp{*} and @samp{?} are
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1455 allowed.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1456
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1457 @item :width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1458 Relative proportionate width, also known as the character set width or
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1459 set width. This should be one of the symbols @code{ultra-condensed},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1460 @code{extra-condensed}, @code{condensed}, @code{semi-condensed},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1461 @code{normal}, @code{semi-expanded}, @code{expanded},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1462 @code{extra-expanded}, or @code{ultra-expanded}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1463
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1464 @item :height
32089
15b8a53f1d7a (Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents: 31373
diff changeset
1465 Either the font height, an integer in units of 1/10 point, a floating
15b8a53f1d7a (Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents: 31373
diff changeset
1466 point number specifying the amount by which to scale the height of any
15b8a53f1d7a (Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents: 31373
diff changeset
1467 underlying face, or a function, which is called with the old height
15b8a53f1d7a (Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents: 31373
diff changeset
1468 (from the underlying face), and should return the new height.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1469
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1470 @item :weight
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1471 Font weight---a symbol from this series (from most dense to most faint):
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1472 @code{ultra-bold}, @code{extra-bold}, @code{bold}, @code{semi-bold},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1473 @code{normal}, @code{semi-light}, @code{light}, @code{extra-light},
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1474 or @code{ultra-light}.
25809
89230444d638 patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
1475
89230444d638 patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
1476 On a text-only terminal, any weight greater than normal is displayed as
89230444d638 patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
1477 extra bright, and any weight less than normal is displayed as
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1478 half-bright (provided the terminal supports the feature).
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1479
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1480 @item :slant
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1481 Font slant---one of the symbols @code{italic}, @code{oblique}, @code{normal},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1482 @code{reverse-italic}, or @code{reverse-oblique}.
25809
89230444d638 patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
1483
89230444d638 patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
1484 On a text-only terminal, slanted text is displayed as half-bright, if
89230444d638 patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
1485 the terminal supports the feature.
89230444d638 patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
1486
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1487 @item :foreground
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1488 Foreground color, a string.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1489
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1490 @item :background
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1491 Background color, a string.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1492
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1493 @item :inverse-video
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1494 Whether or not characters should be displayed in inverse video. The
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1495 value should be @code{t} (yes) or @code{nil} (no).
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1496
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1497 @item :stipple
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1498 The background stipple, a bitmap.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1499
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1500 The value can be a string; that should be the name of a file containing
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1501 external-format X bitmap data. The file is found in the directories
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1502 listed in the variable @code{x-bitmap-file-path}.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1503
40310
34f1a01f25fa *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 39404
diff changeset
1504 Alternatively, the value can specify the bitmap directly, with a list
34f1a01f25fa *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 39404
diff changeset
1505 of the form @code{(@var{width} @var{height} @var{data})}. Here,
34f1a01f25fa *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 39404
diff changeset
1506 @var{width} and @var{height} specify the size in pixels, and
34f1a01f25fa *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 39404
diff changeset
1507 @var{data} is a string containing the raw bits of the bitmap, row by
34f1a01f25fa *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 39404
diff changeset
1508 row. Each row occupies @math{(@var{width} + 7) / 8} consecutive bytes
34f1a01f25fa *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 39404
diff changeset
1509 in the string (which should be a unibyte string for best results).
34f1a01f25fa *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 39404
diff changeset
1510 This means that each row always occupies at least one whole byte.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1511
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1512 If the value is @code{nil}, that means use no stipple pattern.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1513
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1514 Normally you do not need to set the stipple attribute, because it is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1515 used automatically to handle certain shades of gray.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1516
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1517 @item :underline
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1518 Whether or not characters should be underlined, and in what color. If
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1519 the value is @code{t}, underlining uses the foreground color of the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1520 face. If the value is a string, underlining uses that color. The
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1521 value @code{nil} means do not underline.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1522
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1523 @item :overline
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1524 Whether or not characters should be overlined, and in what color.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1525 The value is used like that of @code{:underline}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1526
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1527 @item :strike-through
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1528 Whether or not characters should be strike-through, and in what
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1529 color. The value is used like that of @code{:underline}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1530
32089
15b8a53f1d7a (Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents: 31373
diff changeset
1531 @item :inherit
15b8a53f1d7a (Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents: 31373
diff changeset
1532 The name of a face from which to inherit attributes, or a list of face
15b8a53f1d7a (Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents: 31373
diff changeset
1533 names. Attributes from inherited faces are merged into the face like an
15b8a53f1d7a (Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents: 31373
diff changeset
1534 underlying face would be, with higher priority than underlying faces.
15b8a53f1d7a (Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents: 31373
diff changeset
1535
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1536 @item :box
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1537 Whether or not a box should be drawn around characters, its color, the
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1538 width of the box lines, and 3D appearance.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1539 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1540
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1541 Here are the possible values of the @code{:box} attribute, and what
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1542 they mean:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1543
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1544 @table @asis
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1545 @item @code{nil}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1546 Don't draw a box.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1547
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1548 @item @code{t}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1549 Draw a box with lines of width 1, in the foreground color.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1550
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1551 @item @var{color}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1552 Draw a box with lines of width 1, in color @var{color}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1553
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1554 @item @code{(:line-width @var{width} :color @var{color} :style @var{style})}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1555 This way you can explicitly specify all aspects of the box. The value
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1556 @var{width} specifies the width of the lines to draw; it defaults to 1.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1557
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1558 The value @var{color} specifies the color to draw with. The default is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1559 the foreground color of the face for simple boxes, and the background
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1560 color of the face for 3D boxes.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1561
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1562 The value @var{style} specifies whether to draw a 3D box. If it is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1563 @code{released-button}, the box looks like a 3D button that is not being
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1564 pressed. If it is @code{pressed-button}, the box looks like a 3D button
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1565 that is being pressed. If it is @code{nil} or omitted, a plain 2D box
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1566 is used.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1567 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1568
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1569 The attributes @code{:overline}, @code{:strike-through} and
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1570 @code{:box} are new in Emacs 21. The attributes @code{:family},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1571 @code{:height}, @code{:width}, @code{:weight}, @code{:slant} are also
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1572 new; previous versions used the following attributes, now semi-obsolete,
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1573 to specify some of the same information:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1574
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1575 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1576 @item :font
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1577 This attribute specifies the font name.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1578
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1579 @item :bold
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1580 A non-@code{nil} value specifies a bold font.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1581
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1582 @item :italic
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1583 A non-@code{nil} value specifies an italic font.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1584 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1585
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1586 For compatibility, you can still set these ``attributes'' in Emacs 21,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1587 even though they are not real face attributes. Here is what that does:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1588
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1589 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1590 @item :font
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1591 You can specify an X font name as the ``value'' of this ``attribute'';
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1592 that sets the @code{:family}, @code{:width}, @code{:height},
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1593 @code{:weight}, and @code{:slant} attributes according to the font name.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1594
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1595 If the value is a pattern with wildcards, the first font that matches
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1596 the pattern is used to set these attributes.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1597
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1598 @item :bold
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1599 A non-@code{nil} makes the face bold; @code{nil} makes it normal.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1600 This actually works by setting the @code{:weight} attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1601
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1602 @item :italic
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1603 A non-@code{nil} makes the face italic; @code{nil} makes it normal.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1604 This actually works by setting the @code{:slant} attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1605 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1606
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1607 @defvar x-bitmap-file-path
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1608 This variable specifies a list of directories for searching
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1609 for bitmap files, for the @code{:stipple} attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1610 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1611
25911
b192e4e3a9f5 Rename pixmap-spec-p to bitmap-spec-p.
Gerd Moellmann <gerd@gnu.org>
parents: 25875
diff changeset
1612 @defun bitmap-spec-p object
42888
04040cfbdf67 (set-face-stipple): Reference description of bitmap data
Richard M. Stallman <rms@gnu.org>
parents: 42827
diff changeset
1613 This returns @code{t} if @var{object} is a valid bitmap specification,
04040cfbdf67 (set-face-stipple): Reference description of bitmap data
Richard M. Stallman <rms@gnu.org>
parents: 42827
diff changeset
1614 suitable for use with @code{:stipple} (see above). It returns
04040cfbdf67 (set-face-stipple): Reference description of bitmap data
Richard M. Stallman <rms@gnu.org>
parents: 42827
diff changeset
1615 @code{nil} otherwise.
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1616 @end defun
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1617
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1618 @node Attribute Functions
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1619 @subsection Face Attribute Functions
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1620
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1621 You can modify the attributes of an existing face with the following
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1622 functions. If you specify @var{frame}, they affect just that frame;
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1623 otherwise, they affect all frames as well as the defaults that apply to
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1624 new frames.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1625
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1626 @tindex set-face-attribute
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1627 @defun set-face-attribute face frame &rest arguments
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1628 This function sets one or more attributes of face @var{face}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1629 for frame @var{frame}. If @var{frame} is @code{nil}, it sets
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1630 the attribute for all frames, and the defaults for new frames.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1631
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1632 The extra arguments @var{arguments} specify the attributes to set, and
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1633 the values for them. They should consist of alternating attribute names
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1634 (such as @code{:family} or @code{:underline}) and corresponding values.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1635 Thus,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1636
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1637 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1638 (set-face-attribute 'foo nil
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1639 :width :extended
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1640 :weight :bold
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1641 :underline "red")
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1642 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1643
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1644 @noindent
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1645 sets the attributes @code{:width}, @code{:weight} and @code{:underline}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1646 to the corresponding values.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1647 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1648
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1649 @tindex face-attribute
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1650 @defun face-attribute face attribute &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1651 This returns the value of the @var{attribute} attribute of face
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1652 @var{face} on @var{frame}. If @var{frame} is @code{nil},
39404
5b69d94ceef3 (Font Lookup, Attribute Functions)
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
1653 that means the selected frame (@pxref{Input Focus}).
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1654
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1655 If @var{frame} is @code{t}, the value is the default for
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1656 @var{face} for new frames.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1657
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1658 For example,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1659
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1660 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1661 (face-attribute 'bold :weight)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1662 @result{} bold
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1663 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1664 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1665
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1666 The functions above did not exist before Emacs 21. For compatibility
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1667 with older Emacs versions, you can use the following functions to set
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1668 and examine the face attributes which existed in those versions.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1669
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1670 @defun set-face-foreground face color &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1671 @defunx set-face-background face color &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1672 These functions set the foreground (or background, respectively) color
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1673 of face @var{face} to @var{color}. The argument @var{color} should be a
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1674 string, the name of a color.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1675
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1676 Certain shades of gray are implemented by stipple patterns on
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1677 black-and-white screens.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1678 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1679
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1680 @defun set-face-stipple face pattern &optional frame
42888
04040cfbdf67 (set-face-stipple): Reference description of bitmap data
Richard M. Stallman <rms@gnu.org>
parents: 42827
diff changeset
1681 This function sets the background stipple pattern of face @var{face}
04040cfbdf67 (set-face-stipple): Reference description of bitmap data
Richard M. Stallman <rms@gnu.org>
parents: 42827
diff changeset
1682 to @var{pattern}. The argument @var{pattern} should be the name of a
04040cfbdf67 (set-face-stipple): Reference description of bitmap data
Richard M. Stallman <rms@gnu.org>
parents: 42827
diff changeset
1683 stipple pattern defined by the X server, or actual bitmap data
04040cfbdf67 (set-face-stipple): Reference description of bitmap data
Richard M. Stallman <rms@gnu.org>
parents: 42827
diff changeset
1684 (@pxref{Face Attributes}), or @code{nil} meaning don't use stipple.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1685
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1686 Normally there is no need to pay attention to stipple patterns, because
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1687 they are used automatically to handle certain shades of gray.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1688 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1689
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1690 @defun set-face-font face font &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1691 This function sets the font of face @var{face}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1692
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1693 In Emacs 21, this actually sets the attributes @code{:family},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1694 @code{:width}, @code{:height}, @code{:weight}, and @code{:slant}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1695 according to the font name @var{font}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1696
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1697 In Emacs 20, this sets the font attribute. Once you set the font
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1698 explicitly, the bold and italic attributes cease to have any effect,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1699 because the precise font that you specified is used.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1700 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1701
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1702 @defun set-face-bold-p face bold-p &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1703 This function specifies whether @var{face} should be bold. If
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1704 @var{bold-p} is non-@code{nil}, that means yes; @code{nil} means no.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1705
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1706 In Emacs 21, this sets the @code{:weight} attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1707 In Emacs 20, it sets the @code{:bold} attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1708 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1709
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1710 @defun set-face-italic-p face italic-p &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1711 This function specifies whether @var{face} should be italic. If
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1712 @var{italic-p} is non-@code{nil}, that means yes; @code{nil} means no.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1713
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1714 In Emacs 21, this sets the @code{:slant} attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1715 In Emacs 20, it sets the @code{:italic} attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1716 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1717
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1718 @defun set-face-underline-p face underline-p &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1719 This function sets the underline attribute of face @var{face}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1720 Non-@code{nil} means do underline; @code{nil} means don't.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1721 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1722
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1723 @defun invert-face face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1724 This function inverts the @code{:inverse-video} attribute of face
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1725 @var{face}. If the attribute is @code{nil}, this function sets it to
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1726 @code{t}, and vice versa.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1727 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1728
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1729 These functions examine the attributes of a face. If you don't
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1730 specify @var{frame}, they refer to the default data for new frames.
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1731 They return the symbol @code{unspecified} if the face doesn't define any
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1732 value for that attribute.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1733
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1734 @defun face-foreground face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1735 @defunx face-background face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1736 These functions return the foreground color (or background color,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1737 respectively) of face @var{face}, as a string.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1738 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1739
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1740 @defun face-stipple face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1741 This function returns the name of the background stipple pattern of face
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1742 @var{face}, or @code{nil} if it doesn't have one.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1743 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1744
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1745 @defun face-font face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1746 This function returns the name of the font of face @var{face}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1747 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1748
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1749 @defun face-bold-p face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1750 This function returns @code{t} if @var{face} is bold---that is, if it is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1751 bolder than normal. It returns @code{nil} otherwise.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1752 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1753
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1754 @defun face-italic-p face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1755 This function returns @code{t} if @var{face} is italic or oblique,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1756 @code{nil} otherwise.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1757 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1758
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1759 @defun face-underline-p face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1760 This function returns the @code{:underline} attribute of face @var{face}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1761 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1762
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1763 @defun face-inverse-video-p face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1764 This function returns the @code{:inverse-video} attribute of face @var{face}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1765 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1766
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1767 @node Merging Faces
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1768 @subsection Merging Faces for Display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1769
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1770 Here are the ways to specify which faces to use for display of text:
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1771
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1772 @itemize @bullet
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1773 @item
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1774 With defaults. The @code{default} face is used as the ultimate
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1775 default for all text. (In Emacs 19 and 20, the @code{default}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1776 face is used only when no other face is specified.)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1777
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1778 For a mode line or header line, the face @code{modeline} or
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1779 @code{header-line} is used just before @code{default}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1780
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1781 @item
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1782 With text properties. A character can have a @code{face} property; if
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1783 so, the faces and face attributes specified there apply. @xref{Special
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1784 Properties}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1785
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1786 If the character has a @code{mouse-face} property, that is used instead
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1787 of the @code{face} property when the mouse is ``near enough'' to the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1788 character.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1789
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1790 @item
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1791 With overlays. An overlay can have @code{face} and @code{mouse-face}
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1792 properties too; they apply to all the text covered by the overlay.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1793
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1794 @item
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1795 With a region that is active. In Transient Mark mode, the region is
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1796 highlighted with the face @code{region} (@pxref{Standard Faces}).
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1797
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1798 @item
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1799 With special glyphs. Each glyph can specify a particular face
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1800 number. @xref{Glyphs}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1801 @end itemize
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1802
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1803 If these various sources together specify more than one face for a
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1804 particular character, Emacs merges the attributes of the various faces
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1805 specified. The attributes of the faces of special glyphs come first;
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1806 then comes the face for region highlighting, if appropriate;
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1807 then come attributes of faces from overlays, followed by those from text
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1808 properties, and last the default face.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1809
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1810 When multiple overlays cover one character, an overlay with higher
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1811 priority overrides those with lower priority. @xref{Overlays}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1812
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1813 In Emacs 20, if an attribute such as the font or a color is not
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1814 specified in any of the above ways, the frame's own font or color is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1815 used. In newer Emacs versions, this cannot happen, because the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1816 @code{default} face specifies all attributes---in fact, the frame's own
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1817 font and colors are synonymous with those of the default face.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1818
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1819 @node Font Selection
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1820 @subsection Font Selection
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1821
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1822 @dfn{Selecting a font} means mapping the specified face attributes for
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1823 a character to a font that is available on a particular display. The
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1824 face attributes, as determined by face merging, specify most of the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1825 font choice, but not all. Part of the choice depends on what character
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1826 it is.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1827
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1828 For multibyte characters, typically each font covers only one
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1829 character set. So each character set (@pxref{Character Sets}) specifies
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1830 a registry and encoding to use, with the character set's
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1831 @code{x-charset-registry} property. Its value is a string containing
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1832 the registry and the encoding, with a dash between them:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1833
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1834 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1835 (plist-get (charset-plist 'latin-iso8859-1)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1836 'x-charset-registry)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1837 @result{} "ISO8859-1"
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1838 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1839
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1840 Unibyte text does not have character sets, so displaying a unibyte
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1841 character takes the registry and encoding from the variable
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1842 @code{face-default-registry}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1843
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1844 @defvar face-default-registry
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1845 This variable specifies which registry and encoding to use in choosing
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1846 fonts for unibyte characters. The value is initialized at Emacs startup
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1847 time from the font the user specified for Emacs.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1848 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1849
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1850 If the face specifies a fontset name, that fontset determines a
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1851 pattern for fonts of the given charset. If the face specifies a font
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1852 family, a font pattern is constructed.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1853
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1854 Emacs tries to find an available font for the given face attributes
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1855 and character's registry and encoding. If there is a font that matches
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1856 exactly, it is used, of course. The hard case is when no available font
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1857 exactly fits the specification. Then Emacs looks for one that is
27654
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1858 ``close''---one attribute at a time. You can specify the order to
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1859 consider the attributes. In the case where a specified font family is
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1860 not available, you can specify a set of mappings for alternatives to
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1861 try.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1862
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1863 @defvar face-font-selection-order
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1864 @tindex face-font-selection-order
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1865 This variable specifies the order of importance of the face attributes
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1866 @code{:width}, @code{:height}, @code{:weight}, and @code{:slant}. The
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1867 value should be a list containing those four symbols, in order of
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1868 decreasing importance.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1869
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1870 Font selection first finds the best available matches for the first
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1871 attribute listed; then, among the fonts which are best in that way, it
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1872 searches for the best matches in the second attribute, and so on.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1873
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1874 The attributes @code{:weight} and @code{:width} have symbolic values in
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1875 a range centered around @code{normal}. Matches that are more extreme
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1876 (farther from @code{normal}) are somewhat preferred to matches that are
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1877 less extreme (closer to @code{normal}); this is designed to ensure that
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1878 non-normal faces contrast with normal ones, whenever possible.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1879
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1880 The default is @code{(:width :height :weight :slant)}, which means first
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1881 find the fonts closest to the specified @code{:width}, then---among the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1882 fonts with that width---find a best match for the specified font height,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1883 and so on.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1884
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1885 One example of a case where this variable makes a difference is when the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1886 default font has no italic equivalent. With the default ordering, the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1887 @code{italic} face will use a non-italic font that is similar to the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1888 default one. But if you put @code{:slant} before @code{:height}, the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1889 @code{italic} face will use an italic font, even if its height is not
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1890 quite right.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1891 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1892
33373
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
1893 @defvar face-font-family-alternatives
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
1894 @tindex face-font-family-alternatives
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1895 This variable lets you specify alternative font families to try, if a
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1896 given family is specified and doesn't exist. Each element should have
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1897 this form:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1898
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1899 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1900 (@var{family} @var{alternate-families}@dots{})
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1901 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1902
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1903 If @var{family} is specified but not available, Emacs will try the other
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1904 families given in @var{alternate-families}, one by one, until it finds a
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1905 family that does exist.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1906 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1907
33373
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
1908 @defvar face-font-registry-alternatives
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
1909 @tindex face-font-registry-alternatives
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
1910 This variable lets you specify alternative font registries to try, if a
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
1911 given registry is specified and doesn't exist. Each element should have
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
1912 this form:
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
1913
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
1914 @example
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
1915 (@var{registry} @var{alternate-registries}@dots{})
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
1916 @end example
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
1917
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
1918 If @var{registry} is specified but not available, Emacs will try the
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
1919 other registries given in @var{alternate-registries}, one by one,
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
1920 until it finds a registry that does exist.
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
1921 @end defvar
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
1922
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1923 Emacs can make use of scalable fonts, but by default it does not use
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1924 them, since the use of too many or too big scalable fonts can crash
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1925 XFree86 servers.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1926
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1927 @defvar scalable-fonts-allowed
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1928 @tindex scalable-fonts-allowed
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1929 This variable controls which scalable fonts to use. A value of
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1930 @code{nil}, the default, means do not use scalable fonts. @code{t}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1931 means to use any scalable font that seems appropriate for the text.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1932
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1933 Otherwise, the value must be a list of regular expressions. Then a
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1934 scalable font is enabled for use if its name matches any regular
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1935 expression in the list. For example,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1936
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1937 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1938 (setq scalable-fonts-allowed '("muleindian-2$"))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1939 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1940
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1941 @noindent
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1942 allows the use of scalable fonts with registry @code{muleindian-2}.
26698
73f718a9df4b (Overlays): Add menu entry for Finding Overlays.
Dave Love <fx@gnu.org>
parents: 26696
diff changeset
1943 @end defvar
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1944
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1945 @defun clear-face-cache &optional unload-p
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1946 @tindex clear-face-cache
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1947 This function clears the face cache for all frames.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1948 If @var{unload-p} is non-@code{nil}, that means to unload
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1949 all unused fonts as well.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1950 @end defun
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1951
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1952 @node Face Functions
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1953 @subsection Functions for Working with Faces
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1954
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1955 Here are additional functions for creating and working with faces.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1956
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1957 @defun make-face name
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1958 This function defines a new face named @var{name}, initially with all
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1959 attributes @code{nil}. It does nothing if there is already a face named
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1960 @var{name}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1961 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1962
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1963 @defun face-list
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1964 This function returns a list of all defined face names.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1965 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1966
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1967 @defun copy-face old-face new-name &optional frame new-frame
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1968 This function defines the face @var{new-name} as a copy of the existing
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1969 face named @var{old-face}. It creates the face @var{new-name} if that
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1970 doesn't already exist.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1971
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1972 If the optional argument @var{frame} is given, this function applies
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1973 only to that frame. Otherwise it applies to each frame individually,
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1974 copying attributes from @var{old-face} in each frame to @var{new-face}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1975 in the same frame.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1976
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1977 If the optional argument @var{new-frame} is given, then @code{copy-face}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1978 copies the attributes of @var{old-face} in @var{frame} to @var{new-name}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1979 in @var{new-frame}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1980 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1981
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1982 @defun face-id face
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1983 This function returns the face number of face @var{face}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1984 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1985
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1986 @defun face-documentation face
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1987 This function returns the documentation string of face @var{face}, or
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1988 @code{nil} if none was specified for it.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1989 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1990
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1991 @defun face-equal face1 face2 &optional frame
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1992 This returns @code{t} if the faces @var{face1} and @var{face2} have the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1993 same attributes for display.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1994 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1995
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1996 @defun face-differs-from-default-p face &optional frame
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1997 This returns @code{t} if the face @var{face} displays differently from
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1998 the default face. A face is considered to be ``the same'' as the
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1999 default face if each attribute is either the same as that of the default
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2000 face, or unspecified (meaning to inherit from the default).
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
2001 @end defun
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
2002
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2003 @node Auto Faces
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2004 @subsection Automatic Face Assignment
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2005 @cindex automatic face assignment
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2006 @cindex faces, automatic choice
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2007
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2008 @cindex Font-Lock mode
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2009 Starting with Emacs 21, a hook is available for automatically
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2010 assigning faces to text in the buffer. This hook is used for part of
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2011 the implementation of Font-Lock mode.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2012
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2013 @tindex fontification-functions
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2014 @defvar fontification-functions
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2015 This variable holds a list of functions that are called by Emacs
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2016 redisplay as needed to assign faces automatically to text in the buffer.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2017
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2018 The functions are called in the order listed, with one argument, a
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2019 buffer position @var{pos}. Each function should attempt to assign faces
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2020 to the text in the current buffer starting at @var{pos}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2021
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2022 Each function should record the faces they assign by setting the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2023 @code{face} property. It should also add a non-@code{nil}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2024 @code{fontified} property for all the text it has assigned faces to.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2025 That property tells redisplay that faces have been assigned to that text
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2026 already.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2027
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2028 It is probably a good idea for each function to do nothing if the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2029 character after @var{pos} already has a non-@code{nil} @code{fontified}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2030 property, but this is not required. If one function overrides the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2031 assignments made by a previous one, the properties as they are
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2032 after the last function finishes are the ones that really matter.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2033
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2034 For efficiency, we recommend writing these functions so that they
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2035 usually assign faces to around 400 to 600 characters at each call.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2036 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2037
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2038 @node Font Lookup
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2039 @subsection Looking Up Fonts
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2040
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2041 @defun x-list-fonts pattern &optional face frame maximum
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2042 This function returns a list of available font names that match
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2043 @var{pattern}. If the optional arguments @var{face} and @var{frame} are
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2044 specified, then the list is limited to fonts that are the same size as
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2045 @var{face} currently is on @var{frame}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2046
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2047 The argument @var{pattern} should be a string, perhaps with wildcard
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2048 characters: the @samp{*} character matches any substring, and the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2049 @samp{?} character matches any single character. Pattern matching
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2050 of font names ignores case.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2051
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2052 If you specify @var{face} and @var{frame}, @var{face} should be a face name
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2053 (a symbol) and @var{frame} should be a frame.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2054
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2055 The optional argument @var{maximum} sets a limit on how many fonts to
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2056 return. If this is non-@code{nil}, then the return value is truncated
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2057 after the first @var{maximum} matching fonts. Specifying a small value
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2058 for @var{maximum} can make this function much faster, in cases where
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2059 many fonts match the pattern.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2060 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2061
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2062 These additional functions are available starting in Emacs 21.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2063
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2064 @defun x-family-fonts &optional family frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2065 @tindex x-family-fonts
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2066 This function returns a list describing the available fonts for family
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2067 @var{family} on @var{frame}. If @var{family} is omitted or @code{nil},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2068 this list applies to all families, and therefore, it contains all
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2069 available fonts. Otherwise, @var{family} must be a string; it may
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2070 contain the wildcards @samp{?} and @samp{*}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2071
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2072 The list describes the display that @var{frame} is on; if @var{frame} is
39404
5b69d94ceef3 (Font Lookup, Attribute Functions)
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
2073 omitted or @code{nil}, it applies to the selected frame's display
5b69d94ceef3 (Font Lookup, Attribute Functions)
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
2074 (@pxref{Input Focus}).
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2075
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2076 The list contains a vector of the following form for each font:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2077
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2078 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2079 [@var{family} @var{width} @var{point-size} @var{weight} @var{slant}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2080 @var{fixed-p} @var{full} @var{registry-and-encoding}]
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2081 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2082
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2083 The first five elements correspond to face attributes; if you
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2084 specify these attributes for a face, it will use this font.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2085
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2086 The last three elements give additional information about the font.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2087 @var{fixed-p} is non-nil if the font is fixed-pitch. @var{full} is the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2088 full name of the font, and @var{registry-and-encoding} is a string
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2089 giving the registry and encoding of the font.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2090
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2091 The result list is sorted according to the current face font sort order.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2092 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2093
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2094 @defun x-font-family-list &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2095 @tindex x-font-family-list
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2096 This function returns a list of the font families available for
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2097 @var{frame}'s display. If @var{frame} is omitted or @code{nil}, it
39404
5b69d94ceef3 (Font Lookup, Attribute Functions)
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
2098 describes the selected frame's display (@pxref{Input Focus}).
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2099
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2100 The value is a list of elements of this form:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2101
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2102 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2103 (@var{family} . @var{fixed-p})
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2104 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2105
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2106 @noindent
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2107 Here @var{family} is a font family, and @var{fixed-p} is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2108 non-@code{nil} if fonts of that family are fixed-pitch.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2109 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2110
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2111 @defvar font-list-limit
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2112 @tindex font-list-limit
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2113 This variable specifies maximum number of fonts to consider in font
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2114 matching. The function @code{x-family-fonts} will not return more than
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2115 that many fonts, and font selection will consider only that many fonts
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2116 when searching a matching font for face attributes. The default is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2117 currently 100.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2118 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2119
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2120 @node Fontsets
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2121 @subsection Fontsets
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2122
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2123 A @dfn{fontset} is a list of fonts, each assigned to a range of
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2124 character codes. An individual font cannot display the whole range of
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2125 characters that Emacs supports, but a fontset can. Fontsets have names,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2126 just as fonts do, and you can use a fontset name in place of a font name
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2127 when you specify the ``font'' for a frame or a face. Here is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2128 information about defining a fontset under Lisp program control.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2129
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2130 @defun create-fontset-from-fontset-spec fontset-spec &optional style-variant-p noerror
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2131 This function defines a new fontset according to the specification
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2132 string @var{fontset-spec}. The string should have this format:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2133
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2134 @smallexample
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2135 @var{fontpattern}, @r{[}@var{charsetname}:@var{fontname}@r{]@dots{}}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2136 @end smallexample
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2137
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2138 @noindent
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2139 Whitespace characters before and after the commas are ignored.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2140
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2141 The first part of the string, @var{fontpattern}, should have the form of
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2142 a standard X font name, except that the last two fields should be
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2143 @samp{fontset-@var{alias}}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2144
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2145 The new fontset has two names, one long and one short. The long name is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2146 @var{fontpattern} in its entirety. The short name is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2147 @samp{fontset-@var{alias}}. You can refer to the fontset by either
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2148 name. If a fontset with the same name already exists, an error is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2149 signaled, unless @var{noerror} is non-@code{nil}, in which case this
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2150 function does nothing.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2151
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2152 If optional argument @var{style-variant-p} is non-@code{nil}, that says
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2153 to create bold, italic and bold-italic variants of the fontset as well.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2154 These variant fontsets do not have a short name, only a long one, which
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2155 is made by altering @var{fontpattern} to indicate the bold or italic
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2156 status.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2157
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2158 The specification string also says which fonts to use in the fontset.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2159 See below for the details.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2160 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2161
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2162 The construct @samp{@var{charset}:@var{font}} specifies which font to
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2163 use (in this fontset) for one particular character set. Here,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2164 @var{charset} is the name of a character set, and @var{font} is the font
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2165 to use for that character set. You can use this construct any number of
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2166 times in the specification string.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2167
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2168 For the remaining character sets, those that you don't specify
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2169 explicitly, Emacs chooses a font based on @var{fontpattern}: it replaces
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2170 @samp{fontset-@var{alias}} with a value that names one character set.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2171 For the @sc{ascii} character set, @samp{fontset-@var{alias}} is replaced
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2172 with @samp{ISO8859-1}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2173
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2174 In addition, when several consecutive fields are wildcards, Emacs
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2175 collapses them into a single wildcard. This is to prevent use of
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2176 auto-scaled fonts. Fonts made by scaling larger fonts are not usable
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2177 for editing, and scaling a smaller font is not useful because it is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2178 better to use the smaller font in its own size, which Emacs does.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2179
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2180 Thus if @var{fontpattern} is this,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2181
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2182 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2183 -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2184 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2185
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2186 @noindent
27374
0f5edee5242b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27332
diff changeset
2187 the font specification for @sc{ascii} characters would be this:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2188
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2189 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2190 -*-fixed-medium-r-normal-*-24-*-ISO8859-1
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2191 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2192
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2193 @noindent
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2194 and the font specification for Chinese GB2312 characters would be this:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2195
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2196 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2197 -*-fixed-medium-r-normal-*-24-*-gb2312*-*
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2198 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2199
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2200 You may not have any Chinese font matching the above font
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2201 specification. Most X distributions include only Chinese fonts that
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2202 have @samp{song ti} or @samp{fangsong ti} in the @var{family} field. In
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2203 such a case, @samp{Fontset-@var{n}} can be specified as below:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2204
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2205 @smallexample
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2206 Emacs.Fontset-0: -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24,\
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2207 chinese-gb2312:-*-*-medium-r-normal-*-24-*-gb2312*-*
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2208 @end smallexample
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2209
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2210 @noindent
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2211 Then, the font specifications for all but Chinese GB2312 characters have
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2212 @samp{fixed} in the @var{family} field, and the font specification for
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2213 Chinese GB2312 characters has a wild card @samp{*} in the @var{family}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2214 field.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2215
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2216 @node Display Property
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2217 @section The @code{display} Property
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2218 @cindex display specification
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2219 @kindex display @r{(text property)}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2220
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2221 The @code{display} text property (or overlay property) is used to
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2222 insert images into text, and also control other aspects of how text
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2223 displays. These features are available starting in Emacs 21. The value
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2224 of the @code{display} property should be a display specification, or a
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2225 list or vector containing several display specifications. The rest of
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2226 this section describes several kinds of display specifications and what
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2227 they mean.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2228
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2229 @menu
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2230 * Specified Space:: Displaying one space with a specified width.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2231 * Other Display Specs:: Displaying an image; magnifying text; moving it
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2232 up or down on the page; adjusting the width
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2233 of spaces within text.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2234 * Display Margins:: Displaying text or images to the side of the main text.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2235 * Conditional Display:: Making any of the above features conditional
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2236 depending on some Lisp expression.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2237 @end menu
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2238
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2239 @node Specified Space
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2240 @subsection Specified Spaces
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2241 @cindex spaces, specified height or width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2242 @cindex specified spaces
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2243 @cindex variable-width spaces
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2244
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2245 To display a space of specified width and/or height, use a display
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2246 specification of the form @code{(space . @var{props})}, where
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2247 @var{props} is a property list (a list of alternating properties and
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2248 values). You can put this property on one or more consecutive
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2249 characters; a space of the specified height and width is displayed in
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2250 place of @emph{all} of those characters. These are the properties you
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2251 can use to specify the weight of the space:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2252
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2253 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2254 @item :width @var{width}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2255 Specifies that the space width should be @var{width} times the normal
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2256 character width. @var{width} can be an integer or floating point
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2257 number.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2258
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2259 @item :relative-width @var{factor}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2260 Specifies that the width of the stretch should be computed from the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2261 first character in the group of consecutive characters that have the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2262 same @code{display} property. The space width is the width of that
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2263 character, multiplied by @var{factor}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2264
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2265 @item :align-to @var{hpos}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2266 Specifies that the space should be wide enough to reach @var{hpos}. The
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2267 value @var{hpos} is measured in units of the normal character width. It
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2268 may be an interer or a floating point number.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2269 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2270
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2271 Exactly one of the above properties should be used. You can also
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2272 specify the height of the space, with other properties:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2273
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2274 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2275 @item :height @var{height}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2276 Specifies the height of the space, as @var{height},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2277 measured in terms of the normal line height.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2278
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2279 @item :relative-height @var{factor}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2280 Specifies the height of the space, multiplying the ordinary height
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2281 of the text having this display specification by @var{factor}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2282
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2283 @item :ascent @var{ascent}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2284 Specifies that @var{ascent} percent of the height of the space should be
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2285 considered as the ascent of the space---that is, the part above the
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2286 baseline. The value of @var{ascent} must be a non-negative number no
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2287 greater than 100.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2288 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2289
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2290 You should not use both @code{:height} and @code{:relative-height}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2291 together.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2292
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2293 @node Other Display Specs
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2294 @subsection Other Display Specifications
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2295
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2296 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2297 @item (image . @var{image-props})
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2298 This is in fact an image descriptor (@pxref{Images}). When used as a
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2299 display specification, it means to display the image instead of the text
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2300 that has the display specification.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2301
32467
d8a494b62fbd string display property
Dave Love <fx@gnu.org>
parents: 32261
diff changeset
2302 @item ((margin nil) @var{string})
d8a494b62fbd string display property
Dave Love <fx@gnu.org>
parents: 32261
diff changeset
2303 @itemx @var{string}
d8a494b62fbd string display property
Dave Love <fx@gnu.org>
parents: 32261
diff changeset
2304 A display specification of this form means to display @var{string}
d8a494b62fbd string display property
Dave Love <fx@gnu.org>
parents: 32261
diff changeset
2305 instead of the text that has the display specification, at the same
d8a494b62fbd string display property
Dave Love <fx@gnu.org>
parents: 32261
diff changeset
2306 position as that text. This is a special case of marginal display
d8a494b62fbd string display property
Dave Love <fx@gnu.org>
parents: 32261
diff changeset
2307 (@pxref{Display Margins}).
d8a494b62fbd string display property
Dave Love <fx@gnu.org>
parents: 32261
diff changeset
2308
36935
1ac3e0f3e75a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36730
diff changeset
2309 Recursive display specifications are not supported, i.e.@: string
1ac3e0f3e75a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36730
diff changeset
2310 display specifications that have a display specification property
1ac3e0f3e75a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36730
diff changeset
2311 themselves.
1ac3e0f3e75a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36730
diff changeset
2312
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2313 @item (space-width @var{factor})
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2314 This display specification affects all the space characters within the
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2315 text that has the specification. It displays all of these spaces
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2316 @var{factor} times as wide as normal. The element @var{factor} should
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2317 be an integer or float. Characters other than spaces are not affected
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2318 at all; in particular, this has no effect on tab characters.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2319
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2320 @item (height @var{height})
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2321 This display specification makes the text taller or shorter.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2322 Here are the possibilities for @var{height}:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2323
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2324 @table @asis
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2325 @item @code{(+ @var{n})}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2326 This means to use a font that is @var{n} steps larger. A ``step'' is
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2327 defined by the set of available fonts---specifically, those that match
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2328 what was otherwise specified for this text, in all attributes except
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2329 height. Each size for which a suitable font is available counts as
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2330 another step. @var{n} should be an integer.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2331
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2332 @item @code{(- @var{n})}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2333 This means to use a font that is @var{n} steps smaller.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2334
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2335 @item a number, @var{factor}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2336 A number, @var{factor}, means to use a font that is @var{factor} times
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2337 as tall as the default font.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2338
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2339 @item a symbol, @var{function}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2340 A symbol is a function to compute the height. It is called with the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2341 current height as argument, and should return the new height to use.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2342
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2343 @item anything else, @var{form}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2344 If the @var{height} value doesn't fit the previous possibilities, it is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2345 a form. Emacs evaluates it to get the new height, with the symbol
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2346 @code{height} bound to the current specified font height.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2347 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2348
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2349 @item (raise @var{factor})
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2350 This kind of display specification raises or lowers the text
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2351 it applies to, relative to the baseline of the line.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2352
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2353 @var{factor} must be a number, which is interpreted as a multiple of the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2354 height of the affected text. If it is positive, that means to display
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2355 the characters raised. If it is negative, that means to display them
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2356 lower down.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2357
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2358 If the text also has a @code{height} display specification, that does
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2359 not affect the amount of raising or lowering, which is based on the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2360 faces used for the text.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2361 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2362
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2363 @node Display Margins
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2364 @subsection Displaying in the Margins
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2365 @cindex display margins
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2366 @cindex margins, display
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2367
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2368 A buffer can have blank areas called @dfn{display margins} on the left
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2369 and on the right. Ordinary text never appears in these areas, but you
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2370 can put things into the display margins using the @code{display}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2371 property.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2372
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2373 To put text in the left or right display margin of the window, use a
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2374 display specification of the form @code{(margin right-margin)} or
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2375 @code{(margin left-margin)} on it. To put an image in a display margin,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2376 use that display specification along with the display specification for
42476
fe0b84badbb1 Margin displays can't be mouse sensitive.
Richard M. Stallman <rms@gnu.org>
parents: 42297
diff changeset
2377 the image. Unfortunately, there is currently no way to make
fe0b84badbb1 Margin displays can't be mouse sensitive.
Richard M. Stallman <rms@gnu.org>
parents: 42297
diff changeset
2378 text or images in the margin mouse-sensitive.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2379
42297
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
2380 If you put such a display specification directly on text in the
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
2381 buffer, the specified margin display appears @emph{instead of} that
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
2382 buffer text itself. To put something in the margin @emph{in
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
2383 association with} certain buffer text without preventing or altering
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
2384 the display of that text, put a @code{before-string} property on the
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
2385 text and put the display specification on the contents of the
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
2386 before-string.
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
2387
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2388 Before the display margins can display anything, you must give
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2389 them a nonzero width. The usual way to do that is to set these
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2390 variables:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2391
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2392 @defvar left-margin-width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2393 @tindex left-margin-width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2394 This variable specifies the width of the left margin.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2395 It is buffer-local in all buffers.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2396 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2397
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2398 @defvar right-margin-width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2399 @tindex right-margin-width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2400 This variable specifies the width of the right margin.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2401 It is buffer-local in all buffers.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2402 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2403
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2404 Setting these variables does not immediately affect the window. These
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2405 variables are checked when a new buffer is displayed in the window.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2406 Thus, you can make changes take effect by calling
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2407 @code{set-window-buffer}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2408
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2409 You can also set the margin widths immediately.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2410
36935
1ac3e0f3e75a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36730
diff changeset
2411 @defun set-window-margins window left &optional right
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2412 @tindex set-window-margins
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2413 This function specifies the margin widths for window @var{window}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2414 The argument @var{left} controls the left margin and
36935
1ac3e0f3e75a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36730
diff changeset
2415 @var{right} controls the right margin (default @code{0}).
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2416 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2417
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2418 @defun window-margins &optional window
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2419 @tindex window-margins
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2420 This function returns the left and right margins of @var{window}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2421 as a cons cell of the form @code{(@var{left} . @var{right})}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2422 If @var{window} is @code{nil}, the selected window is used.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2423 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2424
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2425 @node Conditional Display
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2426 @subsection Conditional Display Specifications
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2427 @cindex conditional display specifications
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2428
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2429 You can make any display specification conditional. To do that,
29471
215b57502518 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 29151
diff changeset
2430 package it in another list of the form @code{(when @var{condition} .
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2431 @var{spec})}. Then the specification @var{spec} applies only when
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2432 @var{condition} evaluates to a non-@code{nil} value. During the
39032
ed864621a68e Conditional Display): Adjust to API change.
Gerd Moellmann <gerd@gnu.org>
parents: 38278
diff changeset
2433 evaluation, @code{object} is bound to the string or buffer having the
ed864621a68e Conditional Display): Adjust to API change.
Gerd Moellmann <gerd@gnu.org>
parents: 38278
diff changeset
2434 conditional @code{display} property. @code{position} and
ed864621a68e Conditional Display): Adjust to API change.
Gerd Moellmann <gerd@gnu.org>
parents: 38278
diff changeset
2435 @code{buffer-position} are bound to the position within @code{object}
ed864621a68e Conditional Display): Adjust to API change.
Gerd Moellmann <gerd@gnu.org>
parents: 38278
diff changeset
2436 and the buffer position where the @code{display} property was found,
ed864621a68e Conditional Display): Adjust to API change.
Gerd Moellmann <gerd@gnu.org>
parents: 38278
diff changeset
2437 respectively. Both positions can be different when @code{object} is a
ed864621a68e Conditional Display): Adjust to API change.
Gerd Moellmann <gerd@gnu.org>
parents: 38278
diff changeset
2438 string.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2439
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2440 @node Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2441 @section Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2442 @cindex images in buffers
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2443
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2444 To display an image in an Emacs buffer, you must first create an image
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2445 descriptor, then use it as a display specifier in the @code{display}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2446 property of text that is displayed (@pxref{Display Property}). Like the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2447 @code{display} property, this feature is available starting in Emacs 21.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2448
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2449 Emacs can display a number of different image formats; some of them
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2450 are supported only if particular support libraries are installed on your
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2451 machine. The supported image formats include XBM, XPM (needing the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2452 libraries @code{libXpm} version 3.4k and @code{libz}), GIF (needing
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2453 @code{libungif} 4.1.0), Postscript, PBM, JPEG (needing the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2454 @code{libjpeg} library version v6a), TIFF (needing @code{libtiff} v3.4),
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2455 and PNG (needing @code{libpng} 1.0.2).
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2456
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2457 You specify one of these formats with an image type symbol. The image
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2458 type symbols are @code{xbm}, @code{xpm}, @code{gif}, @code{postscript},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2459 @code{pbm}, @code{jpeg}, @code{tiff}, and @code{png}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2460
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2461 @defvar image-types
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2462 This variable contains a list of those image type symbols that are
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2463 supported in the current configuration.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2464 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2465
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2466 @menu
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2467 * Image Descriptors:: How to specify an image for use in @code{:display}.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2468 * XBM Images:: Special features for XBM format.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2469 * XPM Images:: Special features for XPM format.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2470 * GIF Images:: Special features for GIF format.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2471 * Postscript Images:: Special features for Postscript format.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2472 * Other Image Types:: Various other formats are supported.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2473 * Defining Images:: Convenient ways to define an image for later use.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2474 * Showing Images:: Convenient ways to display an image once it is defined.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2475 * Image Cache:: Internal mechanisms of image display.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2476 @end menu
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2477
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2478 @node Image Descriptors
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2479 @subsection Image Descriptors
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2480 @cindex image descriptor
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2481
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2482 An image description is a list of the form @code{(image
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2483 . @var{props})}, where @var{props} is a property list containing
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2484 alternating keyword symbols (symbols whose names start with a colon) and
26400
53eeb3b7c785 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26221
diff changeset
2485 their values. You can use any Lisp object as a property, but the only
53eeb3b7c785 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26221
diff changeset
2486 properties that have any special meaning are certain symbols, all of
53eeb3b7c785 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26221
diff changeset
2487 them keywords.
53eeb3b7c785 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26221
diff changeset
2488
53eeb3b7c785 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26221
diff changeset
2489 Every image descriptor must contain the property @code{:type
53eeb3b7c785 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26221
diff changeset
2490 @var{type}} to specify the format of the image. The value of @var{type}
53eeb3b7c785 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26221
diff changeset
2491 should be an image type symbol; for example, @code{xpm} for an image in
53eeb3b7c785 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26221
diff changeset
2492 XPM format.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2493
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2494 Here is a list of other properties that are meaningful for all image
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2495 types:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2496
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2497 @table @code
36730
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2498 @item :file @var{file}
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2499 The @code{:file} property specifies to load the image from file
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2500 @var{file}. If @var{file} is not an absolute file name, it is expanded
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2501 in @code{data-directory}.
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2502
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2503 @item :data @var{data}
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2504 The @code{:data} property specifies the actual contents of the image.
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2505 Each image must use either @code{:data} or @code{:file}, but not both.
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2506 For most image types, the value of the @code{:data} property should be a
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2507 string containing the image data; we recommend using a unibyte string.
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2508
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2509 Before using @code{:data}, look for further information in the section
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2510 below describing the specific image format. For some image types,
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2511 @code{:data} may not be supported; for some, it allows other data types;
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2512 for some, @code{:data} alone is not enough, so you need to use other
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2513 image properties along with @code{:data}.
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2514
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2515 @item :margin @var{margin}
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2516 The @code{:margin} property specifies how many pixels to add as an
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2517 extra margin around the image. The value, @var{margin}, must be a a
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2518 non-negative number, or a pair @code{(@var{x} . @var{y})} of such
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2519 numbers. If it is a pair, @var{x} specifies how many pixels to add
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2520 horizontally, and @var{y} specifies how many pixels to add vertically.
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2521 If @code{:margin} is not specified, the default is zero.
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2522
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2523 @item :ascent @var{ascent}
29151
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2524 The @code{:ascent} property specifies the amount of the image's
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2525 height to use for its ascent---that is, the part above the baseline.
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2526 The value, @var{ascent}, must be a number in the range 0 to 100, or
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2527 the symbol @code{center}.
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2528
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2529 If @var{ascent} is a number, that percentage of the image's height is
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2530 used for its ascent.
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2531
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2532 If @var{ascent} is @code{center}, the image is vertically centered
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2533 around a centerline which would be the vertical centerline of text drawn
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2534 at the position of the image, in the manner specified by the text
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2535 properties and overlays that apply to the image.
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2536
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2537 If this property is omitted, it defaults to 50.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2538
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2539 @item :relief @var{relief}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2540 The @code{:relief} property, if non-@code{nil}, adds a shadow rectangle
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2541 around the image. The value, @var{relief}, specifies the width of the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2542 shadow lines, in pixels. If @var{relief} is negative, shadows are drawn
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2543 so that the image appears as a pressed button; otherwise, it appears as
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2544 an unpressed button.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2545
35364
19c93f3ebdce *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 35278
diff changeset
2546 @item :conversion @var{algorithm}
19c93f3ebdce *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 35278
diff changeset
2547 The @code{:conversion} property, if non-@code{nil}, specifies a
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2548 conversion algorithm that should be applied to the image before it is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2549 displayed; the value, @var{algorithm}, specifies which algorithm.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2550
33996
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2551 @table @code
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2552 @item laplace
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2553 @itemx emboss
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2554 Specifies the Laplace edge detection algorithm, which blurs out small
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2555 differences in color while highlighting larger differences. People
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2556 sometimes consider this useful for displaying the image for a
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2557 ``disabled'' button.
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2558
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2559 @item (edge-detection :matrix @var{matrix} :color-adjust @var{adjust})
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2560 Specifies a general edge-detection algorithm. @var{matrix} must be
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2561 either a nine-element list or a nine-element vector of numbers. A pixel
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2562 at position @math{x/y} in the transformed image is computed from
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2563 original pixels around that position. @var{matrix} specifies, for each
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2564 pixel in the neighborhood of @math{x/y}, a factor with which that pixel
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2565 will influence the transformed pixel; element @math{0} specifies the
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2566 factor for the pixel at @math{x-1/y-1}, element @math{1} the factor for
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2567 the pixel at @math{x/y-1} etc., as shown below:
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2568 @iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2569 @tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2570 $$\pmatrix{x-1/y-1 & x/y-1 & x+1/y-1 \cr
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2571 x-1/y & x/y & x+1/y \cr
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2572 x-1/y+1& x/y+1 & x+1/y+1 \cr}$$
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2573 @end tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2574 @end iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2575 @ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2576 @display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2577 (x-1/y-1 x/y-1 x+1/y-1
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2578 x-1/y x/y x+1/y
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2579 x-1/y+1 x/y+1 x+1/y+1)
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2580 @end display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2581 @end ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2582
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2583 The resulting pixel is computed from the color intensity of the color
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2584 resulting from summing up the RGB values of surrounding pixels,
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2585 multiplied by the specified factors, and dividing that sum by the sum
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2586 of the factors' absolute values.
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2587
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2588 Laplace edge-detection currently uses a matrix of
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2589 @iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2590 @tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2591 $$\pmatrix{1 & 0 & 0 \cr
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2592 0& 0 & 0 \cr
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2593 9 & 9 & -1 \cr}$$
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2594 @end tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2595 @end iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2596 @ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2597 @display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2598 (1 0 0
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2599 0 0 0
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2600 9 9 -1)
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2601 @end display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2602 @end ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2603
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2604 Emboss edge-detection uses a matrix of
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2605 @iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2606 @tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2607 $$\pmatrix{ 2 & -1 & 0 \cr
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2608 -1 & 0 & 1 \cr
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2609 0 & 1 & -2 \cr}$$
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2610 @end tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2611 @end iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2612 @ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2613 @display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2614 ( 2 -1 0
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2615 -1 0 1
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2616 0 1 -2)
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2617 @end display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2618 @end ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2619
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2620 @item disabled
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2621 Specifies transforming the image so that it looks ``disabled''.
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2622 @end table
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2623
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2624 @item :mask @var{mask}
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2625 If @var{mask} is @code{heuristic} or @code{(heuristic @var{bg})}, build
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2626 a clipping mask for the image, so that the background of a frame is
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2627 visible behind the image. If @var{bg} is not specified, or if @var{bg}
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2628 is @code{t}, determine the background color of the image by looking at
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2629 the four corners of the image, assuming the most frequently occurring
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2630 color from the corners is the background color of the image. Otherwise,
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2631 @var{bg} must be a list @code{(@var{red} @var{green} @var{blue})}
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2632 specifying the color to assume for the background of the image.
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2633
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2634 If @var{mask} is nil, remove a mask from the image, if it has one. Images
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2635 in some formats include a mask which can be removed by specifying
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2636 @code{:mask nil}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2637 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2638
33996
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2639 @defun image-mask-p spec &optional frame
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2640 @tindex image-mask-p
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2641 This function returns @code{t} if image @var{spec} has a mask bitmap.
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2642 @var{frame} is the frame on which the image will be displayed.
39404
5b69d94ceef3 (Font Lookup, Attribute Functions)
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
2643 @var{frame} @code{nil} or omitted means to use the selected frame
5b69d94ceef3 (Font Lookup, Attribute Functions)
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
2644 (@pxref{Input Focus}).
33996
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2645 @end defun
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2646
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2647 @node XBM Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2648 @subsection XBM Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2649 @cindex XBM
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2650
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2651 To use XBM format, specify @code{xbm} as the image type. This image
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2652 format doesn't require an external library, so images of this type are
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2653 always supported.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2654
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2655 Additional image properties supported for the @code{xbm} image type are:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2656
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2657 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2658 @item :foreground @var{foreground}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2659 The value, @var{foreground}, should be a string specifying the image
37949
1302dd937a79 Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents: 37170
diff changeset
2660 foreground color, or @code{nil} for the default color. This color is
1302dd937a79 Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents: 37170
diff changeset
2661 used for each pixel in the XBM that is 1. The default is the frame's
1302dd937a79 Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents: 37170
diff changeset
2662 foreground color.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2663
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2664 @item :background @var{background}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2665 The value, @var{background}, should be a string specifying the image
37949
1302dd937a79 Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents: 37170
diff changeset
2666 background color, or @code{nil} for the default color. This color is
1302dd937a79 Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents: 37170
diff changeset
2667 used for each pixel in the XBM that is 0. The default is the frame's
1302dd937a79 Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents: 37170
diff changeset
2668 background color.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2669 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2670
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
2671 If you specify an XBM image using data within Emacs instead of an
28792
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2672 external file, use the following three properties:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2673
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2674 @table @code
28792
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2675 @item :data @var{data}
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2676 The value, @var{data}, specifies the contents of the image.
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2677 There are three formats you can use for @var{data}:
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2678
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2679 @itemize @bullet
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2680 @item
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2681 A vector of strings or bool-vectors, each specifying one line of the
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2682 image. Do specify @code{:height} and @code{:width}.
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2683
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2684 @item
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2685 A string containing the same byte sequence as an XBM file would contain.
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2686 You must not specify @code{:height} and @code{:width} in this case,
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2687 because omitting them is what indicates the data has the format of an
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2688 XBM file. The file contents specify the height and width of the image.
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2689
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2690 @item
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2691 A string or a bool-vector containing the bits of the image (plus perhaps
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2692 some extra bits at the end that will not be used). It should contain at
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2693 least @var{width} * @code{height} bits. In this case, you must specify
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2694 @code{:height} and @code{:width}, both to indicate that the string
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2695 contains just the bits rather than a whole XBM file, and to specify the
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2696 size of the image.
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2697 @end itemize
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2698
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2699 @item :width @var{width}
28792
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2700 The value, @var{width}, specifies the width of the image, in pixels.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2701
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2702 @item :height @var{height}
28792
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
2703 The value, @var{height}, specifies the height of the image, in pixels.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2704 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2705
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2706 @node XPM Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2707 @subsection XPM Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2708 @cindex XPM
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2709
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
2710 To use XPM format, specify @code{xpm} as the image type. The
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
2711 additional image property @code{:color-symbols} is also meaningful with
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
2712 the @code{xpm} image type:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2713
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2714 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2715 @item :color-symbols @var{symbols}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2716 The value, @var{symbols}, should be an alist whose elements have the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2717 form @code{(@var{name} . @var{color})}. In each element, @var{name} is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2718 the name of a color as it appears in the image file, and @var{color}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2719 specifies the actual color to use for displaying that name.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2720 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2721
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2722 @node GIF Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2723 @subsection GIF Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2724 @cindex GIF
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2725
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2726 For GIF images, specify image type @code{gif}. Because of the patents
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2727 in the US covering the LZW algorithm, the continued use of GIF format is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2728 a problem for the whole Internet; to end this problem, it is a good idea
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2729 for everyone, even outside the US, to stop using GIFS right away
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2730 (@uref{http://www.burnallgifs.org/}). But if you still want to use
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2731 them, Emacs can display them.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2732
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2733 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2734 @item :index @var{index}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2735 You can use @code{:index} to specify one image from a GIF file that
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2736 contains more than one image. This property specifies use of image
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2737 number @var{index} from the file. An error is signaled if the GIF file
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2738 doesn't contain an image with index @var{index}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2739 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2740
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2741 @ignore
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2742 This could be used to implement limited support for animated GIFs.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2743 For example, the following function displays a multi-image GIF file
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2744 at point-min in the current buffer, switching between sub-images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2745 every 0.1 seconds.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2746
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2747 (defun show-anim (file max)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2748 "Display multi-image GIF file FILE which contains MAX subimages."
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2749 (display-anim (current-buffer) file 0 max t))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2750
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2751 (defun display-anim (buffer file idx max first-time)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2752 (when (= idx max)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2753 (setq idx 0))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2754 (let ((img (create-image file nil :image idx)))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2755 (save-excursion
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2756 (set-buffer buffer)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2757 (goto-char (point-min))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2758 (unless first-time (delete-char 1))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2759 (insert-image img))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2760 (run-with-timer 0.1 nil 'display-anim buffer file (1+ idx) max nil)))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2761 @end ignore
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2762
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2763 @node Postscript Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2764 @subsection Postscript Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2765 @cindex Postscript images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2766
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2767 To use Postscript for an image, specify image type @code{postscript}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2768 This works only if you have Ghostscript installed. You must always use
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2769 these three properties:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2770
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2771 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2772 @item :pt-width @var{width}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2773 The value, @var{width}, specifies the width of the image measured in
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2774 points (1/72 inch). @var{width} must be an integer.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2775
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2776 @item :pt-height @var{height}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2777 The value, @var{height}, specifies the height of the image in points
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2778 (1/72 inch). @var{height} must be an integer.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2779
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2780 @item :bounding-box @var{box}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2781 The value, @var{box}, must be a list or vector of four integers, which
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2782 specifying the bounding box of the Postscript image, analogous to the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2783 @samp{BoundingBox} comment found in Postscript files.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2784
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2785 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2786 %%BoundingBox: 22 171 567 738
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2787 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2788 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2789
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
2790 Displaying Postscript images from Lisp data is not currently
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
2791 implemented, but it may be implemented by the time you read this.
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
2792 See the @file{etc/NEWS} file to make sure.
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
2793
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2794 @node Other Image Types
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2795 @subsection Other Image Types
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2796 @cindex PBM
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2797
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2798 For PBM images, specify image type @code{pbm}. Color, gray-scale and
32552
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
2799 monochromatic images are supported. For mono PBM images, two additional
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
2800 image properties are supported.
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
2801
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
2802 @table @code
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
2803 @item :foreground @var{foreground}
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
2804 The value, @var{foreground}, should be a string specifying the image
37949
1302dd937a79 Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents: 37170
diff changeset
2805 foreground color, or @code{nil} for the default color. This color is
1302dd937a79 Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents: 37170
diff changeset
2806 used for each pixel in the XBM that is 1. The default is the frame's
1302dd937a79 Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents: 37170
diff changeset
2807 foreground color.
32552
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
2808
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
2809 @item :background @var{background}
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
2810 The value, @var{background}, should be a string specifying the image
37949
1302dd937a79 Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents: 37170
diff changeset
2811 background color, or @code{nil} for the default color. This color is
1302dd937a79 Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents: 37170
diff changeset
2812 used for each pixel in the XBM that is 0. The default is the frame's
1302dd937a79 Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents: 37170
diff changeset
2813 background color.
32552
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
2814 @end table
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2815
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
2816 For JPEG images, specify image type @code{jpeg}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2817
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2818 For TIFF images, specify image type @code{tiff}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2819
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2820 For PNG images, specify image type @code{png}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2821
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2822 @node Defining Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2823 @subsection Defining Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2824
31373
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2825 The functions @code{create-image}, @code{defimage} and
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2826 @code{find-image} provide convenient ways to create image descriptors.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2827
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2828 @defun create-image file &optional type &rest props
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2829 @tindex create-image
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2830 This function creates and returns an image descriptor which uses the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2831 data in @var{file}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2832
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2833 The optional argument @var{type} is a symbol specifying the image type.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2834 If @var{type} is omitted or @code{nil}, @code{create-image} tries to
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2835 determine the image type from the file's first few bytes, or else
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2836 from the file's name.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2837
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2838 The remaining arguments, @var{props}, specify additional image
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2839 properties---for example,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2840
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2841 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2842 (create-image "foo.xpm" 'xpm :heuristic-mask t)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2843 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2844
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2845 The function returns @code{nil} if images of this type are not
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2846 supported. Otherwise it returns an image descriptor.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2847 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2848
41058
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
2849 @defmac defimage symbol specs &optional doc
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2850 @tindex defimage
41058
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
2851 This macro defines @var{symbol} as an image name. The arguments
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
2852 @var{specs} is a list which specifies how to display the image.
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
2853 The third argument, @var{doc}, is an optional documentation string.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2854
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2855 Each argument in @var{specs} has the form of a property list, and each
41058
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
2856 one should specify at least the @code{:type} property and either the
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
2857 @code{:file} or the @code{:data} property. The value of @code{:type}
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
2858 should be a symbol specifying the image type, the value of
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
2859 @code{:file} is the file to load the image from, and the value of
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
2860 @code{:data} is a string containing the actual image data. Here is an
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
2861 example:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2862
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2863 @example
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2864 (defimage test-image
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2865 '((:type xpm :file "~/test1.xpm")
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2866 (:type xbm :file "~/test1.xbm")))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2867 @end example
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2868
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2869 @code{defimage} tests each argument, one by one, to see if it is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2870 usable---that is, if the type is supported and the file exists. The
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2871 first usable argument is used to make an image descriptor which is
41058
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
2872 stored in @var{symbol}.
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
2873
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
2874 If none of the alternatives will work, then @var{symbol} is defined
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2875 as @code{nil}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2876 @end defmac
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2877
31373
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2878 @defun find-image specs
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2879 @tindex find-image
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2880 This function provides a convenient way to find an image satisfying one
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2881 of a list of image specifications @var{specs}.
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2882
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2883 Each specification in @var{specs} is a property list with contents
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2884 depending on image type. All specifications must at least contain the
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2885 properties @code{:type @var{type}} and either @w{@code{:file @var{file}}}
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2886 or @w{@code{:data @var{DATA}}}, where @var{type} is a symbol specifying
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2887 the image type, e.g.@: @code{xbm}, @var{file} is the file to load the
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2888 image from, and @var{data} is a string containing the actual image data.
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2889 The first specification in the list whose @var{type} is supported, and
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2890 @var{file} exists, is used to construct the image specification to be
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2891 returned. If no specification is satisfied, @code{nil} is returned.
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2892
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2893 The image is looked for first on @code{load-path} and then in
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2894 @code{data-directory}.
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2895 @end defun
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2896
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2897 @node Showing Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2898 @subsection Showing Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2899
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2900 You can use an image descriptor by setting up the @code{display}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2901 property yourself, but it is easier to use the functions in this
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2902 section.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2903
29471
215b57502518 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 29151
diff changeset
2904 @defun insert-image image &optional string area
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2905 This function inserts @var{image} in the current buffer at point. The
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2906 value @var{image} should be an image descriptor; it could be a value
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2907 returned by @code{create-image}, or the value of a symbol defined with
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2908 @code{defimage}. The argument @var{string} specifies the text to put in
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2909 the buffer to hold the image.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2910
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2911 The argument @var{area} specifies whether to put the image in a margin.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2912 If it is @code{left-margin}, the image appears in the left margin;
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2913 @code{right-margin} specifies the right margin. If @var{area} is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2914 @code{nil} or omitted, the image is displayed at point within the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2915 buffer's text.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2916
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2917 Internally, this function inserts @var{string} in the buffer, and gives
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2918 it a @code{display} property which specifies @var{image}. @xref{Display
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2919 Property}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2920 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2921
29471
215b57502518 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 29151
diff changeset
2922 @defun put-image image pos &optional string area
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2923 This function puts image @var{image} in front of @var{pos} in the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2924 current buffer. The argument @var{pos} should be an integer or a
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2925 marker. It specifies the buffer position where the image should appear.
29471
215b57502518 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 29151
diff changeset
2926 The argument @var{string} specifies the text that should hold the image
215b57502518 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 29151
diff changeset
2927 as an alternative to the default.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2928
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2929 The argument @var{image} must be an image descriptor, perhaps returned
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2930 by @code{create-image} or stored by @code{defimage}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2931
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2932 The argument @var{area} specifies whether to put the image in a margin.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2933 If it is @code{left-margin}, the image appears in the left margin;
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2934 @code{right-margin} specifies the right margin. If @var{area} is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2935 @code{nil} or omitted, the image is displayed at point within the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2936 buffer's text.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2937
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2938 Internally, this function creates an overlay, and gives it a
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2939 @code{before-string} property containing text that has a @code{display}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2940 property whose value is the image. (Whew!)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2941 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2942
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2943 @defun remove-images start end &optional buffer
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2944 This function removes images in @var{buffer} between positions
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2945 @var{start} and @var{end}. If @var{buffer} is omitted or @code{nil},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2946 images are removed from the current buffer.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2947
27331
be0a552c8320 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27193
diff changeset
2948 This removes only images that were put into @var{buffer} the way
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2949 @code{put-image} does it, not images that were inserted with
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2950 @code{insert-image} or in other ways.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2951 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2952
31373
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2953 @defun image-size spec &optional pixels frame
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2954 @tindex image-size
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2955 This function returns the size of an image as a pair
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2956 @w{@code{(@var{width} . @var{height})}}. @var{spec} is an image
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2957 specification. @var{pixels} non-nil means return sizes measured in
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2958 pixels, otherwise return sizes measured in canonical character units
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2959 (fractions of the width/height of the frame's default font).
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2960 @var{frame} is the frame on which the image will be displayed.
39404
5b69d94ceef3 (Font Lookup, Attribute Functions)
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
2961 @var{frame} null or omitted means use the selected frame (@pxref{Input
5b69d94ceef3 (Font Lookup, Attribute Functions)
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
2962 Focus}).
31373
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2963 @end defun
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
2964
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2965 @node Image Cache
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2966 @subsection Image Cache
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2967
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2968 Emacs stores images in an image cache when it displays them, so it can
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2969 display them again more efficiently. It removes an image from the cache
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2970 when it hasn't been displayed for a specified period of time.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2971
28770
313b9e6e2dbf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 27971
diff changeset
2972 When an image is looked up in the cache, its specification is compared
313b9e6e2dbf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 27971
diff changeset
2973 with cached image specifications using @code{equal}. This means that
313b9e6e2dbf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 27971
diff changeset
2974 all images with equal specifications share the same image in the cache.
313b9e6e2dbf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 27971
diff changeset
2975
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2976 @defvar image-cache-eviction-delay
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2977 @tindex image-cache-eviction-delay
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2978 This variable specifies the number of seconds an image can remain in the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2979 cache without being displayed. When an image is not displayed for this
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2980 length of time, Emacs removes it from the image cache.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2981
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2982 If the value is @code{nil}, Emacs does not remove images from the cache
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2983 except when you explicitly clear it. This mode can be useful for
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2984 debugging.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2985 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2986
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2987 @defun clear-image-cache &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2988 @tindex clear-image-cache
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2989 This function clears the image cache. If @var{frame} is non-@code{nil},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2990 only the cache for that frame is cleared. Otherwise all frames' caches
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2991 are cleared.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2992 @end defun
27447
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
2993
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2994 @node Blinking
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2995 @section Blinking Parentheses
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2996 @cindex parenthesis matching
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2997 @cindex blinking
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2998 @cindex balancing parentheses
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2999 @cindex close parenthesis
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3000
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3001 This section describes the mechanism by which Emacs shows a matching
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3002 open parenthesis when the user inserts a close parenthesis.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3003
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3004 @defvar blink-paren-function
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3005 The value of this variable should be a function (of no arguments) to
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3006 be called whenever a character with close parenthesis syntax is inserted.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3007 The value of @code{blink-paren-function} may be @code{nil}, in which
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3008 case nothing is done.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3009 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3010
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3011 @defopt blink-matching-paren
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3012 If this variable is @code{nil}, then @code{blink-matching-open} does
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3013 nothing.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3014 @end defopt
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3015
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3016 @defopt blink-matching-paren-distance
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3017 This variable specifies the maximum distance to scan for a matching
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3018 parenthesis before giving up.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3019 @end defopt
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3020
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3021 @defopt blink-matching-delay
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
3022 This variable specifies the number of seconds for the cursor to remain
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
3023 at the matching parenthesis. A fraction of a second often gives
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
3024 good results, but the default is 1, which works on all systems.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3025 @end defopt
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
3026
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3027 @deffn Command blink-matching-open
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3028 This function is the default value of @code{blink-paren-function}. It
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3029 assumes that point follows a character with close parenthesis syntax and
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3030 moves the cursor momentarily to the matching opening character. If that
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3031 character is not already on the screen, it displays the character's
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3032 context in the echo area. To avoid long delays, this function does not
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3033 search farther than @code{blink-matching-paren-distance} characters.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3034
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3035 Here is an example of calling this function explicitly.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3036
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3037 @smallexample
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3038 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3039 (defun interactive-blink-matching-open ()
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3040 @c Do not break this line! -- rms.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3041 @c The first line of a doc string
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3042 @c must stand alone.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3043 "Indicate momentarily the start of sexp before point."
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3044 (interactive)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3045 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3046 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3047 (let ((blink-matching-paren-distance
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3048 (buffer-size))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3049 (blink-matching-paren t))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3050 (blink-matching-open)))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3051 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3052 @end smallexample
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3053 @end deffn
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3054
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3055 @node Inverse Video
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3056 @section Inverse Video
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3057 @cindex Inverse Video
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3058
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3059 @defopt inverse-video
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3060 @cindex highlighting
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3061 This variable controls whether Emacs uses inverse video for all text
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3062 on the screen. Non-@code{nil} means yes, @code{nil} means no. The
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3063 default is @code{nil}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3064 @end defopt
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3065
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3066 @defopt mode-line-inverse-video
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3067 This variable controls the use of inverse video for mode lines and menu
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3068 bars. If it is non-@code{nil}, then these lines are displayed in
27331
be0a552c8320 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27193
diff changeset
3069 inverse video. Otherwise, these lines are displayed normally, just like
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3070 other text. The default is @code{t}.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3071
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3072 For window frames, this feature actually applies the face named
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3073 @code{mode-line}; that face is normally set up as the inverse of the
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3074 default face, unless you change it.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3075 @end defopt
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3076
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3077 @node Usual Display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3078 @section Usual Display Conventions
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3079
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3080 The usual display conventions define how to display each character
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3081 code. You can override these conventions by setting up a display table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3082 (@pxref{Display Tables}). Here are the usual display conventions:
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3083
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3084 @itemize @bullet
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3085 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3086 Character codes 32 through 126 map to glyph codes 32 through 126.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3087 Normally this means they display as themselves.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3088
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3089 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3090 Character code 9 is a horizontal tab. It displays as whitespace
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3091 up to a position determined by @code{tab-width}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3092
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3093 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3094 Character code 10 is a newline.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3095
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3096 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3097 All other codes in the range 0 through 31, and code 127, display in one
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
3098 of two ways according to the value of @code{ctl-arrow}. If it is
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3099 non-@code{nil}, these codes map to sequences of two glyphs, where the
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3100 first glyph is the @sc{ascii} code for @samp{^}. (A display table can
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3101 specify a glyph to use instead of @samp{^}.) Otherwise, these codes map
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3102 just like the codes in the range 128 to 255.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3103
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3104 On MS-DOS terminals, Emacs arranges by default for the character code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3105 127 to be mapped to the glyph code 127, which normally displays as an
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3106 empty polygon. This glyph is used to display non-@sc{ascii} characters
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3107 that the MS-DOS terminal doesn't support. @xref{MS-DOS and MULE,,,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3108 emacs, The GNU Emacs Manual}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3109
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3110 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3111 Character codes 128 through 255 map to sequences of four glyphs, where
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3112 the first glyph is the @sc{ascii} code for @samp{\}, and the others are
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3113 digit characters representing the character code in octal. (A display
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3114 table can specify a glyph to use instead of @samp{\}.)
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3115
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3116 @item
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3117 Multibyte character codes above 256 are displayed as themselves, or as a
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3118 question mark or empty box if the terminal cannot display that
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3119 character.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3120 @end itemize
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3121
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3122 The usual display conventions apply even when there is a display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3123 table, for any character whose entry in the active display table is
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3124 @code{nil}. Thus, when you set up a display table, you need only
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3125 specify the characters for which you want special behavior.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3126
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
3127 These display rules apply to carriage return (character code 13), when
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
3128 it appears in the buffer. But that character may not appear in the
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
3129 buffer where you expect it, if it was eliminated as part of end-of-line
25454
80ac191b6d2b *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 24951
diff changeset
3130 conversion (@pxref{Coding System Basics}).
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
3131
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3132 These variables affect the way certain characters are displayed on the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3133 screen. Since they change the number of columns the characters occupy,
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3134 they also affect the indentation functions. These variables also affect
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3135 how the mode line is displayed; if you want to force redisplay of the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3136 mode line using the new values, call the function
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3137 @code{force-mode-line-update} (@pxref{Mode Line Format}).
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3138
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3139 @defopt ctl-arrow
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3140 @cindex control characters in display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3141 This buffer-local variable controls how control characters are
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3142 displayed. If it is non-@code{nil}, they are displayed as a caret
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3143 followed by the character: @samp{^A}. If it is @code{nil}, they are
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3144 displayed as a backslash followed by three octal digits: @samp{\001}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3145 @end defopt
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3146
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3147 @c Following may have overfull hbox.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3148 @defvar default-ctl-arrow
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3149 The value of this variable is the default value for @code{ctl-arrow} in
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3150 buffers that do not override it. @xref{Default Value}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3151 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3152
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
3153 @defopt indicate-empty-lines
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
3154 @tindex indicate-empty-lines
42905
09cd352a779e (Truncation, Overlay Arrow, Usual Display): Add index entries for fringe
Eli Zaretskii <eliz@gnu.org>
parents: 42888
diff changeset
3155 @cindex fringes, and empty line indication
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
3156 When this is non-@code{nil}, Emacs displays a special glyph in
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
3157 each empty line at the end of the buffer, on terminals that
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
3158 support it (window systems).
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
3159 @end defopt
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
3160
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3161 @defopt tab-width
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3162 The value of this variable is the spacing between tab stops used for
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3163 displaying tab characters in Emacs buffers. The value is in units of
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3164 columns, and the default is 8. Note that this feature is completely
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3165 independent of the user-settable tab stops used by the command
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3166 @code{tab-to-tab-stop}. @xref{Indent Tabs}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3167 @end defopt
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3168
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3169 @node Display Tables
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3170 @section Display Tables
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3171
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3172 @cindex display table
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3173 You can use the @dfn{display table} feature to control how all possible
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3174 character codes display on the screen. This is useful for displaying
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3175 European languages that have letters not in the @sc{ascii} character
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3176 set.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3177
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3178 The display table maps each character code into a sequence of
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3179 @dfn{glyphs}, each glyph being a graphic that takes up one character
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3180 position on the screen. You can also define how to display each glyph
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3181 on your terminal, using the @dfn{glyph table}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3182
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3183 Display tables affect how the mode line is displayed; if you want to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3184 force redisplay of the mode line using a new display table, call
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3185 @code{force-mode-line-update} (@pxref{Mode Line Format}).
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3186
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3187 @menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3188 * Display Table Format:: What a display table consists of.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3189 * Active Display Table:: How Emacs selects a display table to use.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3190 * Glyphs:: How to define a glyph, and what glyphs mean.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3191 @end menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3192
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3193 @node Display Table Format
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3194 @subsection Display Table Format
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3195
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3196 A display table is actually a char-table (@pxref{Char-Tables}) with
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3197 @code{display-table} as its subtype.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3198
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3199 @defun make-display-table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3200 This creates and returns a display table. The table initially has
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3201 @code{nil} in all elements.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3202 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3203
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3204 The ordinary elements of the display table are indexed by character
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3205 codes; the element at index @var{c} says how to display the character
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3206 code @var{c}. The value should be @code{nil} or a vector of glyph
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3207 values (@pxref{Glyphs}). If an element is @code{nil}, it says to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3208 display that character according to the usual display conventions
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3209 (@pxref{Usual Display}).
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
3210
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
3211 If you use the display table to change the display of newline
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
3212 characters, the whole buffer will be displayed as one long ``line.''
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3213
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3214 The display table also has six ``extra slots'' which serve special
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3215 purposes. Here is a table of their meanings; @code{nil} in any slot
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3216 means to use the default for that slot, as stated below.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3217
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3218 @table @asis
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3219 @item 0
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3220 The glyph for the end of a truncated screen line (the default for this
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3221 is @samp{$}). @xref{Glyphs}. Newer Emacs versions, on some platforms,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3222 display arrows to indicate truncation---the display table has no effect
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3223 in these situations.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3224 @item 1
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3225 The glyph for the end of a continued line (the default is @samp{\}).
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3226 Newer Emacs versions, on some platforms, display curved arrows to
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3227 indicate truncation---the display table has no effect in these
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3228 situations.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3229 @item 2
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3230 The glyph for indicating a character displayed as an octal character
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3231 code (the default is @samp{\}).
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3232 @item 3
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3233 The glyph for indicating a control character (the default is @samp{^}).
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3234 @item 4
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3235 A vector of glyphs for indicating the presence of invisible lines (the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3236 default is @samp{...}). @xref{Selective Display}.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3237 @item 5
8925
b05788fd41f0 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 8096
diff changeset
3238 The glyph used to draw the border between side-by-side windows (the
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3239 default is @samp{|}). @xref{Splitting Windows}. This takes effect only
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3240 when there are no scroll bars; if scroll bars are supported and in use,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3241 a scroll bar separates the two windows.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3242 @end table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3243
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3244 For example, here is how to construct a display table that mimics the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3245 effect of setting @code{ctl-arrow} to a non-@code{nil} value:
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3246
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3247 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3248 (setq disptab (make-display-table))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3249 (let ((i 0))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3250 (while (< i 32)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3251 (or (= i ?\t) (= i ?\n)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3252 (aset disptab i (vector ?^ (+ i 64))))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3253 (setq i (1+ i)))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3254 (aset disptab 127 (vector ?^ ??)))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3255 @end example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3256
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3257 @defun display-table-slot display-table slot
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3258 This function returns the value of the extra slot @var{slot} of
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3259 @var{display-table}. The argument @var{slot} may be a number from 0 to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3260 5 inclusive, or a slot name (symbol). Valid symbols are
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3261 @code{truncation}, @code{wrap}, @code{escape}, @code{control},
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3262 @code{selective-display}, and @code{vertical-border}.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3263 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3264
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3265 @defun set-display-table-slot display-table slot value
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3266 This function stores @var{value} in the extra slot @var{slot} of
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3267 @var{display-table}. The argument @var{slot} may be a number from 0 to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3268 5 inclusive, or a slot name (symbol). Valid symbols are
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3269 @code{truncation}, @code{wrap}, @code{escape}, @code{control},
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3270 @code{selective-display}, and @code{vertical-border}.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3271 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3272
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3273 @defun describe-display-table display-table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3274 @tindex describe-display-table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3275 This function displays a description of the display table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3276 @var{display-table} in a help buffer.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3277 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3278
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3279 @deffn Command describe-current-display-table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3280 @tindex describe-current-display-table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3281 This command displays a description of the current display table in a
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3282 help buffer.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3283 @end deffn
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3284
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3285 @node Active Display Table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3286 @subsection Active Display Table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3287 @cindex active display table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3288
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3289 Each window can specify a display table, and so can each buffer. When
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3290 a buffer @var{b} is displayed in window @var{w}, display uses the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3291 display table for window @var{w} if it has one; otherwise, the display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3292 table for buffer @var{b} if it has one; otherwise, the standard display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3293 table if any. The display table chosen is called the @dfn{active}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3294 display table.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3295
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3296 @defun window-display-table window
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3297 This function returns @var{window}'s display table, or @code{nil}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3298 if @var{window} does not have an assigned display table.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3299 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3300
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3301 @defun set-window-display-table window table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3302 This function sets the display table of @var{window} to @var{table}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3303 The argument @var{table} should be either a display table or
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3304 @code{nil}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3305 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3306
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3307 @defvar buffer-display-table
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3308 This variable is automatically buffer-local in all buffers; its value in
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3309 a particular buffer specifies the display table for that buffer. If it
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3310 is @code{nil}, that means the buffer does not have an assigned display
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3311 table.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3312 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3313
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3314 @defvar standard-display-table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3315 This variable's value is the default display table, used whenever a
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3316 window has no display table and neither does the buffer displayed in
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3317 that window. This variable is @code{nil} by default.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3318 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3319
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3320 If there is no display table to use for a particular window---that is,
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3321 if the window specifies none, its buffer specifies none, and
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3322 @code{standard-display-table} is @code{nil}---then Emacs uses the usual
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3323 display conventions for all character codes in that window. @xref{Usual
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3324 Display}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3325
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3326 A number of functions for changing the standard display table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3327 are defined in the library @file{disp-table}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3328
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3329 @node Glyphs
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3330 @subsection Glyphs
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3331
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3332 @cindex glyph
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3333 A @dfn{glyph} is a generalization of a character; it stands for an
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3334 image that takes up a single character position on the screen. Glyphs
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3335 are represented in Lisp as integers, just as characters are.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3336
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3337 @cindex glyph table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3338 The meaning of each integer, as a glyph, is defined by the glyph
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3339 table, which is the value of the variable @code{glyph-table}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3340
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3341 @defvar glyph-table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3342 The value of this variable is the current glyph table. It should be a
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3343 vector; the @var{g}th element defines glyph code @var{g}. If the value
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3344 is @code{nil} instead of a vector, then all glyphs are simple (see
39205
cb857398a0e0 (The Echo Area) <message>: Document message-truncate-lines.
Eli Zaretskii <eliz@gnu.org>
parents: 39032
diff changeset
3345 below). The glyph table is not used on windowed displays.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3346 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3347
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3348 Here are the possible types of elements in the glyph table:
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3349
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3350 @table @asis
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3351 @item @var{string}
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3352 Send the characters in @var{string} to the terminal to output
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3353 this glyph. This alternative is available on character terminals,
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3354 but not under a window system.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3355
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3356 @item @var{integer}
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3357 Define this glyph code as an alias for glyph code @var{integer}. You
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3358 can use an alias to specify a face code for the glyph; see below.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3359
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3360 @item @code{nil}
42827
3616610fabd8 (Glyphs): All display types support faces in glyphs nowadays.
Eli Zaretskii <eliz@gnu.org>
parents: 42476
diff changeset
3361 This glyph is simple. The glyph code mod 524288 is the character to
3616610fabd8 (Glyphs): All display types support faces in glyphs nowadays.
Eli Zaretskii <eliz@gnu.org>
parents: 42476
diff changeset
3362 output, and the glyph code divided by 524288 specifies the face number
3616610fabd8 (Glyphs): All display types support faces in glyphs nowadays.
Eli Zaretskii <eliz@gnu.org>
parents: 42476
diff changeset
3363 (@pxref{Face Functions}) to use while outputting it. (524288 is
27193
89afca54a135 @ifinto -> @ifnottex.
Gerd Moellmann <gerd@gnu.org>
parents: 27189
diff changeset
3364 @ifnottex
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3365 2**19.)
27193
89afca54a135 @ifinto -> @ifnottex.
Gerd Moellmann <gerd@gnu.org>
parents: 27189
diff changeset
3366 @end ifnottex
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3367 @tex
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3368 $2^{19}$.)
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3369 @end tex
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3370 @xref{Faces}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3371 @end table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3372
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3373 If a glyph code is greater than or equal to the length of the glyph
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3374 table, that code is automatically simple.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3375
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3376 @defun create-glyph string
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3377 @tindex create-glyph
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3378 This function returns a newly-allocated glyph code which is set up to
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3379 display by sending @var{string} to the terminal.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3380 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3381
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3382 @node Beeping
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3383 @section Beeping
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3384 @cindex beeping
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3385 @cindex bell
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3386
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3387 This section describes how to make Emacs ring the bell (or blink the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3388 screen) to attract the user's attention. Be conservative about how
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3389 often you do this; frequent bells can become irritating. Also be
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3390 careful not to use just beeping when signaling an error is more
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3391 appropriate. (@xref{Errors}.)
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3392
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3393 @defun ding &optional do-not-terminate
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3394 @cindex keyboard macro termination
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3395 This function beeps, or flashes the screen (see @code{visible-bell} below).
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3396 It also terminates any keyboard macro currently executing unless
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3397 @var{do-not-terminate} is non-@code{nil}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3398 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3399
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3400 @defun beep &optional do-not-terminate
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3401 This is a synonym for @code{ding}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3402 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3403
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3404 @defopt visible-bell
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3405 This variable determines whether Emacs should flash the screen to
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3406 represent a bell. Non-@code{nil} means yes, @code{nil} means no. This
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3407 is effective on a window system, and on a character-only terminal
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3408 provided the terminal's Termcap entry defines the visible bell
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3409 capability (@samp{vb}).
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3410 @end defopt
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3411
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3412 @defvar ring-bell-function
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3413 If this is non-@code{nil}, it specifies how Emacs should ``ring the
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3414 bell.'' Its value should be a function of no arguments. If this is
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3415 non-@code{nil}, it takes precedence over the @code{visible-bell}
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3416 variable.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3417 @end defvar
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3418
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3419 @node Window Systems
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3420 @section Window Systems
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3421
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3422 Emacs works with several window systems, most notably the X Window
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3423 System. Both Emacs and X use the term ``window'', but use it
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3424 differently. An Emacs frame is a single window as far as X is
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3425 concerned; the individual Emacs windows are not known to X at all.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3426
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3427 @defvar window-system
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3428 This variable tells Lisp programs what window system Emacs is running
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3429 under. The possible values are
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3430
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3431 @table @code
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3432 @item x
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3433 @cindex X Window System
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3434 Emacs is displaying using X.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3435 @item pc
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3436 Emacs is displaying using MS-DOS.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3437 @item w32
27332
5cfe77eaff45 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27331
diff changeset
3438 Emacs is displaying using Windows.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3439 @item mac
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3440 Emacs is displaying using a Macintosh.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3441 @item nil
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3442 Emacs is using a character-based terminal.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3443 @end table
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3444 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3445
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3446 @defvar window-setup-hook
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3447 This variable is a normal hook which Emacs runs after handling the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3448 initialization files. Emacs runs this hook after it has completed
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3449 loading your init file, the default initialization file (if
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3450 any), and the terminal-specific Lisp code, and running the hook
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3451 @code{term-setup-hook}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3452
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3453 This hook is used for internal purposes: setting up communication with
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3454 the window system, and creating the initial window. Users should not
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3455 interfere with it.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3456 @end defvar