Mercurial > emacs
annotate lispref/display.texi @ 56716:c126b8b6a314
* process.c (wait_reading_process_input): Clean up.
Add wait_for_cell, wait_proc, and just_wait_proc args
to avoid overloading `read_kbd' and `do_display' args.
Change read_kbd arg to int. All callers changed.
author | Kim F. Storm <storm@cua.dk> |
---|---|
date | Thu, 19 Aug 2004 13:57:17 +0000 |
parents | b190e160aa91 |
children | 714a83d1ea32 b9eee0a7bef5 |
rev | line source |
---|---|
6598 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
45745 | 3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2000, 2001, 2002 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
4 @c Free Software Foundation, Inc. |
6598 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/display | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
7 @node Display, Calendar, Processes, Top |
6598 | 8 @chapter Emacs Display |
9 | |
10 This chapter describes a number of features related to the display | |
11 that Emacs presents to the user. | |
12 | |
13 @menu | |
14 * Refresh Screen:: Clearing the screen and redrawing everything on it. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
15 * Forcing Redisplay:: Forcing redisplay. |
6598 | 16 * Truncation:: Folding or wrapping long text lines. |
17 * The Echo Area:: Where messages are displayed. | |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
18 * Warnings:: Displaying warning messages for the user. |
12067 | 19 * Invisible Text:: Hiding part of the buffer text. |
20 * Selective Display:: Hiding part of the buffer text (the old way). | |
6598 | 21 * Overlay Arrow:: Display of an arrow to indicate position. |
22 * Temporary Displays:: Displays that go away automatically. | |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
23 * Overlays:: Use overlays to highlight parts of the buffer. |
25875 | 24 * Width:: How wide a character or string is on the screen. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
25 * Faces:: A face defines a graphics style for text characters: |
25875 | 26 font, colors, etc. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
27 * Fringes:: Controlling window fringes. |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
28 * Scroll Bars:: Controlling vertical scroll bars. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
29 * Display Property:: Enabling special display features. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
30 * Images:: Displaying images in Emacs buffers. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
31 * Buttons:: Adding clickable buttons to Emacs buffers. |
6598 | 32 * Blinking:: How Emacs shows the matching open parenthesis. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
33 * Inverse Video:: Specifying how the screen looks. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
34 * Usual Display:: The usual conventions for displaying nonprinting chars. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
35 * Display Tables:: How to specify other conventions. |
6598 | 36 * Beeping:: Audible signal to the user. |
37 * Window Systems:: Which window system is being used. | |
38 @end menu | |
39 | |
40 @node Refresh Screen | |
41 @section Refreshing the Screen | |
42 | |
43 The function @code{redraw-frame} redisplays the entire contents of a | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
44 given frame (@pxref{Frames}). |
6598 | 45 |
46 @c Emacs 19 feature | |
47 @defun redraw-frame frame | |
48 This function clears and redisplays frame @var{frame}. | |
49 @end defun | |
50 | |
51 Even more powerful is @code{redraw-display}: | |
52 | |
53 @deffn Command redraw-display | |
54 This function clears and redisplays all visible frames. | |
55 @end deffn | |
56 | |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
57 This function forces certain windows to be redisplayed |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
58 but does not clear them. |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
59 |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
60 @defun force-window-update object |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
61 This function forces redisplay of some or all windows. If |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
62 @var{object} is a window, it forces redisplay of that window. If |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
63 @var{object} is a buffer or buffer name, it forces redisplay of all |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
64 windows displaying that buffer. If @var{object} is @code{nil}, it |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
65 forces redisplay of all windows. |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
66 @end defun |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
67 |
12098 | 68 Processing user input takes absolute priority over redisplay. If you |
69 call these functions when input is available, they do nothing | |
70 immediately, but a full redisplay does happen eventually---after all the | |
71 input has been processed. | |
72 | |
6598 | 73 Normally, suspending and resuming Emacs also refreshes the screen. |
74 Some terminal emulators record separate contents for display-oriented | |
75 programs such as Emacs and for ordinary sequential display. If you are | |
76 using such a terminal, you might want to inhibit the redisplay on | |
9009 | 77 resumption. |
6598 | 78 |
79 @defvar no-redraw-on-reenter | |
80 @cindex suspend (cf. @code{no-redraw-on-reenter}) | |
81 @cindex resume (cf. @code{no-redraw-on-reenter}) | |
82 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
|
83 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
|
84 to redraw, @code{nil} means redrawing is needed. The default is @code{nil}. |
6598 | 85 @end defvar |
86 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
87 @node Forcing Redisplay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
88 @section Forcing Redisplay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
89 @cindex forcing redisplay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
90 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
91 Emacs redisplay normally stops if input arrives, and does not happen |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
92 at all if input is available before it starts. Most of the time, this |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
93 is exactly what you want. However, you can prevent preemption by |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
94 binding @code{redisplay-dont-pause} to a non-@code{nil} value. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
95 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
96 @tindex redisplay-dont-pause |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
97 @defvar redisplay-dont-pause |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
98 If this variable is non-@code{nil}, pending input does not |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
99 prevent or halt redisplay; redisplay occurs, and finishes, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
100 regardless of whether input is available. This feature is available |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
101 as of Emacs 21. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
102 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
103 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
104 You can request a display update, but only if no input is pending, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
105 with @code{(sit-for 0)}. To force a display update even when input is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
106 pending, do this: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
107 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
108 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
109 (let ((redisplay-dont-pause t)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
110 (sit-for 0)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
111 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
112 |
6598 | 113 @node Truncation |
114 @section Truncation | |
115 @cindex line wrapping | |
116 @cindex continuation lines | |
117 @cindex @samp{$} in display | |
118 @cindex @samp{\} in display | |
119 | |
120 When a line of text extends beyond the right edge of a window, the | |
121 line can either be continued on the next screen line, or truncated to | |
122 one screen line. The additional screen lines used to display a long | |
123 text line are called @dfn{continuation} lines. Normally, a @samp{$} in | |
124 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
|
125 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
|
126 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
|
127 specify alternative indicators; see @ref{Display Tables}.) |
6598 | 128 |
42905
09cd352a779e
(Truncation, Overlay Arrow, Usual Display): Add index entries for fringe
Eli Zaretskii <eliz@gnu.org>
parents:
42888
diff
changeset
|
129 On a windowed display, the @samp{$} and @samp{\} indicators are |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
130 replaced with graphics bitmaps displayed in the window fringes |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
131 (@pxref{Fringes}). |
42905
09cd352a779e
(Truncation, Overlay Arrow, Usual Display): Add index entries for fringe
Eli Zaretskii <eliz@gnu.org>
parents:
42888
diff
changeset
|
132 |
6598 | 133 Note that continuation is different from filling; continuation happens |
134 on the screen only, not in the buffer contents, and it breaks a line | |
135 precisely at the right margin, not at a word boundary. @xref{Filling}. | |
136 | |
137 @defopt truncate-lines | |
138 This buffer-local variable controls how Emacs displays lines that extend | |
139 beyond the right edge of the window. The default is @code{nil}, which | |
140 specifies continuation. If the value is non-@code{nil}, then these | |
141 lines are truncated. | |
142 | |
143 If the variable @code{truncate-partial-width-windows} is non-@code{nil}, | |
144 then truncation is always used for side-by-side windows (within one | |
145 frame) regardless of the value of @code{truncate-lines}. | |
146 @end defopt | |
147 | |
12098 | 148 @defopt default-truncate-lines |
6598 | 149 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
|
150 buffers that do not have buffer-local values for it. |
12098 | 151 @end defopt |
6598 | 152 |
153 @defopt truncate-partial-width-windows | |
154 This variable controls display of lines that extend beyond the right | |
155 edge of the window, in side-by-side windows (@pxref{Splitting Windows}). | |
156 If it is non-@code{nil}, these lines are truncated; otherwise, | |
157 @code{truncate-lines} says what to do with them. | |
158 @end defopt | |
159 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
160 When horizontal scrolling (@pxref{Horizontal Scrolling}) is in use in |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
161 a window, that forces truncation. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
162 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
163 You can override the glyphs that indicate continuation or truncation |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
164 using the display table; see @ref{Display Tables}. |
6598 | 165 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
166 If your buffer contains @emph{very} long lines, and you use |
12067 | 167 continuation to display them, just thinking about them can make Emacs |
12098 | 168 redisplay slow. The column computation and indentation functions also |
169 become slow. Then you might find it advisable to set | |
170 @code{cache-long-line-scans} to @code{t}. | |
12067 | 171 |
172 @defvar cache-long-line-scans | |
173 If this variable is non-@code{nil}, various indentation and motion | |
12098 | 174 functions, and Emacs redisplay, cache the results of scanning the |
175 buffer, and consult the cache to avoid rescanning regions of the buffer | |
176 unless they are modified. | |
12067 | 177 |
12098 | 178 Turning on the cache slows down processing of short lines somewhat. |
12067 | 179 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
180 This variable is automatically buffer-local in every buffer. |
12067 | 181 @end defvar |
182 | |
6598 | 183 @node The Echo Area |
184 @section The Echo Area | |
185 @cindex error display | |
186 @cindex echo area | |
187 | |
12067 | 188 The @dfn{echo area} is used for displaying messages made with the |
6598 | 189 @code{message} primitive, and for echoing keystrokes. It is not the |
190 same as the minibuffer, despite the fact that the minibuffer appears | |
191 (when active) in the same place on the screen as the echo area. The | |
192 @cite{GNU Emacs Manual} specifies the rules for resolving conflicts | |
193 between the echo area and the minibuffer for use of that screen space | |
194 (@pxref{Minibuffer,, The Minibuffer, emacs, The GNU Emacs Manual}). | |
195 Error messages appear in the echo area; see @ref{Errors}. | |
196 | |
197 You can write output in the echo area by using the Lisp printing | |
198 functions with @code{t} as the stream (@pxref{Output Functions}), or as | |
199 follows: | |
200 | |
201 @defun message string &rest arguments | |
39205
cb857398a0e0
(The Echo Area) <message>: Document message-truncate-lines.
Eli Zaretskii <eliz@gnu.org>
parents:
39032
diff
changeset
|
202 This function displays a message in the echo area. The |
6598 | 203 argument @var{string} is similar to a C language @code{printf} control |
204 string. See @code{format} in @ref{String Conversion}, for the details | |
205 on the conversion specifications. @code{message} returns the | |
206 constructed string. | |
207 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
208 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
|
209 error stream, followed by a newline. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
210 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
211 If @var{string}, or strings among the @var{arguments}, have @code{face} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
212 text properties, these affect the way the message is displayed. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
213 |
6598 | 214 @c Emacs 19 feature |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
215 If @var{string} is @code{nil}, @code{message} clears the echo area; if |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
216 the echo area has been expanded automatically, this brings it back to |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
217 its normal size. If the minibuffer is active, this brings the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
218 minibuffer contents back onto the screen immediately. |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
219 |
39205
cb857398a0e0
(The Echo Area) <message>: Document message-truncate-lines.
Eli Zaretskii <eliz@gnu.org>
parents:
39032
diff
changeset
|
220 @vindex message-truncate-lines |
39221
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39217
diff
changeset
|
221 Normally, displaying a long message resizes the echo area to display |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39217
diff
changeset
|
222 the entire message. But if the variable @code{message-truncate-lines} |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39217
diff
changeset
|
223 is non-@code{nil}, the echo area does not resize, and the message is |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39217
diff
changeset
|
224 truncated to fit it, as in Emacs 20 and before. |
39205
cb857398a0e0
(The Echo Area) <message>: Document message-truncate-lines.
Eli Zaretskii <eliz@gnu.org>
parents:
39032
diff
changeset
|
225 |
6598 | 226 @example |
227 @group | |
228 (message "Minibuffer depth is %d." | |
229 (minibuffer-depth)) | |
230 @print{} Minibuffer depth is 0. | |
231 @result{} "Minibuffer depth is 0." | |
232 @end group | |
233 | |
234 @group | |
235 ---------- Echo Area ---------- | |
236 Minibuffer depth is 0. | |
237 ---------- Echo Area ---------- | |
238 @end group | |
239 @end example | |
32261
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
240 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
241 To automatically display a message in the echo area or in a pop-buffer, |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
242 depending on its size, use @code{display-message-or-buffer}. |
6598 | 243 @end defun |
244 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
245 @tindex with-temp-message |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
246 @defmac with-temp-message message &rest body |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
247 This construct displays a message in the echo area temporarily, during |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
248 the execution of @var{body}. It displays @var{message}, executes |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
249 @var{body}, then returns the value of the last body form while restoring |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
250 the previous echo area contents. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
251 @end defmac |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
252 |
22843
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
253 @defun message-or-box string &rest arguments |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
254 This function displays a message like @code{message}, but may display it |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
255 in a dialog box instead of the echo area. If this function is called in |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
256 a command that was invoked using the mouse---more precisely, if |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
257 @code{last-nonmenu-event} (@pxref{Command Loop Info}) is either |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
258 @code{nil} or a list---then it uses a dialog box or pop-up menu to |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
259 display the message. Otherwise, it uses the echo area. (This is the |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
260 same criterion that @code{y-or-n-p} uses to make a similar decision; see |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
261 @ref{Yes-or-No Queries}.) |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
262 |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
263 You can force use of the mouse or of the echo area by binding |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
264 @code{last-nonmenu-event} to a suitable value around the call. |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
265 @end defun |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
266 |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
267 @defun message-box string &rest arguments |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
268 This function displays a message like @code{message}, but uses a dialog |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
269 box (or a pop-up menu) whenever that is possible. If it is impossible |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
270 to use a dialog box or pop-up menu, because the terminal does not |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
271 support them, then @code{message-box} uses the echo area, like |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
272 @code{message}. |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
273 @end defun |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
274 |
32261
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
275 @defun display-message-or-buffer message &optional buffer-name not-this-window frame |
32840 | 276 @tindex display-message-or-buffer |
32261
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
277 This function displays the message @var{message}, which may be either a |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
278 string or a buffer. If it is shorter than the maximum height of the |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
279 echo area, as defined by @code{max-mini-window-height}, it is displayed |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
280 in the echo area, using @code{message}. Otherwise, |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
281 @code{display-buffer} is used to show it in a pop-up buffer. |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
282 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
283 Returns either the string shown in the echo area, or when a pop-up |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
284 buffer is used, the window used to display it. |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
285 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
286 If @var{message} is a string, then the optional argument |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
287 @var{buffer-name} is the name of the buffer used to display it when a |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
288 pop-up buffer is used, defaulting to @samp{*Message*}. In the case |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
289 where @var{message} is a string and displayed in the echo area, it is |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
290 not specified whether the contents are inserted into the buffer anyway. |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
291 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
292 The optional arguments @var{not-this-window} and @var{frame} are as for |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
293 @code{display-buffer}, and only used if a buffer is displayed. |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
294 @end defun |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
295 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
296 @defun current-message |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
297 This function returns the message currently being displayed in the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
298 echo area, or @code{nil} if there is none. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
299 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
300 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
301 @defvar cursor-in-echo-area |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
302 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
|
303 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
|
304 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
|
305 point---not in the echo area at all. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
306 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
307 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
|
308 for brief periods of time. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
309 @end defvar |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
310 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
311 @defvar echo-area-clear-hook |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
312 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
|
313 @code{(message nil)} or for any other reason. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
314 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
315 |
12067 | 316 Almost all the messages displayed in the echo area are also recorded |
317 in the @samp{*Messages*} buffer. | |
318 | |
319 @defopt message-log-max | |
320 This variable specifies how many lines to keep in the @samp{*Messages*} | |
321 buffer. The value @code{t} means there is no limit on how many lines to | |
322 keep. The value @code{nil} disables message logging entirely. Here's | |
323 how to display a message and prevent it from being logged: | |
324 | |
325 @example | |
326 (let (message-log-max) | |
327 (message @dots{})) | |
328 @end example | |
329 @end defopt | |
330 | |
12098 | 331 @defvar echo-keystrokes |
332 This variable determines how much time should elapse before command | |
27971 | 333 characters echo. Its value must be an integer or floating point number, |
334 which specifies the | |
12098 | 335 number of seconds to wait before echoing. If the user types a prefix |
336 key (such as @kbd{C-x}) and then delays this many seconds before | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
337 continuing, the prefix key is echoed in the echo area. (Once echoing |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
338 begins in a key sequence, all subsequent characters in the same key |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
339 sequence are echoed immediately.) |
12098 | 340 |
341 If the value is zero, then command input is not echoed. | |
342 @end defvar | |
343 | |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
344 @node Warnings |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
345 @section Reporting Warnings |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
346 @cindex warnings |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
347 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
348 @dfn{Warnings} are a facility for a program to inform the user of a |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
349 possible problem, but continue running. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
350 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
351 @menu |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
352 * Warning Basics:: Warnings concepts and functions to report them. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
353 * Warning Variables:: Variables programs bind to customize their warnings. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
354 * Warning Options:: Variables users set to control display of warnings. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
355 @end menu |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
356 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
357 @node Warning Basics |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
358 @subsection Warning Basics |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
359 @cindex severity level |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
360 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
361 Every warning has a textual message, which explains the problem for |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
362 the user, and a @dfn{severity level} which is a symbol. Here are the |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
363 possible severity levels, in order of decreasing severity, and their |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
364 meanings: |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
365 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
366 @table @code |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
367 @item :emergency |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
368 A problem that will seriously impair Emacs operation soon |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
369 if you do not attend to it promptly. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
370 @item :error |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
371 A report of data or circumstances that are inherently wrong. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
372 @item :warning |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
373 A report of data or circumstances that are not inherently wrong, but |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
374 raise suspicion of a possible problem. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
375 @item :debug |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
376 A report of information that may be useful if you are debugging. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
377 @end table |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
378 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
379 When your program encounters invalid input data, it can either |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
380 signal a Lisp error by calling @code{error} or @code{signal} or report |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
381 a warning with severity @code{:error}. Signaling a Lisp error is the |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
382 easiest thing to do, but it means the program cannot continue |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
383 processing. If you want to take the trouble to implement a way to |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
384 continue processing despite the bad data, then reporting a warning of |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
385 severity @code{:error} is the right way to inform the user of the |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
386 problem. For instance, the Emacs Lisp byte compiler can report an |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
387 error that way and continue compiling other functions. (If the |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
388 program signals a Lisp error and then handles it with |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
389 @code{condition-case}, the user won't see the error message; it could |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
390 show the message to the user by reporting it as a warning.) |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
391 |
52156
198af82c7606
(Warning Basics): Fix typo.
John Paul Wallington <jpw@pobox.com>
parents:
52141
diff
changeset
|
392 @cindex warning type |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
393 Each warning has a @dfn{warning type} to classify it. The type is a |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
394 list of symbols. The first symbol should be the custom group that you |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
395 use for the program's user options. For example, byte compiler |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
396 warnings use the warning type @code{(bytecomp)}. You can also |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
397 subcategorize the warnings, if you wish, by using more symbols in the |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
398 list. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
399 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
400 @defun display-warning type message &optional level buffer-name |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
401 This function reports a warning, using @var{message} as the message |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
402 and @var{type} as the warning type. @var{level} should be the |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
403 severity level, with @code{:warning} being the default. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
404 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
405 @var{buffer-name}, if non-@code{nil}, specifies the name of the buffer |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
406 for logging the warning. By default, it is @samp{*Warnings*}. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
407 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
408 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
409 @defun lwarn type level message &rest args |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
410 This function reports a warning using the value of @code{(format |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
411 @var{message} @var{args}...)} as the message. In other respects it is |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
412 equivalent to @code{display-warning}. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
413 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
414 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
415 @defun warn message &rest args |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
416 This function reports a warning using the value of @code{(format |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
417 @var{message} @var{args}...)} as the message, @code{(emacs)} as the |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
418 type, and @code{:warning} as the severity level. It exists for |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
419 compatibility only; we recommend not using it, because you should |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
420 specify a specific warning type. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
421 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
422 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
423 @node Warning Variables |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
424 @subsection Warning Variables |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
425 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
426 Programs can customize how their warnings appear by binding |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
427 the variables described in this section. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
428 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
429 @defvar warning-levels |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
430 This list defines the meaning and severity order of the warning |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
431 severity levels. Each element defines one severity level, |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
432 and they are arranged in order of decreasing severity. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
433 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
434 Each element has the form @code{(@var{level} @var{string} |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
435 @var{function})}, where @var{level} is the severity level it defines. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
436 @var{string} specifies the textual description of this level. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
437 @var{string} should use @samp{%s} to specify where to put the warning |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
438 type information, or it can omit the @samp{%s} so as not to include |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
439 that information. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
440 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
441 The optional @var{function}, if non-@code{nil}, is a function to call |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
442 with no arguments, to get the user's attention. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
443 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
444 Normally you should not change the value of this variable. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
445 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
446 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
447 @defvar warning-prefix-function |
54023 | 448 If non-@code{nil}, the value is a function to generate prefix text for |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
449 warnings. Programs can bind the variable to a suitable function. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
450 @code{display-warning} calls this function with the warnings buffer |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
451 current, and the function can insert text in it. That text becomes |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
452 the beginning of the warning message. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
453 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
454 The function is called with two arguments, the severity level and its |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
455 entry in @code{warning-levels}. It should return a list to use as the |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
456 entry (this value need not be an actual member of |
54023 | 457 @code{warning-levels}). By constructing this value, the function can |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
458 change the severity of the warning, or specify different handling for |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
459 a given severity level. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
460 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
461 If the variable's value is @code{nil} then there is no function |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
462 to call. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
463 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
464 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
465 @defvar warning-series |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
466 Programs can bind this variable to @code{t} to say that the next |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
467 warning should begin a series. When several warnings form a series, |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
468 that means to leave point on the first warning of the series, rather |
54023 | 469 than keep moving it for each warning so that it appears on the last one. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
470 The series ends when the local binding is unbound and |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
471 @code{warning-series} becomes @code{nil} again. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
472 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
473 The value can also be a symbol with a function definition. That is |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
474 equivalent to @code{t}, except that the next warning will also call |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
475 the function with no arguments with the warnings buffer current. The |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
476 function can insert text which will serve as a header for the series |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
477 of warnings. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
478 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
479 Once a series has begun, the value is a marker which points to the |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
480 buffer position in the warnings buffer of the start of the series. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
481 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
482 The variable's normal value is @code{nil}, which means to handle |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
483 each warning separately. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
484 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
485 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
486 @defvar warning-fill-prefix |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
487 When this variable is non-@code{nil}, it specifies a fill prefix to |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
488 use for filling each warning's text. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
489 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
490 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
491 @defvar warning-type-format |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
492 This variable specifies the format for displaying the warning type |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
493 in the warning message. The result of formatting the type this way |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
494 gets included in the message under the control of the string in the |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
495 entry in @code{warning-levels}. The default value is @code{" (%s)"}. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
496 If you bind it to @code{""} then the warning type won't appear at |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
497 all. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
498 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
499 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
500 @node Warning Options |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
501 @subsection Warning Options |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
502 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
503 These variables are used by users to control what happens |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
504 when a Lisp program reports a warning. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
505 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
506 @defopt warning-minimum-level |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
507 This user option specifies the minimum severity level that should be |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
508 shown immediately to the user. The default is @code{:warning}, which |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
509 means to immediately display all warnings except @code{:debug} |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
510 warnings. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
511 @end defopt |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
512 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
513 @defopt warning-minimum-log-level |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
514 This user option specifies the minimum severity level that should be |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
515 logged in the warnings buffer. The default is @code{:warning}, which |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
516 means to log all warnings except @code{:debug} warnings. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
517 @end defopt |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
518 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
519 @defopt warning-suppress-types |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
520 This list specifies which warning types should not be displayed |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
521 immediately for the user. Each element of the list should be a list |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
522 of symbols. If its elements match the first elements in a warning |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
523 type, then that warning is not displayed immediately. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
524 @end defopt |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
525 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
526 @defopt warning-suppress-log-types |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
527 This list specifies which warning types should not be logged in the |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
528 warnings buffer. Each element of the list should be a list of |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
529 symbols. If it matches the first few elements in a warning type, then |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
530 that warning is not logged. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
531 @end defopt |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
532 |
12067 | 533 @node Invisible Text |
534 @section Invisible Text | |
535 | |
536 @cindex invisible text | |
537 You can make characters @dfn{invisible}, so that they do not appear on | |
538 the screen, with the @code{invisible} property. This can be either a | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
539 text property (@pxref{Text Properties}) or a property of an overlay |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
540 (@pxref{Overlays}). |
12067 | 541 |
542 In the simplest case, any non-@code{nil} @code{invisible} property makes | |
543 a character invisible. This is the default case---if you don't alter | |
544 the default value of @code{buffer-invisibility-spec}, this is how the | |
48948
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
545 @code{invisible} property works. You should normally use @code{t} |
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
546 as the value of the @code{invisible} property if you don't plan |
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
547 to set @code{buffer-invisibility-spec} yourself. |
12067 | 548 |
549 More generally, you can use the variable @code{buffer-invisibility-spec} | |
550 to control which values of the @code{invisible} property make text | |
551 invisible. This permits you to classify the text into different subsets | |
552 in advance, by giving them different @code{invisible} values, and | |
553 subsequently make various subsets visible or invisible by changing the | |
554 value of @code{buffer-invisibility-spec}. | |
555 | |
556 Controlling visibility with @code{buffer-invisibility-spec} is | |
25875 | 557 especially useful in a program to display the list of entries in a |
558 database. It permits the implementation of convenient filtering | |
559 commands to view just a part of the entries in the database. Setting | |
560 this variable is very fast, much faster than scanning all the text in | |
561 the buffer looking for properties to change. | |
12067 | 562 |
563 @defvar buffer-invisibility-spec | |
564 This variable specifies which kinds of @code{invisible} properties | |
56233
e4e80ee3d6db
(Invisible Text): Setting buffer-invisibility-spec makes it buffer-local.
Richard M. Stallman <rms@gnu.org>
parents:
56185
diff
changeset
|
565 actually make a character invisible. Setting this variable makes it |
e4e80ee3d6db
(Invisible Text): Setting buffer-invisibility-spec makes it buffer-local.
Richard M. Stallman <rms@gnu.org>
parents:
56185
diff
changeset
|
566 buffer-local. |
12067 | 567 |
568 @table @asis | |
569 @item @code{t} | |
570 A character is invisible if its @code{invisible} property is | |
571 non-@code{nil}. This is the default. | |
572 | |
573 @item a list | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
574 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
|
575 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
|
576 the character is invisible. The list can have two kinds of elements: |
12067 | 577 |
578 @table @code | |
579 @item @var{atom} | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
580 A character is invisible if its @code{invisible} property value |
12067 | 581 is @var{atom} or if it is a list with @var{atom} as a member. |
582 | |
583 @item (@var{atom} . t) | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
584 A character is invisible if its @code{invisible} property value |
12067 | 585 is @var{atom} or if it is a list with @var{atom} as a member. |
586 Moreover, if this character is at the end of a line and is followed | |
587 by a visible newline, it displays an ellipsis. | |
588 @end table | |
589 @end table | |
590 @end defvar | |
591 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
592 Two functions are specifically provided for adding elements to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
593 @code{buffer-invisibility-spec} and removing elements from it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
594 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
595 @defun add-to-invisibility-spec element |
48948
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
596 This function adds the element @var{element} to |
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
597 @code{buffer-invisibility-spec} (if it is not already present in that |
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
598 list). If @code{buffer-invisibility-spec} was @code{t}, it changes to |
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
599 a list, @code{(t)}, so that text whose @code{invisible} property |
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
600 is @code{t} remains invisible. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
601 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
602 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
603 @defun remove-from-invisibility-spec element |
54023 | 604 This removes the element @var{element} from |
48948
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
605 @code{buffer-invisibility-spec}. This does nothing if @var{element} |
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
606 is not in the list. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
607 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
608 |
48948
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
609 A convention for use of @code{buffer-invisibility-spec} is that a |
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
610 major mode should use the mode's own name as an element of |
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
611 @code{buffer-invisibility-spec} and as the value of the |
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
612 @code{invisible} property: |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
613 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
614 @example |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
615 ;; @r{If you want to display an ellipsis:} |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
616 (add-to-invisibility-spec '(my-symbol . t)) |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
617 ;; @r{If you don't want ellipsis:} |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
618 (add-to-invisibility-spec 'my-symbol) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
619 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
620 (overlay-put (make-overlay beginning end) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
621 'invisible 'my-symbol) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
622 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
623 ;; @r{When done with the overlays:} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
624 (remove-from-invisibility-spec '(my-symbol . t)) |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
625 ;; @r{Or respectively:} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
626 (remove-from-invisibility-spec 'my-symbol) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
627 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
628 |
15761
77d451c08a30
Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
15074
diff
changeset
|
629 @vindex line-move-ignore-invisible |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
630 Ordinarily, functions 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
|
631 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
|
632 explicitly ignore invisible newlines if |
77d451c08a30
Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
15074
diff
changeset
|
633 @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
|
634 they are explicitly programmed to do so. |
12098 | 635 |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
636 However, if a command ends with point inside or immediately after |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
637 invisible text, the main editing loop moves point further forward or |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
638 further backward (in the same direction that the command already moved |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
639 it) until that condition is no longer true. Thus, if the command |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
640 moved point back into an invisible range, Emacs moves point back to |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
641 the beginning of that range, following the previous visible character. |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
642 If the command moved point forward into an invisible range, Emacs |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
643 moves point forward past the first visible character that follows the |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
644 invisible text. |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
645 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
646 Incremental search can make invisible overlays visible temporarily |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
647 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
|
648 this, the overlay should have a non-@code{nil} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
649 @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
|
650 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
|
651 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
|
652 overlaps the overlay on exit from the search. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
653 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
654 During the search, such overlays are made temporarily visible by |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
655 temporarily modifying their invisible and intangible properties. If you |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
656 want this to be done differently for a certain overlay, give it an |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
657 @code{isearch-open-invisible-temporary} property which is a function. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
658 The function is called with two arguments: the first is the overlay, and |
26986 | 659 the second is @code{nil} to make the overlay visible, or @code{t} to |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
660 make it invisible again. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
661 |
6598 | 662 @node Selective Display |
663 @section Selective Display | |
664 @cindex selective display | |
665 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
666 @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
|
667 hiding certain lines on the screen. |
6598 | 668 |
669 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
|
670 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
|
671 The invisible text feature (@pxref{Invisible Text}) has partially |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
672 replaced this feature. |
12067 | 673 |
674 In the second variant, the choice of lines to hide is made | |
12098 | 675 automatically based on indentation. This variant is designed to be a |
12067 | 676 user-level feature. |
6598 | 677 |
678 The way you control explicit selective display is by replacing a | |
9009 | 679 newline (control-j) with a carriage return (control-m). The text that |
6598 | 680 was formerly a line following that newline is now invisible. Strictly |
681 speaking, it is temporarily no longer a line at all, since only newlines | |
682 can separate lines; it is now part of the previous line. | |
683 | |
684 Selective display does not directly affect editing commands. For | |
685 example, @kbd{C-f} (@code{forward-char}) moves point unhesitatingly into | |
686 invisible text. However, the replacement of newline characters with | |
687 carriage return characters affects some editing commands. For example, | |
688 @code{next-line} skips invisible lines, since it searches only for | |
689 newlines. Modes that use selective display can also define commands | |
690 that take account of the newlines, or that make parts of the text | |
691 visible or invisible. | |
692 | |
693 When you write a selectively displayed buffer into a file, all the | |
694 control-m's are output as newlines. This means that when you next read | |
695 in the file, it looks OK, with nothing invisible. The selective display | |
696 effect is seen only within Emacs. | |
697 | |
698 @defvar selective-display | |
699 This buffer-local variable enables selective display. This means that | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
700 lines, or portions of lines, may be made invisible. |
6598 | 701 |
702 @itemize @bullet | |
703 @item | |
25875 | 704 If the value of @code{selective-display} is @code{t}, then the character |
705 control-m marks the start of invisible text; the control-m, and the rest | |
706 of the line following it, are not displayed. This is explicit selective | |
707 display. | |
6598 | 708 |
709 @item | |
710 If the value of @code{selective-display} is a positive integer, then | |
711 lines that start with more than that many columns of indentation are not | |
712 displayed. | |
713 @end itemize | |
714 | |
715 When some portion of a buffer is invisible, the vertical movement | |
716 commands operate as if that portion did not exist, allowing a single | |
717 @code{next-line} command to skip any number of invisible lines. | |
718 However, character movement commands (such as @code{forward-char}) do | |
719 not skip the invisible portion, and it is possible (if tricky) to insert | |
720 or delete text in an invisible portion. | |
721 | |
722 In the examples below, we show the @emph{display appearance} of the | |
723 buffer @code{foo}, which changes with the value of | |
724 @code{selective-display}. The @emph{contents} of the buffer do not | |
725 change. | |
726 | |
727 @example | |
728 @group | |
729 (setq selective-display nil) | |
730 @result{} nil | |
731 | |
732 ---------- Buffer: foo ---------- | |
733 1 on this column | |
734 2on this column | |
735 3n this column | |
736 3n this column | |
737 2on this column | |
738 1 on this column | |
739 ---------- Buffer: foo ---------- | |
740 @end group | |
741 | |
742 @group | |
743 (setq selective-display 2) | |
744 @result{} 2 | |
745 | |
746 ---------- Buffer: foo ---------- | |
747 1 on this column | |
748 2on this column | |
749 2on this column | |
750 1 on this column | |
751 ---------- Buffer: foo ---------- | |
752 @end group | |
753 @end example | |
754 @end defvar | |
755 | |
756 @defvar selective-display-ellipses | |
757 If this buffer-local variable is non-@code{nil}, then Emacs displays | |
758 @samp{@dots{}} at the end of a line that is followed by invisible text. | |
759 This example is a continuation of the previous one. | |
760 | |
761 @example | |
762 @group | |
763 (setq selective-display-ellipses t) | |
764 @result{} t | |
765 | |
766 ---------- Buffer: foo ---------- | |
767 1 on this column | |
768 2on this column ... | |
769 2on this column | |
770 1 on this column | |
771 ---------- Buffer: foo ---------- | |
772 @end group | |
773 @end example | |
774 | |
775 You can use a display table to substitute other text for the ellipsis | |
776 (@samp{@dots{}}). @xref{Display Tables}. | |
777 @end defvar | |
778 | |
779 @node Overlay Arrow | |
780 @section The Overlay Arrow | |
781 @cindex overlay arrow | |
782 | |
783 The @dfn{overlay arrow} is useful for directing the user's attention | |
784 to a particular line in a buffer. For example, in the modes used for | |
785 interface to debuggers, the overlay arrow indicates the line of code | |
786 about to be executed. | |
787 | |
788 @defvar overlay-arrow-string | |
9009 | 789 This variable holds the string to display to call attention to a |
790 particular line, or @code{nil} if the arrow feature is not in use. | |
29471 | 791 On a graphical display the contents of the string are ignored; instead a |
792 glyph is displayed in the fringe area to the left of the display area. | |
6598 | 793 @end defvar |
794 | |
795 @defvar overlay-arrow-position | |
9009 | 796 This variable holds a marker that indicates where to display the overlay |
29471 | 797 arrow. It should point at the beginning of a line. On a non-graphical |
798 display the arrow text | |
9009 | 799 appears at the beginning of that line, overlaying any text that would |
800 otherwise appear. Since the arrow is usually short, and the line | |
801 usually begins with indentation, normally nothing significant is | |
802 overwritten. | |
6598 | 803 |
9009 | 804 The overlay string is displayed only in the buffer that this marker |
6598 | 805 points into. Thus, only one buffer can have an overlay arrow at any |
806 given time. | |
807 @c !!! overlay-arrow-position: but the overlay string may remain in the display | |
808 @c of some other buffer until an update is required. This should be fixed | |
809 @c now. Is it? | |
810 @end defvar | |
811 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
812 You can do a similar job by creating an overlay with a |
12067 | 813 @code{before-string} property. @xref{Overlay Properties}. |
814 | |
6598 | 815 @node Temporary Displays |
816 @section Temporary Displays | |
817 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
818 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
|
819 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
|
820 editing. Many help commands use this feature. |
6598 | 821 |
822 @defspec with-output-to-temp-buffer buffer-name forms@dots{} | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
823 This function executes @var{forms} while arranging to insert any output |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
824 they print into the buffer named @var{buffer-name}, which is first |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
825 created if necessary, and put into Help mode. Finally, the buffer is |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
826 displayed in some window, but not selected. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
827 |
52923
41c0ac1a4ed4
(Temporary Displays): Add xref to `Documentation Tips'.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52903
diff
changeset
|
828 If the @var{forms} do not change the major mode in the output buffer, |
41c0ac1a4ed4
(Temporary Displays): Add xref to `Documentation Tips'.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52903
diff
changeset
|
829 so that it is still Help mode at the end of their execution, then |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
830 @code{with-output-to-temp-buffer} makes this buffer read-only at the |
52923
41c0ac1a4ed4
(Temporary Displays): Add xref to `Documentation Tips'.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52903
diff
changeset
|
831 end, and also scans it for function and variable names to make them |
53301
67874c814e45
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
832 into clickable cross-references. @xref{Docstring hyperlinks, , Tips |
67874c814e45
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
833 for Documentation Strings}, in particular the item on hyperlinks in |
67874c814e45
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
834 documentation strings, for more details. |
6598 | 835 |
836 The string @var{buffer-name} specifies the temporary buffer, which | |
837 need not already exist. The argument must be a string, not a buffer. | |
838 The buffer is erased initially (with no questions asked), and it is | |
839 marked as unmodified after @code{with-output-to-temp-buffer} exits. | |
840 | |
841 @code{with-output-to-temp-buffer} binds @code{standard-output} to the | |
842 temporary buffer, then it evaluates the forms in @var{forms}. Output | |
843 using the Lisp output functions within @var{forms} goes by default to | |
844 that buffer (but screen display and messages in the echo area, although | |
845 they are ``output'' in the general sense of the word, are not affected). | |
846 @xref{Output Functions}. | |
847 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
848 Several hooks are available for customizing the behavior |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
849 of this construct; they are listed below. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
850 |
6598 | 851 The value of the last form in @var{forms} is returned. |
852 | |
853 @example | |
854 @group | |
855 ---------- Buffer: foo ---------- | |
856 This is the contents of foo. | |
857 ---------- Buffer: foo ---------- | |
858 @end group | |
859 | |
860 @group | |
861 (with-output-to-temp-buffer "foo" | |
862 (print 20) | |
863 (print standard-output)) | |
864 @result{} #<buffer foo> | |
865 | |
866 ---------- Buffer: foo ---------- | |
867 20 | |
868 | |
869 #<buffer foo> | |
870 | |
871 ---------- Buffer: foo ---------- | |
872 @end group | |
873 @end example | |
874 @end defspec | |
875 | |
876 @defvar temp-buffer-show-function | |
9009 | 877 If this variable is non-@code{nil}, @code{with-output-to-temp-buffer} |
6598 | 878 calls it as a function to do the job of displaying a help buffer. The |
879 function gets one argument, which is the buffer it should display. | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
880 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
881 It is a good idea for this function to run @code{temp-buffer-show-hook} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
882 just as @code{with-output-to-temp-buffer} normally would, inside of |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
883 @code{save-selected-window} and with the chosen window and buffer |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
884 selected. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
885 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
886 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
887 @defvar temp-buffer-setup-hook |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
888 @tindex temp-buffer-setup-hook |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
889 This normal hook is run by @code{with-output-to-temp-buffer} before |
42082 | 890 evaluating @var{body}. When the hook runs, the temporary buffer is |
891 current. This hook is normally set up with a function to put the | |
892 buffer in Help mode. | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
893 @end defvar |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
894 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
895 @defvar temp-buffer-show-hook |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
896 This normal hook is run by @code{with-output-to-temp-buffer} after |
42082 | 897 displaying the temporary buffer. When the hook runs, the temporary buffer |
898 is current, and the window it was displayed in is selected. This hook | |
899 is normally set up with a function to make the buffer read only, and | |
900 find function names and variable names in it, provided the major mode | |
901 is Help mode. | |
6598 | 902 @end defvar |
903 | |
904 @defun momentary-string-display string position &optional char message | |
905 This function momentarily displays @var{string} in the current buffer at | |
906 @var{position}. It has no effect on the undo list or on the buffer's | |
907 modification status. | |
908 | |
909 The momentary display remains until the next input event. If the next | |
910 input event is @var{char}, @code{momentary-string-display} ignores it | |
911 and returns. Otherwise, that event remains buffered for subsequent use | |
912 as input. Thus, typing @var{char} will simply remove the string from | |
913 the display, while typing (say) @kbd{C-f} will remove the string from | |
914 the display and later (presumably) move point forward. The argument | |
915 @var{char} is a space by default. | |
916 | |
917 The return value of @code{momentary-string-display} is not meaningful. | |
918 | |
12098 | 919 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
|
920 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
|
921 deleting) an overlay with a @code{before-string} property. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
922 @xref{Overlay Properties}. |
12098 | 923 |
6598 | 924 If @var{message} is non-@code{nil}, it is displayed in the echo area |
925 while @var{string} is displayed in the buffer. If it is @code{nil}, a | |
926 default message says to type @var{char} to continue. | |
927 | |
928 In this example, point is initially located at the beginning of the | |
929 second line: | |
930 | |
931 @example | |
932 @group | |
933 ---------- Buffer: foo ---------- | |
934 This is the contents of foo. | |
935 @point{}Second line. | |
936 ---------- Buffer: foo ---------- | |
937 @end group | |
938 | |
939 @group | |
940 (momentary-string-display | |
941 "**** Important Message! ****" | |
942 (point) ?\r | |
943 "Type RET when done reading") | |
944 @result{} t | |
945 @end group | |
946 | |
947 @group | |
948 ---------- Buffer: foo ---------- | |
949 This is the contents of foo. | |
950 **** Important Message! ****Second line. | |
951 ---------- Buffer: foo ---------- | |
952 | |
953 ---------- Echo Area ---------- | |
954 Type RET when done reading | |
955 ---------- Echo Area ---------- | |
956 @end group | |
957 @end example | |
958 @end defun | |
959 | |
960 @node Overlays | |
961 @section Overlays | |
962 @cindex overlays | |
963 | |
964 You can use @dfn{overlays} to alter the appearance of a buffer's text on | |
12098 | 965 the screen, for the sake of presentation features. An overlay is an |
966 object that belongs to a particular buffer, and has a specified | |
967 beginning and end. It also has properties that you can examine and set; | |
968 these affect the display of the text within the overlay. | |
6598 | 969 |
54023 | 970 An overlays uses markers to record its beginning and end; thus, |
971 editing the text of the buffer adjusts the beginning and end of each | |
972 overlay so that it stays with the text. When you create the overlay, | |
973 you can specify whether text inserted at the beginning should be | |
974 inside the overlay or outside, and likewise for the end of the overlay. | |
975 | |
6598 | 976 @menu |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
977 * Overlay Properties:: How to read and set properties. |
6598 | 978 What properties do to the screen display. |
26698
73f718a9df4b
(Overlays): Add menu entry for Finding Overlays.
Dave Love <fx@gnu.org>
parents:
26696
diff
changeset
|
979 * Managing Overlays:: Creating and moving overlays. |
73f718a9df4b
(Overlays): Add menu entry for Finding Overlays.
Dave Love <fx@gnu.org>
parents:
26696
diff
changeset
|
980 * Finding Overlays:: Searching for overlays. |
6598 | 981 @end menu |
982 | |
983 @node Overlay Properties | |
984 @subsection Overlay Properties | |
985 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
986 Overlay properties are like text properties in that the properties that |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
987 alter how a character is displayed can come from either source. But in |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
988 most respects they are different. Text properties are considered a part |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
989 of the text; overlays are specifically considered not to be part of the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
990 text. Thus, copying text between various buffers and strings preserves |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
991 text properties, but does not try to preserve overlays. Changing a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
992 buffer's text properties marks the buffer as modified, while moving an |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
993 overlay or changing its properties does not. Unlike text property |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
994 changes, overlay changes are not recorded in the buffer's undo list. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
995 @xref{Text Properties}, for comparison. |
6598 | 996 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
997 These functions are used for reading and writing the properties of an |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
998 overlay: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
999 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1000 @defun overlay-get overlay prop |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1001 This function returns the value of property @var{prop} recorded in |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1002 @var{overlay}, if any. If @var{overlay} does not record any value for |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1003 that property, but it does have a @code{category} property which is a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1004 symbol, that symbol's @var{prop} property is used. Otherwise, the value |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1005 is @code{nil}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1006 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1007 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1008 @defun overlay-put overlay prop value |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1009 This function sets the value of property @var{prop} recorded in |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1010 @var{overlay} to @var{value}. It returns @var{value}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1011 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1012 |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1013 @defun overlay-properties overlay |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1014 This returns a copy of the property list of @var{overlay}. |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1015 @end defun |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1016 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1017 See also the function @code{get-char-property} which checks both |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1018 overlay properties and text properties for a given character. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1019 @xref{Examining Properties}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1020 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1021 Many overlay properties have special meanings; here is a table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1022 of them: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1023 |
6598 | 1024 @table @code |
1025 @item priority | |
1026 @kindex priority @r{(overlay property)} | |
52380
7a80a66265e6
(Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents:
52156
diff
changeset
|
1027 This property's value (which should be a nonnegative integer number) |
7a80a66265e6
(Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents:
52156
diff
changeset
|
1028 determines the priority of the overlay. The priority matters when two |
7a80a66265e6
(Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents:
52156
diff
changeset
|
1029 or more overlays cover the same character and both specify the same |
7a80a66265e6
(Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents:
52156
diff
changeset
|
1030 property; the one whose @code{priority} value is larger takes priority |
7a80a66265e6
(Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents:
52156
diff
changeset
|
1031 over the other. For the @code{face} property, the higher priority |
7a80a66265e6
(Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents:
52156
diff
changeset
|
1032 value does not completely replace the other; instead, its face |
7a80a66265e6
(Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents:
52156
diff
changeset
|
1033 attributes override the face attributes of the lower priority |
7a80a66265e6
(Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents:
52156
diff
changeset
|
1034 @code{face} property. |
6598 | 1035 |
1036 Currently, all overlays take priority over text properties. Please | |
1037 avoid using negative priority values, as we have not yet decided just | |
1038 what they should mean. | |
1039 | |
1040 @item window | |
1041 @kindex window @r{(overlay property)} | |
1042 If the @code{window} property is non-@code{nil}, then the overlay | |
1043 applies only on that window. | |
1044 | |
12067 | 1045 @item category |
1046 @kindex category @r{(overlay property)} | |
1047 If an overlay has a @code{category} property, we call it the | |
12098 | 1048 @dfn{category} of the overlay. It should be a symbol. The properties |
12067 | 1049 of the symbol serve as defaults for the properties of the overlay. |
1050 | |
6598 | 1051 @item face |
1052 @kindex face @r{(overlay property)} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1053 This property controls the way text is displayed---for example, which |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1054 font and which colors. @xref{Faces}, for more information. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1055 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1056 In the simplest case, the value is a face name. It can also be a list; |
25875 | 1057 then each element can be any of these possibilities: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1058 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1059 @itemize @bullet |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1060 @item |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1061 A face name (a symbol or string). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1062 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1063 @item |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1064 Starting in Emacs 21, a property list of face attributes. This has the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1065 form (@var{keyword} @var{value} @dots{}), where each @var{keyword} is a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1066 face attribute name and @var{value} is a meaningful value for that |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1067 attribute. With this feature, you do not need to create a face each |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1068 time you want to specify a particular attribute for certain text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1069 @xref{Face Attributes}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1070 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1071 @item |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1072 A cons cell of the form @code{(foreground-color . @var{color-name})} or |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1073 @code{(background-color . @var{color-name})}. These elements specify |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1074 just the foreground color or just the background color. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1075 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1076 @code{(foreground-color . @var{color-name})} is equivalent to |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1077 @code{(:foreground @var{color-name})}, and likewise for the background. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1078 @end itemize |
6598 | 1079 |
1080 @item mouse-face | |
1081 @kindex mouse-face @r{(overlay property)} | |
1082 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
|
1083 the range of the overlay. |
6598 | 1084 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1085 @item display |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1086 @kindex display @r{(overlay property)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1087 This property activates various features that change the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1088 way text is displayed. For example, it can make text appear taller |
38278 | 1089 or shorter, higher or lower, wider or narrower, or replaced with an image. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1090 @xref{Display Property}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1091 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1092 @item help-echo |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1093 @kindex help-echo @r{(text property)} |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
1094 If an overlay has a @code{help-echo} property, then when you move the |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
1095 mouse onto the text in the overlay, Emacs displays a help string in the |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
1096 echo area, or in the tooltip window. For details see @ref{Text |
45750
73b33fa2ec78
Delete "new in Emacs 21" note.
Richard M. Stallman <rms@gnu.org>
parents:
45745
diff
changeset
|
1097 help-echo}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1098 |
6598 | 1099 @item modification-hooks |
1100 @kindex modification-hooks @r{(overlay property)} | |
1101 This property's value is a list of functions to be called if any | |
1102 character within the overlay is changed or if text is inserted strictly | |
12067 | 1103 within the overlay. |
1104 | |
1105 The hook functions are called both before and after each change. | |
1106 If the functions save the information they receive, and compare notes | |
1107 between calls, they can determine exactly what change has been made | |
1108 in the buffer text. | |
1109 | |
1110 When called before a change, each function receives four arguments: the | |
1111 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
|
1112 modified. |
6598 | 1113 |
12067 | 1114 When called after a change, each function receives five arguments: the |
1115 overlay, @code{t}, the beginning and end of the text range just | |
1116 modified, and the length of the pre-change text replaced by that range. | |
1117 (For an insertion, the pre-change length is zero; for a deletion, that | |
1118 length is the number of characters deleted, and the post-change | |
12098 | 1119 beginning and end are equal.) |
12067 | 1120 |
6598 | 1121 @item insert-in-front-hooks |
1122 @kindex insert-in-front-hooks @r{(overlay property)} | |
12067 | 1123 This property's value is a list of functions to be called before and |
1124 after inserting text right at the beginning of the overlay. The calling | |
1125 conventions are the same as for the @code{modification-hooks} functions. | |
6598 | 1126 |
1127 @item insert-behind-hooks | |
1128 @kindex insert-behind-hooks @r{(overlay property)} | |
12067 | 1129 This property's value is a list of functions to be called before and |
1130 after inserting text right at the end of the overlay. The calling | |
1131 conventions are the same as for the @code{modification-hooks} functions. | |
6598 | 1132 |
1133 @item invisible | |
1134 @kindex invisible @r{(overlay property)} | |
12067 | 1135 The @code{invisible} property can make the text in the overlay |
1136 invisible, which means that it does not appear on the screen. | |
1137 @xref{Invisible Text}, for details. | |
1138 | |
1139 @item intangible | |
1140 @kindex intangible @r{(overlay property)} | |
1141 The @code{intangible} property on an overlay works just like the | |
12098 | 1142 @code{intangible} text property. @xref{Special Properties}, for details. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1143 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1144 @item isearch-open-invisible |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1145 This property tells incremental search how to make an invisible overlay |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1146 visible, permanently, if the final match overlaps it. @xref{Invisible |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1147 Text}. |
6598 | 1148 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1149 @item isearch-open-invisible-temporary |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1150 This property tells incremental search how to make an invisible overlay |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1151 visible, temporarily, during the search. @xref{Invisible Text}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1152 |
6598 | 1153 @item before-string |
1154 @kindex before-string @r{(overlay property)} | |
1155 This property's value is a string to add to the display at the beginning | |
1156 of the overlay. The string does not appear in the buffer in any | |
25875 | 1157 sense---only on the screen. |
6598 | 1158 |
1159 @item after-string | |
1160 @kindex after-string @r{(overlay property)} | |
1161 This property's value is a string to add to the display at the end of | |
1162 the overlay. The string does not appear in the buffer in any | |
25875 | 1163 sense---only on the screen. |
12067 | 1164 |
1165 @item evaporate | |
1166 @kindex evaporate @r{(overlay property)} | |
1167 If this property is non-@code{nil}, the overlay is deleted automatically | |
56451
b190e160aa91
(Overlay Properties): Adding `evaporate' prop deletes empty overlay immediately.
Richard M. Stallman <rms@gnu.org>
parents:
56437
diff
changeset
|
1168 if it becomes empty (i.e., if its length becomes zero). If you give |
b190e160aa91
(Overlay Properties): Adding `evaporate' prop deletes empty overlay immediately.
Richard M. Stallman <rms@gnu.org>
parents:
56437
diff
changeset
|
1169 an empty overlay a non-@code{nil} @code{evaporate} property, that deletes |
b190e160aa91
(Overlay Properties): Adding `evaporate' prop deletes empty overlay immediately.
Richard M. Stallman <rms@gnu.org>
parents:
56437
diff
changeset
|
1170 it immediately. |
16123
ec5f48fe0320
Mention local-value property on an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
15761
diff
changeset
|
1171 |
29102 | 1172 @item local-map |
29076 | 1173 @cindex keymap of character (and overlays) |
29102 | 1174 @kindex local-map @r{(overlay property)} |
29076 | 1175 If this property is non-@code{nil}, it specifies a keymap for a portion |
1176 of the text. The property's value replaces the buffer's local map, when | |
1177 the character after point is within the overlay. @xref{Active Keymaps}. | |
33996 | 1178 |
1179 @item keymap | |
1180 @kindex keymap @r{(overlay property)} | |
1181 The @code{keymap} property is similar to @code{local-map} but overrides the | |
1182 buffer's local map (and the map specified by the @code{local-map} | |
1183 property) rather than replacing it. | |
29076 | 1184 @end table |
1185 | |
6598 | 1186 @node Managing Overlays |
1187 @subsection Managing Overlays | |
1188 | |
1189 This section describes the functions to create, delete and move | |
1190 overlays, and to examine their contents. | |
1191 | |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1192 @defun overlayp object |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1193 This function returns @code{t} if @var{object} is an overlay. |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1194 @end defun |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1195 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1196 @defun make-overlay start end &optional buffer front-advance rear-advance |
9009 | 1197 This function creates and returns an overlay that belongs to |
6598 | 1198 @var{buffer} and ranges from @var{start} to @var{end}. Both @var{start} |
1199 and @var{end} must specify buffer positions; they may be integers or | |
1200 markers. If @var{buffer} is omitted, the overlay is created in the | |
1201 current buffer. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1202 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1203 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
|
1204 insertion type for the start of the overlay and for the end of the |
54023 | 1205 overlay, respectively. @xref{Marker Insertion Types}. If |
1206 @var{front-advance} is non-@code{nil}, text inserted at the beginning | |
1207 of the overlay is excluded from the overlay. If @var{read-advance} is | |
1208 non-@code{nil}, text inserted at the beginning of the overlay is | |
1209 included in the overlay. | |
6598 | 1210 @end defun |
1211 | |
1212 @defun overlay-start overlay | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1213 This function returns the position at which @var{overlay} starts, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1214 as an integer. |
6598 | 1215 @end defun |
1216 | |
1217 @defun overlay-end overlay | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1218 This function returns the position at which @var{overlay} ends, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1219 as an integer. |
6598 | 1220 @end defun |
1221 | |
1222 @defun overlay-buffer overlay | |
1223 This function returns the buffer that @var{overlay} belongs to. | |
1224 @end defun | |
1225 | |
1226 @defun delete-overlay overlay | |
1227 This function deletes @var{overlay}. The overlay continues to exist as | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1228 a Lisp object, and its property list is unchanged, but it ceases to be |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1229 attached to the buffer it belonged to, and ceases to have any effect on |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1230 display. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1231 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1232 A deleted overlay is not permanently disconnected. You can give it a |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1233 position in a buffer again by calling @code{move-overlay}. |
6598 | 1234 @end defun |
1235 | |
1236 @defun move-overlay overlay start end &optional buffer | |
1237 This function moves @var{overlay} to @var{buffer}, and places its bounds | |
1238 at @var{start} and @var{end}. Both arguments @var{start} and @var{end} | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1239 must specify buffer positions; they may be integers or markers. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1240 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1241 If @var{buffer} is omitted, @var{overlay} stays in the same buffer it |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1242 was already associated with; if @var{overlay} was deleted, it goes into |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1243 the current buffer. |
6598 | 1244 |
1245 The return value is @var{overlay}. | |
1246 | |
1247 This is the only valid way to change the endpoints of an overlay. Do | |
1248 not try modifying the markers in the overlay by hand, as that fails to | |
1249 update other vital data structures and can cause some overlays to be | |
1250 ``lost''. | |
1251 @end defun | |
1252 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1253 Here are some examples: |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1254 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1255 @example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1256 ;; @r{Create an overlay.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1257 (setq foo (make-overlay 1 10)) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1258 @result{} #<overlay from 1 to 10 in display.texi> |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1259 (overlay-start foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1260 @result{} 1 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1261 (overlay-end foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1262 @result{} 10 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1263 (overlay-buffer foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1264 @result{} #<buffer display.texi> |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1265 ;; @r{Give it a property we can check later.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1266 (overlay-put foo 'happy t) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1267 @result{} t |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1268 ;; @r{Verify the property is present.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1269 (overlay-get foo 'happy) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1270 @result{} t |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1271 ;; @r{Move the overlay.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1272 (move-overlay foo 5 20) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1273 @result{} #<overlay from 5 to 20 in display.texi> |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1274 (overlay-start foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1275 @result{} 5 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1276 (overlay-end foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1277 @result{} 20 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1278 ;; @r{Delete the overlay.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1279 (delete-overlay foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1280 @result{} nil |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1281 ;; @r{Verify it is deleted.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1282 foo |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1283 @result{} #<overlay in no buffer> |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1284 ;; @r{A deleted overlay has no position.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1285 (overlay-start foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1286 @result{} nil |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1287 (overlay-end foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1288 @result{} nil |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1289 (overlay-buffer foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1290 @result{} nil |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1291 ;; @r{Undelete the overlay.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1292 (move-overlay foo 1 20) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1293 @result{} #<overlay from 1 to 20 in display.texi> |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1294 ;; @r{Verify the results.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1295 (overlay-start foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1296 @result{} 1 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1297 (overlay-end foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1298 @result{} 20 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1299 (overlay-buffer foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1300 @result{} #<buffer display.texi> |
27331
be0a552c8320
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
1301 ;; @r{Moving and deleting the overlay does not change its properties.} |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1302 (overlay-get foo 'happy) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1303 @result{} t |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1304 @end example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1305 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1306 @node Finding Overlays |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1307 @subsection Searching for Overlays |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1308 |
6598 | 1309 @defun overlays-at pos |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1310 This function returns a list of all the overlays that cover the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1311 character at position @var{pos} in the current buffer. The list is in |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1312 no particular order. An overlay contains position @var{pos} if it |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1313 begins at or before @var{pos}, and ends after @var{pos}. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1314 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1315 To illustrate usage, here is a Lisp function that returns a list of the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1316 overlays that specify property @var{prop} for the character at point: |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1317 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1318 @smallexample |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1319 (defun find-overlays-specifying (prop) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1320 (let ((overlays (overlays-at (point))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1321 found) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1322 (while overlays |
37170
29f2615d958f
(Finding Overlays): Fix example code.
Gerd Moellmann <gerd@gnu.org>
parents:
36935
diff
changeset
|
1323 (let ((overlay (car overlays))) |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1324 (if (overlay-get overlay prop) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1325 (setq found (cons overlay found)))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1326 (setq overlays (cdr overlays))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1327 found)) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1328 @end smallexample |
6598 | 1329 @end defun |
1330 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1331 @defun overlays-in beg end |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1332 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
|
1333 @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
|
1334 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
|
1335 specified region; however, empty overlays are included in the result if |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1336 they are located at @var{beg}, or strictly between @var{beg} and @var{end}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1337 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1338 |
6598 | 1339 @defun next-overlay-change pos |
1340 This function returns the buffer position of the next beginning or end | |
1341 of an overlay, after @var{pos}. | |
1342 @end defun | |
1343 | |
12067 | 1344 @defun previous-overlay-change pos |
1345 This function returns the buffer position of the previous beginning or | |
1346 end of an overlay, before @var{pos}. | |
1347 @end defun | |
1348 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1349 Here's an easy way to use @code{next-overlay-change} to search for the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1350 next character which gets a non-@code{nil} @code{happy} property from |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1351 either its overlays or its text properties (@pxref{Property Search}): |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1352 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1353 @smallexample |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1354 (defun find-overlay-prop (prop) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1355 (save-excursion |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1356 (while (and (not (eobp)) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1357 (not (get-char-property (point) 'happy))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1358 (goto-char (min (next-overlay-change (point)) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1359 (next-single-property-change (point) 'happy)))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1360 (point))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1361 @end smallexample |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1362 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1363 @node Width |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1364 @section Width |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1365 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1366 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
|
1367 check the width of a character. @xref{Primitive Indent}, and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1368 @ref{Screen Lines}, for related functions. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1369 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1370 @defun char-width char |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1371 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
|
1372 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
|
1373 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1374 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1375 @defun string-width string |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1376 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
|
1377 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
|
1378 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1379 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1380 @defun truncate-string-to-width string width &optional start-column padding |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1381 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
|
1382 @var{width} columns, as a new string. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1383 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1384 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
|
1385 @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
|
1386 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
|
1387 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
|
1388 go beyond it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1389 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1390 The optional argument @var{start-column} specifies the starting column. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1391 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
|
1392 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
|
1393 @var{string} extends across the column @var{start-column}, that |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1394 character is not included. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1395 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1396 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
|
1397 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
|
1398 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
|
1399 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
|
1400 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
|
1401 @var{string} extends across the column @var{start-column}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1402 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1403 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1404 (truncate-string-to-width "\tab\t" 12 4) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1405 @result{} "ab" |
52002
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
1406 (truncate-string-to-width "\tab\t" 12 4 ?\s) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1407 @result{} " ab " |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1408 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1409 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1410 |
6598 | 1411 @node Faces |
1412 @section Faces | |
40469
aa8474236e9e
Index "faces" instead of "face".
Richard M. Stallman <rms@gnu.org>
parents:
40310
diff
changeset
|
1413 @cindex faces |
6598 | 1414 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1415 A @dfn{face} is a named collection of graphical attributes: font |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1416 family, foreground color, background color, optional underlining, and |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1417 many others. Faces are used in Emacs to control the style of display of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1418 particular parts of the text or the frame. |
6598 | 1419 |
1420 @cindex face id | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1421 Each face has its own @dfn{face number}, which distinguishes faces at |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1422 low levels within Emacs. However, for most purposes, you refer to |
6598 | 1423 faces in Lisp programs by their names. |
1424 | |
12067 | 1425 @defun facep object |
1426 This function returns @code{t} if @var{object} is a face name symbol (or | |
1427 if it is a vector of the kind used internally to record face data). It | |
1428 returns @code{nil} otherwise. | |
1429 @end defun | |
1430 | |
6598 | 1431 Each face name is meaningful for all frames, and by default it has the |
1432 same meaning in all frames. But you can arrange to give a particular | |
1433 face name a special meaning in one frame if you wish. | |
1434 | |
1435 @menu | |
1436 * Standard Faces:: The faces Emacs normally comes with. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1437 * Defining Faces:: How to define a face with @code{defface}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1438 * Face Attributes:: What is in a face? |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
1439 * Attribute Functions:: Functions to examine and set face attributes. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
1440 * Merging Faces:: How Emacs combines the faces specified for a character. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1441 * Font Selection:: Finding the best available font for a face. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
1442 * Face Functions:: How to define and examine faces. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1443 * Auto Faces:: Hook for automatic face assignment. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1444 * Font Lookup:: Looking up the names of available fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1445 and information about them. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1446 * Fontsets:: A fontset is a collection of fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1447 that handle a range of character sets. |
6598 | 1448 @end menu |
1449 | |
1450 @node Standard Faces | |
1451 @subsection Standard Faces | |
1452 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1453 This table lists all the standard faces and their uses. Most of them |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1454 are used for displaying certain parts of the frames or certain kinds of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1455 text; you can control how those places look by customizing these faces. |
6598 | 1456 |
1457 @table @code | |
1458 @item default | |
1459 @kindex default @r{(face name)} | |
1460 This face is used for ordinary text. | |
1461 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1462 @item mode-line |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1463 @kindex mode-line @r{(face name)} |
43262
af1ba8f61638
(Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents:
43099
diff
changeset
|
1464 This face is used for the mode line of the selected window, and for |
af1ba8f61638
(Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents:
43099
diff
changeset
|
1465 menu bars when toolkit menus are not used---but only if |
af1ba8f61638
(Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents:
43099
diff
changeset
|
1466 @code{mode-line-inverse-video} is non-@code{nil}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1467 |
6598 | 1468 @item modeline |
1469 @kindex modeline @r{(face name)} | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1470 This is an alias for the @code{mode-line} face, for compatibility with |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1471 old Emacs versions. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1472 |
43262
af1ba8f61638
(Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents:
43099
diff
changeset
|
1473 @item mode-line-inactive |
af1ba8f61638
(Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents:
43099
diff
changeset
|
1474 @kindex mode-line-inactive @r{(face name)} |
af1ba8f61638
(Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents:
43099
diff
changeset
|
1475 This face is used for mode lines of non-selected windows. |
43290 | 1476 This face inherits from @code{mode-line}, so changes |
1477 in that face affect all windows. | |
43262
af1ba8f61638
(Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents:
43099
diff
changeset
|
1478 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1479 @item header-line |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1480 @kindex header-line @r{(face name)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1481 This face is used for the header lines of windows that have them. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1482 |
25875 | 1483 @item menu |
1484 This face controls the display of menus, both their colors and their | |
1485 font. (This works only on certain systems.) | |
1486 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1487 @item fringe |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1488 @kindex fringe @r{(face name)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1489 This face controls the colors of window fringes, the thin areas on |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1490 either side that are used to display continuation and truncation glyphs. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1491 |
43099
761d92c0f64e
(Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents:
42905
diff
changeset
|
1492 @item minibuffer-prompt |
761d92c0f64e
(Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents:
42905
diff
changeset
|
1493 @kindex minibuffer-prompt @r{(face name)} |
761d92c0f64e
(Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents:
42905
diff
changeset
|
1494 @vindex minibuffer-prompt-properties |
761d92c0f64e
(Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents:
42905
diff
changeset
|
1495 This face is used for the text of minibuffer prompts. By default, |
761d92c0f64e
(Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents:
42905
diff
changeset
|
1496 Emacs automatically adds this face to the value of |
761d92c0f64e
(Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents:
42905
diff
changeset
|
1497 @code{minibuffer-prompt-properties}, which is a list of text |
761d92c0f64e
(Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents:
42905
diff
changeset
|
1498 properties used to display the prompt text. |
761d92c0f64e
(Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents:
42905
diff
changeset
|
1499 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1500 @item scroll-bar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1501 @kindex scroll-bar @r{(face name)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1502 This face controls the colors for display of scroll bars. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1503 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1504 @item tool-bar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1505 @kindex tool-bar @r{(face name)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1506 This face is used for display of the tool bar, if any. |
6598 | 1507 |
1508 @item region | |
1509 @kindex region @r{(face name)} | |
1510 This face is used for highlighting the region in Transient Mark mode. | |
1511 | |
1512 @item secondary-selection | |
1513 @kindex secondary-selection @r{(face name)} | |
1514 This face is used to show any secondary selection you have made. | |
1515 | |
1516 @item highlight | |
1517 @kindex highlight @r{(face name)} | |
1518 This face is meant to be used for highlighting for various purposes. | |
1519 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1520 @item trailing-whitespace |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1521 @kindex trailing-whitespace @r{(face name)} |
25875 | 1522 This face is used to display excess whitespace at the end of a line, |
1523 if @code{show-trailing-whitespace} is non-@code{nil}. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1524 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1525 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1526 In contrast, these faces are provided to change the appearance of text |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1527 in specific ways. You can use them on specific text, when you want |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1528 the effects they produce. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1529 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1530 @table @code |
6598 | 1531 @item bold |
1532 @kindex bold @r{(face name)} | |
1533 This face uses a bold font, if possible. It uses the bold variant of | |
1534 the frame's font, if it has one. It's up to you to choose a default | |
1535 font that has a bold variant, if you want to use one. | |
1536 | |
1537 @item italic | |
1538 @kindex italic @r{(face name)} | |
1539 This face uses the italic variant of the frame's font, if it has one. | |
1540 | |
1541 @item bold-italic | |
1542 @kindex bold-italic @r{(face name)} | |
1543 This face uses the bold italic variant of the frame's font, if it has | |
1544 one. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1545 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1546 @item underline |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1547 @kindex underline @r{(face name)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1548 This face underlines text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1549 |
38278 | 1550 @item fixed-pitch |
1551 @kindex fixed-pitch @r{(face name)} | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1552 This face forces use of a particular fixed-width font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1553 |
38278 | 1554 @item variable-pitch |
1555 @kindex variable-pitch @r{(face name)} | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1556 This face forces use of a particular variable-width font. It's |
25875 | 1557 reasonable to customize this to use a different variable-width font, if |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1558 you like, but you should not make it a fixed-width font. |
6598 | 1559 @end table |
1560 | |
25875 | 1561 @defvar show-trailing-whitespace |
1562 @tindex show-trailing-whitespace | |
1563 If this variable is non-@code{nil}, Emacs uses the | |
1564 @code{trailing-whitespace} face to display any spaces and tabs at the | |
1565 end of a line. | |
1566 @end defvar | |
1567 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1568 @node Defining Faces |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1569 @subsection Defining Faces |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1570 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1571 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
|
1572 kind of customization item (@pxref{Customization}) which the user can |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1573 customize using the Customization buffer (@pxref{Easy Customization,,, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1574 emacs, The GNU Emacs Manual}). |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1575 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1576 @defmac defface face spec doc [keyword value]... |
25875 | 1577 This declares @var{face} as a customizable face that defaults according |
1578 to @var{spec}. You should not quote the symbol @var{face}. The | |
1579 argument @var{doc} specifies the face documentation. The keywords you | |
1580 can use in @code{defface} are the same ones that are meaningful in both | |
1581 @code{defgroup} and @code{defcustom} (@pxref{Common Keywords}). | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1582 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1583 When @code{defface} executes, it defines the face according to |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1584 @var{spec}, then uses any customizations that were read from the |
25875 | 1585 init file (@pxref{Init File}) to override that specification. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1586 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1587 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
|
1588 different kinds of terminals. It should be an alist whose elements have |
25875 | 1589 the form @code{(@var{display} @var{atts})}. Each element's @sc{car}, |
1590 @var{display}, specifies a class of terminals. The element's second element, | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1591 @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
|
1592 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
|
1593 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
|
1594 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1595 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
|
1596 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
|
1597 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
|
1598 for that frame. There are two possibilities for @var{display}: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1599 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1600 @table @asis |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1601 @item @code{t} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1602 This element of @var{spec} matches all frames. Therefore, any |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1603 subsequent elements of @var{spec} are never used. Normally |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1604 @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
|
1605 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1606 @item a list |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1607 If @var{display} is a list, each element should have the form |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1608 @code{(@var{characteristic} @var{value}@dots{})}. Here |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1609 @var{characteristic} specifies a way of classifying frames, and the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1610 @var{value}s are possible classifications which @var{display} should |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1611 apply to. Here are the possible values of @var{characteristic}: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1612 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1613 @table @code |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1614 @item type |
32802
66f219c7e8ca
(Defining Faces): Document `graphic' display type in face specs.
Miles Bader <miles@gnu.org>
parents:
32552
diff
changeset
|
1615 The kind of window system the frame uses---either @code{graphic} (any |
66f219c7e8ca
(Defining Faces): Document `graphic' display type in face specs.
Miles Bader <miles@gnu.org>
parents:
32552
diff
changeset
|
1616 graphics-capable display), @code{x}, @code{pc} (for the MS-DOS console), |
66f219c7e8ca
(Defining Faces): Document `graphic' display type in face specs.
Miles Bader <miles@gnu.org>
parents:
32552
diff
changeset
|
1617 @code{w32} (for MS Windows 9X/NT), or @code{tty} (a non-graphics-capable |
66f219c7e8ca
(Defining Faces): Document `graphic' display type in face specs.
Miles Bader <miles@gnu.org>
parents:
32552
diff
changeset
|
1618 display). |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1619 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1620 @item class |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1621 What kinds of colors the frame supports---either @code{color}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1622 @code{grayscale}, or @code{mono}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1623 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1624 @item background |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1625 The kind of background---either @code{light} or @code{dark}. |
45745 | 1626 |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1627 @item min-colors |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1628 An integer that represents the minimum number of colors the frame should |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1629 support, it is compared with the result of @code{display-color-cells}. |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1630 |
45745 | 1631 @item supports |
46170 | 1632 Whether or not the frame can display the face attributes given in |
1633 @var{value}@dots{} (@pxref{Face Attributes}). See the documentation | |
1634 for the function @code{display-supports-face-attributes-p} for more | |
1635 information on exactly how this testing is done. @xref{Display Face | |
1636 Attribute Testing}. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1637 @end table |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1638 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1639 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
|
1640 given @var{characteristic}, any of those values is acceptable. If |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1641 @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
|
1642 different @var{characteristic}; then @emph{each} characteristic of the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1643 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
|
1644 @var{display}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1645 @end table |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1646 @end defmac |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1647 |
25875 | 1648 Here's how the standard face @code{region} is defined: |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1649 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1650 @example |
25875 | 1651 @group |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1652 '((((class color) (min-colors 88) (background dark)) |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1653 :background "blue3") |
25875 | 1654 @end group |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1655 (((class color) (min-colors 88) (background light)) |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1656 :background "lightgoldenrod2") |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1657 (((class color) (min-colors 16) (background dark)) |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1658 :background "blue3") |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1659 (((class color) (min-colors 16) (background light)) |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1660 :background "lightgoldenrod2") |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1661 (((class color) (min-colors 8)) |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1662 :background "blue" :foreground "white") |
25875 | 1663 (((type tty) (class mono)) |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1664 :inverse-video t) |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1665 (t :background "gray")) |
25875 | 1666 @group |
1667 "Basic face for highlighting the region." | |
1668 :group 'basic-faces) | |
1669 @end group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1670 @end example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1671 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1672 Internally, @code{defface} uses the symbol property |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1673 @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
|
1674 @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
|
1675 with the customization buffer, and @code{face-documentation} for the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1676 documentation string. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1677 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1678 @defopt frame-background-mode |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1679 This option, if non-@code{nil}, specifies the background type to use for |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1680 interpreting face definitions. If it is @code{dark}, then Emacs treats |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1681 all frames as if they had a dark background, regardless of their actual |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1682 background colors. If it is @code{light}, then Emacs treats all frames |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1683 as if they had a light background. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1684 @end defopt |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1685 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1686 @node Face Attributes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1687 @subsection Face Attributes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1688 @cindex face attributes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1689 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1690 The effect of using a face is determined by a fixed set of @dfn{face |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1691 attributes}. This table lists all the face attributes, and what they |
25875 | 1692 mean. Note that in general, more than one face can be specified for a |
1693 given piece of text; when that happens, the attributes of all the faces | |
1694 are merged to specify how to display the text. @xref{Merging Faces}. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1695 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1696 In Emacs 21, any attribute in a face can have the value |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1697 @code{unspecified}. This means the face doesn't specify that attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1698 In face merging, when the first face fails to specify a particular |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1699 attribute, that means the next face gets a chance. However, the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1700 @code{default} face must specify all attributes. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1701 |
25875 | 1702 Some of these font attributes are meaningful only on certain kinds of |
1703 displays---if your display cannot handle a certain attribute, the | |
1704 attribute is ignored. (The attributes @code{:family}, @code{:width}, | |
1705 @code{:height}, @code{:weight}, and @code{:slant} correspond to parts of | |
1706 an X Logical Font Descriptor.) | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1707 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1708 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1709 @item :family |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1710 Font family name, or fontset name (@pxref{Fontsets}). If you specify a |
25875 | 1711 font family name, the wild-card characters @samp{*} and @samp{?} are |
1712 allowed. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1713 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1714 @item :width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1715 Relative proportionate width, also known as the character set width or |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1716 set width. This should be one of the symbols @code{ultra-condensed}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1717 @code{extra-condensed}, @code{condensed}, @code{semi-condensed}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1718 @code{normal}, @code{semi-expanded}, @code{expanded}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1719 @code{extra-expanded}, or @code{ultra-expanded}. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1720 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1721 @item :height |
32089
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1722 Either the font height, an integer in units of 1/10 point, a floating |
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1723 point number specifying the amount by which to scale the height of any |
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1724 underlying face, or a function, which is called with the old height |
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1725 (from the underlying face), and should return the new height. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1726 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1727 @item :weight |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1728 Font weight---a symbol from this series (from most dense to most faint): |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1729 @code{ultra-bold}, @code{extra-bold}, @code{bold}, @code{semi-bold}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1730 @code{normal}, @code{semi-light}, @code{light}, @code{extra-light}, |
25875 | 1731 or @code{ultra-light}. |
25809
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1732 |
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1733 On a text-only terminal, any weight greater than normal is displayed as |
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1734 extra bright, and any weight less than normal is displayed as |
25875 | 1735 half-bright (provided the terminal supports the feature). |
1736 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1737 @item :slant |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1738 Font slant---one of the symbols @code{italic}, @code{oblique}, @code{normal}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1739 @code{reverse-italic}, or @code{reverse-oblique}. |
25809
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1740 |
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1741 On a text-only terminal, slanted text is displayed as half-bright, if |
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1742 the terminal supports the feature. |
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1743 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1744 @item :foreground |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1745 Foreground color, a string. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1746 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1747 @item :background |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1748 Background color, a string. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1749 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1750 @item :inverse-video |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1751 Whether or not characters should be displayed in inverse video. The |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1752 value should be @code{t} (yes) or @code{nil} (no). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1753 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1754 @item :stipple |
25875 | 1755 The background stipple, a bitmap. |
1756 | |
1757 The value can be a string; that should be the name of a file containing | |
1758 external-format X bitmap data. The file is found in the directories | |
1759 listed in the variable @code{x-bitmap-file-path}. | |
1760 | |
40310
34f1a01f25fa
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
39404
diff
changeset
|
1761 Alternatively, the value can specify the bitmap directly, with a list |
34f1a01f25fa
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
39404
diff
changeset
|
1762 of the form @code{(@var{width} @var{height} @var{data})}. Here, |
34f1a01f25fa
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
39404
diff
changeset
|
1763 @var{width} and @var{height} specify the size in pixels, and |
34f1a01f25fa
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
39404
diff
changeset
|
1764 @var{data} is a string containing the raw bits of the bitmap, row by |
34f1a01f25fa
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
39404
diff
changeset
|
1765 row. Each row occupies @math{(@var{width} + 7) / 8} consecutive bytes |
34f1a01f25fa
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
39404
diff
changeset
|
1766 in the string (which should be a unibyte string for best results). |
34f1a01f25fa
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
39404
diff
changeset
|
1767 This means that each row always occupies at least one whole byte. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1768 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1769 If the value is @code{nil}, that means use no stipple pattern. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1770 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1771 Normally you do not need to set the stipple attribute, because it is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1772 used automatically to handle certain shades of gray. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1773 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1774 @item :underline |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1775 Whether or not characters should be underlined, and in what color. If |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1776 the value is @code{t}, underlining uses the foreground color of the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1777 face. If the value is a string, underlining uses that color. The |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1778 value @code{nil} means do not underline. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1779 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1780 @item :overline |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1781 Whether or not characters should be overlined, and in what color. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1782 The value is used like that of @code{:underline}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1783 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1784 @item :strike-through |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1785 Whether or not characters should be strike-through, and in what |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1786 color. The value is used like that of @code{:underline}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1787 |
32089
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1788 @item :inherit |
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1789 The name of a face from which to inherit attributes, or a list of face |
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1790 names. Attributes from inherited faces are merged into the face like an |
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1791 underlying face would be, with higher priority than underlying faces. |
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1792 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1793 @item :box |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1794 Whether or not a box should be drawn around characters, its color, the |
25875 | 1795 width of the box lines, and 3D appearance. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1796 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1797 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1798 Here are the possible values of the @code{:box} attribute, and what |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1799 they mean: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1800 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1801 @table @asis |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1802 @item @code{nil} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1803 Don't draw a box. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1804 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1805 @item @code{t} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1806 Draw a box with lines of width 1, in the foreground color. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1807 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1808 @item @var{color} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1809 Draw a box with lines of width 1, in color @var{color}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1810 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1811 @item @code{(:line-width @var{width} :color @var{color} :style @var{style})} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1812 This way you can explicitly specify all aspects of the box. The value |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1813 @var{width} specifies the width of the lines to draw; it defaults to 1. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1814 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1815 The value @var{color} specifies the color to draw with. The default is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1816 the foreground color of the face for simple boxes, and the background |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1817 color of the face for 3D boxes. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1818 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1819 The value @var{style} specifies whether to draw a 3D box. If it is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1820 @code{released-button}, the box looks like a 3D button that is not being |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1821 pressed. If it is @code{pressed-button}, the box looks like a 3D button |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1822 that is being pressed. If it is @code{nil} or omitted, a plain 2D box |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1823 is used. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1824 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1825 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1826 The attributes @code{:overline}, @code{:strike-through} and |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1827 @code{:box} are new in Emacs 21. The attributes @code{:family}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1828 @code{:height}, @code{:width}, @code{:weight}, @code{:slant} are also |
25875 | 1829 new; previous versions used the following attributes, now semi-obsolete, |
1830 to specify some of the same information: | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1831 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1832 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1833 @item :font |
25875 | 1834 This attribute specifies the font name. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1835 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1836 @item :bold |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1837 A non-@code{nil} value specifies a bold font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1838 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1839 @item :italic |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1840 A non-@code{nil} value specifies an italic font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1841 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1842 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1843 For compatibility, you can still set these ``attributes'' in Emacs 21, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1844 even though they are not real face attributes. Here is what that does: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1845 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1846 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1847 @item :font |
25875 | 1848 You can specify an X font name as the ``value'' of this ``attribute''; |
1849 that sets the @code{:family}, @code{:width}, @code{:height}, | |
1850 @code{:weight}, and @code{:slant} attributes according to the font name. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1851 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1852 If the value is a pattern with wildcards, the first font that matches |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1853 the pattern is used to set these attributes. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1854 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1855 @item :bold |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1856 A non-@code{nil} makes the face bold; @code{nil} makes it normal. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1857 This actually works by setting the @code{:weight} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1858 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1859 @item :italic |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1860 A non-@code{nil} makes the face italic; @code{nil} makes it normal. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1861 This actually works by setting the @code{:slant} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1862 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1863 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1864 @defvar x-bitmap-file-path |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1865 This variable specifies a list of directories for searching |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1866 for bitmap files, for the @code{:stipple} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1867 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1868 |
25911
b192e4e3a9f5
Rename pixmap-spec-p to bitmap-spec-p.
Gerd Moellmann <gerd@gnu.org>
parents:
25875
diff
changeset
|
1869 @defun bitmap-spec-p object |
42888
04040cfbdf67
(set-face-stipple): Reference description of bitmap data
Richard M. Stallman <rms@gnu.org>
parents:
42827
diff
changeset
|
1870 This returns @code{t} if @var{object} is a valid bitmap specification, |
04040cfbdf67
(set-face-stipple): Reference description of bitmap data
Richard M. Stallman <rms@gnu.org>
parents:
42827
diff
changeset
|
1871 suitable for use with @code{:stipple} (see above). It returns |
04040cfbdf67
(set-face-stipple): Reference description of bitmap data
Richard M. Stallman <rms@gnu.org>
parents:
42827
diff
changeset
|
1872 @code{nil} otherwise. |
25875 | 1873 @end defun |
1874 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1875 @node Attribute Functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1876 @subsection Face Attribute Functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1877 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1878 You can modify the attributes of an existing face with the following |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1879 functions. If you specify @var{frame}, they affect just that frame; |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1880 otherwise, they affect all frames as well as the defaults that apply to |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1881 new frames. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1882 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1883 @tindex set-face-attribute |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1884 @defun set-face-attribute face frame &rest arguments |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1885 This function sets one or more attributes of face @var{face} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1886 for frame @var{frame}. If @var{frame} is @code{nil}, it sets |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1887 the attribute for all frames, and the defaults for new frames. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1888 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1889 The extra arguments @var{arguments} specify the attributes to set, and |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1890 the values for them. They should consist of alternating attribute names |
25875 | 1891 (such as @code{:family} or @code{:underline}) and corresponding values. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1892 Thus, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1893 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1894 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1895 (set-face-attribute 'foo nil |
46721
12862351ee03
Fix set-face-attribute example.
Richard M. Stallman <rms@gnu.org>
parents:
46338
diff
changeset
|
1896 :width 'extended |
12862351ee03
Fix set-face-attribute example.
Richard M. Stallman <rms@gnu.org>
parents:
46338
diff
changeset
|
1897 :weight 'bold |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1898 :underline "red") |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1899 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1900 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1901 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1902 sets the attributes @code{:width}, @code{:weight} and @code{:underline} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1903 to the corresponding values. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1904 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1905 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1906 @tindex face-attribute |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1907 @defun face-attribute face attribute &optional frame inherit |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1908 This returns the value of the @var{attribute} attribute of face |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1909 @var{face} on @var{frame}. If @var{frame} is @code{nil}, |
39404
5b69d94ceef3
(Font Lookup, Attribute Functions)
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
1910 that means the selected frame (@pxref{Input Focus}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1911 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1912 If @var{frame} is @code{t}, the value is the default for |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1913 @var{face} for new frames. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1914 |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
1915 If @var{inherit} is @code{nil}, only attributes directly defined by |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1916 @var{face} are considered, so the return value may be |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
1917 @code{unspecified}, or a relative value. If @var{inherit} is |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
1918 non-@code{nil}, @var{face}'s definition of @var{attribute} is merged |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
1919 with the faces specified by its @code{:inherit} attribute; however the |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
1920 return value may still be @code{unspecified} or relative. If |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
1921 @var{inherit} is a face or a list of faces, then the result is further |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
1922 merged with that face (or faces), until it becomes specified and |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
1923 absolute. |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1924 |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1925 To ensure that the return value is always specified and absolute, use |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1926 a value of @code{default} for @var{inherit}; this will resolve any |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1927 unspecified or relative values by merging with the @code{default} face |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1928 (which is always completely specified). |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1929 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1930 For example, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1931 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1932 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1933 (face-attribute 'bold :weight) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1934 @result{} bold |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1935 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1936 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1937 |
25875 | 1938 The functions above did not exist before Emacs 21. For compatibility |
1939 with older Emacs versions, you can use the following functions to set | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1940 and examine the face attributes which existed in those versions. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1941 |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1942 @tindex face-attribute-relative-p |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1943 @defun face-attribute-relative-p attribute value |
54023 | 1944 This function returns non-@code{nil} if @var{value}, when used as |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1945 the value of the face attribute @var{attribute}, is relative (that is, |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1946 if it modifies an underlying or inherited value of @var{attribute}). |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1947 @end defun |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1948 |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1949 @tindex merge-face-attribute |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1950 @defun merge-face-attribute attribute value1 value2 |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1951 If @var{value1} is a relative value for the face attribute |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1952 @var{attribute}, returns it merged with the underlying value |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1953 @var{value2}; otherwise, if @var{value1} is an absolute value for the |
51000
72af65197e01
Fix typos. Patch from Jesper Harder <harder@ifa.au.dk>.
Juanma Barranquero <lekktu@gmail.com>
parents:
49600
diff
changeset
|
1954 face attribute @var{attribute}, returns @var{value1} unchanged. |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1955 @end defun |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
1956 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1957 @defun set-face-foreground face color &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1958 @defunx set-face-background face color &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1959 These functions set the foreground (or background, respectively) color |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1960 of face @var{face} to @var{color}. The argument @var{color} should be a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1961 string, the name of a color. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1962 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1963 Certain shades of gray are implemented by stipple patterns on |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1964 black-and-white screens. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1965 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1966 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1967 @defun set-face-stipple face pattern &optional frame |
42888
04040cfbdf67
(set-face-stipple): Reference description of bitmap data
Richard M. Stallman <rms@gnu.org>
parents:
42827
diff
changeset
|
1968 This function sets the background stipple pattern of face @var{face} |
04040cfbdf67
(set-face-stipple): Reference description of bitmap data
Richard M. Stallman <rms@gnu.org>
parents:
42827
diff
changeset
|
1969 to @var{pattern}. The argument @var{pattern} should be the name of a |
04040cfbdf67
(set-face-stipple): Reference description of bitmap data
Richard M. Stallman <rms@gnu.org>
parents:
42827
diff
changeset
|
1970 stipple pattern defined by the X server, or actual bitmap data |
04040cfbdf67
(set-face-stipple): Reference description of bitmap data
Richard M. Stallman <rms@gnu.org>
parents:
42827
diff
changeset
|
1971 (@pxref{Face Attributes}), or @code{nil} meaning don't use stipple. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1972 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1973 Normally there is no need to pay attention to stipple patterns, because |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1974 they are used automatically to handle certain shades of gray. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1975 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1976 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1977 @defun set-face-font face font &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1978 This function sets the font of face @var{face}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1979 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1980 In Emacs 21, this actually sets the attributes @code{:family}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1981 @code{:width}, @code{:height}, @code{:weight}, and @code{:slant} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1982 according to the font name @var{font}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1983 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1984 In Emacs 20, this sets the font attribute. Once you set the font |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1985 explicitly, the bold and italic attributes cease to have any effect, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1986 because the precise font that you specified is used. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1987 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1988 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1989 @defun set-face-bold-p face bold-p &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1990 This function specifies whether @var{face} should be bold. If |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1991 @var{bold-p} is non-@code{nil}, that means yes; @code{nil} means no. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1992 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1993 In Emacs 21, this sets the @code{:weight} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1994 In Emacs 20, it sets the @code{:bold} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1995 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1996 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1997 @defun set-face-italic-p face italic-p &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1998 This function specifies whether @var{face} should be italic. If |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1999 @var{italic-p} is non-@code{nil}, that means yes; @code{nil} means no. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2000 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2001 In Emacs 21, this sets the @code{:slant} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2002 In Emacs 20, it sets the @code{:italic} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2003 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2004 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2005 @defun set-face-underline-p face underline-p &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2006 This function sets the underline attribute of face @var{face}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2007 Non-@code{nil} means do underline; @code{nil} means don't. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2008 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2009 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2010 @defun invert-face face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2011 This function inverts the @code{:inverse-video} attribute of face |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2012 @var{face}. If the attribute is @code{nil}, this function sets it to |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2013 @code{t}, and vice versa. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2014 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2015 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2016 These functions examine the attributes of a face. If you don't |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2017 specify @var{frame}, they refer to the default data for new frames. |
25875 | 2018 They return the symbol @code{unspecified} if the face doesn't define any |
2019 value for that attribute. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2020 |
46245
fb42c0446cbf
Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents:
46240
diff
changeset
|
2021 @defun face-foreground face &optional frame inherit |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2022 @defunx face-background face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2023 These functions return the foreground color (or background color, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2024 respectively) of face @var{face}, as a string. |
46245
fb42c0446cbf
Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents:
46240
diff
changeset
|
2025 |
54777 | 2026 If @var{inherit} is @code{nil}, only a color directly defined by the face is |
2027 returned. If @var{inherit} is non-@code{nil}, any faces specified by its | |
46245
fb42c0446cbf
Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents:
46240
diff
changeset
|
2028 @code{:inherit} attribute are considered as well, and if @var{inherit} |
fb42c0446cbf
Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents:
46240
diff
changeset
|
2029 is a face or a list of faces, then they are also considered, until a |
fb42c0446cbf
Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents:
46240
diff
changeset
|
2030 specified color is found. To ensure that the return value is always |
fb42c0446cbf
Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents:
46240
diff
changeset
|
2031 specified, use a value of @code{default} for @var{inherit}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2032 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2033 |
46245
fb42c0446cbf
Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents:
46240
diff
changeset
|
2034 @defun face-stipple face &optional frame inherit |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2035 This function returns the name of the background stipple pattern of face |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2036 @var{face}, or @code{nil} if it doesn't have one. |
46245
fb42c0446cbf
Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents:
46240
diff
changeset
|
2037 |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2038 If @var{inherit} is @code{nil}, only a stipple directly defined by the |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2039 face is returned. If @var{inherit} is non-@code{nil}, any faces |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2040 specified by its @code{:inherit} attribute are considered as well, and |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2041 if @var{inherit} is a face or a list of faces, then they are also |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2042 considered, until a specified stipple is found. To ensure that the |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2043 return value is always specified, use a value of @code{default} for |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2044 @var{inherit}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2045 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2046 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2047 @defun face-font face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2048 This function returns the name of the font of face @var{face}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2049 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2050 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2051 @defun face-bold-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2052 This function returns @code{t} if @var{face} is bold---that is, if it is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2053 bolder than normal. It returns @code{nil} otherwise. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2054 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2055 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2056 @defun face-italic-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2057 This function returns @code{t} if @var{face} is italic or oblique, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2058 @code{nil} otherwise. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2059 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2060 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2061 @defun face-underline-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2062 This function returns the @code{:underline} attribute of face @var{face}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2063 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2064 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2065 @defun face-inverse-video-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2066 This function returns the @code{:inverse-video} attribute of face @var{face}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2067 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2068 |
6598 | 2069 @node Merging Faces |
2070 @subsection Merging Faces for Display | |
2071 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2072 Here are the ways to specify which faces to use for display of text: |
6598 | 2073 |
2074 @itemize @bullet | |
2075 @item | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2076 With defaults. The @code{default} face is used as the ultimate |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2077 default for all text. (In Emacs 19 and 20, the @code{default} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2078 face is used only when no other face is specified.) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2079 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2080 For a mode line or header line, the face @code{modeline} or |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2081 @code{header-line} is used just before @code{default}. |
6598 | 2082 |
2083 @item | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2084 With text properties. A character can have a @code{face} property; if |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2085 so, the faces and face attributes specified there apply. @xref{Special |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2086 Properties}. |
6598 | 2087 |
2088 If the character has a @code{mouse-face} property, that is used instead | |
2089 of the @code{face} property when the mouse is ``near enough'' to the | |
2090 character. | |
2091 | |
2092 @item | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2093 With overlays. An overlay can have @code{face} and @code{mouse-face} |
6598 | 2094 properties too; they apply to all the text covered by the overlay. |
2095 | |
2096 @item | |
12098 | 2097 With a region that is active. In Transient Mark mode, the region is |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2098 highlighted with the face @code{region} (@pxref{Standard Faces}). |
12098 | 2099 |
2100 @item | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
2101 With special glyphs. Each glyph can specify a particular face |
6598 | 2102 number. @xref{Glyphs}. |
2103 @end itemize | |
2104 | |
2105 If these various sources together specify more than one face for a | |
2106 particular character, Emacs merges the attributes of the various faces | |
2107 specified. The attributes of the faces of special glyphs come first; | |
12098 | 2108 then comes the face for region highlighting, if appropriate; |
6598 | 2109 then come attributes of faces from overlays, followed by those from text |
2110 properties, and last the default face. | |
2111 | |
2112 When multiple overlays cover one character, an overlay with higher | |
2113 priority overrides those with lower priority. @xref{Overlays}. | |
2114 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2115 In Emacs 20, if an attribute such as the font or a color is not |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2116 specified in any of the above ways, the frame's own font or color is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2117 used. In newer Emacs versions, this cannot happen, because the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2118 @code{default} face specifies all attributes---in fact, the frame's own |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2119 font and colors are synonymous with those of the default face. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2120 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2121 @node Font Selection |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2122 @subsection Font Selection |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2123 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2124 @dfn{Selecting a font} means mapping the specified face attributes for |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2125 a character to a font that is available on a particular display. The |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2126 face attributes, as determined by face merging, specify most of the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2127 font choice, but not all. Part of the choice depends on what character |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2128 it is. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2129 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2130 If the face specifies a fontset name, that fontset determines a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2131 pattern for fonts of the given charset. If the face specifies a font |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2132 family, a font pattern is constructed. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2133 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2134 Emacs tries to find an available font for the given face attributes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2135 and character's registry and encoding. If there is a font that matches |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2136 exactly, it is used, of course. The hard case is when no available font |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2137 exactly fits the specification. Then Emacs looks for one that is |
27654
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
2138 ``close''---one attribute at a time. You can specify the order to |
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
2139 consider the attributes. In the case where a specified font family is |
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
2140 not available, you can specify a set of mappings for alternatives to |
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
2141 try. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2142 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2143 @defvar face-font-selection-order |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2144 @tindex face-font-selection-order |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2145 This variable specifies the order of importance of the face attributes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2146 @code{:width}, @code{:height}, @code{:weight}, and @code{:slant}. The |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2147 value should be a list containing those four symbols, in order of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2148 decreasing importance. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2149 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2150 Font selection first finds the best available matches for the first |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2151 attribute listed; then, among the fonts which are best in that way, it |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2152 searches for the best matches in the second attribute, and so on. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2153 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2154 The attributes @code{:weight} and @code{:width} have symbolic values in |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2155 a range centered around @code{normal}. Matches that are more extreme |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2156 (farther from @code{normal}) are somewhat preferred to matches that are |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2157 less extreme (closer to @code{normal}); this is designed to ensure that |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2158 non-normal faces contrast with normal ones, whenever possible. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2159 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2160 The default is @code{(:width :height :weight :slant)}, which means first |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2161 find the fonts closest to the specified @code{:width}, then---among the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2162 fonts with that width---find a best match for the specified font height, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2163 and so on. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2164 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2165 One example of a case where this variable makes a difference is when the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2166 default font has no italic equivalent. With the default ordering, the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2167 @code{italic} face will use a non-italic font that is similar to the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2168 default one. But if you put @code{:slant} before @code{:height}, the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2169 @code{italic} face will use an italic font, even if its height is not |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2170 quite right. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2171 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2172 |
33373 | 2173 @defvar face-font-family-alternatives |
2174 @tindex face-font-family-alternatives | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2175 This variable lets you specify alternative font families to try, if a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2176 given family is specified and doesn't exist. Each element should have |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2177 this form: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2178 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2179 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2180 (@var{family} @var{alternate-families}@dots{}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2181 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2182 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2183 If @var{family} is specified but not available, Emacs will try the other |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2184 families given in @var{alternate-families}, one by one, until it finds a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2185 family that does exist. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2186 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2187 |
33373 | 2188 @defvar face-font-registry-alternatives |
2189 @tindex face-font-registry-alternatives | |
2190 This variable lets you specify alternative font registries to try, if a | |
2191 given registry is specified and doesn't exist. Each element should have | |
2192 this form: | |
2193 | |
2194 @example | |
2195 (@var{registry} @var{alternate-registries}@dots{}) | |
2196 @end example | |
2197 | |
2198 If @var{registry} is specified but not available, Emacs will try the | |
2199 other registries given in @var{alternate-registries}, one by one, | |
2200 until it finds a registry that does exist. | |
2201 @end defvar | |
2202 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2203 Emacs can make use of scalable fonts, but by default it does not use |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2204 them, since the use of too many or too big scalable fonts can crash |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2205 XFree86 servers. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2206 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2207 @defvar scalable-fonts-allowed |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2208 @tindex scalable-fonts-allowed |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2209 This variable controls which scalable fonts to use. A value of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2210 @code{nil}, the default, means do not use scalable fonts. @code{t} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2211 means to use any scalable font that seems appropriate for the text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2212 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2213 Otherwise, the value must be a list of regular expressions. Then a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2214 scalable font is enabled for use if its name matches any regular |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2215 expression in the list. For example, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2216 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2217 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2218 (setq scalable-fonts-allowed '("muleindian-2$")) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2219 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2220 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2221 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2222 allows the use of scalable fonts with registry @code{muleindian-2}. |
26698
73f718a9df4b
(Overlays): Add menu entry for Finding Overlays.
Dave Love <fx@gnu.org>
parents:
26696
diff
changeset
|
2223 @end defvar |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2224 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2225 @defun clear-face-cache &optional unload-p |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2226 @tindex clear-face-cache |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2227 This function clears the face cache for all frames. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2228 If @var{unload-p} is non-@code{nil}, that means to unload |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2229 all unused fonts as well. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2230 @end defun |
6598 | 2231 |
52002
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2232 @defvar face-font-rescale-alist |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2233 This variable specifies scaling for certain faces. Its value should |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2234 be a list of elements of the form |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2235 |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2236 @example |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2237 (@var{fontname-regexp} . @var{scale-factor}) |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2238 @end example |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2239 |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2240 If @var{fontname-regexp} matches the font name that is about to be |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2241 used, this says to choose a larger similar font according to the |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2242 factor @var{scale-factor}. You would use this feature to normalize |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2243 the font size if certain fonts are bigger or smaller than their |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2244 nominal heights and widths would suggest. |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2245 @end defvar |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2246 |
6598 | 2247 @node Face Functions |
2248 @subsection Functions for Working with Faces | |
2249 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2250 Here are additional functions for creating and working with faces. |
6598 | 2251 |
2252 @defun make-face name | |
2253 This function defines a new face named @var{name}, initially with all | |
2254 attributes @code{nil}. It does nothing if there is already a face named | |
2255 @var{name}. | |
2256 @end defun | |
2257 | |
2258 @defun face-list | |
2259 This function returns a list of all defined face names. | |
2260 @end defun | |
2261 | |
2262 @defun copy-face old-face new-name &optional frame new-frame | |
2263 This function defines the face @var{new-name} as a copy of the existing | |
2264 face named @var{old-face}. It creates the face @var{new-name} if that | |
2265 doesn't already exist. | |
2266 | |
2267 If the optional argument @var{frame} is given, this function applies | |
2268 only to that frame. Otherwise it applies to each frame individually, | |
2269 copying attributes from @var{old-face} in each frame to @var{new-face} | |
2270 in the same frame. | |
2271 | |
2272 If the optional argument @var{new-frame} is given, then @code{copy-face} | |
2273 copies the attributes of @var{old-face} in @var{frame} to @var{new-name} | |
2274 in @var{new-frame}. | |
2275 @end defun | |
2276 | |
12098 | 2277 @defun face-id face |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2278 This function returns the face number of face @var{face}. |
6598 | 2279 @end defun |
2280 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2281 @defun face-documentation face |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
2282 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
|
2283 @code{nil} if none was specified for it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
2284 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
2285 |
6598 | 2286 @defun face-equal face1 face2 &optional frame |
2287 This returns @code{t} if the faces @var{face1} and @var{face2} have the | |
2288 same attributes for display. | |
2289 @end defun | |
2290 | |
2291 @defun face-differs-from-default-p face &optional frame | |
55899
4592654cd2e9
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-369
Miles Bader <miles@gnu.org>
parents:
55246
diff
changeset
|
2292 This returns non-@code{nil} if the face @var{face} displays |
4592654cd2e9
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-369
Miles Bader <miles@gnu.org>
parents:
55246
diff
changeset
|
2293 differently from the default face. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2294 @end defun |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2295 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2296 @node Auto Faces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2297 @subsection Automatic Face Assignment |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2298 @cindex automatic face assignment |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2299 @cindex faces, automatic choice |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2300 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2301 @cindex Font-Lock mode |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2302 Starting with Emacs 21, a hook is available for automatically |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2303 assigning faces to text in the buffer. This hook is used for part of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2304 the implementation of Font-Lock mode. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2305 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2306 @tindex fontification-functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2307 @defvar fontification-functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2308 This variable holds a list of functions that are called by Emacs |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2309 redisplay as needed to assign faces automatically to text in the buffer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2310 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2311 The functions are called in the order listed, with one argument, a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2312 buffer position @var{pos}. Each function should attempt to assign faces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2313 to the text in the current buffer starting at @var{pos}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2314 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2315 Each function should record the faces they assign by setting the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2316 @code{face} property. It should also add a non-@code{nil} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2317 @code{fontified} property for all the text it has assigned faces to. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2318 That property tells redisplay that faces have been assigned to that text |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2319 already. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2320 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2321 It is probably a good idea for each function to do nothing if the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2322 character after @var{pos} already has a non-@code{nil} @code{fontified} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2323 property, but this is not required. If one function overrides the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2324 assignments made by a previous one, the properties as they are |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2325 after the last function finishes are the ones that really matter. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2326 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2327 For efficiency, we recommend writing these functions so that they |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2328 usually assign faces to around 400 to 600 characters at each call. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2329 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2330 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2331 @node Font Lookup |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2332 @subsection Looking Up Fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2333 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2334 @defun x-list-fonts pattern &optional face frame maximum |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2335 This function returns a list of available font names that match |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2336 @var{pattern}. If the optional arguments @var{face} and @var{frame} are |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2337 specified, then the list is limited to fonts that are the same size as |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2338 @var{face} currently is on @var{frame}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2339 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2340 The argument @var{pattern} should be a string, perhaps with wildcard |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2341 characters: the @samp{*} character matches any substring, and the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2342 @samp{?} character matches any single character. Pattern matching |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2343 of font names ignores case. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2344 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2345 If you specify @var{face} and @var{frame}, @var{face} should be a face name |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2346 (a symbol) and @var{frame} should be a frame. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2347 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2348 The optional argument @var{maximum} sets a limit on how many fonts to |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2349 return. If this is non-@code{nil}, then the return value is truncated |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2350 after the first @var{maximum} matching fonts. Specifying a small value |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2351 for @var{maximum} can make this function much faster, in cases where |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2352 many fonts match the pattern. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2353 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2354 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2355 These additional functions are available starting in Emacs 21. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2356 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2357 @defun x-family-fonts &optional family frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2358 @tindex x-family-fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2359 This function returns a list describing the available fonts for family |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2360 @var{family} on @var{frame}. If @var{family} is omitted or @code{nil}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2361 this list applies to all families, and therefore, it contains all |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2362 available fonts. Otherwise, @var{family} must be a string; it may |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2363 contain the wildcards @samp{?} and @samp{*}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2364 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2365 The list describes the display that @var{frame} is on; if @var{frame} is |
39404
5b69d94ceef3
(Font Lookup, Attribute Functions)
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
2366 omitted or @code{nil}, it applies to the selected frame's display |
5b69d94ceef3
(Font Lookup, Attribute Functions)
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
2367 (@pxref{Input Focus}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2368 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2369 The list contains a vector of the following form for each font: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2370 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2371 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2372 [@var{family} @var{width} @var{point-size} @var{weight} @var{slant} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2373 @var{fixed-p} @var{full} @var{registry-and-encoding}] |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2374 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2375 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2376 The first five elements correspond to face attributes; if you |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2377 specify these attributes for a face, it will use this font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2378 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2379 The last three elements give additional information about the font. |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2380 @var{fixed-p} is non-@code{nil} if the font is fixed-pitch. |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2381 @var{full} is the full name of the font, and |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2382 @var{registry-and-encoding} is a string giving the registry and |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2383 encoding of the font. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2384 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2385 The result list is sorted according to the current face font sort order. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2386 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2387 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2388 @defun x-font-family-list &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2389 @tindex x-font-family-list |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2390 This function returns a list of the font families available for |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2391 @var{frame}'s display. If @var{frame} is omitted or @code{nil}, it |
39404
5b69d94ceef3
(Font Lookup, Attribute Functions)
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
2392 describes the selected frame's display (@pxref{Input Focus}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2393 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2394 The value is a list of elements of this form: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2395 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2396 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2397 (@var{family} . @var{fixed-p}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2398 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2399 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2400 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2401 Here @var{family} is a font family, and @var{fixed-p} is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2402 non-@code{nil} if fonts of that family are fixed-pitch. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2403 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2404 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2405 @defvar font-list-limit |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2406 @tindex font-list-limit |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2407 This variable specifies maximum number of fonts to consider in font |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2408 matching. The function @code{x-family-fonts} will not return more than |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2409 that many fonts, and font selection will consider only that many fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2410 when searching a matching font for face attributes. The default is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2411 currently 100. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2412 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2413 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2414 @node Fontsets |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2415 @subsection Fontsets |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2416 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2417 A @dfn{fontset} is a list of fonts, each assigned to a range of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2418 character codes. An individual font cannot display the whole range of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2419 characters that Emacs supports, but a fontset can. Fontsets have names, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2420 just as fonts do, and you can use a fontset name in place of a font name |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2421 when you specify the ``font'' for a frame or a face. Here is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2422 information about defining a fontset under Lisp program control. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2423 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2424 @defun create-fontset-from-fontset-spec fontset-spec &optional style-variant-p noerror |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2425 This function defines a new fontset according to the specification |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2426 string @var{fontset-spec}. The string should have this format: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2427 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2428 @smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2429 @var{fontpattern}, @r{[}@var{charsetname}:@var{fontname}@r{]@dots{}} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2430 @end smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2431 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2432 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2433 Whitespace characters before and after the commas are ignored. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2434 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2435 The first part of the string, @var{fontpattern}, should have the form of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2436 a standard X font name, except that the last two fields should be |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2437 @samp{fontset-@var{alias}}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2438 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2439 The new fontset has two names, one long and one short. The long name is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2440 @var{fontpattern} in its entirety. The short name is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2441 @samp{fontset-@var{alias}}. You can refer to the fontset by either |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2442 name. If a fontset with the same name already exists, an error is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2443 signaled, unless @var{noerror} is non-@code{nil}, in which case this |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2444 function does nothing. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2445 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2446 If optional argument @var{style-variant-p} is non-@code{nil}, that says |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2447 to create bold, italic and bold-italic variants of the fontset as well. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2448 These variant fontsets do not have a short name, only a long one, which |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2449 is made by altering @var{fontpattern} to indicate the bold or italic |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2450 status. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2451 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2452 The specification string also says which fonts to use in the fontset. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2453 See below for the details. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2454 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2455 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2456 The construct @samp{@var{charset}:@var{font}} specifies which font to |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2457 use (in this fontset) for one particular character set. Here, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2458 @var{charset} is the name of a character set, and @var{font} is the font |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2459 to use for that character set. You can use this construct any number of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2460 times in the specification string. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2461 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2462 For the remaining character sets, those that you don't specify |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2463 explicitly, Emacs chooses a font based on @var{fontpattern}: it replaces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2464 @samp{fontset-@var{alias}} with a value that names one character set. |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52940
diff
changeset
|
2465 For the @acronym{ASCII} character set, @samp{fontset-@var{alias}} is replaced |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2466 with @samp{ISO8859-1}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2467 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2468 In addition, when several consecutive fields are wildcards, Emacs |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2469 collapses them into a single wildcard. This is to prevent use of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2470 auto-scaled fonts. Fonts made by scaling larger fonts are not usable |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2471 for editing, and scaling a smaller font is not useful because it is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2472 better to use the smaller font in its own size, which Emacs does. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2473 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2474 Thus if @var{fontpattern} is this, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2475 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2476 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2477 -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2478 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2479 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2480 @noindent |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52940
diff
changeset
|
2481 the font specification for @acronym{ASCII} characters would be this: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2482 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2483 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2484 -*-fixed-medium-r-normal-*-24-*-ISO8859-1 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2485 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2486 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2487 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2488 and the font specification for Chinese GB2312 characters would be this: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2489 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2490 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2491 -*-fixed-medium-r-normal-*-24-*-gb2312*-* |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2492 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2493 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2494 You may not have any Chinese font matching the above font |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2495 specification. Most X distributions include only Chinese fonts that |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2496 have @samp{song ti} or @samp{fangsong ti} in the @var{family} field. In |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2497 such a case, @samp{Fontset-@var{n}} can be specified as below: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2498 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2499 @smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2500 Emacs.Fontset-0: -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24,\ |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2501 chinese-gb2312:-*-*-medium-r-normal-*-24-*-gb2312*-* |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2502 @end smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2503 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2504 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2505 Then, the font specifications for all but Chinese GB2312 characters have |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2506 @samp{fixed} in the @var{family} field, and the font specification for |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2507 Chinese GB2312 characters has a wild card @samp{*} in the @var{family} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2508 field. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2509 |
52932
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2510 @defun set-fontset-font name character fontname &optional frame |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2511 This function modifies the existing fontset @var{name} to |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2512 use the font name @var{fontname} for the character @var{character}. |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2513 |
52940
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2514 If @var{name} is @code{nil}, this function modifies the default |
54023 | 2515 fontset, whose short name is @samp{fontset-default}. |
52940
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2516 |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2517 @var{character} may be a cons; @code{(@var{from} . @var{to})}, where |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2518 @var{from} and @var{to} are non-generic characters. In that case, use |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2519 @var{fontname} for all characters in the range @var{from} and @var{to} |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2520 (inclusive). |
52932
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2521 |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2522 @var{character} may be a charset. In that case, use |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2523 @var{fontname} for all character in the charsets. |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2524 |
52940
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2525 @var{fontname} may be a cons; @code{(@var{family} . @var{registry})}, |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2526 where @var{family} is a family name of a font (possibly including a |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2527 foundry name at the head), @var{registry} is a registry name of a font |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2528 (possibly including an encoding name at the tail). |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2529 |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2530 For instance, this changes the default fontset to use a font of which |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2531 registry name is @samp{JISX0208.1983} for all characters belonging to |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2532 the charset @code{japanese-jisx0208}. |
52932
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2533 |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2534 @example |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2535 (set-fontset-font nil 'japanese-jisx0208 '(nil . "JISX0208.1983")) |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2536 @end example |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2537 |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2538 @end defun |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2539 |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2540 @defun char-displayable-p char |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2541 This function returns @code{t} if Emacs ought to be able to display |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2542 @var{char}. More precisely, if the selected frame's fontset has a |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2543 font to display the character set that @var{char} belongs to. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2544 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2545 Fontsets can specify a font on a per-character basis; when the fontset |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2546 does that, this function's value may not be accurate. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2547 @end defun |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2548 |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2549 @node Fringes |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2550 @section Fringes |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2551 @cindex Fringes |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2552 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2553 The @dfn{fringes} of a window are thin vertical strips down the |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2554 sides that are used for displaying bitmaps that indicate truncation, |
54023 | 2555 continuation, horizontal scrolling, and the overlay arrow. The |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2556 fringes normally appear between the display margins and the window |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2557 text, but you can put them outside the display margins for a specific |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2558 buffer by setting @code{fringes-outside-margins} buffer-locally to a |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2559 non-@code{nil} value. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2560 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2561 @defvar fringes-outside-margins |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2562 If the value is non-@code{nil}, the frames appear outside |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2563 the display margins. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2564 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2565 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2566 @defvar left-fringe-width |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2567 This variable, if non-@code{nil}, specifies the width of the left |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2568 fringe in pixels. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2569 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2570 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2571 @defvar right-fringe-width |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2572 This variable, if non-@code{nil}, specifies the width of the right |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2573 fringe in pixels. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2574 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2575 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2576 The values of these variables take effect when you display the |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2577 buffer in a window. If you change them while the buffer is visible, |
54023 | 2578 you can call @code{set-window-buffer} to display it once again in the |
2579 same window, to make the changes take effect. | |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2580 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2581 @defun set-window-fringes window left &optional right outside-margins |
54023 | 2582 This function sets the fringe widths of window @var{window}. |
53929
3ef7a4a3c230
(Fringes): Use consistent wording.
Kim F. Storm <storm@cua.dk>
parents:
53829
diff
changeset
|
2583 If @var{window} is @code{nil}, the selected window is used. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2584 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2585 The argument @var{left} specifies the width in pixels of the left |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2586 fringe, and likewise @var{right} for the right fringe. A value of |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2587 @code{nil} for either one stands for the default width. If |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2588 @var{outside-margins} is non-@code{nil}, that specifies that fringes |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2589 should appear outside of the display margins. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2590 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2591 |
53929
3ef7a4a3c230
(Fringes): Use consistent wording.
Kim F. Storm <storm@cua.dk>
parents:
53829
diff
changeset
|
2592 @defun window-fringes &optional window |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2593 This function returns information about the fringes of a window |
53929
3ef7a4a3c230
(Fringes): Use consistent wording.
Kim F. Storm <storm@cua.dk>
parents:
53829
diff
changeset
|
2594 @var{window}. If @var{window} is omitted or @code{nil}, the selected |
3ef7a4a3c230
(Fringes): Use consistent wording.
Kim F. Storm <storm@cua.dk>
parents:
53829
diff
changeset
|
2595 window is used. The value has the form @code{(@var{left-width} |
52156
198af82c7606
(Warning Basics): Fix typo.
John Paul Wallington <jpw@pobox.com>
parents:
52141
diff
changeset
|
2596 @var{right-width} @var{frames-outside-margins})}. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2597 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2598 |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2599 @node Scroll Bars |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2600 @section Scroll Bars |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2601 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2602 Normally the frame parameter @code{vertical-scroll-bars} controls |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2603 whether the windows in the frame have vertical scroll bars. A |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2604 non-@code{nil} parameter value means they do. The frame parameter |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2605 @code{scroll-bar-width} specifies how wide they are (@code{nil} |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2606 meaning the default). @xref{Window Frame Parameters}. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2607 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2608 You can also control this for individual windows. Call the function |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2609 @code{set-window-scroll-bars} to specify what to do for a specific window: |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2610 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2611 @defun set-window-scroll-bars window width &optional vertical-type horizontal-type |
53929
3ef7a4a3c230
(Fringes): Use consistent wording.
Kim F. Storm <storm@cua.dk>
parents:
53829
diff
changeset
|
2612 Set width and type of scroll bars of window @var{window}. |
3ef7a4a3c230
(Fringes): Use consistent wording.
Kim F. Storm <storm@cua.dk>
parents:
53829
diff
changeset
|
2613 If @var{window} is @code{nil}, the selected window is used. |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2614 @var{width} specifies the scroll bar width in pixels (@code{nil} means |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2615 use whatever is specified for width for the frame). |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2616 @var{vertical-type} specifies whether to have a vertical scroll bar |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2617 and, if so, where. The possible values are @code{left}, @code{right} |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2618 and @code{nil}, just like the values of the |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2619 @code{vertical-scroll-bars} frame parameter. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2620 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2621 The argument @var{horizontal-type} is meant to specify whether and |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2622 where to have horizontal scroll bars, but since they are not |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2623 implemented, it has no effect. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2624 @end defun |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2625 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2626 @defun window-scroll-bars &optional window |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2627 Report the width and type of scroll bars specified for @var{window}. |
53929
3ef7a4a3c230
(Fringes): Use consistent wording.
Kim F. Storm <storm@cua.dk>
parents:
53829
diff
changeset
|
2628 If @var{window} is omitted or @code{nil}, the selected window is used. |
3ef7a4a3c230
(Fringes): Use consistent wording.
Kim F. Storm <storm@cua.dk>
parents:
53829
diff
changeset
|
2629 The value is a list of the form @code{(@var{width} |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2630 @var{cols} @var{vertical-type} @var{horizontal-type})}. The value |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2631 @var{width} is the value that was specified for the width (which may |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2632 be @code{nil}); @var{cols} is the number of columns that the scroll |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2633 bar actually occupies. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2634 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2635 @var{horizontal-type} is not actually meaningful. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2636 @end defun |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2637 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2638 If you don't specify these values for a window with |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2639 @code{set-window-scroll-bars}, the buffer-local variables |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2640 @code{scroll-bar-mode} and @code{scroll-bar-width} in the buffer being |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2641 displayed control the window's vertical scroll bars. The function |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2642 @code{set-window-buffer} examines these variables. If you change them |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2643 in a buffer that is already visible in a window, you can make the |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2644 window take note of the new values by calling @code{set-window-buffer} |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2645 specifying the same buffer that is already displayed. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2646 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2647 @node Display Property |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2648 @section The @code{display} Property |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2649 @cindex display specification |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2650 @kindex display @r{(text property)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2651 |
25875 | 2652 The @code{display} text property (or overlay property) is used to |
2653 insert images into text, and also control other aspects of how text | |
2654 displays. These features are available starting in Emacs 21. The value | |
2655 of the @code{display} property should be a display specification, or a | |
2656 list or vector containing several display specifications. The rest of | |
2657 this section describes several kinds of display specifications and what | |
2658 they mean. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2659 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2660 @menu |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
2661 * Specified Space:: Displaying one space with a specified width. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
2662 * Other Display Specs:: Displaying an image; magnifying text; moving it |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
2663 up or down on the page; adjusting the width |
25875 | 2664 of spaces within text. |
2665 * Display Margins:: Displaying text or images to the side of the main text. | |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
2666 * Conditional Display:: Making any of the above features conditional |
25875 | 2667 depending on some Lisp expression. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2668 @end menu |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2669 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2670 @node Specified Space |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2671 @subsection Specified Spaces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2672 @cindex spaces, specified height or width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2673 @cindex specified spaces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2674 @cindex variable-width spaces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2675 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2676 To display a space of specified width and/or height, use a display |
25875 | 2677 specification of the form @code{(space . @var{props})}, where |
2678 @var{props} is a property list (a list of alternating properties and | |
2679 values). You can put this property on one or more consecutive | |
2680 characters; a space of the specified height and width is displayed in | |
2681 place of @emph{all} of those characters. These are the properties you | |
44281 | 2682 can use in @var{props} to specify the weight of the space: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2683 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2684 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2685 @item :width @var{width} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2686 Specifies that the space width should be @var{width} times the normal |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2687 character width. @var{width} can be an integer or floating point |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2688 number. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2689 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2690 @item :relative-width @var{factor} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2691 Specifies that the width of the stretch should be computed from the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2692 first character in the group of consecutive characters that have the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2693 same @code{display} property. The space width is the width of that |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2694 character, multiplied by @var{factor}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2695 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2696 @item :align-to @var{hpos} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2697 Specifies that the space should be wide enough to reach @var{hpos}. The |
25875 | 2698 value @var{hpos} is measured in units of the normal character width. It |
48701 | 2699 may be an integer or a floating point number. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2700 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2701 |
44281 | 2702 You should use one and only one of the above properties. You can |
2703 also specify the height of the space, with other properties: | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2704 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2705 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2706 @item :height @var{height} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2707 Specifies the height of the space, as @var{height}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2708 measured in terms of the normal line height. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2709 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2710 @item :relative-height @var{factor} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2711 Specifies the height of the space, multiplying the ordinary height |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2712 of the text having this display specification by @var{factor}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2713 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2714 @item :ascent @var{ascent} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2715 Specifies that @var{ascent} percent of the height of the space should be |
25875 | 2716 considered as the ascent of the space---that is, the part above the |
2717 baseline. The value of @var{ascent} must be a non-negative number no | |
2718 greater than 100. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2719 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2720 |
44281 | 2721 Don't use both @code{:height} and @code{:relative-height} together. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2722 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2723 @node Other Display Specs |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2724 @subsection Other Display Specifications |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2725 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2726 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2727 @item (image . @var{image-props}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2728 This is in fact an image descriptor (@pxref{Images}). When used as a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2729 display specification, it means to display the image instead of the text |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2730 that has the display specification. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2731 |
32467 | 2732 @item ((margin nil) @var{string}) |
2733 @itemx @var{string} | |
2734 A display specification of this form means to display @var{string} | |
2735 instead of the text that has the display specification, at the same | |
2736 position as that text. This is a special case of marginal display | |
2737 (@pxref{Display Margins}). | |
2738 | |
44281 | 2739 Recursive display specifications are not supported---string display |
2740 specifications must not have @code{display} properties themselves. | |
36935 | 2741 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2742 @item (space-width @var{factor}) |
25875 | 2743 This display specification affects all the space characters within the |
2744 text that has the specification. It displays all of these spaces | |
2745 @var{factor} times as wide as normal. The element @var{factor} should | |
2746 be an integer or float. Characters other than spaces are not affected | |
2747 at all; in particular, this has no effect on tab characters. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2748 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2749 @item (height @var{height}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2750 This display specification makes the text taller or shorter. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2751 Here are the possibilities for @var{height}: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2752 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2753 @table @asis |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2754 @item @code{(+ @var{n})} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2755 This means to use a font that is @var{n} steps larger. A ``step'' is |
25875 | 2756 defined by the set of available fonts---specifically, those that match |
2757 what was otherwise specified for this text, in all attributes except | |
2758 height. Each size for which a suitable font is available counts as | |
2759 another step. @var{n} should be an integer. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2760 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2761 @item @code{(- @var{n})} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2762 This means to use a font that is @var{n} steps smaller. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2763 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2764 @item a number, @var{factor} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2765 A number, @var{factor}, means to use a font that is @var{factor} times |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2766 as tall as the default font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2767 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2768 @item a symbol, @var{function} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2769 A symbol is a function to compute the height. It is called with the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2770 current height as argument, and should return the new height to use. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2771 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2772 @item anything else, @var{form} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2773 If the @var{height} value doesn't fit the previous possibilities, it is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2774 a form. Emacs evaluates it to get the new height, with the symbol |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2775 @code{height} bound to the current specified font height. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2776 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2777 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2778 @item (raise @var{factor}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2779 This kind of display specification raises or lowers the text |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2780 it applies to, relative to the baseline of the line. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2781 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2782 @var{factor} must be a number, which is interpreted as a multiple of the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2783 height of the affected text. If it is positive, that means to display |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2784 the characters raised. If it is negative, that means to display them |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2785 lower down. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2786 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2787 If the text also has a @code{height} display specification, that does |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2788 not affect the amount of raising or lowering, which is based on the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2789 faces used for the text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2790 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2791 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2792 @node Display Margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2793 @subsection Displaying in the Margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2794 @cindex display margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2795 @cindex margins, display |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2796 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2797 A buffer can have blank areas called @dfn{display margins} on the left |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2798 and on the right. Ordinary text never appears in these areas, but you |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2799 can put things into the display margins using the @code{display} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2800 property. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2801 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2802 To put text in the left or right display margin of the window, use a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2803 display specification of the form @code{(margin right-margin)} or |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2804 @code{(margin left-margin)} on it. To put an image in a display margin, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2805 use that display specification along with the display specification for |
42476
fe0b84badbb1
Margin displays can't be mouse sensitive.
Richard M. Stallman <rms@gnu.org>
parents:
42297
diff
changeset
|
2806 the image. Unfortunately, there is currently no way to make |
fe0b84badbb1
Margin displays can't be mouse sensitive.
Richard M. Stallman <rms@gnu.org>
parents:
42297
diff
changeset
|
2807 text or images in the margin mouse-sensitive. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2808 |
42297
c4f9d48801a8
Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents:
42082
diff
changeset
|
2809 If you put such a display specification directly on text in the |
c4f9d48801a8
Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents:
42082
diff
changeset
|
2810 buffer, the specified margin display appears @emph{instead of} that |
c4f9d48801a8
Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents:
42082
diff
changeset
|
2811 buffer text itself. To put something in the margin @emph{in |
c4f9d48801a8
Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents:
42082
diff
changeset
|
2812 association with} certain buffer text without preventing or altering |
c4f9d48801a8
Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents:
42082
diff
changeset
|
2813 the display of that text, put a @code{before-string} property on the |
c4f9d48801a8
Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents:
42082
diff
changeset
|
2814 text and put the display specification on the contents of the |
c4f9d48801a8
Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents:
42082
diff
changeset
|
2815 before-string. |
c4f9d48801a8
Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents:
42082
diff
changeset
|
2816 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2817 Before the display margins can display anything, you must give |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2818 them a nonzero width. The usual way to do that is to set these |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2819 variables: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2820 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2821 @defvar left-margin-width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2822 @tindex left-margin-width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2823 This variable specifies the width of the left margin. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2824 It is buffer-local in all buffers. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2825 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2826 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2827 @defvar right-margin-width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2828 @tindex right-margin-width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2829 This variable specifies the width of the right margin. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2830 It is buffer-local in all buffers. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2831 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2832 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2833 Setting these variables does not immediately affect the window. These |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2834 variables are checked when a new buffer is displayed in the window. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2835 Thus, you can make changes take effect by calling |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2836 @code{set-window-buffer}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2837 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2838 You can also set the margin widths immediately. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2839 |
36935 | 2840 @defun set-window-margins window left &optional right |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2841 @tindex set-window-margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2842 This function specifies the margin widths for window @var{window}. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
2843 The argument @var{left} controls the left margin and |
36935 | 2844 @var{right} controls the right margin (default @code{0}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2845 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2846 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2847 @defun window-margins &optional window |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2848 @tindex window-margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2849 This function returns the left and right margins of @var{window} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2850 as a cons cell of the form @code{(@var{left} . @var{right})}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2851 If @var{window} is @code{nil}, the selected window is used. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2852 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2853 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2854 @node Conditional Display |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2855 @subsection Conditional Display Specifications |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2856 @cindex conditional display specifications |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2857 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2858 You can make any display specification conditional. To do that, |
29471 | 2859 package it in another list of the form @code{(when @var{condition} . |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2860 @var{spec})}. Then the specification @var{spec} applies only when |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2861 @var{condition} evaluates to a non-@code{nil} value. During the |
39032
ed864621a68e
Conditional Display): Adjust to API change.
Gerd Moellmann <gerd@gnu.org>
parents:
38278
diff
changeset
|
2862 evaluation, @code{object} is bound to the string or buffer having the |
ed864621a68e
Conditional Display): Adjust to API change.
Gerd Moellmann <gerd@gnu.org>
parents:
38278
diff
changeset
|
2863 conditional @code{display} property. @code{position} and |
ed864621a68e
Conditional Display): Adjust to API change.
Gerd Moellmann <gerd@gnu.org>
parents:
38278
diff
changeset
|
2864 @code{buffer-position} are bound to the position within @code{object} |
ed864621a68e
Conditional Display): Adjust to API change.
Gerd Moellmann <gerd@gnu.org>
parents:
38278
diff
changeset
|
2865 and the buffer position where the @code{display} property was found, |
ed864621a68e
Conditional Display): Adjust to API change.
Gerd Moellmann <gerd@gnu.org>
parents:
38278
diff
changeset
|
2866 respectively. Both positions can be different when @code{object} is a |
ed864621a68e
Conditional Display): Adjust to API change.
Gerd Moellmann <gerd@gnu.org>
parents:
38278
diff
changeset
|
2867 string. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2868 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2869 @node Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2870 @section Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2871 @cindex images in buffers |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2872 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2873 To display an image in an Emacs buffer, you must first create an image |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2874 descriptor, then use it as a display specifier in the @code{display} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2875 property of text that is displayed (@pxref{Display Property}). Like the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2876 @code{display} property, this feature is available starting in Emacs 21. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2877 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2878 Emacs can display a number of different image formats; some of them |
56109
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2879 are supported only if particular support libraries are installed on |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2880 your machine. In some environments, Emacs allows loading image |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2881 libraries on demand; if so, the variable @code{image-library-alist} |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2882 can be used to modify the set of known names for these dynamic |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2883 libraries (though it is not posible to add new image formats). |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2884 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2885 The supported image formats include XBM, XPM (needing the |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2886 libraries @code{libXpm} version 3.4k and @code{libz}), GIF (needing |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2887 @code{libungif} 4.1.0), Postscript, PBM, JPEG (needing the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2888 @code{libjpeg} library version v6a), TIFF (needing @code{libtiff} v3.4), |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2889 and PNG (needing @code{libpng} 1.0.2). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2890 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2891 You specify one of these formats with an image type symbol. The image |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2892 type symbols are @code{xbm}, @code{xpm}, @code{gif}, @code{postscript}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2893 @code{pbm}, @code{jpeg}, @code{tiff}, and @code{png}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2894 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2895 @defvar image-types |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2896 This variable contains a list of those image type symbols that are |
56109
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2897 potentially supported in the current configuration. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2898 @emph{Potentially} here means that Emacs knows about the image types, |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2899 not necessarily that they can be loaded (they could depend on |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2900 unavailable dynamic libraries, for example). |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2901 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2902 To know which image types are really available, use |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2903 @code{image-type-available-p}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2904 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2905 |
56109
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2906 @defvar image-library-alist |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2907 This in an alist of image types vs external libraries needed to |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2908 display them. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2909 |
56437
bd1f1cbf959f
(Images): Fix Texinfo usage.
Juanma Barranquero <lekktu@gmail.com>
parents:
56233
diff
changeset
|
2910 Each element is a list @code{(@var{image-type} @var{library}...)}, |
56109
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2911 where the car is a supported image format from @code{image-types}, and |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2912 the rest are strings giving alternate filenames for the corresponding |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2913 external libraries to load. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2914 |
56185
4f36c90f5404
(Images): Remove redundant @vindex directives.
Juanma Barranquero <lekktu@gmail.com>
parents:
56109
diff
changeset
|
2915 Emacs tries to load the libraries in the order they appear on the |
4f36c90f5404
(Images): Remove redundant @vindex directives.
Juanma Barranquero <lekktu@gmail.com>
parents:
56109
diff
changeset
|
2916 list; if none is loaded, the running session of Emacs won't support |
4f36c90f5404
(Images): Remove redundant @vindex directives.
Juanma Barranquero <lekktu@gmail.com>
parents:
56109
diff
changeset
|
2917 the image type. @code{pbm} and @code{xbm} don't need to be listed; |
56109
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2918 they're always supported. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2919 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2920 This variable is ignored if the image libraries are statically linked |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2921 into Emacs. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2922 @end defvar |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2923 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2924 @defun image-type-available-p type |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2925 @findex image-type-available-p |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2926 |
56437
bd1f1cbf959f
(Images): Fix Texinfo usage.
Juanma Barranquero <lekktu@gmail.com>
parents:
56233
diff
changeset
|
2927 This function returns non-@code{nil} if image type @var{type} is |
bd1f1cbf959f
(Images): Fix Texinfo usage.
Juanma Barranquero <lekktu@gmail.com>
parents:
56233
diff
changeset
|
2928 available, i.e., if images of this type can be loaded and displayed in |
bd1f1cbf959f
(Images): Fix Texinfo usage.
Juanma Barranquero <lekktu@gmail.com>
parents:
56233
diff
changeset
|
2929 Emacs. @var{type} should be one of the types contained in |
bd1f1cbf959f
(Images): Fix Texinfo usage.
Juanma Barranquero <lekktu@gmail.com>
parents:
56233
diff
changeset
|
2930 @code{image-types}. |
56109
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2931 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2932 For image types whose support libraries are statically linked, this |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2933 function always returns @code{t}; for other image types, it returns |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2934 @code{t} if the dynamic library could be loaded, @code{nil} otherwise. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2935 @end defun |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
2936 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2937 @menu |
25875 | 2938 * Image Descriptors:: How to specify an image for use in @code{:display}. |
2939 * XBM Images:: Special features for XBM format. | |
2940 * XPM Images:: Special features for XPM format. | |
2941 * GIF Images:: Special features for GIF format. | |
2942 * Postscript Images:: Special features for Postscript format. | |
2943 * Other Image Types:: Various other formats are supported. | |
2944 * Defining Images:: Convenient ways to define an image for later use. | |
2945 * Showing Images:: Convenient ways to display an image once it is defined. | |
2946 * Image Cache:: Internal mechanisms of image display. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2947 @end menu |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2948 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2949 @node Image Descriptors |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2950 @subsection Image Descriptors |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2951 @cindex image descriptor |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2952 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2953 An image description is a list of the form @code{(image |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2954 . @var{props})}, where @var{props} is a property list containing |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2955 alternating keyword symbols (symbols whose names start with a colon) and |
26400 | 2956 their values. You can use any Lisp object as a property, but the only |
2957 properties that have any special meaning are certain symbols, all of | |
2958 them keywords. | |
2959 | |
2960 Every image descriptor must contain the property @code{:type | |
2961 @var{type}} to specify the format of the image. The value of @var{type} | |
2962 should be an image type symbol; for example, @code{xpm} for an image in | |
2963 XPM format. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2964 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2965 Here is a list of other properties that are meaningful for all image |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2966 types: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2967 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2968 @table @code |
36730
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2969 @item :file @var{file} |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2970 The @code{:file} property specifies to load the image from file |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2971 @var{file}. If @var{file} is not an absolute file name, it is expanded |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2972 in @code{data-directory}. |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2973 |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2974 @item :data @var{data} |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2975 The @code{:data} property specifies the actual contents of the image. |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2976 Each image must use either @code{:data} or @code{:file}, but not both. |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2977 For most image types, the value of the @code{:data} property should be a |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2978 string containing the image data; we recommend using a unibyte string. |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2979 |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2980 Before using @code{:data}, look for further information in the section |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2981 below describing the specific image format. For some image types, |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2982 @code{:data} may not be supported; for some, it allows other data types; |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2983 for some, @code{:data} alone is not enough, so you need to use other |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2984 image properties along with @code{:data}. |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2985 |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2986 @item :margin @var{margin} |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2987 The @code{:margin} property specifies how many pixels to add as an |
51000
72af65197e01
Fix typos. Patch from Jesper Harder <harder@ifa.au.dk>.
Juanma Barranquero <lekktu@gmail.com>
parents:
49600
diff
changeset
|
2988 extra margin around the image. The value, @var{margin}, must be a |
36730
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2989 non-negative number, or a pair @code{(@var{x} . @var{y})} of such |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2990 numbers. If it is a pair, @var{x} specifies how many pixels to add |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2991 horizontally, and @var{y} specifies how many pixels to add vertically. |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2992 If @code{:margin} is not specified, the default is zero. |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
2993 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2994 @item :ascent @var{ascent} |
29151 | 2995 The @code{:ascent} property specifies the amount of the image's |
2996 height to use for its ascent---that is, the part above the baseline. | |
2997 The value, @var{ascent}, must be a number in the range 0 to 100, or | |
2998 the symbol @code{center}. | |
2999 | |
3000 If @var{ascent} is a number, that percentage of the image's height is | |
3001 used for its ascent. | |
3002 | |
3003 If @var{ascent} is @code{center}, the image is vertically centered | |
3004 around a centerline which would be the vertical centerline of text drawn | |
3005 at the position of the image, in the manner specified by the text | |
3006 properties and overlays that apply to the image. | |
3007 | |
3008 If this property is omitted, it defaults to 50. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3009 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3010 @item :relief @var{relief} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3011 The @code{:relief} property, if non-@code{nil}, adds a shadow rectangle |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3012 around the image. The value, @var{relief}, specifies the width of the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3013 shadow lines, in pixels. If @var{relief} is negative, shadows are drawn |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3014 so that the image appears as a pressed button; otherwise, it appears as |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3015 an unpressed button. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3016 |
35364 | 3017 @item :conversion @var{algorithm} |
3018 The @code{:conversion} property, if non-@code{nil}, specifies a | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3019 conversion algorithm that should be applied to the image before it is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3020 displayed; the value, @var{algorithm}, specifies which algorithm. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3021 |
33996 | 3022 @table @code |
3023 @item laplace | |
3024 @itemx emboss | |
3025 Specifies the Laplace edge detection algorithm, which blurs out small | |
3026 differences in color while highlighting larger differences. People | |
3027 sometimes consider this useful for displaying the image for a | |
3028 ``disabled'' button. | |
3029 | |
3030 @item (edge-detection :matrix @var{matrix} :color-adjust @var{adjust}) | |
3031 Specifies a general edge-detection algorithm. @var{matrix} must be | |
3032 either a nine-element list or a nine-element vector of numbers. A pixel | |
3033 at position @math{x/y} in the transformed image is computed from | |
3034 original pixels around that position. @var{matrix} specifies, for each | |
3035 pixel in the neighborhood of @math{x/y}, a factor with which that pixel | |
3036 will influence the transformed pixel; element @math{0} specifies the | |
3037 factor for the pixel at @math{x-1/y-1}, element @math{1} the factor for | |
3038 the pixel at @math{x/y-1} etc., as shown below: | |
3039 @iftex | |
3040 @tex | |
3041 $$\pmatrix{x-1/y-1 & x/y-1 & x+1/y-1 \cr | |
3042 x-1/y & x/y & x+1/y \cr | |
3043 x-1/y+1& x/y+1 & x+1/y+1 \cr}$$ | |
3044 @end tex | |
3045 @end iftex | |
3046 @ifnottex | |
3047 @display | |
3048 (x-1/y-1 x/y-1 x+1/y-1 | |
3049 x-1/y x/y x+1/y | |
3050 x-1/y+1 x/y+1 x+1/y+1) | |
3051 @end display | |
3052 @end ifnottex | |
3053 | |
3054 The resulting pixel is computed from the color intensity of the color | |
3055 resulting from summing up the RGB values of surrounding pixels, | |
3056 multiplied by the specified factors, and dividing that sum by the sum | |
3057 of the factors' absolute values. | |
3058 | |
3059 Laplace edge-detection currently uses a matrix of | |
3060 @iftex | |
3061 @tex | |
3062 $$\pmatrix{1 & 0 & 0 \cr | |
3063 0& 0 & 0 \cr | |
3064 9 & 9 & -1 \cr}$$ | |
3065 @end tex | |
3066 @end iftex | |
3067 @ifnottex | |
3068 @display | |
3069 (1 0 0 | |
3070 0 0 0 | |
3071 9 9 -1) | |
3072 @end display | |
3073 @end ifnottex | |
3074 | |
3075 Emboss edge-detection uses a matrix of | |
3076 @iftex | |
3077 @tex | |
3078 $$\pmatrix{ 2 & -1 & 0 \cr | |
3079 -1 & 0 & 1 \cr | |
3080 0 & 1 & -2 \cr}$$ | |
3081 @end tex | |
3082 @end iftex | |
3083 @ifnottex | |
3084 @display | |
3085 ( 2 -1 0 | |
3086 -1 0 1 | |
3087 0 1 -2) | |
3088 @end display | |
3089 @end ifnottex | |
3090 | |
3091 @item disabled | |
3092 Specifies transforming the image so that it looks ``disabled''. | |
3093 @end table | |
3094 | |
3095 @item :mask @var{mask} | |
3096 If @var{mask} is @code{heuristic} or @code{(heuristic @var{bg})}, build | |
3097 a clipping mask for the image, so that the background of a frame is | |
3098 visible behind the image. If @var{bg} is not specified, or if @var{bg} | |
3099 is @code{t}, determine the background color of the image by looking at | |
3100 the four corners of the image, assuming the most frequently occurring | |
3101 color from the corners is the background color of the image. Otherwise, | |
3102 @var{bg} must be a list @code{(@var{red} @var{green} @var{blue})} | |
3103 specifying the color to assume for the background of the image. | |
3104 | |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
3105 If @var{mask} is @code{nil}, remove a mask from the image, if it has |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
3106 one. Images in some formats include a mask which can be removed by |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
3107 specifying @code{:mask nil}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3108 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3109 |
33996 | 3110 @defun image-mask-p spec &optional frame |
3111 @tindex image-mask-p | |
3112 This function returns @code{t} if image @var{spec} has a mask bitmap. | |
3113 @var{frame} is the frame on which the image will be displayed. | |
39404
5b69d94ceef3
(Font Lookup, Attribute Functions)
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
3114 @var{frame} @code{nil} or omitted means to use the selected frame |
5b69d94ceef3
(Font Lookup, Attribute Functions)
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
3115 (@pxref{Input Focus}). |
33996 | 3116 @end defun |
3117 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3118 @node XBM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3119 @subsection XBM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3120 @cindex XBM |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3121 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3122 To use XBM format, specify @code{xbm} as the image type. This image |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3123 format doesn't require an external library, so images of this type are |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3124 always supported. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3125 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3126 Additional image properties supported for the @code{xbm} image type are: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3127 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3128 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3129 @item :foreground @var{foreground} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3130 The value, @var{foreground}, should be a string specifying the image |
37949
1302dd937a79
Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents:
37170
diff
changeset
|
3131 foreground color, or @code{nil} for the default color. This color is |
1302dd937a79
Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents:
37170
diff
changeset
|
3132 used for each pixel in the XBM that is 1. The default is the frame's |
1302dd937a79
Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents:
37170
diff
changeset
|
3133 foreground color. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3134 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3135 @item :background @var{background} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3136 The value, @var{background}, should be a string specifying the image |
37949
1302dd937a79
Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents:
37170
diff
changeset
|
3137 background color, or @code{nil} for the default color. This color is |
1302dd937a79
Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents:
37170
diff
changeset
|
3138 used for each pixel in the XBM that is 0. The default is the frame's |
1302dd937a79
Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents:
37170
diff
changeset
|
3139 background color. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3140 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3141 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3142 If you specify an XBM image using data within Emacs instead of an |
28792 | 3143 external file, use the following three properties: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3144 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3145 @table @code |
28792 | 3146 @item :data @var{data} |
3147 The value, @var{data}, specifies the contents of the image. | |
3148 There are three formats you can use for @var{data}: | |
3149 | |
3150 @itemize @bullet | |
3151 @item | |
3152 A vector of strings or bool-vectors, each specifying one line of the | |
3153 image. Do specify @code{:height} and @code{:width}. | |
3154 | |
3155 @item | |
3156 A string containing the same byte sequence as an XBM file would contain. | |
3157 You must not specify @code{:height} and @code{:width} in this case, | |
3158 because omitting them is what indicates the data has the format of an | |
3159 XBM file. The file contents specify the height and width of the image. | |
3160 | |
3161 @item | |
3162 A string or a bool-vector containing the bits of the image (plus perhaps | |
3163 some extra bits at the end that will not be used). It should contain at | |
3164 least @var{width} * @code{height} bits. In this case, you must specify | |
3165 @code{:height} and @code{:width}, both to indicate that the string | |
3166 contains just the bits rather than a whole XBM file, and to specify the | |
3167 size of the image. | |
3168 @end itemize | |
3169 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3170 @item :width @var{width} |
28792 | 3171 The value, @var{width}, specifies the width of the image, in pixels. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3172 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3173 @item :height @var{height} |
28792 | 3174 The value, @var{height}, specifies the height of the image, in pixels. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3175 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3176 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3177 @node XPM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3178 @subsection XPM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3179 @cindex XPM |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3180 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3181 To use XPM format, specify @code{xpm} as the image type. The |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3182 additional image property @code{:color-symbols} is also meaningful with |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3183 the @code{xpm} image type: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3184 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3185 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3186 @item :color-symbols @var{symbols} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3187 The value, @var{symbols}, should be an alist whose elements have the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3188 form @code{(@var{name} . @var{color})}. In each element, @var{name} is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3189 the name of a color as it appears in the image file, and @var{color} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3190 specifies the actual color to use for displaying that name. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3191 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3192 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3193 @node GIF Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3194 @subsection GIF Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3195 @cindex GIF |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3196 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3197 For GIF images, specify image type @code{gif}. Because of the patents |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3198 in the US covering the LZW algorithm, the continued use of GIF format is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3199 a problem for the whole Internet; to end this problem, it is a good idea |
56020 | 3200 for everyone, even outside the US, to stop using GIFs right away |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3201 (@uref{http://www.burnallgifs.org/}). But if you still want to use |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3202 them, Emacs can display them. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3203 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3204 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3205 @item :index @var{index} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3206 You can use @code{:index} to specify one image from a GIF file that |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3207 contains more than one image. This property specifies use of image |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
3208 number @var{index} from the file. If the GIF file doesn't contain an |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
3209 image with index @var{index}, the image displays as a hollow box. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3210 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3211 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3212 @ignore |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3213 This could be used to implement limited support for animated GIFs. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3214 For example, the following function displays a multi-image GIF file |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3215 at point-min in the current buffer, switching between sub-images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3216 every 0.1 seconds. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3217 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3218 (defun show-anim (file max) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3219 "Display multi-image GIF file FILE which contains MAX subimages." |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3220 (display-anim (current-buffer) file 0 max t)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3221 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3222 (defun display-anim (buffer file idx max first-time) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3223 (when (= idx max) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3224 (setq idx 0)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3225 (let ((img (create-image file nil :image idx))) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3226 (save-excursion |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3227 (set-buffer buffer) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3228 (goto-char (point-min)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3229 (unless first-time (delete-char 1)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3230 (insert-image img)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3231 (run-with-timer 0.1 nil 'display-anim buffer file (1+ idx) max nil))) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3232 @end ignore |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3233 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3234 @node Postscript Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3235 @subsection Postscript Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3236 @cindex Postscript images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3237 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3238 To use Postscript for an image, specify image type @code{postscript}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3239 This works only if you have Ghostscript installed. You must always use |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3240 these three properties: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3241 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3242 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3243 @item :pt-width @var{width} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3244 The value, @var{width}, specifies the width of the image measured in |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3245 points (1/72 inch). @var{width} must be an integer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3246 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3247 @item :pt-height @var{height} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3248 The value, @var{height}, specifies the height of the image in points |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3249 (1/72 inch). @var{height} must be an integer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3250 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3251 @item :bounding-box @var{box} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3252 The value, @var{box}, must be a list or vector of four integers, which |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3253 specifying the bounding box of the Postscript image, analogous to the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3254 @samp{BoundingBox} comment found in Postscript files. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3255 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3256 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3257 %%BoundingBox: 22 171 567 738 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3258 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3259 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3260 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3261 Displaying Postscript images from Lisp data is not currently |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3262 implemented, but it may be implemented by the time you read this. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3263 See the @file{etc/NEWS} file to make sure. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3264 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3265 @node Other Image Types |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3266 @subsection Other Image Types |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3267 @cindex PBM |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3268 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3269 For PBM images, specify image type @code{pbm}. Color, gray-scale and |
32552
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3270 monochromatic images are supported. For mono PBM images, two additional |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3271 image properties are supported. |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3272 |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3273 @table @code |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3274 @item :foreground @var{foreground} |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3275 The value, @var{foreground}, should be a string specifying the image |
37949
1302dd937a79
Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents:
37170
diff
changeset
|
3276 foreground color, or @code{nil} for the default color. This color is |
1302dd937a79
Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents:
37170
diff
changeset
|
3277 used for each pixel in the XBM that is 1. The default is the frame's |
1302dd937a79
Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents:
37170
diff
changeset
|
3278 foreground color. |
32552
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3279 |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3280 @item :background @var{background} |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3281 The value, @var{background}, should be a string specifying the image |
37949
1302dd937a79
Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents:
37170
diff
changeset
|
3282 background color, or @code{nil} for the default color. This color is |
1302dd937a79
Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents:
37170
diff
changeset
|
3283 used for each pixel in the XBM that is 0. The default is the frame's |
1302dd937a79
Add that PBM and XBM image specs may have :foreground nil, and
Gerd Moellmann <gerd@gnu.org>
parents:
37170
diff
changeset
|
3284 background color. |
32552
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3285 @end table |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3286 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3287 For JPEG images, specify image type @code{jpeg}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3288 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3289 For TIFF images, specify image type @code{tiff}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3290 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3291 For PNG images, specify image type @code{png}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3292 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3293 @node Defining Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3294 @subsection Defining Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3295 |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3296 The functions @code{create-image}, @code{defimage} and |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3297 @code{find-image} provide convenient ways to create image descriptors. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3298 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3299 @defun create-image file &optional type &rest props |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3300 @tindex create-image |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3301 This function creates and returns an image descriptor which uses the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3302 data in @var{file}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3303 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3304 The optional argument @var{type} is a symbol specifying the image type. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3305 If @var{type} is omitted or @code{nil}, @code{create-image} tries to |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3306 determine the image type from the file's first few bytes, or else |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3307 from the file's name. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3308 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3309 The remaining arguments, @var{props}, specify additional image |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3310 properties---for example, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3311 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3312 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3313 (create-image "foo.xpm" 'xpm :heuristic-mask t) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3314 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3315 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3316 The function returns @code{nil} if images of this type are not |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3317 supported. Otherwise it returns an image descriptor. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3318 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3319 |
41058
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3320 @defmac defimage symbol specs &optional doc |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3321 @tindex defimage |
41058
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3322 This macro defines @var{symbol} as an image name. The arguments |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3323 @var{specs} is a list which specifies how to display the image. |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3324 The third argument, @var{doc}, is an optional documentation string. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3325 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3326 Each argument in @var{specs} has the form of a property list, and each |
41058
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3327 one should specify at least the @code{:type} property and either the |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3328 @code{:file} or the @code{:data} property. The value of @code{:type} |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3329 should be a symbol specifying the image type, the value of |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3330 @code{:file} is the file to load the image from, and the value of |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3331 @code{:data} is a string containing the actual image data. Here is an |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3332 example: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3333 |
25875 | 3334 @example |
3335 (defimage test-image | |
46338
6cf0fbc1d7da
defimage does not evaluate SPECS.
Richard M. Stallman <rms@gnu.org>
parents:
46245
diff
changeset
|
3336 ((:type xpm :file "~/test1.xpm") |
6cf0fbc1d7da
defimage does not evaluate SPECS.
Richard M. Stallman <rms@gnu.org>
parents:
46245
diff
changeset
|
3337 (:type xbm :file "~/test1.xbm"))) |
25875 | 3338 @end example |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3339 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3340 @code{defimage} tests each argument, one by one, to see if it is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3341 usable---that is, if the type is supported and the file exists. The |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3342 first usable argument is used to make an image descriptor which is |
41058
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3343 stored in @var{symbol}. |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3344 |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3345 If none of the alternatives will work, then @var{symbol} is defined |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3346 as @code{nil}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3347 @end defmac |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3348 |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3349 @defun find-image specs |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3350 @tindex find-image |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3351 This function provides a convenient way to find an image satisfying one |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3352 of a list of image specifications @var{specs}. |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3353 |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3354 Each specification in @var{specs} is a property list with contents |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3355 depending on image type. All specifications must at least contain the |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3356 properties @code{:type @var{type}} and either @w{@code{:file @var{file}}} |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3357 or @w{@code{:data @var{DATA}}}, where @var{type} is a symbol specifying |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3358 the image type, e.g.@: @code{xbm}, @var{file} is the file to load the |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3359 image from, and @var{data} is a string containing the actual image data. |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3360 The first specification in the list whose @var{type} is supported, and |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3361 @var{file} exists, is used to construct the image specification to be |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3362 returned. If no specification is satisfied, @code{nil} is returned. |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3363 |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3364 The image is looked for first on @code{load-path} and then in |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3365 @code{data-directory}. |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3366 @end defun |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3367 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3368 @node Showing Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3369 @subsection Showing Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3370 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3371 You can use an image descriptor by setting up the @code{display} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3372 property yourself, but it is easier to use the functions in this |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3373 section. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3374 |
29471 | 3375 @defun insert-image image &optional string area |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3376 This function inserts @var{image} in the current buffer at point. The |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3377 value @var{image} should be an image descriptor; it could be a value |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3378 returned by @code{create-image}, or the value of a symbol defined with |
25875 | 3379 @code{defimage}. The argument @var{string} specifies the text to put in |
3380 the buffer to hold the image. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3381 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3382 The argument @var{area} specifies whether to put the image in a margin. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3383 If it is @code{left-margin}, the image appears in the left margin; |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3384 @code{right-margin} specifies the right margin. If @var{area} is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3385 @code{nil} or omitted, the image is displayed at point within the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3386 buffer's text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3387 |
25875 | 3388 Internally, this function inserts @var{string} in the buffer, and gives |
3389 it a @code{display} property which specifies @var{image}. @xref{Display | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3390 Property}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3391 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3392 |
29471 | 3393 @defun put-image image pos &optional string area |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3394 This function puts image @var{image} in front of @var{pos} in the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3395 current buffer. The argument @var{pos} should be an integer or a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3396 marker. It specifies the buffer position where the image should appear. |
29471 | 3397 The argument @var{string} specifies the text that should hold the image |
3398 as an alternative to the default. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3399 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3400 The argument @var{image} must be an image descriptor, perhaps returned |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3401 by @code{create-image} or stored by @code{defimage}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3402 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3403 The argument @var{area} specifies whether to put the image in a margin. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3404 If it is @code{left-margin}, the image appears in the left margin; |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3405 @code{right-margin} specifies the right margin. If @var{area} is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3406 @code{nil} or omitted, the image is displayed at point within the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3407 buffer's text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3408 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3409 Internally, this function creates an overlay, and gives it a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3410 @code{before-string} property containing text that has a @code{display} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3411 property whose value is the image. (Whew!) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3412 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3413 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3414 @defun remove-images start end &optional buffer |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3415 This function removes images in @var{buffer} between positions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3416 @var{start} and @var{end}. If @var{buffer} is omitted or @code{nil}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3417 images are removed from the current buffer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3418 |
27331
be0a552c8320
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
3419 This removes only images that were put into @var{buffer} the way |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3420 @code{put-image} does it, not images that were inserted with |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3421 @code{insert-image} or in other ways. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3422 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3423 |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3424 @defun image-size spec &optional pixels frame |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3425 @tindex image-size |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3426 This function returns the size of an image as a pair |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3427 @w{@code{(@var{width} . @var{height})}}. @var{spec} is an image |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
3428 specification. @var{pixels} non-@code{nil} means return sizes |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
3429 measured in pixels, otherwise return sizes measured in canonical |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
3430 character units (fractions of the width/height of the frame's default |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
3431 font). @var{frame} is the frame on which the image will be displayed. |
39404
5b69d94ceef3
(Font Lookup, Attribute Functions)
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
3432 @var{frame} null or omitted means use the selected frame (@pxref{Input |
5b69d94ceef3
(Font Lookup, Attribute Functions)
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
3433 Focus}). |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3434 @end defun |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3435 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3436 @node Image Cache |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3437 @subsection Image Cache |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3438 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3439 Emacs stores images in an image cache when it displays them, so it can |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3440 display them again more efficiently. It removes an image from the cache |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3441 when it hasn't been displayed for a specified period of time. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3442 |
28770 | 3443 When an image is looked up in the cache, its specification is compared |
3444 with cached image specifications using @code{equal}. This means that | |
3445 all images with equal specifications share the same image in the cache. | |
3446 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3447 @defvar image-cache-eviction-delay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3448 @tindex image-cache-eviction-delay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3449 This variable specifies the number of seconds an image can remain in the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3450 cache without being displayed. When an image is not displayed for this |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3451 length of time, Emacs removes it from the image cache. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3452 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3453 If the value is @code{nil}, Emacs does not remove images from the cache |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3454 except when you explicitly clear it. This mode can be useful for |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3455 debugging. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3456 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3457 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3458 @defun clear-image-cache &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3459 @tindex clear-image-cache |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3460 This function clears the image cache. If @var{frame} is non-@code{nil}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3461 only the cache for that frame is cleared. Otherwise all frames' caches |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3462 are cleared. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3463 @end defun |
27447
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
3464 |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3465 @node Buttons |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3466 @section Buttons |
53468
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3467 @cindex buttons |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3468 @cindex buttons in buffers |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3469 @cindex clickable buttons in buffers |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3470 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3471 The @emph{button} package defines functions for inserting and |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3472 manipulating clickable (with the mouse, or via keyboard commands) |
53468
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3473 buttons in Emacs buffers, such as might be used for help hyper-links, |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3474 etc. Emacs uses buttons for the hyper-links in help text and the like. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3475 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3476 A button is essentially a set of properties attached (via text |
55246 | 3477 properties or overlays) to a region of text in an Emacs buffer, which |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3478 are called its button properties. @xref{Button Properties}. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3479 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3480 One of the these properties (@code{action}) is a function, which will |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3481 be called when the user invokes it using the keyboard or the mouse. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3482 The invoked function may then examine the button and use its other |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3483 properties as desired. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3484 |
55246 | 3485 In some ways the Emacs button package duplicates functionality offered |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3486 by the widget package (@pxref{Top, , Introduction, widget, The Emacs |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3487 Widget Library}), but the button package has the advantage that it is |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3488 much faster, much smaller, and much simpler to use (for elisp |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3489 programmers---for users, the result is about the same). The extra |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3490 speed and space savings are useful mainly if you need to create many |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3491 buttons in a buffer (for instance an @code{*Apropos*} buffer uses |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3492 buttons to make entries clickable, and may contain many thousands of |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3493 entries). |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3494 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3495 @menu |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3496 * Button Properties:: Button properties with special meanings. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3497 * Button Types:: Defining common properties for classes of buttons. |
55246 | 3498 * Making Buttons:: Adding buttons to Emacs buffers. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3499 * Manipulating Buttons:: Getting and setting properties of buttons. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3500 * Button Buffer Commands:: Buffer-wide commands and bindings for buttons. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3501 * Manipulating Button Types:: |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3502 @end menu |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3503 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3504 @node Button Properties |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3505 @subsection Button Properties |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3506 @cindex button properties |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3507 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3508 Buttons have an associated list of properties defining their |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3509 appearance and behavior, and other arbitrary properties may be used |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3510 for application specific purposes. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3511 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3512 Some properties that have special meaning to the button package |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3513 include: |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3514 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3515 @table @code |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3516 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3517 @item action |
53468
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3518 @kindex action @r{(button property)} |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3519 The function to call when the user invokes the button, which is passed |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3520 the single argument @var{button}. By default this is @code{ignore}, |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3521 which does nothing. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3522 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3523 @item mouse-action |
53468
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3524 @kindex mouse-action @r{(button property)} |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3525 This is similar to @code{action}, and when present, will be used |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3526 instead of @code{action} for button invocations resulting from |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3527 mouse-clicks (instead of the user hitting @key{RET}). If not |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3528 present, mouse-clicks use @code{action} instead. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3529 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3530 @item face |
53468
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3531 @kindex face @r{(button property)} |
55246 | 3532 This is an Emacs face controlling how buttons of this type are |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3533 displayed; by default this is the @code{button} face. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3534 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3535 @item mouse-face |
53468
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3536 @kindex mouse-face @r{(button property)} |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3537 This is an additional face which controls appearance during |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3538 mouse-overs (merged with the usual button face); by default this is |
55246 | 3539 the usual Emacs @code{highlight} face. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3540 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3541 @item keymap |
53468
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3542 @kindex keymap @r{(button property)} |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3543 The button's keymap, defining bindings active within the button |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3544 region. By default this is the usual button region keymap, stored |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3545 in the variable @code{button-map}, which defines @key{RET} and |
53829
83980e864dd7
(Button Properties, Button Buffer Commands): mouse-2 invokes button,
John Paul Wallington <jpw@pobox.com>
parents:
53468
diff
changeset
|
3546 @key{mouse-2} to invoke the button. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3547 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3548 @item type |
53468
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3549 @kindex type @r{(button property)} |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3550 The button-type of the button. When creating a button, this is |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3551 usually specified using the @code{:type} keyword argument. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3552 @xref{Button Types}. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3553 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3554 @item help-echo |
53468
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3555 @kindex help-index @r{(button property)} |
55246 | 3556 A string displayed by the Emacs tool-tip help system; by default, |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3557 @code{"mouse-2, RET: Push this button"}. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3558 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3559 @item button |
53468
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3560 @kindex button @r{(button property)} |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3561 All buttons have a non-@code{nil} @code{button} property, which may be useful |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3562 in finding regions of text that comprise buttons (which is what the |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3563 standard button functions do). |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3564 @end table |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3565 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3566 There are other properties defined for the regions of text in a |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3567 button, but these are not generally interesting for typical uses. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3568 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3569 @node Button Types |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3570 @subsection Button Types |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3571 @cindex button types |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3572 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3573 Every button has a button @emph{type}, which defines default values |
53468
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3574 for the button's properties. Button types are arranged in a |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3575 hierarchy, with specialized types inheriting from more general types, |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3576 so that it's easy to define special-purpose types of buttons for |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3577 specific tasks. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3578 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3579 @defun define-button-type name &rest properties |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3580 @tindex define-button-type |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3581 Define a `button type' called @var{name}. The remaining arguments |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3582 form a sequence of @var{property value} pairs, specifying default |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3583 property values for buttons with this type (a button's type may be set |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3584 by giving it a @code{type} property when creating the button, using |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3585 the @code{:type} keyword argument). |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3586 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3587 In addition, the keyword argument @code{:supertype} may be used to |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3588 specify a button-type from which @var{name} inherits its default |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3589 property values. Note that this inheritance happens only when |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3590 @var{name} is defined; subsequent changes to a supertype are not |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3591 reflected in its subtypes. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3592 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3593 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3594 Using @code{define-button-type} to define default properties for |
53468
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3595 buttons is not necessary---buttons without any specified type use the |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3596 built-in button-type @code{button}---but it is is encouraged, since |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3597 doing so usually makes the resulting code clearer and more efficient. |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3598 |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3599 @node Making Buttons |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3600 @subsection Making Buttons |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3601 @cindex making buttons |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3602 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3603 Buttons are associated with a region of text, using an overlay or |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3604 text-properties to hold button-specific information, all of which are |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3605 initialized from the button's type (which defaults to the built-in |
55246 | 3606 button type @code{button}). Like all Emacs text, the appearance of |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3607 the button is governed by the @code{face} property; by default (via |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3608 the @code{face} property inherited from the @code{button} button-type) |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3609 this is a simple underline, like a typical web-page link. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3610 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3611 For convenience, there are two sorts of button-creation functions, |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3612 those that add button properties to an existing region of a buffer, |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3613 called @code{make-...button}, and those also insert the button text, |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3614 called @code{insert-...button}. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3615 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3616 The button-creation functions all take the @code{&rest} argument |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3617 @var{properties}, which should be a sequence of @var{property value} |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3618 pairs, specifying properties to add to the button; see @ref{Button |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3619 Properties}. In addition, the keyword argument @code{:type} may be |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3620 used to specify a button-type from which to inherit other properties; |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3621 see @ref{Button Types}. Any properties not explicitly specified |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3622 during creation will be inherited from the button's type (if the type |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3623 defines such a property). |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3624 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3625 The following functions add a button using an overlay |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3626 (@pxref{Overlays}) to hold the button properties: |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3627 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3628 @defun make-button beg end &rest properties |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3629 @tindex make-button |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3630 Make a button from @var{beg} to @var{end} in the current buffer. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3631 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3632 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3633 @defun insert-button label &rest properties |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3634 @tindex insert-button |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3635 Insert a button with the label @var{label}. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3636 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3637 |
55246 | 3638 The following functions are similar, but use Emacs text-properties |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3639 (@pxref{Text Properties}) to hold the button properties, making the |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3640 button actually part of the text instead of being a property of the |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3641 buffer (using text-properties is usually faster than using overlays, |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3642 so this may be preferable when creating large numbers of buttons): |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3643 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3644 @defun make-text-button beg end &rest properties |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3645 @tindex make-text-button |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3646 Make a button from @var{beg} to @var{end} in the current buffer, using |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3647 text-properties. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3648 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3649 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3650 @defun insert-text-button label &rest properties |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3651 @tindex insert-text-button |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3652 Insert a button with the label @var{label}, using text-properties. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3653 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3654 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3655 Buttons using text-properties retain no markers into the buffer are |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3656 retained, which is important for speed in cases where there are |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3657 extremely large numbers of buttons. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3658 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3659 @node Manipulating Buttons |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3660 @subsection Manipulating Buttons |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3661 @cindex manipulating buttons |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3662 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3663 These are functions for getting and setting properties of buttons. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3664 Often these are used by a button's invocation function to determine |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3665 what to do. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3666 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3667 Where a @var{button} parameter is specified, it means an object |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3668 referring to a specific button, either an overlay (for overlay |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3669 buttons), or a buffer-position or marker (for text property buttons). |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3670 Such an object is passed as the first argument to a button's |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3671 invocation function when it is invoked. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3672 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3673 @defun button-start button |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3674 @tindex button-start |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3675 Return the position at which @var{button} starts. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3676 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3677 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3678 @defun button-end button |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3679 @tindex button-end |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3680 Return the position at which @var{button} ends. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3681 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3682 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3683 @defun button-get button prop |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3684 @tindex button-get |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3685 Get the property of button @var{button} named @var{prop}. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3686 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3687 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3688 @defun button-put button prop val |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3689 @tindex button-put |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3690 Set @var{button}'s @var{prop} property to @var{val}. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3691 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3692 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3693 @defun button-activate button &optional use-mouse-action |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3694 @tindex button-activate |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3695 Call @var{button}'s @code{action} property (i.e., invoke it). If |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3696 @var{use-mouse-action} is non-@code{nil}, try to invoke the button's |
53468
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3697 @code{mouse-action} property instead of @code{action}; if the button |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3698 has no @code{mouse-action} property, use @code{action} as normal. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3699 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3700 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3701 @defun button-label button |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3702 @tindex button-label |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3703 Return @var{button}'s text label. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3704 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3705 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3706 @defun button-type button |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3707 @tindex button-type |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3708 Return @var{button}'s button-type. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3709 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3710 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3711 @defun button-has-type-p button type |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3712 @tindex button-has-type-p |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3713 Return @code{t} if @var{button} has button-type @var{type}, or one of |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3714 @var{type}'s subtypes. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3715 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3716 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3717 @defun button-at pos |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3718 @tindex button-at |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3719 Return the button at position @var{pos} in the current buffer, or @code{nil}. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3720 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3721 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3722 @node Button Buffer Commands |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3723 @subsection Button Buffer Commands |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3724 @cindex button buffer commands |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3725 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3726 These are commands and functions for locating and operating on |
55246 | 3727 buttons in an Emacs buffer. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3728 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3729 @code{push-button} is the command that a user uses to actually `push' |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3730 a button, and is bound by default in the button itself to @key{RET} |
53829
83980e864dd7
(Button Properties, Button Buffer Commands): mouse-2 invokes button,
John Paul Wallington <jpw@pobox.com>
parents:
53468
diff
changeset
|
3731 and to @key{mouse-2} using a region-specific keymap. Commands |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3732 that are useful outside the buttons itself, such as |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3733 @code{forward-button} and @code{backward-button} are additionally |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3734 available in the keymap stored in @code{button-buffer-map}; a mode |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3735 which uses buttons may want to use @code{button-buffer-map} as a |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3736 parent keymap for its keymap. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3737 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3738 @deffn Command push-button &optional pos use-mouse-action |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3739 @tindex push-button |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3740 Perform the action specified by a button at location @var{pos}. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3741 @var{pos} may be either a buffer position or a mouse-event. If |
53468
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3742 @var{use-mouse-action} is non-@code{nil}, or @var{pos} is a |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3743 mouse-event (@pxref{Mouse Events}), try to invoke the button's |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3744 @code{mouse-action} property instead of @code{action}; if the button |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3745 has no @code{mouse-action} property, use @code{action} as normal. |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3746 @var{pos} defaults to point, except when @code{push-button} is invoked |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3747 interactively as the result of a mouse-event, in which case, the mouse |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3748 event's position is used. If there's no button at @var{pos}, do |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3749 nothing and return @code{nil}, otherwise return @code{t}. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3750 @end deffn |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3751 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3752 @deffn Command forward-button n &optional wrap display-message |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3753 @tindex forward-button |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3754 Move to the @var{n}th next button, or @var{n}th previous button if |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3755 @var{n} is negative. If @var{n} is zero, move to the start of any |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3756 button at point. If @var{wrap} is non-@code{nil}, moving past either |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3757 end of the buffer continues from the other end. If |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3758 @var{display-message} is non-@code{nil}, the button's help-echo string |
53468
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3759 is displayed. Any button with a non-@code{nil} @code{skip} property |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3760 is skipped over. Returns the button found. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3761 @end deffn |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3762 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3763 @deffn Command backward-button n &optional wrap display-message |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3764 @tindex backward-button |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3765 Move to the @var{n}th previous button, or @var{n}th next button if |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3766 @var{n} is negative. If @var{n} is zero, move to the start of any |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3767 button at point. If @var{wrap} is non-@code{nil}, moving past either |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3768 end of the buffer continues from the other end. If |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3769 @var{display-message} is non-@code{nil}, the button's help-echo string |
53468
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3770 is displayed. Any button with a non-@code{nil} @code{skip} property |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
3771 is skipped over. Returns the button found. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3772 @end deffn |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3773 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3774 @defun next-button pos &optional count-current |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3775 @tindex next-button |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3776 Return the next button after position @var{pos} in the current buffer. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3777 If @var{count-current} is non-@code{nil}, count any button at |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3778 @var{pos} in the search, instead of starting at the next button. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3779 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3780 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3781 @defun previous-button pos &optional count-current |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3782 @tindex previous-button |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3783 Return the @var{n}th button before position @var{pos} in the current |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3784 buffer. If @var{count-current} is non-@code{nil}, count any button at |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3785 @var{pos} in the search, instead of starting at the next button. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3786 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3787 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3788 @node Manipulating Button Types |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3789 @subsection Manipulating Button Types |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3790 @cindex manipulating button types |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3791 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3792 @defun button-type-put type prop val |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3793 @tindex button-type-put |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3794 Set the button-type @var{type}'s @var{prop} property to @var{val}. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3795 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3796 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3797 @defun button-type-get type prop |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3798 @tindex button-type-get |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3799 Get the property of button-type @var{type} named @var{prop}. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3800 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3801 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3802 @defun button-type-subtype-p type supertype |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3803 @tindex button-type-subtype-p |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3804 Return @code{t} if button-type @var{type} is a subtype of @var{supertype}. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3805 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3806 |
6598 | 3807 @node Blinking |
3808 @section Blinking Parentheses | |
3809 @cindex parenthesis matching | |
3810 @cindex blinking | |
3811 @cindex balancing parentheses | |
3812 @cindex close parenthesis | |
3813 | |
3814 This section describes the mechanism by which Emacs shows a matching | |
3815 open parenthesis when the user inserts a close parenthesis. | |
3816 | |
3817 @defvar blink-paren-function | |
3818 The value of this variable should be a function (of no arguments) to | |
3819 be called whenever a character with close parenthesis syntax is inserted. | |
3820 The value of @code{blink-paren-function} may be @code{nil}, in which | |
3821 case nothing is done. | |
3822 @end defvar | |
3823 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
3824 @defopt blink-matching-paren |
6598 | 3825 If this variable is @code{nil}, then @code{blink-matching-open} does |
3826 nothing. | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
3827 @end defopt |
6598 | 3828 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
3829 @defopt blink-matching-paren-distance |
6598 | 3830 This variable specifies the maximum distance to scan for a matching |
3831 parenthesis before giving up. | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
3832 @end defopt |
6598 | 3833 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
3834 @defopt blink-matching-delay |
12098 | 3835 This variable specifies the number of seconds for the cursor to remain |
3836 at the matching parenthesis. A fraction of a second often gives | |
3837 good results, but the default is 1, which works on all systems. | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
3838 @end defopt |
12098 | 3839 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
3840 @deffn Command blink-matching-open |
6598 | 3841 This function is the default value of @code{blink-paren-function}. It |
3842 assumes that point follows a character with close parenthesis syntax and | |
3843 moves the cursor momentarily to the matching opening character. If that | |
3844 character is not already on the screen, it displays the character's | |
3845 context in the echo area. To avoid long delays, this function does not | |
3846 search farther than @code{blink-matching-paren-distance} characters. | |
3847 | |
3848 Here is an example of calling this function explicitly. | |
3849 | |
3850 @smallexample | |
3851 @group | |
3852 (defun interactive-blink-matching-open () | |
3853 @c Do not break this line! -- rms. | |
3854 @c The first line of a doc string | |
3855 @c must stand alone. | |
3856 "Indicate momentarily the start of sexp before point." | |
3857 (interactive) | |
3858 @end group | |
3859 @group | |
3860 (let ((blink-matching-paren-distance | |
3861 (buffer-size)) | |
3862 (blink-matching-paren t)) | |
3863 (blink-matching-open))) | |
3864 @end group | |
3865 @end smallexample | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
3866 @end deffn |
6598 | 3867 |
3868 @node Inverse Video | |
3869 @section Inverse Video | |
3870 @cindex Inverse Video | |
3871 | |
3872 @defopt inverse-video | |
3873 @cindex highlighting | |
3874 This variable controls whether Emacs uses inverse video for all text | |
3875 on the screen. Non-@code{nil} means yes, @code{nil} means no. The | |
3876 default is @code{nil}. | |
3877 @end defopt | |
3878 | |
3879 @defopt mode-line-inverse-video | |
25875 | 3880 This variable controls the use of inverse video for mode lines and menu |
3881 bars. If it is non-@code{nil}, then these lines are displayed in | |
27331
be0a552c8320
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
3882 inverse video. Otherwise, these lines are displayed normally, just like |
25875 | 3883 other text. The default is @code{t}. |
3884 | |
3885 For window frames, this feature actually applies the face named | |
3886 @code{mode-line}; that face is normally set up as the inverse of the | |
3887 default face, unless you change it. | |
6598 | 3888 @end defopt |
3889 | |
3890 @node Usual Display | |
3891 @section Usual Display Conventions | |
3892 | |
3893 The usual display conventions define how to display each character | |
3894 code. You can override these conventions by setting up a display table | |
3895 (@pxref{Display Tables}). Here are the usual display conventions: | |
3896 | |
3897 @itemize @bullet | |
3898 @item | |
3899 Character codes 32 through 126 map to glyph codes 32 through 126. | |
3900 Normally this means they display as themselves. | |
3901 | |
3902 @item | |
3903 Character code 9 is a horizontal tab. It displays as whitespace | |
3904 up to a position determined by @code{tab-width}. | |
3905 | |
3906 @item | |
3907 Character code 10 is a newline. | |
3908 | |
3909 @item | |
3910 All other codes in the range 0 through 31, and code 127, display in one | |
9009 | 3911 of two ways according to the value of @code{ctl-arrow}. If it is |
6598 | 3912 non-@code{nil}, these codes map to sequences of two glyphs, where the |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52940
diff
changeset
|
3913 first glyph is the @acronym{ASCII} code for @samp{^}. (A display table can |
6598 | 3914 specify a glyph to use instead of @samp{^}.) Otherwise, these codes map |
3915 just like the codes in the range 128 to 255. | |
3916 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3917 On MS-DOS terminals, Emacs arranges by default for the character code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3918 127 to be mapped to the glyph code 127, which normally displays as an |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52940
diff
changeset
|
3919 empty polygon. This glyph is used to display non-@acronym{ASCII} characters |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3920 that the MS-DOS terminal doesn't support. @xref{MS-DOS and MULE,,, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3921 emacs, The GNU Emacs Manual}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3922 |
6598 | 3923 @item |
3924 Character codes 128 through 255 map to sequences of four glyphs, where | |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52940
diff
changeset
|
3925 the first glyph is the @acronym{ASCII} code for @samp{\}, and the others are |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
3926 digit characters representing the character code in octal. (A display |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
3927 table can specify a glyph to use instead of @samp{\}.) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
3928 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
3929 @item |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
3930 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
|
3931 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
|
3932 character. |
6598 | 3933 @end itemize |
3934 | |
3935 The usual display conventions apply even when there is a display | |
3936 table, for any character whose entry in the active display table is | |
3937 @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
|
3938 specify the characters for which you want special behavior. |
6598 | 3939 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
3940 These display rules apply to carriage return (character code 13), when |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
3941 it appears in the buffer. But that character may not appear in the |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
3942 buffer where you expect it, if it was eliminated as part of end-of-line |
25454 | 3943 conversion (@pxref{Coding System Basics}). |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
3944 |
6598 | 3945 These variables affect the way certain characters are displayed on the |
3946 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
|
3947 they also affect the indentation functions. These variables also affect |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
3948 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
|
3949 mode line using the new values, call the function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
3950 @code{force-mode-line-update} (@pxref{Mode Line Format}). |
6598 | 3951 |
3952 @defopt ctl-arrow | |
3953 @cindex control characters in display | |
3954 This buffer-local variable controls how control characters are | |
3955 displayed. If it is non-@code{nil}, they are displayed as a caret | |
3956 followed by the character: @samp{^A}. If it is @code{nil}, they are | |
3957 displayed as a backslash followed by three octal digits: @samp{\001}. | |
3958 @end defopt | |
3959 | |
3960 @c Following may have overfull hbox. | |
3961 @defvar default-ctl-arrow | |
3962 The value of this variable is the default value for @code{ctl-arrow} in | |
3963 buffers that do not override it. @xref{Default Value}. | |
3964 @end defvar | |
3965 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
3966 @defopt indicate-empty-lines |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
3967 @tindex indicate-empty-lines |
42905
09cd352a779e
(Truncation, Overlay Arrow, Usual Display): Add index entries for fringe
Eli Zaretskii <eliz@gnu.org>
parents:
42888
diff
changeset
|
3968 @cindex fringes, and empty line indication |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
3969 When this is non-@code{nil}, Emacs displays a special glyph in the |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
3970 fringe of each empty line at the end of the buffer, on terminals that |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
3971 support it (window systems). @xref{Fringes}. |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
3972 @end defopt |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
3973 |
6598 | 3974 @defopt tab-width |
3975 The value of this variable is the spacing between tab stops used for | |
25875 | 3976 displaying tab characters in Emacs buffers. The value is in units of |
3977 columns, and the default is 8. Note that this feature is completely | |
3978 independent of the user-settable tab stops used by the command | |
3979 @code{tab-to-tab-stop}. @xref{Indent Tabs}. | |
6598 | 3980 @end defopt |
3981 | |
3982 @node Display Tables | |
3983 @section Display Tables | |
3984 | |
3985 @cindex display table | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
3986 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
|
3987 character codes display on the screen. This is useful for displaying |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52940
diff
changeset
|
3988 European languages that have letters not in the @acronym{ASCII} character |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
3989 set. |
6598 | 3990 |
3991 The display table maps each character code into a sequence of | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3992 @dfn{glyphs}, each glyph being a graphic that takes up one character |
6598 | 3993 position on the screen. You can also define how to display each glyph |
3994 on your terminal, using the @dfn{glyph table}. | |
3995 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
3996 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
|
3997 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
|
3998 @code{force-mode-line-update} (@pxref{Mode Line Format}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
3999 |
6598 | 4000 @menu |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4001 * Display Table Format:: What a display table consists of. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4002 * Active Display Table:: How Emacs selects a display table to use. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4003 * Glyphs:: How to define a glyph, and what glyphs mean. |
6598 | 4004 @end menu |
4005 | |
4006 @node Display Table Format | |
4007 @subsection Display Table Format | |
4008 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4009 A display table is actually a char-table (@pxref{Char-Tables}) with |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4010 @code{display-table} as its subtype. |
6598 | 4011 |
4012 @defun make-display-table | |
4013 This creates and returns a display table. The table initially has | |
4014 @code{nil} in all elements. | |
4015 @end defun | |
4016 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4017 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
|
4018 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
|
4019 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
|
4020 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
|
4021 display that character according to the usual display conventions |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4022 (@pxref{Usual Display}). |
12067 | 4023 |
4024 If you use the display table to change the display of newline | |
4025 characters, the whole buffer will be displayed as one long ``line.'' | |
6598 | 4026 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4027 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
|
4028 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
|
4029 means to use the default for that slot, as stated below. |
6598 | 4030 |
4031 @table @asis | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4032 @item 0 |
6598 | 4033 The glyph for the end of a truncated screen line (the default for this |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4034 is @samp{$}). @xref{Glyphs}. Newer Emacs versions, on some platforms, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4035 display arrows to indicate truncation---the display table has no effect |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4036 in these situations. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4037 @item 1 |
6598 | 4038 The glyph for the end of a continued line (the default is @samp{\}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4039 Newer Emacs versions, on some platforms, display curved arrows to |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4040 indicate truncation---the display table has no effect in these |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4041 situations. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4042 @item 2 |
6598 | 4043 The glyph for indicating a character displayed as an octal character |
4044 code (the default is @samp{\}). | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4045 @item 3 |
6598 | 4046 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
|
4047 @item 4 |
6598 | 4048 A vector of glyphs for indicating the presence of invisible lines (the |
4049 default is @samp{...}). @xref{Selective Display}. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4050 @item 5 |
8925 | 4051 The glyph used to draw the border between side-by-side windows (the |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4052 default is @samp{|}). @xref{Splitting Windows}. This takes effect only |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4053 when there are no scroll bars; if scroll bars are supported and in use, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4054 a scroll bar separates the two windows. |
6598 | 4055 @end table |
4056 | |
4057 For example, here is how to construct a display table that mimics the | |
4058 effect of setting @code{ctl-arrow} to a non-@code{nil} value: | |
4059 | |
4060 @example | |
4061 (setq disptab (make-display-table)) | |
4062 (let ((i 0)) | |
4063 (while (< i 32) | |
4064 (or (= i ?\t) (= i ?\n) | |
4065 (aset disptab i (vector ?^ (+ i 64)))) | |
4066 (setq i (1+ i))) | |
4067 (aset disptab 127 (vector ?^ ??))) | |
4068 @end example | |
4069 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4070 @defun display-table-slot display-table slot |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4071 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
|
4072 @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
|
4073 5 inclusive, or a slot name (symbol). Valid symbols are |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4074 @code{truncation}, @code{wrap}, @code{escape}, @code{control}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4075 @code{selective-display}, and @code{vertical-border}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4076 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4077 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4078 @defun set-display-table-slot display-table slot value |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4079 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
|
4080 @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
|
4081 5 inclusive, or a slot name (symbol). Valid symbols are |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4082 @code{truncation}, @code{wrap}, @code{escape}, @code{control}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4083 @code{selective-display}, and @code{vertical-border}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4084 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4085 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4086 @defun describe-display-table display-table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4087 @tindex describe-display-table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4088 This function displays a description of the display table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4089 @var{display-table} in a help buffer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4090 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4091 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4092 @deffn Command describe-current-display-table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4093 @tindex describe-current-display-table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4094 This command displays a description of the current display table in a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4095 help buffer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4096 @end deffn |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4097 |
6598 | 4098 @node Active Display Table |
4099 @subsection Active Display Table | |
4100 @cindex active display table | |
4101 | |
4102 Each window can specify a display table, and so can each buffer. When | |
4103 a buffer @var{b} is displayed in window @var{w}, display uses the | |
4104 display table for window @var{w} if it has one; otherwise, the display | |
4105 table for buffer @var{b} if it has one; otherwise, the standard display | |
4106 table if any. The display table chosen is called the @dfn{active} | |
4107 display table. | |
4108 | |
4109 @defun window-display-table window | |
4110 This function returns @var{window}'s display table, or @code{nil} | |
4111 if @var{window} does not have an assigned display table. | |
4112 @end defun | |
4113 | |
4114 @defun set-window-display-table window table | |
4115 This function sets the display table of @var{window} to @var{table}. | |
4116 The argument @var{table} should be either a display table or | |
4117 @code{nil}. | |
4118 @end defun | |
4119 | |
4120 @defvar buffer-display-table | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4121 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
|
4122 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
|
4123 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
|
4124 table. |
6598 | 4125 @end defvar |
4126 | |
4127 @defvar standard-display-table | |
4128 This variable's value is the default display table, used whenever a | |
4129 window has no display table and neither does the buffer displayed in | |
4130 that window. This variable is @code{nil} by default. | |
4131 @end defvar | |
4132 | |
4133 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
|
4134 if the window specifies none, its buffer specifies none, and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4135 @code{standard-display-table} is @code{nil}---then Emacs uses the usual |
6598 | 4136 display conventions for all character codes in that window. @xref{Usual |
4137 Display}. | |
4138 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4139 A number of functions for changing the standard display table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4140 are defined in the library @file{disp-table}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4141 |
6598 | 4142 @node Glyphs |
4143 @subsection Glyphs | |
4144 | |
4145 @cindex glyph | |
4146 A @dfn{glyph} is a generalization of a character; it stands for an | |
4147 image that takes up a single character position on the screen. Glyphs | |
47482
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4148 are represented in Lisp as integers, just as characters are. Normally |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4149 Emacs finds glyphs in the display table (@pxref{Display Tables}). |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4150 |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4151 A glyph can be @dfn{simple} or it can be defined by the @dfn{glyph |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4152 table}. A simple glyph is just a way of specifying a character and a |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4153 face to output it in. The glyph code for a simple glyph, mod 524288, |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4154 is the character to output, and the glyph code divided by 524288 |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4155 specifies the face number (@pxref{Face Functions}) to use while |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4156 outputting it. (524288 is |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4157 @ifnottex |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4158 2**19.) |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4159 @end ifnottex |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4160 @tex |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4161 $2^{19}$.) |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4162 @end tex |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4163 @xref{Faces}. |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4164 |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4165 On character terminals, you can set up a @dfn{glyph table} to define |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4166 the meaning of glyph codes. The glyph codes is the value of the |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4167 variable @code{glyph-table}. |
6598 | 4168 |
4169 @defvar glyph-table | |
4170 The value of this variable is the current glyph table. It should be a | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
4171 vector; the @var{g}th element defines glyph code @var{g}. |
47482
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4172 |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4173 If a glyph code is greater than or equal to the length of the glyph |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4174 table, that code is automatically simple. If the value of |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4175 @code{glyph-table} is @code{nil} instead of a vector, then all glyphs |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4176 are simple. The glyph table is not used on graphical displays, only |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4177 on character terminals. On graphical displays, all glyphs are simple. |
6598 | 4178 @end defvar |
4179 | |
4180 Here are the possible types of elements in the glyph table: | |
4181 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4182 @table @asis |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4183 @item @var{string} |
6598 | 4184 Send the characters in @var{string} to the terminal to output |
4185 this glyph. This alternative is available on character terminals, | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4186 but not under a window system. |
6598 | 4187 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4188 @item @var{integer} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4189 Define this glyph code as an alias for glyph code @var{integer}. You |
47482
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4190 can use an alias to specify a face code for the glyph and use a small |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4191 number as its code. |
6598 | 4192 |
4193 @item @code{nil} | |
47482
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4194 This glyph is simple. |
6598 | 4195 @end table |
4196 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4197 @defun create-glyph string |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4198 @tindex create-glyph |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4199 This function returns a newly-allocated glyph code which is set up to |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4200 display by sending @var{string} to the terminal. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4201 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4202 |
6598 | 4203 @node Beeping |
4204 @section Beeping | |
4205 @cindex beeping | |
4206 @cindex bell | |
4207 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4208 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
|
4209 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
|
4210 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
|
4211 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
|
4212 appropriate. (@xref{Errors}.) |
6598 | 4213 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4214 @defun ding &optional do-not-terminate |
6598 | 4215 @cindex keyboard macro termination |
4216 This function beeps, or flashes the screen (see @code{visible-bell} below). | |
4217 It also terminates any keyboard macro currently executing unless | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4218 @var{do-not-terminate} is non-@code{nil}. |
6598 | 4219 @end defun |
4220 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4221 @defun beep &optional do-not-terminate |
6598 | 4222 This is a synonym for @code{ding}. |
4223 @end defun | |
4224 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4225 @defopt visible-bell |
6598 | 4226 This variable determines whether Emacs should flash the screen to |
4227 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
|
4228 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
|
4229 provided the terminal's Termcap entry defines the visible bell |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4230 capability (@samp{vb}). |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4231 @end defopt |
6598 | 4232 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4233 @defvar ring-bell-function |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4234 If this is non-@code{nil}, it specifies how Emacs should ``ring the |
25875 | 4235 bell.'' Its value should be a function of no arguments. If this is |
4236 non-@code{nil}, it takes precedence over the @code{visible-bell} | |
4237 variable. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4238 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4239 |
6598 | 4240 @node Window Systems |
4241 @section Window Systems | |
4242 | |
4243 Emacs works with several window systems, most notably the X Window | |
4244 System. Both Emacs and X use the term ``window'', but use it | |
4245 differently. An Emacs frame is a single window as far as X is | |
4246 concerned; the individual Emacs windows are not known to X at all. | |
4247 | |
4248 @defvar window-system | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4249 This variable tells Lisp programs what window system Emacs is running |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4250 under. The possible values are |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4251 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4252 @table @code |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4253 @item x |
6598 | 4254 @cindex X Window System |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4255 Emacs is displaying using X. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4256 @item pc |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4257 Emacs is displaying using MS-DOS. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4258 @item w32 |
27332
5cfe77eaff45
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27331
diff
changeset
|
4259 Emacs is displaying using Windows. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4260 @item mac |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4261 Emacs is displaying using a Macintosh. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4262 @item nil |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4263 Emacs is using a character-based terminal. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4264 @end table |
6598 | 4265 @end defvar |
4266 | |
4267 @defvar window-setup-hook | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4268 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
|
4269 initialization files. Emacs runs this hook after it has completed |
25875 | 4270 loading your init file, the default initialization file (if |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4271 any), and the terminal-specific Lisp code, and running the hook |
6598 | 4272 @code{term-setup-hook}. |
4273 | |
4274 This hook is used for internal purposes: setting up communication with | |
4275 the window system, and creating the initial window. Users should not | |
4276 interfere with it. | |
4277 @end defvar | |
52401 | 4278 |
4279 @ignore | |
4280 arch-tag: ffdf5714-7ecf-415b-9023-fbc6b409c2c6 | |
4281 @end ignore |