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