annotate lispref/display.texi @ 52635:9963e9da5850

(quote_file_name): Print the result instead of returning it. Fix the return type accordingly. (main): Under --eval, don't fail if left with additional arguments after decoding options. Quote file names.
author Eli Zaretskii <eliz@gnu.org>
date Sun, 28 Sep 2003 08:24:56 +0000
parents 3bbb565fa7ac
children f1ba36825faa
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.
45745
394a19fc134e defface `supports' predicate
Miles Bader <miles@gnu.org>
parents: 44281
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2000, 2001, 2002
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
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.
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
18 * Warnings:: Displaying warning messages for the user.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
19 * Invisible Text:: Hiding part of the buffer text.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
20 * Selective Display:: Hiding part of the buffer text (the old way).
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 * Overlay Arrow:: Display of an arrow to indicate position.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22 * Temporary Displays:: Displays that go away automatically.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23 * Overlays:: Use overlays to highlight parts of the buffer.
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
24 * Width:: How wide a character or string is on the screen.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
25 * Faces:: A face defines a graphics style for text characters:
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
26 font, colors, etc.
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
27 * Fringes:: Controlling window fringes.
52483
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
28 * Scroll Bars:: Controlling vertical scroll bars.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
29 * Display Property:: Enabling special display features.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
30 * Images:: Displaying images in Emacs buffers.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 * Blinking:: How Emacs shows the matching open parenthesis.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32 * Inverse Video:: Specifying how the screen looks.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 * Usual Display:: The usual conventions for displaying nonprinting chars.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 * Display Tables:: How to specify other conventions.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35 * Beeping:: Audible signal to the user.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 * Window Systems:: Which window system is being used.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 @end menu
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 @node Refresh Screen
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40 @section Refreshing the Screen
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 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
43 given frame (@pxref{Frames}).
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 @c Emacs 19 feature
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 @defun redraw-frame frame
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 This function clears and redisplays frame @var{frame}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
48 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50 Even more powerful is @code{redraw-display}:
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52 @deffn Command redraw-display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53 This function clears and redisplays all visible frames.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
54 @end deffn
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
56 Processing user input takes absolute priority over redisplay. If you
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
57 call these functions when input is available, they do nothing
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
58 immediately, but a full redisplay does happen eventually---after all the
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
59 input has been processed.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
60
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 Normally, suspending and resuming Emacs also refreshes the screen.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 Some terminal emulators record separate contents for display-oriented
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63 programs such as Emacs and for ordinary sequential display. If you are
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 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
65 resumption.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
67 @defvar no-redraw-on-reenter
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68 @cindex suspend (cf. @code{no-redraw-on-reenter})
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69 @cindex resume (cf. @code{no-redraw-on-reenter})
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 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
71 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
72 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
73 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
75 @node Forcing Redisplay
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
76 @section Forcing Redisplay
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
77 @cindex forcing redisplay
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
78
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
79 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
80 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
81 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
82 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
83
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
84 @tindex redisplay-dont-pause
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
85 @defvar redisplay-dont-pause
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
86 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
87 prevent or halt redisplay; redisplay occurs, and finishes,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
88 regardless of whether input is available. This feature is available
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
89 as of Emacs 21.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
90 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
91
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
92 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
93 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
94 pending, do this:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
95
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
96 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
97 (let ((redisplay-dont-pause t))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
98 (sit-for 0))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
99 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
100
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
101 @node Truncation
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
102 @section Truncation
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
103 @cindex line wrapping
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104 @cindex continuation lines
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
105 @cindex @samp{$} in display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
106 @cindex @samp{\} in display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
107
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
108 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
109 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
110 one screen line. The additional screen lines used to display a long
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
111 text line are called @dfn{continuation} lines. Normally, a @samp{$} in
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
112 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
113 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
114 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
115 specify alternative indicators; see @ref{Display Tables}.)
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
116
42905
09cd352a779e (Truncation, Overlay Arrow, Usual Display): Add index entries for fringe
Eli Zaretskii <eliz@gnu.org>
parents: 42888
diff changeset
117 On a windowed display, the @samp{$} and @samp{\} indicators are
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
118 replaced with graphics bitmaps displayed in the window fringes
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
119 (@pxref{Fringes}).
42905
09cd352a779e (Truncation, Overlay Arrow, Usual Display): Add index entries for fringe
Eli Zaretskii <eliz@gnu.org>
parents: 42888
diff changeset
120
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
121 Note that continuation is different from filling; continuation happens
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
122 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
123 precisely at the right margin, not at a word boundary. @xref{Filling}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
124
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125 @defopt truncate-lines
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
126 This buffer-local variable controls how Emacs displays lines that extend
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
127 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
128 specifies continuation. If the value is non-@code{nil}, then these
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
129 lines are truncated.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
130
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
131 If the variable @code{truncate-partial-width-windows} is non-@code{nil},
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
132 then truncation is always used for side-by-side windows (within one
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
133 frame) regardless of the value of @code{truncate-lines}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
134 @end defopt
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
135
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
136 @defopt default-truncate-lines
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
137 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
138 buffers that do not have buffer-local values for it.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
139 @end defopt
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
140
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
141 @defopt truncate-partial-width-windows
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
142 This variable controls display of lines that extend beyond the right
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
143 edge of the window, in side-by-side windows (@pxref{Splitting Windows}).
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
144 If it is non-@code{nil}, these lines are truncated; otherwise,
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
145 @code{truncate-lines} says what to do with them.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
146 @end defopt
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
147
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
148 When horizontal scrolling (@pxref{Horizontal Scrolling}) is in use in
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
149 a window, that forces truncation.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
150
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
151 You can override the glyphs that indicate continuation or truncation
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
152 using the display table; see @ref{Display Tables}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
153
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
154 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
155 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
156 redisplay slow. The column computation and indentation functions also
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
157 become slow. Then you might find it advisable to set
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
158 @code{cache-long-line-scans} to @code{t}.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
159
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
160 @defvar cache-long-line-scans
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
161 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
162 functions, and Emacs redisplay, cache the results of scanning the
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
163 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
164 unless they are modified.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
165
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
166 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
167
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
168 This variable is automatically buffer-local in every buffer.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
169 @end defvar
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
170
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
171 @node The Echo Area
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
172 @section The Echo Area
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
173 @cindex error display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
174 @cindex echo area
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
175
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
176 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
177 @code{message} primitive, and for echoing keystrokes. It is not the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
178 same as the minibuffer, despite the fact that the minibuffer appears
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
179 (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
180 @cite{GNU Emacs Manual} specifies the rules for resolving conflicts
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
181 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
182 (@pxref{Minibuffer,, The Minibuffer, emacs, The GNU Emacs Manual}).
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
183 Error messages appear in the echo area; see @ref{Errors}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
184
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
185 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
186 functions with @code{t} as the stream (@pxref{Output Functions}), or as
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
187 follows:
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
188
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
189 @defun message string &rest arguments
39205
cb857398a0e0 (The Echo Area) <message>: Document message-truncate-lines.
Eli Zaretskii <eliz@gnu.org>
parents: 39032
diff changeset
190 This function displays a message in the echo area. The
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
191 argument @var{string} is similar to a C language @code{printf} control
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
192 string. See @code{format} in @ref{String Conversion}, for the details
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
193 on the conversion specifications. @code{message} returns the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
194 constructed string.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
195
7735
7db892210924 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7086
diff changeset
196 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
197 error stream, followed by a newline.
7db892210924 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7086
diff changeset
198
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
199 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
200 text properties, these affect the way the message is displayed.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
201
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
202 @c Emacs 19 feature
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
203 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
204 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
205 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
206 minibuffer contents back onto the screen immediately.
7735
7db892210924 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7086
diff changeset
207
39205
cb857398a0e0 (The Echo Area) <message>: Document message-truncate-lines.
Eli Zaretskii <eliz@gnu.org>
parents: 39032
diff changeset
208 @vindex message-truncate-lines
39221
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39217
diff changeset
209 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
210 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
211 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
212 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
213
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
214 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
215 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
216 (message "Minibuffer depth is %d."
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
217 (minibuffer-depth))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
218 @print{} Minibuffer depth is 0.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
219 @result{} "Minibuffer depth is 0."
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
220 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
221
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
222 @group
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 Minibuffer depth is 0.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
225 ---------- Echo Area ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
226 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
227 @end example
32261
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
228
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
229 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
230 depending on its size, use @code{display-message-or-buffer}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
231 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
232
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
233 @tindex with-temp-message
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
234 @defmac with-temp-message message &rest body
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
235 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
236 the execution of @var{body}. It displays @var{message}, executes
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
237 @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
238 the previous echo area contents.
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
239 @end defmac
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
240
22843
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
241 @defun message-or-box string &rest arguments
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
242 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
243 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
244 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
245 @code{last-nonmenu-event} (@pxref{Command Loop Info}) is either
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
246 @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
247 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
248 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
249 @ref{Yes-or-No Queries}.)
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
250
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
251 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
252 @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
253 @end defun
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
254
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
255 @defun message-box string &rest arguments
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
256 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
257 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
258 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
259 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
260 @code{message}.
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
261 @end defun
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
262
32261
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
263 @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
264 @tindex display-message-or-buffer
32261
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
265 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
266 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
267 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
268 in the echo area, using @code{message}. Otherwise,
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
269 @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
270
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
271 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
272 buffer is used, the window used to display it.
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
273
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
274 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
275 @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
276 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
277 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
278 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
279
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
280 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
281 @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
282 @end defun
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
283
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
284 @defun current-message
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
285 This function returns the message currently being displayed in the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
286 echo area, or @code{nil} if there is none.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
287 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
288
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
289 @defvar cursor-in-echo-area
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
290 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
291 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
292 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
293 point---not in the echo area at all.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
294
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
295 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
296 for brief periods of time.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
297 @end defvar
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
298
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
299 @defvar echo-area-clear-hook
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
300 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
301 @code{(message nil)} or for any other reason.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
302 @end defvar
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
303
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
304 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
305 in the @samp{*Messages*} buffer.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
306
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
307 @defopt message-log-max
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
308 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
309 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
310 keep. The value @code{nil} disables message logging entirely. Here's
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
311 how to display a message and prevent it from being logged:
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
312
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
313 @example
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
314 (let (message-log-max)
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
315 (message @dots{}))
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
316 @end example
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
317 @end defopt
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
318
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
319 @defvar echo-keystrokes
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
320 This variable determines how much time should elapse before command
27971
b10a9716fb38 echo-keystrokes change.
Dave Love <fx@gnu.org>
parents: 27654
diff changeset
321 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
322 which specifies the
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
323 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
324 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
325 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
326 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
327 sequence are echoed immediately.)
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
328
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
329 If the value is zero, then command input is not echoed.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
330 @end defvar
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
331
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
332 @node Warnings
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
333 @section Reporting Warnings
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
334 @cindex warnings
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
335
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
336 @dfn{Warnings} are a facility for a program to inform the user of a
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
337 possible problem, but continue running.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
338
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
339 @menu
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
340 * Warning Basics:: Warnings concepts and functions to report them.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
341 * Warning Variables:: Variables programs bind to customize their warnings.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
342 * Warning Options:: Variables users set to control display of warnings.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
343 @end menu
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
344
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
345 @node Warning Basics
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
346 @subsection Warning Basics
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
347 @cindex severity level
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
348
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
349 Every warning has a textual message, which explains the problem for
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
350 the user, and a @dfn{severity level} which is a symbol. Here are the
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
351 possible severity levels, in order of decreasing severity, and their
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
352 meanings:
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
353
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
354 @table @code
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
355 @item :emergency
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
356 A problem that will seriously impair Emacs operation soon
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
357 if you do not attend to it promptly.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
358 @item :error
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
359 A report of data or circumstances that are inherently wrong.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
360 @item :warning
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
361 A report of data or circumstances that are not inherently wrong, but
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
362 raise suspicion of a possible problem.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
363 @item :debug
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
364 A report of information that may be useful if you are debugging.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
365 @end table
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
366
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
367 When your program encounters invalid input data, it can either
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
368 signal a Lisp error by calling @code{error} or @code{signal} or report
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
369 a warning with severity @code{:error}. Signaling a Lisp error is the
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
370 easiest thing to do, but it means the program cannot continue
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
371 processing. If you want to take the trouble to implement a way to
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
372 continue processing despite the bad data, then reporting a warning of
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
373 severity @code{:error} is the right way to inform the user of the
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
374 problem. For instance, the Emacs Lisp byte compiler can report an
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
375 error that way and continue compiling other functions. (If the
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
376 program signals a Lisp error and then handles it with
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
377 @code{condition-case}, the user won't see the error message; it could
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
378 show the message to the user by reporting it as a warning.)
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
379
52156
198af82c7606 (Warning Basics): Fix typo.
John Paul Wallington <jpw@pobox.com>
parents: 52141
diff changeset
380 @cindex warning type
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
381 Each warning has a @dfn{warning type} to classify it. The type is a
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
382 list of symbols. The first symbol should be the custom group that you
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
383 use for the program's user options. For example, byte compiler
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
384 warnings use the warning type @code{(bytecomp)}. You can also
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
385 subcategorize the warnings, if you wish, by using more symbols in the
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
386 list.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
387
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
388 @defun display-warning type message &optional level buffer-name
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
389 This function reports a warning, using @var{message} as the message
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
390 and @var{type} as the warning type. @var{level} should be the
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
391 severity level, with @code{:warning} being the default.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
392
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
393 @var{buffer-name}, if non-@code{nil}, specifies the name of the buffer
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
394 for logging the warning. By default, it is @samp{*Warnings*}.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
395 @end defun
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
396
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
397 @defun lwarn type level message &rest args
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
398 This function reports a warning using the value of @code{(format
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
399 @var{message} @var{args}...)} as the message. In other respects it is
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
400 equivalent to @code{display-warning}.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
401 @end defun
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
402
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
403 @defun warn message &rest args
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
404 This function reports a warning using the value of @code{(format
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
405 @var{message} @var{args}...)} as the message, @code{(emacs)} as the
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
406 type, and @code{:warning} as the severity level. It exists for
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
407 compatibility only; we recommend not using it, because you should
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
408 specify a specific warning type.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
409 @end defun
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
410
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
411 @node Warning Variables
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
412 @subsection Warning Variables
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
413
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
414 Programs can customize how their warnings appear by binding
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
415 the variables described in this section.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
416
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
417 @defvar warning-levels
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
418 This list defines the meaning and severity order of the warning
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
419 severity levels. Each element defines one severity level,
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
420 and they are arranged in order of decreasing severity.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
421
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
422 Each element has the form @code{(@var{level} @var{string}
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
423 @var{function})}, where @var{level} is the severity level it defines.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
424 @var{string} specifies the textual description of this level.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
425 @var{string} should use @samp{%s} to specify where to put the warning
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
426 type information, or it can omit the @samp{%s} so as not to include
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
427 that information.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
428
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
429 The optional @var{function}, if non-@code{nil}, is a function to call
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
430 with no arguments, to get the user's attention.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
431
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
432 Normally you should not change the value of this variable.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
433 @end defvar
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
434
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
435 @defvar warning-prefix-function
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
436 If non-@code{nil}, te value is a function to generate prefix text for
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
437 warnings. Programs can bind the variable to a suitable function.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
438 @code{display-warning} calls this function with the warnings buffer
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
439 current, and the function can insert text in it. That text becomes
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
440 the beginning of the warning message.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
441
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
442 The function is called with two arguments, the severity level and its
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
443 entry in @code{warning-levels}. It should return a list to use as the
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
444 entry (this value need not be an actual member of
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
445 @code{warning-levels}). By constructing this value, the function to
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
446 change the severity of the warning, or specify different handling for
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
447 a given severity level.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
448
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
449 If the variable's value is @code{nil} then there is no function
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
450 to call.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
451 @end defvar
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
452
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
453 @defvar warning-series
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
454 Programs can bind this variable to @code{t} to say that the next
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
455 warning should begin a series. When several warnings form a series,
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
456 that means to leave point on the first warning of the series, rather
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
457 than keep move it for each warning so that it appears on the last one.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
458 The series ends when the local binding is unbound and
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
459 @code{warning-series} becomes @code{nil} again.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
460
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
461 The value can also be a symbol with a function definition. That is
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
462 equivalent to @code{t}, except that the next warning will also call
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
463 the function with no arguments with the warnings buffer current. The
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
464 function can insert text which will serve as a header for the series
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
465 of warnings.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
466
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
467 Once a series has begun, the value is a marker which points to the
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
468 buffer position in the warnings buffer of the start of the series.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
469
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
470 The variable's normal value is @code{nil}, which means to handle
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
471 each warning separately.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
472 @end defvar
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
473
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
474 @defvar warning-fill-prefix
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
475 When this variable is non-@code{nil}, it specifies a fill prefix to
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
476 use for filling each warning's text.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
477 @end defvar
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
478
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
479 @defvar warning-type-format
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
480 This variable specifies the format for displaying the warning type
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
481 in the warning message. The result of formatting the type this way
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
482 gets included in the message under the control of the string in the
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
483 entry in @code{warning-levels}. The default value is @code{" (%s)"}.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
484 If you bind it to @code{""} then the warning type won't appear at
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
485 all.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
486 @end defvar
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
487
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
488 @node Warning Options
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
489 @subsection Warning Options
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
490
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
491 These variables are used by users to control what happens
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
492 when a Lisp program reports a warning.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
493
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
494 @defopt warning-minimum-level
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
495 This user option specifies the minimum severity level that should be
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
496 shown immediately to the user. The default is @code{:warning}, which
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
497 means to immediately display all warnings except @code{:debug}
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
498 warnings.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
499 @end defopt
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
500
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
501 @defopt warning-minimum-log-level
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
502 This user option specifies the minimum severity level that should be
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
503 logged in the warnings buffer. The default is @code{:warning}, which
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
504 means to log all warnings except @code{:debug} warnings.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
505 @end defopt
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
506
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
507 @defopt warning-suppress-types
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
508 This list specifies which warning types should not be displayed
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
509 immediately for the user. Each element of the list should be a list
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
510 of symbols. If its elements match the first elements in a warning
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
511 type, then that warning is not displayed immediately.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
512 @end defopt
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
513
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
514 @defopt warning-suppress-log-types
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
515 This list specifies which warning types should not be logged in the
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
516 warnings buffer. Each element of the list should be a list of
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
517 symbols. If it matches the first few elements in a warning type, then
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
518 that warning is not logged.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
519 @end defopt
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
520 @node Invisible Text
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
521 @section Invisible Text
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
522
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
523 @cindex invisible text
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
524 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
525 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
526 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
527 (@pxref{Overlays}).
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
528
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
529 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
530 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
531 the default value of @code{buffer-invisibility-spec}, this is how the
48948
4dfb36c387bf Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents: 48701
diff changeset
532 @code{invisible} property works. You should normally use @code{t}
4dfb36c387bf Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents: 48701
diff changeset
533 as the value of the @code{invisible} property if you don't plan
4dfb36c387bf Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents: 48701
diff changeset
534 to set @code{buffer-invisibility-spec} yourself.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
535
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
536 More generally, you can use the variable @code{buffer-invisibility-spec}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
537 to control which values of the @code{invisible} property make text
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
538 invisible. This permits you to classify the text into different subsets
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
539 in advance, by giving them different @code{invisible} values, and
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
540 subsequently make various subsets visible or invisible by changing the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
541 value of @code{buffer-invisibility-spec}.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
542
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
543 Controlling visibility with @code{buffer-invisibility-spec} is
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
544 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
545 database. It permits the implementation of convenient filtering
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
546 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
547 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
548 the buffer looking for properties to change.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
549
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
550 @defvar buffer-invisibility-spec
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
551 This variable specifies which kinds of @code{invisible} properties
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
552 actually make a character invisible.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
553
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
554 @table @asis
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
555 @item @code{t}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
556 A character is invisible if its @code{invisible} property is
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
557 non-@code{nil}. This is the default.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
558
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
559 @item a list
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
560 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
561 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
562 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
563
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
564 @table @code
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
565 @item @var{atom}
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
566 A character is invisible if its @code{invisible} property value
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
567 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
568
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
569 @item (@var{atom} . t)
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
570 A character is invisible if its @code{invisible} property value
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
571 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
572 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
573 by a visible newline, it displays an ellipsis.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
574 @end table
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
575 @end table
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
576 @end defvar
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
577
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
578 Two functions are specifically provided for adding elements to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
579 @code{buffer-invisibility-spec} and removing elements from it.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
580
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
581 @defun add-to-invisibility-spec element
48948
4dfb36c387bf Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents: 48701
diff changeset
582 This function adds the element @var{element} to
4dfb36c387bf Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents: 48701
diff changeset
583 @code{buffer-invisibility-spec} (if it is not already present in that
4dfb36c387bf Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents: 48701
diff changeset
584 list). If @code{buffer-invisibility-spec} was @code{t}, it changes to
4dfb36c387bf Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents: 48701
diff changeset
585 a list, @code{(t)}, so that text whose @code{invisible} property
4dfb36c387bf Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents: 48701
diff changeset
586 is @code{t} remains invisible.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
587 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
588
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
589 @defun remove-from-invisibility-spec element
48948
4dfb36c387bf Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents: 48701
diff changeset
590 This removeds the element @var{element} from
4dfb36c387bf Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents: 48701
diff changeset
591 @code{buffer-invisibility-spec}. This does nothing if @var{element}
4dfb36c387bf Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents: 48701
diff changeset
592 is not in the list.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
593 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
594
48948
4dfb36c387bf Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents: 48701
diff changeset
595 A convention for use of @code{buffer-invisibility-spec} is that a
4dfb36c387bf Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents: 48701
diff changeset
596 major mode should use the mode's own name as an element of
4dfb36c387bf Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents: 48701
diff changeset
597 @code{buffer-invisibility-spec} and as the value of the
4dfb36c387bf Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents: 48701
diff changeset
598 @code{invisible} property:
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
599
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
600 @example
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
601 ;; @r{If you want to display an ellipsis:}
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
602 (add-to-invisibility-spec '(my-symbol . t))
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
603 ;; @r{If you don't want ellipsis:}
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
604 (add-to-invisibility-spec 'my-symbol)
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
605
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
606 (overlay-put (make-overlay beginning end)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
607 'invisible 'my-symbol)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
608
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
609 ;; @r{When done with the overlays:}
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
610 (remove-from-invisibility-spec '(my-symbol . t))
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
611 ;; @r{Or respectively:}
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
612 (remove-from-invisibility-spec 'my-symbol)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
613 @end example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
614
15761
77d451c08a30 Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents: 15074
diff changeset
615 @vindex line-move-ignore-invisible
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
616 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
617 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
618 explicitly ignore invisible newlines if
77d451c08a30 Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents: 15074
diff changeset
619 @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
620 they are explicitly programmed to do so.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
621
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
622 Incremental search can make invisible overlays visible temporarily
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
623 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
624 this, the overlay should have a non-@code{nil}
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
625 @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
626 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
627 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
628 overlaps the overlay on exit from the search.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
629
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
630 During the search, such overlays are made temporarily visible by
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
631 temporarily modifying their invisible and intangible properties. If you
22267
dfac7398266b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22252
diff changeset
632 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
633 @code{isearch-open-invisible-temporary} property which is a function.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
634 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
635 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
636 make it invisible again.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
637
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
638 @node Selective Display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
639 @section Selective Display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
640 @cindex selective display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
641
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
642 @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
643 hiding certain lines on the screen.
6598
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 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
646 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
647 The invisible text feature (@pxref{Invisible Text}) has partially
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
648 replaced this feature.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
649
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
650 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
651 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
652 user-level feature.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
653
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
654 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
655 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
656 was formerly a line following that newline is now invisible. Strictly
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
657 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
658 can separate lines; it is now part of the previous line.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
659
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
660 Selective display does not directly affect editing commands. For
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
661 example, @kbd{C-f} (@code{forward-char}) moves point unhesitatingly into
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
662 invisible text. However, the replacement of newline characters with
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
663 carriage return characters affects some editing commands. For example,
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
664 @code{next-line} skips invisible lines, since it searches only for
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
665 newlines. Modes that use selective display can also define commands
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
666 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
667 visible or invisible.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
668
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
669 When you write a selectively displayed buffer into a file, all the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
670 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
671 in the file, it looks OK, with nothing invisible. The selective display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
672 effect is seen only within Emacs.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
673
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
674 @defvar selective-display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
675 This buffer-local variable enables selective display. This means that
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
676 lines, or portions of lines, may be made invisible.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
677
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
678 @itemize @bullet
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
679 @item
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
680 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
681 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
682 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
683 display.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
684
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
685 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
686 If the value of @code{selective-display} is a positive integer, then
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
687 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
688 displayed.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
689 @end itemize
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
690
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
691 When some portion of a buffer is invisible, the vertical movement
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
692 commands operate as if that portion did not exist, allowing a single
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
693 @code{next-line} command to skip any number of invisible lines.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
694 However, character movement commands (such as @code{forward-char}) do
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
695 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
696 or delete text in an invisible portion.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
697
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
698 In the examples below, we show the @emph{display appearance} of the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
699 buffer @code{foo}, which changes with the value of
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
700 @code{selective-display}. The @emph{contents} of the buffer do not
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
701 change.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
702
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
703 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
704 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
705 (setq selective-display nil)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
706 @result{} nil
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
707
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
708 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
709 1 on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
710 2on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
711 3n this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
712 3n this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
713 2on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
714 1 on this column
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 (setq selective-display 2)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
720 @result{} 2
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
721
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
722 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
723 1 on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
724 2on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
725 2on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
726 1 on this column
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 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
729 @end example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
730 @end defvar
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 @defvar selective-display-ellipses
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
733 If this buffer-local variable is non-@code{nil}, then Emacs displays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
734 @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
735 This example is a continuation of the previous one.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
736
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
737 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
738 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
739 (setq selective-display-ellipses t)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
740 @result{} t
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
741
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
742 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
743 1 on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
744 2on this column ...
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
745 2on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
746 1 on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
747 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
748 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
749 @end example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
750
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
751 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
752 (@samp{@dots{}}). @xref{Display Tables}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
753 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
754
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
755 @node Overlay Arrow
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
756 @section The Overlay Arrow
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
757 @cindex overlay arrow
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
758
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
759 The @dfn{overlay arrow} is useful for directing the user's attention
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
760 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
761 interface to debuggers, the overlay arrow indicates the line of code
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
762 about to be executed.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
763
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
764 @defvar overlay-arrow-string
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
765 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
766 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
767 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
768 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
769 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
770
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
771 @defvar overlay-arrow-position
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
772 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
773 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
774 display the arrow text
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
775 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
776 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
777 usually begins with indentation, normally nothing significant is
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
778 overwritten.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
779
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
780 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
781 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
782 given time.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
783 @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
784 @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
785 @c now. Is it?
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
786 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
787
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
788 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
789 @code{before-string} property. @xref{Overlay Properties}.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
790
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
791 @node Temporary Displays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
792 @section Temporary Displays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
793
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
794 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
795 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
796 editing. Many help commands use this feature.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
797
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
798 @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
799 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
800 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
801 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
802 displayed in some window, but not selected.
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
803
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
804 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
805 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
806 @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
807 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
808 clickable cross-references.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
809
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
810 The string @var{buffer-name} specifies the temporary buffer, which
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
811 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
812 The buffer is erased initially (with no questions asked), and it is
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
813 marked as unmodified after @code{with-output-to-temp-buffer} exits.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
814
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
815 @code{with-output-to-temp-buffer} binds @code{standard-output} to the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
816 temporary buffer, then it evaluates the forms in @var{forms}. Output
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
817 using the Lisp output functions within @var{forms} goes by default to
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
818 that buffer (but screen display and messages in the echo area, although
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
819 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
820 @xref{Output Functions}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
821
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
822 Several hooks are available for customizing the behavior
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
823 of this construct; they are listed below.
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
824
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
825 The value of the last form in @var{forms} is returned.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
826
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
827 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
828 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
829 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
830 This is the contents of foo.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
831 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
832 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
833
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
834 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
835 (with-output-to-temp-buffer "foo"
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
836 (print 20)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
837 (print standard-output))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
838 @result{} #<buffer foo>
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
839
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
840 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
841 20
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
842
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
843 #<buffer foo>
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
844
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
845 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
846 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
847 @end example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
848 @end defspec
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
849
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
850 @defvar temp-buffer-show-function
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
851 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
852 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
853 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
854
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
855 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
856 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
857 @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
858 selected.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
859 @end defvar
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
860
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
861 @defvar temp-buffer-setup-hook
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
862 @tindex temp-buffer-setup-hook
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
863 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
864 evaluating @var{body}. When the hook runs, the temporary buffer is
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
865 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
866 buffer in Help mode.
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
867 @end defvar
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
868
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
869 @defvar temp-buffer-show-hook
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
870 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
871 displaying the temporary buffer. When the hook runs, the temporary buffer
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
872 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
873 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
874 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
875 is Help mode.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
876 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
877
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
878 @defun momentary-string-display string position &optional char message
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
879 This function momentarily displays @var{string} in the current buffer at
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
880 @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
881 modification status.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
882
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
883 The momentary display remains until the next input event. If the next
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
884 input event is @var{char}, @code{momentary-string-display} ignores it
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
885 and returns. Otherwise, that event remains buffered for subsequent use
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
886 as input. Thus, typing @var{char} will simply remove the string from
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
887 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
888 the display and later (presumably) move point forward. The argument
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
889 @var{char} is a space by default.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
890
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
891 The return value of @code{momentary-string-display} is not meaningful.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
892
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
893 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
894 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
895 deleting) an overlay with a @code{before-string} property.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
896 @xref{Overlay Properties}.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
897
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
898 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
899 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
900 default message says to type @var{char} to continue.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
901
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
902 In this example, point is initially located at the beginning of the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
903 second line:
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
904
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
905 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
906 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
907 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
908 This is the contents of foo.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
909 @point{}Second line.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
910 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
911 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
912
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
913 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
914 (momentary-string-display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
915 "**** Important Message! ****"
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
916 (point) ?\r
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
917 "Type RET when done reading")
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
918 @result{} t
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
919 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
920
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
921 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
922 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
923 This is the contents of foo.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
924 **** Important Message! ****Second line.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
925 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
926
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
927 ---------- Echo Area ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
928 Type RET when done reading
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
929 ---------- Echo Area ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
930 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
931 @end example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
932 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
933
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
934 @node Overlays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
935 @section Overlays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
936 @cindex overlays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
937
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
938 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
939 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
940 object that belongs to a particular buffer, and has a specified
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
941 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
942 these affect the display of the text within the overlay.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
943
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
944 @menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
945 * Overlay Properties:: How to read and set properties.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
946 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
947 * Managing Overlays:: Creating and moving overlays.
73f718a9df4b (Overlays): Add menu entry for Finding Overlays.
Dave Love <fx@gnu.org>
parents: 26696
diff changeset
948 * Finding Overlays:: Searching for overlays.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
949 @end menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
950
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
951 @node Overlay Properties
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
952 @subsection Overlay Properties
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
953
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
954 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
955 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
956 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
957 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
958 text. Thus, copying text between various buffers and strings preserves
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
959 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
960 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
961 overlay or changing its properties does not. Unlike text property
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
962 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
963 @xref{Text Properties}, for comparison.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
964
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
965 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
966 overlay:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
967
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
968 @defun overlay-get overlay prop
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
969 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
970 @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
971 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
972 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
973 is @code{nil}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
974 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
975
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
976 @defun overlay-put overlay prop value
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
977 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
978 @var{overlay} to @var{value}. It returns @var{value}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
979 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
980
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
981 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
982 overlay properties and text properties for a given character.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
983 @xref{Examining Properties}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
984
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
985 Many overlay properties have special meanings; here is a table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
986 of them:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
987
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
988 @table @code
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
989 @item priority
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
990 @kindex priority @r{(overlay property)}
52380
7a80a66265e6 (Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents: 52156
diff changeset
991 This property's value (which should be a nonnegative integer number)
7a80a66265e6 (Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents: 52156
diff changeset
992 determines the priority of the overlay. The priority matters when two
7a80a66265e6 (Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents: 52156
diff changeset
993 or more overlays cover the same character and both specify the same
7a80a66265e6 (Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents: 52156
diff changeset
994 property; the one whose @code{priority} value is larger takes priority
7a80a66265e6 (Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents: 52156
diff changeset
995 over the other. For the @code{face} property, the higher priority
7a80a66265e6 (Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents: 52156
diff changeset
996 value does not completely replace the other; instead, its face
7a80a66265e6 (Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents: 52156
diff changeset
997 attributes override the face attributes of the lower priority
7a80a66265e6 (Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents: 52156
diff changeset
998 @code{face} property.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
999
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1000 Currently, all overlays take priority over text properties. Please
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1001 avoid using negative priority values, as we have not yet decided just
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1002 what they should mean.
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 @item window
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1005 @kindex window @r{(overlay property)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1006 If the @code{window} property is non-@code{nil}, then the overlay
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1007 applies only on that window.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1008
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1009 @item category
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1010 @kindex category @r{(overlay property)}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1011 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
1012 @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
1013 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
1014
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1015 @item face
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1016 @kindex face @r{(overlay property)}
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1017 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
1018 font and which colors. @xref{Faces}, for more information.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1019
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1020 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
1021 then each element can be any of these possibilities:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1022
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1023 @itemize @bullet
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1024 @item
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1025 A face name (a symbol or string).
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1026
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1027 @item
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1028 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
1029 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
1030 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
1031 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
1032 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
1033 @xref{Face Attributes}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1034
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1035 @item
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1036 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
1037 @code{(background-color . @var{color-name})}. These elements specify
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1038 just the foreground color or just the background color.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1039
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1040 @code{(foreground-color . @var{color-name})} is equivalent to
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1041 @code{(:foreground @var{color-name})}, and likewise for the background.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1042 @end itemize
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1043
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1044 @item mouse-face
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1045 @kindex mouse-face @r{(overlay property)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1046 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
1047 the range of the overlay.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1048
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1049 @item display
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1050 @kindex display @r{(overlay property)}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1051 This property activates various features that change the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1052 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
1053 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
1054 @xref{Display Property}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1055
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1056 @item help-echo
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1057 @kindex help-echo @r{(text property)}
31373
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
1058 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
1059 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
1060 echo area, or in the tooltip window. For details see @ref{Text
45750
73b33fa2ec78 Delete "new in Emacs 21" note.
Richard M. Stallman <rms@gnu.org>
parents: 45745
diff changeset
1061 help-echo}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1062
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1063 @item modification-hooks
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1064 @kindex modification-hooks @r{(overlay property)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1065 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
1066 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
1067 within the overlay.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1068
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1069 The hook functions are called both before and after each change.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1070 If the functions save the information they receive, and compare notes
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1071 between calls, they can determine exactly what change has been made
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1072 in the buffer text.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1073
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1074 When called before a change, each function receives four arguments: the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1075 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
1076 modified.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1077
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1078 When called after a change, each function receives five arguments: the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1079 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
1080 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
1081 (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
1082 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
1083 beginning and end are equal.)
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1084
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1085 @item insert-in-front-hooks
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1086 @kindex insert-in-front-hooks @r{(overlay property)}
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1087 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
1088 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
1089 conventions are the same as for the @code{modification-hooks} functions.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1090
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1091 @item insert-behind-hooks
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1092 @kindex insert-behind-hooks @r{(overlay property)}
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1093 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
1094 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
1095 conventions are the same as for the @code{modification-hooks} functions.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1096
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1097 @item invisible
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1098 @kindex invisible @r{(overlay property)}
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1099 The @code{invisible} property can make the text in the overlay
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1100 invisible, which means that it does not appear on the screen.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1101 @xref{Invisible Text}, for details.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1102
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1103 @item intangible
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1104 @kindex intangible @r{(overlay property)}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1105 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
1106 @code{intangible} text property. @xref{Special Properties}, for details.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1107
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1108 @item isearch-open-invisible
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1109 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
1110 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
1111 Text}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1112
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1113 @item isearch-open-invisible-temporary
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1114 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
1115 visible, temporarily, during the search. @xref{Invisible Text}.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1116
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1117 @item before-string
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1118 @kindex before-string @r{(overlay property)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1119 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
1120 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
1121 sense---only on the screen.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1122
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1123 @item after-string
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1124 @kindex after-string @r{(overlay property)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1125 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
1126 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
1127 sense---only on the screen.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1128
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1129 @item evaporate
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1130 @kindex evaporate @r{(overlay property)}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1131 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
1132 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
1133
29102
ba9cfbfc601e *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29076
diff changeset
1134 @item local-map
29076
c7c150b377c0 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28792
diff changeset
1135 @cindex keymap of character (and overlays)
29102
ba9cfbfc601e *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29076
diff changeset
1136 @kindex local-map @r{(overlay property)}
29076
c7c150b377c0 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28792
diff changeset
1137 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
1138 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
1139 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
1140
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
1141 @item keymap
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
1142 @kindex keymap @r{(overlay property)}
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
1143 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
1144 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
1145 property) rather than replacing it.
29076
c7c150b377c0 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28792
diff changeset
1146 @end table
c7c150b377c0 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28792
diff changeset
1147
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1148 @node Managing Overlays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1149 @subsection Managing Overlays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1150
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1151 This section describes the functions to create, delete and move
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1152 overlays, and to examine their contents.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1153
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1154 @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
1155 This function creates and returns an overlay that belongs to
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1156 @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
1157 and @var{end} must specify buffer positions; they may be integers or
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1158 markers. If @var{buffer} is omitted, the overlay is created in the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1159 current buffer.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1160
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1161 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
1162 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
1163 overlay, respectively. @xref{Marker Insertion Types}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1164 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1165
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1166 @defun overlay-start overlay
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1167 This function returns the position at which @var{overlay} starts,
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1168 as an integer.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1169 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1170
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1171 @defun overlay-end overlay
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1172 This function returns the position at which @var{overlay} ends,
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1173 as an integer.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1174 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1175
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1176 @defun overlay-buffer overlay
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1177 This function returns the buffer that @var{overlay} belongs to.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1178 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1179
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1180 @defun delete-overlay overlay
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1181 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
1182 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
1183 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
1184 display.
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1185
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1186 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
1187 position in a buffer again by calling @code{move-overlay}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1188 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1189
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1190 @defun move-overlay overlay start end &optional buffer
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1191 This function moves @var{overlay} to @var{buffer}, and places its bounds
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1192 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
1193 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
1194
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1195 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
1196 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
1197 the current buffer.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1198
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1199 The return value is @var{overlay}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1200
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1201 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
1202 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
1203 update other vital data structures and can cause some overlays to be
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1204 ``lost''.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1205 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1206
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1207 Here are some examples:
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1208
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1209 @example
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1210 ;; @r{Create an overlay.}
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1211 (setq foo (make-overlay 1 10))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1212 @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
1213 (overlay-start foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1214 @result{} 1
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1215 (overlay-end foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1216 @result{} 10
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1217 (overlay-buffer foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1218 @result{} #<buffer display.texi>
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1219 ;; @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
1220 (overlay-put foo 'happy t)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1221 @result{} t
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1222 ;; @r{Verify the property is present.}
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1223 (overlay-get foo 'happy)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1224 @result{} t
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1225 ;; @r{Move the overlay.}
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1226 (move-overlay foo 5 20)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1227 @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
1228 (overlay-start foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1229 @result{} 5
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1230 (overlay-end foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1231 @result{} 20
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1232 ;; @r{Delete the overlay.}
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1233 (delete-overlay foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1234 @result{} nil
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1235 ;; @r{Verify it is deleted.}
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1236 foo
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1237 @result{} #<overlay in no buffer>
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1238 ;; @r{A deleted overlay has no position.}
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1239 (overlay-start foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1240 @result{} nil
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1241 (overlay-end foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1242 @result{} nil
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1243 (overlay-buffer foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1244 @result{} nil
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1245 ;; @r{Undelete the overlay.}
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1246 (move-overlay foo 1 20)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1247 @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
1248 ;; @r{Verify the results.}
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1249 (overlay-start foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1250 @result{} 1
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1251 (overlay-end foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1252 @result{} 20
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1253 (overlay-buffer foo)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1254 @result{} #<buffer display.texi>
27331
be0a552c8320 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27193
diff changeset
1255 ;; @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
1256 (overlay-get foo 'happy)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1257 @result{} t
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1258 @end example
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1259
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1260 @node Finding Overlays
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1261 @subsection Searching for Overlays
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1262
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1263 @defun overlays-at pos
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1264 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
1265 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
1266 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
1267 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
1268
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1269 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
1270 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
1271
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1272 @smallexample
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1273 (defun find-overlays-specifying (prop)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1274 (let ((overlays (overlays-at (point)))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1275 found)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1276 (while overlays
37170
29f2615d958f (Finding Overlays): Fix example code.
Gerd Moellmann <gerd@gnu.org>
parents: 36935
diff changeset
1277 (let ((overlay (car overlays)))
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1278 (if (overlay-get overlay prop)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1279 (setq found (cons overlay found))))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1280 (setq overlays (cdr overlays)))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1281 found))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1282 @end smallexample
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1283 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1284
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1285 @defun overlays-in beg end
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1286 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
1287 @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
1288 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
1289 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
1290 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
1291 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1292
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1293 @defun next-overlay-change pos
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1294 This function returns the buffer position of the next beginning or end
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1295 of an overlay, after @var{pos}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1296 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1297
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1298 @defun previous-overlay-change pos
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1299 This function returns the buffer position of the previous beginning or
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1300 end of an overlay, before @var{pos}.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1301 @end defun
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1302
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1303 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
1304 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
1305 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
1306
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1307 @smallexample
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1308 (defun find-overlay-prop (prop)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1309 (save-excursion
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1310 (while (and (not (eobp))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1311 (not (get-char-property (point) 'happy)))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1312 (goto-char (min (next-overlay-change (point))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1313 (next-single-property-change (point) 'happy))))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1314 (point)))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1315 @end smallexample
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1316
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1317 @node Width
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1318 @section Width
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1319
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1320 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
1321 check the width of a character. @xref{Primitive Indent}, and
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1322 @ref{Screen Lines}, for related functions.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1323
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1324 @defun char-width char
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1325 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
1326 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
1327 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1328
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1329 @defun string-width string
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1330 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
1331 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
1332 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1333
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1334 @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
1335 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
1336 @var{width} columns, as a new string.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1337
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1338 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
1339 @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
1340 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
1341 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
1342 go beyond it.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1343
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1344 The optional argument @var{start-column} specifies the starting column.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1345 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
1346 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
1347 @var{string} extends across the column @var{start-column}, that
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1348 character is not included.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1349
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1350 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
1351 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
1352 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
1353 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
1354 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
1355 @var{string} extends across the column @var{start-column}.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1356
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1357 @example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1358 (truncate-string-to-width "\tab\t" 12 4)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1359 @result{} "ab"
52002
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
1360 (truncate-string-to-width "\tab\t" 12 4 ?\s)
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1361 @result{} " ab "
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1362 @end example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1363 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1364
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1365 @node Faces
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1366 @section Faces
40469
aa8474236e9e Index "faces" instead of "face".
Richard M. Stallman <rms@gnu.org>
parents: 40310
diff changeset
1367 @cindex faces
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1368
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1369 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
1370 family, foreground color, background color, optional underlining, and
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1371 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
1372 particular parts of the text or the frame.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1373
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1374 @cindex face id
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1375 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
1376 low levels within Emacs. However, for most purposes, you refer to
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1377 faces in Lisp programs by their names.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1378
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1379 @defun facep object
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1380 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
1381 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
1382 returns @code{nil} otherwise.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1383 @end defun
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1384
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1385 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
1386 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
1387 face name a special meaning in one frame if you wish.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1388
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1389 @menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1390 * Standard Faces:: The faces Emacs normally comes with.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1391 * 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
1392 * Face Attributes:: What is in a face?
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1393 * Attribute Functions:: Functions to examine and set face attributes.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1394 * 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
1395 * Font Selection:: Finding the best available font for a face.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1396 * Face Functions:: How to define and examine faces.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1397 * Auto Faces:: Hook for automatic face assignment.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1398 * Font Lookup:: Looking up the names of available fonts
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1399 and information about them.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1400 * Fontsets:: A fontset is a collection of fonts
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1401 that handle a range of character sets.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1402 @end menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1403
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1404 @node Standard Faces
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1405 @subsection Standard Faces
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1406
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1407 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
1408 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
1409 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
1410
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1411 @table @code
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1412 @item default
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1413 @kindex default @r{(face name)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1414 This face is used for ordinary text.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1415
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1416 @item mode-line
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1417 @kindex mode-line @r{(face name)}
43262
af1ba8f61638 (Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents: 43099
diff changeset
1418 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
1419 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
1420 @code{mode-line-inverse-video} is non-@code{nil}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1421
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1422 @item modeline
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1423 @kindex modeline @r{(face name)}
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1424 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
1425 old Emacs versions.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1426
43262
af1ba8f61638 (Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents: 43099
diff changeset
1427 @item mode-line-inactive
af1ba8f61638 (Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents: 43099
diff changeset
1428 @kindex mode-line-inactive @r{(face name)}
af1ba8f61638 (Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents: 43099
diff changeset
1429 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
1430 This face inherits from @code{mode-line}, so changes
3198ecb4e71f Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 43262
diff changeset
1431 in that face affect all windows.
43262
af1ba8f61638 (Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents: 43099
diff changeset
1432
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1433 @item header-line
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1434 @kindex header-line @r{(face name)}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1435 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
1436
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1437 @item menu
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1438 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
1439 font. (This works only on certain systems.)
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1440
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1441 @item fringe
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1442 @kindex fringe @r{(face name)}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1443 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
1444 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
1445
43099
761d92c0f64e (Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents: 42905
diff changeset
1446 @item minibuffer-prompt
761d92c0f64e (Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents: 42905
diff changeset
1447 @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
1448 @vindex minibuffer-prompt-properties
761d92c0f64e (Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents: 42905
diff changeset
1449 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
1450 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
1451 @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
1452 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
1453
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1454 @item scroll-bar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1455 @kindex scroll-bar @r{(face name)}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1456 This face controls the colors for display of scroll bars.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1457
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1458 @item tool-bar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1459 @kindex tool-bar @r{(face name)}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1460 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
1461
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1462 @item region
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1463 @kindex region @r{(face name)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1464 This face is used for highlighting the region in Transient Mark mode.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1465
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1466 @item secondary-selection
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1467 @kindex secondary-selection @r{(face name)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1468 This face is used to show any secondary selection you have made.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1469
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1470 @item highlight
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1471 @kindex highlight @r{(face name)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1472 This face is meant to be used for highlighting for various purposes.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1473
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1474 @item trailing-whitespace
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1475 @kindex trailing-whitespace @r{(face name)}
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1476 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
1477 if @code{show-trailing-whitespace} is non-@code{nil}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1478 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1479
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1480 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
1481 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
1482 the effects they produce.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1483
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1484 @table @code
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1485 @item bold
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1486 @kindex bold @r{(face name)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1487 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
1488 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
1489 font that has a bold variant, if you want to use one.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1490
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1491 @item italic
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1492 @kindex italic @r{(face name)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1493 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
1494
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1495 @item bold-italic
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1496 @kindex bold-italic @r{(face name)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1497 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
1498 one.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1499
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1500 @item underline
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1501 @kindex underline @r{(face name)}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1502 This face underlines text.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1503
38278
9e543d761717 Fix several typos.
Gerd Moellmann <gerd@gnu.org>
parents: 37949
diff changeset
1504 @item fixed-pitch
9e543d761717 Fix several typos.
Gerd Moellmann <gerd@gnu.org>
parents: 37949
diff changeset
1505 @kindex fixed-pitch @r{(face name)}
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1506 This face forces use of a particular fixed-width font.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1507
38278
9e543d761717 Fix several typos.
Gerd Moellmann <gerd@gnu.org>
parents: 37949
diff changeset
1508 @item variable-pitch
9e543d761717 Fix several typos.
Gerd Moellmann <gerd@gnu.org>
parents: 37949
diff changeset
1509 @kindex variable-pitch @r{(face name)}
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1510 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
1511 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
1512 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
1513 @end table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1514
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1515 @defvar show-trailing-whitespace
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1516 @tindex show-trailing-whitespace
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1517 If this variable is non-@code{nil}, Emacs uses the
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1518 @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
1519 end of a line.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1520 @end defvar
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1521
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1522 @node Defining Faces
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1523 @subsection Defining Faces
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1524
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1525 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
1526 kind of customization item (@pxref{Customization}) which the user can
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1527 customize using the Customization buffer (@pxref{Easy Customization,,,
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1528 emacs, The GNU Emacs Manual}).
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1529
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
1530 @defmac defface face spec doc [keyword value]...
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1531 This declares @var{face} as a customizable face that defaults according
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1532 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
1533 argument @var{doc} specifies the face documentation. The keywords you
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1534 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
1535 @code{defgroup} and @code{defcustom} (@pxref{Common Keywords}).
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1536
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1537 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
1538 @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
1539 init file (@pxref{Init File}) to override that specification.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1540
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1541 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
1542 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
1543 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
1544 @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
1545 @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
1546 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
1547 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
1548
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1549 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
1550 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
1551 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
1552 for that frame. There are two possibilities for @var{display}:
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1553
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1554 @table @asis
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1555 @item @code{t}
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1556 This element of @var{spec} matches all frames. Therefore, any
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1557 subsequent elements of @var{spec} are never used. Normally
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1558 @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
1559
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1560 @item a list
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1561 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
1562 @code{(@var{characteristic} @var{value}@dots{})}. Here
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1563 @var{characteristic} specifies a way of classifying frames, and the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1564 @var{value}s are possible classifications which @var{display} should
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1565 apply to. Here are the possible values of @var{characteristic}:
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1566
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1567 @table @code
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1568 @item type
32802
66f219c7e8ca (Defining Faces): Document `graphic' display type in face specs.
Miles Bader <miles@gnu.org>
parents: 32552
diff changeset
1569 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
1570 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
1571 @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
1572 display).
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1573
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1574 @item class
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1575 What kinds of colors the frame supports---either @code{color},
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1576 @code{grayscale}, or @code{mono}.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1577
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1578 @item background
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1579 The kind of background---either @code{light} or @code{dark}.
45745
394a19fc134e defface `supports' predicate
Miles Bader <miles@gnu.org>
parents: 44281
diff changeset
1580
394a19fc134e defface `supports' predicate
Miles Bader <miles@gnu.org>
parents: 44281
diff changeset
1581 @item supports
46170
115fa2a7cd26 Tweak text a bit.
Miles Bader <miles@gnu.org>
parents: 45750
diff changeset
1582 Whether or not the frame can display the face attributes given in
115fa2a7cd26 Tweak text a bit.
Miles Bader <miles@gnu.org>
parents: 45750
diff changeset
1583 @var{value}@dots{} (@pxref{Face Attributes}). See the documentation
115fa2a7cd26 Tweak text a bit.
Miles Bader <miles@gnu.org>
parents: 45750
diff changeset
1584 for the function @code{display-supports-face-attributes-p} for more
115fa2a7cd26 Tweak text a bit.
Miles Bader <miles@gnu.org>
parents: 45750
diff changeset
1585 information on exactly how this testing is done. @xref{Display Face
115fa2a7cd26 Tweak text a bit.
Miles Bader <miles@gnu.org>
parents: 45750
diff changeset
1586 Attribute Testing}.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1587 @end table
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1588
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1589 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
1590 given @var{characteristic}, any of those values is acceptable. If
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1591 @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
1592 different @var{characteristic}; then @emph{each} characteristic of the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1593 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
1594 @var{display}.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1595 @end table
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1596 @end defmac
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1597
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1598 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
1599
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1600 @example
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1601 @group
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1602 (defface region
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1603 `((((type tty) (class color))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1604 (:background "blue" :foreground "white"))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1605 @end group
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1606 (((type tty) (class mono))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1607 (:inverse-video t))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1608 (((class color) (background dark))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1609 (:background "blue"))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1610 (((class color) (background light))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1611 (:background "lightblue"))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1612 (t (:background "gray")))
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1613 @group
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1614 "Basic face for highlighting the region."
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1615 :group 'basic-faces)
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1616 @end group
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1617 @end example
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1618
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1619 Internally, @code{defface} uses the symbol property
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1620 @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
1621 @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
1622 with the customization buffer, and @code{face-documentation} for the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1623 documentation string.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1624
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1625 @defopt frame-background-mode
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1626 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
1627 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
1628 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
1629 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
1630 as if they had a light background.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1631 @end defopt
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1632
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1633 @node Face Attributes
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1634 @subsection Face Attributes
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1635 @cindex face attributes
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 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
1638 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
1639 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
1640 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
1641 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
1642
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1643 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
1644 @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
1645 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
1646 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
1647 @code{default} face must specify all attributes.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1648
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1649 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
1650 displays---if your display cannot handle a certain attribute, the
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1651 attribute is ignored. (The attributes @code{:family}, @code{:width},
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1652 @code{:height}, @code{:weight}, and @code{:slant} correspond to parts of
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1653 an X Logical Font Descriptor.)
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 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1656 @item :family
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1657 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
1658 font family name, the wild-card characters @samp{*} and @samp{?} are
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1659 allowed.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1660
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1661 @item :width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1662 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
1663 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
1664 @code{extra-condensed}, @code{condensed}, @code{semi-condensed},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1665 @code{normal}, @code{semi-expanded}, @code{expanded},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1666 @code{extra-expanded}, or @code{ultra-expanded}.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
1667
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1668 @item :height
32089
15b8a53f1d7a (Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents: 31373
diff changeset
1669 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
1670 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
1671 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
1672 (from the underlying face), and should return the new height.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
1673
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1674 @item :weight
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1675 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
1676 @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
1677 @code{normal}, @code{semi-light}, @code{light}, @code{extra-light},
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1678 or @code{ultra-light}.
25809
89230444d638 patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
1679
89230444d638 patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
1680 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
1681 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
1682 half-bright (provided the terminal supports the feature).
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1683
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1684 @item :slant
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1685 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
1686 @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
1687
89230444d638 patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
1688 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
1689 the terminal supports the feature.
89230444d638 patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
1690
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1691 @item :foreground
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1692 Foreground color, a string.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
1693
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1694 @item :background
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1695 Background color, a string.
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 @item :inverse-video
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1698 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
1699 value should be @code{t} (yes) or @code{nil} (no).
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1700
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1701 @item :stipple
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1702 The background stipple, a bitmap.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1703
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1704 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
1705 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
1706 listed in the variable @code{x-bitmap-file-path}.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1707
40310
34f1a01f25fa *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 39404
diff changeset
1708 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
1709 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
1710 @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
1711 @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
1712 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
1713 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
1714 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
1715
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1716 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
1717
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1718 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
1719 used automatically to handle certain shades of gray.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1720
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1721 @item :underline
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1722 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
1723 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
1724 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
1725 value @code{nil} means do not underline.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1726
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1727 @item :overline
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1728 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
1729 The value is used like that of @code{:underline}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1730
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1731 @item :strike-through
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1732 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
1733 color. The value is used like that of @code{:underline}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1734
32089
15b8a53f1d7a (Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents: 31373
diff changeset
1735 @item :inherit
15b8a53f1d7a (Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents: 31373
diff changeset
1736 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
1737 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
1738 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
1739
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1740 @item :box
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1741 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
1742 width of the box lines, and 3D appearance.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1743 @end table
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 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
1746 they mean:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1747
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1748 @table @asis
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1749 @item @code{nil}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1750 Don't draw a box.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1752 @item @code{t}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1753 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
1754
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1755 @item @var{color}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1756 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
1757
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1758 @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
1759 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
1760 @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
1761
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1762 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
1763 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
1764 color of the face for 3D boxes.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1765
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1766 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
1767 @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
1768 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
1769 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
1770 is used.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1771 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1772
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1773 The attributes @code{:overline}, @code{:strike-through} and
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1774 @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
1775 @code{:height}, @code{:width}, @code{:weight}, @code{:slant} are also
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1776 new; previous versions used the following attributes, now semi-obsolete,
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1777 to specify some of the same information:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1778
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1779 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1780 @item :font
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1781 This attribute specifies the font name.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1782
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1783 @item :bold
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1784 A non-@code{nil} value specifies a bold font.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1785
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1786 @item :italic
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1787 A non-@code{nil} value specifies an italic font.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1788 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1789
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1790 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
1791 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
1792
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1793 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1794 @item :font
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1795 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
1796 that sets the @code{:family}, @code{:width}, @code{:height},
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1797 @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
1798
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1799 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
1800 the pattern is used to set these attributes.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1801
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1802 @item :bold
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1803 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
1804 This actually works by setting the @code{:weight} attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1805
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1806 @item :italic
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1807 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
1808 This actually works by setting the @code{:slant} attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1809 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1810
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1811 @defvar x-bitmap-file-path
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1812 This variable specifies a list of directories for searching
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1813 for bitmap files, for the @code{:stipple} attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1814 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1815
25911
b192e4e3a9f5 Rename pixmap-spec-p to bitmap-spec-p.
Gerd Moellmann <gerd@gnu.org>
parents: 25875
diff changeset
1816 @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
1817 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
1818 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
1819 @code{nil} otherwise.
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1820 @end defun
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1821
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1822 @node Attribute Functions
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1823 @subsection Face Attribute Functions
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1824
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1825 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
1826 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
1827 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
1828 new frames.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1829
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1830 @tindex set-face-attribute
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1831 @defun set-face-attribute face frame &rest arguments
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1832 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
1833 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
1834 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
1835
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1836 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
1837 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
1838 (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
1839 Thus,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1840
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1841 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1842 (set-face-attribute 'foo nil
46721
12862351ee03 Fix set-face-attribute example.
Richard M. Stallman <rms@gnu.org>
parents: 46338
diff changeset
1843 :width 'extended
12862351ee03 Fix set-face-attribute example.
Richard M. Stallman <rms@gnu.org>
parents: 46338
diff changeset
1844 :weight 'bold
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1845 :underline "red")
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1846 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1847
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1848 @noindent
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1849 sets the attributes @code{:width}, @code{:weight} and @code{:underline}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1850 to the corresponding values.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1851 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1852
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1853 @tindex face-attribute
46240
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1854 @defun face-attribute face attribute &optional frame inherit
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1855 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
1856 @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
1857 that means the selected frame (@pxref{Input Focus}).
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1858
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1859 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
1860 @var{face} for new frames.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1861
51652
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
1862 If @var{inherit} is @code{nil}, only attributes directly defined by
46240
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1863 @var{face} are considered, so the return value may be
51652
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
1864 @code{unspecified}, or a relative value. If @var{inherit} is
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
1865 non-@code{nil}, @var{face}'s definition of @var{attribute} is merged
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
1866 with the faces specified by its @code{:inherit} attribute; however the
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
1867 return value may still be @code{unspecified} or relative. If
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
1868 @var{inherit} is a face or a list of faces, then the result is further
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
1869 merged with that face (or faces), until it becomes specified and
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
1870 absolute.
46240
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1871
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1872 To ensure that the return value is always specified and absolute, use
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1873 a value of @code{default} for @var{inherit}; this will resolve any
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1874 unspecified or relative values by merging with the @code{default} face
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1875 (which is always completely specified).
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1876
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1877 For example,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1878
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1879 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1880 (face-attribute 'bold :weight)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1881 @result{} bold
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1882 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1883 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1884
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1885 The functions above did not exist before Emacs 21. For compatibility
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1886 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
1887 and examine the face attributes which existed in those versions.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1888
46240
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1889 @tindex face-attribute-relative-p
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1890 @defun face-attribute-relative-p attribute value
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1891 This function returns non-@code{nil} if @var{value}, when used as a
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1892 the value of the face attribute @var{attribute}, is relative (that is,
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1893 if it modifies an underlying or inherited value of @var{attribute}).
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1894 @end defun
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1895
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1896 @tindex merge-face-attribute
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1897 @defun merge-face-attribute attribute value1 value2
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1898 If @var{value1} is a relative value for the face attribute
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1899 @var{attribute}, returns it merged with the underlying value
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1900 @var{value2}; otherwise, if @var{value1} is an absolute value for the
51000
72af65197e01 Fix typos. Patch from Jesper Harder <harder@ifa.au.dk>.
Juanma Barranquero <lekktu@gmail.com>
parents: 49600
diff changeset
1901 face attribute @var{attribute}, returns @var{value1} unchanged.
46240
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1902 @end defun
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
1903
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1904 @defun set-face-foreground face color &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1905 @defunx set-face-background face color &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1906 These functions set the foreground (or background, respectively) color
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1907 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
1908 string, the name of a color.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1909
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1910 Certain shades of gray are implemented by stipple patterns on
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1911 black-and-white screens.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1912 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1913
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1914 @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
1915 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
1916 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
1917 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
1918 (@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
1919
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1920 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
1921 they are used automatically to handle certain shades of gray.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1922 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1923
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1924 @defun set-face-font face font &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1925 This function sets the font of face @var{face}.
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 In Emacs 21, this actually sets the attributes @code{:family},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1928 @code{:width}, @code{:height}, @code{:weight}, and @code{:slant}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1929 according to the font name @var{font}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1930
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1931 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
1932 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
1933 because the precise font that you specified is used.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1934 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1935
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1936 @defun set-face-bold-p face bold-p &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1937 This function specifies whether @var{face} should be bold. If
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1938 @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
1939
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1940 In Emacs 21, this sets the @code{:weight} attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1941 In Emacs 20, it sets the @code{:bold} attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1942 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1943
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1944 @defun set-face-italic-p face italic-p &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1945 This function specifies whether @var{face} should be italic. If
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1946 @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
1947
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1948 In Emacs 21, this sets the @code{:slant} attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1949 In Emacs 20, it sets the @code{:italic} attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1950 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1951
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1952 @defun set-face-underline-p face underline-p &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1953 This function sets the underline attribute of face @var{face}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1954 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
1955 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1956
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1957 @defun invert-face face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1958 This function inverts the @code{:inverse-video} attribute of face
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1959 @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
1960 @code{t}, and vice versa.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1961 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1962
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1963 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
1964 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
1965 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
1966 value for that attribute.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1967
46245
fb42c0446cbf Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents: 46240
diff changeset
1968 @defun face-foreground face &optional frame inherit
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1969 @defunx face-background face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1970 These functions return the foreground color (or background color,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1971 respectively) of face @var{face}, as a string.
46245
fb42c0446cbf Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents: 46240
diff changeset
1972
fb42c0446cbf Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents: 46240
diff changeset
1973 If @var{inherit} is nil, only a color directly defined by the face is
fb42c0446cbf Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents: 46240
diff changeset
1974 returned. If @var{inherit} is non-nil, any faces specified by its
fb42c0446cbf Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents: 46240
diff changeset
1975 @code{:inherit} attribute are considered as well, and if @var{inherit}
fb42c0446cbf Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents: 46240
diff changeset
1976 is a face or a list of faces, then they are also considered, until a
fb42c0446cbf Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents: 46240
diff changeset
1977 specified color is found. To ensure that the return value is always
fb42c0446cbf Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents: 46240
diff changeset
1978 specified, use a value of @code{default} for @var{inherit}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1979 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1980
46245
fb42c0446cbf Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents: 46240
diff changeset
1981 @defun face-stipple face &optional frame inherit
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1982 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
1983 @var{face}, or @code{nil} if it doesn't have one.
46245
fb42c0446cbf Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents: 46240
diff changeset
1984
51652
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
1985 If @var{inherit} is @code{nil}, only a stipple directly defined by the
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
1986 face is returned. If @var{inherit} is non-@code{nil}, any faces
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
1987 specified by its @code{:inherit} attribute are considered as well, and
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
1988 if @var{inherit} is a face or a list of faces, then they are also
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
1989 considered, until a specified stipple is found. To ensure that the
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
1990 return value is always specified, use a value of @code{default} for
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
1991 @var{inherit}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1992 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1993
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1994 @defun face-font face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1995 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
1996 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1997
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1998 @defun face-bold-p face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1999 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
2000 bolder than normal. It returns @code{nil} otherwise.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2001 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2002
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2003 @defun face-italic-p face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2004 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
2005 @code{nil} otherwise.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2006 @end defun
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 @defun face-underline-p face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2009 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
2010 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2011
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2012 @defun face-inverse-video-p face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2013 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
2014 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2015
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2016 @node Merging Faces
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2017 @subsection Merging Faces for Display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2018
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2019 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
2020
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2021 @itemize @bullet
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2022 @item
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2023 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
2024 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
2025 face is used only when no other face is specified.)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2026
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2027 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
2028 @code{header-line} is used just before @code{default}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2029
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2030 @item
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2031 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
2032 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
2033 Properties}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2034
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2035 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
2036 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
2037 character.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2038
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2039 @item
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2040 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
2041 properties too; they apply to all the text covered by the overlay.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2042
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2043 @item
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
2044 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
2045 highlighted with the face @code{region} (@pxref{Standard Faces}).
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
2046
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
2047 @item
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
2048 With special glyphs. Each glyph can specify a particular face
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2049 number. @xref{Glyphs}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2050 @end itemize
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2051
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2052 If these various sources together specify more than one face for a
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2053 particular character, Emacs merges the attributes of the various faces
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2054 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
2055 then comes the face for region highlighting, if appropriate;
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2056 then come attributes of faces from overlays, followed by those from text
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2057 properties, and last the default face.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2058
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2059 When multiple overlays cover one character, an overlay with higher
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2060 priority overrides those with lower priority. @xref{Overlays}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2061
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2062 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
2063 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
2064 used. In newer Emacs versions, this cannot happen, because the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2065 @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
2066 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
2067
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2068 @node Font Selection
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2069 @subsection Font Selection
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2070
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2071 @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
2072 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
2073 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
2074 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
2075 it is.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2076
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2077 For multibyte characters, typically each font covers only one
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2078 character set. So each character set (@pxref{Character Sets}) specifies
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2079 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
2080 @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
2081 the registry and the encoding, with a dash between them:
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 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2084 (plist-get (charset-plist 'latin-iso8859-1)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2085 'x-charset-registry)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2086 @result{} "ISO8859-1"
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2087 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2088
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2089 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
2090 character takes the registry and encoding from the variable
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2091 @code{face-default-registry}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2092
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2093 @defvar face-default-registry
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2094 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
2095 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
2096 time from the font the user specified for Emacs.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2097 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2098
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2099 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
2100 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
2101 family, a font pattern is constructed.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2102
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2103 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
2104 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
2105 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
2106 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
2107 ``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
2108 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
2109 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
2110 try.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2111
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2112 @defvar face-font-selection-order
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2113 @tindex face-font-selection-order
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2114 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
2115 @code{:width}, @code{:height}, @code{:weight}, and @code{:slant}. The
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2116 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
2117 decreasing importance.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2118
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2119 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
2120 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
2121 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
2122
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2123 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
2124 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
2125 (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
2126 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
2127 non-normal faces contrast with normal ones, whenever possible.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2128
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2129 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
2130 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
2131 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
2132 and so on.
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 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
2135 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
2136 @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
2137 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
2138 @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
2139 quite right.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2140 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2141
33373
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2142 @defvar face-font-family-alternatives
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2143 @tindex face-font-family-alternatives
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2144 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
2145 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
2146 this form:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2147
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2148 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2149 (@var{family} @var{alternate-families}@dots{})
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2150 @end example
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 @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
2153 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
2154 family that does exist.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2155 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2156
33373
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2157 @defvar face-font-registry-alternatives
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2158 @tindex face-font-registry-alternatives
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2159 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
2160 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
2161 this form:
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2162
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2163 @example
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2164 (@var{registry} @var{alternate-registries}@dots{})
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2165 @end example
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2166
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2167 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
2168 other registries given in @var{alternate-registries}, one by one,
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2169 until it finds a registry that does exist.
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2170 @end defvar
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2171
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2172 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
2173 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
2174 XFree86 servers.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2175
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2176 @defvar scalable-fonts-allowed
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2177 @tindex scalable-fonts-allowed
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2178 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
2179 @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
2180 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
2181
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2182 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
2183 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
2184 expression in the list. For 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 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2187 (setq scalable-fonts-allowed '("muleindian-2$"))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2188 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2189
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2190 @noindent
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2191 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
2192 @end defvar
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2193
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2194 @defun clear-face-cache &optional unload-p
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2195 @tindex clear-face-cache
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2196 This function clears the face cache for all frames.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2197 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
2198 all unused fonts as well.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2199 @end defun
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2200
52002
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2201 @defvar face-font-rescale-alist
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2202 This variable specifies scaling for certain faces. Its value should
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2203 be a list of elements of the form
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2204
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2205 @example
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2206 (@var{fontname-regexp} . @var{scale-factor})
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2207 @end example
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2208
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2209 If @var{fontname-regexp} matches the font name that is about to be
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2210 used, this says to choose a larger similar font according to the
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2211 factor @var{scale-factor}. You would use this feature to normalize
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2212 the font size if certain fonts are bigger or smaller than their
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2213 nominal heights and widths would suggest.
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2214 @end defvar
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2215
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2216 @node Face Functions
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2217 @subsection Functions for Working with Faces
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2218
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2219 Here are additional functions for creating and working with faces.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2220
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2221 @defun make-face name
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2222 This function defines a new face named @var{name}, initially with all
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2223 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
2224 @var{name}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2225 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2226
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2227 @defun face-list
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2228 This function returns a list of all defined face names.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2229 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2230
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2231 @defun copy-face old-face new-name &optional frame new-frame
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2232 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
2233 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
2234 doesn't already exist.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2235
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2236 If the optional argument @var{frame} is given, this function applies
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2237 only to that frame. Otherwise it applies to each frame individually,
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2238 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
2239 in the same frame.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2240
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2241 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
2242 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
2243 in @var{new-frame}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2244 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2245
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
2246 @defun face-id face
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
2247 This function returns the face number of face @var{face}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2248 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2249
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
2250 @defun face-documentation face
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
2251 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
2252 @code{nil} if none was specified for it.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
2253 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
2254
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2255 @defun face-equal face1 face2 &optional frame
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2256 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
2257 same attributes for display.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2258 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2259
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2260 @defun face-differs-from-default-p face &optional frame
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2261 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
2262 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
2263 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
2264 face, or unspecified (meaning to inherit from the default).
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
2265 @end defun
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
2266
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2267 @node Auto Faces
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2268 @subsection Automatic Face Assignment
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2269 @cindex automatic face assignment
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2270 @cindex faces, automatic choice
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2271
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2272 @cindex Font-Lock mode
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2273 Starting with Emacs 21, a hook is available for automatically
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2274 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
2275 the implementation of Font-Lock mode.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2276
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2277 @tindex fontification-functions
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2278 @defvar fontification-functions
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2279 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
2280 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
2281
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2282 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
2283 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
2284 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
2285
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2286 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
2287 @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
2288 @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
2289 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
2290 already.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2291
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2292 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
2293 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
2294 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
2295 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
2296 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
2297
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2298 For efficiency, we recommend writing these functions so that they
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2299 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
2300 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2301
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2302 @node Font Lookup
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2303 @subsection Looking Up Fonts
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2304
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2305 @defun x-list-fonts pattern &optional face frame maximum
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2306 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
2307 @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
2308 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
2309 @var{face} currently is on @var{frame}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2310
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2311 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
2312 characters: the @samp{*} character matches any substring, and the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2313 @samp{?} character matches any single character. Pattern matching
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2314 of font names ignores case.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2315
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2316 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
2317 (a symbol) and @var{frame} should be a frame.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2318
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2319 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
2320 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
2321 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
2322 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
2323 many fonts match the pattern.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2324 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2325
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2326 These additional functions are available starting in Emacs 21.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2327
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2328 @defun x-family-fonts &optional family frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2329 @tindex x-family-fonts
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2330 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
2331 @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
2332 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
2333 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
2334 contain the wildcards @samp{?} and @samp{*}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2335
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2336 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
2337 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
2338 (@pxref{Input Focus}).
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2339
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2340 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
2341
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2342 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2343 [@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
2344 @var{fixed-p} @var{full} @var{registry-and-encoding}]
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2345 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2346
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2347 The first five elements correspond to face attributes; if you
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2348 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
2349
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2350 The last three elements give additional information about the font.
51652
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
2351 @var{fixed-p} is non-@code{nil} if the font is fixed-pitch.
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
2352 @var{full} is the full name of the font, and
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
2353 @var{registry-and-encoding} is a string giving the registry and
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
2354 encoding of the font.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2355
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2356 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
2357 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2358
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2359 @defun x-font-family-list &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2360 @tindex x-font-family-list
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2361 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
2362 @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
2363 describes the selected frame's display (@pxref{Input Focus}).
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2364
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2365 The value is a list of elements of this form:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2366
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2367 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2368 (@var{family} . @var{fixed-p})
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2369 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2370
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2371 @noindent
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2372 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
2373 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
2374 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2375
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2376 @defvar font-list-limit
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2377 @tindex font-list-limit
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2378 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
2379 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
2380 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
2381 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
2382 currently 100.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2383 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2384
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2385 @node Fontsets
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2386 @subsection Fontsets
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2387
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2388 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
2389 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
2390 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
2391 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
2392 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
2393 information about defining a fontset under Lisp program control.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2394
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2395 @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
2396 This function defines a new fontset according to the specification
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2397 string @var{fontset-spec}. The string should have this format:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2398
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2399 @smallexample
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2400 @var{fontpattern}, @r{[}@var{charsetname}:@var{fontname}@r{]@dots{}}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2401 @end smallexample
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2402
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2403 @noindent
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2404 Whitespace characters before and after the commas are ignored.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2405
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2406 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
2407 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
2408 @samp{fontset-@var{alias}}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2409
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2410 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
2411 @var{fontpattern} in its entirety. The short name is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2412 @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
2413 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
2414 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
2415 function does nothing.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2416
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2417 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
2418 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
2419 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
2420 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
2421 status.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2422
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2423 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
2424 See below for the details.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2425 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2426
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2427 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
2428 use (in this fontset) for one particular character set. Here,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2429 @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
2430 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
2431 times in the specification string.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2432
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2433 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
2434 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
2435 @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
2436 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
2437 with @samp{ISO8859-1}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2438
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2439 In addition, when several consecutive fields are wildcards, Emacs
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2440 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
2441 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
2442 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
2443 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
2444
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2445 Thus if @var{fontpattern} is this,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2446
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2447 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2448 -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2449 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2450
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2451 @noindent
27374
0f5edee5242b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27332
diff changeset
2452 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
2453
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2454 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2455 -*-fixed-medium-r-normal-*-24-*-ISO8859-1
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2456 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2457
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2458 @noindent
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2459 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
2460
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2461 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2462 -*-fixed-medium-r-normal-*-24-*-gb2312*-*
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2463 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2464
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2465 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
2466 specification. Most X distributions include only Chinese fonts that
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2467 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
2468 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
2469
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2470 @smallexample
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2471 Emacs.Fontset-0: -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24,\
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2472 chinese-gb2312:-*-*-medium-r-normal-*-24-*-gb2312*-*
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2473 @end smallexample
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2474
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2475 @noindent
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2476 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
2477 @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
2478 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
2479 field.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2480
52483
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2481 @defun char-displayable-p char
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2482 This function returns @code{t} if Emacs ought to be able to display
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2483 @var{char}. More precisely, if the selected frame's fontset has a
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2484 font to display the character set that @var{char} belongs to.
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2485
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2486 Fontsets can specify a font on a per-character basis; when the fontset
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2487 does that, this function's value may not be accurate.
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2488 @end defun
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2489
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2490 @node Fringes
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2491 @section Fringes
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2492 @cindex Fringes
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2493
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2494 The @dfn{fringes} of a window are thin vertical strips down the
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2495 sides that are used for displaying bitmaps that indicate truncation,
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2496 continuation, and horizontal scrolling, the overlay arrow. The
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2497 fringes normally appear between the display margins and the window
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2498 text, but you can put them outside the display margins for a specific
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2499 buffer by setting @code{fringes-outside-margins} buffer-locally to a
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2500 non-@code{nil} value.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2501
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2502 @defvar fringes-outside-margins
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2503 If the value is non-@code{nil}, the frames appear outside
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2504 the display margins.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2505 @end defvar
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2506
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2507 @defvar left-fringe-width
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2508 This variable, if non-@code{nil}, specifies the width of the left
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2509 fringe in pixels.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2510 @end defvar
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2511
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2512 @defvar right-fringe-width
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2513 This variable, if non-@code{nil}, specifies the width of the right
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2514 fringe in pixels.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2515 @end defvar
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2516
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2517 The values of these variables take effect when you display the
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2518 buffer in a window. If you change them while the buffer is visible,
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2519 you can call @code{set-buffer-window} to display it in a window again.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2520
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2521 @defun set-window-fringes window left &optional right outside-margins
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2522 This function sets the fringe widthes of window @var{window}.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2523 If window is @code{nil}, that stands for the selected window.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2524
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2525 The argument @var{left} specifies the width in pixels of the left
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2526 fringe, and likewise @var{right} for the right fringe. A value of
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2527 @code{nil} for either one stands for the default width. If
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2528 @var{outside-margins} is non-@code{nil}, that specifies that fringes
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2529 should appear outside of the display margins.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2530 @end defun
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2531
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2532 @defun window-fringes window
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2533 This function returns information about the fringes of a window
52156
198af82c7606 (Warning Basics): Fix typo.
John Paul Wallington <jpw@pobox.com>
parents: 52141
diff changeset
2534 @var{window}. The value has the form @code{(@var{left-width}
198af82c7606 (Warning Basics): Fix typo.
John Paul Wallington <jpw@pobox.com>
parents: 52141
diff changeset
2535 @var{right-width} @var{frames-outside-margins})}.
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2536 @end defun
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2537
52483
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2538 @node Scroll Bars
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2539 @section Scroll Bars
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2540
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2541 Normally the frame parameter @code{vertical-scroll-bars} controls
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2542 whether the windows in the frame have vertical scroll bars. A
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2543 non-@code{nil} parameter value means they do. The frame parameter
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2544 @code{scroll-bar-width} specifies how wide they are (@code{nil}
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2545 meaning the default). @xref{Window Frame Parameters}.
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2546
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2547 You can also control this for individual windows. Call the function
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2548 @code{set-window-scroll-bars} to specify what to do for a specific window:
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2549
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2550 @defun set-window-scroll-bars window width &optional vertical-type horizontal-type
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2551 Set width and type of scroll bars of window @var{window}. (If
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2552 @var{window} is @code{nil}, this applies to the selected window.)
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2553 @var{width} specifies the scroll bar width in pixels (@code{nil} means
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2554 use whatever is specified for width for the frame).
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2555 @var{vertical-type} specifies whether to have a vertical scroll bar
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2556 and, if so, where. The possible values are @code{left}, @code{right}
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2557 and @code{nil}, just like the values of the
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2558 @code{vertical-scroll-bars} frame parameter.
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2559
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2560 The argument @var{horizontal-type} is meant to specify whether and
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2561 where to have horizontal scroll bars, but since they are not
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2562 implemented, it has no effect.
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2563 @end defun
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2564
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2565 @defun window-scroll-bars &optional window
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2566 Report the width and type of scroll bars specified for @var{window}.
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2567 If @var{window} is omitted or @code{nil}, it defaults to the currently
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2568 selected window. The value is a list of the form @code{(@var{width}
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2569 @var{cols} @var{vertical-type} @var{horizontal-type})}. The value
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2570 @var{width} is the value that was specified for the width (which may
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2571 be @code{nil}); @var{cols} is the number of columns that the scroll
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2572 bar actually occupies.
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2573
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2574 @var{horizontal-type} is not actually meaningful.
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2575 @end defun
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2576
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2577 If you don't specify these values for a window with
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2578 @code{set-window-scroll-bars}, the buffer-local variables
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2579 @code{scroll-bar-mode} and @code{scroll-bar-width} in the buffer being
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2580 displayed control the window's vertical scroll bars. The function
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2581 @code{set-window-buffer} examines these variables. If you change them
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2582 in a buffer that is already visible in a window, you can make the
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2583 window take note of the new values by calling @code{set-window-buffer}
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2584 specifying the same buffer that is already displayed.
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2585
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2586 @node Display Property
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2587 @section The @code{display} Property
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2588 @cindex display specification
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2589 @kindex display @r{(text property)}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2590
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2591 The @code{display} text property (or overlay property) is used to
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2592 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
2593 displays. These features are available starting in Emacs 21. The value
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2594 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
2595 list or vector containing several display specifications. The rest of
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2596 this section describes several kinds of display specifications and what
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2597 they mean.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2598
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2599 @menu
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2600 * Specified Space:: Displaying one space with a specified width.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2601 * Other Display Specs:: Displaying an image; magnifying text; moving it
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
2602 up or down on the page; adjusting the width
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2603 of spaces within text.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2604 * 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
2605 * Conditional Display:: Making any of the above features conditional
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2606 depending on some Lisp expression.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2607 @end menu
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2608
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2609 @node Specified Space
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2610 @subsection Specified Spaces
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2611 @cindex spaces, specified height or width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2612 @cindex specified spaces
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2613 @cindex variable-width spaces
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2614
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2615 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
2616 specification of the form @code{(space . @var{props})}, where
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2617 @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
2618 values). You can put this property on one or more consecutive
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2619 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
2620 place of @emph{all} of those characters. These are the properties you
44281
dfabb11c1e1a Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 43290
diff changeset
2621 can use in @var{props} to specify the weight of the space:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2622
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2623 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2624 @item :width @var{width}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2625 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
2626 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
2627 number.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2628
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2629 @item :relative-width @var{factor}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2630 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
2631 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
2632 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
2633 character, multiplied by @var{factor}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2634
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2635 @item :align-to @var{hpos}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2636 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
2637 value @var{hpos} is measured in units of the normal character width. It
48701
bfdd0deae843 Fix typo.
Pavel Janík <Pavel@Janik.cz>
parents: 47482
diff changeset
2638 may be an integer or a floating point number.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2639 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2640
44281
dfabb11c1e1a Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 43290
diff changeset
2641 You should use one and only one of the above properties. You can
dfabb11c1e1a Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 43290
diff changeset
2642 also specify the height of the space, with other properties:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2643
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2644 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2645 @item :height @var{height}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2646 Specifies the height of the space, as @var{height},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2647 measured in terms of the normal line height.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2648
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2649 @item :relative-height @var{factor}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2650 Specifies the height of the space, multiplying the ordinary height
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2651 of the text having this display specification by @var{factor}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2652
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2653 @item :ascent @var{ascent}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2654 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
2655 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
2656 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
2657 greater than 100.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2658 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2659
44281
dfabb11c1e1a Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 43290
diff changeset
2660 Don't use both @code{:height} and @code{:relative-height} together.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2661
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2662 @node Other Display Specs
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2663 @subsection Other Display Specifications
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2664
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2665 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2666 @item (image . @var{image-props})
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2667 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
2668 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
2669 that has the display specification.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2670
32467
d8a494b62fbd string display property
Dave Love <fx@gnu.org>
parents: 32261
diff changeset
2671 @item ((margin nil) @var{string})
d8a494b62fbd string display property
Dave Love <fx@gnu.org>
parents: 32261
diff changeset
2672 @itemx @var{string}
d8a494b62fbd string display property
Dave Love <fx@gnu.org>
parents: 32261
diff changeset
2673 A display specification of this form means to display @var{string}
d8a494b62fbd string display property
Dave Love <fx@gnu.org>
parents: 32261
diff changeset
2674 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
2675 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
2676 (@pxref{Display Margins}).
d8a494b62fbd string display property
Dave Love <fx@gnu.org>
parents: 32261
diff changeset
2677
44281
dfabb11c1e1a Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 43290
diff changeset
2678 Recursive display specifications are not supported---string display
dfabb11c1e1a Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 43290
diff changeset
2679 specifications must not have @code{display} properties themselves.
36935
1ac3e0f3e75a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36730
diff changeset
2680
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2681 @item (space-width @var{factor})
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2682 This display specification affects all the space characters within the
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2683 text that has the specification. It displays all of these spaces
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2684 @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
2685 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
2686 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
2687
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2688 @item (height @var{height})
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2689 This display specification makes the text taller or shorter.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2690 Here are the possibilities for @var{height}:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2691
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2692 @table @asis
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2693 @item @code{(+ @var{n})}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2694 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
2695 defined by the set of available fonts---specifically, those that match
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2696 what was otherwise specified for this text, in all attributes except
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2697 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
2698 another step. @var{n} should be an integer.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2699
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2700 @item @code{(- @var{n})}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2701 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
2702
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2703 @item a number, @var{factor}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2704 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
2705 as tall as the default font.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2706
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2707 @item a symbol, @var{function}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2708 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
2709 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
2710
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2711 @item anything else, @var{form}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2712 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
2713 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
2714 @code{height} bound to the current specified font height.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2715 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2716
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2717 @item (raise @var{factor})
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2718 This kind of display specification raises or lowers the text
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2719 it applies to, relative to the baseline of the line.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2720
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2721 @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
2722 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
2723 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
2724 lower down.
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 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
2727 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
2728 faces used for the text.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2729 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2730
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2731 @node Display Margins
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2732 @subsection Displaying in the Margins
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2733 @cindex display margins
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2734 @cindex margins, display
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2735
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2736 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
2737 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
2738 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
2739 property.
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 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
2742 display specification of the form @code{(margin right-margin)} or
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2743 @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
2744 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
2745 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
2746 text or images in the margin mouse-sensitive.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2747
42297
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
2748 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
2749 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
2750 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
2751 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
2752 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
2753 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
2754 before-string.
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
2755
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2756 Before the display margins can display anything, you must give
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2757 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
2758 variables:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2759
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2760 @defvar left-margin-width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2761 @tindex left-margin-width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2762 This variable specifies the width of the left margin.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2763 It is buffer-local in all buffers.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2764 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2765
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2766 @defvar right-margin-width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2767 @tindex right-margin-width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2768 This variable specifies the width of the right margin.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2769 It is buffer-local in all buffers.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2770 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2771
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2772 Setting these variables does not immediately affect the window. These
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2773 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
2774 Thus, you can make changes take effect by calling
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2775 @code{set-window-buffer}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2776
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2777 You can also set the margin widths immediately.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2778
36935
1ac3e0f3e75a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36730
diff changeset
2779 @defun set-window-margins window left &optional right
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2780 @tindex set-window-margins
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2781 This function specifies the margin widths for window @var{window}.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
2782 The argument @var{left} controls the left margin and
36935
1ac3e0f3e75a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36730
diff changeset
2783 @var{right} controls the right margin (default @code{0}).
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2784 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2785
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2786 @defun window-margins &optional window
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2787 @tindex window-margins
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2788 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
2789 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
2790 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
2791 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2792
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2793 @node Conditional Display
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2794 @subsection Conditional Display Specifications
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2795 @cindex conditional display specifications
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2796
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2797 You can make any display specification conditional. To do that,
29471
215b57502518 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 29151
diff changeset
2798 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
2799 @var{spec})}. Then the specification @var{spec} applies only when
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2800 @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
2801 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
2802 conditional @code{display} property. @code{position} and
ed864621a68e Conditional Display): Adjust to API change.
Gerd Moellmann <gerd@gnu.org>
parents: 38278
diff changeset
2803 @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
2804 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
2805 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
2806 string.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2807
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2808 @node Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2809 @section Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2810 @cindex images in buffers
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2811
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2812 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
2813 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
2814 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
2815 @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
2816
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2817 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
2818 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
2819 machine. The supported image formats include XBM, XPM (needing the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2820 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
2821 @code{libungif} 4.1.0), Postscript, PBM, JPEG (needing the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2822 @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
2823 and PNG (needing @code{libpng} 1.0.2).
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2824
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2825 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
2826 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
2827 @code{pbm}, @code{jpeg}, @code{tiff}, and @code{png}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2828
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2829 @defvar image-types
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2830 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
2831 supported in the current configuration.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2832 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2833
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2834 @menu
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2835 * 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
2836 * XBM Images:: Special features for XBM format.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2837 * XPM Images:: Special features for XPM format.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2838 * GIF Images:: Special features for GIF format.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2839 * Postscript Images:: Special features for Postscript format.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2840 * Other Image Types:: Various other formats are supported.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2841 * Defining Images:: Convenient ways to define an image for later use.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2842 * 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
2843 * Image Cache:: Internal mechanisms of image display.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2844 @end menu
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2845
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2846 @node Image Descriptors
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2847 @subsection Image Descriptors
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2848 @cindex image descriptor
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2849
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2850 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
2851 . @var{props})}, where @var{props} is a property list containing
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2852 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
2853 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
2854 properties that have any special meaning are certain symbols, all of
53eeb3b7c785 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26221
diff changeset
2855 them keywords.
53eeb3b7c785 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26221
diff changeset
2856
53eeb3b7c785 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26221
diff changeset
2857 Every image descriptor must contain the property @code{:type
53eeb3b7c785 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26221
diff changeset
2858 @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
2859 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
2860 XPM format.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2861
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2862 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
2863 types:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2864
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2865 @table @code
36730
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2866 @item :file @var{file}
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2867 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
2868 @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
2869 in @code{data-directory}.
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2870
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2871 @item :data @var{data}
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2872 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
2873 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
2874 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
2875 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
2876
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2877 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
2878 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
2879 @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
2880 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
2881 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
2882
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2883 @item :margin @var{margin}
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2884 The @code{:margin} property specifies how many pixels to add as an
51000
72af65197e01 Fix typos. Patch from Jesper Harder <harder@ifa.au.dk>.
Juanma Barranquero <lekktu@gmail.com>
parents: 49600
diff changeset
2885 extra margin around the image. The value, @var{margin}, must be a
36730
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
2886 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
2887 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
2888 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
2889 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
2890
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2891 @item :ascent @var{ascent}
29151
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2892 The @code{:ascent} property specifies the amount of the image's
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2893 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
2894 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
2895 the symbol @code{center}.
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2896
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2897 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
2898 used for its ascent.
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2899
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2900 If @var{ascent} is @code{center}, the image is vertically centered
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2901 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
2902 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
2903 properties and overlays that apply to the image.
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2904
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
2905 If this property is omitted, it defaults to 50.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2906
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2907 @item :relief @var{relief}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2908 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
2909 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
2910 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
2911 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
2912 an unpressed button.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2913
35364
19c93f3ebdce *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 35278
diff changeset
2914 @item :conversion @var{algorithm}
19c93f3ebdce *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 35278
diff changeset
2915 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
2916 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
2917 displayed; the value, @var{algorithm}, specifies which algorithm.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2918
33996
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2919 @table @code
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2920 @item laplace
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2921 @itemx emboss
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2922 Specifies the Laplace edge detection algorithm, which blurs out small
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2923 differences in color while highlighting larger differences. People
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2924 sometimes consider this useful for displaying the image for a
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2925 ``disabled'' button.
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2926
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2927 @item (edge-detection :matrix @var{matrix} :color-adjust @var{adjust})
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2928 Specifies a general edge-detection algorithm. @var{matrix} must be
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2929 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
2930 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
2931 original pixels around that position. @var{matrix} specifies, for each
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2932 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
2933 will influence the transformed pixel; element @math{0} specifies the
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2934 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
2935 the pixel at @math{x/y-1} etc., as shown below:
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2936 @iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2937 @tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2938 $$\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
2939 x-1/y & x/y & x+1/y \cr
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2940 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
2941 @end tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2942 @end iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2943 @ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2944 @display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2945 (x-1/y-1 x/y-1 x+1/y-1
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2946 x-1/y x/y x+1/y
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2947 x-1/y+1 x/y+1 x+1/y+1)
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2948 @end display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2949 @end ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2950
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2951 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
2952 resulting from summing up the RGB values of surrounding pixels,
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2953 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
2954 of the factors' absolute values.
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2955
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2956 Laplace edge-detection currently uses a matrix of
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2957 @iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2958 @tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2959 $$\pmatrix{1 & 0 & 0 \cr
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2960 0& 0 & 0 \cr
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2961 9 & 9 & -1 \cr}$$
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2962 @end tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2963 @end iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2964 @ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2965 @display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2966 (1 0 0
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2967 0 0 0
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2968 9 9 -1)
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2969 @end display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2970 @end ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2971
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2972 Emboss edge-detection uses a matrix of
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2973 @iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2974 @tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2975 $$\pmatrix{ 2 & -1 & 0 \cr
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2976 -1 & 0 & 1 \cr
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2977 0 & 1 & -2 \cr}$$
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2978 @end tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2979 @end iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2980 @ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2981 @display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2982 ( 2 -1 0
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2983 -1 0 1
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2984 0 1 -2)
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2985 @end display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2986 @end ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2987
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2988 @item disabled
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2989 Specifies transforming the image so that it looks ``disabled''.
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2990 @end table
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2991
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2992 @item :mask @var{mask}
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2993 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
2994 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
2995 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
2996 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
2997 the four corners of the image, assuming the most frequently occurring
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
2998 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
2999 @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
3000 specifying the color to assume for the background of the image.
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3001
51652
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
3002 If @var{mask} is @code{nil}, remove a mask from the image, if it has
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
3003 one. Images in some formats include a mask which can be removed by
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
3004 specifying @code{:mask nil}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3005 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3006
33996
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3007 @defun image-mask-p spec &optional frame
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3008 @tindex image-mask-p
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3009 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
3010 @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
3011 @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
3012 (@pxref{Input Focus}).
33996
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3013 @end defun
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3014
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3015 @node XBM Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3016 @subsection XBM Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3017 @cindex XBM
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3018
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3019 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
3020 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
3021 always supported.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3022
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3023 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
3024
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3025 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3026 @item :foreground @var{foreground}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3027 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
3028 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
3029 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
3030 foreground color.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3031
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3032 @item :background @var{background}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3033 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
3034 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
3035 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
3036 background color.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3037 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3038
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
3039 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
3040 external file, use the following three properties:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3041
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3042 @table @code
28792
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3043 @item :data @var{data}
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3044 The value, @var{data}, specifies the contents of the image.
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3045 There are three formats you can use for @var{data}:
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3046
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3047 @itemize @bullet
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3048 @item
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3049 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
3050 image. Do specify @code{:height} and @code{:width}.
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3051
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3052 @item
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3053 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
3054 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
3055 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
3056 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
3057
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3058 @item
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3059 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
3060 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
3061 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
3062 @code{:height} and @code{:width}, both to indicate that the string
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3063 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
3064 size of the image.
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3065 @end itemize
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3066
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3067 @item :width @var{width}
28792
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3068 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
3069
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3070 @item :height @var{height}
28792
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3071 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
3072 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3073
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3074 @node XPM Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3075 @subsection XPM Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3076 @cindex XPM
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3077
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
3078 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
3079 additional image property @code{:color-symbols} is also meaningful with
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
3080 the @code{xpm} image type:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3081
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3082 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3083 @item :color-symbols @var{symbols}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3084 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
3085 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
3086 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
3087 specifies the actual color to use for displaying that name.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3088 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3089
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3090 @node GIF Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3091 @subsection GIF Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3092 @cindex GIF
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3093
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3094 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
3095 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
3096 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
3097 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
3098 (@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
3099 them, Emacs can display them.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3100
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3101 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3102 @item :index @var{index}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3103 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
3104 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
3105 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
3106 doesn't contain an image with index @var{index}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3107 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3108
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3109 @ignore
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3110 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
3111 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
3112 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
3113 every 0.1 seconds.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3114
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3115 (defun show-anim (file max)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3116 "Display multi-image GIF file FILE which contains MAX subimages."
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3117 (display-anim (current-buffer) file 0 max t))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3118
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3119 (defun display-anim (buffer file idx max first-time)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3120 (when (= idx max)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3121 (setq idx 0))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3122 (let ((img (create-image file nil :image idx)))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3123 (save-excursion
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3124 (set-buffer buffer)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3125 (goto-char (point-min))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3126 (unless first-time (delete-char 1))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3127 (insert-image img))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3128 (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
3129 @end ignore
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3130
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3131 @node Postscript Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3132 @subsection Postscript Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3133 @cindex Postscript images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3134
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3135 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
3136 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
3137 these three properties:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3138
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3139 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3140 @item :pt-width @var{width}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3141 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
3142 points (1/72 inch). @var{width} must be an integer.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3143
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3144 @item :pt-height @var{height}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3145 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
3146 (1/72 inch). @var{height} must be an integer.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3147
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3148 @item :bounding-box @var{box}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3149 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
3150 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
3151 @samp{BoundingBox} comment found in Postscript files.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3152
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3153 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3154 %%BoundingBox: 22 171 567 738
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3155 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3156 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3157
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
3158 Displaying Postscript images from Lisp data is not currently
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
3159 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
3160 See the @file{etc/NEWS} file to make sure.
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
3161
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3162 @node Other Image Types
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3163 @subsection Other Image Types
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3164 @cindex PBM
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3165
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3166 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
3167 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
3168 image properties are supported.
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
3169
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
3170 @table @code
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
3171 @item :foreground @var{foreground}
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
3172 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
3173 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
3174 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
3175 foreground color.
32552
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
3176
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
3177 @item :background @var{background}
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
3178 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
3179 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
3180 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
3181 background color.
32552
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
3182 @end table
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3183
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
3184 For JPEG images, specify image type @code{jpeg}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3185
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3186 For TIFF images, specify image type @code{tiff}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3187
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3188 For PNG images, specify image type @code{png}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3189
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3190 @node Defining Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3191 @subsection Defining Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3192
31373
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
3193 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
3194 @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
3195
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3196 @defun create-image file &optional type &rest props
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3197 @tindex create-image
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3198 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
3199 data in @var{file}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3200
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3201 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
3202 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
3203 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
3204 from the file's name.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3205
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3206 The remaining arguments, @var{props}, specify additional image
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3207 properties---for example,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3208
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3209 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3210 (create-image "foo.xpm" 'xpm :heuristic-mask t)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3211 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3212
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3213 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
3214 supported. Otherwise it returns an image descriptor.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3215 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3216
41058
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
3217 @defmac defimage symbol specs &optional doc
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3218 @tindex defimage
41058
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
3219 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
3220 @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
3221 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
3222
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3223 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
3224 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
3225 @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
3226 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
3227 @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
3228 @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
3229 example:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3230
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3231 @example
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3232 (defimage test-image
46338
6cf0fbc1d7da defimage does not evaluate SPECS.
Richard M. Stallman <rms@gnu.org>
parents: 46245
diff changeset
3233 ((:type xpm :file "~/test1.xpm")
6cf0fbc1d7da defimage does not evaluate SPECS.
Richard M. Stallman <rms@gnu.org>
parents: 46245
diff changeset
3234 (:type xbm :file "~/test1.xbm")))
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3235 @end example
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3236
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3237 @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
3238 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
3239 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
3240 stored in @var{symbol}.
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
3241
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
3242 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
3243 as @code{nil}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3244 @end defmac
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3245
31373
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
3246 @defun find-image specs
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
3247 @tindex find-image
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
3248 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
3249 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
3250
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
3251 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
3252 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
3253 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
3254 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
3255 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
3256 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
3257 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
3258 @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
3259 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
3260
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
3261 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
3262 @code{data-directory}.
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
3263 @end defun
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
3264
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3265 @node Showing Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3266 @subsection Showing Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3267
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3268 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
3269 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
3270 section.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3271
29471
215b57502518 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 29151
diff changeset
3272 @defun insert-image image &optional string area
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3273 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
3274 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
3275 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
3276 @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
3277 the buffer to hold the image.
25751
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 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
3280 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
3281 @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
3282 @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
3283 buffer's text.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3284
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3285 Internally, this function inserts @var{string} in the buffer, and gives
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3286 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
3287 Property}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3288 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3289
29471
215b57502518 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 29151
diff changeset
3290 @defun put-image image pos &optional string area
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3291 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
3292 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
3293 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
3294 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
3295 as an alternative to the default.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3296
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3297 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
3298 by @code{create-image} or stored by @code{defimage}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3299
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3300 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
3301 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
3302 @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
3303 @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
3304 buffer's text.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3305
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3306 Internally, this function creates an overlay, and gives it a
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3307 @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
3308 property whose value is the image. (Whew!)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3309 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3310
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3311 @defun remove-images start end &optional buffer
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3312 This function removes images in @var{buffer} between positions
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3313 @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
3314 images are removed from the current buffer.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3315
27331
be0a552c8320 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27193
diff changeset
3316 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
3317 @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
3318 @code{insert-image} or in other ways.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3319 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3320
31373
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
3321 @defun image-size spec &optional pixels frame
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
3322 @tindex image-size
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
3323 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
3324 @w{@code{(@var{width} . @var{height})}}. @var{spec} is an image
51652
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
3325 specification. @var{pixels} non-@code{nil} means return sizes
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
3326 measured in pixels, otherwise return sizes measured in canonical
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
3327 character units (fractions of the width/height of the frame's default
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
3328 font). @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
3329 @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
3330 Focus}).
31373
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
3331 @end defun
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
3332
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3333 @node Image Cache
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3334 @subsection Image Cache
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3335
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3336 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
3337 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
3338 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
3339
28770
313b9e6e2dbf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 27971
diff changeset
3340 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
3341 with cached image specifications using @code{equal}. This means that
313b9e6e2dbf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 27971
diff changeset
3342 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
3343
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3344 @defvar image-cache-eviction-delay
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3345 @tindex image-cache-eviction-delay
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3346 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
3347 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
3348 length of time, Emacs removes it from the image cache.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3349
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3350 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
3351 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
3352 debugging.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3353 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3354
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3355 @defun clear-image-cache &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3356 @tindex clear-image-cache
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3357 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
3358 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
3359 are cleared.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3360 @end defun
27447
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
3361
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3362 @node Blinking
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3363 @section Blinking Parentheses
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3364 @cindex parenthesis matching
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3365 @cindex blinking
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3366 @cindex balancing parentheses
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3367 @cindex close parenthesis
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3368
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3369 This section describes the mechanism by which Emacs shows a matching
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3370 open parenthesis when the user inserts a close parenthesis.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3371
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3372 @defvar blink-paren-function
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3373 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
3374 be called whenever a character with close parenthesis syntax is inserted.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3375 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
3376 case nothing is done.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3377 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3378
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3379 @defopt blink-matching-paren
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3380 If this variable is @code{nil}, then @code{blink-matching-open} does
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3381 nothing.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3382 @end defopt
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3383
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3384 @defopt blink-matching-paren-distance
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3385 This variable specifies the maximum distance to scan for a matching
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3386 parenthesis before giving up.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3387 @end defopt
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3388
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3389 @defopt blink-matching-delay
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
3390 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
3391 at the matching parenthesis. A fraction of a second often gives
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
3392 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
3393 @end defopt
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
3394
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3395 @deffn Command blink-matching-open
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3396 This function is the default value of @code{blink-paren-function}. It
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3397 assumes that point follows a character with close parenthesis syntax and
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3398 moves the cursor momentarily to the matching opening character. If that
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3399 character is not already on the screen, it displays the character's
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3400 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
3401 search farther than @code{blink-matching-paren-distance} characters.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3402
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3403 Here is an example of calling this function explicitly.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3404
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3405 @smallexample
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3406 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3407 (defun interactive-blink-matching-open ()
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3408 @c Do not break this line! -- rms.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3409 @c The first line of a doc string
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3410 @c must stand alone.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3411 "Indicate momentarily the start of sexp before point."
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3412 (interactive)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3413 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3414 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3415 (let ((blink-matching-paren-distance
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3416 (buffer-size))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3417 (blink-matching-paren t))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3418 (blink-matching-open)))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3419 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3420 @end smallexample
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3421 @end deffn
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3422
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3423 @node Inverse Video
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3424 @section Inverse Video
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3425 @cindex Inverse Video
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 @defopt inverse-video
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3428 @cindex highlighting
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3429 This variable controls whether Emacs uses inverse video for all text
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3430 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
3431 default is @code{nil}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3432 @end defopt
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3433
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3434 @defopt mode-line-inverse-video
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3435 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
3436 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
3437 inverse video. Otherwise, these lines are displayed normally, just like
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3438 other text. The default is @code{t}.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3439
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3440 For window frames, this feature actually applies the face named
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3441 @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
3442 default face, unless you change it.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3443 @end defopt
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3444
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3445 @node Usual Display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3446 @section Usual Display Conventions
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3447
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3448 The usual display conventions define how to display each character
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3449 code. You can override these conventions by setting up a display table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3450 (@pxref{Display Tables}). Here are the usual display conventions:
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3451
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3452 @itemize @bullet
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3453 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3454 Character codes 32 through 126 map to glyph codes 32 through 126.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3455 Normally this means they display as themselves.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3456
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3457 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3458 Character code 9 is a horizontal tab. It displays as whitespace
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3459 up to a position determined by @code{tab-width}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3460
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3461 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3462 Character code 10 is a newline.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3463
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3464 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3465 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
3466 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
3467 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
3468 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
3469 specify a glyph to use instead of @samp{^}.) Otherwise, these codes map
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3470 just like the codes in the range 128 to 255.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3471
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3472 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
3473 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
3474 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
3475 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
3476 emacs, The GNU Emacs Manual}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3477
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3478 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3479 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
3480 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
3481 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
3482 table can specify a glyph to use instead of @samp{\}.)
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3483
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3484 @item
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3485 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
3486 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
3487 character.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3488 @end itemize
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3489
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3490 The usual display conventions apply even when there is a display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3491 table, for any character whose entry in the active display table is
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3492 @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
3493 specify the characters for which you want special behavior.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3494
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
3495 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
3496 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
3497 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
3498 conversion (@pxref{Coding System Basics}).
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
3499
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3500 These variables affect the way certain characters are displayed on the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3501 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
3502 they also affect the indentation functions. These variables also affect
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3503 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
3504 mode line using the new values, call the function
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3505 @code{force-mode-line-update} (@pxref{Mode Line Format}).
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3506
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3507 @defopt ctl-arrow
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3508 @cindex control characters in display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3509 This buffer-local variable controls how control characters are
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3510 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
3511 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
3512 displayed as a backslash followed by three octal digits: @samp{\001}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3513 @end defopt
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3514
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3515 @c Following may have overfull hbox.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3516 @defvar default-ctl-arrow
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3517 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
3518 buffers that do not override it. @xref{Default Value}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3519 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3520
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
3521 @defopt indicate-empty-lines
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
3522 @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
3523 @cindex fringes, and empty line indication
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
3524 When this is non-@code{nil}, Emacs displays a special glyph in the
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
3525 fringe of each empty line at the end of the buffer, on terminals that
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
3526 support it (window systems). @xref{Fringes}.
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
3527 @end defopt
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
3528
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3529 @defopt tab-width
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3530 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
3531 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
3532 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
3533 independent of the user-settable tab stops used by the command
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3534 @code{tab-to-tab-stop}. @xref{Indent Tabs}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3535 @end defopt
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3536
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3537 @node Display Tables
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3538 @section Display Tables
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3539
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3540 @cindex display table
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3541 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
3542 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
3543 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
3544 set.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3545
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3546 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
3547 @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
3548 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
3549 on your terminal, using the @dfn{glyph table}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3550
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3551 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
3552 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
3553 @code{force-mode-line-update} (@pxref{Mode Line Format}).
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3554
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3555 @menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3556 * Display Table Format:: What a display table consists of.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3557 * Active Display Table:: How Emacs selects a display table to use.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3558 * Glyphs:: How to define a glyph, and what glyphs mean.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3559 @end menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3560
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3561 @node Display Table Format
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3562 @subsection Display Table Format
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3563
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3564 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
3565 @code{display-table} as its subtype.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3566
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3567 @defun make-display-table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3568 This creates and returns a display table. The table initially has
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3569 @code{nil} in all elements.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3570 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3571
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3572 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
3573 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
3574 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
3575 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
3576 display that character according to the usual display conventions
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3577 (@pxref{Usual Display}).
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
3578
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
3579 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
3580 characters, the whole buffer will be displayed as one long ``line.''
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3581
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3582 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
3583 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
3584 means to use the default for that slot, as stated below.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3585
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3586 @table @asis
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3587 @item 0
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3588 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
3589 is @samp{$}). @xref{Glyphs}. Newer Emacs versions, on some platforms,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3590 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
3591 in these situations.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3592 @item 1
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3593 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
3594 Newer Emacs versions, on some platforms, display curved arrows to
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3595 indicate truncation---the display table has no effect in these
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3596 situations.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3597 @item 2
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3598 The glyph for indicating a character displayed as an octal character
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3599 code (the default is @samp{\}).
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3600 @item 3
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3601 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
3602 @item 4
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3603 A vector of glyphs for indicating the presence of invisible lines (the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3604 default is @samp{...}). @xref{Selective Display}.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3605 @item 5
8925
b05788fd41f0 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 8096
diff changeset
3606 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
3607 default is @samp{|}). @xref{Splitting Windows}. This takes effect only
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3608 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
3609 a scroll bar separates the two windows.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3610 @end table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3611
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3612 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
3613 effect of setting @code{ctl-arrow} to a non-@code{nil} value:
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3614
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3615 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3616 (setq disptab (make-display-table))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3617 (let ((i 0))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3618 (while (< i 32)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3619 (or (= i ?\t) (= i ?\n)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3620 (aset disptab i (vector ?^ (+ i 64))))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3621 (setq i (1+ i)))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3622 (aset disptab 127 (vector ?^ ??)))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3623 @end example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3624
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3625 @defun display-table-slot display-table slot
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3626 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
3627 @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
3628 5 inclusive, or a slot name (symbol). Valid symbols are
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3629 @code{truncation}, @code{wrap}, @code{escape}, @code{control},
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3630 @code{selective-display}, and @code{vertical-border}.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3631 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3632
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3633 @defun set-display-table-slot display-table slot value
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3634 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
3635 @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
3636 5 inclusive, or a slot name (symbol). Valid symbols are
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3637 @code{truncation}, @code{wrap}, @code{escape}, @code{control},
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3638 @code{selective-display}, and @code{vertical-border}.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3639 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3640
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3641 @defun describe-display-table display-table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3642 @tindex describe-display-table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3643 This function displays a description of the display table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3644 @var{display-table} in a help buffer.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3645 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3646
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3647 @deffn Command describe-current-display-table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3648 @tindex describe-current-display-table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3649 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
3650 help buffer.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3651 @end deffn
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3652
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3653 @node Active Display Table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3654 @subsection Active Display Table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3655 @cindex active display table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3656
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3657 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
3658 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
3659 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
3660 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
3661 table if any. The display table chosen is called the @dfn{active}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3662 display table.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3663
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3664 @defun window-display-table window
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3665 This function returns @var{window}'s display table, or @code{nil}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3666 if @var{window} does not have an assigned display table.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3667 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3668
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3669 @defun set-window-display-table window table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3670 This function sets the display table of @var{window} to @var{table}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3671 The argument @var{table} should be either a display table or
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3672 @code{nil}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3673 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3674
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3675 @defvar buffer-display-table
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3676 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
3677 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
3678 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
3679 table.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3680 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3681
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3682 @defvar standard-display-table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3683 This variable's value is the default display table, used whenever a
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3684 window has no display table and neither does the buffer displayed in
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3685 that window. This variable is @code{nil} by default.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3686 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3687
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3688 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
3689 if the window specifies none, its buffer specifies none, and
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3690 @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
3691 display conventions for all character codes in that window. @xref{Usual
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3692 Display}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3693
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3694 A number of functions for changing the standard display table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3695 are defined in the library @file{disp-table}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3696
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3697 @node Glyphs
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3698 @subsection Glyphs
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3699
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3700 @cindex glyph
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3701 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
3702 image that takes up a single character position on the screen. Glyphs
47482
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3703 are represented in Lisp as integers, just as characters are. Normally
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3704 Emacs finds glyphs in the display table (@pxref{Display Tables}).
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3705
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3706 A glyph can be @dfn{simple} or it can be defined by the @dfn{glyph
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3707 table}. A simple glyph is just a way of specifying a character and a
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3708 face to output it in. The glyph code for a simple glyph, mod 524288,
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3709 is the character to output, and the glyph code divided by 524288
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3710 specifies the face number (@pxref{Face Functions}) to use while
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3711 outputting it. (524288 is
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3712 @ifnottex
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3713 2**19.)
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3714 @end ifnottex
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3715 @tex
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3716 $2^{19}$.)
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3717 @end tex
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3718 @xref{Faces}.
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3719
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3720 On character terminals, you can set up a @dfn{glyph table} to define
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3721 the meaning of glyph codes. The glyph codes is the value of the
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3722 variable @code{glyph-table}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3723
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3724 @defvar glyph-table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3725 The value of this variable is the current glyph table. It should be a
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
3726 vector; the @var{g}th element defines glyph code @var{g}.
47482
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3727
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3728 If a glyph code is greater than or equal to the length of the glyph
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3729 table, that code is automatically simple. If the value of
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3730 @code{glyph-table} is @code{nil} instead of a vector, then all glyphs
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3731 are simple. The glyph table is not used on graphical displays, only
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3732 on character terminals. On graphical displays, all glyphs are simple.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3733 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3734
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3735 Here are the possible types of elements in the glyph table:
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3736
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3737 @table @asis
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3738 @item @var{string}
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3739 Send the characters in @var{string} to the terminal to output
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3740 this glyph. This alternative is available on character terminals,
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3741 but not under a window system.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3742
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3743 @item @var{integer}
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3744 Define this glyph code as an alias for glyph code @var{integer}. You
47482
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3745 can use an alias to specify a face code for the glyph and use a small
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3746 number as its code.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3747
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3748 @item @code{nil}
47482
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
3749 This glyph is simple.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3750 @end table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3751
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3752 @defun create-glyph string
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3753 @tindex create-glyph
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3754 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
3755 display by sending @var{string} to the terminal.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3756 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3757
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3758 @node Beeping
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3759 @section Beeping
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3760 @cindex beeping
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3761 @cindex bell
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3762
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3763 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
3764 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
3765 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
3766 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
3767 appropriate. (@xref{Errors}.)
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3768
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3769 @defun ding &optional do-not-terminate
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3770 @cindex keyboard macro termination
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3771 This function beeps, or flashes the screen (see @code{visible-bell} below).
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3772 It also terminates any keyboard macro currently executing unless
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3773 @var{do-not-terminate} is non-@code{nil}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3774 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3775
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3776 @defun beep &optional do-not-terminate
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3777 This is a synonym for @code{ding}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3778 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3779
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3780 @defopt visible-bell
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3781 This variable determines whether Emacs should flash the screen to
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3782 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
3783 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
3784 provided the terminal's Termcap entry defines the visible bell
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
3785 capability (@samp{vb}).
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3786 @end defopt
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3787
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3788 @defvar ring-bell-function
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3789 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
3790 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
3791 non-@code{nil}, it takes precedence over the @code{visible-bell}
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3792 variable.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3793 @end defvar
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3794
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3795 @node Window Systems
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3796 @section Window Systems
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3797
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3798 Emacs works with several window systems, most notably the X Window
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3799 System. Both Emacs and X use the term ``window'', but use it
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3800 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
3801 concerned; the individual Emacs windows are not known to X at all.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3802
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3803 @defvar window-system
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3804 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
3805 under. The possible values are
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3806
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3807 @table @code
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3808 @item x
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3809 @cindex X Window System
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3810 Emacs is displaying using X.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3811 @item pc
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3812 Emacs is displaying using MS-DOS.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3813 @item w32
27332
5cfe77eaff45 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27331
diff changeset
3814 Emacs is displaying using Windows.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3815 @item mac
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3816 Emacs is displaying using a Macintosh.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3817 @item nil
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3818 Emacs is using a character-based terminal.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
3819 @end table
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3820 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3821
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3822 @defvar window-setup-hook
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
3823 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
3824 initialization files. Emacs runs this hook after it has completed
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3825 loading your init file, the default initialization file (if
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
3826 any), and the terminal-specific Lisp code, and running the hook
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3827 @code{term-setup-hook}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3828
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3829 This hook is used for internal purposes: setting up communication with
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3830 the window system, and creating the initial window. Users should not
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3831 interfere with it.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3832 @end defvar
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52380
diff changeset
3833
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52380
diff changeset
3834 @ignore
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52380
diff changeset
3835 arch-tag: ffdf5714-7ecf-415b-9023-fbc6b409c2c6
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52380
diff changeset
3836 @end ignore