Mercurial > emacs
annotate lispref/display.texi @ 90113:a50413a4ba8b
*** empty log message ***
author | Kenichi Handa <handa@m17n.org> |
---|---|
date | Wed, 02 Mar 2005 11:04:29 +0000 |
parents | bbc2e661b93c |
children | 29e773288013 |
rev | line source |
---|---|
6598 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
59651
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2000, 2001, |
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
4 @c 2002, 2005 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. |
57389 | 19 * Progress:: Informing user about progress of a long operation. |
12067 | 20 * Invisible Text:: Hiding part of the buffer text. |
21 * Selective Display:: Hiding part of the buffer text (the old way). | |
6598 | 22 * Overlay Arrow:: Display of an arrow to indicate position. |
23 * 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
|
24 * Overlays:: Use overlays to highlight parts of the buffer. |
25875 | 25 * Width:: How wide a character or string is on the screen. |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
26 * Line Height:: Controlling the height of lines. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
27 * Faces:: A face defines a graphics style for text characters: |
25875 | 28 font, colors, etc. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
29 * Fringes:: Controlling window fringes. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
30 * Fringe Bitmaps:: Displaying bitmaps in the window fringes. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
31 * Customizing Bitmaps:: Specifying your own bitmaps to use in the fringes. |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
32 * Scroll Bars:: Controlling vertical scroll bars. |
57202
ce88ee86e383
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
57201
diff
changeset
|
33 * Pointer Shape:: Controlling the mouse pointer shape. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
34 * Display Property:: Enabling special display features. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
35 * 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
|
36 * Buttons:: Adding clickable buttons to Emacs buffers. |
6598 | 37 * 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
|
38 * 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
|
39 * 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
|
40 * Display Tables:: How to specify other conventions. |
6598 | 41 * Beeping:: Audible signal to the user. |
42 * Window Systems:: Which window system is being used. | |
43 @end menu | |
44 | |
45 @node Refresh Screen | |
46 @section Refreshing the Screen | |
47 | |
48 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
|
49 given frame (@pxref{Frames}). |
6598 | 50 |
51 @c Emacs 19 feature | |
52 @defun redraw-frame frame | |
53 This function clears and redisplays frame @var{frame}. | |
54 @end defun | |
55 | |
56 Even more powerful is @code{redraw-display}: | |
57 | |
58 @deffn Command redraw-display | |
59 This function clears and redisplays all visible frames. | |
60 @end deffn | |
61 | |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
62 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
|
63 but does not clear them. |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
64 |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
65 @defun force-window-update object |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
66 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
|
67 @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
|
68 @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
|
69 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
|
70 forces redisplay of all windows. |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
71 @end defun |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
72 |
12098 | 73 Processing user input takes absolute priority over redisplay. If you |
74 call these functions when input is available, they do nothing | |
75 immediately, but a full redisplay does happen eventually---after all the | |
76 input has been processed. | |
77 | |
6598 | 78 Normally, suspending and resuming Emacs also refreshes the screen. |
79 Some terminal emulators record separate contents for display-oriented | |
80 programs such as Emacs and for ordinary sequential display. If you are | |
81 using such a terminal, you might want to inhibit the redisplay on | |
9009 | 82 resumption. |
6598 | 83 |
84 @defvar no-redraw-on-reenter | |
85 @cindex suspend (cf. @code{no-redraw-on-reenter}) | |
86 @cindex resume (cf. @code{no-redraw-on-reenter}) | |
87 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
|
88 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
|
89 to redraw, @code{nil} means redrawing is needed. The default is @code{nil}. |
6598 | 90 @end defvar |
91 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
92 @node Forcing Redisplay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
93 @section Forcing Redisplay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
94 @cindex forcing redisplay |
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 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
|
97 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
|
98 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
|
99 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
|
100 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
101 @tindex redisplay-dont-pause |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
102 @defvar redisplay-dont-pause |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
103 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
|
104 prevent or halt redisplay; redisplay occurs, and finishes, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
105 regardless of whether input is available. This feature is available |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
106 as of Emacs 21. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
107 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
108 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
109 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
|
110 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
|
111 pending, do this: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
112 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
113 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
114 (let ((redisplay-dont-pause t)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
115 (sit-for 0)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
116 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
117 |
6598 | 118 @node Truncation |
119 @section Truncation | |
120 @cindex line wrapping | |
121 @cindex continuation lines | |
122 @cindex @samp{$} in display | |
123 @cindex @samp{\} in display | |
124 | |
125 When a line of text extends beyond the right edge of a window, the | |
126 line can either be continued on the next screen line, or truncated to | |
127 one screen line. The additional screen lines used to display a long | |
128 text line are called @dfn{continuation} lines. Normally, a @samp{$} in | |
129 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
|
130 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
|
131 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
|
132 specify alternative indicators; see @ref{Display Tables}.) |
6598 | 133 |
42905
09cd352a779e
(Truncation, Overlay Arrow, Usual Display): Add index entries for fringe
Eli Zaretskii <eliz@gnu.org>
parents:
42888
diff
changeset
|
134 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
|
135 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
|
136 (@pxref{Fringes}). |
42905
09cd352a779e
(Truncation, Overlay Arrow, Usual Display): Add index entries for fringe
Eli Zaretskii <eliz@gnu.org>
parents:
42888
diff
changeset
|
137 |
6598 | 138 Note that continuation is different from filling; continuation happens |
139 on the screen only, not in the buffer contents, and it breaks a line | |
140 precisely at the right margin, not at a word boundary. @xref{Filling}. | |
141 | |
142 @defopt truncate-lines | |
143 This buffer-local variable controls how Emacs displays lines that extend | |
144 beyond the right edge of the window. The default is @code{nil}, which | |
145 specifies continuation. If the value is non-@code{nil}, then these | |
146 lines are truncated. | |
147 | |
148 If the variable @code{truncate-partial-width-windows} is non-@code{nil}, | |
149 then truncation is always used for side-by-side windows (within one | |
150 frame) regardless of the value of @code{truncate-lines}. | |
151 @end defopt | |
152 | |
12098 | 153 @defopt default-truncate-lines |
6598 | 154 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
|
155 buffers that do not have buffer-local values for it. |
12098 | 156 @end defopt |
6598 | 157 |
158 @defopt truncate-partial-width-windows | |
159 This variable controls display of lines that extend beyond the right | |
160 edge of the window, in side-by-side windows (@pxref{Splitting Windows}). | |
161 If it is non-@code{nil}, these lines are truncated; otherwise, | |
162 @code{truncate-lines} says what to do with them. | |
163 @end defopt | |
164 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
165 When horizontal scrolling (@pxref{Horizontal Scrolling}) is in use in |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
166 a window, that forces truncation. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
167 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
168 You can override the glyphs that indicate continuation or truncation |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
169 using the display table; see @ref{Display Tables}. |
6598 | 170 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
171 If your buffer contains @emph{very} long lines, and you use |
12067 | 172 continuation to display them, just thinking about them can make Emacs |
12098 | 173 redisplay slow. The column computation and indentation functions also |
174 become slow. Then you might find it advisable to set | |
175 @code{cache-long-line-scans} to @code{t}. | |
12067 | 176 |
177 @defvar cache-long-line-scans | |
178 If this variable is non-@code{nil}, various indentation and motion | |
12098 | 179 functions, and Emacs redisplay, cache the results of scanning the |
180 buffer, and consult the cache to avoid rescanning regions of the buffer | |
181 unless they are modified. | |
12067 | 182 |
12098 | 183 Turning on the cache slows down processing of short lines somewhat. |
12067 | 184 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
185 This variable is automatically buffer-local in every buffer. |
12067 | 186 @end defvar |
187 | |
6598 | 188 @node The Echo Area |
189 @section The Echo Area | |
190 @cindex error display | |
191 @cindex echo area | |
192 | |
12067 | 193 The @dfn{echo area} is used for displaying messages made with the |
6598 | 194 @code{message} primitive, and for echoing keystrokes. It is not the |
195 same as the minibuffer, despite the fact that the minibuffer appears | |
196 (when active) in the same place on the screen as the echo area. The | |
197 @cite{GNU Emacs Manual} specifies the rules for resolving conflicts | |
198 between the echo area and the minibuffer for use of that screen space | |
199 (@pxref{Minibuffer,, The Minibuffer, emacs, The GNU Emacs Manual}). | |
200 Error messages appear in the echo area; see @ref{Errors}. | |
201 | |
202 You can write output in the echo area by using the Lisp printing | |
203 functions with @code{t} as the stream (@pxref{Output Functions}), or as | |
204 follows: | |
205 | |
206 @defun message string &rest arguments | |
39205
cb857398a0e0
(The Echo Area) <message>: Document message-truncate-lines.
Eli Zaretskii <eliz@gnu.org>
parents:
39032
diff
changeset
|
207 This function displays a message in the echo area. The |
6598 | 208 argument @var{string} is similar to a C language @code{printf} control |
209 string. See @code{format} in @ref{String Conversion}, for the details | |
210 on the conversion specifications. @code{message} returns the | |
211 constructed string. | |
212 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
213 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
|
214 error stream, followed by a newline. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
215 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
216 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
|
217 text properties, these affect the way the message is displayed. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
218 |
6598 | 219 @c Emacs 19 feature |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
220 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
|
221 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
|
222 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
|
223 minibuffer contents back onto the screen immediately. |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
224 |
39205
cb857398a0e0
(The Echo Area) <message>: Document message-truncate-lines.
Eli Zaretskii <eliz@gnu.org>
parents:
39032
diff
changeset
|
225 @vindex message-truncate-lines |
39221
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39217
diff
changeset
|
226 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
|
227 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
|
228 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
|
229 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
|
230 |
6598 | 231 @example |
232 @group | |
233 (message "Minibuffer depth is %d." | |
234 (minibuffer-depth)) | |
235 @print{} Minibuffer depth is 0. | |
236 @result{} "Minibuffer depth is 0." | |
237 @end group | |
238 | |
239 @group | |
240 ---------- Echo Area ---------- | |
241 Minibuffer depth is 0. | |
242 ---------- Echo Area ---------- | |
243 @end group | |
244 @end example | |
32261
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
245 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
246 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
|
247 depending on its size, use @code{display-message-or-buffer}. |
6598 | 248 @end defun |
249 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
250 @tindex with-temp-message |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
251 @defmac with-temp-message message &rest body |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
252 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
|
253 the execution of @var{body}. It displays @var{message}, executes |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
254 @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
|
255 the previous echo area contents. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
256 @end defmac |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
257 |
22843
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
258 @defun message-or-box string &rest arguments |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
259 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
|
260 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
|
261 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
|
262 @code{last-nonmenu-event} (@pxref{Command Loop Info}) is either |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
263 @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
|
264 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
|
265 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
|
266 @ref{Yes-or-No Queries}.) |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
267 |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
268 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
|
269 @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
|
270 @end defun |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
271 |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
272 @defun message-box string &rest arguments |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
273 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
|
274 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
|
275 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
|
276 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
|
277 @code{message}. |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
278 @end defun |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
279 |
32261
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
280 @defun display-message-or-buffer message &optional buffer-name not-this-window frame |
32840 | 281 @tindex display-message-or-buffer |
32261
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
282 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
|
283 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
|
284 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
|
285 in the echo area, using @code{message}. Otherwise, |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
286 @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
|
287 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
288 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
|
289 buffer is used, the window used to display it. |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
290 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
291 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
|
292 @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
|
293 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
|
294 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
|
295 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
|
296 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
297 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
|
298 @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
|
299 @end defun |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
300 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
301 @defun current-message |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
302 This function returns the message currently being displayed in the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
303 echo area, or @code{nil} if there is none. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
304 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
305 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
306 @defvar cursor-in-echo-area |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
307 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
|
308 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
|
309 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
|
310 point---not in the echo area at all. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
311 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
312 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
|
313 for brief periods of time. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
314 @end defvar |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
315 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
316 @defvar echo-area-clear-hook |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
317 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
|
318 @code{(message nil)} or for any other reason. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
319 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
320 |
12067 | 321 Almost all the messages displayed in the echo area are also recorded |
322 in the @samp{*Messages*} buffer. | |
323 | |
324 @defopt message-log-max | |
325 This variable specifies how many lines to keep in the @samp{*Messages*} | |
326 buffer. The value @code{t} means there is no limit on how many lines to | |
327 keep. The value @code{nil} disables message logging entirely. Here's | |
328 how to display a message and prevent it from being logged: | |
329 | |
330 @example | |
331 (let (message-log-max) | |
332 (message @dots{})) | |
333 @end example | |
334 @end defopt | |
335 | |
12098 | 336 @defvar echo-keystrokes |
337 This variable determines how much time should elapse before command | |
27971 | 338 characters echo. Its value must be an integer or floating point number, |
339 which specifies the | |
12098 | 340 number of seconds to wait before echoing. If the user types a prefix |
341 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
|
342 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
|
343 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
|
344 sequence are echoed immediately.) |
12098 | 345 |
346 If the value is zero, then command input is not echoed. | |
347 @end defvar | |
348 | |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
349 @node Warnings |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
350 @section Reporting Warnings |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
351 @cindex warnings |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
352 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
353 @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
|
354 possible problem, but continue running. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
355 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
356 @menu |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
357 * 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
|
358 * 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
|
359 * 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
|
360 @end menu |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
361 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
362 @node Warning Basics |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
363 @subsection Warning Basics |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
364 @cindex severity level |
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 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
|
367 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
|
368 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
|
369 meanings: |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
370 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
371 @table @code |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
372 @item :emergency |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
373 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
|
374 if you do not attend to it promptly. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
375 @item :error |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
376 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
|
377 @item :warning |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
378 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
|
379 raise suspicion of a possible problem. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
380 @item :debug |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
381 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
|
382 @end table |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
383 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
384 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
|
385 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
|
386 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
|
387 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
|
388 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
|
389 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
|
390 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
|
391 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
|
392 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
|
393 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
|
394 @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
|
395 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
|
396 |
52156
198af82c7606
(Warning Basics): Fix typo.
John Paul Wallington <jpw@pobox.com>
parents:
52141
diff
changeset
|
397 @cindex warning type |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
398 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
|
399 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
|
400 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
|
401 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
|
402 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
|
403 list. |
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 @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
|
406 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
|
407 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
|
408 severity level, with @code{:warning} being the default. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
409 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
410 @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
|
411 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
|
412 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
413 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
414 @defun lwarn type level message &rest args |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
415 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
|
416 @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
|
417 equivalent to @code{display-warning}. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
418 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
419 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
420 @defun warn message &rest args |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
421 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
|
422 @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
|
423 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
|
424 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
|
425 specify a specific warning type. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
426 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
427 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
428 @node Warning Variables |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
429 @subsection Warning Variables |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
430 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
431 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
|
432 the variables described in this section. |
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 @defvar warning-levels |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
435 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
|
436 severity levels. Each element defines one severity level, |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
437 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
|
438 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
439 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
|
440 @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
|
441 @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
|
442 @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
|
443 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
|
444 that information. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
445 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
446 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
|
447 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
|
448 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
449 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
|
450 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
451 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
452 @defvar warning-prefix-function |
54023 | 453 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
|
454 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
|
455 @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
|
456 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
|
457 the beginning of the warning message. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
458 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
459 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
|
460 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
|
461 entry (this value need not be an actual member of |
54023 | 462 @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
|
463 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
|
464 a given severity level. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
465 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
466 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
|
467 to call. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
468 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
469 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
470 @defvar warning-series |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
471 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
|
472 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
|
473 that means to leave point on the first warning of the series, rather |
54023 | 474 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
|
475 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
|
476 @code{warning-series} becomes @code{nil} again. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
477 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
478 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
|
479 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
|
480 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
|
481 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
|
482 of warnings. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
483 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
484 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
|
485 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
|
486 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
487 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
|
488 each warning separately. |
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-fill-prefix |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
492 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
|
493 use for filling each warning's text. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
494 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
495 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
496 @defvar warning-type-format |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
497 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
|
498 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
|
499 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
|
500 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
|
501 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
|
502 all. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
503 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
504 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
505 @node Warning Options |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
506 @subsection Warning Options |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
507 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
508 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
|
509 when a Lisp program reports a warning. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
510 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
511 @defopt warning-minimum-level |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
512 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
|
513 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
|
514 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
|
515 warnings. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
516 @end defopt |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
517 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
518 @defopt warning-minimum-log-level |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
519 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
|
520 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
|
521 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
|
522 @end defopt |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
523 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
524 @defopt warning-suppress-types |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
525 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
|
526 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
|
527 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
|
528 type, then that warning is not displayed immediately. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
529 @end defopt |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
530 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
531 @defopt warning-suppress-log-types |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
532 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
|
533 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
|
534 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
|
535 that warning is not logged. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
536 @end defopt |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
537 |
57389 | 538 @node Progress |
539 @section Reporting Operation Progress | |
540 @cindex progress reporting | |
541 | |
542 When an operation can take a while to finish, you should inform the | |
543 user about the progress it makes. This way the user can estimate | |
544 remaining time and clearly see that Emacs is busy working, not hung. | |
545 | |
546 Functions listed in this section provide simple and efficient way of | |
547 reporting operation progress. Here is a working example that does | |
548 nothing useful: | |
549 | |
550 @example | |
551 (let ((progress-reporter | |
552 (make-progress-reporter "Collecting some mana for Emacs..." | |
553 0 500))) | |
554 (dotimes (k 500) | |
555 (sit-for 0.01) | |
556 (progress-reporter-update progress-reporter k)) | |
557 (progress-reporter-done progress-reporter)) | |
558 @end example | |
559 | |
560 @defun make-progress-reporter message min-value max-value &optional current-value min-change min-time | |
561 This function creates a progress reporter---the object you will use as | |
562 an argument for all other functions listed here. The idea is to | |
563 precompute as much data as possible to make progress reporting very | |
564 fast. | |
565 | |
566 The @var{message} will be displayed in the echo area, followed by | |
567 progress percentage. @var{message} is treated as a simple string. If | |
568 you need it to depend on a filename, for instance, use @code{format} | |
569 before calling this function. | |
570 | |
571 @var{min-value} and @var{max-value} arguments stand for starting and | |
572 final states of your operation. For instance, if you scan a buffer, | |
573 they should be the results of @code{point-min} and @code{point-max} | |
574 correspondingly. It is required that @var{max-value} is greater than | |
575 @var{min-value}. If you create progress reporter when some part of | |
576 the operation has already been completed, then specify | |
577 @var{current-value} argument. But normally you should omit it or set | |
578 it to @code{nil}---it will default to @var{min-value} then. | |
579 | |
580 Remaining arguments control the rate of echo area updates. Progress | |
581 reporter will wait for at least @var{min-change} more percents of the | |
582 operation to be completed before printing next message. | |
583 @var{min-time} specifies the minimum time in seconds to pass between | |
584 successive prints. It can be fractional. Depending on Emacs and | |
585 system capabilities, progress reporter may or may not respect this | |
586 last argument or do it with varying precision. Default value for | |
587 @var{min-change} is 1 (one percent), for @var{min-time}---0.2 | |
588 (seconds.) | |
589 | |
590 This function calls @code{progress-reporter-update}, so the first | |
591 message is printed immediately. | |
592 @end defun | |
593 | |
594 @defun progress-reporter-update reporter value | |
595 This function does the main work of reporting progress of your | |
596 operation. It print the message of @var{reporter} followed by | |
597 progress percentage determined by @var{value}. If percentage is zero, | |
598 then it is not printed at all. | |
599 | |
600 @var{reporter} must be the result of a call to | |
601 @code{make-progress-reporter}. @var{value} specifies the current | |
602 state of your operation and must be between @var{min-value} and | |
603 @var{max-value} (inclusive) as passed to | |
604 @code{make-progress-reporter}. For instance, if you scan a buffer, | |
605 then @var{value} should be the result of a call to @code{point}. | |
606 | |
607 This function respects @var{min-change} and @var{min-time} as passed | |
608 to @code{make-progress-reporter} and so does not output new messages | |
609 on every invocation. It is thus very fast and normally you should not | |
610 try to reduce the number of calls to it: resulting overhead will most | |
611 likely negate your effort. | |
612 @end defun | |
613 | |
614 @defun progress-reporter-force-update reporter value &optional new-message | |
615 This function is similar to @code{progress-reporter-update} except | |
616 that it prints a message in the echo area unconditionally. | |
617 | |
618 The first two arguments have the same meaning as for | |
619 @code{progress-reporter-update}. Optional @var{new-message} allows | |
620 you to change the message of the @var{reporter}. Since this functions | |
621 always updates the echo area, such a change will be immediately | |
622 presented to the user. | |
623 @end defun | |
624 | |
625 @defun progress-reporter-done reporter | |
626 This function should be called when the operation is finished. It | |
627 prints the message of @var{reporter} followed by word ``done'' in the | |
628 echo area. | |
629 | |
630 You should always call this function and not hope for | |
631 @code{progress-reporter-update} to print ``100%.'' Firstly, it may | |
632 never print it, there are many good reasons for this not to happen. | |
633 Secondly, ``done'' is more explicit. | |
634 @end defun | |
635 | |
59651
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
636 @defmac dotimes-with-progress-reporter (var count [result]) message body... |
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
637 This is a convenience macro that works the same way as @code{dotimes} |
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
638 does, but also reports loop progress using the functions described |
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
639 above. It allows you to save some typing. |
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
640 |
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
641 You can rewrite the example in the beginning of this node using |
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
642 this macro this way: |
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
643 |
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
644 @example |
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
645 (dotimes-with-progress-reporter |
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
646 (k 500) |
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
647 "Collecting some mana for Emacs..." |
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
648 (sit-for 0.01)) |
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
649 @end example |
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
650 @end defmac |
939528a9d14b
Add dotimes-with-progress-reporter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
59574
diff
changeset
|
651 |
12067 | 652 @node Invisible Text |
653 @section Invisible Text | |
654 | |
655 @cindex invisible text | |
656 You can make characters @dfn{invisible}, so that they do not appear on | |
657 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
|
658 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
|
659 (@pxref{Overlays}). |
12067 | 660 |
661 In the simplest case, any non-@code{nil} @code{invisible} property makes | |
662 a character invisible. This is the default case---if you don't alter | |
663 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
|
664 @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
|
665 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
|
666 to set @code{buffer-invisibility-spec} yourself. |
12067 | 667 |
668 More generally, you can use the variable @code{buffer-invisibility-spec} | |
669 to control which values of the @code{invisible} property make text | |
670 invisible. This permits you to classify the text into different subsets | |
671 in advance, by giving them different @code{invisible} values, and | |
672 subsequently make various subsets visible or invisible by changing the | |
673 value of @code{buffer-invisibility-spec}. | |
674 | |
675 Controlling visibility with @code{buffer-invisibility-spec} is | |
25875 | 676 especially useful in a program to display the list of entries in a |
677 database. It permits the implementation of convenient filtering | |
678 commands to view just a part of the entries in the database. Setting | |
679 this variable is very fast, much faster than scanning all the text in | |
680 the buffer looking for properties to change. | |
12067 | 681 |
682 @defvar buffer-invisibility-spec | |
683 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
|
684 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
|
685 buffer-local. |
12067 | 686 |
687 @table @asis | |
688 @item @code{t} | |
689 A character is invisible if its @code{invisible} property is | |
690 non-@code{nil}. This is the default. | |
691 | |
692 @item a list | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
693 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
|
694 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
|
695 the character is invisible. The list can have two kinds of elements: |
12067 | 696 |
697 @table @code | |
698 @item @var{atom} | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
699 A character is invisible if its @code{invisible} property value |
12067 | 700 is @var{atom} or if it is a list with @var{atom} as a member. |
701 | |
702 @item (@var{atom} . t) | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
703 A character is invisible if its @code{invisible} property value |
12067 | 704 is @var{atom} or if it is a list with @var{atom} as a member. |
705 Moreover, if this character is at the end of a line and is followed | |
706 by a visible newline, it displays an ellipsis. | |
707 @end table | |
708 @end table | |
709 @end defvar | |
710 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
711 Two functions are specifically provided for adding elements to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
712 @code{buffer-invisibility-spec} and removing elements from it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
713 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
714 @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
|
715 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
|
716 @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
|
717 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
|
718 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
|
719 is @code{t} remains invisible. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
720 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
721 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
722 @defun remove-from-invisibility-spec element |
54023 | 723 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
|
724 @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
|
725 is not in the list. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
726 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
727 |
48948
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
728 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
|
729 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
|
730 @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
|
731 @code{invisible} property: |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
732 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
733 @example |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
734 ;; @r{If you want to display an ellipsis:} |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
735 (add-to-invisibility-spec '(my-symbol . t)) |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
736 ;; @r{If you don't want ellipsis:} |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
737 (add-to-invisibility-spec 'my-symbol) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
738 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
739 (overlay-put (make-overlay beginning end) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
740 'invisible 'my-symbol) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
741 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
742 ;; @r{When done with the overlays:} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
743 (remove-from-invisibility-spec '(my-symbol . t)) |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
744 ;; @r{Or respectively:} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
745 (remove-from-invisibility-spec 'my-symbol) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
746 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
747 |
15761
77d451c08a30
Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
15074
diff
changeset
|
748 @vindex line-move-ignore-invisible |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
749 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
|
750 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
|
751 explicitly ignore invisible newlines if |
77d451c08a30
Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
15074
diff
changeset
|
752 @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
|
753 they are explicitly programmed to do so. |
12098 | 754 |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
755 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
|
756 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
|
757 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
|
758 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
|
759 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
|
760 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
|
761 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
|
762 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
|
763 invisible text. |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
764 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
765 Incremental search can make invisible overlays visible temporarily |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
766 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
|
767 this, the overlay should have a non-@code{nil} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
768 @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
|
769 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
|
770 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
|
771 overlaps the overlay on exit from the search. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
772 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
773 During the search, such overlays are made temporarily visible by |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
774 temporarily modifying their invisible and intangible properties. If you |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
775 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
|
776 @code{isearch-open-invisible-temporary} property which is a function. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
777 The function is called with two arguments: the first is the overlay, and |
26986 | 778 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
|
779 make it invisible again. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
780 |
6598 | 781 @node Selective Display |
782 @section Selective Display | |
783 @cindex selective display | |
784 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
785 @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
|
786 hiding certain lines on the screen. |
6598 | 787 |
788 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
|
789 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
|
790 The invisible text feature (@pxref{Invisible Text}) has partially |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
791 replaced this feature. |
12067 | 792 |
793 In the second variant, the choice of lines to hide is made | |
12098 | 794 automatically based on indentation. This variant is designed to be a |
12067 | 795 user-level feature. |
6598 | 796 |
797 The way you control explicit selective display is by replacing a | |
9009 | 798 newline (control-j) with a carriage return (control-m). The text that |
6598 | 799 was formerly a line following that newline is now invisible. Strictly |
800 speaking, it is temporarily no longer a line at all, since only newlines | |
801 can separate lines; it is now part of the previous line. | |
802 | |
803 Selective display does not directly affect editing commands. For | |
804 example, @kbd{C-f} (@code{forward-char}) moves point unhesitatingly into | |
805 invisible text. However, the replacement of newline characters with | |
806 carriage return characters affects some editing commands. For example, | |
807 @code{next-line} skips invisible lines, since it searches only for | |
808 newlines. Modes that use selective display can also define commands | |
809 that take account of the newlines, or that make parts of the text | |
810 visible or invisible. | |
811 | |
812 When you write a selectively displayed buffer into a file, all the | |
813 control-m's are output as newlines. This means that when you next read | |
814 in the file, it looks OK, with nothing invisible. The selective display | |
815 effect is seen only within Emacs. | |
816 | |
817 @defvar selective-display | |
818 This buffer-local variable enables selective display. This means that | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
819 lines, or portions of lines, may be made invisible. |
6598 | 820 |
821 @itemize @bullet | |
822 @item | |
25875 | 823 If the value of @code{selective-display} is @code{t}, then the character |
824 control-m marks the start of invisible text; the control-m, and the rest | |
825 of the line following it, are not displayed. This is explicit selective | |
826 display. | |
6598 | 827 |
828 @item | |
829 If the value of @code{selective-display} is a positive integer, then | |
830 lines that start with more than that many columns of indentation are not | |
831 displayed. | |
832 @end itemize | |
833 | |
834 When some portion of a buffer is invisible, the vertical movement | |
835 commands operate as if that portion did not exist, allowing a single | |
836 @code{next-line} command to skip any number of invisible lines. | |
837 However, character movement commands (such as @code{forward-char}) do | |
838 not skip the invisible portion, and it is possible (if tricky) to insert | |
839 or delete text in an invisible portion. | |
840 | |
841 In the examples below, we show the @emph{display appearance} of the | |
842 buffer @code{foo}, which changes with the value of | |
843 @code{selective-display}. The @emph{contents} of the buffer do not | |
844 change. | |
845 | |
846 @example | |
847 @group | |
848 (setq selective-display nil) | |
849 @result{} nil | |
850 | |
851 ---------- Buffer: foo ---------- | |
852 1 on this column | |
853 2on this column | |
854 3n this column | |
855 3n this column | |
856 2on this column | |
857 1 on this column | |
858 ---------- Buffer: foo ---------- | |
859 @end group | |
860 | |
861 @group | |
862 (setq selective-display 2) | |
863 @result{} 2 | |
864 | |
865 ---------- Buffer: foo ---------- | |
866 1 on this column | |
867 2on this column | |
868 2on this column | |
869 1 on this column | |
870 ---------- Buffer: foo ---------- | |
871 @end group | |
872 @end example | |
873 @end defvar | |
874 | |
875 @defvar selective-display-ellipses | |
876 If this buffer-local variable is non-@code{nil}, then Emacs displays | |
877 @samp{@dots{}} at the end of a line that is followed by invisible text. | |
878 This example is a continuation of the previous one. | |
879 | |
880 @example | |
881 @group | |
882 (setq selective-display-ellipses t) | |
883 @result{} t | |
884 | |
885 ---------- Buffer: foo ---------- | |
886 1 on this column | |
887 2on this column ... | |
888 2on this column | |
889 1 on this column | |
890 ---------- Buffer: foo ---------- | |
891 @end group | |
892 @end example | |
893 | |
894 You can use a display table to substitute other text for the ellipsis | |
895 (@samp{@dots{}}). @xref{Display Tables}. | |
896 @end defvar | |
897 | |
898 @node Overlay Arrow | |
899 @section The Overlay Arrow | |
900 @cindex overlay arrow | |
901 | |
902 The @dfn{overlay arrow} is useful for directing the user's attention | |
903 to a particular line in a buffer. For example, in the modes used for | |
904 interface to debuggers, the overlay arrow indicates the line of code | |
905 about to be executed. | |
906 | |
907 @defvar overlay-arrow-string | |
9009 | 908 This variable holds the string to display to call attention to a |
909 particular line, or @code{nil} if the arrow feature is not in use. | |
29471 | 910 On a graphical display the contents of the string are ignored; instead a |
911 glyph is displayed in the fringe area to the left of the display area. | |
6598 | 912 @end defvar |
913 | |
914 @defvar overlay-arrow-position | |
9009 | 915 This variable holds a marker that indicates where to display the overlay |
29471 | 916 arrow. It should point at the beginning of a line. On a non-graphical |
917 display the arrow text | |
9009 | 918 appears at the beginning of that line, overlaying any text that would |
919 otherwise appear. Since the arrow is usually short, and the line | |
920 usually begins with indentation, normally nothing significant is | |
921 overwritten. | |
6598 | 922 |
9009 | 923 The overlay string is displayed only in the buffer that this marker |
6598 | 924 points into. Thus, only one buffer can have an overlay arrow at any |
925 given time. | |
926 @c !!! overlay-arrow-position: but the overlay string may remain in the display | |
927 @c of some other buffer until an update is required. This should be fixed | |
928 @c now. Is it? | |
929 @end defvar | |
930 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
931 You can do a similar job by creating an overlay with a |
12067 | 932 @code{before-string} property. @xref{Overlay Properties}. |
933 | |
6598 | 934 @node Temporary Displays |
935 @section Temporary Displays | |
936 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
937 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
|
938 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
|
939 editing. Many help commands use this feature. |
6598 | 940 |
941 @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
|
942 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
|
943 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
|
944 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
|
945 displayed in some window, but not selected. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
946 |
52923
41c0ac1a4ed4
(Temporary Displays): Add xref to `Documentation Tips'.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52903
diff
changeset
|
947 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
|
948 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
|
949 @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
|
950 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
|
951 into clickable cross-references. @xref{Docstring hyperlinks, , Tips |
67874c814e45
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
952 for Documentation Strings}, in particular the item on hyperlinks in |
67874c814e45
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
953 documentation strings, for more details. |
6598 | 954 |
955 The string @var{buffer-name} specifies the temporary buffer, which | |
956 need not already exist. The argument must be a string, not a buffer. | |
957 The buffer is erased initially (with no questions asked), and it is | |
958 marked as unmodified after @code{with-output-to-temp-buffer} exits. | |
959 | |
960 @code{with-output-to-temp-buffer} binds @code{standard-output} to the | |
961 temporary buffer, then it evaluates the forms in @var{forms}. Output | |
962 using the Lisp output functions within @var{forms} goes by default to | |
963 that buffer (but screen display and messages in the echo area, although | |
964 they are ``output'' in the general sense of the word, are not affected). | |
965 @xref{Output Functions}. | |
966 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
967 Several hooks are available for customizing the behavior |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
968 of this construct; they are listed below. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
969 |
6598 | 970 The value of the last form in @var{forms} is returned. |
971 | |
972 @example | |
973 @group | |
974 ---------- Buffer: foo ---------- | |
975 This is the contents of foo. | |
976 ---------- Buffer: foo ---------- | |
977 @end group | |
978 | |
979 @group | |
980 (with-output-to-temp-buffer "foo" | |
981 (print 20) | |
982 (print standard-output)) | |
983 @result{} #<buffer foo> | |
984 | |
985 ---------- Buffer: foo ---------- | |
986 20 | |
987 | |
988 #<buffer foo> | |
989 | |
990 ---------- Buffer: foo ---------- | |
991 @end group | |
992 @end example | |
993 @end defspec | |
994 | |
995 @defvar temp-buffer-show-function | |
9009 | 996 If this variable is non-@code{nil}, @code{with-output-to-temp-buffer} |
6598 | 997 calls it as a function to do the job of displaying a help buffer. The |
998 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
|
999 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1000 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
|
1001 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
|
1002 @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
|
1003 selected. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1004 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1005 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1006 @defvar temp-buffer-setup-hook |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1007 @tindex temp-buffer-setup-hook |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1008 This normal hook is run by @code{with-output-to-temp-buffer} before |
42082 | 1009 evaluating @var{body}. When the hook runs, the temporary buffer is |
1010 current. This hook is normally set up with a function to put the | |
1011 buffer in Help mode. | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1012 @end defvar |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1013 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1014 @defvar temp-buffer-show-hook |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1015 This normal hook is run by @code{with-output-to-temp-buffer} after |
42082 | 1016 displaying the temporary buffer. When the hook runs, the temporary buffer |
1017 is current, and the window it was displayed in is selected. This hook | |
1018 is normally set up with a function to make the buffer read only, and | |
1019 find function names and variable names in it, provided the major mode | |
1020 is Help mode. | |
6598 | 1021 @end defvar |
1022 | |
1023 @defun momentary-string-display string position &optional char message | |
1024 This function momentarily displays @var{string} in the current buffer at | |
1025 @var{position}. It has no effect on the undo list or on the buffer's | |
1026 modification status. | |
1027 | |
1028 The momentary display remains until the next input event. If the next | |
1029 input event is @var{char}, @code{momentary-string-display} ignores it | |
1030 and returns. Otherwise, that event remains buffered for subsequent use | |
1031 as input. Thus, typing @var{char} will simply remove the string from | |
1032 the display, while typing (say) @kbd{C-f} will remove the string from | |
1033 the display and later (presumably) move point forward. The argument | |
1034 @var{char} is a space by default. | |
1035 | |
1036 The return value of @code{momentary-string-display} is not meaningful. | |
1037 | |
12098 | 1038 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
|
1039 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
|
1040 deleting) an overlay with a @code{before-string} property. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1041 @xref{Overlay Properties}. |
12098 | 1042 |
6598 | 1043 If @var{message} is non-@code{nil}, it is displayed in the echo area |
1044 while @var{string} is displayed in the buffer. If it is @code{nil}, a | |
1045 default message says to type @var{char} to continue. | |
1046 | |
1047 In this example, point is initially located at the beginning of the | |
1048 second line: | |
1049 | |
1050 @example | |
1051 @group | |
1052 ---------- Buffer: foo ---------- | |
1053 This is the contents of foo. | |
1054 @point{}Second line. | |
1055 ---------- Buffer: foo ---------- | |
1056 @end group | |
1057 | |
1058 @group | |
1059 (momentary-string-display | |
1060 "**** Important Message! ****" | |
1061 (point) ?\r | |
1062 "Type RET when done reading") | |
1063 @result{} t | |
1064 @end group | |
1065 | |
1066 @group | |
1067 ---------- Buffer: foo ---------- | |
1068 This is the contents of foo. | |
1069 **** Important Message! ****Second line. | |
1070 ---------- Buffer: foo ---------- | |
1071 | |
1072 ---------- Echo Area ---------- | |
1073 Type RET when done reading | |
1074 ---------- Echo Area ---------- | |
1075 @end group | |
1076 @end example | |
1077 @end defun | |
1078 | |
1079 @node Overlays | |
1080 @section Overlays | |
1081 @cindex overlays | |
1082 | |
1083 You can use @dfn{overlays} to alter the appearance of a buffer's text on | |
12098 | 1084 the screen, for the sake of presentation features. An overlay is an |
1085 object that belongs to a particular buffer, and has a specified | |
1086 beginning and end. It also has properties that you can examine and set; | |
1087 these affect the display of the text within the overlay. | |
6598 | 1088 |
54023 | 1089 An overlays uses markers to record its beginning and end; thus, |
1090 editing the text of the buffer adjusts the beginning and end of each | |
1091 overlay so that it stays with the text. When you create the overlay, | |
1092 you can specify whether text inserted at the beginning should be | |
1093 inside the overlay or outside, and likewise for the end of the overlay. | |
1094 | |
6598 | 1095 @menu |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
1096 * Overlay Properties:: How to read and set properties. |
6598 | 1097 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
|
1098 * Managing Overlays:: Creating and moving overlays. |
73f718a9df4b
(Overlays): Add menu entry for Finding Overlays.
Dave Love <fx@gnu.org>
parents:
26696
diff
changeset
|
1099 * Finding Overlays:: Searching for overlays. |
6598 | 1100 @end menu |
1101 | |
1102 @node Overlay Properties | |
1103 @subsection Overlay Properties | |
1104 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1105 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
|
1106 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
|
1107 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
|
1108 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
|
1109 text. Thus, copying text between various buffers and strings preserves |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1110 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
|
1111 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
|
1112 overlay or changing its properties does not. Unlike text property |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1113 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
|
1114 @xref{Text Properties}, for comparison. |
6598 | 1115 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1116 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
|
1117 overlay: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1118 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1119 @defun overlay-get overlay prop |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1120 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
|
1121 @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
|
1122 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
|
1123 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
|
1124 is @code{nil}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1125 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1126 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1127 @defun overlay-put overlay prop value |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1128 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
|
1129 @var{overlay} to @var{value}. It returns @var{value}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1130 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1131 |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1132 @defun overlay-properties overlay |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1133 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
|
1134 @end defun |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1135 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1136 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
|
1137 overlay properties and text properties for a given character. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1138 @xref{Examining Properties}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1139 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1140 Many overlay properties have special meanings; here is a table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1141 of them: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1142 |
6598 | 1143 @table @code |
1144 @item priority | |
1145 @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
|
1146 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
|
1147 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
|
1148 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
|
1149 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
|
1150 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
|
1151 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
|
1152 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
|
1153 @code{face} property. |
6598 | 1154 |
1155 Currently, all overlays take priority over text properties. Please | |
1156 avoid using negative priority values, as we have not yet decided just | |
1157 what they should mean. | |
1158 | |
1159 @item window | |
1160 @kindex window @r{(overlay property)} | |
1161 If the @code{window} property is non-@code{nil}, then the overlay | |
1162 applies only on that window. | |
1163 | |
12067 | 1164 @item category |
1165 @kindex category @r{(overlay property)} | |
1166 If an overlay has a @code{category} property, we call it the | |
12098 | 1167 @dfn{category} of the overlay. It should be a symbol. The properties |
12067 | 1168 of the symbol serve as defaults for the properties of the overlay. |
1169 | |
6598 | 1170 @item face |
1171 @kindex face @r{(overlay property)} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1172 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
|
1173 font and which colors. @xref{Faces}, for more information. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1174 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1175 In the simplest case, the value is a face name. It can also be a list; |
25875 | 1176 then each element can be any of these possibilities: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1177 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1178 @itemize @bullet |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1179 @item |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1180 A face name (a symbol or string). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1181 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1182 @item |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1183 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
|
1184 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
|
1185 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
|
1186 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
|
1187 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
|
1188 @xref{Face Attributes}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1189 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1190 @item |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1191 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
|
1192 @code{(background-color . @var{color-name})}. These elements specify |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1193 just the foreground color or just the background color. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1194 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1195 @code{(foreground-color . @var{color-name})} is equivalent to |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1196 @code{(:foreground @var{color-name})}, and likewise for the background. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1197 @end itemize |
6598 | 1198 |
1199 @item mouse-face | |
1200 @kindex mouse-face @r{(overlay property)} | |
1201 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
|
1202 the range of the overlay. |
6598 | 1203 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1204 @item display |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1205 @kindex display @r{(overlay property)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1206 This property activates various features that change the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1207 way text is displayed. For example, it can make text appear taller |
38278 | 1208 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
|
1209 @xref{Display Property}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1210 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1211 @item help-echo |
59769
39b4d09e8528
(Overlay Properties): Fix the index entry for help-echo overlay property.
Eli Zaretskii <eliz@gnu.org>
parents:
59651
diff
changeset
|
1212 @kindex help-echo @r{(overlay property)} |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
1213 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
|
1214 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
|
1215 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
|
1216 help-echo}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1217 |
6598 | 1218 @item modification-hooks |
1219 @kindex modification-hooks @r{(overlay property)} | |
1220 This property's value is a list of functions to be called if any | |
1221 character within the overlay is changed or if text is inserted strictly | |
12067 | 1222 within the overlay. |
1223 | |
1224 The hook functions are called both before and after each change. | |
1225 If the functions save the information they receive, and compare notes | |
1226 between calls, they can determine exactly what change has been made | |
1227 in the buffer text. | |
1228 | |
1229 When called before a change, each function receives four arguments: the | |
1230 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
|
1231 modified. |
6598 | 1232 |
12067 | 1233 When called after a change, each function receives five arguments: the |
1234 overlay, @code{t}, the beginning and end of the text range just | |
1235 modified, and the length of the pre-change text replaced by that range. | |
1236 (For an insertion, the pre-change length is zero; for a deletion, that | |
1237 length is the number of characters deleted, and the post-change | |
12098 | 1238 beginning and end are equal.) |
12067 | 1239 |
6598 | 1240 @item insert-in-front-hooks |
1241 @kindex insert-in-front-hooks @r{(overlay property)} | |
12067 | 1242 This property's value is a list of functions to be called before and |
1243 after inserting text right at the beginning of the overlay. The calling | |
1244 conventions are the same as for the @code{modification-hooks} functions. | |
6598 | 1245 |
1246 @item insert-behind-hooks | |
1247 @kindex insert-behind-hooks @r{(overlay property)} | |
12067 | 1248 This property's value is a list of functions to be called before and |
1249 after inserting text right at the end of the overlay. The calling | |
1250 conventions are the same as for the @code{modification-hooks} functions. | |
6598 | 1251 |
1252 @item invisible | |
1253 @kindex invisible @r{(overlay property)} | |
12067 | 1254 The @code{invisible} property can make the text in the overlay |
1255 invisible, which means that it does not appear on the screen. | |
1256 @xref{Invisible Text}, for details. | |
1257 | |
1258 @item intangible | |
1259 @kindex intangible @r{(overlay property)} | |
1260 The @code{intangible} property on an overlay works just like the | |
12098 | 1261 @code{intangible} text property. @xref{Special Properties}, for details. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1262 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1263 @item isearch-open-invisible |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1264 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
|
1265 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
|
1266 Text}. |
6598 | 1267 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1268 @item isearch-open-invisible-temporary |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1269 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
|
1270 visible, temporarily, during the search. @xref{Invisible Text}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1271 |
6598 | 1272 @item before-string |
1273 @kindex before-string @r{(overlay property)} | |
1274 This property's value is a string to add to the display at the beginning | |
1275 of the overlay. The string does not appear in the buffer in any | |
25875 | 1276 sense---only on the screen. |
6598 | 1277 |
1278 @item after-string | |
1279 @kindex after-string @r{(overlay property)} | |
1280 This property's value is a string to add to the display at the end of | |
1281 the overlay. The string does not appear in the buffer in any | |
25875 | 1282 sense---only on the screen. |
12067 | 1283 |
1284 @item evaporate | |
1285 @kindex evaporate @r{(overlay property)} | |
1286 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
|
1287 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
|
1288 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
|
1289 it immediately. |
16123
ec5f48fe0320
Mention local-value property on an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
15761
diff
changeset
|
1290 |
29102 | 1291 @item local-map |
29076 | 1292 @cindex keymap of character (and overlays) |
29102 | 1293 @kindex local-map @r{(overlay property)} |
29076 | 1294 If this property is non-@code{nil}, it specifies a keymap for a portion |
1295 of the text. The property's value replaces the buffer's local map, when | |
1296 the character after point is within the overlay. @xref{Active Keymaps}. | |
33996 | 1297 |
1298 @item keymap | |
1299 @kindex keymap @r{(overlay property)} | |
1300 The @code{keymap} property is similar to @code{local-map} but overrides the | |
1301 buffer's local map (and the map specified by the @code{local-map} | |
1302 property) rather than replacing it. | |
29076 | 1303 @end table |
1304 | |
6598 | 1305 @node Managing Overlays |
1306 @subsection Managing Overlays | |
1307 | |
1308 This section describes the functions to create, delete and move | |
1309 overlays, and to examine their contents. | |
1310 | |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1311 @defun overlayp object |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1312 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
|
1313 @end defun |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1314 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1315 @defun make-overlay start end &optional buffer front-advance rear-advance |
9009 | 1316 This function creates and returns an overlay that belongs to |
6598 | 1317 @var{buffer} and ranges from @var{start} to @var{end}. Both @var{start} |
1318 and @var{end} must specify buffer positions; they may be integers or | |
1319 markers. If @var{buffer} is omitted, the overlay is created in the | |
1320 current buffer. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1321 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1322 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
|
1323 insertion type for the start of the overlay and for the end of the |
54023 | 1324 overlay, respectively. @xref{Marker Insertion Types}. If |
1325 @var{front-advance} is non-@code{nil}, text inserted at the beginning | |
1326 of the overlay is excluded from the overlay. If @var{read-advance} is | |
1327 non-@code{nil}, text inserted at the beginning of the overlay is | |
1328 included in the overlay. | |
6598 | 1329 @end defun |
1330 | |
1331 @defun overlay-start overlay | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1332 This function returns the position at which @var{overlay} starts, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1333 as an integer. |
6598 | 1334 @end defun |
1335 | |
1336 @defun overlay-end overlay | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1337 This function returns the position at which @var{overlay} ends, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1338 as an integer. |
6598 | 1339 @end defun |
1340 | |
1341 @defun overlay-buffer overlay | |
60218
91e11eea20a2
(Managing Overlays): overlay-buffer returns nil for deleted overlays.
Lute Kamstra <lute@gnu.org>
parents:
59769
diff
changeset
|
1342 This function returns the buffer that @var{overlay} belongs to. It |
91e11eea20a2
(Managing Overlays): overlay-buffer returns nil for deleted overlays.
Lute Kamstra <lute@gnu.org>
parents:
59769
diff
changeset
|
1343 returns @code{nil}, if @var{overlay} has been deleted. |
6598 | 1344 @end defun |
1345 | |
1346 @defun delete-overlay overlay | |
1347 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
|
1348 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
|
1349 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
|
1350 display. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1351 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1352 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
|
1353 position in a buffer again by calling @code{move-overlay}. |
6598 | 1354 @end defun |
1355 | |
1356 @defun move-overlay overlay start end &optional buffer | |
1357 This function moves @var{overlay} to @var{buffer}, and places its bounds | |
1358 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
|
1359 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
|
1360 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1361 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
|
1362 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
|
1363 the current buffer. |
6598 | 1364 |
1365 The return value is @var{overlay}. | |
1366 | |
1367 This is the only valid way to change the endpoints of an overlay. Do | |
1368 not try modifying the markers in the overlay by hand, as that fails to | |
1369 update other vital data structures and can cause some overlays to be | |
1370 ``lost''. | |
1371 @end defun | |
1372 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1373 Here are some examples: |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1374 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1375 @example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1376 ;; @r{Create an overlay.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1377 (setq foo (make-overlay 1 10)) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1378 @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
|
1379 (overlay-start foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1380 @result{} 1 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1381 (overlay-end foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1382 @result{} 10 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1383 (overlay-buffer foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1384 @result{} #<buffer display.texi> |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1385 ;; @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
|
1386 (overlay-put foo 'happy t) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1387 @result{} t |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1388 ;; @r{Verify the property is present.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1389 (overlay-get foo 'happy) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1390 @result{} t |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1391 ;; @r{Move the overlay.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1392 (move-overlay foo 5 20) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1393 @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
|
1394 (overlay-start foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1395 @result{} 5 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1396 (overlay-end foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1397 @result{} 20 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1398 ;; @r{Delete the overlay.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1399 (delete-overlay foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1400 @result{} nil |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1401 ;; @r{Verify it is deleted.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1402 foo |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1403 @result{} #<overlay in no buffer> |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1404 ;; @r{A deleted overlay has no position.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1405 (overlay-start foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1406 @result{} nil |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1407 (overlay-end foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1408 @result{} nil |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1409 (overlay-buffer foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1410 @result{} nil |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1411 ;; @r{Undelete the overlay.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1412 (move-overlay foo 1 20) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1413 @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
|
1414 ;; @r{Verify the results.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1415 (overlay-start foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1416 @result{} 1 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1417 (overlay-end foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1418 @result{} 20 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1419 (overlay-buffer foo) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1420 @result{} #<buffer display.texi> |
27331
be0a552c8320
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
1421 ;; @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
|
1422 (overlay-get foo 'happy) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1423 @result{} t |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1424 @end example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1425 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1426 @node Finding Overlays |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1427 @subsection Searching for Overlays |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1428 |
6598 | 1429 @defun overlays-at pos |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1430 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
|
1431 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
|
1432 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
|
1433 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
|
1434 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1435 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
|
1436 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
|
1437 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1438 @smallexample |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1439 (defun find-overlays-specifying (prop) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1440 (let ((overlays (overlays-at (point))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1441 found) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1442 (while overlays |
37170
29f2615d958f
(Finding Overlays): Fix example code.
Gerd Moellmann <gerd@gnu.org>
parents:
36935
diff
changeset
|
1443 (let ((overlay (car overlays))) |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1444 (if (overlay-get overlay prop) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1445 (setq found (cons overlay found)))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1446 (setq overlays (cdr overlays))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1447 found)) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1448 @end smallexample |
6598 | 1449 @end defun |
1450 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1451 @defun overlays-in beg end |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1452 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
|
1453 @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
|
1454 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
|
1455 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
|
1456 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
|
1457 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1458 |
6598 | 1459 @defun next-overlay-change pos |
1460 This function returns the buffer position of the next beginning or end | |
1461 of an overlay, after @var{pos}. | |
1462 @end defun | |
1463 | |
12067 | 1464 @defun previous-overlay-change pos |
1465 This function returns the buffer position of the previous beginning or | |
1466 end of an overlay, before @var{pos}. | |
1467 @end defun | |
1468 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1469 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
|
1470 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
|
1471 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
|
1472 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1473 @smallexample |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1474 (defun find-overlay-prop (prop) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1475 (save-excursion |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1476 (while (and (not (eobp)) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1477 (not (get-char-property (point) 'happy))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1478 (goto-char (min (next-overlay-change (point)) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1479 (next-single-property-change (point) 'happy)))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1480 (point))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1481 @end smallexample |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1482 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1483 @node Width |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1484 @section Width |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1485 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1486 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
|
1487 check the width of a character. @xref{Primitive Indent}, and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1488 @ref{Screen Lines}, for related functions. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1489 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1490 @defun char-width char |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1491 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
|
1492 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
|
1493 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1494 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1495 @defun string-width string |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1496 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
|
1497 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
|
1498 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1499 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1500 @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
|
1501 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
|
1502 @var{width} columns, as a new string. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1503 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1504 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
|
1505 @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
|
1506 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
|
1507 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
|
1508 go beyond it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1509 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1510 The optional argument @var{start-column} specifies the starting column. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1511 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
|
1512 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
|
1513 @var{string} extends across the column @var{start-column}, that |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1514 character is not included. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1515 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1516 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
|
1517 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
|
1518 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
|
1519 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
|
1520 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
|
1521 @var{string} extends across the column @var{start-column}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1522 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1523 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1524 (truncate-string-to-width "\tab\t" 12 4) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1525 @result{} "ab" |
52002
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
1526 (truncate-string-to-width "\tab\t" 12 4 ?\s) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1527 @result{} " ab " |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1528 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1529 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1530 |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1531 @node Line Height |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1532 @section Line Height |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1533 @cindex line height |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1534 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1535 The total height of each display line consists of the height of the |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1536 contents of the line, and additional vertical line spacing below the |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1537 display row. |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1538 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1539 The height of the line contents is normally determined from the |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1540 maximum height of any character or image on that display line, |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1541 including the final newline if there is one. (A line that is |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1542 continued doesn't include a final newline.) In the most common case, |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1543 the line height equals the height of the default frame font. |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1544 |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1545 There are several ways to explicitly control or change the line |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1546 height, either by specifying an absolute height for the display line, |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1547 or by adding additional vertical space below one or all lines. |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1548 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1549 @kindex line-height @r{(text property)} |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1550 A newline can have a @code{line-height} text or overlay property |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1551 that controls the total height of the display line ending in that |
59212
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1552 newline. |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1553 |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1554 If the property value is a list @code{(@var{height} @var{total})}, |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1555 then @var{height} is used as the actual property value for the |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1556 @code{line-height}, and @var{total} specifies the total displayed |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1557 height of the line, so the line spacing added below the line equals |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1558 the @var{total} height minus the actual line height. In this case, |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1559 the other ways to specify the line spacing are ignored. |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1560 |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1561 If the property value is @code{t}, the displayed height of the |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1562 line is exactly what its contents demand; no line-spacing is added. |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1563 This case is useful for tiling small images or image slices without |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1564 adding blank areas between the images. |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1565 |
59212
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1566 If the property value is not @code{t}, it is a height spec. A height |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1567 spec stands for a numeric height value; this heigh spec specifies the |
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1568 actual line height, @var{line-height}. There are several ways to |
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1569 write a height spec; here's how each of them translates into a numeric |
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1570 height: |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1571 |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1572 @table @code |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1573 @item @var{integer} |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1574 If the height spec is a positive integer, the height value is that integer. |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1575 @item @var{float} |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1576 If the height spec is a float, @var{float}, the numeric height value |
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1577 is @var{float} times the frame's default line height. |
59212
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1578 @item (@var{face} . @var{ratio}) |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1579 If the height spec is a cons of the format shown, the numeric height |
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1580 is @var{ratio} times the height of face @var{face}. @var{ratio} can |
59212
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1581 be any type of number, or @code{nil} which means a ratio of 1. |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1582 If @var{face} is @code{t}, it refers to the current face. |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1583 @item (@code{nil} . @var{ratio}) |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1584 If the height spec is a cons of the format shown, the numeric height |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1585 is @var{ratio} times the height of the contents of the line. |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1586 @end table |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1587 |
59212
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1588 Thus, any valid non-@code{t} property value specifies a height in pixels, |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1589 @var{line-height}, one way or another. If the line contents' height |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1590 is less than @var{line-height}, Emacs adds extra vertical space above |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1591 the line to achieve the total height @var{line-height}. Otherwise, |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1592 @var{line-height} has no effect. |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1593 |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1594 If you don't specify the @code{line-height} propery, the line's |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1595 height consists of the contents' height plus the line spacing. |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1596 There are several ways to specify the line spacing for different |
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1597 parts of Emacs text. |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1598 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1599 @vindex default-line-spacing |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1600 You can specify the line spacing for all lines in a frame with the |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1601 @code{line-spacing} frame parameter, @xref{Window Frame Parameters}. |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1602 However, if the variable @code{default-line-spacing} is |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1603 non-@code{nil}, it overrides the frame's @code{line-spacing} |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1604 parameter. An integer value specifies the number of pixels put below |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1605 lines on window systems. A floating point number specifies the |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1606 spacing relative to the frame's default line height. |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1607 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1608 @vindex line-spacing |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1609 You can specify the line spacing for all lines in a buffer via the |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1610 buffer-local @code{line-spacing} variable. An integer value specifies |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1611 the number of pixels put below lines on window systems. A floating |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1612 point number specifies the spacing relative to the default frame line |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1613 height. This overrides line spacings specified for the frame. |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1614 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1615 @kindex line-spacing @r{(text property)} |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1616 Finally, a newline can have a @code{line-spacing} text or overlay |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1617 property that controls the height of the display line ending with that |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1618 newline. The property value overrides the default frame line spacing |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1619 and the buffer local @code{line-spacing} variable. |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1620 |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1621 One way or another, these mechanisms specify a Lisp value for the |
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1622 spacing of each line. The value is a height spec, and it translates |
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1623 into a Lisp value as described above. However, in this case the |
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1624 numeric height value specifies the line spacing, rather than the line |
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1625 height. |
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1626 |
6598 | 1627 @node Faces |
1628 @section Faces | |
40469
aa8474236e9e
Index "faces" instead of "face".
Richard M. Stallman <rms@gnu.org>
parents:
40310
diff
changeset
|
1629 @cindex faces |
6598 | 1630 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1631 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
|
1632 family, foreground color, background color, optional underlining, and |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1633 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
|
1634 particular parts of the text or the frame. |
6598 | 1635 |
1636 @cindex face id | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1637 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
|
1638 low levels within Emacs. However, for most purposes, you refer to |
6598 | 1639 faces in Lisp programs by their names. |
1640 | |
12067 | 1641 @defun facep object |
1642 This function returns @code{t} if @var{object} is a face name symbol (or | |
1643 if it is a vector of the kind used internally to record face data). It | |
1644 returns @code{nil} otherwise. | |
1645 @end defun | |
1646 | |
6598 | 1647 Each face name is meaningful for all frames, and by default it has the |
1648 same meaning in all frames. But you can arrange to give a particular | |
1649 face name a special meaning in one frame if you wish. | |
1650 | |
1651 @menu | |
1652 * Standard Faces:: The faces Emacs normally comes with. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1653 * 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
|
1654 * 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
|
1655 * Attribute Functions:: Functions to examine and set face attributes. |
59277
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
1656 * Displaying 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
|
1657 * 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
|
1658 * Face Functions:: How to define and examine faces. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1659 * Auto Faces:: Hook for automatic face assignment. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1660 * Font Lookup:: Looking up the names of available fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1661 and information about them. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1662 * Fontsets:: A fontset is a collection of fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1663 that handle a range of character sets. |
6598 | 1664 @end menu |
1665 | |
1666 @node Standard Faces | |
1667 @subsection Standard Faces | |
1668 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1669 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
|
1670 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
|
1671 text; you can control how those places look by customizing these faces. |
6598 | 1672 |
1673 @table @code | |
1674 @item default | |
1675 @kindex default @r{(face name)} | |
1676 This face is used for ordinary text. | |
1677 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1678 @item mode-line |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1679 @kindex mode-line @r{(face name)} |
43262
af1ba8f61638
(Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents:
43099
diff
changeset
|
1680 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
|
1681 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
|
1682 @code{mode-line-inverse-video} is non-@code{nil}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1683 |
6598 | 1684 @item modeline |
1685 @kindex modeline @r{(face name)} | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1686 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
|
1687 old Emacs versions. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1688 |
43262
af1ba8f61638
(Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents:
43099
diff
changeset
|
1689 @item mode-line-inactive |
af1ba8f61638
(Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents:
43099
diff
changeset
|
1690 @kindex mode-line-inactive @r{(face name)} |
af1ba8f61638
(Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents:
43099
diff
changeset
|
1691 This face is used for mode lines of non-selected windows. |
43290 | 1692 This face inherits from @code{mode-line}, so changes |
1693 in that face affect all windows. | |
43262
af1ba8f61638
(Standard Faces): Document mode-line-inactive.
Eli Zaretskii <eliz@gnu.org>
parents:
43099
diff
changeset
|
1694 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1695 @item header-line |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1696 @kindex header-line @r{(face name)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1697 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
|
1698 |
25875 | 1699 @item menu |
1700 This face controls the display of menus, both their colors and their | |
1701 font. (This works only on certain systems.) | |
1702 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1703 @item fringe |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1704 @kindex fringe @r{(face name)} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
1705 This face controls the default colors of window fringes, the thin areas on |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1706 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
|
1707 |
43099
761d92c0f64e
(Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents:
42905
diff
changeset
|
1708 @item minibuffer-prompt |
761d92c0f64e
(Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents:
42905
diff
changeset
|
1709 @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
|
1710 @vindex minibuffer-prompt-properties |
761d92c0f64e
(Standard Faces): Document the minibuffer-prompt face and the
Eli Zaretskii <eliz@gnu.org>
parents:
42905
diff
changeset
|
1711 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
|
1712 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
|
1713 @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
|
1714 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
|
1715 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1716 @item scroll-bar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1717 @kindex scroll-bar @r{(face name)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1718 This face controls the colors for display of scroll bars. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1719 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1720 @item tool-bar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1721 @kindex tool-bar @r{(face name)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1722 This face is used for display of the tool bar, if any. |
6598 | 1723 |
1724 @item region | |
1725 @kindex region @r{(face name)} | |
1726 This face is used for highlighting the region in Transient Mark mode. | |
1727 | |
1728 @item secondary-selection | |
1729 @kindex secondary-selection @r{(face name)} | |
1730 This face is used to show any secondary selection you have made. | |
1731 | |
1732 @item highlight | |
1733 @kindex highlight @r{(face name)} | |
1734 This face is meant to be used for highlighting for various purposes. | |
1735 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1736 @item trailing-whitespace |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1737 @kindex trailing-whitespace @r{(face name)} |
25875 | 1738 This face is used to display excess whitespace at the end of a line, |
1739 if @code{show-trailing-whitespace} is non-@code{nil}. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1740 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1741 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1742 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
|
1743 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
|
1744 the effects they produce. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1745 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1746 @table @code |
6598 | 1747 @item bold |
1748 @kindex bold @r{(face name)} | |
1749 This face uses a bold font, if possible. It uses the bold variant of | |
1750 the frame's font, if it has one. It's up to you to choose a default | |
1751 font that has a bold variant, if you want to use one. | |
1752 | |
1753 @item italic | |
1754 @kindex italic @r{(face name)} | |
1755 This face uses the italic variant of the frame's font, if it has one. | |
1756 | |
1757 @item bold-italic | |
1758 @kindex bold-italic @r{(face name)} | |
1759 This face uses the bold italic variant of the frame's font, if it has | |
1760 one. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1761 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1762 @item underline |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1763 @kindex underline @r{(face name)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1764 This face underlines text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1765 |
38278 | 1766 @item fixed-pitch |
1767 @kindex fixed-pitch @r{(face name)} | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1768 This face forces use of a particular fixed-width font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1769 |
38278 | 1770 @item variable-pitch |
1771 @kindex variable-pitch @r{(face name)} | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1772 This face forces use of a particular variable-width font. It's |
25875 | 1773 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
|
1774 you like, but you should not make it a fixed-width font. |
6598 | 1775 @end table |
1776 | |
25875 | 1777 @defvar show-trailing-whitespace |
1778 @tindex show-trailing-whitespace | |
1779 If this variable is non-@code{nil}, Emacs uses the | |
1780 @code{trailing-whitespace} face to display any spaces and tabs at the | |
1781 end of a line. | |
1782 @end defvar | |
1783 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1784 @node Defining Faces |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1785 @subsection Defining Faces |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1786 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1787 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
|
1788 kind of customization item (@pxref{Customization}) which the user can |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1789 customize using the Customization buffer (@pxref{Easy Customization,,, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1790 emacs, The GNU Emacs Manual}). |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1791 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1792 @defmac defface face spec doc [keyword value]... |
25875 | 1793 This declares @var{face} as a customizable face that defaults according |
1794 to @var{spec}. You should not quote the symbol @var{face}. The | |
1795 argument @var{doc} specifies the face documentation. The keywords you | |
1796 can use in @code{defface} are the same ones that are meaningful in both | |
1797 @code{defgroup} and @code{defcustom} (@pxref{Common Keywords}). | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1798 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1799 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
|
1800 @var{spec}, then uses any customizations that were read from the |
25875 | 1801 init file (@pxref{Init File}) to override that specification. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1802 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1803 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
|
1804 different kinds of terminals. It should be an alist whose elements have |
25875 | 1805 the form @code{(@var{display} @var{atts})}. Each element's @sc{car}, |
1806 @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
|
1807 @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
|
1808 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
|
1809 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
|
1810 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1811 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
|
1812 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
|
1813 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
|
1814 for that frame. There are two possibilities for @var{display}: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1815 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1816 @table @asis |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1817 @item @code{t} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1818 This element of @var{spec} matches all frames. Therefore, any |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1819 subsequent elements of @var{spec} are never used. Normally |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1820 @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
|
1821 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1822 @item a list |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1823 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
|
1824 @code{(@var{characteristic} @var{value}@dots{})}. Here |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1825 @var{characteristic} specifies a way of classifying frames, and the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1826 @var{value}s are possible classifications which @var{display} should |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1827 apply to. Here are the possible values of @var{characteristic}: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1828 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1829 @table @code |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1830 @item type |
32802
66f219c7e8ca
(Defining Faces): Document `graphic' display type in face specs.
Miles Bader <miles@gnu.org>
parents:
32552
diff
changeset
|
1831 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
|
1832 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
|
1833 @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
|
1834 display). |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1835 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1836 @item class |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1837 What kinds of colors the frame supports---either @code{color}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1838 @code{grayscale}, or @code{mono}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1839 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1840 @item background |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1841 The kind of background---either @code{light} or @code{dark}. |
45745 | 1842 |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1843 @item min-colors |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1844 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
|
1845 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
|
1846 |
45745 | 1847 @item supports |
46170 | 1848 Whether or not the frame can display the face attributes given in |
1849 @var{value}@dots{} (@pxref{Face Attributes}). See the documentation | |
1850 for the function @code{display-supports-face-attributes-p} for more | |
1851 information on exactly how this testing is done. @xref{Display Face | |
1852 Attribute Testing}. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1853 @end table |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1854 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1855 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
|
1856 given @var{characteristic}, any of those values is acceptable. If |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1857 @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
|
1858 different @var{characteristic}; then @emph{each} characteristic of the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1859 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
|
1860 @var{display}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1861 @end table |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1862 @end defmac |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1863 |
25875 | 1864 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
|
1865 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1866 @example |
25875 | 1867 @group |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1868 '((((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
|
1869 :background "blue3") |
25875 | 1870 @end group |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1871 (((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
|
1872 :background "lightgoldenrod2") |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1873 (((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
|
1874 :background "blue3") |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1875 (((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
|
1876 :background "lightgoldenrod2") |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1877 (((class color) (min-colors 8)) |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1878 :background "blue" :foreground "white") |
25875 | 1879 (((type tty) (class mono)) |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1880 :inverse-video t) |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1881 (t :background "gray")) |
25875 | 1882 @group |
1883 "Basic face for highlighting the region." | |
1884 :group 'basic-faces) | |
1885 @end group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1886 @end example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1887 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1888 Internally, @code{defface} uses the symbol property |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1889 @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
|
1890 @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
|
1891 with the customization buffer, and @code{face-documentation} for the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1892 documentation string. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1893 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1894 @defopt frame-background-mode |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1895 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
|
1896 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
|
1897 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
|
1898 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
|
1899 as if they had a light background. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1900 @end defopt |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1901 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1902 @node Face Attributes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1903 @subsection Face Attributes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1904 @cindex face attributes |
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 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
|
1907 attributes}. This table lists all the face attributes, and what they |
25875 | 1908 mean. Note that in general, more than one face can be specified for a |
1909 given piece of text; when that happens, the attributes of all the faces | |
59286
785b3315a07c
(Face Attributes): Correct xref to renamed node.
Luc Teirlinck <teirllm@auburn.edu>
parents:
59277
diff
changeset
|
1910 are merged to specify how to display the text. @xref{Displaying Faces}. |
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 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
|
1913 @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
|
1914 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
|
1915 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
|
1916 @code{default} face must specify all attributes. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1917 |
25875 | 1918 Some of these font attributes are meaningful only on certain kinds of |
1919 displays---if your display cannot handle a certain attribute, the | |
1920 attribute is ignored. (The attributes @code{:family}, @code{:width}, | |
1921 @code{:height}, @code{:weight}, and @code{:slant} correspond to parts of | |
1922 an X Logical Font Descriptor.) | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1923 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1924 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1925 @item :family |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1926 Font family name, or fontset name (@pxref{Fontsets}). If you specify a |
25875 | 1927 font family name, the wild-card characters @samp{*} and @samp{?} are |
1928 allowed. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1929 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1930 @item :width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1931 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
|
1932 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
|
1933 @code{extra-condensed}, @code{condensed}, @code{semi-condensed}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1934 @code{normal}, @code{semi-expanded}, @code{expanded}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1935 @code{extra-expanded}, or @code{ultra-expanded}. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1936 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1937 @item :height |
32089
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1938 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
|
1939 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
|
1940 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
|
1941 (from the underlying face), and should return the new height. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1942 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1943 @item :weight |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1944 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
|
1945 @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
|
1946 @code{normal}, @code{semi-light}, @code{light}, @code{extra-light}, |
25875 | 1947 or @code{ultra-light}. |
25809
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1948 |
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1949 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
|
1950 extra bright, and any weight less than normal is displayed as |
25875 | 1951 half-bright (provided the terminal supports the feature). |
1952 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1953 @item :slant |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1954 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
|
1955 @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
|
1956 |
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1957 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
|
1958 the terminal supports the feature. |
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1959 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1960 @item :foreground |
59277
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
1961 Foreground color, a string. The value can be a system-defined color |
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
1962 name, or a hexadecimal color specification of the form |
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
1963 @samp{#@var{rr}@var{gg}@var{bb}}. (@samp{#000000} is black, |
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
1964 @samp{#ff0000} is red, @samp{#00ff00} is green, @samp{#0000ff} is |
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
1965 blue, and @samp{#ffffff} is white.) |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1966 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1967 @item :background |
59277
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
1968 Background color, a string, like the foreground color. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1969 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1970 @item :inverse-video |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1971 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
|
1972 value should be @code{t} (yes) or @code{nil} (no). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1973 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1974 @item :stipple |
25875 | 1975 The background stipple, a bitmap. |
1976 | |
1977 The value can be a string; that should be the name of a file containing | |
1978 external-format X bitmap data. The file is found in the directories | |
1979 listed in the variable @code{x-bitmap-file-path}. | |
1980 | |
40310
34f1a01f25fa
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
39404
diff
changeset
|
1981 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
|
1982 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
|
1983 @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
|
1984 @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
|
1985 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
|
1986 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
|
1987 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
|
1988 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1989 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
|
1990 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1991 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
|
1992 used automatically to handle certain shades of gray. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1993 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1994 @item :underline |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1995 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
|
1996 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
|
1997 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
|
1998 value @code{nil} means do not underline. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1999 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2000 @item :overline |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2001 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
|
2002 The value is used like that of @code{:underline}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2003 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2004 @item :strike-through |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2005 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
|
2006 color. The value is used like that of @code{:underline}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2007 |
32089
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
2008 @item :inherit |
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
2009 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
|
2010 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
|
2011 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
|
2012 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2013 @item :box |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2014 Whether or not a box should be drawn around characters, its color, the |
25875 | 2015 width of the box lines, and 3D appearance. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2016 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2017 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2018 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
|
2019 they mean: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2020 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2021 @table @asis |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2022 @item @code{nil} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2023 Don't draw a box. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2024 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2025 @item @code{t} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2026 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
|
2027 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2028 @item @var{color} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2029 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
|
2030 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2031 @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
|
2032 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
|
2033 @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
|
2034 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2035 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
|
2036 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
|
2037 color of the face for 3D boxes. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2038 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2039 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
|
2040 @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
|
2041 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
|
2042 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
|
2043 is used. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2044 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2045 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2046 The attributes @code{:overline}, @code{:strike-through} and |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2047 @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
|
2048 @code{:height}, @code{:width}, @code{:weight}, @code{:slant} are also |
25875 | 2049 new; previous versions used the following attributes, now semi-obsolete, |
2050 to specify some of the same information: | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2051 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2052 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2053 @item :font |
25875 | 2054 This attribute specifies the font name. |
25751
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 @item :bold |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2057 A non-@code{nil} value specifies a bold font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2058 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2059 @item :italic |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2060 A non-@code{nil} value specifies an italic font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2061 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2062 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2063 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
|
2064 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
|
2065 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2066 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2067 @item :font |
25875 | 2068 You can specify an X font name as the ``value'' of this ``attribute''; |
2069 that sets the @code{:family}, @code{:width}, @code{:height}, | |
2070 @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
|
2071 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2072 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
|
2073 the pattern is used to set these attributes. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2074 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2075 @item :bold |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2076 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
|
2077 This actually works by setting the @code{:weight} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2078 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2079 @item :italic |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2080 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
|
2081 This actually works by setting the @code{:slant} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2082 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2083 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2084 @defvar x-bitmap-file-path |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2085 This variable specifies a list of directories for searching |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2086 for bitmap files, for the @code{:stipple} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2087 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2088 |
25911
b192e4e3a9f5
Rename pixmap-spec-p to bitmap-spec-p.
Gerd Moellmann <gerd@gnu.org>
parents:
25875
diff
changeset
|
2089 @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
|
2090 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
|
2091 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
|
2092 @code{nil} otherwise. |
25875 | 2093 @end defun |
2094 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2095 @node Attribute Functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2096 @subsection Face Attribute Functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2097 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2098 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
|
2099 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
|
2100 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
|
2101 new frames. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2102 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2103 @tindex set-face-attribute |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2104 @defun set-face-attribute face frame &rest arguments |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2105 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
|
2106 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
|
2107 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
|
2108 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2109 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
|
2110 the values for them. They should consist of alternating attribute names |
25875 | 2111 (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
|
2112 Thus, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2113 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2114 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2115 (set-face-attribute 'foo nil |
46721
12862351ee03
Fix set-face-attribute example.
Richard M. Stallman <rms@gnu.org>
parents:
46338
diff
changeset
|
2116 :width 'extended |
12862351ee03
Fix set-face-attribute example.
Richard M. Stallman <rms@gnu.org>
parents:
46338
diff
changeset
|
2117 :weight 'bold |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2118 :underline "red") |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2119 @end example |
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 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2122 sets the attributes @code{:width}, @code{:weight} and @code{:underline} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2123 to the corresponding values. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2124 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2125 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2126 @tindex face-attribute |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2127 @defun face-attribute face attribute &optional frame inherit |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2128 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
|
2129 @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
|
2130 that means the selected frame (@pxref{Input Focus}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2131 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2132 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
|
2133 @var{face} for new frames. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2134 |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2135 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
|
2136 @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
|
2137 @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
|
2138 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
|
2139 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
|
2140 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
|
2141 @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
|
2142 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
|
2143 absolute. |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2144 |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2145 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
|
2146 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
|
2147 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
|
2148 (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
|
2149 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2150 For example, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2151 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2152 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2153 (face-attribute 'bold :weight) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2154 @result{} bold |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2155 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2156 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2157 |
25875 | 2158 The functions above did not exist before Emacs 21. For compatibility |
2159 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
|
2160 and examine the face attributes which existed in those versions. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2161 |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2162 @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
|
2163 @defun face-attribute-relative-p attribute value |
54023 | 2164 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
|
2165 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
|
2166 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
|
2167 @end defun |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2168 |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2169 @tindex merge-face-attribute |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2170 @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
|
2171 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
|
2172 @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
|
2173 @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
|
2174 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
|
2175 @end defun |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2176 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2177 @defun set-face-foreground face color &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2178 @defunx set-face-background face color &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2179 These functions set the foreground (or background, respectively) color |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2180 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
|
2181 string, the name of a color. |
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 Certain shades of gray are implemented by stipple patterns on |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2184 black-and-white screens. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2185 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2186 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2187 @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
|
2188 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
|
2189 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
|
2190 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
|
2191 (@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
|
2192 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2193 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
|
2194 they are used automatically to handle certain shades of gray. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2195 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2196 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2197 @defun set-face-font face font &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2198 This function sets the font of face @var{face}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2199 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2200 In Emacs 21, this actually sets the attributes @code{:family}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2201 @code{:width}, @code{:height}, @code{:weight}, and @code{:slant} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2202 according to the font name @var{font}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2203 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2204 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
|
2205 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
|
2206 because the precise font that you specified is used. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2207 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2208 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2209 @defun set-face-bold-p face bold-p &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2210 This function specifies whether @var{face} should be bold. If |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2211 @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
|
2212 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2213 In Emacs 21, this sets the @code{:weight} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2214 In Emacs 20, it sets the @code{:bold} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2215 @end defun |
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 @defun set-face-italic-p face italic-p &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2218 This function specifies whether @var{face} should be italic. If |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2219 @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
|
2220 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2221 In Emacs 21, this sets the @code{:slant} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2222 In Emacs 20, it sets the @code{:italic} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2223 @end defun |
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 set-face-underline-p face underline-p &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2226 This function sets the underline attribute of face @var{face}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2227 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
|
2228 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2229 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2230 @defun invert-face face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2231 This function inverts the @code{:inverse-video} attribute of face |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2232 @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
|
2233 @code{t}, and vice versa. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2234 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2235 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2236 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
|
2237 specify @var{frame}, they refer to the default data for new frames. |
25875 | 2238 They return the symbol @code{unspecified} if the face doesn't define any |
2239 value for that attribute. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2240 |
46245
fb42c0446cbf
Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents:
46240
diff
changeset
|
2241 @defun face-foreground face &optional frame inherit |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2242 @defunx face-background face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2243 These functions return the foreground color (or background color, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2244 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
|
2245 |
54777 | 2246 If @var{inherit} is @code{nil}, only a color directly defined by the face is |
2247 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
|
2248 @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
|
2249 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
|
2250 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
|
2251 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
|
2252 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2253 |
46245
fb42c0446cbf
Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents:
46240
diff
changeset
|
2254 @defun face-stipple face &optional frame inherit |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2255 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
|
2256 @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
|
2257 |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2258 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
|
2259 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
|
2260 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
|
2261 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
|
2262 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
|
2263 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
|
2264 @var{inherit}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2265 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2266 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2267 @defun face-font face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2268 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
|
2269 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2270 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2271 @defun face-bold-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2272 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
|
2273 bolder than normal. It returns @code{nil} otherwise. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2274 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2275 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2276 @defun face-italic-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2277 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
|
2278 @code{nil} otherwise. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2279 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2280 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2281 @defun face-underline-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2282 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
|
2283 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2284 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2285 @defun face-inverse-video-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2286 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
|
2287 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2288 |
59277
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
2289 @node Displaying Faces |
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
2290 @subsection Displaying Faces |
6598 | 2291 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2292 Here are the ways to specify which faces to use for display of text: |
6598 | 2293 |
2294 @itemize @bullet | |
2295 @item | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2296 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
|
2297 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
|
2298 face is used only when no other face is specified.) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2299 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2300 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
|
2301 @code{header-line} is used just before @code{default}. |
6598 | 2302 |
2303 @item | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2304 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
|
2305 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
|
2306 Properties}. |
6598 | 2307 |
2308 If the character has a @code{mouse-face} property, that is used instead | |
2309 of the @code{face} property when the mouse is ``near enough'' to the | |
2310 character. | |
2311 | |
2312 @item | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2313 With overlays. An overlay can have @code{face} and @code{mouse-face} |
6598 | 2314 properties too; they apply to all the text covered by the overlay. |
2315 | |
2316 @item | |
12098 | 2317 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
|
2318 highlighted with the face @code{region} (@pxref{Standard Faces}). |
12098 | 2319 |
2320 @item | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
2321 With special glyphs. Each glyph can specify a particular face |
6598 | 2322 number. @xref{Glyphs}. |
2323 @end itemize | |
2324 | |
2325 If these various sources together specify more than one face for a | |
2326 particular character, Emacs merges the attributes of the various faces | |
2327 specified. The attributes of the faces of special glyphs come first; | |
12098 | 2328 then comes the face for region highlighting, if appropriate; |
6598 | 2329 then come attributes of faces from overlays, followed by those from text |
2330 properties, and last the default face. | |
2331 | |
2332 When multiple overlays cover one character, an overlay with higher | |
2333 priority overrides those with lower priority. @xref{Overlays}. | |
2334 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2335 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
|
2336 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
|
2337 used. In newer Emacs versions, this cannot happen, because the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2338 @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
|
2339 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
|
2340 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2341 @node Font Selection |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2342 @subsection Font Selection |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2343 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2344 @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
|
2345 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
|
2346 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
|
2347 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
|
2348 it is. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2349 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2350 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
|
2351 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
|
2352 family, a font pattern is constructed. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2353 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2354 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
|
2355 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
|
2356 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
|
2357 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
|
2358 ``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
|
2359 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
|
2360 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
|
2361 try. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2362 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2363 @defvar face-font-selection-order |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2364 @tindex face-font-selection-order |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2365 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
|
2366 @code{:width}, @code{:height}, @code{:weight}, and @code{:slant}. The |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2367 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
|
2368 decreasing importance. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2369 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2370 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
|
2371 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
|
2372 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
|
2373 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2374 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
|
2375 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
|
2376 (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
|
2377 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
|
2378 non-normal faces contrast with normal ones, whenever possible. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2379 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2380 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
|
2381 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
|
2382 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
|
2383 and so on. |
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 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
|
2386 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
|
2387 @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
|
2388 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
|
2389 @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
|
2390 quite right. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2391 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2392 |
33373 | 2393 @defvar face-font-family-alternatives |
2394 @tindex face-font-family-alternatives | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2395 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
|
2396 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
|
2397 this form: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2398 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2399 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2400 (@var{family} @var{alternate-families}@dots{}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2401 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2402 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2403 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
|
2404 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
|
2405 family that does exist. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2406 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2407 |
33373 | 2408 @defvar face-font-registry-alternatives |
2409 @tindex face-font-registry-alternatives | |
2410 This variable lets you specify alternative font registries to try, if a | |
2411 given registry is specified and doesn't exist. Each element should have | |
2412 this form: | |
2413 | |
2414 @example | |
2415 (@var{registry} @var{alternate-registries}@dots{}) | |
2416 @end example | |
2417 | |
2418 If @var{registry} is specified but not available, Emacs will try the | |
2419 other registries given in @var{alternate-registries}, one by one, | |
2420 until it finds a registry that does exist. | |
2421 @end defvar | |
2422 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2423 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
|
2424 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
|
2425 XFree86 servers. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2426 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2427 @defvar scalable-fonts-allowed |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2428 @tindex scalable-fonts-allowed |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2429 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
|
2430 @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
|
2431 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
|
2432 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2433 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
|
2434 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
|
2435 expression in the list. For example, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2436 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2437 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2438 (setq scalable-fonts-allowed '("muleindian-2$")) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2439 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2440 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2441 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2442 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
|
2443 @end defvar |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2444 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2445 @defun clear-face-cache &optional unload-p |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2446 @tindex clear-face-cache |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2447 This function clears the face cache for all frames. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2448 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
|
2449 all unused fonts as well. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2450 @end defun |
6598 | 2451 |
52002
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2452 @defvar face-font-rescale-alist |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2453 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
|
2454 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
|
2455 |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2456 @example |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2457 (@var{fontname-regexp} . @var{scale-factor}) |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2458 @end example |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2459 |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2460 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
|
2461 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
|
2462 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
|
2463 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
|
2464 nominal heights and widths would suggest. |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2465 @end defvar |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2466 |
6598 | 2467 @node Face Functions |
2468 @subsection Functions for Working with Faces | |
2469 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2470 Here are additional functions for creating and working with faces. |
6598 | 2471 |
2472 @defun make-face name | |
2473 This function defines a new face named @var{name}, initially with all | |
2474 attributes @code{nil}. It does nothing if there is already a face named | |
2475 @var{name}. | |
2476 @end defun | |
2477 | |
2478 @defun face-list | |
2479 This function returns a list of all defined face names. | |
2480 @end defun | |
2481 | |
2482 @defun copy-face old-face new-name &optional frame new-frame | |
2483 This function defines the face @var{new-name} as a copy of the existing | |
2484 face named @var{old-face}. It creates the face @var{new-name} if that | |
2485 doesn't already exist. | |
2486 | |
2487 If the optional argument @var{frame} is given, this function applies | |
2488 only to that frame. Otherwise it applies to each frame individually, | |
2489 copying attributes from @var{old-face} in each frame to @var{new-face} | |
2490 in the same frame. | |
2491 | |
2492 If the optional argument @var{new-frame} is given, then @code{copy-face} | |
2493 copies the attributes of @var{old-face} in @var{frame} to @var{new-name} | |
2494 in @var{new-frame}. | |
2495 @end defun | |
2496 | |
12098 | 2497 @defun face-id face |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2498 This function returns the face number of face @var{face}. |
6598 | 2499 @end defun |
2500 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2501 @defun face-documentation face |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
2502 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
|
2503 @code{nil} if none was specified for it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
2504 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
2505 |
6598 | 2506 @defun face-equal face1 face2 &optional frame |
2507 This returns @code{t} if the faces @var{face1} and @var{face2} have the | |
2508 same attributes for display. | |
2509 @end defun | |
2510 | |
2511 @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
|
2512 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
|
2513 differently from the default face. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2514 @end defun |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2515 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2516 @node Auto Faces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2517 @subsection Automatic Face Assignment |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2518 @cindex automatic face assignment |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2519 @cindex faces, automatic choice |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2520 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2521 @cindex Font-Lock mode |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2522 Starting with Emacs 21, a hook is available for automatically |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2523 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
|
2524 the implementation of Font-Lock mode. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2525 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2526 @tindex fontification-functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2527 @defvar fontification-functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2528 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
|
2529 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
|
2530 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2531 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
|
2532 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
|
2533 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
|
2534 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2535 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
|
2536 @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
|
2537 @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
|
2538 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
|
2539 already. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2540 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2541 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
|
2542 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
|
2543 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
|
2544 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
|
2545 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
|
2546 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2547 For efficiency, we recommend writing these functions so that they |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2548 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
|
2549 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2550 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2551 @node Font Lookup |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2552 @subsection Looking Up Fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2553 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2554 @defun x-list-fonts pattern &optional face frame maximum |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2555 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
|
2556 @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
|
2557 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
|
2558 @var{face} currently is on @var{frame}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2559 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2560 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
|
2561 characters: the @samp{*} character matches any substring, and the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2562 @samp{?} character matches any single character. Pattern matching |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2563 of font names ignores case. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2564 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2565 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
|
2566 (a symbol) and @var{frame} should be a frame. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2567 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2568 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
|
2569 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
|
2570 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
|
2571 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
|
2572 many fonts match the pattern. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2573 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2574 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2575 These additional functions are available starting in Emacs 21. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2576 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2577 @defun x-family-fonts &optional family frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2578 @tindex x-family-fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2579 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
|
2580 @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
|
2581 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
|
2582 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
|
2583 contain the wildcards @samp{?} and @samp{*}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2584 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2585 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
|
2586 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
|
2587 (@pxref{Input Focus}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2588 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2589 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
|
2590 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2591 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2592 [@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
|
2593 @var{fixed-p} @var{full} @var{registry-and-encoding}] |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2594 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2595 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2596 The first five elements correspond to face attributes; if you |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2597 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
|
2598 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2599 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
|
2600 @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
|
2601 @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
|
2602 @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
|
2603 encoding of the font. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2604 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2605 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
|
2606 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2607 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2608 @defun x-font-family-list &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2609 @tindex x-font-family-list |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2610 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
|
2611 @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
|
2612 describes the selected frame's display (@pxref{Input Focus}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2613 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2614 The value is a list of elements of this form: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2615 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2616 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2617 (@var{family} . @var{fixed-p}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2618 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2619 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2620 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2621 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
|
2622 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
|
2623 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2624 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2625 @defvar font-list-limit |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2626 @tindex font-list-limit |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2627 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
|
2628 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
|
2629 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
|
2630 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
|
2631 currently 100. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2632 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2633 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2634 @node Fontsets |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2635 @subsection Fontsets |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2636 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2637 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
|
2638 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
|
2639 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
|
2640 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
|
2641 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
|
2642 information about defining a fontset under Lisp program control. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2643 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2644 @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
|
2645 This function defines a new fontset according to the specification |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2646 string @var{fontset-spec}. The string should have this format: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2647 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2648 @smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2649 @var{fontpattern}, @r{[}@var{charsetname}:@var{fontname}@r{]@dots{}} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2650 @end smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2651 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2652 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2653 Whitespace characters before and after the commas are ignored. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2654 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2655 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
|
2656 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
|
2657 @samp{fontset-@var{alias}}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2658 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2659 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
|
2660 @var{fontpattern} in its entirety. The short name is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2661 @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
|
2662 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
|
2663 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
|
2664 function does nothing. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2665 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2666 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
|
2667 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
|
2668 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
|
2669 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
|
2670 status. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2671 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2672 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
|
2673 See below for the details. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2674 @end defun |
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 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
|
2677 use (in this fontset) for one particular character set. Here, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2678 @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
|
2679 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
|
2680 times in the specification string. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2681 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2682 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
|
2683 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
|
2684 @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
|
2685 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
|
2686 with @samp{ISO8859-1}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2687 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2688 In addition, when several consecutive fields are wildcards, Emacs |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2689 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
|
2690 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
|
2691 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
|
2692 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
|
2693 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2694 Thus if @var{fontpattern} is this, |
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 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2697 -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2698 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2699 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2700 @noindent |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52940
diff
changeset
|
2701 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
|
2702 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2703 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2704 -*-fixed-medium-r-normal-*-24-*-ISO8859-1 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2705 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2706 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2707 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2708 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
|
2709 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2710 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2711 -*-fixed-medium-r-normal-*-24-*-gb2312*-* |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2712 @end example |
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 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
|
2715 specification. Most X distributions include only Chinese fonts that |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2716 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
|
2717 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
|
2718 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2719 @smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2720 Emacs.Fontset-0: -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24,\ |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2721 chinese-gb2312:-*-*-medium-r-normal-*-24-*-gb2312*-* |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2722 @end smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2723 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2724 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2725 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
|
2726 @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
|
2727 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
|
2728 field. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2729 |
52932
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2730 @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
|
2731 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
|
2732 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
|
2733 |
52940
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2734 If @var{name} is @code{nil}, this function modifies the default |
54023 | 2735 fontset, whose short name is @samp{fontset-default}. |
52940
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2736 |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2737 @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
|
2738 @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
|
2739 @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
|
2740 (inclusive). |
52932
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2741 |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2742 @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
|
2743 @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
|
2744 |
52940
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2745 @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
|
2746 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
|
2747 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
|
2748 (possibly including an encoding name at the tail). |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2749 |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2750 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
|
2751 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
|
2752 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
|
2753 |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2754 @example |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2755 (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
|
2756 @end example |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2757 |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2758 @end defun |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2759 |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2760 @defun char-displayable-p char |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2761 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
|
2762 @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
|
2763 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
|
2764 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2765 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
|
2766 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
|
2767 @end defun |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2768 |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2769 @node Fringes |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2770 @section Fringes |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2771 @cindex Fringes |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2772 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2773 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
|
2774 sides that are used for displaying bitmaps that indicate truncation, |
54023 | 2775 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
|
2776 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
|
2777 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
|
2778 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
|
2779 non-@code{nil} value. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2780 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2781 @defvar fringes-outside-margins |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2782 If the value is non-@code{nil}, the frames appear outside |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2783 the display margins. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2784 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2785 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2786 @defvar left-fringe-width |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2787 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
|
2788 fringe in pixels. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2789 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2790 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2791 @defvar right-fringe-width |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2792 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
|
2793 fringe in pixels. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2794 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2795 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2796 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
|
2797 buffer in a window. If you change them while the buffer is visible, |
54023 | 2798 you can call @code{set-window-buffer} to display it once again in the |
2799 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
|
2800 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2801 @defun set-window-fringes window left &optional right outside-margins |
54023 | 2802 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
|
2803 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
|
2804 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2805 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
|
2806 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
|
2807 @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
|
2808 @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
|
2809 should appear outside of the display margins. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2810 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2811 |
53929
3ef7a4a3c230
(Fringes): Use consistent wording.
Kim F. Storm <storm@cua.dk>
parents:
53829
diff
changeset
|
2812 @defun window-fringes &optional window |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2813 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
|
2814 @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
|
2815 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
|
2816 @var{right-width} @var{frames-outside-margins})}. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2817 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2818 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2819 @defvar overflow-newline-into-fringe |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2820 If this is non-@code{nil}, lines exactly as wide as the window (not |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2821 counting the final newline character) are not continued. Instead, |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2822 when point is at the end of the line, the cursor appears in the right |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2823 fringe. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2824 @end defvar |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2825 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2826 @node Fringe Bitmaps |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2827 @section Fringe Bitmaps |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2828 @cindex fringe bitmaps |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2829 @cindex bitmaps, fringe |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2830 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2831 The @dfn{fringe bitmaps} are tiny icons Emacs displays in the window |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2832 fringe (on a graphic display) to indicate truncated or continued |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2833 lines, buffer boundaries, overlay arrow, etc. The fringe bitmaps are |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2834 shared by all frames and windows. You can redefine the built-in |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2835 fringe bitmaps, and you can define new fringe bitmaps. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2836 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2837 The way to display a bitmap in the left or right fringes for a given |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2838 line in a window is by specifying the @code{display} property for one |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2839 of the characters that appears in it. Use a display specification of |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2840 the form @code{(left-fringe @var{bitmap} [@var{face}])} or |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2841 @code{(right-fringe @var{bitmap} [@var{face}])} (@pxref{Display |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2842 Property}). Here, @var{bitmap} is a symbol identifying the bitmap |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2843 you want, and @var{face} (which is optional) is the name of the face |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2844 whose colors should be used for displaying the bitmap. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2845 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2846 These are the symbols identify the standard fringe bitmaps. |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2847 Evaluate @code{(require 'fringe)} to define them. Fringe bitmap |
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2848 symbols have their own name space. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2849 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2850 @table @asis |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2851 @item Truncation and continuation line bitmaps: |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2852 @code{left-truncation}, @code{right-truncation}, |
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2853 @code{continued-line}, @code{continuation-line}. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2854 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2855 @item Buffer indication bitmaps: |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2856 @code{up-arrow}, @code{down-arrow}, |
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2857 @code{top-left-angle}, @code{top-right-angle}, |
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2858 @code{bottom-left-angle}, @code{bottom-right-angle}, |
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2859 @code{left-bracket}, @code{right-bracket}. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2860 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2861 @item Empty line indication bitmap: |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2862 @code{empty-line}. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2863 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2864 @item Overlay arrow bitmap: |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2865 @code{overlay-arrow}. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2866 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2867 @item Bitmaps for displaying the cursor in right fringe: |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2868 @code{filled-box-cursor}, @code{hollow-box-cursor}, @code{hollow-square}, |
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2869 @code{bar-cursor}, @code{hbar-cursor}. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2870 @end table |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2871 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2872 @defun fringe-bitmaps-at-pos &optional pos window |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2873 This function returns the fringe bitmaps of the display line |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2874 containing position @var{pos} in window @var{window}. The return |
57331
c02ec4a1158e
(Fringe Bitmaps): Update fringe-bitmaps-at-pos.
Kim F. Storm <storm@cua.dk>
parents:
57274
diff
changeset
|
2875 value has the form @code{(@var{left} @var{right} @var{ov})}, where @var{left} |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2876 is the symbol for the fringe bitmap in the left fringe (or @code{nil} |
57331
c02ec4a1158e
(Fringe Bitmaps): Update fringe-bitmaps-at-pos.
Kim F. Storm <storm@cua.dk>
parents:
57274
diff
changeset
|
2877 if no bitmap), @var{right} is similar for the right fringe, and @var{ov} |
c02ec4a1158e
(Fringe Bitmaps): Update fringe-bitmaps-at-pos.
Kim F. Storm <storm@cua.dk>
parents:
57274
diff
changeset
|
2878 is non-@code{nil} if there is an overlay arrow in the left fringe. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2879 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2880 The value is @code{nil} if @var{pos} is not visible in @var{window}. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2881 If @var{window} is @code{nil}, that stands for the selected window. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2882 If @var{pos} is @code{nil}, that stands for the value of point in |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2883 @var{window}. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2884 @end defun |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2885 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2886 @node Customizing Bitmaps |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2887 @section Customizing Fringe Bitmaps |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2888 |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2889 @defun define-fringe-bitmap bitmap bits &optional height width align |
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2890 This function defines the symbol @var{bitmap} as a new fringe bitmap, |
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2891 or replaces an existing bitmap with that name. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2892 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2893 The argument @var{bits} specifies the image to use. It should be |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2894 either a string or a vector of integers, where each element (an |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2895 integer) corresponds to one row of the bitmap. Each bit of an integer |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2896 corresponds to one pixel of the bitmap, where the low bit corresponds |
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2897 to the rightmost pixel of the bitmap. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2898 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2899 The height is normally the length of @var{bits}. However, you |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2900 can specify a different height with non-@code{nil} @var{height}. The width |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2901 is normally 8, but you can specify a different width with non-@code{nil} |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2902 @var{width}. The width must be an integer between 1 and 16. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2903 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2904 The argument @var{align} specifies the positioning of the bitmap |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2905 relative to the range of rows where it is used; the default is to |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2906 center the bitmap. The allowed values are @code{top}, @code{center}, |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2907 or @code{bottom}. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2908 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2909 The @var{align} argument may also be a list @code{(@var{align} |
57225 | 2910 @var{periodic})} where @var{align} is interpreted as described above. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2911 If @var{periodic} is non-@code{nil}, it specifies that the rows in |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2912 @code{bits} should be repeated enough times to reach the specified |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2913 height. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2914 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2915 The return value on success is an integer identifying the new bitmap. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2916 You should save that integer in a variable so it can be used to select |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2917 this bitmap. |
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2918 |
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2919 This function signals an error if there are no more free bitmap slots. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2920 @end defun |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2921 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2922 @defun destroy-fringe-bitmap bitmap |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2923 This function destroy the fringe bitmap identified by @var{bitmap}. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2924 If @var{bitmap} identifies a standard fringe bitmap, it actually |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2925 restores the standard definition of that bitmap, instead of |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2926 eliminating it entirely. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2927 @end defun |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2928 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2929 @defun set-fringe-bitmap-face bitmap &optional face |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2930 This sets the face for the fringe bitmap @var{bitmap} to @var{face}. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2931 If @var{face} is @code{nil}, it selects the @code{fringe} face. The |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2932 bitmap's face controls the color to draw it in. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2933 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2934 The face you use here should be derived from @code{fringe}, and should |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2935 specify only the foreground color. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2936 @end defun |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2937 |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2938 @node Scroll Bars |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2939 @section Scroll Bars |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2940 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2941 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
|
2942 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
|
2943 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
|
2944 @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
|
2945 meaning the default). @xref{Window Frame Parameters}. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2946 |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
2947 @vindex vertical-scroll-bar |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
2948 You can enable or disable scroll bars for a particular buffer, |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
2949 by setting the variable @code{vertical-scroll-bar}. This variable |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
2950 automatically becomes buffer-local when set. The possible values are |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
2951 @code{left}, @code{right}, @code{t}, which means to use the |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
2952 frame's default, and @code{nil} for no scroll bar. |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
2953 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
2954 You can also control this for individual windows. Call the function |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2955 @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
|
2956 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2957 @defun set-window-scroll-bars window width &optional vertical-type horizontal-type |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2958 This function sets the width and type of scroll bars for window |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2959 @var{window}. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2960 |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2961 @var{width} specifies the scroll bar width in pixels (@code{nil} means |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2962 use the width specified for the frame). @var{vertical-type} specifies |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2963 whether to have a vertical scroll bar and, if so, where. The possible |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2964 values are @code{left}, @code{right} and @code{nil}, just like the |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2965 values of the @code{vertical-scroll-bars} frame parameter. |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2966 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2967 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
|
2968 where to have horizontal scroll bars, but since they are not |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2969 implemented, it has no effect. If @var{window} is @code{nil}, the |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2970 selected window is used. |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2971 @end defun |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2972 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2973 @defun window-scroll-bars &optional window |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2974 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
|
2975 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
|
2976 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
|
2977 @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
|
2978 @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
|
2979 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
|
2980 bar actually occupies. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2981 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2982 @var{horizontal-type} is not actually meaningful. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2983 @end defun |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2984 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2985 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
|
2986 @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
|
2987 @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
|
2988 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
|
2989 @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
|
2990 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
|
2991 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
|
2992 specifying the same buffer that is already displayed. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2993 |
58496
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
2994 @defvar scroll-bar-mode |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
2995 This variable, always local in all buffers, controls whether and where |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
2996 to put scroll bars in windows displaying the buffer. The possible values |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
2997 are @code{nil} for no scroll bar, @code{left} to put a scroll bar on |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
2998 the left, and @code{right} to put a scroll bar on the right. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
2999 @end defvar |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3000 |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3001 @defvar scroll-bar-width |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3002 This variable, always local in all buffers, specifies the width of the |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3003 buffer's scroll bars, measured in pixels. A value of @code{nil} means |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3004 to use the value specified by the frame. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3005 @end defvar |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3006 |
57201
2950fcfcfa44
Correct various typos.
Luc Teirlinck <teirllm@auburn.edu>
parents:
57193
diff
changeset
|
3007 @node Pointer Shape |
2950fcfcfa44
Correct various typos.
Luc Teirlinck <teirllm@auburn.edu>
parents:
57193
diff
changeset
|
3008 @section Pointer Shape |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3009 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3010 Normally, the mouse pointer has the @code{text} shape over text and |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3011 the @code{arrow} shape over window areas which do not correspond to |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3012 any buffer text. You can specify the mouse pointer shape over text or |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3013 images via the @code{pointer} text property, and for images with the |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3014 @code{:pointer} and @code{:map} image properties. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3015 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3016 The available pointer shapes are: @code{text} (or @code{nil}), |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3017 @code{arrow}, @code{hand}, @code{vdrag}, @code{hdrag}, |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3018 @code{modeline}, and @code{hourglass}. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3019 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3020 @defvar void-text-area-pointer |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3021 @tindex void-text-area-pointer |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3022 This variable specifies the mouse pointer shape in void text areas, |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3023 i.e. the areas after the end of a line or below the last line in the |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3024 buffer. The default is to use the @code{arrow} (non-text) pointer. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3025 @end defvar |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3026 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3027 @node Display Property |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3028 @section The @code{display} Property |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3029 @cindex display specification |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3030 @kindex display @r{(text property)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3031 |
25875 | 3032 The @code{display} text property (or overlay property) is used to |
3033 insert images into text, and also control other aspects of how text | |
3034 displays. These features are available starting in Emacs 21. The value | |
3035 of the @code{display} property should be a display specification, or a | |
3036 list or vector containing several display specifications. The rest of | |
3037 this section describes several kinds of display specifications and what | |
3038 they mean. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3039 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3040 @menu |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3041 * Specified Space:: Displaying one space with a specified width. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3042 * Pixel Specification:: Specifying space width or height in pixels. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3043 * Other Display Specs:: Displaying an image; magnifying text; moving it |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
3044 up or down on the page; adjusting the width |
25875 | 3045 of spaces within text. |
3046 * 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
|
3047 * Conditional Display:: Making any of the above features conditional |
25875 | 3048 depending on some Lisp expression. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3049 @end menu |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3050 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3051 @node Specified Space |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3052 @subsection Specified Spaces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3053 @cindex spaces, specified height or width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3054 @cindex specified spaces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3055 @cindex variable-width spaces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3056 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3057 To display a space of specified width and/or height, use a display |
25875 | 3058 specification of the form @code{(space . @var{props})}, where |
3059 @var{props} is a property list (a list of alternating properties and | |
3060 values). You can put this property on one or more consecutive | |
3061 characters; a space of the specified height and width is displayed in | |
3062 place of @emph{all} of those characters. These are the properties you | |
44281 | 3063 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
|
3064 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3065 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3066 @item :width @var{width} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3067 If @var{width} is an integer or floating point number, it specifies |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3068 that the space width should be @var{width} times the normal character |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3069 width. @var{width} can also be a @dfn{pixel width} specification |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3070 (@pxref{Pixel Specification}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3071 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3072 @item :relative-width @var{factor} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3073 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
|
3074 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
|
3075 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
|
3076 character, multiplied by @var{factor}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3077 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3078 @item :align-to @var{hpos} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3079 Specifies that the space should be wide enough to reach @var{hpos}. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3080 If @var{hpos} is a number, it is measured in units of the normal |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3081 character width. @var{hpos} can also be a @dfn{pixel width} |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3082 specification (@pxref{Pixel Specification}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3083 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3084 |
44281 | 3085 You should use one and only one of the above properties. You can |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3086 also specify the height of the space, with these properties: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3087 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3088 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3089 @item :height @var{height} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3090 Specifies the height of the space. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3091 If @var{height} is an integer or floating point number, it specifies |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3092 that the space height should be @var{height} times the normal character |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3093 height. The @var{height} may also be a @dfn{pixel height} specification |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3094 (@pxref{Pixel Specification}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3095 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3096 @item :relative-height @var{factor} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3097 Specifies the height of the space, multiplying the ordinary height |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3098 of the text having this display specification by @var{factor}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3099 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3100 @item :ascent @var{ascent} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3101 If the value of @var{ascent} is a non-negative number no greater than |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3102 100, it specifies that @var{ascent} percent of the height of the space |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3103 should be considered as the ascent of the space---that is, the part |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3104 above the baseline. The ascent may also be specified in pixel units |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3105 with a @dfn{pixel ascent} specification (@pxref{Pixel Specification}). |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3106 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3107 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3108 |
44281 | 3109 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
|
3110 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3111 The @code{:height} and @code{:align-to} properties are supported on |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3112 non-graphic terminals, but the other space properties in this section |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3113 are not. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3114 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3115 @node Pixel Specification |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3116 @subsection Pixel Specification for Spaces |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3117 @cindex spaces, pixel specification |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3118 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3119 The value of the @code{:width}, @code{:align-to}, @code{:height}, |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3120 and @code{:ascent} properties can be a special kind of expression that |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3121 is evaluated during redisplay. The result of the evaluation is used |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3122 as an absolute number of pixels. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3123 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3124 The following expressions are supported: |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3125 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3126 @example |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3127 @group |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
3128 @var{expr} ::= @var{num} | (@var{num}) | @var{unit} | @var{elem} | @var{pos} | @var{image} | @var{form} |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3129 @var{num} ::= @var{integer} | @var{float} | @var{symbol} |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3130 @var{unit} ::= in | mm | cm | width | height |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3131 @var{elem} ::= left-fringe | right-fringe | left-margin | right-margin |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3132 | scroll-bar | text |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3133 @var{pos} ::= left | center | right |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3134 @var{form} ::= (@var{num} . @var{expr}) | (@var{op} @var{expr} ...) |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3135 @var{op} ::= + | - |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3136 @end group |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3137 @end example |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3138 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3139 The form @var{num} specifies a fraction of the default frame font |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3140 height or width. The form @code{(@var{num})} specifies an absolute |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3141 number of pixels. If @var{num} is a symbol, @var{symbol}, its |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3142 buffer-local variable binding is used. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3143 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3144 The @code{in}, @code{mm}, and @code{cm} units specify the number of |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3145 pixels per inch, millimeter, and centimeter, respectively. The |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3146 @code{width} and @code{height} units correspond to the default width |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
3147 and height of the current face. An image specification @code{image} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3148 corresponds to the width or height of the image. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3149 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3150 The @code{left-fringe}, @code{right-fringe}, @code{left-margin}, |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3151 @code{right-margin}, @code{scroll-bar}, and @code{text} elements |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3152 specify to the width of the corresponding area of the window. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3153 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3154 The @code{left}, @code{center}, and @code{right} positions can be |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3155 used with @code{:align-to} to specify a position relative to the left |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3156 edge, center, or right edge of the text area. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3157 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3158 Any of the above window elements (except @code{text}) can also be |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3159 used with @code{:align-to} to specify that the position is relative to |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3160 the left edge of the given area. Once the base offset for a relative |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3161 position has been set (by the first occurrence of one of these |
57225 | 3162 symbols), further occurrences of these symbols are interpreted as the |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3163 width of the specified area. For example, to align to the center of |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3164 the left-margin, use |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3165 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3166 @example |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3167 :align-to (+ left-margin (0.5 . left-margin)) |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3168 @end example |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3169 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3170 If no specific base offset is set for alignment, it is always relative |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3171 to the left edge of the text area. For example, @samp{:align-to 0} in a |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3172 header-line aligns with the first text column in the text area. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3173 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3174 A value of the form @code{(@var{num} . @var{expr})} stands |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3175 multiplying the values of @var{num} and @var{expr}. For example, |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3176 @code{(2 . in)} specifies a width of 2 inches, while @code{(0.5 . |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
3177 @var{image})} specifies half the width (or height) of the specified image. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3178 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3179 The form @code{(+ @var{expr} ...)} adds up the value of the |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3180 expressions. The form @code{(- @var{expr} ...)} negates or subtracts |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3181 the value of the expressions. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3182 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3183 @node Other Display Specs |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3184 @subsection Other Display Specifications |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3185 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3186 Here are the other sorts of display specifications that you can use |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3187 in the @code{display} text property. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3188 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3189 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3190 @item (image . @var{image-props}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3191 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
|
3192 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
|
3193 that has the display specification. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3194 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3195 @item (slice @var{x} @var{y} @var{width} @var{height}) |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3196 This specification together with @code{image} specifies a @dfn{slice} |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3197 (a partial area) of the image to display. The elements @var{y} and |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3198 @var{x} specify the top left corner of the slice, within the image; |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3199 @var{width} and @var{height} specify the width and height of the |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3200 slice. Integer values are numbers of pixels. A floating point number |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3201 in the range 0.0--1.0 stands for that fraction of the width or height |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3202 of the entire image. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3203 |
32467 | 3204 @item ((margin nil) @var{string}) |
3205 @itemx @var{string} | |
3206 A display specification of this form means to display @var{string} | |
3207 instead of the text that has the display specification, at the same | |
3208 position as that text. This is a special case of marginal display | |
3209 (@pxref{Display Margins}). | |
3210 | |
44281 | 3211 Recursive display specifications are not supported---string display |
3212 specifications must not have @code{display} properties themselves. | |
36935 | 3213 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3214 @item (space-width @var{factor}) |
25875 | 3215 This display specification affects all the space characters within the |
3216 text that has the specification. It displays all of these spaces | |
3217 @var{factor} times as wide as normal. The element @var{factor} should | |
3218 be an integer or float. Characters other than spaces are not affected | |
3219 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
|
3220 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3221 @item (height @var{height}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3222 This display specification makes the text taller or shorter. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3223 Here are the possibilities for @var{height}: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3224 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3225 @table @asis |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3226 @item @code{(+ @var{n})} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3227 This means to use a font that is @var{n} steps larger. A ``step'' is |
25875 | 3228 defined by the set of available fonts---specifically, those that match |
3229 what was otherwise specified for this text, in all attributes except | |
3230 height. Each size for which a suitable font is available counts as | |
3231 another step. @var{n} should be an integer. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3232 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3233 @item @code{(- @var{n})} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3234 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
|
3235 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3236 @item a number, @var{factor} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3237 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
|
3238 as tall as the default font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3239 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3240 @item a symbol, @var{function} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3241 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
|
3242 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
|
3243 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3244 @item anything else, @var{form} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3245 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
|
3246 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
|
3247 @code{height} bound to the current specified font height. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3248 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3249 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3250 @item (raise @var{factor}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3251 This kind of display specification raises or lowers the text |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3252 it applies to, relative to the baseline of the line. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3253 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3254 @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
|
3255 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
|
3256 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
|
3257 lower down. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3258 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3259 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
|
3260 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
|
3261 faces used for the text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3262 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3263 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3264 @node Display Margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3265 @subsection Displaying in the Margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3266 @cindex display margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3267 @cindex margins, display |
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 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
|
3270 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
|
3271 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
|
3272 property. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3273 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3274 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
|
3275 display specification of the form @code{(margin right-margin)} or |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3276 @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
|
3277 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
|
3278 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
|
3279 text or images in the margin mouse-sensitive. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3280 |
42297
c4f9d48801a8
Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents:
42082
diff
changeset
|
3281 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
|
3282 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
|
3283 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
|
3284 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
|
3285 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
|
3286 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
|
3287 before-string. |
c4f9d48801a8
Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents:
42082
diff
changeset
|
3288 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3289 Before the display margins can display anything, you must give |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3290 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
|
3291 variables: |
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 @defvar left-margin-width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3294 @tindex left-margin-width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3295 This variable specifies the width of the left margin. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3296 It is buffer-local in all buffers. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3297 @end defvar |
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 @defvar right-margin-width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3300 @tindex right-margin-width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3301 This variable specifies the width of the right margin. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3302 It is buffer-local in all buffers. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3303 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3304 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3305 Setting these variables does not immediately affect the window. These |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3306 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
|
3307 Thus, you can make changes take effect by calling |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3308 @code{set-window-buffer}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3309 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3310 You can also set the margin widths immediately. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3311 |
36935 | 3312 @defun set-window-margins window left &optional right |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3313 @tindex set-window-margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3314 This function specifies the margin widths for window @var{window}. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
3315 The argument @var{left} controls the left margin and |
36935 | 3316 @var{right} controls the right margin (default @code{0}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3317 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3318 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3319 @defun window-margins &optional window |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3320 @tindex window-margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3321 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
|
3322 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
|
3323 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
|
3324 @end defun |
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 @node Conditional Display |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3327 @subsection Conditional Display Specifications |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3328 @cindex conditional display specifications |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3329 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3330 You can make any display specification conditional. To do that, |
29471 | 3331 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
|
3332 @var{spec})}. Then the specification @var{spec} applies only when |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3333 @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
|
3334 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
|
3335 conditional @code{display} property. @code{position} and |
ed864621a68e
Conditional Display): Adjust to API change.
Gerd Moellmann <gerd@gnu.org>
parents:
38278
diff
changeset
|
3336 @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
|
3337 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
|
3338 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
|
3339 string. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3340 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3341 @node Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3342 @section Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3343 @cindex images in buffers |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3344 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3345 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
|
3346 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
|
3347 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
|
3348 @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
|
3349 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3350 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
|
3351 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
|
3352 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
|
3353 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
|
3354 can be used to modify the set of known names for these dynamic |
57225 | 3355 libraries (though it is not possible to add new image formats). |
56109
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3356 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3357 The supported image formats include XBM, XPM (needing the |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3358 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
|
3359 @code{libungif} 4.1.0), Postscript, PBM, JPEG (needing the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3360 @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
|
3361 and PNG (needing @code{libpng} 1.0.2). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3362 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3363 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
|
3364 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
|
3365 @code{pbm}, @code{jpeg}, @code{tiff}, and @code{png}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3366 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3367 @defvar image-types |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3368 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
|
3369 potentially supported in the current configuration. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3370 @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
|
3371 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
|
3372 unavailable dynamic libraries, for example). |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3373 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3374 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
|
3375 @code{image-type-available-p}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3376 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3377 |
56109
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3378 @defvar image-library-alist |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3379 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
|
3380 display them. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3381 |
56437
bd1f1cbf959f
(Images): Fix Texinfo usage.
Juanma Barranquero <lekktu@gmail.com>
parents:
56233
diff
changeset
|
3382 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
|
3383 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
|
3384 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
|
3385 external libraries to load. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3386 |
56185
4f36c90f5404
(Images): Remove redundant @vindex directives.
Juanma Barranquero <lekktu@gmail.com>
parents:
56109
diff
changeset
|
3387 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
|
3388 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
|
3389 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
|
3390 they're always supported. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3391 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3392 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
|
3393 into Emacs. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3394 @end defvar |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3395 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3396 @defun image-type-available-p type |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3397 @findex image-type-available-p |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3398 |
56437
bd1f1cbf959f
(Images): Fix Texinfo usage.
Juanma Barranquero <lekktu@gmail.com>
parents:
56233
diff
changeset
|
3399 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
|
3400 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
|
3401 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
|
3402 @code{image-types}. |
56109
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3403 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3404 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
|
3405 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
|
3406 @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
|
3407 @end defun |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3408 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3409 @menu |
25875 | 3410 * Image Descriptors:: How to specify an image for use in @code{:display}. |
3411 * XBM Images:: Special features for XBM format. | |
3412 * XPM Images:: Special features for XPM format. | |
3413 * GIF Images:: Special features for GIF format. | |
3414 * Postscript Images:: Special features for Postscript format. | |
3415 * Other Image Types:: Various other formats are supported. | |
3416 * Defining Images:: Convenient ways to define an image for later use. | |
3417 * Showing Images:: Convenient ways to display an image once it is defined. | |
3418 * Image Cache:: Internal mechanisms of image display. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3419 @end menu |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3420 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3421 @node Image Descriptors |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3422 @subsection Image Descriptors |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3423 @cindex image descriptor |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3424 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3425 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
|
3426 . @var{props})}, where @var{props} is a property list containing |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3427 alternating keyword symbols (symbols whose names start with a colon) and |
26400 | 3428 their values. You can use any Lisp object as a property, but the only |
3429 properties that have any special meaning are certain symbols, all of | |
3430 them keywords. | |
3431 | |
3432 Every image descriptor must contain the property @code{:type | |
3433 @var{type}} to specify the format of the image. The value of @var{type} | |
3434 should be an image type symbol; for example, @code{xpm} for an image in | |
3435 XPM format. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3436 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3437 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
|
3438 types: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3439 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3440 @table @code |
36730
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3441 @item :file @var{file} |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3442 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
|
3443 @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
|
3444 in @code{data-directory}. |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3445 |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3446 @item :data @var{data} |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3447 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
|
3448 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
|
3449 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
|
3450 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
|
3451 |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3452 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
|
3453 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
|
3454 @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
|
3455 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
|
3456 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
|
3457 |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3458 @item :margin @var{margin} |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3459 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
|
3460 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
|
3461 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
|
3462 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
|
3463 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
|
3464 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
|
3465 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3466 @item :ascent @var{ascent} |
29151 | 3467 The @code{:ascent} property specifies the amount of the image's |
3468 height to use for its ascent---that is, the part above the baseline. | |
3469 The value, @var{ascent}, must be a number in the range 0 to 100, or | |
3470 the symbol @code{center}. | |
3471 | |
3472 If @var{ascent} is a number, that percentage of the image's height is | |
3473 used for its ascent. | |
3474 | |
3475 If @var{ascent} is @code{center}, the image is vertically centered | |
3476 around a centerline which would be the vertical centerline of text drawn | |
3477 at the position of the image, in the manner specified by the text | |
3478 properties and overlays that apply to the image. | |
3479 | |
3480 If this property is omitted, it defaults to 50. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3481 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3482 @item :relief @var{relief} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3483 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
|
3484 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
|
3485 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
|
3486 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
|
3487 an unpressed button. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3488 |
35364 | 3489 @item :conversion @var{algorithm} |
3490 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
|
3491 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
|
3492 displayed; the value, @var{algorithm}, specifies which algorithm. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3493 |
33996 | 3494 @table @code |
3495 @item laplace | |
3496 @itemx emboss | |
3497 Specifies the Laplace edge detection algorithm, which blurs out small | |
3498 differences in color while highlighting larger differences. People | |
3499 sometimes consider this useful for displaying the image for a | |
3500 ``disabled'' button. | |
3501 | |
3502 @item (edge-detection :matrix @var{matrix} :color-adjust @var{adjust}) | |
3503 Specifies a general edge-detection algorithm. @var{matrix} must be | |
3504 either a nine-element list or a nine-element vector of numbers. A pixel | |
3505 at position @math{x/y} in the transformed image is computed from | |
3506 original pixels around that position. @var{matrix} specifies, for each | |
3507 pixel in the neighborhood of @math{x/y}, a factor with which that pixel | |
3508 will influence the transformed pixel; element @math{0} specifies the | |
3509 factor for the pixel at @math{x-1/y-1}, element @math{1} the factor for | |
3510 the pixel at @math{x/y-1} etc., as shown below: | |
3511 @iftex | |
3512 @tex | |
3513 $$\pmatrix{x-1/y-1 & x/y-1 & x+1/y-1 \cr | |
3514 x-1/y & x/y & x+1/y \cr | |
3515 x-1/y+1& x/y+1 & x+1/y+1 \cr}$$ | |
3516 @end tex | |
3517 @end iftex | |
3518 @ifnottex | |
3519 @display | |
3520 (x-1/y-1 x/y-1 x+1/y-1 | |
3521 x-1/y x/y x+1/y | |
3522 x-1/y+1 x/y+1 x+1/y+1) | |
3523 @end display | |
3524 @end ifnottex | |
3525 | |
3526 The resulting pixel is computed from the color intensity of the color | |
3527 resulting from summing up the RGB values of surrounding pixels, | |
3528 multiplied by the specified factors, and dividing that sum by the sum | |
3529 of the factors' absolute values. | |
3530 | |
3531 Laplace edge-detection currently uses a matrix of | |
3532 @iftex | |
3533 @tex | |
3534 $$\pmatrix{1 & 0 & 0 \cr | |
3535 0& 0 & 0 \cr | |
3536 9 & 9 & -1 \cr}$$ | |
3537 @end tex | |
3538 @end iftex | |
3539 @ifnottex | |
3540 @display | |
3541 (1 0 0 | |
3542 0 0 0 | |
3543 9 9 -1) | |
3544 @end display | |
3545 @end ifnottex | |
3546 | |
3547 Emboss edge-detection uses a matrix of | |
3548 @iftex | |
3549 @tex | |
3550 $$\pmatrix{ 2 & -1 & 0 \cr | |
3551 -1 & 0 & 1 \cr | |
3552 0 & 1 & -2 \cr}$$ | |
3553 @end tex | |
3554 @end iftex | |
3555 @ifnottex | |
3556 @display | |
3557 ( 2 -1 0 | |
3558 -1 0 1 | |
3559 0 1 -2) | |
3560 @end display | |
3561 @end ifnottex | |
3562 | |
3563 @item disabled | |
3564 Specifies transforming the image so that it looks ``disabled''. | |
3565 @end table | |
3566 | |
3567 @item :mask @var{mask} | |
3568 If @var{mask} is @code{heuristic} or @code{(heuristic @var{bg})}, build | |
3569 a clipping mask for the image, so that the background of a frame is | |
3570 visible behind the image. If @var{bg} is not specified, or if @var{bg} | |
3571 is @code{t}, determine the background color of the image by looking at | |
3572 the four corners of the image, assuming the most frequently occurring | |
3573 color from the corners is the background color of the image. Otherwise, | |
3574 @var{bg} must be a list @code{(@var{red} @var{green} @var{blue})} | |
3575 specifying the color to assume for the background of the image. | |
3576 | |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
3577 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
|
3578 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
|
3579 specifying @code{:mask nil}. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3580 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3581 @item :pointer @var{shape} |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3582 This specifies the pointer shape when the mouse pointer is over this |
57225 | 3583 image. @xref{Pointer Shape}, for available pointer shapes. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3584 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3585 @item :map @var{map} |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3586 This associates an image map of @dfn{hot spots} with this image. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3587 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3588 An image map is an alist where each element has the format |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3589 @code{(@var{area} @var{id} @var{plist})}. An @var{area} is specified |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3590 as either a rectangle, a circle, or a polygon. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3591 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3592 A rectangle is a cons |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3593 @code{(rect . ((@var{x0} . @var{y0}) . (@var{x1} . @var{y1})))} |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3594 which specifies the pixel coordinates of the upper left and bottom right |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3595 corners of the rectangle area. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3596 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3597 A circle is a cons |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3598 @code{(circle . ((@var{x0} . @var{y0}) . @var{r}))} |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3599 which specifies the center and the radius of the circle; @var{r} may |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3600 be a float or integer. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3601 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3602 A polygon is a cons |
57201
2950fcfcfa44
Correct various typos.
Luc Teirlinck <teirllm@auburn.edu>
parents:
57193
diff
changeset
|
3603 @code{(poly . [@var{x0} @var{y0} @var{x1} @var{y1} ...])} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3604 where each pair in the vector describes one corner in the polygon. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3605 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3606 When the mouse pointer is above a hot-spot area of an image, the |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3607 @var{plist} of that hot-spot is consulted; if it contains a @code{help-echo} |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3608 property it defines a tool-tip for the hot-spot, and if it contains |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3609 a @code{pointer} property, it defines the shape of the mouse cursor when |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3610 it is over the hot-spot. |
57225 | 3611 @xref{Pointer Shape}, for available pointer shapes. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3612 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3613 When you click the mouse when the mouse pointer is over a hot-spot, an |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3614 event is composed by combining the @var{id} of the hot-spot with the |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3615 mouse event; for instance, @code{[area4 mouse-1]} if the hot-spot's |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3616 @var{id} is @code{area4}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3617 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3618 |
33996 | 3619 @defun image-mask-p spec &optional frame |
3620 @tindex image-mask-p | |
3621 This function returns @code{t} if image @var{spec} has a mask bitmap. | |
3622 @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
|
3623 @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
|
3624 (@pxref{Input Focus}). |
33996 | 3625 @end defun |
3626 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3627 @node XBM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3628 @subsection XBM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3629 @cindex XBM |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3630 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3631 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
|
3632 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
|
3633 always supported. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3634 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3635 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
|
3636 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3637 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3638 @item :foreground @var{foreground} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3639 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
|
3640 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
|
3641 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
|
3642 foreground color. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3643 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3644 @item :background @var{background} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3645 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
|
3646 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
|
3647 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
|
3648 background color. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3649 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3650 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3651 If you specify an XBM image using data within Emacs instead of an |
28792 | 3652 external file, use the following three properties: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3653 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3654 @table @code |
28792 | 3655 @item :data @var{data} |
3656 The value, @var{data}, specifies the contents of the image. | |
3657 There are three formats you can use for @var{data}: | |
3658 | |
3659 @itemize @bullet | |
3660 @item | |
3661 A vector of strings or bool-vectors, each specifying one line of the | |
3662 image. Do specify @code{:height} and @code{:width}. | |
3663 | |
3664 @item | |
3665 A string containing the same byte sequence as an XBM file would contain. | |
3666 You must not specify @code{:height} and @code{:width} in this case, | |
3667 because omitting them is what indicates the data has the format of an | |
3668 XBM file. The file contents specify the height and width of the image. | |
3669 | |
3670 @item | |
3671 A string or a bool-vector containing the bits of the image (plus perhaps | |
3672 some extra bits at the end that will not be used). It should contain at | |
3673 least @var{width} * @code{height} bits. In this case, you must specify | |
3674 @code{:height} and @code{:width}, both to indicate that the string | |
3675 contains just the bits rather than a whole XBM file, and to specify the | |
3676 size of the image. | |
3677 @end itemize | |
3678 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3679 @item :width @var{width} |
28792 | 3680 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
|
3681 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3682 @item :height @var{height} |
28792 | 3683 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
|
3684 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3685 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3686 @node XPM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3687 @subsection XPM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3688 @cindex XPM |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3689 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3690 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
|
3691 additional image property @code{:color-symbols} is also meaningful with |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3692 the @code{xpm} image type: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3693 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3694 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3695 @item :color-symbols @var{symbols} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3696 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
|
3697 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
|
3698 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
|
3699 specifies the actual color to use for displaying that name. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3700 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3701 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3702 @node GIF Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3703 @subsection GIF Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3704 @cindex GIF |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3705 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3706 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
|
3707 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
|
3708 a problem for the whole Internet; to end this problem, it is a good idea |
56020 | 3709 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
|
3710 (@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
|
3711 them, Emacs can display them. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3712 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3713 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3714 @item :index @var{index} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3715 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
|
3716 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
|
3717 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
|
3718 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
|
3719 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3720 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3721 @ignore |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3722 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
|
3723 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
|
3724 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
|
3725 every 0.1 seconds. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3726 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3727 (defun show-anim (file max) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3728 "Display multi-image GIF file FILE which contains MAX subimages." |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3729 (display-anim (current-buffer) file 0 max t)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3730 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3731 (defun display-anim (buffer file idx max first-time) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3732 (when (= idx max) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3733 (setq idx 0)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3734 (let ((img (create-image file nil :image idx))) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3735 (save-excursion |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3736 (set-buffer buffer) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3737 (goto-char (point-min)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3738 (unless first-time (delete-char 1)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3739 (insert-image img)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3740 (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
|
3741 @end ignore |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3742 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3743 @node Postscript Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3744 @subsection Postscript Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3745 @cindex Postscript images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3746 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3747 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
|
3748 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
|
3749 these three properties: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3750 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3751 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3752 @item :pt-width @var{width} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3753 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
|
3754 points (1/72 inch). @var{width} must be an integer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3755 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3756 @item :pt-height @var{height} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3757 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
|
3758 (1/72 inch). @var{height} must be an integer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3759 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3760 @item :bounding-box @var{box} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3761 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
|
3762 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
|
3763 @samp{BoundingBox} comment found in Postscript files. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3764 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3765 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3766 %%BoundingBox: 22 171 567 738 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3767 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3768 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3769 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3770 Displaying Postscript images from Lisp data is not currently |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3771 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
|
3772 See the @file{etc/NEWS} file to make sure. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3773 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3774 @node Other Image Types |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3775 @subsection Other Image Types |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3776 @cindex PBM |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3777 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3778 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
|
3779 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
|
3780 image properties are supported. |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3781 |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3782 @table @code |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3783 @item :foreground @var{foreground} |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3784 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
|
3785 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
|
3786 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
|
3787 foreground color. |
32552
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3788 |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3789 @item :background @var{background} |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3790 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
|
3791 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
|
3792 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
|
3793 background color. |
32552
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3794 @end table |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3795 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3796 For JPEG images, specify image type @code{jpeg}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3797 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3798 For TIFF images, specify image type @code{tiff}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3799 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3800 For PNG images, specify image type @code{png}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3801 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3802 @node Defining Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3803 @subsection Defining Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3804 |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3805 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
|
3806 @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
|
3807 |
59574
9ce057395159
(Defining Images): Mention DATA-P arg of create-image.
Richard M. Stallman <rms@gnu.org>
parents:
59505
diff
changeset
|
3808 @defun create-image file-or-data &optional type data-p &rest props |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3809 @tindex create-image |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3810 This function creates and returns an image descriptor which uses the |
59574
9ce057395159
(Defining Images): Mention DATA-P arg of create-image.
Richard M. Stallman <rms@gnu.org>
parents:
59505
diff
changeset
|
3811 data in @var{file-or-data}. @var{file-or-data} can be a file name or |
9ce057395159
(Defining Images): Mention DATA-P arg of create-image.
Richard M. Stallman <rms@gnu.org>
parents:
59505
diff
changeset
|
3812 a string containing the image data; @var{data-p} should be @code{nil} |
9ce057395159
(Defining Images): Mention DATA-P arg of create-image.
Richard M. Stallman <rms@gnu.org>
parents:
59505
diff
changeset
|
3813 for the former case, non-@code{nil} for the latter case. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3814 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3815 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
|
3816 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
|
3817 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
|
3818 from the file's name. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3819 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3820 The remaining arguments, @var{props}, specify additional image |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3821 properties---for example, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3822 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3823 @example |
59574
9ce057395159
(Defining Images): Mention DATA-P arg of create-image.
Richard M. Stallman <rms@gnu.org>
parents:
59505
diff
changeset
|
3824 (create-image "foo.xpm" 'xpm nil :heuristic-mask t) |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3825 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3826 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3827 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
|
3828 supported. Otherwise it returns an image descriptor. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3829 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3830 |
41058
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3831 @defmac defimage symbol specs &optional doc |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3832 @tindex defimage |
41058
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3833 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
|
3834 @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
|
3835 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
|
3836 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3837 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
|
3838 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
|
3839 @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
|
3840 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
|
3841 @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
|
3842 @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
|
3843 example: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3844 |
25875 | 3845 @example |
3846 (defimage test-image | |
46338
6cf0fbc1d7da
defimage does not evaluate SPECS.
Richard M. Stallman <rms@gnu.org>
parents:
46245
diff
changeset
|
3847 ((:type xpm :file "~/test1.xpm") |
6cf0fbc1d7da
defimage does not evaluate SPECS.
Richard M. Stallman <rms@gnu.org>
parents:
46245
diff
changeset
|
3848 (:type xbm :file "~/test1.xbm"))) |
25875 | 3849 @end example |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3850 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3851 @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
|
3852 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
|
3853 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
|
3854 stored in @var{symbol}. |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3855 |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3856 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
|
3857 as @code{nil}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3858 @end defmac |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3859 |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3860 @defun find-image specs |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3861 @tindex find-image |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3862 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
|
3863 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
|
3864 |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3865 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
|
3866 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
|
3867 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
|
3868 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
|
3869 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
|
3870 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
|
3871 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
|
3872 @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
|
3873 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
|
3874 |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3875 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
|
3876 @code{data-directory}. |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3877 @end defun |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3878 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3879 @node Showing Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3880 @subsection Showing Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3881 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3882 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
|
3883 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
|
3884 section. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3885 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3886 @defun insert-image image &optional string area slice |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3887 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
|
3888 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
|
3889 returned by @code{create-image}, or the value of a symbol defined with |
25875 | 3890 @code{defimage}. The argument @var{string} specifies the text to put in |
3891 the buffer to hold the image. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3892 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3893 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
|
3894 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
|
3895 @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
|
3896 @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
|
3897 buffer's text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3898 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3899 The argument @var{slice} specifies a slice of the image to insert. If |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3900 @var{slice} is @code{nil} or omitted the whole image is inserted. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3901 Otherwise, @var{slice} is a list @code{(@var{x} @var{y} @var{width} |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3902 @var{height})} which specifies the @var{x} and @var{y} positions and |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3903 @var{width} and @var{height} of the image area to insert. Integer |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3904 values are in units of pixels. A floating point number in the range |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3905 0.0--1.0 stands for that fraction of the width or height of the entire |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3906 image. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3907 |
25875 | 3908 Internally, this function inserts @var{string} in the buffer, and gives |
3909 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
|
3910 Property}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3911 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3912 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3913 @defun insert-sliced-image image &optional string area rows cols |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3914 This function inserts @var{image} in the current buffer at point, like |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3915 @code{insert-image}, but splits the image into @var{rows}x@var{cols} |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3916 equally sized slices. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3917 @end defun |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3918 |
29471 | 3919 @defun put-image image pos &optional string area |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3920 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
|
3921 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
|
3922 marker. It specifies the buffer position where the image should appear. |
29471 | 3923 The argument @var{string} specifies the text that should hold the image |
3924 as an alternative to the default. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3925 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3926 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
|
3927 by @code{create-image} or stored by @code{defimage}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3928 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3929 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
|
3930 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
|
3931 @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
|
3932 @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
|
3933 buffer's text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3934 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3935 Internally, this function creates an overlay, and gives it a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3936 @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
|
3937 property whose value is the image. (Whew!) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3938 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3939 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3940 @defun remove-images start end &optional buffer |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3941 This function removes images in @var{buffer} between positions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3942 @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
|
3943 images are removed from the current buffer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3944 |
27331
be0a552c8320
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
3945 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
|
3946 @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
|
3947 @code{insert-image} or in other ways. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3948 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3949 |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3950 @defun image-size spec &optional pixels frame |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3951 @tindex image-size |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3952 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
|
3953 @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
|
3954 specification. @var{pixels} non-@code{nil} means return sizes |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
3955 measured in pixels, otherwise return sizes measured in canonical |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
3956 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
|
3957 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
|
3958 @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
|
3959 Focus}). |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3960 @end defun |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3961 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3962 @node Image Cache |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3963 @subsection Image Cache |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3964 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3965 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
|
3966 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
|
3967 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
|
3968 |
28770 | 3969 When an image is looked up in the cache, its specification is compared |
3970 with cached image specifications using @code{equal}. This means that | |
3971 all images with equal specifications share the same image in the cache. | |
3972 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3973 @defvar image-cache-eviction-delay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3974 @tindex image-cache-eviction-delay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3975 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
|
3976 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
|
3977 length of time, Emacs removes it from the image cache. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3978 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3979 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
|
3980 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
|
3981 debugging. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3982 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3983 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3984 @defun clear-image-cache &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3985 @tindex clear-image-cache |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3986 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
|
3987 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
|
3988 are cleared. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3989 @end defun |
27447
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
3990 |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3991 @node Buttons |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3992 @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
|
3993 @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
|
3994 @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
|
3995 @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
|
3996 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3997 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
|
3998 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
|
3999 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
|
4000 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
|
4001 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4002 A button is essentially a set of properties attached (via text |
55246 | 4003 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
|
4004 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
|
4005 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4006 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
|
4007 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
|
4008 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
|
4009 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
|
4010 |
55246 | 4011 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
|
4012 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
|
4013 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
|
4014 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
|
4015 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
|
4016 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
|
4017 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
|
4018 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
|
4019 entries). |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4020 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4021 @menu |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4022 * 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
|
4023 * Button Types:: Defining common properties for classes of buttons. |
55246 | 4024 * 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
|
4025 * 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
|
4026 * Button Buffer Commands:: Buffer-wide commands and bindings for buttons. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
4027 * Manipulating Button Types:: |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4028 @end menu |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4029 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4030 @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
|
4031 @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
|
4032 @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
|
4033 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4034 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
|
4035 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
|
4036 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
|
4037 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4038 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
|
4039 include: |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4040 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4041 @table @code |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4042 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4043 @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
|
4044 @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
|
4045 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
|
4046 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
|
4047 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
|
4048 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4049 @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
|
4050 @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
|
4051 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
|
4052 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
|
4053 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
|
4054 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
|
4055 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4056 @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
|
4057 @kindex face @r{(button property)} |
55246 | 4058 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
|
4059 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
|
4060 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4061 @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
|
4062 @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
|
4063 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
|
4064 mouse-overs (merged with the usual button face); by default this is |
55246 | 4065 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
|
4066 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4067 @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
|
4068 @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
|
4069 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
|
4070 region. By default this is the usual button region keymap, stored |
59505
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4071 in the variable @code{button-map}, which defines @key{RET} and |
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4072 @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
|
4073 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4074 @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
|
4075 @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
|
4076 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
|
4077 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
|
4078 @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
|
4079 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4080 @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
|
4081 @kindex help-index @r{(button property)} |
55246 | 4082 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
|
4083 @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
|
4084 |
59467
9c3931bf6cd0
(Button Properties): Add follow-link keyword.
Kim F. Storm <storm@cua.dk>
parents:
59463
diff
changeset
|
4085 @item follow-link |
9c3931bf6cd0
(Button Properties): Add follow-link keyword.
Kim F. Storm <storm@cua.dk>
parents:
59463
diff
changeset
|
4086 @kindex follow-link @r{(button property)} |
59505
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4087 The follow-link property, defining how a @key{Mouse-1} click behaves |
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4088 on this button, @xref{Links and Mouse-1}. |
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4089 |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4090 @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
|
4091 @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
|
4092 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
|
4093 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
|
4094 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
|
4095 @end table |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4096 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4097 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
|
4098 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
|
4099 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4100 @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
|
4101 @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
|
4102 @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
|
4103 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4104 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
|
4105 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
|
4106 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
|
4107 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
|
4108 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
|
4109 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4110 @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
|
4111 @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
|
4112 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
|
4113 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
|
4114 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
|
4115 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
|
4116 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
|
4117 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4118 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
|
4119 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
|
4120 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
|
4121 @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
|
4122 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
|
4123 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4124 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4125 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
|
4126 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
|
4127 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
|
4128 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
|
4129 |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
4130 @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
|
4131 @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
|
4132 @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
|
4133 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4134 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
|
4135 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
|
4136 initialized from the button's type (which defaults to the built-in |
55246 | 4137 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
|
4138 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
|
4139 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
|
4140 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
|
4141 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4142 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
|
4143 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
|
4144 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
|
4145 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
|
4146 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4147 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
|
4148 @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
|
4149 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
|
4150 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
|
4151 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
|
4152 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
|
4153 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
|
4154 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
|
4155 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4156 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
|
4157 (@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
|
4158 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4159 @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
|
4160 @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
|
4161 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
|
4162 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4163 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4164 @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
|
4165 @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
|
4166 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
|
4167 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4168 |
55246 | 4169 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
|
4170 (@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
|
4171 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
|
4172 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
|
4173 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
|
4174 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4175 @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
|
4176 @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
|
4177 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
|
4178 text-properties. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4179 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4180 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4181 @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
|
4182 @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
|
4183 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
|
4184 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4185 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4186 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
|
4187 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
|
4188 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
|
4189 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4190 @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
|
4191 @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
|
4192 @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
|
4193 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4194 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
|
4195 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
|
4196 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
|
4197 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4198 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
|
4199 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
|
4200 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
|
4201 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
|
4202 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
|
4203 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4204 @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
|
4205 @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
|
4206 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
|
4207 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4208 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4209 @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
|
4210 @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
|
4211 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
|
4212 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4213 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4214 @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
|
4215 @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
|
4216 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
|
4217 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4218 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4219 @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
|
4220 @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
|
4221 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
|
4222 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4223 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4224 @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
|
4225 @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
|
4226 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
|
4227 @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
|
4228 @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
|
4229 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
|
4230 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4231 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4232 @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
|
4233 @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
|
4234 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
|
4235 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4236 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4237 @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
|
4238 @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
|
4239 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
|
4240 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4241 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4242 @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
|
4243 @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
|
4244 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
|
4245 @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
|
4246 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4247 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4248 @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
|
4249 @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
|
4250 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
|
4251 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4252 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4253 @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
|
4254 @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
|
4255 @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
|
4256 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4257 These are commands and functions for locating and operating on |
55246 | 4258 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
|
4259 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4260 @code{push-button} is the command that a user uses to actually `push' |
59505
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4261 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
|
4262 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
|
4263 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
|
4264 @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
|
4265 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
|
4266 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
|
4267 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
|
4268 |
59505
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4269 If the button has a non-@code{nil} @code{follow-link} property, and |
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4270 @var{mouse-1-click-follows-link} is set, a @key{Mouse-1} click will |
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4271 also activate the @code{push-button} command. |
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4272 |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4273 @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
|
4274 @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
|
4275 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
|
4276 @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
|
4277 @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
|
4278 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
|
4279 @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
|
4280 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
|
4281 @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
|
4282 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
|
4283 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
|
4284 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
|
4285 @end deffn |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4286 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4287 @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
|
4288 @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
|
4289 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
|
4290 @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
|
4291 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
|
4292 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
|
4293 @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
|
4294 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
|
4295 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
|
4296 @end deffn |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4297 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4298 @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
|
4299 @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
|
4300 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
|
4301 @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
|
4302 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
|
4303 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
|
4304 @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
|
4305 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
|
4306 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
|
4307 @end deffn |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4308 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4309 @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
|
4310 @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
|
4311 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
|
4312 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
|
4313 @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
|
4314 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4315 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4316 @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
|
4317 @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
|
4318 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
|
4319 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
|
4320 @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
|
4321 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4322 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4323 @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
|
4324 @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
|
4325 @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
|
4326 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4327 @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
|
4328 @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
|
4329 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
|
4330 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4331 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4332 @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
|
4333 @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
|
4334 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
|
4335 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4336 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4337 @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
|
4338 @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
|
4339 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
|
4340 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4341 |
6598 | 4342 @node Blinking |
4343 @section Blinking Parentheses | |
4344 @cindex parenthesis matching | |
4345 @cindex blinking | |
4346 @cindex balancing parentheses | |
4347 @cindex close parenthesis | |
4348 | |
4349 This section describes the mechanism by which Emacs shows a matching | |
4350 open parenthesis when the user inserts a close parenthesis. | |
4351 | |
4352 @defvar blink-paren-function | |
4353 The value of this variable should be a function (of no arguments) to | |
4354 be called whenever a character with close parenthesis syntax is inserted. | |
4355 The value of @code{blink-paren-function} may be @code{nil}, in which | |
4356 case nothing is done. | |
4357 @end defvar | |
4358 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4359 @defopt blink-matching-paren |
6598 | 4360 If this variable is @code{nil}, then @code{blink-matching-open} does |
4361 nothing. | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4362 @end defopt |
6598 | 4363 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4364 @defopt blink-matching-paren-distance |
6598 | 4365 This variable specifies the maximum distance to scan for a matching |
4366 parenthesis before giving up. | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4367 @end defopt |
6598 | 4368 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4369 @defopt blink-matching-delay |
12098 | 4370 This variable specifies the number of seconds for the cursor to remain |
4371 at the matching parenthesis. A fraction of a second often gives | |
4372 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
|
4373 @end defopt |
12098 | 4374 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4375 @deffn Command blink-matching-open |
6598 | 4376 This function is the default value of @code{blink-paren-function}. It |
4377 assumes that point follows a character with close parenthesis syntax and | |
4378 moves the cursor momentarily to the matching opening character. If that | |
4379 character is not already on the screen, it displays the character's | |
4380 context in the echo area. To avoid long delays, this function does not | |
4381 search farther than @code{blink-matching-paren-distance} characters. | |
4382 | |
4383 Here is an example of calling this function explicitly. | |
4384 | |
4385 @smallexample | |
4386 @group | |
4387 (defun interactive-blink-matching-open () | |
4388 @c Do not break this line! -- rms. | |
4389 @c The first line of a doc string | |
4390 @c must stand alone. | |
4391 "Indicate momentarily the start of sexp before point." | |
4392 (interactive) | |
4393 @end group | |
4394 @group | |
4395 (let ((blink-matching-paren-distance | |
4396 (buffer-size)) | |
4397 (blink-matching-paren t)) | |
4398 (blink-matching-open))) | |
4399 @end group | |
4400 @end smallexample | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4401 @end deffn |
6598 | 4402 |
4403 @node Inverse Video | |
4404 @section Inverse Video | |
4405 @cindex Inverse Video | |
4406 | |
4407 @defopt inverse-video | |
4408 @cindex highlighting | |
4409 This variable controls whether Emacs uses inverse video for all text | |
4410 on the screen. Non-@code{nil} means yes, @code{nil} means no. The | |
4411 default is @code{nil}. | |
4412 @end defopt | |
4413 | |
4414 @defopt mode-line-inverse-video | |
25875 | 4415 This variable controls the use of inverse video for mode lines and menu |
4416 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
|
4417 inverse video. Otherwise, these lines are displayed normally, just like |
25875 | 4418 other text. The default is @code{t}. |
4419 | |
4420 For window frames, this feature actually applies the face named | |
4421 @code{mode-line}; that face is normally set up as the inverse of the | |
4422 default face, unless you change it. | |
6598 | 4423 @end defopt |
4424 | |
4425 @node Usual Display | |
4426 @section Usual Display Conventions | |
4427 | |
4428 The usual display conventions define how to display each character | |
4429 code. You can override these conventions by setting up a display table | |
4430 (@pxref{Display Tables}). Here are the usual display conventions: | |
4431 | |
4432 @itemize @bullet | |
4433 @item | |
4434 Character codes 32 through 126 map to glyph codes 32 through 126. | |
4435 Normally this means they display as themselves. | |
4436 | |
4437 @item | |
4438 Character code 9 is a horizontal tab. It displays as whitespace | |
4439 up to a position determined by @code{tab-width}. | |
4440 | |
4441 @item | |
4442 Character code 10 is a newline. | |
4443 | |
4444 @item | |
4445 All other codes in the range 0 through 31, and code 127, display in one | |
9009 | 4446 of two ways according to the value of @code{ctl-arrow}. If it is |
6598 | 4447 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
|
4448 first glyph is the @acronym{ASCII} code for @samp{^}. (A display table can |
6598 | 4449 specify a glyph to use instead of @samp{^}.) Otherwise, these codes map |
4450 just like the codes in the range 128 to 255. | |
4451 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4452 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
|
4453 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
|
4454 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
|
4455 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
|
4456 emacs, The GNU Emacs Manual}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4457 |
6598 | 4458 @item |
4459 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
|
4460 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
|
4461 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
|
4462 table can specify a glyph to use instead of @samp{\}.) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4463 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4464 @item |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4465 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
|
4466 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
|
4467 character. |
6598 | 4468 @end itemize |
4469 | |
4470 The usual display conventions apply even when there is a display | |
4471 table, for any character whose entry in the active display table is | |
4472 @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
|
4473 specify the characters for which you want special behavior. |
6598 | 4474 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
4475 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
|
4476 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
|
4477 buffer where you expect it, if it was eliminated as part of end-of-line |
25454 | 4478 conversion (@pxref{Coding System Basics}). |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
4479 |
6598 | 4480 These variables affect the way certain characters are displayed on the |
4481 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
|
4482 they also affect the indentation functions. These variables also affect |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4483 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
|
4484 mode line using the new values, call the function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4485 @code{force-mode-line-update} (@pxref{Mode Line Format}). |
6598 | 4486 |
4487 @defopt ctl-arrow | |
4488 @cindex control characters in display | |
4489 This buffer-local variable controls how control characters are | |
4490 displayed. If it is non-@code{nil}, they are displayed as a caret | |
4491 followed by the character: @samp{^A}. If it is @code{nil}, they are | |
4492 displayed as a backslash followed by three octal digits: @samp{\001}. | |
4493 @end defopt | |
4494 | |
4495 @c Following may have overfull hbox. | |
4496 @defvar default-ctl-arrow | |
4497 The value of this variable is the default value for @code{ctl-arrow} in | |
4498 buffers that do not override it. @xref{Default Value}. | |
4499 @end defvar | |
4500 | |
58496
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4501 @defopt tab-width |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4502 The value of this variable is the spacing between tab stops used for |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4503 displaying tab characters in Emacs buffers. The value is in units of |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4504 columns, and the default is 8. Note that this feature is completely |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4505 independent of the user-settable tab stops used by the command |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4506 @code{tab-to-tab-stop}. @xref{Indent Tabs}. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4507 @end defopt |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4508 |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
4509 @defopt indicate-empty-lines |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
4510 @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
|
4511 @cindex fringes, and empty line indication |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
4512 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
|
4513 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
|
4514 support it (window systems). @xref{Fringes}. |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
4515 @end defopt |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
4516 |
58496
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4517 @defvar indicate-buffer-boundaries |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4518 This buffer-local variable controls how the buffer boundaries and |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4519 window scrolling are indicated in the window fringes. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4520 |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4521 Emacs can indicate the buffer boundaries---that is, the first and last |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4522 line in the buffer---with angle icons when they appear on the screen. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4523 In addition, Emacs can display an up-arrow in the fringe to show |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4524 that there is text above the screen, and a down-arrow to show |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4525 there is text below the screen. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4526 |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4527 There are four kinds of basic values: |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4528 |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4529 @table @asis |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4530 @item @code{nil} |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4531 Don't display the icons. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4532 @item @code{left} |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4533 Display them in the left fringe. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4534 @item @code{right} |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4535 Display them in the right fringe. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4536 @item @var{anything-else} |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4537 Display the icon at the top of the window top in the left fringe, and other |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4538 in the right fringe. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4539 @end table |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4540 |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4541 If value is a cons @code{(@var{angles} . @var{arrows})}, @var{angles} |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4542 controls the angle icons, and @var{arrows} controls the arrows. Both |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4543 @var{angles} and @var{arrows} work according to the table above. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4544 Thus, @code{(t . right)} places the top angle icon in the left |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4545 fringe, the bottom angle icon in the right fringe, and both arrows in |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4546 the right fringe. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4547 @end defvar |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4548 |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4549 @defvar default-indicate-buffer-boundaries |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4550 The value of this variable is the default value for |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4551 @code{indicate-buffer-boundaries} in buffers that do not override it. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4552 @end defvar |
6598 | 4553 |
4554 @node Display Tables | |
4555 @section Display Tables | |
4556 | |
4557 @cindex display table | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4558 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
|
4559 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
|
4560 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
|
4561 set. |
6598 | 4562 |
4563 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
|
4564 @dfn{glyphs}, each glyph being a graphic that takes up one character |
6598 | 4565 position on the screen. You can also define how to display each glyph |
4566 on your terminal, using the @dfn{glyph table}. | |
4567 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4568 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
|
4569 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
|
4570 @code{force-mode-line-update} (@pxref{Mode Line Format}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4571 |
6598 | 4572 @menu |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4573 * 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
|
4574 * 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
|
4575 * Glyphs:: How to define a glyph, and what glyphs mean. |
6598 | 4576 @end menu |
4577 | |
4578 @node Display Table Format | |
4579 @subsection Display Table Format | |
4580 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4581 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
|
4582 @code{display-table} as its subtype. |
6598 | 4583 |
4584 @defun make-display-table | |
4585 This creates and returns a display table. The table initially has | |
4586 @code{nil} in all elements. | |
4587 @end defun | |
4588 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4589 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
|
4590 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
|
4591 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
|
4592 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
|
4593 display that character according to the usual display conventions |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4594 (@pxref{Usual Display}). |
12067 | 4595 |
4596 If you use the display table to change the display of newline | |
4597 characters, the whole buffer will be displayed as one long ``line.'' | |
6598 | 4598 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4599 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
|
4600 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
|
4601 means to use the default for that slot, as stated below. |
6598 | 4602 |
4603 @table @asis | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4604 @item 0 |
6598 | 4605 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
|
4606 is @samp{$}). @xref{Glyphs}. Newer Emacs versions, on some platforms, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4607 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
|
4608 in these situations. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4609 @item 1 |
6598 | 4610 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
|
4611 Newer Emacs versions, on some platforms, display curved arrows to |
58371
656195249167
(Display Table Format): Minor fix.
Richard M. Stallman <rms@gnu.org>
parents:
57389
diff
changeset
|
4612 indicate continuation---the display table has no effect in these |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4613 situations. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4614 @item 2 |
6598 | 4615 The glyph for indicating a character displayed as an octal character |
4616 code (the default is @samp{\}). | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4617 @item 3 |
6598 | 4618 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
|
4619 @item 4 |
6598 | 4620 A vector of glyphs for indicating the presence of invisible lines (the |
4621 default is @samp{...}). @xref{Selective Display}. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4622 @item 5 |
8925 | 4623 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
|
4624 default is @samp{|}). @xref{Splitting Windows}. This takes effect only |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4625 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
|
4626 a scroll bar separates the two windows. |
6598 | 4627 @end table |
4628 | |
4629 For example, here is how to construct a display table that mimics the | |
4630 effect of setting @code{ctl-arrow} to a non-@code{nil} value: | |
4631 | |
4632 @example | |
4633 (setq disptab (make-display-table)) | |
4634 (let ((i 0)) | |
4635 (while (< i 32) | |
4636 (or (= i ?\t) (= i ?\n) | |
4637 (aset disptab i (vector ?^ (+ i 64)))) | |
4638 (setq i (1+ i))) | |
4639 (aset disptab 127 (vector ?^ ??))) | |
4640 @end example | |
4641 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4642 @defun display-table-slot display-table slot |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4643 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
|
4644 @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
|
4645 5 inclusive, or a slot name (symbol). Valid symbols are |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4646 @code{truncation}, @code{wrap}, @code{escape}, @code{control}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4647 @code{selective-display}, and @code{vertical-border}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4648 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4649 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4650 @defun set-display-table-slot display-table slot value |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4651 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
|
4652 @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
|
4653 5 inclusive, or a slot name (symbol). Valid symbols are |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4654 @code{truncation}, @code{wrap}, @code{escape}, @code{control}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4655 @code{selective-display}, and @code{vertical-border}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4656 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4657 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4658 @defun describe-display-table display-table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4659 @tindex describe-display-table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4660 This function displays a description of the display table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4661 @var{display-table} in a help buffer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4662 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4663 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4664 @deffn Command describe-current-display-table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4665 @tindex describe-current-display-table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4666 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
|
4667 help buffer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4668 @end deffn |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4669 |
6598 | 4670 @node Active Display Table |
4671 @subsection Active Display Table | |
4672 @cindex active display table | |
4673 | |
4674 Each window can specify a display table, and so can each buffer. When | |
4675 a buffer @var{b} is displayed in window @var{w}, display uses the | |
4676 display table for window @var{w} if it has one; otherwise, the display | |
4677 table for buffer @var{b} if it has one; otherwise, the standard display | |
4678 table if any. The display table chosen is called the @dfn{active} | |
4679 display table. | |
4680 | |
4681 @defun window-display-table window | |
4682 This function returns @var{window}'s display table, or @code{nil} | |
4683 if @var{window} does not have an assigned display table. | |
4684 @end defun | |
4685 | |
4686 @defun set-window-display-table window table | |
4687 This function sets the display table of @var{window} to @var{table}. | |
4688 The argument @var{table} should be either a display table or | |
4689 @code{nil}. | |
4690 @end defun | |
4691 | |
4692 @defvar buffer-display-table | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4693 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
|
4694 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
|
4695 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
|
4696 table. |
6598 | 4697 @end defvar |
4698 | |
4699 @defvar standard-display-table | |
4700 This variable's value is the default display table, used whenever a | |
4701 window has no display table and neither does the buffer displayed in | |
4702 that window. This variable is @code{nil} by default. | |
4703 @end defvar | |
4704 | |
4705 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
|
4706 if the window specifies none, its buffer specifies none, and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4707 @code{standard-display-table} is @code{nil}---then Emacs uses the usual |
6598 | 4708 display conventions for all character codes in that window. @xref{Usual |
4709 Display}. | |
4710 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4711 A number of functions for changing the standard display table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4712 are defined in the library @file{disp-table}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4713 |
6598 | 4714 @node Glyphs |
4715 @subsection Glyphs | |
4716 | |
4717 @cindex glyph | |
4718 A @dfn{glyph} is a generalization of a character; it stands for an | |
4719 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
|
4720 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
|
4721 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
|
4722 |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4723 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
|
4724 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
|
4725 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
|
4726 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
|
4727 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
|
4728 outputting it. (524288 is |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4729 @ifnottex |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4730 2**19.) |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4731 @end ifnottex |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4732 @tex |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4733 $2^{19}$.) |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4734 @end tex |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4735 @xref{Faces}. |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4736 |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4737 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
|
4738 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
|
4739 variable @code{glyph-table}. |
6598 | 4740 |
4741 @defvar glyph-table | |
4742 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
|
4743 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
|
4744 |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4745 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
|
4746 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
|
4747 @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
|
4748 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
|
4749 on character terminals. On graphical displays, all glyphs are simple. |
6598 | 4750 @end defvar |
4751 | |
4752 Here are the possible types of elements in the glyph table: | |
4753 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4754 @table @asis |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4755 @item @var{string} |
6598 | 4756 Send the characters in @var{string} to the terminal to output |
4757 this glyph. This alternative is available on character terminals, | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4758 but not under a window system. |
6598 | 4759 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4760 @item @var{integer} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4761 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
|
4762 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
|
4763 number as its code. |
6598 | 4764 |
4765 @item @code{nil} | |
47482
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4766 This glyph is simple. |
6598 | 4767 @end table |
4768 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4769 @defun create-glyph string |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4770 @tindex create-glyph |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4771 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
|
4772 display by sending @var{string} to the terminal. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4773 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4774 |
6598 | 4775 @node Beeping |
4776 @section Beeping | |
4777 @cindex beeping | |
4778 @cindex bell | |
4779 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4780 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
|
4781 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
|
4782 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
|
4783 careful not to use just beeping when signaling an error is more |
59493
0b8e17ea69db
(Beeping): Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
59467
diff
changeset
|
4784 appropriate. (@xref{Errors}.) |
6598 | 4785 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4786 @defun ding &optional do-not-terminate |
6598 | 4787 @cindex keyboard macro termination |
4788 This function beeps, or flashes the screen (see @code{visible-bell} below). | |
4789 It also terminates any keyboard macro currently executing unless | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4790 @var{do-not-terminate} is non-@code{nil}. |
6598 | 4791 @end defun |
4792 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4793 @defun beep &optional do-not-terminate |
6598 | 4794 This is a synonym for @code{ding}. |
4795 @end defun | |
4796 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4797 @defopt visible-bell |
6598 | 4798 This variable determines whether Emacs should flash the screen to |
4799 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
|
4800 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
|
4801 provided the terminal's Termcap entry defines the visible bell |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4802 capability (@samp{vb}). |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4803 @end defopt |
6598 | 4804 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4805 @defvar ring-bell-function |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4806 If this is non-@code{nil}, it specifies how Emacs should ``ring the |
25875 | 4807 bell.'' Its value should be a function of no arguments. If this is |
4808 non-@code{nil}, it takes precedence over the @code{visible-bell} | |
4809 variable. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4810 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4811 |
6598 | 4812 @node Window Systems |
4813 @section Window Systems | |
4814 | |
4815 Emacs works with several window systems, most notably the X Window | |
4816 System. Both Emacs and X use the term ``window'', but use it | |
4817 differently. An Emacs frame is a single window as far as X is | |
4818 concerned; the individual Emacs windows are not known to X at all. | |
4819 | |
4820 @defvar window-system | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4821 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
|
4822 under. The possible values are |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4823 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4824 @table @code |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4825 @item x |
6598 | 4826 @cindex X Window System |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4827 Emacs is displaying using X. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4828 @item pc |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4829 Emacs is displaying using MS-DOS. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4830 @item w32 |
27332
5cfe77eaff45
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27331
diff
changeset
|
4831 Emacs is displaying using Windows. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4832 @item mac |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4833 Emacs is displaying using a Macintosh. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4834 @item nil |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4835 Emacs is using a character-based terminal. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4836 @end table |
6598 | 4837 @end defvar |
4838 | |
4839 @defvar window-setup-hook | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4840 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
|
4841 initialization files. Emacs runs this hook after it has completed |
25875 | 4842 loading your init file, the default initialization file (if |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4843 any), and the terminal-specific Lisp code, and running the hook |
6598 | 4844 @code{term-setup-hook}. |
4845 | |
4846 This hook is used for internal purposes: setting up communication with | |
4847 the window system, and creating the initial window. Users should not | |
4848 interfere with it. | |
4849 @end defvar | |
52401 | 4850 |
4851 @ignore | |
4852 arch-tag: ffdf5714-7ecf-415b-9023-fbc6b409c2c6 | |
4853 @end ignore |