Mercurial > emacs
annotate lispref/display.texi @ 22023:8c00a2d112cc
(Fset_buffer_multibyte): Error if marker is put
on buffer's marker-chain while we have temporarily put nil there.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Mon, 11 May 1998 01:14:36 +0000 |
parents | 90da2489c498 |
children | d4ac295a98b3 |
rev | line source |
---|---|
6598 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998 Free Software Foundation, Inc. |
6598 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/display | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
6 @node Display, Calendar, Processes, Top |
6598 | 7 @chapter Emacs Display |
8 | |
9 This chapter describes a number of features related to the display | |
10 that Emacs presents to the user. | |
11 | |
12 @menu | |
13 * Refresh Screen:: Clearing the screen and redrawing everything on it. | |
14 * Screen Size:: How big is the Emacs screen. | |
15 * Truncation:: Folding or wrapping long text lines. | |
16 * The Echo Area:: Where messages are displayed. | |
12067 | 17 * Invisible Text:: Hiding part of the buffer text. |
18 * Selective Display:: Hiding part of the buffer text (the old way). | |
6598 | 19 * Overlay Arrow:: Display of an arrow to indicate position. |
20 * Temporary Displays:: Displays that go away automatically. | |
21 * Overlays:: Use overlays to highlight parts of the buffer. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
22 * Width:: How wide is a character or string. |
6598 | 23 * Faces:: A face defines a graphics appearance: font, color, etc. |
24 * Blinking:: How Emacs shows the matching open parenthesis. | |
25 * Inverse Video:: Specifying how the screen looks. | |
26 * Usual Display:: The usual conventions for displaying nonprinting chars. | |
27 * Display Tables:: How to specify other conventions. | |
28 * Beeping:: Audible signal to the user. | |
29 * Window Systems:: Which window system is being used. | |
30 @end menu | |
31 | |
32 @node Refresh Screen | |
33 @section Refreshing the Screen | |
34 | |
35 The function @code{redraw-frame} redisplays the entire contents of a | |
36 given frame. @xref{Frames}. | |
37 | |
38 @c Emacs 19 feature | |
39 @defun redraw-frame frame | |
40 This function clears and redisplays frame @var{frame}. | |
41 @end defun | |
42 | |
43 Even more powerful is @code{redraw-display}: | |
44 | |
45 @deffn Command redraw-display | |
46 This function clears and redisplays all visible frames. | |
47 @end deffn | |
48 | |
12098 | 49 Processing user input takes absolute priority over redisplay. If you |
50 call these functions when input is available, they do nothing | |
51 immediately, but a full redisplay does happen eventually---after all the | |
52 input has been processed. | |
53 | |
6598 | 54 Normally, suspending and resuming Emacs also refreshes the screen. |
55 Some terminal emulators record separate contents for display-oriented | |
56 programs such as Emacs and for ordinary sequential display. If you are | |
57 using such a terminal, you might want to inhibit the redisplay on | |
9009 | 58 resumption. |
6598 | 59 |
60 @defvar no-redraw-on-reenter | |
61 @cindex suspend (cf. @code{no-redraw-on-reenter}) | |
62 @cindex resume (cf. @code{no-redraw-on-reenter}) | |
63 This variable controls whether Emacs redraws the entire screen after it | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
64 has been suspended and resumed. Non-@code{nil} means there is no need |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
65 to redraw, @code{nil} means redrawing is needed. The default is @code{nil}. |
6598 | 66 @end defvar |
67 | |
68 @node Screen Size | |
69 @section Screen Size | |
70 @cindex size of screen | |
71 @cindex screen size | |
72 @cindex display lines | |
73 @cindex display columns | |
74 @cindex resize redisplay | |
75 | |
9009 | 76 The screen size functions access or specify the height or width of |
6598 | 77 the terminal. When you are using multiple frames, they apply to the |
78 selected frame (@pxref{Frames}). | |
79 | |
80 @defun screen-height | |
81 This function returns the number of lines on the screen that are | |
82 available for display. | |
83 | |
84 @example | |
85 @group | |
86 (screen-height) | |
87 @result{} 50 | |
88 @end group | |
89 @end example | |
90 @end defun | |
91 | |
92 @defun screen-width | |
93 This function returns the number of columns on the screen that are | |
94 available for display. | |
95 | |
96 @example | |
97 @group | |
98 (screen-width) | |
99 @result{} 80 | |
100 @end group | |
101 @end example | |
102 @end defun | |
103 | |
104 @defun set-screen-height lines &optional not-actual-size | |
105 This function declares that the terminal can display @var{lines} lines. | |
106 The sizes of existing windows are altered proportionally to fit. | |
107 | |
108 If @var{not-actual-size} is non-@code{nil}, then Emacs displays | |
109 @var{lines} lines of output, but does not change its value for the | |
110 actual height of the screen. (Knowing the correct actual size may be | |
111 necessary for correct cursor positioning.) Using a smaller height than | |
112 the terminal actually implements may be useful to reproduce behavior | |
113 observed on a smaller screen, or if the terminal malfunctions when using | |
114 its whole screen. | |
115 | |
116 If @var{lines} is different from what it was previously, then the | |
117 entire screen is cleared and redisplayed using the new size. | |
118 | |
119 This function returns @code{nil}. | |
120 @end defun | |
121 | |
122 @defun set-screen-width columns &optional not-actual-size | |
123 This function declares that the terminal can display @var{columns} | |
124 columns. The details are as in @code{set-screen-height}. | |
125 @end defun | |
126 | |
127 @node Truncation | |
128 @section Truncation | |
129 @cindex line wrapping | |
130 @cindex continuation lines | |
131 @cindex @samp{$} in display | |
132 @cindex @samp{\} in display | |
133 | |
134 When a line of text extends beyond the right edge of a window, the | |
135 line can either be continued on the next screen line, or truncated to | |
136 one screen line. The additional screen lines used to display a long | |
137 text line are called @dfn{continuation} lines. Normally, a @samp{$} in | |
138 the rightmost column of the window indicates truncation; a @samp{\} on | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
139 the rightmost column indicates a line that ``wraps'' onto the next line, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
140 which is also called @dfn{continuing} the line. (The display table can |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
141 specify alternative indicators; see @ref{Display Tables}.) |
6598 | 142 |
143 Note that continuation is different from filling; continuation happens | |
144 on the screen only, not in the buffer contents, and it breaks a line | |
145 precisely at the right margin, not at a word boundary. @xref{Filling}. | |
146 | |
147 @defopt truncate-lines | |
148 This buffer-local variable controls how Emacs displays lines that extend | |
149 beyond the right edge of the window. The default is @code{nil}, which | |
150 specifies continuation. If the value is non-@code{nil}, then these | |
151 lines are truncated. | |
152 | |
153 If the variable @code{truncate-partial-width-windows} is non-@code{nil}, | |
154 then truncation is always used for side-by-side windows (within one | |
155 frame) regardless of the value of @code{truncate-lines}. | |
156 @end defopt | |
157 | |
12098 | 158 @defopt default-truncate-lines |
6598 | 159 This variable is the default value for @code{truncate-lines}, for |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
160 buffers that do not have buffer-local values for it. |
12098 | 161 @end defopt |
6598 | 162 |
163 @defopt truncate-partial-width-windows | |
164 This variable controls display of lines that extend beyond the right | |
165 edge of the window, in side-by-side windows (@pxref{Splitting Windows}). | |
166 If it is non-@code{nil}, these lines are truncated; otherwise, | |
167 @code{truncate-lines} says what to do with them. | |
168 @end defopt | |
169 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
170 You can override the glyphs that indicate continuation or truncation |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
171 using the display table; see @ref{Display Tables}. |
6598 | 172 |
12067 | 173 If your buffer contains @strong{very} long lines, and you use |
174 continuation to display them, just thinking about them can make Emacs | |
12098 | 175 redisplay slow. The column computation and indentation functions also |
176 become slow. Then you might find it advisable to set | |
177 @code{cache-long-line-scans} to @code{t}. | |
12067 | 178 |
179 @defvar cache-long-line-scans | |
180 If this variable is non-@code{nil}, various indentation and motion | |
12098 | 181 functions, and Emacs redisplay, cache the results of scanning the |
182 buffer, and consult the cache to avoid rescanning regions of the buffer | |
183 unless they are modified. | |
12067 | 184 |
12098 | 185 Turning on the cache slows down processing of short lines somewhat. |
12067 | 186 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
187 This variable is automatically buffer-local in every buffer. |
12067 | 188 @end defvar |
189 | |
6598 | 190 @node The Echo Area |
191 @section The Echo Area | |
192 @cindex error display | |
193 @cindex echo area | |
194 | |
12067 | 195 The @dfn{echo area} is used for displaying messages made with the |
6598 | 196 @code{message} primitive, and for echoing keystrokes. It is not the |
197 same as the minibuffer, despite the fact that the minibuffer appears | |
198 (when active) in the same place on the screen as the echo area. The | |
199 @cite{GNU Emacs Manual} specifies the rules for resolving conflicts | |
200 between the echo area and the minibuffer for use of that screen space | |
201 (@pxref{Minibuffer,, The Minibuffer, emacs, The GNU Emacs Manual}). | |
202 Error messages appear in the echo area; see @ref{Errors}. | |
203 | |
204 You can write output in the echo area by using the Lisp printing | |
205 functions with @code{t} as the stream (@pxref{Output Functions}), or as | |
206 follows: | |
207 | |
208 @defun message string &rest arguments | |
12067 | 209 This function displays a one-line message in the echo area. The |
6598 | 210 argument @var{string} is similar to a C language @code{printf} control |
211 string. See @code{format} in @ref{String Conversion}, for the details | |
212 on the conversion specifications. @code{message} returns the | |
213 constructed string. | |
214 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
215 In batch mode, @code{message} prints the message text on the standard |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
216 error stream, followed by a newline. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
217 |
6598 | 218 @c Emacs 19 feature |
219 If @var{string} is @code{nil}, @code{message} clears the echo area. If | |
220 the minibuffer is active, this brings the minibuffer contents back onto | |
221 the screen immediately. | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
222 |
6598 | 223 @example |
224 @group | |
225 (message "Minibuffer depth is %d." | |
226 (minibuffer-depth)) | |
227 @print{} Minibuffer depth is 0. | |
228 @result{} "Minibuffer depth is 0." | |
229 @end group | |
230 | |
231 @group | |
232 ---------- Echo Area ---------- | |
233 Minibuffer depth is 0. | |
234 ---------- Echo Area ---------- | |
235 @end group | |
236 @end example | |
237 @end defun | |
238 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
239 @tindex current-message |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
240 @defun current-message |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
241 This function returns the message currently being displayed in the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
242 echo area, or @code{nil} if there is none. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
243 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
244 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
245 @defvar cursor-in-echo-area |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
246 This variable controls where the cursor appears when a message is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
247 displayed in the echo area. If it is non-@code{nil}, then the cursor |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
248 appears at the end of the message. Otherwise, the cursor appears at |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
249 point---not in the echo area at all. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
250 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
251 The value is normally @code{nil}; Lisp programs bind it to @code{t} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
252 for brief periods of time. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
253 @end defvar |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
254 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
255 @tindex echo-area-clear-hook |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
256 @defvar echo-area-clear-hook |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
257 This normal hook is run whenever the echo area is cleared---either by |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
258 @code{(message nil)} or for any other reason. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
259 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
260 |
12067 | 261 Almost all the messages displayed in the echo area are also recorded |
262 in the @samp{*Messages*} buffer. | |
263 | |
264 @defopt message-log-max | |
265 This variable specifies how many lines to keep in the @samp{*Messages*} | |
266 buffer. The value @code{t} means there is no limit on how many lines to | |
267 keep. The value @code{nil} disables message logging entirely. Here's | |
268 how to display a message and prevent it from being logged: | |
269 | |
270 @example | |
271 (let (message-log-max) | |
272 (message @dots{})) | |
273 @end example | |
274 @end defopt | |
275 | |
12098 | 276 @defvar echo-keystrokes |
277 This variable determines how much time should elapse before command | |
278 characters echo. Its value must be an integer, which specifies the | |
279 number of seconds to wait before echoing. If the user types a prefix | |
280 key (such as @kbd{C-x}) and then delays this many seconds before | |
281 continuing, the prefix key is echoed in the echo area. Any subsequent | |
282 characters in the same command will be echoed as well. | |
283 | |
284 If the value is zero, then command input is not echoed. | |
285 @end defvar | |
286 | |
12067 | 287 @node Invisible Text |
288 @section Invisible Text | |
289 | |
290 @cindex invisible text | |
291 You can make characters @dfn{invisible}, so that they do not appear on | |
292 the screen, with the @code{invisible} property. This can be either a | |
293 text property or a property of an overlay. | |
294 | |
295 In the simplest case, any non-@code{nil} @code{invisible} property makes | |
296 a character invisible. This is the default case---if you don't alter | |
297 the default value of @code{buffer-invisibility-spec}, this is how the | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
298 @code{invisible} property works. |
12067 | 299 |
300 More generally, you can use the variable @code{buffer-invisibility-spec} | |
301 to control which values of the @code{invisible} property make text | |
302 invisible. This permits you to classify the text into different subsets | |
303 in advance, by giving them different @code{invisible} values, and | |
304 subsequently make various subsets visible or invisible by changing the | |
305 value of @code{buffer-invisibility-spec}. | |
306 | |
307 Controlling visibility with @code{buffer-invisibility-spec} is | |
308 especially useful in a program to display the list of entries in a data | |
309 base. It permits the implementation of convenient filtering commands to | |
310 view just a part of the entries in the data base. Setting this variable | |
311 is very fast, much faster than scanning all the text in the buffer | |
12098 | 312 looking for properties to change. |
12067 | 313 |
314 @defvar buffer-invisibility-spec | |
315 This variable specifies which kinds of @code{invisible} properties | |
316 actually make a character invisible. | |
317 | |
318 @table @asis | |
319 @item @code{t} | |
320 A character is invisible if its @code{invisible} property is | |
321 non-@code{nil}. This is the default. | |
322 | |
323 @item a list | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
324 Each element of the list specifies a criterion for invisibility; if a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
325 character's @code{invisible} property fits any one of these criteria, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
326 the character is invisible. The list can have two kinds of elements: |
12067 | 327 |
328 @table @code | |
329 @item @var{atom} | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
330 A character is invisible if its @code{invisible} property value |
12067 | 331 is @var{atom} or if it is a list with @var{atom} as a member. |
332 | |
333 @item (@var{atom} . t) | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
334 A character is invisible if its @code{invisible} property value |
12067 | 335 is @var{atom} or if it is a list with @var{atom} as a member. |
336 Moreover, if this character is at the end of a line and is followed | |
337 by a visible newline, it displays an ellipsis. | |
338 @end table | |
339 @end table | |
340 @end defvar | |
341 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
342 Two functions are specifically provided for adding elements to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
343 @code{buffer-invisibility-spec} and removing elements from it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
344 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
345 @tindex add-to-invisibility-spec |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
346 @defun add-to-invisibility-spec element |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
347 Add the element @var{element} to @code{buffer-invisibility-spec} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
348 (if it is not already present in that list). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
349 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
350 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
351 @tindex remove-from-invisibility-spec |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
352 @defun remove-from-invisibility-spec element |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
353 Remove the element @var{element} from @code{buffer-invisibility-spec}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
354 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
355 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
356 One convention about the use of @code{buffer-invisibility-spec} is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
357 that a major mode should use the mode's own name as an element of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
358 @code{buffer-invisibility-spec} and as the value of the @code{invisible} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
359 property: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
360 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
361 @example |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
362 ;; @r{If you want to display an ellipsis:} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
363 (add-to-invisibility-spec '(my-symbol . t)) |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
364 ;; @r{If you don't want ellipsis:} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
365 (add-to-invisibility-spec 'my-symbol) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
366 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
367 (overlay-put (make-overlay beginning end) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
368 'invisible 'my-symbol) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
369 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
370 ;; @r{When done with the overlays:} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
371 (remove-from-invisibility-spec '(my-symbol . t)) |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
372 ;; @r{Or respectively:} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
373 (remove-from-invisibility-spec 'my-symbol) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
374 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
375 |
15761
77d451c08a30
Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
15074
diff
changeset
|
376 @vindex line-move-ignore-invisible |
12098 | 377 Ordinarily, commands that operate on text or move point do not care |
15761
77d451c08a30
Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
15074
diff
changeset
|
378 whether the text is invisible. The user-level line motion commands |
77d451c08a30
Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
15074
diff
changeset
|
379 explicitly ignore invisible newlines if |
77d451c08a30
Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
15074
diff
changeset
|
380 @code{line-move-ignore-invisible} is non-@code{nil}, but only because |
77d451c08a30
Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
15074
diff
changeset
|
381 they are explicitly programmed to do so. |
12098 | 382 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
383 Incremental search can make invisible overlays visible temporarily |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
384 and/or permanently when a match includes invisible text. To enable |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
385 this, the overlay should have a non-@code{nil} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
386 @code{isearch-open-invisible} property. The property value should be a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
387 function to be called with the overlay as an argument. This function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
388 should make the overlay visible permanently; it is used when the match |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
389 overlaps the overlay on exit from the search. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
390 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
391 During the search, such overlays are made temporarily visible by |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
392 temporarily modifying their invisible and intangible properties. If you |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
393 want this to be done differently for a certain overlays, give it a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
394 @code{isearch-open-invisible-temporary} property which is a function. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
395 The function is called with two arguments: the first is the overlay, and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
396 the second is @code{nil} to make the overlay visible or @code{t} to make |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
397 it invisible again. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
398 |
6598 | 399 @node Selective Display |
400 @section Selective Display | |
401 @cindex selective display | |
402 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
403 @dfn{Selective display} refers to a pair of related features for |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
404 hiding certain lines on the screen. |
6598 | 405 |
406 The first variant, explicit selective display, is designed for use in | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
407 a Lisp program: it controls which lines are hidden by altering the text. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
408 The invisible text feature (@pxref{Invisible Text}) has partially |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
409 replaced this feature. |
12067 | 410 |
411 In the second variant, the choice of lines to hide is made | |
12098 | 412 automatically based on indentation. This variant is designed to be a |
12067 | 413 user-level feature. |
6598 | 414 |
415 The way you control explicit selective display is by replacing a | |
9009 | 416 newline (control-j) with a carriage return (control-m). The text that |
6598 | 417 was formerly a line following that newline is now invisible. Strictly |
418 speaking, it is temporarily no longer a line at all, since only newlines | |
419 can separate lines; it is now part of the previous line. | |
420 | |
421 Selective display does not directly affect editing commands. For | |
422 example, @kbd{C-f} (@code{forward-char}) moves point unhesitatingly into | |
423 invisible text. However, the replacement of newline characters with | |
424 carriage return characters affects some editing commands. For example, | |
425 @code{next-line} skips invisible lines, since it searches only for | |
426 newlines. Modes that use selective display can also define commands | |
427 that take account of the newlines, or that make parts of the text | |
428 visible or invisible. | |
429 | |
430 When you write a selectively displayed buffer into a file, all the | |
431 control-m's are output as newlines. This means that when you next read | |
432 in the file, it looks OK, with nothing invisible. The selective display | |
433 effect is seen only within Emacs. | |
434 | |
435 @defvar selective-display | |
436 This buffer-local variable enables selective display. This means that | |
437 lines, or portions of lines, may be made invisible. | |
438 | |
439 @itemize @bullet | |
440 @item | |
441 If the value of @code{selective-display} is @code{t}, then any portion | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
442 of a line that follows a control-m is not displayed. This is explicit |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
443 selective display. |
6598 | 444 |
445 @item | |
446 If the value of @code{selective-display} is a positive integer, then | |
447 lines that start with more than that many columns of indentation are not | |
448 displayed. | |
449 @end itemize | |
450 | |
451 When some portion of a buffer is invisible, the vertical movement | |
452 commands operate as if that portion did not exist, allowing a single | |
453 @code{next-line} command to skip any number of invisible lines. | |
454 However, character movement commands (such as @code{forward-char}) do | |
455 not skip the invisible portion, and it is possible (if tricky) to insert | |
456 or delete text in an invisible portion. | |
457 | |
458 In the examples below, we show the @emph{display appearance} of the | |
459 buffer @code{foo}, which changes with the value of | |
460 @code{selective-display}. The @emph{contents} of the buffer do not | |
461 change. | |
462 | |
463 @example | |
464 @group | |
465 (setq selective-display nil) | |
466 @result{} nil | |
467 | |
468 ---------- Buffer: foo ---------- | |
469 1 on this column | |
470 2on this column | |
471 3n this column | |
472 3n this column | |
473 2on this column | |
474 1 on this column | |
475 ---------- Buffer: foo ---------- | |
476 @end group | |
477 | |
478 @group | |
479 (setq selective-display 2) | |
480 @result{} 2 | |
481 | |
482 ---------- Buffer: foo ---------- | |
483 1 on this column | |
484 2on this column | |
485 2on this column | |
486 1 on this column | |
487 ---------- Buffer: foo ---------- | |
488 @end group | |
489 @end example | |
490 @end defvar | |
491 | |
492 @defvar selective-display-ellipses | |
493 If this buffer-local variable is non-@code{nil}, then Emacs displays | |
494 @samp{@dots{}} at the end of a line that is followed by invisible text. | |
495 This example is a continuation of the previous one. | |
496 | |
497 @example | |
498 @group | |
499 (setq selective-display-ellipses t) | |
500 @result{} t | |
501 | |
502 ---------- Buffer: foo ---------- | |
503 1 on this column | |
504 2on this column ... | |
505 2on this column | |
506 1 on this column | |
507 ---------- Buffer: foo ---------- | |
508 @end group | |
509 @end example | |
510 | |
511 You can use a display table to substitute other text for the ellipsis | |
512 (@samp{@dots{}}). @xref{Display Tables}. | |
513 @end defvar | |
514 | |
515 @node Overlay Arrow | |
516 @section The Overlay Arrow | |
517 @cindex overlay arrow | |
518 | |
519 The @dfn{overlay arrow} is useful for directing the user's attention | |
520 to a particular line in a buffer. For example, in the modes used for | |
521 interface to debuggers, the overlay arrow indicates the line of code | |
522 about to be executed. | |
523 | |
524 @defvar overlay-arrow-string | |
9009 | 525 This variable holds the string to display to call attention to a |
526 particular line, or @code{nil} if the arrow feature is not in use. | |
6598 | 527 @end defvar |
528 | |
529 @defvar overlay-arrow-position | |
9009 | 530 This variable holds a marker that indicates where to display the overlay |
531 arrow. It should point at the beginning of a line. The arrow text | |
532 appears at the beginning of that line, overlaying any text that would | |
533 otherwise appear. Since the arrow is usually short, and the line | |
534 usually begins with indentation, normally nothing significant is | |
535 overwritten. | |
6598 | 536 |
9009 | 537 The overlay string is displayed only in the buffer that this marker |
6598 | 538 points into. Thus, only one buffer can have an overlay arrow at any |
539 given time. | |
540 @c !!! overlay-arrow-position: but the overlay string may remain in the display | |
541 @c of some other buffer until an update is required. This should be fixed | |
542 @c now. Is it? | |
543 @end defvar | |
544 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
545 You can do a similar job by creating an overlay with a |
12067 | 546 @code{before-string} property. @xref{Overlay Properties}. |
547 | |
6598 | 548 @node Temporary Displays |
549 @section Temporary Displays | |
550 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
551 Temporary displays are used by Lisp programs to put output into a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
552 buffer and then present it to the user for perusal rather than for |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
553 editing. Many help commands use this feature. |
6598 | 554 |
555 @defspec with-output-to-temp-buffer buffer-name forms@dots{} | |
556 This function executes @var{forms} while arranging to insert any | |
557 output they print into the buffer named @var{buffer-name}. The buffer | |
558 is then shown in some window for viewing, displayed but not selected. | |
559 | |
560 The string @var{buffer-name} specifies the temporary buffer, which | |
561 need not already exist. The argument must be a string, not a buffer. | |
562 The buffer is erased initially (with no questions asked), and it is | |
563 marked as unmodified after @code{with-output-to-temp-buffer} exits. | |
564 | |
565 @code{with-output-to-temp-buffer} binds @code{standard-output} to the | |
566 temporary buffer, then it evaluates the forms in @var{forms}. Output | |
567 using the Lisp output functions within @var{forms} goes by default to | |
568 that buffer (but screen display and messages in the echo area, although | |
569 they are ``output'' in the general sense of the word, are not affected). | |
570 @xref{Output Functions}. | |
571 | |
572 The value of the last form in @var{forms} is returned. | |
573 | |
574 @example | |
575 @group | |
576 ---------- Buffer: foo ---------- | |
577 This is the contents of foo. | |
578 ---------- Buffer: foo ---------- | |
579 @end group | |
580 | |
581 @group | |
582 (with-output-to-temp-buffer "foo" | |
583 (print 20) | |
584 (print standard-output)) | |
585 @result{} #<buffer foo> | |
586 | |
587 ---------- Buffer: foo ---------- | |
588 20 | |
589 | |
590 #<buffer foo> | |
591 | |
592 ---------- Buffer: foo ---------- | |
593 @end group | |
594 @end example | |
595 @end defspec | |
596 | |
597 @defvar temp-buffer-show-function | |
9009 | 598 If this variable is non-@code{nil}, @code{with-output-to-temp-buffer} |
6598 | 599 calls it as a function to do the job of displaying a help buffer. The |
600 function gets one argument, which is the buffer it should display. | |
601 @end defvar | |
602 | |
603 @defun momentary-string-display string position &optional char message | |
604 This function momentarily displays @var{string} in the current buffer at | |
605 @var{position}. It has no effect on the undo list or on the buffer's | |
606 modification status. | |
607 | |
608 The momentary display remains until the next input event. If the next | |
609 input event is @var{char}, @code{momentary-string-display} ignores it | |
610 and returns. Otherwise, that event remains buffered for subsequent use | |
611 as input. Thus, typing @var{char} will simply remove the string from | |
612 the display, while typing (say) @kbd{C-f} will remove the string from | |
613 the display and later (presumably) move point forward. The argument | |
614 @var{char} is a space by default. | |
615 | |
616 The return value of @code{momentary-string-display} is not meaningful. | |
617 | |
12098 | 618 If the string @var{string} does not contain control characters, you can |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
619 do the same job in a more general way by creating (and then subsequently |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
620 deleting) an overlay with a @code{before-string} property. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
621 @xref{Overlay Properties}. |
12098 | 622 |
6598 | 623 If @var{message} is non-@code{nil}, it is displayed in the echo area |
624 while @var{string} is displayed in the buffer. If it is @code{nil}, a | |
625 default message says to type @var{char} to continue. | |
626 | |
627 In this example, point is initially located at the beginning of the | |
628 second line: | |
629 | |
630 @example | |
631 @group | |
632 ---------- Buffer: foo ---------- | |
633 This is the contents of foo. | |
634 @point{}Second line. | |
635 ---------- Buffer: foo ---------- | |
636 @end group | |
637 | |
638 @group | |
639 (momentary-string-display | |
640 "**** Important Message! ****" | |
641 (point) ?\r | |
642 "Type RET when done reading") | |
643 @result{} t | |
644 @end group | |
645 | |
646 @group | |
647 ---------- Buffer: foo ---------- | |
648 This is the contents of foo. | |
649 **** Important Message! ****Second line. | |
650 ---------- Buffer: foo ---------- | |
651 | |
652 ---------- Echo Area ---------- | |
653 Type RET when done reading | |
654 ---------- Echo Area ---------- | |
655 @end group | |
656 @end example | |
657 @end defun | |
658 | |
659 @node Overlays | |
660 @section Overlays | |
661 @cindex overlays | |
662 | |
663 You can use @dfn{overlays} to alter the appearance of a buffer's text on | |
12098 | 664 the screen, for the sake of presentation features. An overlay is an |
665 object that belongs to a particular buffer, and has a specified | |
666 beginning and end. It also has properties that you can examine and set; | |
667 these affect the display of the text within the overlay. | |
6598 | 668 |
669 @menu | |
670 * Overlay Properties:: How to read and set properties. | |
671 What properties do to the screen display. | |
672 * Managing Overlays:: Creating, moving, finding overlays. | |
673 @end menu | |
674 | |
675 @node Overlay Properties | |
676 @subsection Overlay Properties | |
677 | |
678 Overlay properties are like text properties in some respects, but the | |
679 differences are more important than the similarities. Text properties | |
680 are considered a part of the text; overlays are specifically considered | |
681 not to be part of the text. Thus, copying text between various buffers | |
682 and strings preserves text properties, but does not try to preserve | |
683 overlays. Changing a buffer's text properties marks the buffer as | |
684 modified, while moving an overlay or changing its properties does not. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
685 Unlike text property changes, overlay changes are not recorded in the |
6598 | 686 buffer's undo list. |
687 | |
688 @table @code | |
689 @item priority | |
690 @kindex priority @r{(overlay property)} | |
691 This property's value (which should be a nonnegative number) determines | |
692 the priority of the overlay. The priority matters when two or more | |
693 overlays cover the same character and both specify a face for display; | |
694 the one whose @code{priority} value is larger takes priority over the | |
695 other, and its face attributes override the face attributes of the lower | |
696 priority overlay. | |
697 | |
698 Currently, all overlays take priority over text properties. Please | |
699 avoid using negative priority values, as we have not yet decided just | |
700 what they should mean. | |
701 | |
702 @item window | |
703 @kindex window @r{(overlay property)} | |
704 If the @code{window} property is non-@code{nil}, then the overlay | |
705 applies only on that window. | |
706 | |
12067 | 707 @item category |
708 @kindex category @r{(overlay property)} | |
709 If an overlay has a @code{category} property, we call it the | |
12098 | 710 @dfn{category} of the overlay. It should be a symbol. The properties |
12067 | 711 of the symbol serve as defaults for the properties of the overlay. |
712 | |
6598 | 713 @item face |
714 @kindex face @r{(overlay property)} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
715 This property controls the way text is displayed---for example, which |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
716 font and which colors. Its value is a face name or a list of face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
717 names. @xref{Faces}, for more information. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
718 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
719 If the property value is a list, elements may also have the form |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
720 @code{(foreground-color . @var{color-name})} or @code{(background-color |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
721 . @var{color-name})}. These elements specify just the foreground color |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
722 or just the background color; therefore, there is no need to create a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
723 face for each color that you want to use. |
6598 | 724 |
725 @item mouse-face | |
726 @kindex mouse-face @r{(overlay property)} | |
727 This property is used instead of @code{face} when the mouse is within | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
728 the range of the overlay. |
6598 | 729 |
730 @item modification-hooks | |
731 @kindex modification-hooks @r{(overlay property)} | |
732 This property's value is a list of functions to be called if any | |
733 character within the overlay is changed or if text is inserted strictly | |
12067 | 734 within the overlay. |
735 | |
736 The hook functions are called both before and after each change. | |
737 If the functions save the information they receive, and compare notes | |
738 between calls, they can determine exactly what change has been made | |
739 in the buffer text. | |
740 | |
741 When called before a change, each function receives four arguments: the | |
742 overlay, @code{nil}, and the beginning and end of the text range to be | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6598
diff
changeset
|
743 modified. |
6598 | 744 |
12067 | 745 When called after a change, each function receives five arguments: the |
746 overlay, @code{t}, the beginning and end of the text range just | |
747 modified, and the length of the pre-change text replaced by that range. | |
748 (For an insertion, the pre-change length is zero; for a deletion, that | |
749 length is the number of characters deleted, and the post-change | |
12098 | 750 beginning and end are equal.) |
12067 | 751 |
6598 | 752 @item insert-in-front-hooks |
753 @kindex insert-in-front-hooks @r{(overlay property)} | |
12067 | 754 This property's value is a list of functions to be called before and |
755 after inserting text right at the beginning of the overlay. The calling | |
756 conventions are the same as for the @code{modification-hooks} functions. | |
6598 | 757 |
758 @item insert-behind-hooks | |
759 @kindex insert-behind-hooks @r{(overlay property)} | |
12067 | 760 This property's value is a list of functions to be called before and |
761 after inserting text right at the end of the overlay. The calling | |
762 conventions are the same as for the @code{modification-hooks} functions. | |
6598 | 763 |
764 @item invisible | |
765 @kindex invisible @r{(overlay property)} | |
12067 | 766 The @code{invisible} property can make the text in the overlay |
767 invisible, which means that it does not appear on the screen. | |
768 @xref{Invisible Text}, for details. | |
769 | |
770 @item intangible | |
771 @kindex intangible @r{(overlay property)} | |
772 The @code{intangible} property on an overlay works just like the | |
12098 | 773 @code{intangible} text property. @xref{Special Properties}, for details. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
774 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
775 @item isearch-open-invisible |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
776 @itemx isearch-open-invisible-temporary |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
777 These properties control how incremental search should make invisible an |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
778 overlay visible, either permanently or temporarily. @xref{Invisible |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
779 Text}. |
6598 | 780 |
781 @item before-string | |
782 @kindex before-string @r{(overlay property)} | |
783 This property's value is a string to add to the display at the beginning | |
784 of the overlay. The string does not appear in the buffer in any | |
12067 | 785 sense---only on the screen. The string should contain only characters |
786 that display as a single column---control characters, including tabs or | |
787 newlines, will give strange results. | |
6598 | 788 |
789 @item after-string | |
790 @kindex after-string @r{(overlay property)} | |
791 This property's value is a string to add to the display at the end of | |
792 the overlay. The string does not appear in the buffer in any | |
12067 | 793 sense---only on the screen. The string should contain only characters |
794 that display as a single column---control characters, including tabs or | |
795 newlines, will give strange results. | |
796 | |
797 @item evaporate | |
798 @kindex evaporate @r{(overlay property)} | |
799 If this property is non-@code{nil}, the overlay is deleted automatically | |
800 if it ever becomes empty (i.e., if it spans no characters). | |
16123
ec5f48fe0320
Mention local-value property on an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
15761
diff
changeset
|
801 |
ec5f48fe0320
Mention local-value property on an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
15761
diff
changeset
|
802 @item local-map |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
803 @cindex keymap of character (and overlays) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
804 @kindex local-map @r{(overlay property)} |
16123
ec5f48fe0320
Mention local-value property on an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
15761
diff
changeset
|
805 If this property is non-@code{nil}, it specifies a keymap for a portion |
ec5f48fe0320
Mention local-value property on an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
15761
diff
changeset
|
806 of the text. The property's value replaces the buffer's local map, when |
ec5f48fe0320
Mention local-value property on an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
15761
diff
changeset
|
807 the character after point is within the overlay. @xref{Active Keymaps}. |
6598 | 808 @end table |
809 | |
810 These are the functions for reading and writing the properties of an | |
811 overlay. | |
812 | |
813 @defun overlay-get overlay prop | |
814 This function returns the value of property @var{prop} recorded in | |
12067 | 815 @var{overlay}, if any. If @var{overlay} does not record any value for |
816 that property, but it does have a @code{category} property which is a | |
817 symbol, that symbol's @var{prop} property is used. Otherwise, the value | |
818 is @code{nil}. | |
6598 | 819 @end defun |
820 | |
821 @defun overlay-put overlay prop value | |
822 This function sets the value of property @var{prop} recorded in | |
823 @var{overlay} to @var{value}. It returns @var{value}. | |
824 @end defun | |
825 | |
826 See also the function @code{get-char-property} which checks both | |
827 overlay properties and text properties for a given character. | |
828 @xref{Examining Properties}. | |
829 | |
830 @node Managing Overlays | |
831 @subsection Managing Overlays | |
832 | |
833 This section describes the functions to create, delete and move | |
834 overlays, and to examine their contents. | |
835 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
836 @defun make-overlay start end &optional buffer front-advance rear-advance |
9009 | 837 This function creates and returns an overlay that belongs to |
6598 | 838 @var{buffer} and ranges from @var{start} to @var{end}. Both @var{start} |
839 and @var{end} must specify buffer positions; they may be integers or | |
840 markers. If @var{buffer} is omitted, the overlay is created in the | |
841 current buffer. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
842 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
843 The arguments @var{front-advance} and @var{rear-advance} specify the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
844 insertion type for the start of the overlay and for the end of the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
845 overlay. @xref{Marker Insertion Types}. |
6598 | 846 @end defun |
847 | |
848 @defun overlay-start overlay | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
849 This function returns the position at which @var{overlay} starts, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
850 as an integer. |
6598 | 851 @end defun |
852 | |
853 @defun overlay-end overlay | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
854 This function returns the position at which @var{overlay} ends, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
855 as an integer. |
6598 | 856 @end defun |
857 | |
858 @defun overlay-buffer overlay | |
859 This function returns the buffer that @var{overlay} belongs to. | |
860 @end defun | |
861 | |
862 @defun delete-overlay overlay | |
863 This function deletes @var{overlay}. The overlay continues to exist as | |
864 a Lisp object, but ceases to be part of the buffer it belonged to, and | |
865 ceases to have any effect on display. | |
866 @end defun | |
867 | |
868 @defun move-overlay overlay start end &optional buffer | |
869 This function moves @var{overlay} to @var{buffer}, and places its bounds | |
870 at @var{start} and @var{end}. Both arguments @var{start} and @var{end} | |
871 must specify buffer positions; they may be integers or markers. If | |
872 @var{buffer} is omitted, the overlay stays in the same buffer. | |
873 | |
874 The return value is @var{overlay}. | |
875 | |
876 This is the only valid way to change the endpoints of an overlay. Do | |
877 not try modifying the markers in the overlay by hand, as that fails to | |
878 update other vital data structures and can cause some overlays to be | |
879 ``lost''. | |
880 @end defun | |
881 | |
882 @defun overlays-at pos | |
883 This function returns a list of all the overlays that contain position | |
884 @var{pos} in the current buffer. The list is in no particular order. | |
885 An overlay contains position @var{pos} if it begins at or before | |
886 @var{pos}, and ends after @var{pos}. | |
887 @end defun | |
888 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
889 @tindex overlays-in |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
890 @defun overlays-in beg end |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
891 This function returns a list of the overlays that overlap the region |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
892 @var{beg} through @var{end}. ``Overlap'' means that at least one |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
893 character is contained within the overlay and also contained within the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
894 specified region; however, empty overlays are included in the result if |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
895 they are located at @var{beg} or between @var{beg} and @var{end}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
896 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
897 |
6598 | 898 @defun next-overlay-change pos |
899 This function returns the buffer position of the next beginning or end | |
900 of an overlay, after @var{pos}. | |
901 @end defun | |
902 | |
12067 | 903 @defun previous-overlay-change pos |
904 This function returns the buffer position of the previous beginning or | |
905 end of an overlay, before @var{pos}. | |
906 @end defun | |
907 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
908 @node Width |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
909 @section Width |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
910 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
911 Since not all characters have the same width, these functions let you |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
912 check the width of a character. @xref{Primitive Indent}, and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
913 @ref{Screen Lines}, for related functions. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
914 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
915 @tindex char-width |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
916 @defun char-width char |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
917 This function returns the width in columns of the character @var{char}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
918 if it were displayed in the current buffer and the selected window. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
919 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
920 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
921 @tindex string-width |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
922 @defun string-width string |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
923 This function returns the width in columns of the string @var{string}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
924 if it were displayed in the current buffer and the selected window. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
925 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
926 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
927 @tindex truncate-string-to-width |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
928 @defun truncate-string-to-width string width &optional start-column padding |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
929 This function returns the part of @var{string} that fits within |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
930 @var{width} columns, as a new string. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
931 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
932 If @var{string} does not reach @var{width}, then the result ends where |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
933 @var{string} ends. If one multi-column character in @var{string} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
934 extends across the column @var{width}, that character is not included in |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
935 the result. Thus, the result can fall short of @var{width} but cannot |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
936 go beyond it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
937 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
938 The optional argument @var{start-column} specifies the starting column. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
939 If this is non-@code{nil}, then the first @var{start-column} columns of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
940 the string are omitted from the value. If one multi-column character in |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
941 @var{string} extends across the column @var{start-column}, that |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
942 character is not included. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
943 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
944 The optional argument @var{padding}, if non-@code{nil}, is a padding |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
945 character added at the beginning and end of the result string, to extend |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
946 it to exactly @var{width} columns. The padding character is used at the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
947 end of the result if it falls short of @var{width}. It is also used at |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
948 the beginning of the result if one multi-column character in |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
949 @var{string} extends across the column @var{start-column}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
950 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
951 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
952 (truncate-string-to-width "\tab\t" 12 4) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
953 @result{} "ab" |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
954 (truncate-string-to-width "\tab\t" 12 4 ?\ ) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
955 @result{} " ab " |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
956 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
957 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
958 |
6598 | 959 @node Faces |
960 @section Faces | |
961 @cindex face | |
962 | |
963 A @dfn{face} is a named collection of graphical attributes: font, | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
964 foreground color, background color, and optional underlining. Faces |
6598 | 965 control the display of text on the screen. |
966 | |
967 @cindex face id | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
968 Each face has its own @dfn{face number}, which distinguishes faces at |
6598 | 969 low levels within Emacs. However, for most purposes, you can refer to |
970 faces in Lisp programs by their names. | |
971 | |
12067 | 972 @defun facep object |
973 This function returns @code{t} if @var{object} is a face name symbol (or | |
974 if it is a vector of the kind used internally to record face data). It | |
975 returns @code{nil} otherwise. | |
976 @end defun | |
977 | |
6598 | 978 Each face name is meaningful for all frames, and by default it has the |
979 same meaning in all frames. But you can arrange to give a particular | |
980 face name a special meaning in one frame if you wish. | |
981 | |
982 @menu | |
983 * Standard Faces:: The faces Emacs normally comes with. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
984 * Defining Faces:: How to define a face with @code{defface}. |
6598 | 985 * Merging Faces:: How Emacs decides which face to use for a character. |
986 * Face Functions:: How to define and examine faces. | |
987 @end menu | |
988 | |
989 @node Standard Faces | |
990 @subsection Standard Faces | |
991 | |
992 This table lists all the standard faces and their uses. | |
993 | |
994 @table @code | |
995 @item default | |
996 @kindex default @r{(face name)} | |
997 This face is used for ordinary text. | |
998 | |
999 @item modeline | |
1000 @kindex modeline @r{(face name)} | |
1001 This face is used for mode lines and menu bars. | |
1002 | |
1003 @item region | |
1004 @kindex region @r{(face name)} | |
1005 This face is used for highlighting the region in Transient Mark mode. | |
1006 | |
1007 @item secondary-selection | |
1008 @kindex secondary-selection @r{(face name)} | |
1009 This face is used to show any secondary selection you have made. | |
1010 | |
1011 @item highlight | |
1012 @kindex highlight @r{(face name)} | |
1013 This face is meant to be used for highlighting for various purposes. | |
1014 | |
1015 @item underline | |
1016 @kindex underline @r{(face name)} | |
1017 This face underlines text. | |
1018 | |
1019 @item bold | |
1020 @kindex bold @r{(face name)} | |
1021 This face uses a bold font, if possible. It uses the bold variant of | |
1022 the frame's font, if it has one. It's up to you to choose a default | |
1023 font that has a bold variant, if you want to use one. | |
1024 | |
1025 @item italic | |
1026 @kindex italic @r{(face name)} | |
1027 This face uses the italic variant of the frame's font, if it has one. | |
1028 | |
1029 @item bold-italic | |
1030 @kindex bold-italic @r{(face name)} | |
1031 This face uses the bold italic variant of the frame's font, if it has | |
1032 one. | |
1033 @end table | |
1034 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1035 @node Defining Faces |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1036 @section Defining Faces |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1037 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1038 The way to define a new face is with @code{defface}. This creates a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1039 kind of customization item (@pxref{Customization}) which the user can |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1040 customize using the Customization buffer (@pxref{Easy Customization,,, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1041 emacs, The GNU Emacs Manual}). |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1042 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1043 @tindex defface |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1044 @defmac defface face spec doc [keyword value]... |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1045 Declare @var{face} as a customizable face that defaults according to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1046 @var{spec}. Do not quote the symbol @var{face}. The argument @var{doc} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1047 specifies the face documentation. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1048 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1049 When @code{defface} executes, it defines the face according to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1050 @var{spec}, then uses any customizations saved in the @file{.emacs} file |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1051 to override that specification. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1052 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1053 The purpose of @var{spec} is to specify how the face should appear on |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1054 different kinds of terminals. It should be an alist whose elements have |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1055 the form @code{(@var{display} @var{atts})}. The element's @sc{car}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1056 @var{display}, specifies a class of terminals. The @sc{cdr}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1057 @var{atts}, is a list of face attributes and their values; it specifies |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1058 what the face should look like on that kind of terminal. The possible |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1059 attributes are defined in the value of @code{custom-face-attributes}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1060 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1061 The @var{display} part of an element of @var{spec} determines which |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1062 frames the element applies to. If more than one element of @var{spec} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1063 matches a given frame, the first matching element is the only one used |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1064 for that frame. There are two possibilities for @var{display}: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1065 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1066 @table @asis |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1067 @item @code{t} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1068 This element of @var{spec} matches all frames. Therefore, any |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1069 subsequent elements of @var{spec} are never used. Normally |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1070 @code{t} is used in the last (or only) element of @var{spec}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1071 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1072 @item an list |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1073 If @var{display} is alist, each elements should have the form |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1074 @code{(@var{characteristic} @var{value}@dots{})}. Here |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1075 @var{characteristic} specifies a way of classifying frames, and the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1076 @var{value}s are possible classifications which @var{display} should |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1077 apply to. Here are the possible values of @var{characteristic}: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1078 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1079 @table @code |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1080 @item type |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1081 The kind of window system the frame uses---either @code{x}, @code{pc} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1082 (for the MS-DOS console), @code{w32} (for MS Windows 9X/NT), or |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1083 @code{tty}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1084 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1085 @item class |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1086 What kinds of colors the frame supports---either @code{color}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1087 @code{grayscale}, or @code{mono}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1088 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1089 @item background |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1090 The kind of background--- either @code{light} or @code{dark}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1091 @end table |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1092 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1093 If an element of @var{display} specifies more than one @var{value} for a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1094 given @var{characteristic}, any of those values is acceptable. If |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1095 @var{display} has more than one element, each element should specify a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1096 different @var{characteristic}; then @emph{each} characteristic of the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1097 frame must match one of the @var{value}s specified for it in |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1098 @var{display}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1099 @end table |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1100 @end defmac |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1101 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1102 Here's how the standard face @code{region} could be defined |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1103 with @code{defface}: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1104 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1105 @example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1106 (defface region |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1107 ((((class color) (background dark)) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1108 (:background "blue")) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1109 (t (:background "gray"))) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1110 "Used for displaying the region.") |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1111 @end example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1112 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1113 Internally, @code{defface} uses the symbol property |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1114 @code{face-defface-spec} to record the face attributes specified in |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1115 @code{defface}, @code{saved-face} for the attributes saved by the user |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1116 with the customization buffer, and @code{face-documentation} for the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1117 documentation string. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1118 |
6598 | 1119 @node Merging Faces |
1120 @subsection Merging Faces for Display | |
1121 | |
1122 Here are all the ways to specify which face to use for display of text: | |
1123 | |
1124 @itemize @bullet | |
1125 @item | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1126 With defaults. Each frame has a @dfn{default face}, which is used for |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1127 all text that doesn't somehow specify another face. (We may change this |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1128 in a forthcoming Emacs version to serve as a default for all text.) |
6598 | 1129 |
1130 @item | |
1131 With text properties. A character may have a @code{face} property; if so, | |
9009 | 1132 it is displayed with that face. @xref{Special Properties}. |
6598 | 1133 |
1134 If the character has a @code{mouse-face} property, that is used instead | |
1135 of the @code{face} property when the mouse is ``near enough'' to the | |
1136 character. | |
1137 | |
1138 @item | |
1139 With overlays. An overlay may have @code{face} and @code{mouse-face} | |
1140 properties too; they apply to all the text covered by the overlay. | |
1141 | |
1142 @item | |
12098 | 1143 With a region that is active. In Transient Mark mode, the region is |
1144 highlighted with a particular face (see @code{region-face}, below). | |
1145 | |
1146 @item | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1147 With special glyphs. Each glyph can specify a particular face |
6598 | 1148 number. @xref{Glyphs}. |
1149 @end itemize | |
1150 | |
1151 If these various sources together specify more than one face for a | |
1152 particular character, Emacs merges the attributes of the various faces | |
1153 specified. The attributes of the faces of special glyphs come first; | |
12098 | 1154 then comes the face for region highlighting, if appropriate; |
6598 | 1155 then come attributes of faces from overlays, followed by those from text |
1156 properties, and last the default face. | |
1157 | |
1158 When multiple overlays cover one character, an overlay with higher | |
1159 priority overrides those with lower priority. @xref{Overlays}. | |
1160 | |
1161 If an attribute such as the font or a color is not specified in any of | |
1162 the above ways, the frame's own font or color is used. | |
1163 | |
1164 @node Face Functions | |
1165 @subsection Functions for Working with Faces | |
1166 | |
1167 The attributes a face can specify include the font, the foreground | |
1168 color, the background color, and underlining. The face can also leave | |
1169 these unspecified by giving the value @code{nil} for them. | |
1170 | |
1171 Here are the primitives for creating and changing faces. | |
1172 | |
1173 @defun make-face name | |
1174 This function defines a new face named @var{name}, initially with all | |
1175 attributes @code{nil}. It does nothing if there is already a face named | |
1176 @var{name}. | |
1177 @end defun | |
1178 | |
1179 @defun face-list | |
1180 This function returns a list of all defined face names. | |
1181 @end defun | |
1182 | |
1183 @defun copy-face old-face new-name &optional frame new-frame | |
1184 This function defines the face @var{new-name} as a copy of the existing | |
1185 face named @var{old-face}. It creates the face @var{new-name} if that | |
1186 doesn't already exist. | |
1187 | |
1188 If the optional argument @var{frame} is given, this function applies | |
1189 only to that frame. Otherwise it applies to each frame individually, | |
1190 copying attributes from @var{old-face} in each frame to @var{new-face} | |
1191 in the same frame. | |
1192 | |
1193 If the optional argument @var{new-frame} is given, then @code{copy-face} | |
1194 copies the attributes of @var{old-face} in @var{frame} to @var{new-name} | |
1195 in @var{new-frame}. | |
1196 @end defun | |
1197 | |
1198 You can modify the attributes of an existing face with the following | |
1199 functions. If you specify @var{frame}, they affect just that frame; | |
1200 otherwise, they affect all frames as well as the defaults that apply to | |
1201 new frames. | |
1202 | |
1203 @defun set-face-foreground face color &optional frame | |
1204 @defunx set-face-background face color &optional frame | |
9009 | 1205 These functions set the foreground (or background, respectively) color |
1206 of face @var{face} to @var{color}. The argument @var{color} should be a | |
6598 | 1207 string, the name of a color. |
12098 | 1208 |
1209 Certain shades of gray are implemented by stipple patterns on | |
1210 black-and-white screens. | |
1211 @end defun | |
1212 | |
1213 @defun set-face-stipple face pattern &optional frame | |
1214 This function sets the background stipple pattern of face @var{face} to | |
1215 @var{pattern}. The argument @var{pattern} should be the name of a | |
1216 stipple pattern defined by the X server, or @code{nil} meaning don't use | |
1217 stipple. | |
1218 | |
1219 Normally there is no need to pay attention to stipple patterns, because | |
1220 they are used automatically to handle certain shades of gray. | |
6598 | 1221 @end defun |
1222 | |
1223 @defun set-face-font face font &optional frame | |
1224 This function sets the font of face @var{face}. The argument @var{font} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1225 should be a string. Note that if you set the font explicitly, the bold |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1226 and italic attributes cease to have any effect, because the precise font |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1227 that you specified is always used. |
18234
2e66f4ee4ca8
Add make-face-bold/italic and unbold/unitalic.
Richard M. Stallman <rms@gnu.org>
parents:
16123
diff
changeset
|
1228 @end defun |
2e66f4ee4ca8
Add make-face-bold/italic and unbold/unitalic.
Richard M. Stallman <rms@gnu.org>
parents:
16123
diff
changeset
|
1229 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1230 @tindex set-face-bold-p |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1231 @defun set-face-bold-p face bold-p &optional frame |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1232 This function sets the bold attribute of face @var{face}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1233 Non-@code{nil} means bold; @code{nil} means non-bold. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1234 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1235 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1236 @tindex set-face-italic-p |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1237 @defun set-face-italic-p face italic-p &optional frame |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1238 This function sets the italic attribute of face @var{face}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1239 Non-@code{nil} means italic; @code{nil} means non-italic. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1240 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1241 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1242 @defun set-face-underline-p face underline-p &optional frame |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1243 This function sets the underline attribute of face @var{face}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1244 Non-@code{nil} means do underline; @code{nil} means don't. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1245 @end defun |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1246 |
6598 | 1247 @defun invert-face face &optional frame |
1248 Swap the foreground and background colors of face @var{face}. If the | |
1249 face doesn't specify both foreground and background, then its foreground | |
9009 | 1250 and background are set to the default background and foreground, |
1251 respectively. | |
6598 | 1252 @end defun |
1253 | |
1254 These functions examine the attributes of a face. If you don't | |
1255 specify @var{frame}, they refer to the default data for new frames. | |
1256 | |
1257 @defun face-foreground face &optional frame | |
1258 @defunx face-background face &optional frame | |
9009 | 1259 These functions return the foreground color (or background color, |
1260 respectively) of face @var{face}, as a string. | |
6598 | 1261 @end defun |
1262 | |
12098 | 1263 @defun face-stipple face &optional frame |
1264 This function returns the name of the background stipple pattern of face | |
1265 @var{face}, or @code{nil} if it doesn't have one. | |
1266 @end defun | |
1267 | |
6598 | 1268 @defun face-font face &optional frame |
1269 This function returns the name of the font of face @var{face}. | |
1270 @end defun | |
1271 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1272 @tindex face-bold-p |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1273 @defun face-bold-p face &optional frame |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1274 This function returns the bold attribute of face @var{face}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1275 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1276 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1277 @tindex face-italic-p |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1278 @defun face-italic-p face &optional frame |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1279 This function returns the italic attribute of face @var{face}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1280 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1281 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1282 @defun face-underline-p face &optional frame |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1283 This function returns the underline attribute of face @var{face}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1284 @end defun |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1285 |
12098 | 1286 @defun face-id face |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1287 This function returns the face number of face @var{face}. |
6598 | 1288 @end defun |
1289 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1290 @tindex face-documentation |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1291 @defun face-documentation face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1292 This function returns the documentation string of face @var{face}, or |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1293 @code{nil} if none was specified for it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1294 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1295 |
6598 | 1296 @defun face-equal face1 face2 &optional frame |
1297 This returns @code{t} if the faces @var{face1} and @var{face2} have the | |
1298 same attributes for display. | |
1299 @end defun | |
1300 | |
1301 @defun face-differs-from-default-p face &optional frame | |
1302 This returns @code{t} if the face @var{face} displays differently from | |
1303 the default face. A face is considered to be ``the same'' as the normal | |
1304 face if each attribute is either the same as that of the default face or | |
1305 @code{nil} (meaning to inherit from the default). | |
1306 @end defun | |
1307 | |
1308 @defvar region-face | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1309 This variable's value specifies the face number to use to display characters |
6598 | 1310 in the region when it is active (in Transient Mark mode only). The face |
1311 thus specified takes precedence over all faces that come from text | |
1312 properties and overlays, for characters in the region. @xref{The Mark}, | |
1313 for more information about Transient Mark mode. | |
1314 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1315 Normally, the value is the face number of the face named @code{region}. |
6598 | 1316 @end defvar |
1317 | |
1318 @node Blinking | |
1319 @section Blinking Parentheses | |
1320 @cindex parenthesis matching | |
1321 @cindex blinking | |
1322 @cindex balancing parentheses | |
1323 @cindex close parenthesis | |
1324 | |
1325 This section describes the mechanism by which Emacs shows a matching | |
1326 open parenthesis when the user inserts a close parenthesis. | |
1327 | |
1328 @defvar blink-paren-function | |
1329 The value of this variable should be a function (of no arguments) to | |
1330 be called whenever a character with close parenthesis syntax is inserted. | |
1331 The value of @code{blink-paren-function} may be @code{nil}, in which | |
1332 case nothing is done. | |
1333 @end defvar | |
1334 | |
1335 @defvar blink-matching-paren | |
1336 If this variable is @code{nil}, then @code{blink-matching-open} does | |
1337 nothing. | |
1338 @end defvar | |
1339 | |
1340 @defvar blink-matching-paren-distance | |
1341 This variable specifies the maximum distance to scan for a matching | |
1342 parenthesis before giving up. | |
1343 @end defvar | |
1344 | |
12098 | 1345 @defvar blink-matching-paren-delay |
1346 This variable specifies the number of seconds for the cursor to remain | |
1347 at the matching parenthesis. A fraction of a second often gives | |
1348 good results, but the default is 1, which works on all systems. | |
1349 @end defvar | |
1350 | |
6598 | 1351 @defun blink-matching-open |
1352 This function is the default value of @code{blink-paren-function}. It | |
1353 assumes that point follows a character with close parenthesis syntax and | |
1354 moves the cursor momentarily to the matching opening character. If that | |
1355 character is not already on the screen, it displays the character's | |
1356 context in the echo area. To avoid long delays, this function does not | |
1357 search farther than @code{blink-matching-paren-distance} characters. | |
1358 | |
1359 Here is an example of calling this function explicitly. | |
1360 | |
1361 @smallexample | |
1362 @group | |
1363 (defun interactive-blink-matching-open () | |
1364 @c Do not break this line! -- rms. | |
1365 @c The first line of a doc string | |
1366 @c must stand alone. | |
1367 "Indicate momentarily the start of sexp before point." | |
1368 (interactive) | |
1369 @end group | |
1370 @group | |
1371 (let ((blink-matching-paren-distance | |
1372 (buffer-size)) | |
1373 (blink-matching-paren t)) | |
1374 (blink-matching-open))) | |
1375 @end group | |
1376 @end smallexample | |
1377 @end defun | |
1378 | |
1379 @node Inverse Video | |
1380 @section Inverse Video | |
1381 @cindex Inverse Video | |
1382 | |
1383 @defopt inverse-video | |
1384 @cindex highlighting | |
1385 This variable controls whether Emacs uses inverse video for all text | |
1386 on the screen. Non-@code{nil} means yes, @code{nil} means no. The | |
1387 default is @code{nil}. | |
1388 @end defopt | |
1389 | |
1390 @defopt mode-line-inverse-video | |
1391 This variable controls the use of inverse video for mode lines. If it | |
12098 | 1392 is non-@code{nil}, then mode lines are displayed in inverse video. |
1393 Otherwise, mode lines are displayed normally, just like text. The | |
1394 default is @code{t}. | |
1395 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1396 For window frames, this displays mode lines using the face named |
12098 | 1397 @code{modeline}, which is normally the inverse of the default face |
1398 unless you change it. | |
6598 | 1399 @end defopt |
1400 | |
1401 @node Usual Display | |
1402 @section Usual Display Conventions | |
1403 | |
1404 The usual display conventions define how to display each character | |
1405 code. You can override these conventions by setting up a display table | |
1406 (@pxref{Display Tables}). Here are the usual display conventions: | |
1407 | |
1408 @itemize @bullet | |
1409 @item | |
1410 Character codes 32 through 126 map to glyph codes 32 through 126. | |
1411 Normally this means they display as themselves. | |
1412 | |
1413 @item | |
1414 Character code 9 is a horizontal tab. It displays as whitespace | |
1415 up to a position determined by @code{tab-width}. | |
1416 | |
1417 @item | |
1418 Character code 10 is a newline. | |
1419 | |
1420 @item | |
1421 All other codes in the range 0 through 31, and code 127, display in one | |
9009 | 1422 of two ways according to the value of @code{ctl-arrow}. If it is |
6598 | 1423 non-@code{nil}, these codes map to sequences of two glyphs, where the |
1424 first glyph is the @sc{ASCII} code for @samp{^}. (A display table can | |
1425 specify a glyph to use instead of @samp{^}.) Otherwise, these codes map | |
1426 just like the codes in the range 128 to 255. | |
1427 | |
1428 @item | |
1429 Character codes 128 through 255 map to sequences of four glyphs, where | |
1430 the first glyph is the @sc{ASCII} code for @samp{\}, and the others are | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1431 digit characters representing the charatcer code in octal. (A display |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1432 table can specify a glyph to use instead of @samp{\}.) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1433 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1434 @item |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1435 Multibyte character codes above 256 are displayed as themselves, or as a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1436 question mark or empty box if the terminal cannot display that |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1437 character. |
6598 | 1438 @end itemize |
1439 | |
1440 The usual display conventions apply even when there is a display | |
1441 table, for any character whose entry in the active display table is | |
1442 @code{nil}. Thus, when you set up a display table, you need only | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1443 specify the characters for which you want special behavior. |
6598 | 1444 |
1445 These variables affect the way certain characters are displayed on the | |
1446 screen. Since they change the number of columns the characters occupy, | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1447 they also affect the indentation functions. These variables also affect |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1448 how the mode line is displayed; if you want to force redisplay of the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1449 mode line using the new values, call the function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1450 @code{force-mode-line-update} (@pxref{Mode Line Format}). |
6598 | 1451 |
1452 @defopt ctl-arrow | |
1453 @cindex control characters in display | |
1454 This buffer-local variable controls how control characters are | |
1455 displayed. If it is non-@code{nil}, they are displayed as a caret | |
1456 followed by the character: @samp{^A}. If it is @code{nil}, they are | |
1457 displayed as a backslash followed by three octal digits: @samp{\001}. | |
1458 @end defopt | |
1459 | |
1460 @c Following may have overfull hbox. | |
1461 @defvar default-ctl-arrow | |
1462 The value of this variable is the default value for @code{ctl-arrow} in | |
1463 buffers that do not override it. @xref{Default Value}. | |
1464 @end defvar | |
1465 | |
1466 @defopt tab-width | |
1467 The value of this variable is the spacing between tab stops used for | |
1468 displaying tab characters in Emacs buffers. The default is 8. Note | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1469 that this feature is completely independent of the user-settable tab |
6598 | 1470 stops used by the command @code{tab-to-tab-stop}. @xref{Indent Tabs}. |
1471 @end defopt | |
1472 | |
1473 @node Display Tables | |
1474 @section Display Tables | |
1475 | |
1476 @cindex display table | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1477 You can use the @dfn{display table} feature to control how all possible |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1478 character codes display on the screen. This is useful for displaying |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1479 European languages that have letters not in the @sc{ASCII} character |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1480 set. |
6598 | 1481 |
1482 The display table maps each character code into a sequence of | |
1483 @dfn{glyphs}, each glyph being an image that takes up one character | |
1484 position on the screen. You can also define how to display each glyph | |
1485 on your terminal, using the @dfn{glyph table}. | |
1486 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1487 Display tables affect how the mode line is displayed; if you want to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1488 force redisplay of the mode line using a new display table, call |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1489 @code{force-mode-line-update} (@pxref{Mode Line Format}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1490 |
6598 | 1491 @menu |
1492 * Display Table Format:: What a display table consists of. | |
1493 * Active Display Table:: How Emacs selects a display table to use. | |
1494 * Glyphs:: How to define a glyph, and what glyphs mean. | |
1495 @end menu | |
1496 | |
1497 @node Display Table Format | |
1498 @subsection Display Table Format | |
1499 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1500 A display table is actually char-table with subtype @code{display-table}. |
6598 | 1501 |
1502 @defun make-display-table | |
1503 This creates and returns a display table. The table initially has | |
1504 @code{nil} in all elements. | |
1505 @end defun | |
1506 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1507 The ordinary elements of the display table are indexed by character |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1508 codes; the element at index @var{c} says how to display the character |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1509 code @var{c}. The value should be @code{nil} or a vector of glyph |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1510 values (@pxref{Glyphs}). If an element is @code{nil}, it says to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1511 display that character according to the usual display conventions |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1512 (@pxref{Usual Display}). |
12067 | 1513 |
1514 If you use the display table to change the display of newline | |
1515 characters, the whole buffer will be displayed as one long ``line.'' | |
6598 | 1516 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1517 The display table also has six ``extra slots'' which serve special |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1518 purposes. Here is a table of their meanings; @code{nil} in any slot |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1519 means to use the default for that slot, as stated below. |
6598 | 1520 |
1521 @table @asis | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1522 @item 0 |
6598 | 1523 The glyph for the end of a truncated screen line (the default for this |
1524 is @samp{$}). @xref{Glyphs}. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1525 @item 1 |
6598 | 1526 The glyph for the end of a continued line (the default is @samp{\}). |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1527 @item 2 |
6598 | 1528 The glyph for indicating a character displayed as an octal character |
1529 code (the default is @samp{\}). | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1530 @item 3 |
6598 | 1531 The glyph for indicating a control character (the default is @samp{^}). |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1532 @item 4 |
6598 | 1533 A vector of glyphs for indicating the presence of invisible lines (the |
1534 default is @samp{...}). @xref{Selective Display}. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1535 @item 5 |
8925 | 1536 The glyph used to draw the border between side-by-side windows (the |
1537 default is @samp{|}). @xref{Splitting Windows}. | |
6598 | 1538 @end table |
1539 | |
1540 For example, here is how to construct a display table that mimics the | |
1541 effect of setting @code{ctl-arrow} to a non-@code{nil} value: | |
1542 | |
1543 @example | |
1544 (setq disptab (make-display-table)) | |
1545 (let ((i 0)) | |
1546 (while (< i 32) | |
1547 (or (= i ?\t) (= i ?\n) | |
1548 (aset disptab i (vector ?^ (+ i 64)))) | |
1549 (setq i (1+ i))) | |
1550 (aset disptab 127 (vector ?^ ??))) | |
1551 @end example | |
1552 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1553 @tindex display-table-slot |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1554 @defun display-table-slot display-table slot |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1555 This function returns the value of the extra slot @var{slot} of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1556 @var{display-table}. The argument @var{slot} may be a number from 0 to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1557 5 inclusive, or a slot name (symbol). Valid symbols are |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1558 @code{truncation}, @code{wrap}, @code{escape}, @code{control}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1559 @code{selective-display}, and @code{vertical-border}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1560 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1561 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1562 @tindex set-display-table-slot |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1563 @defun set-display-table-slot display-table slot value |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1564 This function stores @var{value} in the extra slot @var{slot} of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1565 @var{display-table}. The argument @var{slot} may be a number from 0 to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1566 5 inclusive, or a slot name (symbol). Valid symbols are |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1567 @code{truncation}, @code{wrap}, @code{escape}, @code{control}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1568 @code{selective-display}, and @code{vertical-border}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1569 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1570 |
6598 | 1571 @node Active Display Table |
1572 @subsection Active Display Table | |
1573 @cindex active display table | |
1574 | |
1575 Each window can specify a display table, and so can each buffer. When | |
1576 a buffer @var{b} is displayed in window @var{w}, display uses the | |
1577 display table for window @var{w} if it has one; otherwise, the display | |
1578 table for buffer @var{b} if it has one; otherwise, the standard display | |
1579 table if any. The display table chosen is called the @dfn{active} | |
1580 display table. | |
1581 | |
1582 @defun window-display-table window | |
1583 This function returns @var{window}'s display table, or @code{nil} | |
1584 if @var{window} does not have an assigned display table. | |
1585 @end defun | |
1586 | |
1587 @defun set-window-display-table window table | |
1588 This function sets the display table of @var{window} to @var{table}. | |
1589 The argument @var{table} should be either a display table or | |
1590 @code{nil}. | |
1591 @end defun | |
1592 | |
1593 @defvar buffer-display-table | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1594 This variable is automatically buffer-local in all buffers; its value in |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1595 a particular buffer specifies the display table for that buffer. If it |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1596 is @code{nil}, that means the buffer does not have an assigned display |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1597 table. |
6598 | 1598 @end defvar |
1599 | |
1600 @defvar standard-display-table | |
1601 This variable's value is the default display table, used whenever a | |
1602 window has no display table and neither does the buffer displayed in | |
1603 that window. This variable is @code{nil} by default. | |
1604 @end defvar | |
1605 | |
1606 If there is no display table to use for a particular window---that is, | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1607 if the window specifies none, its buffer specifies none, and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1608 @code{standard-display-table} is @code{nil}---then Emacs uses the usual |
6598 | 1609 display conventions for all character codes in that window. @xref{Usual |
1610 Display}. | |
1611 | |
1612 @node Glyphs | |
1613 @subsection Glyphs | |
1614 | |
1615 @cindex glyph | |
1616 A @dfn{glyph} is a generalization of a character; it stands for an | |
1617 image that takes up a single character position on the screen. Glyphs | |
1618 are represented in Lisp as integers, just as characters are. | |
1619 | |
1620 @cindex glyph table | |
1621 The meaning of each integer, as a glyph, is defined by the glyph | |
1622 table, which is the value of the variable @code{glyph-table}. | |
1623 | |
1624 @defvar glyph-table | |
1625 The value of this variable is the current glyph table. It should be a | |
1626 vector; the @var{g}th element defines glyph code @var{g}. If the value | |
1627 is @code{nil} instead of a vector, then all glyphs are simple (see | |
1628 below). | |
1629 @end defvar | |
1630 | |
1631 Here are the possible types of elements in the glyph table: | |
1632 | |
1633 @table @var | |
1634 @item string | |
1635 Send the characters in @var{string} to the terminal to output | |
1636 this glyph. This alternative is available on character terminals, | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1637 but not under a window system. |
6598 | 1638 |
1639 @item integer | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1640 Define this glyph code as an alias for glyph code @var{integer}. You |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1641 can use an alias to specify a face code for the glyph; see below. |
6598 | 1642 |
1643 @item @code{nil} | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1644 This glyph is simple. On an ordinary terminal, the glyph code mod |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1645 524288 is the character to output. In a window system, the glyph code |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1646 mod 524288 is the character to output, and the glyph code divided by |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1647 524288 specifies the face number (@pxref{Face Functions}) to use while |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1648 outputting it. (524288 is |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1649 @ifinfo |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1650 2**19.) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1651 @end ifinfo |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1652 @tex |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1653 $2^{19}$.) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1654 @end tex |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1655 @xref{Faces}. |
6598 | 1656 @end table |
1657 | |
1658 If a glyph code is greater than or equal to the length of the glyph | |
1659 table, that code is automatically simple. | |
1660 | |
1661 @node Beeping | |
1662 @section Beeping | |
1663 @cindex beeping | |
1664 @cindex bell | |
1665 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1666 This section describes how to make Emacs ring the bell (or blink the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1667 screen) to attract the user's attention. Be conservative about how |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1668 often you do this; frequent bells can become irritating. Also be |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1669 careful not to use just beeping when signaling an error is more |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1670 appropriate. (@xref{Errors}.) |
6598 | 1671 |
1672 @defun ding &optional dont-terminate | |
1673 @cindex keyboard macro termination | |
1674 This function beeps, or flashes the screen (see @code{visible-bell} below). | |
1675 It also terminates any keyboard macro currently executing unless | |
1676 @var{dont-terminate} is non-@code{nil}. | |
1677 @end defun | |
1678 | |
1679 @defun beep &optional dont-terminate | |
1680 This is a synonym for @code{ding}. | |
1681 @end defun | |
1682 | |
1683 @defvar visible-bell | |
1684 This variable determines whether Emacs should flash the screen to | |
1685 represent a bell. Non-@code{nil} means yes, @code{nil} means no. This | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1686 is effective on a window system, and on a character-only terminal |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1687 provided the terminal's Termcap entry defines the visible bell |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1688 capability (@samp{vb}). |
6598 | 1689 @end defvar |
1690 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1691 @tindex ring-bell-function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1692 @defvar ring-bell-function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1693 If this is non-@code{nil}, it specifies how Emacs should ``ring the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1694 bell.'' Its value should bea function of no arguments. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1695 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1696 |
6598 | 1697 @node Window Systems |
1698 @section Window Systems | |
1699 | |
1700 Emacs works with several window systems, most notably the X Window | |
1701 System. Both Emacs and X use the term ``window'', but use it | |
1702 differently. An Emacs frame is a single window as far as X is | |
1703 concerned; the individual Emacs windows are not known to X at all. | |
1704 | |
1705 @defvar window-system | |
1706 @cindex X Window System | |
1707 This variable tells Lisp programs what window system Emacs is running | |
1708 under. Its value should be a symbol such as @code{x} (if Emacs is | |
1709 running under X) or @code{nil} (if Emacs is running on an ordinary | |
1710 terminal). | |
1711 @end defvar | |
1712 | |
1713 @defvar window-setup-hook | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1714 This variable is a normal hook which Emacs runs after handling the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1715 initialization files. Emacs runs this hook after it has completed |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1716 loading your @file{.emacs} file, the default initialization file (if |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1717 any), and the terminal-specific Lisp code, and runring the hook |
6598 | 1718 @code{term-setup-hook}. |
1719 | |
1720 This hook is used for internal purposes: setting up communication with | |
1721 the window system, and creating the initial window. Users should not | |
1722 interfere with it. | |
1723 @end defvar |