Mercurial > emacs
annotate lispref/display.texi @ 65251:bd6366e3f520
[!TARGET_API_MAC_CARBON] (GetPixDepth): New define.
author | YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp> |
---|---|
date | Wed, 31 Aug 2005 08:35:44 +0000 |
parents | 64ac61f4b3b4 |
children | 822218f80ae4 2d92f5c9d6ae |
rev | line source |
---|---|
64174 | 1 @c -*-texinfo-*- |
6598 | 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, |
64889
e836425ee789
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64877
diff
changeset
|
4 @c 2002, 2003, 2004, 2005 Free Software Foundation, Inc. |
6598 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/display | |
60995
b130414b9a25
(Display): Change name of next node.
Glenn Morris <rgm@gnu.org>
parents:
60958
diff
changeset
|
7 @node Display, System Interface, Processes, Top |
6598 | 8 @chapter Emacs Display |
9 | |
10 This chapter describes a number of features related to the display | |
11 that Emacs presents to the user. | |
12 | |
13 @menu | |
14 * Refresh Screen:: Clearing the screen and redrawing everything on it. | |
25751
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. |
63957
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
17 * The Echo Area:: Displaying messages at the bottom of the screen. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
18 * Warnings:: Displaying warning messages for the user. |
12067 | 19 * Invisible Text:: Hiding part of the buffer text. |
20 * Selective Display:: Hiding part of the buffer text (the old way). | |
6598 | 21 * 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
|
22 * Overlays:: Use overlays to highlight parts of the buffer. |
25875 | 23 * 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
|
24 * 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
|
25 * Faces:: A face defines a graphics style for text characters: |
25875 | 26 font, colors, etc. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
27 * Fringes:: Controlling window fringes. |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
28 * Scroll Bars:: Controlling vertical scroll bars. |
57202
ce88ee86e383
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
57201
diff
changeset
|
29 * Pointer Shape:: Controlling the mouse pointer shape. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
30 * Display Property:: Enabling special display features. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
31 * 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
|
32 * Buttons:: Adding clickable buttons to Emacs buffers. |
6598 | 33 * 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
|
34 * Usual Display:: The usual conventions for displaying nonprinting chars. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
35 * Display Tables:: How to specify other conventions. |
6598 | 36 * Beeping:: Audible signal to the user. |
37 * Window Systems:: Which window system is being used. | |
38 @end menu | |
39 | |
40 @node Refresh Screen | |
41 @section Refreshing the Screen | |
42 | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
43 The function @code{redraw-frame} clears and redisplays the entire |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
44 contents of a given frame (@pxref{Frames}). This is useful if the |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
45 screen is corrupted. |
6598 | 46 |
47 @c Emacs 19 feature | |
48 @defun redraw-frame frame | |
49 This function clears and redisplays frame @var{frame}. | |
50 @end defun | |
51 | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
52 Even more powerful is @code{redraw-display}: |
6598 | 53 |
54 @deffn Command redraw-display | |
55 This function clears and redisplays all visible frames. | |
56 @end deffn | |
57 | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
58 This function calls for redisplay of certain windows, the next time |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
59 redisplay is done, but does not clear them first. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
60 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
61 @defun force-window-update &optional object |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
62 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
|
63 @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
|
64 @var{object} is a buffer or buffer name, it forces redisplay of all |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
65 windows displaying that buffer. If @var{object} is @code{nil} (or |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
66 omitted), it forces redisplay of all windows. |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
67 @end defun |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
68 |
12098 | 69 Processing user input takes absolute priority over redisplay. If you |
70 call these functions when input is available, they do nothing | |
71 immediately, but a full redisplay does happen eventually---after all the | |
72 input has been processed. | |
73 | |
6598 | 74 Normally, suspending and resuming Emacs also refreshes the screen. |
75 Some terminal emulators record separate contents for display-oriented | |
76 programs such as Emacs and for ordinary sequential display. If you are | |
77 using such a terminal, you might want to inhibit the redisplay on | |
9009 | 78 resumption. |
6598 | 79 |
80 @defvar no-redraw-on-reenter | |
81 @cindex suspend (cf. @code{no-redraw-on-reenter}) | |
82 @cindex resume (cf. @code{no-redraw-on-reenter}) | |
83 This variable controls whether Emacs redraws the entire screen after it | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
84 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
|
85 to redraw, @code{nil} means redrawing is needed. The default is @code{nil}. |
6598 | 86 @end defvar |
87 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
88 @node Forcing Redisplay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
89 @section Forcing Redisplay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
90 @cindex forcing redisplay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
91 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
92 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
|
93 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
|
94 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
|
95 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
|
96 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
97 @tindex redisplay-dont-pause |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
98 @defvar redisplay-dont-pause |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
99 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
|
100 prevent or halt redisplay; redisplay occurs, and finishes, |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
101 regardless of whether input is available. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
102 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
103 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
104 You can request a display update, but only if no input is pending, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
105 with @code{(sit-for 0)}. To force a display update even when input is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
106 pending, do this: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
107 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
108 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
109 (let ((redisplay-dont-pause t)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
110 (sit-for 0)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
111 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
112 |
6598 | 113 @node Truncation |
114 @section Truncation | |
115 @cindex line wrapping | |
116 @cindex continuation lines | |
117 @cindex @samp{$} in display | |
118 @cindex @samp{\} in display | |
119 | |
120 When a line of text extends beyond the right edge of a window, the | |
121 line can either be continued on the next screen line, or truncated to | |
122 one screen line. The additional screen lines used to display a long | |
123 text line are called @dfn{continuation} lines. Normally, a @samp{$} in | |
124 the rightmost column of the window indicates truncation; a @samp{\} on | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
125 the rightmost column indicates a line that ``wraps'' onto the next line, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
126 which is also called @dfn{continuing} the line. (The display table can |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
127 specify alternative indicators; see @ref{Display Tables}.) |
6598 | 128 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
129 On a window system display, the @samp{$} and @samp{\} indicators are |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
130 replaced with arrow images displayed in the window fringes |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
131 (@pxref{Fringes}). |
42905
09cd352a779e
(Truncation, Overlay Arrow, Usual Display): Add index entries for fringe
Eli Zaretskii <eliz@gnu.org>
parents:
42888
diff
changeset
|
132 |
6598 | 133 Note that continuation is different from filling; continuation happens |
134 on the screen only, not in the buffer contents, and it breaks a line | |
135 precisely at the right margin, not at a word boundary. @xref{Filling}. | |
136 | |
137 @defopt truncate-lines | |
138 This buffer-local variable controls how Emacs displays lines that extend | |
139 beyond the right edge of the window. The default is @code{nil}, which | |
140 specifies continuation. If the value is non-@code{nil}, then these | |
141 lines are truncated. | |
142 | |
143 If the variable @code{truncate-partial-width-windows} is non-@code{nil}, | |
144 then truncation is always used for side-by-side windows (within one | |
145 frame) regardless of the value of @code{truncate-lines}. | |
146 @end defopt | |
147 | |
12098 | 148 @defopt default-truncate-lines |
6598 | 149 This variable is the default value for @code{truncate-lines}, for |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
150 buffers that do not have buffer-local values for it. |
12098 | 151 @end defopt |
6598 | 152 |
153 @defopt truncate-partial-width-windows | |
154 This variable controls display of lines that extend beyond the right | |
155 edge of the window, in side-by-side windows (@pxref{Splitting Windows}). | |
156 If it is non-@code{nil}, these lines are truncated; otherwise, | |
157 @code{truncate-lines} says what to do with them. | |
158 @end defopt | |
159 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
160 When horizontal scrolling (@pxref{Horizontal Scrolling}) is in use in |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
161 a window, that forces truncation. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
162 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
163 If your buffer contains @emph{very} long lines, and you use |
12067 | 164 continuation to display them, just thinking about them can make Emacs |
12098 | 165 redisplay slow. The column computation and indentation functions also |
166 become slow. Then you might find it advisable to set | |
167 @code{cache-long-line-scans} to @code{t}. | |
12067 | 168 |
169 @defvar cache-long-line-scans | |
170 If this variable is non-@code{nil}, various indentation and motion | |
12098 | 171 functions, and Emacs redisplay, cache the results of scanning the |
172 buffer, and consult the cache to avoid rescanning regions of the buffer | |
173 unless they are modified. | |
12067 | 174 |
12098 | 175 Turning on the cache slows down processing of short lines somewhat. |
12067 | 176 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
177 This variable is automatically buffer-local in every buffer. |
12067 | 178 @end defvar |
179 | |
6598 | 180 @node The Echo Area |
181 @section The Echo Area | |
182 @cindex error display | |
183 @cindex echo area | |
184 | |
63957
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
185 The @dfn{echo area} is used for displaying error messages |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
186 (@pxref{Errors}), for messages made with the @code{message} primitive, |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
187 and for echoing keystrokes. It is not the same as the minibuffer, |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
188 despite the fact that the minibuffer appears (when active) in the same |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
189 place on the screen as the echo area. The @cite{GNU Emacs Manual} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
190 specifies the rules for resolving conflicts between the echo area and |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
191 the minibuffer for use of that screen space (@pxref{Minibuffer,, The |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
192 Minibuffer, emacs, The GNU Emacs Manual}). |
6598 | 193 |
63957
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
194 You can write output in the echo area by using the Lisp printing |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
195 functions with @code{t} as the stream (@pxref{Output Functions}), or |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
196 explicitly. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
197 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
198 @menu |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
199 * Displaying Messages:: Explicitly displaying text in the echo area. |
63967
bbc8b6b4962d
(The Echo Area): Correct menu.
Luc Teirlinck <teirllm@auburn.edu>
parents:
63957
diff
changeset
|
200 * Progress:: Informing user about progress of a long operation. |
63957
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
201 * Logging Messages:: Echo area messages are logged for the user. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
202 * Echo Area Customization:: Controlling the echo area. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
203 @end menu |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
204 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
205 @node Displaying Messages |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
206 @subsection Displaying Messages in the Echo Area |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
207 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
208 This section describes the functions for explicitly producing echo |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
209 area messages. Many other Emacs features display messages there, too. |
6598 | 210 |
211 @defun message string &rest arguments | |
39205
cb857398a0e0
(The Echo Area) <message>: Document message-truncate-lines.
Eli Zaretskii <eliz@gnu.org>
parents:
39032
diff
changeset
|
212 This function displays a message in the echo area. The |
6598 | 213 argument @var{string} is similar to a C language @code{printf} control |
62118
e5a04a0e92c1
(The Echo Area): Correct format function cross reference.
Eli Zaretskii <eliz@gnu.org>
parents:
61980
diff
changeset
|
214 string. See @code{format} in @ref{Formatting Strings}, for the details |
6598 | 215 on the conversion specifications. @code{message} returns the |
216 constructed string. | |
217 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
218 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
|
219 error stream, followed by a newline. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
220 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
221 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
|
222 text properties, these affect the way the message is displayed. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
223 |
6598 | 224 @c Emacs 19 feature |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
225 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
|
226 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
|
227 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
|
228 minibuffer contents back onto the screen immediately. |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
229 |
6598 | 230 @example |
231 @group | |
232 (message "Minibuffer depth is %d." | |
233 (minibuffer-depth)) | |
234 @print{} Minibuffer depth is 0. | |
235 @result{} "Minibuffer depth is 0." | |
236 @end group | |
237 | |
238 @group | |
239 ---------- Echo Area ---------- | |
240 Minibuffer depth is 0. | |
241 ---------- Echo Area ---------- | |
242 @end group | |
243 @end example | |
32261
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
244 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
245 To automatically display a message in the echo area or in a pop-buffer, |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
246 depending on its size, use @code{display-message-or-buffer} (see below). |
6598 | 247 @end defun |
248 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
249 @tindex with-temp-message |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
250 @defmac with-temp-message message &rest body |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
251 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
|
252 the execution of @var{body}. It displays @var{message}, executes |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
253 @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
|
254 the previous echo area contents. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
255 @end defmac |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
256 |
22843
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
257 @defun message-or-box string &rest arguments |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
258 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
|
259 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
|
260 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
|
261 @code{last-nonmenu-event} (@pxref{Command Loop Info}) is either |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
262 @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
|
263 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
|
264 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
|
265 @ref{Yes-or-No Queries}.) |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
266 |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
267 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
|
268 @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
|
269 @end defun |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
270 |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
271 @defun message-box string &rest arguments |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
272 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
|
273 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
|
274 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
|
275 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
|
276 @code{message}. |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
277 @end defun |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
278 |
32261
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
279 @defun display-message-or-buffer message &optional buffer-name not-this-window frame |
32840 | 280 @tindex display-message-or-buffer |
32261
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
281 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
|
282 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
|
283 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
|
284 in the echo area, using @code{message}. Otherwise, |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
285 @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
|
286 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
287 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
|
288 buffer is used, the window used to display it. |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
289 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
290 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
|
291 @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
|
292 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
|
293 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
|
294 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
|
295 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
296 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
|
297 @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
|
298 @end defun |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
299 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
300 @defun current-message |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
301 This function returns the message currently being displayed in the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
302 echo area, or @code{nil} if there is none. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
303 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
304 |
63957
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
305 @node Progress |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
306 @subsection Reporting Operation Progress |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
307 @cindex progress reporting |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
308 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
309 When an operation can take a while to finish, you should inform the |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
310 user about the progress it makes. This way the user can estimate |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
311 remaining time and clearly see that Emacs is busy working, not hung. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
312 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
313 Functions listed in this section provide simple and efficient way of |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
314 reporting operation progress. Here is a working example that does |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
315 nothing useful: |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
316 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
317 @smallexample |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
318 (let ((progress-reporter |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
319 (make-progress-reporter "Collecting mana for Emacs..." |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
320 0 500))) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
321 (dotimes (k 500) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
322 (sit-for 0.01) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
323 (progress-reporter-update progress-reporter k)) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
324 (progress-reporter-done progress-reporter)) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
325 @end smallexample |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
326 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
327 @defun make-progress-reporter message min-value max-value &optional current-value min-change min-time |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
328 This function creates and returns a @dfn{progress reporter}---an |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
329 object you will use as an argument for all other functions listed |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
330 here. The idea is to precompute as much data as possible to make |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
331 progress reporting very fast. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
332 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
333 When this progress reporter is subsequently used, it will display |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
334 @var{message} in the echo area, followed by progress percentage. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
335 @var{message} is treated as a simple string. If you need it to depend |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
336 on a filename, for instance, use @code{format} before calling this |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
337 function. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
338 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
339 @var{min-value} and @var{max-value} arguments stand for starting and |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
340 final states of your operation. For instance, if you scan a buffer, |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
341 they should be the results of @code{point-min} and @code{point-max} |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
342 correspondingly. It is required that @var{max-value} is greater than |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
343 @var{min-value}. If you create progress reporter when some part of |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
344 the operation has already been completed, then specify |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
345 @var{current-value} argument. But normally you should omit it or set |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
346 it to @code{nil}---it will default to @var{min-value} then. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
347 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
348 Remaining arguments control the rate of echo area updates. Progress |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
349 reporter will wait for at least @var{min-change} more percents of the |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
350 operation to be completed before printing next message. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
351 @var{min-time} specifies the minimum time in seconds to pass between |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
352 successive prints. It can be fractional. Depending on Emacs and |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
353 system capabilities, progress reporter may or may not respect this |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
354 last argument or do it with varying precision. Default value for |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
355 @var{min-change} is 1 (one percent), for @var{min-time}---0.2 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
356 (seconds.) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
357 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
358 This function calls @code{progress-reporter-update}, so the first |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
359 message is printed immediately. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
360 @end defun |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
361 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
362 @defun progress-reporter-update reporter value |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
363 This function does the main work of reporting progress of your |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
364 operation. It displays the message of @var{reporter}, followed by |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
365 progress percentage determined by @var{value}. If percentage is zero, |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
366 or close enough according to the @var{min-change} and @var{min-time} |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
367 arguments, then it is omitted from the output. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
368 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
369 @var{reporter} must be the result of a call to |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
370 @code{make-progress-reporter}. @var{value} specifies the current |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
371 state of your operation and must be between @var{min-value} and |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
372 @var{max-value} (inclusive) as passed to |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
373 @code{make-progress-reporter}. For instance, if you scan a buffer, |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
374 then @var{value} should be the result of a call to @code{point}. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
375 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
376 This function respects @var{min-change} and @var{min-time} as passed |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
377 to @code{make-progress-reporter} and so does not output new messages |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
378 on every invocation. It is thus very fast and normally you should not |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
379 try to reduce the number of calls to it: resulting overhead will most |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
380 likely negate your effort. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
381 @end defun |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
382 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
383 @defun progress-reporter-force-update reporter value &optional new-message |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
384 This function is similar to @code{progress-reporter-update} except |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
385 that it prints a message in the echo area unconditionally. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
386 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
387 The first two arguments have the same meaning as for |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
388 @code{progress-reporter-update}. Optional @var{new-message} allows |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
389 you to change the message of the @var{reporter}. Since this functions |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
390 always updates the echo area, such a change will be immediately |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
391 presented to the user. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
392 @end defun |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
393 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
394 @defun progress-reporter-done reporter |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
395 This function should be called when the operation is finished. It |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
396 prints the message of @var{reporter} followed by word ``done'' in the |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
397 echo area. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
398 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
399 You should always call this function and not hope for |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
400 @code{progress-reporter-update} to print ``100%.'' Firstly, it may |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
401 never print it, there are many good reasons for this not to happen. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
402 Secondly, ``done'' is more explicit. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
403 @end defun |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
404 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
405 @defmac dotimes-with-progress-reporter (var count [result]) message body... |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
406 This is a convenience macro that works the same way as @code{dotimes} |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
407 does, but also reports loop progress using the functions described |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
408 above. It allows you to save some typing. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
409 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
410 You can rewrite the example in the beginning of this node using |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
411 this macro this way: |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
412 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
413 @example |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
414 (dotimes-with-progress-reporter |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
415 (k 500) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
416 "Collecting some mana for Emacs..." |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
417 (sit-for 0.01)) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
418 @end example |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
419 @end defmac |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
420 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
421 @node Logging Messages |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
422 @subsection Logging Messages in @samp{*Messages*} |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
423 @cindex logging echo-area messages |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
424 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
425 Almost all the messages displayed in the echo area are also recorded |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
426 in the @samp{*Messages*} buffer so that the user can refer back to |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
427 them. This includes all the messages that are output with |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
428 @code{message}. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
429 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
430 @defopt message-log-max |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
431 This variable specifies how many lines to keep in the @samp{*Messages*} |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
432 buffer. The value @code{t} means there is no limit on how many lines to |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
433 keep. The value @code{nil} disables message logging entirely. Here's |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
434 how to display a message and prevent it from being logged: |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
435 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
436 @example |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
437 (let (message-log-max) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
438 (message @dots{})) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
439 @end example |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
440 @end defopt |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
441 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
442 To make @samp{*Messages*} more convenient for the user, the logging |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
443 facility combines successive identical messages. It also combines |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
444 successive related messages for the sake of two cases: question |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
445 followed by answer, and a series of progress messages. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
446 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
447 A ``question followed by an answer'' means two messages like the |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
448 ones produced by @code{y-or-n-p}: the first is @samp{@var{question}}, |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
449 and the second is @samp{@var{question}...@var{answer}}. The first |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
450 message conveys no additional information beyond what's in the second, |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
451 so logging the second message discards the first from the log. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
452 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
453 A ``series of progress messages'' means successive messages like |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
454 those produced by @code{make-progress-reporter}. They have the form |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
455 @samp{@var{base}...@var{how-far}}, where @var{base} is the same each |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
456 time, while @var{how-far} varies. Logging each message in the series |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
457 discards the previous one, provided they are consecutive. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
458 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
459 The functions @code{make-progress-reporter} and @code{y-or-n-p} |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
460 don't have to do anything special to activate the message log |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
461 combination feature. It operates whenever two consecutive messages |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
462 are logged that share a common prefix ending in @samp{...}. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
463 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
464 @node Echo Area Customization |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
465 @subsection Echo Area Customization |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
466 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
467 These variables control details of how the echo area works. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
468 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
469 @defvar cursor-in-echo-area |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
470 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
|
471 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
|
472 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
|
473 point---not in the echo area at all. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
474 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
475 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
|
476 for brief periods of time. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
477 @end defvar |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
478 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
479 @defvar echo-area-clear-hook |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
480 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
|
481 @code{(message nil)} or for any other reason. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
482 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
483 |
12098 | 484 @defvar echo-keystrokes |
485 This variable determines how much time should elapse before command | |
27971 | 486 characters echo. Its value must be an integer or floating point number, |
487 which specifies the | |
12098 | 488 number of seconds to wait before echoing. If the user types a prefix |
489 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
|
490 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
|
491 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
|
492 sequence are echoed immediately.) |
12098 | 493 |
494 If the value is zero, then command input is not echoed. | |
495 @end defvar | |
496 | |
63957
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
497 @defvar message-truncate-lines |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
498 Normally, displaying a long message resizes the echo area to display |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
499 the entire message. But if the variable @code{message-truncate-lines} |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
500 is non-@code{nil}, the echo area does not resize, and the message is |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
501 truncated to fit it, as in Emacs 20 and before. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
502 @end defvar |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
503 |
64841
c171f553d289
(Echo Area Customization): Don't define max-mini-window-height here;
Richard M. Stallman <rms@gnu.org>
parents:
64411
diff
changeset
|
504 The variable @code{max-mini-window-height}, which specifies the |
c171f553d289
(Echo Area Customization): Don't define max-mini-window-height here;
Richard M. Stallman <rms@gnu.org>
parents:
64411
diff
changeset
|
505 maximum height for resizing minibuffer windows, also applies to the |
c171f553d289
(Echo Area Customization): Don't define max-mini-window-height here;
Richard M. Stallman <rms@gnu.org>
parents:
64411
diff
changeset
|
506 echo area (which is really a special use of the minibuffer window. |
c171f553d289
(Echo Area Customization): Don't define max-mini-window-height here;
Richard M. Stallman <rms@gnu.org>
parents:
64411
diff
changeset
|
507 @xref{Minibuffer Misc}. |
c171f553d289
(Echo Area Customization): Don't define max-mini-window-height here;
Richard M. Stallman <rms@gnu.org>
parents:
64411
diff
changeset
|
508 |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
509 @node Warnings |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
510 @section Reporting Warnings |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
511 @cindex warnings |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
512 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
513 @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
|
514 possible problem, but continue running. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
515 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
516 @menu |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
517 * 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
|
518 * 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
|
519 * 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
|
520 @end menu |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
521 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
522 @node Warning Basics |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
523 @subsection Warning Basics |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
524 @cindex severity level |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
525 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
526 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
|
527 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
|
528 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
|
529 meanings: |
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 @table @code |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
532 @item :emergency |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
533 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
|
534 if you do not attend to it promptly. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
535 @item :error |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
536 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
|
537 @item :warning |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
538 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
|
539 raise suspicion of a possible problem. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
540 @item :debug |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
541 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
|
542 @end table |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
543 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
544 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
|
545 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
|
546 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
|
547 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
|
548 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
|
549 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
|
550 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
|
551 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
|
552 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
|
553 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
|
554 @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
|
555 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
|
556 |
52156
198af82c7606
(Warning Basics): Fix typo.
John Paul Wallington <jpw@pobox.com>
parents:
52141
diff
changeset
|
557 @cindex warning type |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
558 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
|
559 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
|
560 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
|
561 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
|
562 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
|
563 list. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
564 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
565 @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
|
566 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
|
567 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
|
568 severity level, with @code{:warning} being the default. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
569 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
570 @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
|
571 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
|
572 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
573 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
574 @defun lwarn type level message &rest args |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
575 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
|
576 @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
|
577 equivalent to @code{display-warning}. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
578 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
579 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
580 @defun warn message &rest args |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
581 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
|
582 @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
|
583 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
|
584 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
|
585 specify a specific warning type. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
586 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
587 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
588 @node Warning Variables |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
589 @subsection Warning Variables |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
590 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
591 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
|
592 the variables described in this section. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
593 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
594 @defvar warning-levels |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
595 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
|
596 severity levels. Each element defines one severity level, |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
597 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
|
598 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
599 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
|
600 @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
|
601 @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
|
602 @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
|
603 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
|
604 that information. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
605 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
606 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
|
607 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
|
608 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
609 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
|
610 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
611 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
612 @defvar warning-prefix-function |
54023 | 613 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
|
614 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
|
615 @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
|
616 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
|
617 the beginning of the warning message. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
618 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
619 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
|
620 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
|
621 entry (this value need not be an actual member of |
54023 | 622 @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
|
623 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
|
624 a given severity level. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
625 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
626 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
|
627 to call. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
628 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
629 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
630 @defvar warning-series |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
631 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
|
632 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
|
633 that means to leave point on the first warning of the series, rather |
54023 | 634 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
|
635 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
|
636 @code{warning-series} becomes @code{nil} again. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
637 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
638 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
|
639 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
|
640 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
|
641 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
|
642 of warnings. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
643 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
644 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
|
645 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
|
646 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
647 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
|
648 each warning separately. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
649 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
650 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
651 @defvar warning-fill-prefix |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
652 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
|
653 use for filling each warning's text. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
654 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
655 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
656 @defvar warning-type-format |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
657 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
|
658 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
|
659 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
|
660 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
|
661 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
|
662 all. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
663 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
664 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
665 @node Warning Options |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
666 @subsection Warning Options |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
667 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
668 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
|
669 when a Lisp program reports a warning. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
670 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
671 @defopt warning-minimum-level |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
672 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
|
673 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
|
674 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
|
675 warnings. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
676 @end defopt |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
677 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
678 @defopt warning-minimum-log-level |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
679 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
|
680 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
|
681 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
|
682 @end defopt |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
683 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
684 @defopt warning-suppress-types |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
685 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
|
686 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
|
687 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
|
688 type, then that warning is not displayed immediately. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
689 @end defopt |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
690 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
691 @defopt warning-suppress-log-types |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
692 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
|
693 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
|
694 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
|
695 that warning is not logged. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
696 @end defopt |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
697 |
12067 | 698 @node Invisible Text |
699 @section Invisible Text | |
700 | |
701 @cindex invisible text | |
702 You can make characters @dfn{invisible}, so that they do not appear on | |
703 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
|
704 text property (@pxref{Text Properties}) or a property of an overlay |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
705 (@pxref{Overlays}). Cursor motion also partly ignores these |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
706 characters; if the command loop finds point within them, it moves |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
707 point to the other side of them. |
12067 | 708 |
709 In the simplest case, any non-@code{nil} @code{invisible} property makes | |
710 a character invisible. This is the default case---if you don't alter | |
711 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
|
712 @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
|
713 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
|
714 to set @code{buffer-invisibility-spec} yourself. |
12067 | 715 |
716 More generally, you can use the variable @code{buffer-invisibility-spec} | |
717 to control which values of the @code{invisible} property make text | |
718 invisible. This permits you to classify the text into different subsets | |
719 in advance, by giving them different @code{invisible} values, and | |
720 subsequently make various subsets visible or invisible by changing the | |
721 value of @code{buffer-invisibility-spec}. | |
722 | |
723 Controlling visibility with @code{buffer-invisibility-spec} is | |
25875 | 724 especially useful in a program to display the list of entries in a |
725 database. It permits the implementation of convenient filtering | |
726 commands to view just a part of the entries in the database. Setting | |
727 this variable is very fast, much faster than scanning all the text in | |
728 the buffer looking for properties to change. | |
12067 | 729 |
730 @defvar buffer-invisibility-spec | |
731 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
|
732 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
|
733 buffer-local. |
12067 | 734 |
735 @table @asis | |
736 @item @code{t} | |
737 A character is invisible if its @code{invisible} property is | |
738 non-@code{nil}. This is the default. | |
739 | |
740 @item a list | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
741 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
|
742 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
|
743 the character is invisible. The list can have two kinds of elements: |
12067 | 744 |
745 @table @code | |
746 @item @var{atom} | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
747 A character is invisible if its @code{invisible} property value |
12067 | 748 is @var{atom} or if it is a list with @var{atom} as a member. |
749 | |
750 @item (@var{atom} . t) | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
751 A character is invisible if its @code{invisible} property value |
12067 | 752 is @var{atom} or if it is a list with @var{atom} as a member. |
753 Moreover, if this character is at the end of a line and is followed | |
754 by a visible newline, it displays an ellipsis. | |
755 @end table | |
756 @end table | |
757 @end defvar | |
758 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
759 Two functions are specifically provided for adding elements to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
760 @code{buffer-invisibility-spec} and removing elements from it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
761 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
762 @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
|
763 This function adds the element @var{element} to |
61972
874393fa8818
(Invisible Text): Correct add-to-invisibility-spec.
Richard M. Stallman <rms@gnu.org>
parents:
61854
diff
changeset
|
764 @code{buffer-invisibility-spec}. If @code{buffer-invisibility-spec} |
874393fa8818
(Invisible Text): Correct add-to-invisibility-spec.
Richard M. Stallman <rms@gnu.org>
parents:
61854
diff
changeset
|
765 was @code{t}, it changes to a list, @code{(t)}, so that text whose |
874393fa8818
(Invisible Text): Correct add-to-invisibility-spec.
Richard M. Stallman <rms@gnu.org>
parents:
61854
diff
changeset
|
766 @code{invisible} property is @code{t} remains invisible. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
767 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
768 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
769 @defun remove-from-invisibility-spec element |
54023 | 770 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
|
771 @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
|
772 is not in the list. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
773 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
774 |
48948
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
775 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
|
776 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
|
777 @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
|
778 @code{invisible} property: |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
779 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
780 @example |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
781 ;; @r{If you want to display an ellipsis:} |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
782 (add-to-invisibility-spec '(my-symbol . t)) |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
783 ;; @r{If you don't want ellipsis:} |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
784 (add-to-invisibility-spec 'my-symbol) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
785 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
786 (overlay-put (make-overlay beginning end) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
787 'invisible 'my-symbol) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
788 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
789 ;; @r{When done with the overlays:} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
790 (remove-from-invisibility-spec '(my-symbol . t)) |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
791 ;; @r{Or respectively:} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
792 (remove-from-invisibility-spec 'my-symbol) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
793 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
794 |
15761
77d451c08a30
Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
15074
diff
changeset
|
795 @vindex line-move-ignore-invisible |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
796 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
|
797 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
|
798 explicitly ignore invisible newlines if |
60782
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
799 @code{line-move-ignore-invisible} is non-@code{nil} (the default), but |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
800 only because they are explicitly programmed to do so. |
12098 | 801 |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
802 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
|
803 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
|
804 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
|
805 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
|
806 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
|
807 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
|
808 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
|
809 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
|
810 invisible text. |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
811 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
812 Incremental search can make invisible overlays visible temporarily |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
813 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
|
814 this, the overlay should have a non-@code{nil} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
815 @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
|
816 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
|
817 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
|
818 overlaps the overlay on exit from the search. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
819 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
820 During the search, such overlays are made temporarily visible by |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
821 temporarily modifying their invisible and intangible properties. If you |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
822 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
|
823 @code{isearch-open-invisible-temporary} property which is a function. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
824 The function is called with two arguments: the first is the overlay, and |
26986 | 825 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
|
826 make it invisible again. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
827 |
6598 | 828 @node Selective Display |
829 @section Selective Display | |
830 @cindex selective display | |
831 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
832 @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
|
833 hiding certain lines on the screen. |
6598 | 834 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
835 The first variant, explicit selective display, is designed for use |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
836 in a Lisp program: it controls which lines are hidden by altering the |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
837 text. This kind of hiding in some ways resembles the effect of the |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
838 @code{invisible} property (@pxref{Invisible Text}), but the two |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
839 features are different and do not work the same way. |
12067 | 840 |
841 In the second variant, the choice of lines to hide is made | |
12098 | 842 automatically based on indentation. This variant is designed to be a |
12067 | 843 user-level feature. |
6598 | 844 |
845 The way you control explicit selective display is by replacing a | |
9009 | 846 newline (control-j) with a carriage return (control-m). The text that |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
847 was formerly a line following that newline is now hidden. Strictly |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
848 speaking, it is temporarily no longer a line at all, since only |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
849 newlines can separate lines; it is now part of the previous line. |
6598 | 850 |
851 Selective display does not directly affect editing commands. For | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
852 example, @kbd{C-f} (@code{forward-char}) moves point unhesitatingly |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
853 into hidden text. However, the replacement of newline characters with |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
854 carriage return characters affects some editing commands. For |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
855 example, @code{next-line} skips hidden lines, since it searches only |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
856 for newlines. Modes that use selective display can also define |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
857 commands that take account of the newlines, or that control which |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
858 parts of the text are hidden. |
6598 | 859 |
860 When you write a selectively displayed buffer into a file, all the | |
861 control-m's are output as newlines. This means that when you next read | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
862 in the file, it looks OK, with nothing hidden. The selective display |
6598 | 863 effect is seen only within Emacs. |
864 | |
865 @defvar selective-display | |
866 This buffer-local variable enables selective display. This means that | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
867 lines, or portions of lines, may be made hidden. |
6598 | 868 |
869 @itemize @bullet | |
870 @item | |
25875 | 871 If the value of @code{selective-display} is @code{t}, then the character |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
872 control-m marks the start of hidden text; the control-m, and the rest |
25875 | 873 of the line following it, are not displayed. This is explicit selective |
874 display. | |
6598 | 875 |
876 @item | |
877 If the value of @code{selective-display} is a positive integer, then | |
878 lines that start with more than that many columns of indentation are not | |
879 displayed. | |
880 @end itemize | |
881 | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
882 When some portion of a buffer is hidden, the vertical movement |
6598 | 883 commands operate as if that portion did not exist, allowing a single |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
884 @code{next-line} command to skip any number of hidden lines. |
6598 | 885 However, character movement commands (such as @code{forward-char}) do |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
886 not skip the hidden portion, and it is possible (if tricky) to insert |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
887 or delete text in an hidden portion. |
6598 | 888 |
889 In the examples below, we show the @emph{display appearance} of the | |
890 buffer @code{foo}, which changes with the value of | |
891 @code{selective-display}. The @emph{contents} of the buffer do not | |
892 change. | |
893 | |
894 @example | |
895 @group | |
896 (setq selective-display nil) | |
897 @result{} nil | |
898 | |
899 ---------- Buffer: foo ---------- | |
900 1 on this column | |
901 2on this column | |
902 3n this column | |
903 3n this column | |
904 2on this column | |
905 1 on this column | |
906 ---------- Buffer: foo ---------- | |
907 @end group | |
908 | |
909 @group | |
910 (setq selective-display 2) | |
911 @result{} 2 | |
912 | |
913 ---------- Buffer: foo ---------- | |
914 1 on this column | |
915 2on this column | |
916 2on this column | |
917 1 on this column | |
918 ---------- Buffer: foo ---------- | |
919 @end group | |
920 @end example | |
921 @end defvar | |
922 | |
923 @defvar selective-display-ellipses | |
924 If this buffer-local variable is non-@code{nil}, then Emacs displays | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
925 @samp{@dots{}} at the end of a line that is followed by hidden text. |
6598 | 926 This example is a continuation of the previous one. |
927 | |
928 @example | |
929 @group | |
930 (setq selective-display-ellipses t) | |
931 @result{} t | |
932 | |
933 ---------- Buffer: foo ---------- | |
934 1 on this column | |
935 2on this column ... | |
936 2on this column | |
937 1 on this column | |
938 ---------- Buffer: foo ---------- | |
939 @end group | |
940 @end example | |
941 | |
942 You can use a display table to substitute other text for the ellipsis | |
943 (@samp{@dots{}}). @xref{Display Tables}. | |
944 @end defvar | |
945 | |
946 @node Temporary Displays | |
947 @section Temporary Displays | |
948 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
949 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
|
950 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
|
951 editing. Many help commands use this feature. |
6598 | 952 |
953 @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
|
954 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
|
955 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
|
956 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
|
957 displayed in some window, but not selected. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
958 |
52923
41c0ac1a4ed4
(Temporary Displays): Add xref to `Documentation Tips'.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52903
diff
changeset
|
959 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
|
960 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
|
961 @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
|
962 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
|
963 into clickable cross-references. @xref{Docstring hyperlinks, , Tips |
67874c814e45
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
964 for Documentation Strings}, in particular the item on hyperlinks in |
67874c814e45
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
965 documentation strings, for more details. |
6598 | 966 |
967 The string @var{buffer-name} specifies the temporary buffer, which | |
968 need not already exist. The argument must be a string, not a buffer. | |
969 The buffer is erased initially (with no questions asked), and it is | |
970 marked as unmodified after @code{with-output-to-temp-buffer} exits. | |
971 | |
972 @code{with-output-to-temp-buffer} binds @code{standard-output} to the | |
973 temporary buffer, then it evaluates the forms in @var{forms}. Output | |
974 using the Lisp output functions within @var{forms} goes by default to | |
975 that buffer (but screen display and messages in the echo area, although | |
976 they are ``output'' in the general sense of the word, are not affected). | |
977 @xref{Output Functions}. | |
978 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
979 Several hooks are available for customizing the behavior |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
980 of this construct; they are listed below. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
981 |
6598 | 982 The value of the last form in @var{forms} is returned. |
983 | |
984 @example | |
985 @group | |
986 ---------- Buffer: foo ---------- | |
987 This is the contents of foo. | |
988 ---------- Buffer: foo ---------- | |
989 @end group | |
990 | |
991 @group | |
992 (with-output-to-temp-buffer "foo" | |
993 (print 20) | |
994 (print standard-output)) | |
995 @result{} #<buffer foo> | |
996 | |
997 ---------- Buffer: foo ---------- | |
998 20 | |
999 | |
1000 #<buffer foo> | |
1001 | |
1002 ---------- Buffer: foo ---------- | |
1003 @end group | |
1004 @end example | |
1005 @end defspec | |
1006 | |
1007 @defvar temp-buffer-show-function | |
9009 | 1008 If this variable is non-@code{nil}, @code{with-output-to-temp-buffer} |
6598 | 1009 calls it as a function to do the job of displaying a help buffer. The |
1010 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
|
1011 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1012 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
|
1013 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
|
1014 @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
|
1015 selected. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1016 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1017 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1018 @defvar temp-buffer-setup-hook |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1019 @tindex temp-buffer-setup-hook |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1020 This normal hook is run by @code{with-output-to-temp-buffer} before |
42082 | 1021 evaluating @var{body}. When the hook runs, the temporary buffer is |
1022 current. This hook is normally set up with a function to put the | |
1023 buffer in Help mode. | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1024 @end defvar |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1025 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1026 @defvar temp-buffer-show-hook |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1027 This normal hook is run by @code{with-output-to-temp-buffer} after |
42082 | 1028 displaying the temporary buffer. When the hook runs, the temporary buffer |
1029 is current, and the window it was displayed in is selected. This hook | |
1030 is normally set up with a function to make the buffer read only, and | |
1031 find function names and variable names in it, provided the major mode | |
1032 is Help mode. | |
6598 | 1033 @end defvar |
1034 | |
1035 @defun momentary-string-display string position &optional char message | |
1036 This function momentarily displays @var{string} in the current buffer at | |
1037 @var{position}. It has no effect on the undo list or on the buffer's | |
1038 modification status. | |
1039 | |
1040 The momentary display remains until the next input event. If the next | |
1041 input event is @var{char}, @code{momentary-string-display} ignores it | |
1042 and returns. Otherwise, that event remains buffered for subsequent use | |
1043 as input. Thus, typing @var{char} will simply remove the string from | |
1044 the display, while typing (say) @kbd{C-f} will remove the string from | |
1045 the display and later (presumably) move point forward. The argument | |
1046 @var{char} is a space by default. | |
1047 | |
1048 The return value of @code{momentary-string-display} is not meaningful. | |
1049 | |
12098 | 1050 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
|
1051 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
|
1052 deleting) an overlay with a @code{before-string} property. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1053 @xref{Overlay Properties}. |
12098 | 1054 |
6598 | 1055 If @var{message} is non-@code{nil}, it is displayed in the echo area |
1056 while @var{string} is displayed in the buffer. If it is @code{nil}, a | |
1057 default message says to type @var{char} to continue. | |
1058 | |
1059 In this example, point is initially located at the beginning of the | |
1060 second line: | |
1061 | |
1062 @example | |
1063 @group | |
1064 ---------- Buffer: foo ---------- | |
1065 This is the contents of foo. | |
1066 @point{}Second line. | |
1067 ---------- Buffer: foo ---------- | |
1068 @end group | |
1069 | |
1070 @group | |
1071 (momentary-string-display | |
1072 "**** Important Message! ****" | |
1073 (point) ?\r | |
1074 "Type RET when done reading") | |
1075 @result{} t | |
1076 @end group | |
1077 | |
1078 @group | |
1079 ---------- Buffer: foo ---------- | |
1080 This is the contents of foo. | |
1081 **** Important Message! ****Second line. | |
1082 ---------- Buffer: foo ---------- | |
1083 | |
1084 ---------- Echo Area ---------- | |
1085 Type RET when done reading | |
1086 ---------- Echo Area ---------- | |
1087 @end group | |
1088 @end example | |
1089 @end defun | |
1090 | |
1091 @node Overlays | |
1092 @section Overlays | |
1093 @cindex overlays | |
1094 | |
1095 You can use @dfn{overlays} to alter the appearance of a buffer's text on | |
12098 | 1096 the screen, for the sake of presentation features. An overlay is an |
1097 object that belongs to a particular buffer, and has a specified | |
1098 beginning and end. It also has properties that you can examine and set; | |
1099 these affect the display of the text within the overlay. | |
6598 | 1100 |
54023 | 1101 An overlays uses markers to record its beginning and end; thus, |
1102 editing the text of the buffer adjusts the beginning and end of each | |
1103 overlay so that it stays with the text. When you create the overlay, | |
1104 you can specify whether text inserted at the beginning should be | |
1105 inside the overlay or outside, and likewise for the end of the overlay. | |
1106 | |
6598 | 1107 @menu |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1108 * Managing Overlays:: Creating and moving overlays. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
1109 * Overlay Properties:: How to read and set properties. |
6598 | 1110 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
|
1111 * Finding Overlays:: Searching for overlays. |
6598 | 1112 @end menu |
1113 | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1114 @node Managing Overlays |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1115 @subsection Managing Overlays |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1116 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1117 This section describes the functions to create, delete and move |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1118 overlays, and to examine their contents. Overlay changes are not |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1119 recorded in the buffer's undo list, since the overlays are not |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1120 part of the buffer's contents. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1121 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1122 @defun overlayp object |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1123 This function returns @code{t} if @var{object} is an overlay. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1124 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1125 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1126 @defun make-overlay start end &optional buffer front-advance rear-advance |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1127 This function creates and returns an overlay that belongs to |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1128 @var{buffer} and ranges from @var{start} to @var{end}. Both @var{start} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1129 and @var{end} must specify buffer positions; they may be integers or |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1130 markers. If @var{buffer} is omitted, the overlay is created in the |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1131 current buffer. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1132 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1133 The arguments @var{front-advance} and @var{rear-advance} specify the |
64411
4dcefa44889e
(Managing Overlays): Clarify make-overlay args for insertion types.
Richard M. Stallman <rms@gnu.org>
parents:
64174
diff
changeset
|
1134 marker insertion type for the start of the overlay and for the end of |
4dcefa44889e
(Managing Overlays): Clarify make-overlay args for insertion types.
Richard M. Stallman <rms@gnu.org>
parents:
64174
diff
changeset
|
1135 the overlay, respectively. @xref{Marker Insertion Types}. If they |
4dcefa44889e
(Managing Overlays): Clarify make-overlay args for insertion types.
Richard M. Stallman <rms@gnu.org>
parents:
64174
diff
changeset
|
1136 are both @code{nil}, the default, then the overlay extends to include |
4dcefa44889e
(Managing Overlays): Clarify make-overlay args for insertion types.
Richard M. Stallman <rms@gnu.org>
parents:
64174
diff
changeset
|
1137 any text inserted at the beginning, but not text inserted at the end. |
4dcefa44889e
(Managing Overlays): Clarify make-overlay args for insertion types.
Richard M. Stallman <rms@gnu.org>
parents:
64174
diff
changeset
|
1138 If @var{front-advance} is non-@code{nil}, text inserted at the |
4dcefa44889e
(Managing Overlays): Clarify make-overlay args for insertion types.
Richard M. Stallman <rms@gnu.org>
parents:
64174
diff
changeset
|
1139 beginning of the overlay is excluded from the overlay. If |
4dcefa44889e
(Managing Overlays): Clarify make-overlay args for insertion types.
Richard M. Stallman <rms@gnu.org>
parents:
64174
diff
changeset
|
1140 @var{rear-advance} is non-@code{nil}, text inserted at the end of the |
4dcefa44889e
(Managing Overlays): Clarify make-overlay args for insertion types.
Richard M. Stallman <rms@gnu.org>
parents:
64174
diff
changeset
|
1141 overlay is included in the overlay. |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1142 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1143 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1144 @defun overlay-start overlay |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1145 This function returns the position at which @var{overlay} starts, |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1146 as an integer. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1147 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1148 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1149 @defun overlay-end overlay |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1150 This function returns the position at which @var{overlay} ends, |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1151 as an integer. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1152 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1153 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1154 @defun overlay-buffer overlay |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1155 This function returns the buffer that @var{overlay} belongs to. It |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1156 returns @code{nil} if @var{overlay} has been deleted. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1157 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1158 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1159 @defun delete-overlay overlay |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1160 This function deletes @var{overlay}. The overlay continues to exist as |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1161 a Lisp object, and its property list is unchanged, but it ceases to be |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1162 attached to the buffer it belonged to, and ceases to have any effect on |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1163 display. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1164 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1165 A deleted overlay is not permanently disconnected. You can give it a |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1166 position in a buffer again by calling @code{move-overlay}. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1167 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1168 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1169 @defun move-overlay overlay start end &optional buffer |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1170 This function moves @var{overlay} to @var{buffer}, and places its bounds |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1171 at @var{start} and @var{end}. Both arguments @var{start} and @var{end} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1172 must specify buffer positions; they may be integers or markers. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1173 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1174 If @var{buffer} is omitted, @var{overlay} stays in the same buffer it |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1175 was already associated with; if @var{overlay} was deleted, it goes into |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1176 the current buffer. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1177 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1178 The return value is @var{overlay}. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1179 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1180 This is the only valid way to change the endpoints of an overlay. Do |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1181 not try modifying the markers in the overlay by hand, as that fails to |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1182 update other vital data structures and can cause some overlays to be |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1183 ``lost''. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1184 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1185 |
60782
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1186 @defun remove-overlays &optional start end name value |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1187 This function removes all the overlays between @var{start} and |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1188 @var{end} whose property @var{name} has the value @var{value}. It can |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1189 move the endpoints of the overlays in the region, or split them. |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1190 |
61980
f3d536670495
Fix typos and Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61972
diff
changeset
|
1191 If @var{name} is omitted or @code{nil}, it means to delete all overlays in |
60782
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1192 the specified region. If @var{start} and/or @var{end} are omitted or |
61980
f3d536670495
Fix typos and Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61972
diff
changeset
|
1193 @code{nil}, that means the beginning and end of the buffer respectively. |
60782
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1194 Therefore, @code{(remove-overlays)} removes all the overlays in the |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1195 current buffer. |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1196 @end defun |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1197 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1198 Here are some examples: |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1199 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1200 @example |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1201 ;; @r{Create an overlay.} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1202 (setq foo (make-overlay 1 10)) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1203 @result{} #<overlay from 1 to 10 in display.texi> |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1204 (overlay-start foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1205 @result{} 1 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1206 (overlay-end foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1207 @result{} 10 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1208 (overlay-buffer foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1209 @result{} #<buffer display.texi> |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1210 ;; @r{Give it a property we can check later.} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1211 (overlay-put foo 'happy t) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1212 @result{} t |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1213 ;; @r{Verify the property is present.} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1214 (overlay-get foo 'happy) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1215 @result{} t |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1216 ;; @r{Move the overlay.} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1217 (move-overlay foo 5 20) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1218 @result{} #<overlay from 5 to 20 in display.texi> |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1219 (overlay-start foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1220 @result{} 5 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1221 (overlay-end foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1222 @result{} 20 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1223 ;; @r{Delete the overlay.} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1224 (delete-overlay foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1225 @result{} nil |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1226 ;; @r{Verify it is deleted.} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1227 foo |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1228 @result{} #<overlay in no buffer> |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1229 ;; @r{A deleted overlay has no position.} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1230 (overlay-start foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1231 @result{} nil |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1232 (overlay-end foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1233 @result{} nil |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1234 (overlay-buffer foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1235 @result{} nil |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1236 ;; @r{Undelete the overlay.} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1237 (move-overlay foo 1 20) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1238 @result{} #<overlay from 1 to 20 in display.texi> |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1239 ;; @r{Verify the results.} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1240 (overlay-start foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1241 @result{} 1 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1242 (overlay-end foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1243 @result{} 20 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1244 (overlay-buffer foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1245 @result{} #<buffer display.texi> |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1246 ;; @r{Moving and deleting the overlay does not change its properties.} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1247 (overlay-get foo 'happy) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1248 @result{} t |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1249 @end example |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1250 |
6598 | 1251 @node Overlay Properties |
1252 @subsection Overlay Properties | |
1253 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1254 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
|
1255 alter how a character is displayed can come from either source. But in |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1256 most respects they are different. @xref{Text Properties}, for comparison. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1257 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1258 Text properties are considered a part of the text; overlays and |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1259 their properties are specifically considered not to be part of the |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1260 text. Thus, copying text between various buffers and strings |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1261 preserves text properties, but does not try to preserve overlays. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1262 Changing a buffer's text properties marks the buffer as modified, |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1263 while moving an overlay or changing its properties does not. Unlike |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1264 text property changes, overlay property changes are not recorded in |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1265 the buffer's undo list. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1266 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1267 These functions read and set the properties of an overlay: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1268 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1269 @defun overlay-get overlay prop |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1270 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
|
1271 @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
|
1272 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
|
1273 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
|
1274 is @code{nil}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1275 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1276 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1277 @defun overlay-put overlay prop value |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1278 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
|
1279 @var{overlay} to @var{value}. It returns @var{value}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1280 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1281 |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1282 @defun overlay-properties overlay |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1283 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
|
1284 @end defun |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1285 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1286 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
|
1287 overlay properties and text properties for a given character. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1288 @xref{Examining Properties}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1289 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1290 Many overlay properties have special meanings; here is a table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1291 of them: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1292 |
6598 | 1293 @table @code |
1294 @item priority | |
1295 @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
|
1296 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
|
1297 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
|
1298 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
|
1299 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
|
1300 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
|
1301 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
|
1302 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
|
1303 @code{face} property. |
6598 | 1304 |
1305 Currently, all overlays take priority over text properties. Please | |
1306 avoid using negative priority values, as we have not yet decided just | |
1307 what they should mean. | |
1308 | |
1309 @item window | |
1310 @kindex window @r{(overlay property)} | |
1311 If the @code{window} property is non-@code{nil}, then the overlay | |
1312 applies only on that window. | |
1313 | |
12067 | 1314 @item category |
1315 @kindex category @r{(overlay property)} | |
1316 If an overlay has a @code{category} property, we call it the | |
12098 | 1317 @dfn{category} of the overlay. It should be a symbol. The properties |
12067 | 1318 of the symbol serve as defaults for the properties of the overlay. |
1319 | |
6598 | 1320 @item face |
1321 @kindex face @r{(overlay property)} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1322 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
|
1323 font and which colors. @xref{Faces}, for more information. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1324 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1325 In the simplest case, the value is a face name. It can also be a list; |
25875 | 1326 then each element can be any of these possibilities: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1327 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1328 @itemize @bullet |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1329 @item |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1330 A face name (a symbol or string). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1331 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1332 @item |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1333 A property list of face attributes. This has the form (@var{keyword} |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1334 @var{value} @dots{}), where each @var{keyword} is a face attribute |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1335 name and @var{value} is a meaningful value for that attribute. With |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1336 this feature, you do not need to create a face each time you want to |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1337 specify a particular attribute for certain text. @xref{Face |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1338 Attributes}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1339 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1340 @item |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1341 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
|
1342 @code{(background-color . @var{color-name})}. These elements specify |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1343 just the foreground color or just the background color. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1344 |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
1345 @code{(foreground-color . @var{color-name})} has the same effect as |
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
1346 @code{(:foreground @var{color-name})}; likewise for the background. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1347 @end itemize |
6598 | 1348 |
1349 @item mouse-face | |
1350 @kindex mouse-face @r{(overlay property)} | |
1351 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
|
1352 the range of the overlay. |
6598 | 1353 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1354 @item display |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1355 @kindex display @r{(overlay property)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1356 This property activates various features that change the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1357 way text is displayed. For example, it can make text appear taller |
38278 | 1358 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
|
1359 @xref{Display Property}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1360 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1361 @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
|
1362 @kindex help-echo @r{(overlay property)} |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
1363 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
|
1364 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
|
1365 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
|
1366 help-echo}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1367 |
6598 | 1368 @item modification-hooks |
1369 @kindex modification-hooks @r{(overlay property)} | |
1370 This property's value is a list of functions to be called if any | |
1371 character within the overlay is changed or if text is inserted strictly | |
12067 | 1372 within the overlay. |
1373 | |
1374 The hook functions are called both before and after each change. | |
1375 If the functions save the information they receive, and compare notes | |
1376 between calls, they can determine exactly what change has been made | |
1377 in the buffer text. | |
1378 | |
1379 When called before a change, each function receives four arguments: the | |
1380 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
|
1381 modified. |
6598 | 1382 |
12067 | 1383 When called after a change, each function receives five arguments: the |
1384 overlay, @code{t}, the beginning and end of the text range just | |
1385 modified, and the length of the pre-change text replaced by that range. | |
1386 (For an insertion, the pre-change length is zero; for a deletion, that | |
1387 length is the number of characters deleted, and the post-change | |
12098 | 1388 beginning and end are equal.) |
12067 | 1389 |
64156
06f333c0aec7
(Inverse Video): Delete mode-line-inverse-video.
Richard M. Stallman <rms@gnu.org>
parents:
63967
diff
changeset
|
1390 If these functions modify the buffer, they should bind |
06f333c0aec7
(Inverse Video): Delete mode-line-inverse-video.
Richard M. Stallman <rms@gnu.org>
parents:
63967
diff
changeset
|
1391 @code{inhibit-modification-hooks} to @code{t} around doing so, to |
06f333c0aec7
(Inverse Video): Delete mode-line-inverse-video.
Richard M. Stallman <rms@gnu.org>
parents:
63967
diff
changeset
|
1392 avoid confusing the internal mechanism that calls these hooks. |
06f333c0aec7
(Inverse Video): Delete mode-line-inverse-video.
Richard M. Stallman <rms@gnu.org>
parents:
63967
diff
changeset
|
1393 |
6598 | 1394 @item insert-in-front-hooks |
1395 @kindex insert-in-front-hooks @r{(overlay property)} | |
12067 | 1396 This property's value is a list of functions to be called before and |
1397 after inserting text right at the beginning of the overlay. The calling | |
1398 conventions are the same as for the @code{modification-hooks} functions. | |
6598 | 1399 |
1400 @item insert-behind-hooks | |
1401 @kindex insert-behind-hooks @r{(overlay property)} | |
12067 | 1402 This property's value is a list of functions to be called before and |
1403 after inserting text right at the end of the overlay. The calling | |
1404 conventions are the same as for the @code{modification-hooks} functions. | |
6598 | 1405 |
1406 @item invisible | |
1407 @kindex invisible @r{(overlay property)} | |
12067 | 1408 The @code{invisible} property can make the text in the overlay |
1409 invisible, which means that it does not appear on the screen. | |
1410 @xref{Invisible Text}, for details. | |
1411 | |
1412 @item intangible | |
1413 @kindex intangible @r{(overlay property)} | |
1414 The @code{intangible} property on an overlay works just like the | |
12098 | 1415 @code{intangible} text property. @xref{Special Properties}, for details. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1416 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1417 @item isearch-open-invisible |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1418 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
|
1419 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
|
1420 Text}. |
6598 | 1421 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1422 @item isearch-open-invisible-temporary |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1423 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
|
1424 visible, temporarily, during the search. @xref{Invisible Text}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1425 |
6598 | 1426 @item before-string |
1427 @kindex before-string @r{(overlay property)} | |
1428 This property's value is a string to add to the display at the beginning | |
1429 of the overlay. The string does not appear in the buffer in any | |
25875 | 1430 sense---only on the screen. |
6598 | 1431 |
1432 @item after-string | |
1433 @kindex after-string @r{(overlay property)} | |
1434 This property's value is a string to add to the display at the end of | |
1435 the overlay. The string does not appear in the buffer in any | |
25875 | 1436 sense---only on the screen. |
12067 | 1437 |
1438 @item evaporate | |
1439 @kindex evaporate @r{(overlay property)} | |
1440 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
|
1441 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
|
1442 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
|
1443 it immediately. |
16123
ec5f48fe0320
Mention local-value property on an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
15761
diff
changeset
|
1444 |
29102 | 1445 @item local-map |
29076 | 1446 @cindex keymap of character (and overlays) |
29102 | 1447 @kindex local-map @r{(overlay property)} |
29076 | 1448 If this property is non-@code{nil}, it specifies a keymap for a portion |
1449 of the text. The property's value replaces the buffer's local map, when | |
1450 the character after point is within the overlay. @xref{Active Keymaps}. | |
33996 | 1451 |
1452 @item keymap | |
1453 @kindex keymap @r{(overlay property)} | |
1454 The @code{keymap} property is similar to @code{local-map} but overrides the | |
1455 buffer's local map (and the map specified by the @code{local-map} | |
1456 property) rather than replacing it. | |
29076 | 1457 @end table |
1458 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1459 @node Finding Overlays |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1460 @subsection Searching for Overlays |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1461 |
6598 | 1462 @defun overlays-at pos |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1463 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
|
1464 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
|
1465 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
|
1466 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
|
1467 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1468 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
|
1469 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
|
1470 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1471 @smallexample |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1472 (defun find-overlays-specifying (prop) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1473 (let ((overlays (overlays-at (point))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1474 found) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1475 (while overlays |
37170
29f2615d958f
(Finding Overlays): Fix example code.
Gerd Moellmann <gerd@gnu.org>
parents:
36935
diff
changeset
|
1476 (let ((overlay (car overlays))) |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1477 (if (overlay-get overlay prop) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1478 (setq found (cons overlay found)))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1479 (setq overlays (cdr overlays))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1480 found)) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1481 @end smallexample |
6598 | 1482 @end defun |
1483 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1484 @defun overlays-in beg end |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1485 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
|
1486 @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
|
1487 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
|
1488 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
|
1489 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
|
1490 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1491 |
6598 | 1492 @defun next-overlay-change pos |
1493 This function returns the buffer position of the next beginning or end | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1494 of an overlay, after @var{pos}. If there is none, it returns |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1495 @code{(point-max)}. |
6598 | 1496 @end defun |
1497 | |
12067 | 1498 @defun previous-overlay-change pos |
1499 This function returns the buffer position of the previous beginning or | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1500 end of an overlay, before @var{pos}. If there is none, it returns |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1501 @code{(point-min)}. |
12067 | 1502 @end defun |
1503 | |
65121
64ac61f4b3b4
(Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents:
65075
diff
changeset
|
1504 Here's a function which uses @code{next-overlay-change} to search |
64ac61f4b3b4
(Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents:
65075
diff
changeset
|
1505 for the next character which gets a given property @code{prop} from |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1506 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
|
1507 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1508 @smallexample |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1509 (defun find-overlay-prop (prop) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1510 (save-excursion |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1511 (while (and (not (eobp)) |
65121
64ac61f4b3b4
(Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents:
65075
diff
changeset
|
1512 (not (get-char-property (point) prop))) |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1513 (goto-char (min (next-overlay-change (point)) |
65121
64ac61f4b3b4
(Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents:
65075
diff
changeset
|
1514 (next-single-property-change (point) prop)))) |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1515 (point))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1516 @end smallexample |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1517 |
65121
64ac61f4b3b4
(Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents:
65075
diff
changeset
|
1518 Now you can search for a @code{happy} property like this: |
64ac61f4b3b4
(Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents:
65075
diff
changeset
|
1519 |
64ac61f4b3b4
(Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents:
65075
diff
changeset
|
1520 @smallexample |
64ac61f4b3b4
(Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents:
65075
diff
changeset
|
1521 (find-overlay-prop 'happy) |
64ac61f4b3b4
(Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents:
65075
diff
changeset
|
1522 @end smallexample |
64ac61f4b3b4
(Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents:
65075
diff
changeset
|
1523 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1524 @node Width |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1525 @section Width |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1526 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1527 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
|
1528 check the width of a character. @xref{Primitive Indent}, and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1529 @ref{Screen Lines}, for related functions. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1530 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1531 @defun char-width char |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1532 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
|
1533 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
|
1534 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1535 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1536 @defun string-width string |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1537 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
|
1538 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
|
1539 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1540 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1541 @defun truncate-string-to-width string width &optional start-column padding ellipsis |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1542 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
|
1543 @var{width} columns, as a new string. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1544 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1545 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
|
1546 @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
|
1547 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
|
1548 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
|
1549 go beyond it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1550 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1551 The optional argument @var{start-column} specifies the starting column. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1552 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
|
1553 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
|
1554 @var{string} extends across the column @var{start-column}, that |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1555 character is not included. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1556 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1557 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
|
1558 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
|
1559 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
|
1560 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
|
1561 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
|
1562 @var{string} extends across the column @var{start-column}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1563 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1564 If @var{ellipsis} is non-@code{nil}, it should be a string which will |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1565 replace the end of @var{str} (including any padding) if it extends |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1566 beyond @var{end-column}, unless the display width of @var{str} is |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1567 equal to or less than the display width of @var{ellipsis}. If |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1568 @var{ellipsis} is non-@code{nil} and not a string, it stands for |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1569 @code{"..."}. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1570 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1571 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1572 (truncate-string-to-width "\tab\t" 12 4) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1573 @result{} "ab" |
52002
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
1574 (truncate-string-to-width "\tab\t" 12 4 ?\s) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1575 @result{} " ab " |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1576 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1577 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1578 |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1579 @node Line Height |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1580 @section Line Height |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1581 @cindex line height |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1582 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1583 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
|
1584 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
|
1585 display row. |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1586 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1587 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
|
1588 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
|
1589 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
|
1590 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
|
1591 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
|
1592 |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1593 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
|
1594 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
|
1595 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
|
1596 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1597 @kindex line-height @r{(text property)} |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1598 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
|
1599 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
|
1600 newline. |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1601 |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1602 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
|
1603 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
|
1604 @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
|
1605 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
|
1606 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
|
1607 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
|
1608 |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1609 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
|
1610 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
|
1611 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
|
1612 adding blank areas between the images. |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1613 |
59212
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1614 If the property value is not @code{t}, it is a height spec. A height |
61980
f3d536670495
Fix typos and Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61972
diff
changeset
|
1615 spec stands for a numeric height value; this height spec specifies the |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1616 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
|
1617 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
|
1618 height: |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1619 |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1620 @table @code |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1621 @item @var{integer} |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1622 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
|
1623 @item @var{float} |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1624 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
|
1625 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
|
1626 @item (@var{face} . @var{ratio}) |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1627 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
|
1628 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
|
1629 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
|
1630 If @var{face} is @code{t}, it refers to the current face. |
61980
f3d536670495
Fix typos and Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61972
diff
changeset
|
1631 @item (nil . @var{ratio}) |
59212
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1632 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
|
1633 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
|
1634 @end table |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1635 |
59212
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1636 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
|
1637 @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
|
1638 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
|
1639 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
|
1640 @var{line-height} has no effect. |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1641 |
61980
f3d536670495
Fix typos and Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61972
diff
changeset
|
1642 If you don't specify the @code{line-height} property, the line's |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1643 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
|
1644 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
|
1645 parts of Emacs text. |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1646 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1647 @vindex default-line-spacing |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1648 You can specify the line spacing for all lines in a frame with the |
64877
573bd827cef9
(Line Height, Scroll Bars): Fix xrefs.
Richard M. Stallman <rms@gnu.org>
parents:
64841
diff
changeset
|
1649 @code{line-spacing} frame parameter (@pxref{Layout Parameters}). |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1650 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
|
1651 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
|
1652 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
|
1653 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
|
1654 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
|
1655 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1656 @vindex line-spacing |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1657 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
|
1658 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
|
1659 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
|
1660 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
|
1661 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
|
1662 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1663 @kindex line-spacing @r{(text property)} |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1664 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
|
1665 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
|
1666 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
|
1667 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
|
1668 |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1669 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
|
1670 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
|
1671 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
|
1672 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
|
1673 height. |
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1674 |
6598 | 1675 @node Faces |
1676 @section Faces | |
40469
aa8474236e9e
Index "faces" instead of "face".
Richard M. Stallman <rms@gnu.org>
parents:
40310
diff
changeset
|
1677 @cindex faces |
6598 | 1678 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1679 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
|
1680 family, foreground color, background color, optional underlining, and |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1681 many others. Faces are used in Emacs to control the style of display of |
65075
88aad5396aac
(Standard Faces): Delete node.
Juri Linkov <juri@jurta.org>
parents:
65073
diff
changeset
|
1682 particular parts of the text or the frame. @xref{Standard Faces,,, |
88aad5396aac
(Standard Faces): Delete node.
Juri Linkov <juri@jurta.org>
parents:
65073
diff
changeset
|
1683 emacs, The GNU Emacs Manual}, for the list of faces Emacs normally |
88aad5396aac
(Standard Faces): Delete node.
Juri Linkov <juri@jurta.org>
parents:
65073
diff
changeset
|
1684 comes with. |
6598 | 1685 |
1686 @cindex face id | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1687 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
|
1688 low levels within Emacs. However, for most purposes, you refer to |
63782
a750e72f48e7
(Faces): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
63777
diff
changeset
|
1689 faces in Lisp programs by the symbols that name them. |
6598 | 1690 |
12067 | 1691 @defun facep object |
63777
fd183c9e3b18
(Faces): `facep' returns t for strings that are face names.
Luc Teirlinck <teirllm@auburn.edu>
parents:
63734
diff
changeset
|
1692 This function returns @code{t} if @var{object} is a face name string |
fd183c9e3b18
(Faces): `facep' returns t for strings that are face names.
Luc Teirlinck <teirllm@auburn.edu>
parents:
63734
diff
changeset
|
1693 or symbol (or if it is a vector of the kind used internally to record |
fd183c9e3b18
(Faces): `facep' returns t for strings that are face names.
Luc Teirlinck <teirllm@auburn.edu>
parents:
63734
diff
changeset
|
1694 face data). It returns @code{nil} otherwise. |
12067 | 1695 @end defun |
1696 | |
6598 | 1697 Each face name is meaningful for all frames, and by default it has the |
1698 same meaning in all frames. But you can arrange to give a particular | |
1699 face name a special meaning in one frame if you wish. | |
1700 | |
1701 @menu | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1702 * 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
|
1703 * 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
|
1704 * 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
|
1705 * 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
|
1706 * 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
|
1707 * Face Functions:: How to define and examine faces. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1708 * Auto Faces:: Hook for automatic face assignment. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1709 * Font Lookup:: Looking up the names of available fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1710 and information about them. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1711 * Fontsets:: A fontset is a collection of fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1712 that handle a range of character sets. |
6598 | 1713 @end menu |
1714 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1715 @node Defining Faces |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1716 @subsection Defining Faces |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1717 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1718 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
|
1719 kind of customization item (@pxref{Customization}) which the user can |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1720 customize using the Customization buffer (@pxref{Easy Customization,,, |
63777
fd183c9e3b18
(Faces): `facep' returns t for strings that are face names.
Luc Teirlinck <teirllm@auburn.edu>
parents:
63734
diff
changeset
|
1721 emacs, The GNU Emacs Manual}). |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1722 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1723 @defmac defface face spec doc [keyword value]... |
63134
ca65a2108220
(Defining Faces): Explain that face name should not end in `-face'.
Richard M. Stallman <rms@gnu.org>
parents:
63117
diff
changeset
|
1724 This declares @var{face} as a customizable face that defaults |
ca65a2108220
(Defining Faces): Explain that face name should not end in `-face'.
Richard M. Stallman <rms@gnu.org>
parents:
63117
diff
changeset
|
1725 according to @var{spec}. You should not quote the symbol @var{face}, |
ca65a2108220
(Defining Faces): Explain that face name should not end in `-face'.
Richard M. Stallman <rms@gnu.org>
parents:
63117
diff
changeset
|
1726 and it should not end in @samp{-face} (that would be redundant). The |
25875 | 1727 argument @var{doc} specifies the face documentation. The keywords you |
63134
ca65a2108220
(Defining Faces): Explain that face name should not end in `-face'.
Richard M. Stallman <rms@gnu.org>
parents:
63117
diff
changeset
|
1728 can use in @code{defface} are the same as in @code{defgroup} and |
ca65a2108220
(Defining Faces): Explain that face name should not end in `-face'.
Richard M. Stallman <rms@gnu.org>
parents:
63117
diff
changeset
|
1729 @code{defcustom} (@pxref{Common Keywords}). |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1730 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1731 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
|
1732 @var{spec}, then uses any customizations that were read from the |
25875 | 1733 init file (@pxref{Init File}) to override that specification. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1734 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1735 The purpose of @var{spec} is to specify how the face should appear on |
61854
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1736 different kinds of terminals. It should be an alist whose elements |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1737 have the form @code{(@var{display} @var{atts})}. Each element's |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1738 @sc{car}, @var{display}, specifies a class of terminals. (The first |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1739 element, if it s @sc{car} is @code{default}, is special---it specifies |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1740 defaults for the remaining elements). The element's @sc{cadr}, |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1741 @var{atts}, is a list of face attributes and their values; it |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1742 specifies what the face should look like on that kind of terminal. |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1743 The possible attributes are defined in the value of |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1744 @code{custom-face-attributes}. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1745 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1746 The @var{display} part of an element of @var{spec} determines which |
61854
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1747 frames the element matches. If more than one element of @var{spec} |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1748 matches a given frame, the first element that matches is the one used |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1749 for that frame. There are three possibilities for @var{display}: |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1750 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1751 @table @asis |
61854
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1752 @item @code{default} |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1753 This element of @var{spec} doesn't match any frames; instead, it |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1754 specifies defaults that apply to all frames. This kind of element, if |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1755 used, must be the first element of @var{spec}. Each of the following |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1756 elements can override any or all of these defaults. |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1757 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1758 @item @code{t} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1759 This element of @var{spec} matches all frames. Therefore, any |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1760 subsequent elements of @var{spec} are never used. Normally |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1761 @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
|
1762 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1763 @item a list |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1764 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
|
1765 @code{(@var{characteristic} @var{value}@dots{})}. Here |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1766 @var{characteristic} specifies a way of classifying frames, and the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1767 @var{value}s are possible classifications which @var{display} should |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1768 apply to. Here are the possible values of @var{characteristic}: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1769 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1770 @table @code |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1771 @item type |
32802
66f219c7e8ca
(Defining Faces): Document `graphic' display type in face specs.
Miles Bader <miles@gnu.org>
parents:
32552
diff
changeset
|
1772 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
|
1773 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
|
1774 @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
|
1775 display). |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1776 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1777 @item class |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1778 What kinds of colors the frame supports---either @code{color}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1779 @code{grayscale}, or @code{mono}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1780 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1781 @item background |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1782 The kind of background---either @code{light} or @code{dark}. |
45745 | 1783 |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1784 @item min-colors |
61854
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1785 An integer that represents the minimum number of colors the frame |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1786 should support. This matches a frame if its |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1787 @code{display-color-cells} value is at least the specified integer. |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1788 |
45745 | 1789 @item supports |
46170 | 1790 Whether or not the frame can display the face attributes given in |
1791 @var{value}@dots{} (@pxref{Face Attributes}). See the documentation | |
1792 for the function @code{display-supports-face-attributes-p} for more | |
1793 information on exactly how this testing is done. @xref{Display Face | |
1794 Attribute Testing}. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1795 @end table |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1796 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1797 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
|
1798 given @var{characteristic}, any of those values is acceptable. If |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1799 @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
|
1800 different @var{characteristic}; then @emph{each} characteristic of the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1801 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
|
1802 @var{display}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1803 @end table |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1804 @end defmac |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1805 |
25875 | 1806 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
|
1807 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1808 @example |
25875 | 1809 @group |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1810 '((((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
|
1811 :background "blue3") |
25875 | 1812 @end group |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1813 (((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
|
1814 :background "lightgoldenrod2") |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1815 (((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
|
1816 :background "blue3") |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1817 (((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
|
1818 :background "lightgoldenrod2") |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1819 (((class color) (min-colors 8)) |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1820 :background "blue" :foreground "white") |
25875 | 1821 (((type tty) (class mono)) |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1822 :inverse-video t) |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1823 (t :background "gray")) |
25875 | 1824 @group |
1825 "Basic face for highlighting the region." | |
1826 :group 'basic-faces) | |
1827 @end group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1828 @end example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1829 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1830 Internally, @code{defface} uses the symbol property |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1831 @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
|
1832 @code{defface}, @code{saved-face} for the attributes saved by the user |
63640
2b9aa367d2f8
(Defining Faces): Add `customized-face'.
Juri Linkov <juri@jurta.org>
parents:
63583
diff
changeset
|
1833 with the customization buffer, @code{customized-face} for the |
2b9aa367d2f8
(Defining Faces): Add `customized-face'.
Juri Linkov <juri@jurta.org>
parents:
63583
diff
changeset
|
1834 attributes customized by the user for the current session, but not |
2b9aa367d2f8
(Defining Faces): Add `customized-face'.
Juri Linkov <juri@jurta.org>
parents:
63583
diff
changeset
|
1835 saved, and @code{face-documentation} for the documentation string. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1836 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1837 @defopt frame-background-mode |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1838 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
|
1839 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
|
1840 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
|
1841 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
|
1842 as if they had a light background. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1843 @end defopt |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1844 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1845 @node Face Attributes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1846 @subsection Face Attributes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1847 @cindex face attributes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1848 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1849 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
|
1850 attributes}. This table lists all the face attributes, and what they |
25875 | 1851 mean. Note that in general, more than one face can be specified for a |
1852 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
|
1853 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
|
1854 |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1855 Any attribute in a face can have the value @code{unspecified}. This |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1856 means the face doesn't specify that attribute. In face merging, when |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1857 the first face fails to specify a particular attribute, that means the |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1858 next face gets a chance. However, the @code{default} face must |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1859 specify all attributes. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1860 |
25875 | 1861 Some of these font attributes are meaningful only on certain kinds of |
1862 displays---if your display cannot handle a certain attribute, the | |
1863 attribute is ignored. (The attributes @code{:family}, @code{:width}, | |
1864 @code{:height}, @code{:weight}, and @code{:slant} correspond to parts of | |
1865 an X Logical Font Descriptor.) | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1866 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1867 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1868 @item :family |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1869 Font family name, or fontset name (@pxref{Fontsets}). If you specify a |
25875 | 1870 font family name, the wild-card characters @samp{*} and @samp{?} are |
1871 allowed. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1872 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1873 @item :width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1874 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
|
1875 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
|
1876 @code{extra-condensed}, @code{condensed}, @code{semi-condensed}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1877 @code{normal}, @code{semi-expanded}, @code{expanded}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1878 @code{extra-expanded}, or @code{ultra-expanded}. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1879 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1880 @item :height |
32089
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1881 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
|
1882 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
|
1883 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
|
1884 (from the underlying face), and should return the new height. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1885 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1886 @item :weight |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1887 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
|
1888 @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
|
1889 @code{normal}, @code{semi-light}, @code{light}, @code{extra-light}, |
25875 | 1890 or @code{ultra-light}. |
25809
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1891 |
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1892 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
|
1893 extra bright, and any weight less than normal is displayed as |
25875 | 1894 half-bright (provided the terminal supports the feature). |
1895 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1896 @item :slant |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1897 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
|
1898 @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
|
1899 |
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1900 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
|
1901 the terminal supports the feature. |
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1902 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1903 @item :foreground |
59277
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
1904 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
|
1905 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
|
1906 @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
|
1907 @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
|
1908 blue, and @samp{#ffffff} is white.) |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1909 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1910 @item :background |
59277
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
1911 Background color, a string, like the foreground color. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1912 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1913 @item :inverse-video |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1914 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
|
1915 value should be @code{t} (yes) or @code{nil} (no). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1916 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1917 @item :stipple |
25875 | 1918 The background stipple, a bitmap. |
1919 | |
1920 The value can be a string; that should be the name of a file containing | |
1921 external-format X bitmap data. The file is found in the directories | |
1922 listed in the variable @code{x-bitmap-file-path}. | |
1923 | |
40310
34f1a01f25fa
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
39404
diff
changeset
|
1924 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
|
1925 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
|
1926 @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
|
1927 @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
|
1928 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
|
1929 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
|
1930 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
|
1931 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1932 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
|
1933 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1934 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
|
1935 used automatically to handle certain shades of gray. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1936 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1937 @item :underline |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1938 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
|
1939 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
|
1940 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
|
1941 value @code{nil} means do not underline. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1942 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1943 @item :overline |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1944 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
|
1945 The value is used like that of @code{:underline}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1946 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1947 @item :strike-through |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1948 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
|
1949 color. The value is used like that of @code{:underline}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1950 |
32089
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1951 @item :inherit |
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1952 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
|
1953 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
|
1954 underlying face would be, with higher priority than underlying faces. |
60958
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
1955 If a list of faces is used, attributes from faces earlier in the list |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
1956 override those from later faces. |
32089
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1957 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1958 @item :box |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1959 Whether or not a box should be drawn around characters, its color, the |
25875 | 1960 width of the box lines, and 3D appearance. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1961 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1962 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1963 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
|
1964 they mean: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1965 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1966 @table @asis |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1967 @item @code{nil} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1968 Don't draw a box. |
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 @code{t} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1971 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
|
1972 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1973 @item @var{color} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1974 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
|
1975 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1976 @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
|
1977 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
|
1978 @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
|
1979 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1980 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
|
1981 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
|
1982 color of the face for 3D boxes. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1983 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1984 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
|
1985 @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
|
1986 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
|
1987 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
|
1988 is used. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1989 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1990 |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1991 In older versions of Emacs, before @code{:family}, @code{:height}, |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1992 @code{:width}, @code{:weight}, and @code{:slant} existed, these |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1993 attributes were used to specify the type face. They are now |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1994 semi-obsolete, but they still work: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1995 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1996 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1997 @item :font |
25875 | 1998 This attribute specifies the font name. |
25751
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 :bold |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2001 A non-@code{nil} value specifies a bold font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2002 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2003 @item :italic |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2004 A non-@code{nil} value specifies an italic font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2005 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2006 |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
2007 For compatibility, you can still set these ``attributes'', even |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
2008 though they are not real face attributes. Here is what that does: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2009 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2010 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2011 @item :font |
25875 | 2012 You can specify an X font name as the ``value'' of this ``attribute''; |
2013 that sets the @code{:family}, @code{:width}, @code{:height}, | |
2014 @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
|
2015 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2016 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
|
2017 the pattern is used to set these attributes. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2018 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2019 @item :bold |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2020 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
|
2021 This actually works by setting the @code{:weight} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2022 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2023 @item :italic |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2024 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
|
2025 This actually works by setting the @code{:slant} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2026 @end table |
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 @defvar x-bitmap-file-path |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2029 This variable specifies a list of directories for searching |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2030 for bitmap files, for the @code{:stipple} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2031 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2032 |
25911
b192e4e3a9f5
Rename pixmap-spec-p to bitmap-spec-p.
Gerd Moellmann <gerd@gnu.org>
parents:
25875
diff
changeset
|
2033 @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
|
2034 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
|
2035 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
|
2036 @code{nil} otherwise. |
25875 | 2037 @end defun |
2038 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2039 @node Attribute Functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2040 @subsection Face Attribute Functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2041 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2042 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
|
2043 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
|
2044 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
|
2045 new frames. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2046 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2047 @tindex set-face-attribute |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2048 @defun set-face-attribute face frame &rest arguments |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2049 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
|
2050 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
|
2051 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
|
2052 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2053 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
|
2054 the values for them. They should consist of alternating attribute names |
25875 | 2055 (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
|
2056 Thus, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2057 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2058 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2059 (set-face-attribute 'foo nil |
46721
12862351ee03
Fix set-face-attribute example.
Richard M. Stallman <rms@gnu.org>
parents:
46338
diff
changeset
|
2060 :width 'extended |
12862351ee03
Fix set-face-attribute example.
Richard M. Stallman <rms@gnu.org>
parents:
46338
diff
changeset
|
2061 :weight 'bold |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2062 :underline "red") |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2063 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2064 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2065 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2066 sets the attributes @code{:width}, @code{:weight} and @code{:underline} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2067 to the corresponding values. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2068 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2069 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2070 @tindex face-attribute |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2071 @defun face-attribute face attribute &optional frame inherit |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2072 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
|
2073 @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
|
2074 that means the selected frame (@pxref{Input Focus}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2075 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2076 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
|
2077 @var{face} for new frames. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2078 |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2079 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
|
2080 @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
|
2081 @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
|
2082 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
|
2083 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
|
2084 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
|
2085 @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
|
2086 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
|
2087 absolute. |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2088 |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2089 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
|
2090 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
|
2091 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
|
2092 (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
|
2093 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2094 For example, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2095 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2096 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2097 (face-attribute 'bold :weight) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2098 @result{} bold |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2099 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2100 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2101 |
25875 | 2102 The functions above did not exist before Emacs 21. For compatibility |
2103 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
|
2104 and examine the face attributes which existed in those versions. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2105 |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2106 @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
|
2107 @defun face-attribute-relative-p attribute value |
54023 | 2108 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
|
2109 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
|
2110 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
|
2111 @end defun |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2112 |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2113 @tindex merge-face-attribute |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2114 @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
|
2115 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
|
2116 @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
|
2117 @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
|
2118 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
|
2119 @end defun |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2120 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2121 @defun set-face-foreground face color &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2122 @defunx set-face-background face color &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2123 These functions set the foreground (or background, respectively) color |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2124 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
|
2125 string, the name of a color. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2126 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2127 Certain shades of gray are implemented by stipple patterns on |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2128 black-and-white screens. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2129 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2130 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2131 @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
|
2132 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
|
2133 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
|
2134 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
|
2135 (@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
|
2136 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2137 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
|
2138 they are used automatically to handle certain shades of gray. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2139 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2140 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2141 @defun set-face-font face font &optional frame |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
2142 This function sets the font of face @var{face}. This actually sets |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
2143 the attributes @code{:family}, @code{:width}, @code{:height}, |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
2144 @code{:weight}, and @code{:slant} according to the font name |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
2145 @var{font}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2146 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2147 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2148 @defun set-face-bold-p face bold-p &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2149 This function specifies whether @var{face} should be bold. If |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2150 @var{bold-p} is non-@code{nil}, that means yes; @code{nil} means no. |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
2151 This actually sets the @code{:weight} attribute. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2152 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2153 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2154 @defun set-face-italic-p face italic-p &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2155 This function specifies whether @var{face} should be italic. If |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2156 @var{italic-p} is non-@code{nil}, that means yes; @code{nil} means no. |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
2157 This actually sets the @code{:slant} attribute. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2158 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2159 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2160 @defun set-face-underline-p face underline-p &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2161 This function sets the underline attribute of face @var{face}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2162 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
|
2163 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2164 |
65073
408e294257ab
(Attribute Functions): Add set-face-inverse-video-p.
Juri Linkov <juri@jurta.org>
parents:
64921
diff
changeset
|
2165 @defun set-face-inverse-video-p face inverse-video-p &optional frame |
408e294257ab
(Attribute Functions): Add set-face-inverse-video-p.
Juri Linkov <juri@jurta.org>
parents:
64921
diff
changeset
|
2166 This function sets the @code{:inverse-video} attribute of face |
408e294257ab
(Attribute Functions): Add set-face-inverse-video-p.
Juri Linkov <juri@jurta.org>
parents:
64921
diff
changeset
|
2167 @var{face}. |
408e294257ab
(Attribute Functions): Add set-face-inverse-video-p.
Juri Linkov <juri@jurta.org>
parents:
64921
diff
changeset
|
2168 @end defun |
408e294257ab
(Attribute Functions): Add set-face-inverse-video-p.
Juri Linkov <juri@jurta.org>
parents:
64921
diff
changeset
|
2169 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2170 @defun invert-face face &optional frame |
65073
408e294257ab
(Attribute Functions): Add set-face-inverse-video-p.
Juri Linkov <juri@jurta.org>
parents:
64921
diff
changeset
|
2171 This function swaps the foreground and background colors of face |
408e294257ab
(Attribute Functions): Add set-face-inverse-video-p.
Juri Linkov <juri@jurta.org>
parents:
64921
diff
changeset
|
2172 @var{face}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2173 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2174 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2175 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
|
2176 specify @var{frame}, they refer to the default data for new frames. |
25875 | 2177 They return the symbol @code{unspecified} if the face doesn't define any |
2178 value for that attribute. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2179 |
46245
fb42c0446cbf
Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents:
46240
diff
changeset
|
2180 @defun face-foreground face &optional frame inherit |
65073
408e294257ab
(Attribute Functions): Add set-face-inverse-video-p.
Juri Linkov <juri@jurta.org>
parents:
64921
diff
changeset
|
2181 @defunx face-background face &optional frame inherit |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2182 These functions return the foreground color (or background color, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2183 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
|
2184 |
54777 | 2185 If @var{inherit} is @code{nil}, only a color directly defined by the face is |
2186 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
|
2187 @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
|
2188 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
|
2189 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
|
2190 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
|
2191 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2192 |
46245
fb42c0446cbf
Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents:
46240
diff
changeset
|
2193 @defun face-stipple face &optional frame inherit |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2194 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
|
2195 @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
|
2196 |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2197 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
|
2198 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
|
2199 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
|
2200 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
|
2201 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
|
2202 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
|
2203 @var{inherit}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2204 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2205 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2206 @defun face-font face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2207 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
|
2208 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2209 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2210 @defun face-bold-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2211 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
|
2212 bolder than normal. It returns @code{nil} otherwise. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2213 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2214 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2215 @defun face-italic-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2216 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
|
2217 @code{nil} otherwise. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2218 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2219 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2220 @defun face-underline-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2221 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
|
2222 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2223 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2224 @defun face-inverse-video-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2225 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
|
2226 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2227 |
59277
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
2228 @node Displaying Faces |
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
2229 @subsection Displaying Faces |
6598 | 2230 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2231 Here are the ways to specify which faces to use for display of text: |
6598 | 2232 |
2233 @itemize @bullet | |
2234 @item | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2235 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
|
2236 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
|
2237 face is used only when no other face is specified.) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2238 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2239 @item |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2240 For a mode line or header line, the face @code{mode-line} or |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2241 @code{mode-line-inactive}, or @code{header-line}, is merged in just |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2242 before @code{default}. |
6598 | 2243 |
2244 @item | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2245 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
|
2246 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
|
2247 Properties}. |
6598 | 2248 |
2249 If the character has a @code{mouse-face} property, that is used instead | |
2250 of the @code{face} property when the mouse is ``near enough'' to the | |
2251 character. | |
2252 | |
2253 @item | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2254 With overlays. An overlay can have @code{face} and @code{mouse-face} |
6598 | 2255 properties too; they apply to all the text covered by the overlay. |
2256 | |
2257 @item | |
12098 | 2258 With a region that is active. In Transient Mark mode, the region is |
65075
88aad5396aac
(Standard Faces): Delete node.
Juri Linkov <juri@jurta.org>
parents:
65073
diff
changeset
|
2259 highlighted with the face @code{region} (@pxref{Standard Faces,,, |
88aad5396aac
(Standard Faces): Delete node.
Juri Linkov <juri@jurta.org>
parents:
65073
diff
changeset
|
2260 emacs, The GNU Emacs Manual}). |
12098 | 2261 |
2262 @item | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
2263 With special glyphs. Each glyph can specify a particular face |
6598 | 2264 number. @xref{Glyphs}. |
2265 @end itemize | |
2266 | |
2267 If these various sources together specify more than one face for a | |
2268 particular character, Emacs merges the attributes of the various faces | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2269 specified. For each attribute, Emacs tries first the face of any |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2270 special glyph; then the face for region highlighting, if appropriate; |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2271 then the faces specified by overlays, followed by those specified by |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2272 text properties, then the @code{mode-line} or |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2273 @code{mode-line-inactive} or @code{header-line} face (if in a mode |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2274 line or a header line), and last the @code{default} face. |
6598 | 2275 |
2276 When multiple overlays cover one character, an overlay with higher | |
2277 priority overrides those with lower priority. @xref{Overlays}. | |
2278 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2279 @node Font Selection |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2280 @subsection Font Selection |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2281 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2282 @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
|
2283 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
|
2284 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
|
2285 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
|
2286 it is. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2287 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2288 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
|
2289 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
|
2290 family, a font pattern is constructed. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2291 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2292 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
|
2293 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
|
2294 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
|
2295 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
|
2296 ``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
|
2297 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
|
2298 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
|
2299 try. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2300 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2301 @defvar face-font-selection-order |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2302 @tindex face-font-selection-order |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2303 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
|
2304 @code{:width}, @code{:height}, @code{:weight}, and @code{:slant}. The |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2305 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
|
2306 decreasing importance. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2307 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2308 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
|
2309 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
|
2310 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
|
2311 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2312 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
|
2313 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
|
2314 (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
|
2315 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
|
2316 non-normal faces contrast with normal ones, whenever possible. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2317 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2318 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
|
2319 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
|
2320 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
|
2321 and so on. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2322 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2323 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
|
2324 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
|
2325 @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
|
2326 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
|
2327 @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
|
2328 quite right. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2329 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2330 |
33373 | 2331 @defvar face-font-family-alternatives |
2332 @tindex face-font-family-alternatives | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2333 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
|
2334 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
|
2335 this form: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2336 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2337 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2338 (@var{family} @var{alternate-families}@dots{}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2339 @end example |
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 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
|
2342 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
|
2343 family that does exist. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2344 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2345 |
33373 | 2346 @defvar face-font-registry-alternatives |
2347 @tindex face-font-registry-alternatives | |
2348 This variable lets you specify alternative font registries to try, if a | |
2349 given registry is specified and doesn't exist. Each element should have | |
2350 this form: | |
2351 | |
2352 @example | |
2353 (@var{registry} @var{alternate-registries}@dots{}) | |
2354 @end example | |
2355 | |
2356 If @var{registry} is specified but not available, Emacs will try the | |
2357 other registries given in @var{alternate-registries}, one by one, | |
2358 until it finds a registry that does exist. | |
2359 @end defvar | |
2360 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2361 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
|
2362 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
|
2363 XFree86 servers. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2364 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2365 @defvar scalable-fonts-allowed |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2366 @tindex scalable-fonts-allowed |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2367 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
|
2368 @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
|
2369 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
|
2370 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2371 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
|
2372 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
|
2373 expression in the list. For example, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2374 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2375 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2376 (setq scalable-fonts-allowed '("muleindian-2$")) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2377 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2378 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2379 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2380 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
|
2381 @end defvar |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2382 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2383 @defun clear-face-cache &optional unload-p |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2384 @tindex clear-face-cache |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2385 This function clears the face cache for all frames. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2386 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
|
2387 all unused fonts as well. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2388 @end defun |
6598 | 2389 |
52002
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2390 @defvar face-font-rescale-alist |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2391 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
|
2392 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
|
2393 |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2394 @example |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2395 (@var{fontname-regexp} . @var{scale-factor}) |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2396 @end example |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2397 |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2398 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
|
2399 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
|
2400 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
|
2401 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
|
2402 nominal heights and widths would suggest. |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2403 @end defvar |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2404 |
6598 | 2405 @node Face Functions |
2406 @subsection Functions for Working with Faces | |
2407 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2408 Here are additional functions for creating and working with faces. |
6598 | 2409 |
2410 @defun make-face name | |
2411 This function defines a new face named @var{name}, initially with all | |
2412 attributes @code{nil}. It does nothing if there is already a face named | |
2413 @var{name}. | |
2414 @end defun | |
2415 | |
2416 @defun face-list | |
2417 This function returns a list of all defined face names. | |
2418 @end defun | |
2419 | |
2420 @defun copy-face old-face new-name &optional frame new-frame | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2421 This function defines a face named @var{new-name} as a copy of the existing |
6598 | 2422 face named @var{old-face}. It creates the face @var{new-name} if that |
2423 doesn't already exist. | |
2424 | |
2425 If the optional argument @var{frame} is given, this function applies | |
2426 only to that frame. Otherwise it applies to each frame individually, | |
2427 copying attributes from @var{old-face} in each frame to @var{new-face} | |
2428 in the same frame. | |
2429 | |
2430 If the optional argument @var{new-frame} is given, then @code{copy-face} | |
2431 copies the attributes of @var{old-face} in @var{frame} to @var{new-name} | |
2432 in @var{new-frame}. | |
2433 @end defun | |
2434 | |
12098 | 2435 @defun face-id face |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2436 This function returns the face number of face @var{face}. |
6598 | 2437 @end defun |
2438 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2439 @defun face-documentation face |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
2440 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
|
2441 @code{nil} if none was specified for it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
2442 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
2443 |
6598 | 2444 @defun face-equal face1 face2 &optional frame |
2445 This returns @code{t} if the faces @var{face1} and @var{face2} have the | |
2446 same attributes for display. | |
2447 @end defun | |
2448 | |
2449 @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
|
2450 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
|
2451 differently from the default face. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2452 @end defun |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2453 |
63659
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2454 @cindex face alias |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2455 A @dfn{face alias} provides an equivalent name for a face. You can |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2456 define a face alias by giving the alias symbol the @code{face-alias} |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2457 property, with a value of the target face name. The following example |
63734
8fd2b4f56556
(Face Functions): Correct Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
63733
diff
changeset
|
2458 makes @code{modeline} an alias for the @code{mode-line} face. |
63659
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2459 |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2460 @example |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2461 (put 'modeline 'face-alias 'mode-line) |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2462 @end example |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2463 |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2464 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2465 @node Auto Faces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2466 @subsection Automatic Face Assignment |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2467 @cindex automatic face assignment |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2468 @cindex faces, automatic choice |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2469 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2470 @cindex Font-Lock mode |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
2471 This hook is used for automatically assigning faces to text in the |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
2472 buffer. It is part of the implementation of Font-Lock mode. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2473 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2474 @tindex fontification-functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2475 @defvar fontification-functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2476 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
|
2477 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
|
2478 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2479 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
|
2480 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
|
2481 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
|
2482 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2483 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
|
2484 @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
|
2485 @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
|
2486 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
|
2487 already. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2488 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2489 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
|
2490 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
|
2491 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
|
2492 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
|
2493 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
|
2494 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2495 For efficiency, we recommend writing these functions so that they |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2496 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
|
2497 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2498 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2499 @node Font Lookup |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2500 @subsection Looking Up Fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2501 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2502 @defun x-list-fonts pattern &optional face frame maximum |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2503 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
|
2504 @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
|
2505 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
|
2506 @var{face} currently is on @var{frame}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2507 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2508 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
|
2509 characters: the @samp{*} character matches any substring, and the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2510 @samp{?} character matches any single character. Pattern matching |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2511 of font names ignores case. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2512 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2513 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
|
2514 (a symbol) and @var{frame} should be a frame. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2515 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2516 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
|
2517 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
|
2518 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
|
2519 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
|
2520 many fonts match the pattern. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2521 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2522 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2523 @defun x-family-fonts &optional family frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2524 @tindex x-family-fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2525 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
|
2526 @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
|
2527 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
|
2528 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
|
2529 contain the wildcards @samp{?} and @samp{*}. |
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 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
|
2532 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
|
2533 (@pxref{Input Focus}). |
25751
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 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
|
2536 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2537 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2538 [@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
|
2539 @var{fixed-p} @var{full} @var{registry-and-encoding}] |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2540 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2541 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2542 The first five elements correspond to face attributes; if you |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2543 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
|
2544 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2545 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
|
2546 @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
|
2547 @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
|
2548 @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
|
2549 encoding of the font. |
25751
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 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
|
2552 @end defun |
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-font-family-list &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2555 @tindex x-font-family-list |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2556 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
|
2557 @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
|
2558 describes the selected frame's display (@pxref{Input Focus}). |
25751
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 value is a list of elements of this form: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2561 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2562 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2563 (@var{family} . @var{fixed-p}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2564 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2565 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2566 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2567 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
|
2568 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
|
2569 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2570 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2571 @defvar font-list-limit |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2572 @tindex font-list-limit |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2573 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
|
2574 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
|
2575 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
|
2576 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
|
2577 currently 100. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2578 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2579 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2580 @node Fontsets |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2581 @subsection Fontsets |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2582 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2583 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
|
2584 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
|
2585 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
|
2586 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
|
2587 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
|
2588 information about defining a fontset under Lisp program control. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2589 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2590 @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
|
2591 This function defines a new fontset according to the specification |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2592 string @var{fontset-spec}. The string should have this format: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2593 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2594 @smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2595 @var{fontpattern}, @r{[}@var{charsetname}:@var{fontname}@r{]@dots{}} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2596 @end smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2597 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2598 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2599 Whitespace characters before and after the commas are ignored. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2600 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2601 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
|
2602 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
|
2603 @samp{fontset-@var{alias}}. |
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 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
|
2606 @var{fontpattern} in its entirety. The short name is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2607 @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
|
2608 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
|
2609 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
|
2610 function does nothing. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2611 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2612 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
|
2613 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
|
2614 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
|
2615 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
|
2616 status. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2617 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2618 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
|
2619 See below for the details. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2620 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2621 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2622 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
|
2623 use (in this fontset) for one particular character set. Here, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2624 @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
|
2625 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
|
2626 times in the specification string. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2627 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2628 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
|
2629 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
|
2630 @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
|
2631 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
|
2632 with @samp{ISO8859-1}. |
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 In addition, when several consecutive fields are wildcards, Emacs |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2635 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
|
2636 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
|
2637 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
|
2638 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
|
2639 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2640 Thus if @var{fontpattern} is this, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2641 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2642 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2643 -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2644 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2645 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2646 @noindent |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52940
diff
changeset
|
2647 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
|
2648 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2649 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2650 -*-fixed-medium-r-normal-*-24-*-ISO8859-1 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2651 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2652 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2653 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2654 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
|
2655 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2656 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2657 -*-fixed-medium-r-normal-*-24-*-gb2312*-* |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2658 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2659 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2660 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
|
2661 specification. Most X distributions include only Chinese fonts that |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2662 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
|
2663 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
|
2664 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2665 @smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2666 Emacs.Fontset-0: -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24,\ |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2667 chinese-gb2312:-*-*-medium-r-normal-*-24-*-gb2312*-* |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2668 @end smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2669 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2670 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2671 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
|
2672 @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
|
2673 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
|
2674 field. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2675 |
52932
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2676 @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
|
2677 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
|
2678 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
|
2679 |
52940
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2680 If @var{name} is @code{nil}, this function modifies the default |
54023 | 2681 fontset, whose short name is @samp{fontset-default}. |
52940
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2682 |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2683 @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
|
2684 @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
|
2685 @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
|
2686 (inclusive). |
52932
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2687 |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2688 @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
|
2689 @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
|
2690 |
52940
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2691 @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
|
2692 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
|
2693 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
|
2694 (possibly including an encoding name at the tail). |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2695 |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2696 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
|
2697 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
|
2698 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
|
2699 |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
2700 @smallexample |
52932
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2701 (set-fontset-font nil 'japanese-jisx0208 '(nil . "JISX0208.1983")) |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
2702 @end smallexample |
52932
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2703 @end defun |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2704 |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2705 @defun char-displayable-p char |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2706 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
|
2707 @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
|
2708 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
|
2709 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2710 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
|
2711 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
|
2712 @end defun |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2713 |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2714 @node Fringes |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2715 @section Fringes |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2716 @cindex Fringes |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2717 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2718 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
|
2719 sides that are used for displaying bitmaps that indicate truncation, |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2720 continuation, horizontal scrolling, and the overlay arrow. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2721 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2722 @menu |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2723 * Fringe Size/Pos:: Specifying where to put the window fringes. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2724 * Fringe Bitmaps:: Displaying bitmaps in the window fringes. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2725 * Customizing Bitmaps:: Specifying your own bitmaps to use in the fringes. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2726 * Overlay Arrow:: Display of an arrow to indicate position. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2727 @end menu |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2728 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2729 @node Fringe Size/Pos |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2730 @subsection Fringe Size and Position |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2731 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2732 Here's how to control the position and width of the window fringes. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2733 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2734 @defvar fringes-outside-margins |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2735 If the value is non-@code{nil}, the frames appear outside the display |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2736 margins. The fringes normally appear between the display margins and |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2737 the window text. It works to set @code{fringes-outside-margins} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2738 buffer-locally. @xref{Display Margins}. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2739 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2740 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2741 @defvar left-fringe-width |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2742 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
|
2743 fringe in pixels. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2744 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2745 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2746 @defvar right-fringe-width |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2747 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
|
2748 fringe in pixels. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2749 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2750 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2751 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
|
2752 buffer in a window. If you change them while the buffer is visible, |
54023 | 2753 you can call @code{set-window-buffer} to display it once again in the |
2754 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
|
2755 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2756 @defun set-window-fringes window left &optional right outside-margins |
54023 | 2757 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
|
2758 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
|
2759 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2760 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
|
2761 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
|
2762 @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
|
2763 @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
|
2764 should appear outside of the display margins. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2765 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2766 |
53929
3ef7a4a3c230
(Fringes): Use consistent wording.
Kim F. Storm <storm@cua.dk>
parents:
53829
diff
changeset
|
2767 @defun window-fringes &optional window |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2768 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
|
2769 @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
|
2770 window is used. The value has the form @code{(@var{left-width} |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2771 @var{right-width} @var{outside-margins})}. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2772 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2773 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2774 @defvar overflow-newline-into-fringe |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2775 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
|
2776 counting the final newline character) are not continued. Instead, |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2777 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
|
2778 fringe. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2779 @end defvar |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2780 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2781 @node Fringe Bitmaps |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2782 @subsection Fringe Bitmaps |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2783 @cindex fringe bitmaps |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2784 @cindex bitmaps, fringe |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2785 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2786 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
|
2787 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
|
2788 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
|
2789 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
|
2790 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
|
2791 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2792 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
|
2793 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
|
2794 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
|
2795 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
|
2796 @code{(right-fringe @var{bitmap} [@var{face}])} (@pxref{Display |
60958
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2797 Property}). Here, @var{bitmap} is a symbol identifying the bitmap you |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2798 want, and @var{face} (which is optional) is the name of the face whose |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2799 colors should be used for displaying the bitmap, instead of the |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2800 default @code{fringe} face. @var{face} is automatically merged with |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2801 the @code{fringe} face, so normally @var{face} need only specify the |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2802 foreground color for the bitmap. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2803 |
63733
7cbe9f7cc3cc
(Face Functions): Correct Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
63691
diff
changeset
|
2804 These symbols identify the standard fringe bitmaps. Evaluate |
7cbe9f7cc3cc
(Face Functions): Correct Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
63691
diff
changeset
|
2805 @code{(require 'fringe)} to define them. Fringe bitmap symbols have |
7cbe9f7cc3cc
(Face Functions): Correct Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
63691
diff
changeset
|
2806 their own name space. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2807 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2808 @table @asis |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2809 @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
|
2810 @code{left-truncation}, @code{right-truncation}, |
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2811 @code{continued-line}, @code{continuation-line}. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2812 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2813 @item Buffer indication bitmaps: |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2814 @code{up-arrow}, @code{down-arrow}, |
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2815 @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
|
2816 @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
|
2817 @code{left-bracket}, @code{right-bracket}. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2818 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2819 @item Empty line indication bitmap: |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2820 @code{empty-line}. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2821 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2822 @item Overlay arrow bitmap: |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2823 @code{overlay-arrow}. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2824 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2825 @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
|
2826 @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
|
2827 @code{bar-cursor}, @code{hbar-cursor}. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2828 @end table |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2829 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2830 @defun fringe-bitmaps-at-pos &optional pos window |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2831 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
|
2832 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
|
2833 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
|
2834 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
|
2835 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
|
2836 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
|
2837 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2838 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
|
2839 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
|
2840 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
|
2841 @var{window}. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2842 @end defun |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2843 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2844 @node Customizing Bitmaps |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2845 @subsection Customizing Fringe Bitmaps |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2846 |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2847 @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
|
2848 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
|
2849 or replaces an existing bitmap with that name. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2850 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2851 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
|
2852 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
|
2853 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
|
2854 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
|
2855 to the rightmost pixel of the bitmap. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2856 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2857 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
|
2858 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
|
2859 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
|
2860 @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
|
2861 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2862 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
|
2863 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
|
2864 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
|
2865 or @code{bottom}. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2866 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2867 The @var{align} argument may also be a list @code{(@var{align} |
57225 | 2868 @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
|
2869 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
|
2870 @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
|
2871 height. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2872 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2873 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
|
2874 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
|
2875 this bitmap. |
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2876 |
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
2877 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
|
2878 @end defun |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2879 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2880 @defun destroy-fringe-bitmap bitmap |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2881 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
|
2882 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
|
2883 restores the standard definition of that bitmap, instead of |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2884 eliminating it entirely. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2885 @end defun |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2886 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2887 @defun set-fringe-bitmap-face bitmap &optional face |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2888 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
|
2889 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
|
2890 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
|
2891 |
60958
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2892 @var{face} is merged with the @code{fringe} face, so normally |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2893 @var{face} should specify only the foreground color. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2894 @end defun |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2895 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2896 @node Overlay Arrow |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2897 @subsection The Overlay Arrow |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2898 @cindex overlay arrow |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2899 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2900 The @dfn{overlay arrow} is useful for directing the user's attention |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2901 to a particular line in a buffer. For example, in the modes used for |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2902 interface to debuggers, the overlay arrow indicates the line of code |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2903 about to be executed. This feature has nothing to do with |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2904 @dfn{overlays} (@pxref{Overlays}). |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2905 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2906 @defvar overlay-arrow-string |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2907 This variable holds the string to display to call attention to a |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2908 particular line, or @code{nil} if the arrow feature is not in use. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2909 On a graphical display the contents of the string are ignored; instead a |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2910 glyph is displayed in the fringe area to the left of the display area. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2911 @end defvar |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2912 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2913 @defvar overlay-arrow-position |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2914 This variable holds a marker that indicates where to display the overlay |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2915 arrow. It should point at the beginning of a line. On a non-graphical |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2916 display the arrow text |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2917 appears at the beginning of that line, overlaying any text that would |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2918 otherwise appear. Since the arrow is usually short, and the line |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2919 usually begins with indentation, normally nothing significant is |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2920 overwritten. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2921 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2922 The overlay string is displayed only in the buffer that this marker |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2923 points into. Thus, only one buffer can have an overlay arrow at any |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2924 given time. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2925 @c !!! overlay-arrow-position: but the overlay string may remain in the display |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2926 @c of some other buffer until an update is required. This should be fixed |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2927 @c now. Is it? |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2928 @end defvar |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2929 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2930 You can do a similar job by creating an overlay with a |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2931 @code{before-string} property. @xref{Overlay Properties}. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2932 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2933 You can define multiple overlay arrows via the variable |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2934 @code{overlay-arrow-variable-list}. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2935 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2936 @defvar overlay-arrow-variable-list |
61980
f3d536670495
Fix typos and Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61972
diff
changeset
|
2937 This variable's value is a list of variables, each of which specifies |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2938 the position of an overlay arrow. The variable |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2939 @code{overlay-arrow-position} has its normal meaning because it is on |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2940 this list. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2941 @end defvar |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2942 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2943 Each variable on this list can have properties |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2944 @code{overlay-arrow-string} and @code{overlay-arrow-bitmap} that |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2945 specify an overlay arrow string (for text-only terminals) or fringe |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2946 bitmap (for graphical terminals) to display at the corresponding |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2947 overlay arrow position. If either property is not set, the default |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2948 (@code{overlay-arrow-string} or @code{overlay-arrow-fringe-bitmap}) is |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2949 used. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2950 |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2951 @node Scroll Bars |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2952 @section Scroll Bars |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2953 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2954 Normally the frame parameter @code{vertical-scroll-bars} controls |
60958
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2955 whether the windows in the frame have vertical scroll bars, and |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2956 whether they are on the left or right. The frame parameter |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2957 @code{scroll-bar-width} specifies how wide they are (@code{nil} |
64877
573bd827cef9
(Line Height, Scroll Bars): Fix xrefs.
Richard M. Stallman <rms@gnu.org>
parents:
64841
diff
changeset
|
2958 meaning the default). @xref{Layout Parameters}. |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2959 |
60958
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2960 @defun frame-current-scroll-bars &optional frame |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2961 This function reports the scroll bar type settings for frame |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2962 @var{frame}. The value is a cons cell |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2963 @code{(@var{vertical-type} .@: @var{horizontal-type})}, where |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2964 @var{vertical-type} is either @code{left}, @code{right}, or @code{nil} |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2965 (which means no scroll bar.) @var{horizontal-type} is meant to |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2966 specify the horizontal scroll bar type, but since they are not |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2967 implemented, it is always @code{nil}. |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2968 @end defun |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
2969 |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
2970 @vindex vertical-scroll-bar |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
2971 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
|
2972 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
|
2973 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
|
2974 @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
|
2975 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
|
2976 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
2977 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
|
2978 @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
|
2979 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2980 @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
|
2981 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
|
2982 @var{window}. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2983 |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2984 @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
|
2985 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
|
2986 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
|
2987 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
|
2988 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
|
2989 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2990 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
|
2991 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
|
2992 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
|
2993 selected window is used. |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2994 @end defun |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2995 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2996 @defun window-scroll-bars &optional window |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2997 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
|
2998 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
|
2999 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
|
3000 @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
|
3001 @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
|
3002 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
|
3003 bar actually occupies. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3004 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3005 @var{horizontal-type} is not actually meaningful. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3006 @end defun |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3007 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3008 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
|
3009 @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
|
3010 @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
|
3011 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
|
3012 @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
|
3013 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
|
3014 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
|
3015 specifying the same buffer that is already displayed. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3016 |
58496
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3017 @defvar scroll-bar-mode |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3018 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
|
3019 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
|
3020 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
|
3021 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
|
3022 @end defvar |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3023 |
60958
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3024 @defun window-current-scroll-bars &optional window |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3025 This function reports the scroll bar type for window @var{window}. |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3026 If @var{window} is omitted or @code{nil}, the selected window is used. |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3027 The value is a cons cell |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3028 @code{(@var{vertical-type} .@: @var{horizontal-type})}. Unlike |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3029 @code{window-scroll-bars}, this reports the scroll bar type actually |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3030 used, once frame defaults and @code{scroll-bar-mode} are taken into |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3031 account. |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3032 @end defun |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3033 |
58496
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3034 @defvar scroll-bar-width |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3035 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
|
3036 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
|
3037 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
|
3038 @end defvar |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3039 |
57201
2950fcfcfa44
Correct various typos.
Luc Teirlinck <teirllm@auburn.edu>
parents:
57193
diff
changeset
|
3040 @node Pointer Shape |
2950fcfcfa44
Correct various typos.
Luc Teirlinck <teirllm@auburn.edu>
parents:
57193
diff
changeset
|
3041 @section Pointer Shape |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3042 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3043 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
|
3044 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
|
3045 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
|
3046 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
|
3047 @code{:pointer} and @code{:map} image properties. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3048 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3049 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
|
3050 @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
|
3051 @code{modeline}, and @code{hourglass}. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3052 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3053 @defvar void-text-area-pointer |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3054 @tindex void-text-area-pointer |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3055 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
|
3056 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
|
3057 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
|
3058 @end defvar |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3059 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3060 @node Display Property |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3061 @section The @code{display} Property |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3062 @cindex display specification |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3063 @kindex display @r{(text property)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3064 |
25875 | 3065 The @code{display} text property (or overlay property) is used to |
3066 insert images into text, and also control other aspects of how text | |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
3067 displays. The value of the @code{display} property should be a |
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
3068 display specification, or a list or vector containing several display |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3069 specifications. |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3070 |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3071 Some kinds of @code{display} properties specify something to display |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3072 instead of the text that has the property. In this case, ``the text'' |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3073 means all the consecutive characters that have the same Lisp object as |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3074 their @code{display} property; these characters are replaced as a |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3075 single unit. By contrast, characters that have similar but distinct |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3076 Lisp objects as their @code{display} properties are handled |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3077 separately. Here's a function that illustrates this point: |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3078 |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3079 @smallexample |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3080 (defun foo () |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3081 (goto-char (point-min)) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3082 (dotimes (i 5) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3083 (let ((string (concat "A"))) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3084 (put-text-property (point) (1+ (point)) 'display string) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3085 (forward-char 1) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3086 (put-text-property (point) (1+ (point)) 'display string) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3087 (forward-char 1)))) |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3088 @end smallexample |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3089 |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3090 @noindent |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3091 It gives each of the first ten characters in the buffer string |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3092 @code{"A"} as the @code{display} property, but they don't all get the |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3093 same string. The first two characters get the same string, so they |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3094 together are replaced with one @samp{A}. The next two characters get |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3095 a second string, so they together are replaced with one @samp{A}. |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3096 Likewise for each following pair of characters. Thus, the ten |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3097 characters appear as five A's. This function would have the same |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3098 results: |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3099 |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3100 @smallexample |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3101 (defun foo () |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3102 (goto-char (point-min)) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3103 (dotimes (i 5) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3104 (let ((string (concat "A"))) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3105 (put-text-property (point) (2+ (point)) 'display string) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3106 (put-text-property (point) (1+ (point)) 'display string) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3107 (forward-char 2)))) |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3108 @end smallexample |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3109 |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3110 @noindent |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3111 This illustrates that what matters is the property value for |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3112 each character. If two consecutive characters have the same |
61980
f3d536670495
Fix typos and Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61972
diff
changeset
|
3113 object as the @code{display} property value, it's irrelevant |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3114 whether they got this property from a single call to |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3115 @code{put-text-property} or from two different calls. |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3116 |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3117 The rest of this section describes several kinds of |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
3118 display specifications and what they mean. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3119 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3120 @menu |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3121 * 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
|
3122 * 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
|
3123 * Other Display Specs:: Displaying an image; magnifying text; moving it |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
3124 up or down on the page; adjusting the width |
25875 | 3125 of spaces within text. |
3126 * Display Margins:: Displaying text or images to the side of the main text. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3127 @end menu |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3128 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3129 @node Specified Space |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3130 @subsection Specified Spaces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3131 @cindex spaces, specified height or width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3132 @cindex specified spaces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3133 @cindex variable-width spaces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3134 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3135 To display a space of specified width and/or height, use a display |
25875 | 3136 specification of the form @code{(space . @var{props})}, where |
3137 @var{props} is a property list (a list of alternating properties and | |
3138 values). You can put this property on one or more consecutive | |
3139 characters; a space of the specified height and width is displayed in | |
3140 place of @emph{all} of those characters. These are the properties you | |
44281 | 3141 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
|
3142 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3143 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3144 @item :width @var{width} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3145 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
|
3146 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
|
3147 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
|
3148 (@pxref{Pixel Specification}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3149 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3150 @item :relative-width @var{factor} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3151 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
|
3152 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
|
3153 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
|
3154 character, multiplied by @var{factor}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3155 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3156 @item :align-to @var{hpos} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3157 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
|
3158 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
|
3159 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
|
3160 specification (@pxref{Pixel Specification}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3161 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3162 |
44281 | 3163 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
|
3164 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
|
3165 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3166 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3167 @item :height @var{height} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3168 Specifies the height of the space. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3169 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
|
3170 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
|
3171 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
|
3172 (@pxref{Pixel Specification}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3173 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3174 @item :relative-height @var{factor} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3175 Specifies the height of the space, multiplying the ordinary height |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3176 of the text having this display specification by @var{factor}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3177 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3178 @item :ascent @var{ascent} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3179 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
|
3180 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
|
3181 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
|
3182 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
|
3183 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
|
3184 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3185 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3186 |
44281 | 3187 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
|
3188 |
60509
b6fee46c2fad
(Specified Space): Property :width is support on
Kim F. Storm <storm@cua.dk>
parents:
60503
diff
changeset
|
3189 The @code{:width} and @code{:align-to} properties are supported on |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3190 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
|
3191 are not. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3192 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3193 @node Pixel Specification |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3194 @subsection Pixel Specification for Spaces |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3195 @cindex spaces, pixel specification |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3196 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3197 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
|
3198 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
|
3199 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
|
3200 as an absolute number of pixels. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3201 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3202 The following expressions are supported: |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3203 |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3204 @smallexample |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3205 @group |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
3206 @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
|
3207 @var{num} ::= @var{integer} | @var{float} | @var{symbol} |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3208 @var{unit} ::= in | mm | cm | width | height |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3209 @end group |
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3210 @group |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3211 @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
|
3212 | scroll-bar | text |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3213 @var{pos} ::= left | center | right |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3214 @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
|
3215 @var{op} ::= + | - |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3216 @end group |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3217 @end smallexample |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3218 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3219 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
|
3220 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
|
3221 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
|
3222 buffer-local variable binding is used. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3223 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3224 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
|
3225 pixels per inch, millimeter, and centimeter, respectively. The |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3226 @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
|
3227 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
|
3228 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
|
3229 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3230 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
|
3231 @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
|
3232 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
|
3233 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3234 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
|
3235 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
|
3236 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
|
3237 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3238 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
|
3239 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
|
3240 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
|
3241 position has been set (by the first occurrence of one of these |
57225 | 3242 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
|
3243 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
|
3244 the left-margin, use |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3245 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3246 @example |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3247 :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
|
3248 @end example |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3249 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3250 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
|
3251 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
|
3252 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
|
3253 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3254 A value of the form @code{(@var{num} . @var{expr})} stands for the |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3255 product of the values of @var{num} and @var{expr}. For example, |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3256 @code{(2 . in)} specifies a width of 2 inches, while @code{(0.5 . |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3257 @var{image})} specifies half the width (or height) of the specified |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3258 image. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3259 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3260 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
|
3261 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
|
3262 the value of the expressions. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3263 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3264 @node Other Display Specs |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3265 @subsection Other Display Specifications |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3266 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3267 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
|
3268 in the @code{display} text property. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3269 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3270 @table @code |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3271 @item @var{string} |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3272 Display @var{string} instead of the text that has this property. |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3273 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3274 @item (image . @var{image-props}) |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3275 This kind of display specification is an image descriptor (@pxref{Images}). |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3276 When used as a display specification, it means to display the image |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3277 instead of the text that has the display specification. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3278 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3279 @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
|
3280 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
|
3281 (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
|
3282 @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
|
3283 @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
|
3284 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
|
3285 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
|
3286 of the entire image. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3287 |
32467 | 3288 @item ((margin nil) @var{string}) |
3289 @itemx @var{string} | |
3290 A display specification of this form means to display @var{string} | |
3291 instead of the text that has the display specification, at the same | |
3292 position as that text. This is a special case of marginal display | |
3293 (@pxref{Display Margins}). | |
3294 | |
44281 | 3295 Recursive display specifications are not supported---string display |
3296 specifications must not have @code{display} properties themselves. | |
36935 | 3297 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3298 @item (space-width @var{factor}) |
25875 | 3299 This display specification affects all the space characters within the |
3300 text that has the specification. It displays all of these spaces | |
3301 @var{factor} times as wide as normal. The element @var{factor} should | |
3302 be an integer or float. Characters other than spaces are not affected | |
3303 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
|
3304 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3305 @item (height @var{height}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3306 This display specification makes the text taller or shorter. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3307 Here are the possibilities for @var{height}: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3308 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3309 @table @asis |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3310 @item @code{(+ @var{n})} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3311 This means to use a font that is @var{n} steps larger. A ``step'' is |
25875 | 3312 defined by the set of available fonts---specifically, those that match |
3313 what was otherwise specified for this text, in all attributes except | |
3314 height. Each size for which a suitable font is available counts as | |
3315 another step. @var{n} should be an integer. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3316 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3317 @item @code{(- @var{n})} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3318 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
|
3319 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3320 @item a number, @var{factor} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3321 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
|
3322 as tall as the default font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3323 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3324 @item a symbol, @var{function} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3325 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
|
3326 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
|
3327 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3328 @item anything else, @var{form} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3329 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
|
3330 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
|
3331 @code{height} bound to the current specified font height. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3332 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3333 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3334 @item (raise @var{factor}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3335 This kind of display specification raises or lowers the text |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3336 it applies to, relative to the baseline of the line. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3337 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3338 @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
|
3339 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
|
3340 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
|
3341 lower down. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3342 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3343 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
|
3344 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
|
3345 faces used for the text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3346 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3347 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3348 You can make any display specification conditional. To do that, |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3349 package it in another list of the form @code{(when @var{condition} . |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3350 @var{spec})}. Then the specification @var{spec} applies only when |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3351 @var{condition} evaluates to a non-@code{nil} value. During the |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3352 evaluation, @code{object} is bound to the string or buffer having the |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3353 conditional @code{display} property. @code{position} and |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3354 @code{buffer-position} are bound to the position within @code{object} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3355 and the buffer position where the @code{display} property was found, |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3356 respectively. Both positions can be different when @code{object} is a |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3357 string. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3358 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3359 @node Display Margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3360 @subsection Displaying in the Margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3361 @cindex display margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3362 @cindex margins, display |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3363 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3364 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
|
3365 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
|
3366 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
|
3367 property. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3368 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3369 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
|
3370 display specification of the form @code{(margin right-margin)} or |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3371 @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
|
3372 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
|
3373 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
|
3374 text or images in the margin mouse-sensitive. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3375 |
42297
c4f9d48801a8
Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents:
42082
diff
changeset
|
3376 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
|
3377 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
|
3378 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
|
3379 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
|
3380 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
|
3381 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
|
3382 before-string. |
c4f9d48801a8
Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents:
42082
diff
changeset
|
3383 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3384 Before the display margins can display anything, you must give |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3385 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
|
3386 variables: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3387 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3388 @defvar left-margin-width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3389 @tindex left-margin-width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3390 This variable specifies the width of the left margin. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3391 It is buffer-local in all buffers. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3392 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3393 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3394 @defvar right-margin-width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3395 @tindex right-margin-width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3396 This variable specifies the width of the right margin. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3397 It is buffer-local in all buffers. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3398 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3399 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3400 Setting these variables does not immediately affect the window. These |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3401 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
|
3402 Thus, you can make changes take effect by calling |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3403 @code{set-window-buffer}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3404 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3405 You can also set the margin widths immediately. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3406 |
36935 | 3407 @defun set-window-margins window left &optional right |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3408 @tindex set-window-margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3409 This function specifies the margin widths for window @var{window}. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
3410 The argument @var{left} controls the left margin and |
36935 | 3411 @var{right} controls the right margin (default @code{0}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3412 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3413 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3414 @defun window-margins &optional window |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3415 @tindex window-margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3416 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
|
3417 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
|
3418 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
|
3419 @end defun |
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 Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3422 @section Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3423 @cindex images in buffers |
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 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
|
3426 descriptor, then use it as a display specifier in the @code{display} |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
3427 property of text that is displayed (@pxref{Display Property}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3428 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3429 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
|
3430 are supported only if particular support libraries are installed on |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3431 your machine. In some environments, Emacs can load image |
56109
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3432 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
|
3433 can be used to modify the set of known names for these dynamic |
57225 | 3434 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
|
3435 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3436 The supported image formats include XBM, XPM (this requires the |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3437 libraries @code{libXpm} version 3.4k and @code{libz}), GIF (requiring |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3438 @code{libungif} 4.1.0), Postscript, PBM, JPEG (requiring the |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3439 @code{libjpeg} library version v6a), TIFF (requiring @code{libtiff} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3440 v3.4), and PNG (requiring @code{libpng} 1.0.2). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3441 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3442 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
|
3443 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
|
3444 @code{pbm}, @code{jpeg}, @code{tiff}, and @code{png}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3445 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3446 @defvar image-types |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3447 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
|
3448 potentially supported in the current configuration. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3449 @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
|
3450 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
|
3451 unavailable dynamic libraries, for example). |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3452 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3453 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
|
3454 @code{image-type-available-p}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3455 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3456 |
56109
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3457 @defvar image-library-alist |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3458 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
|
3459 display them. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3460 |
56437
bd1f1cbf959f
(Images): Fix Texinfo usage.
Juanma Barranquero <lekktu@gmail.com>
parents:
56233
diff
changeset
|
3461 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
|
3462 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
|
3463 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
|
3464 external libraries to load. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3465 |
56185
4f36c90f5404
(Images): Remove redundant @vindex directives.
Juanma Barranquero <lekktu@gmail.com>
parents:
56109
diff
changeset
|
3466 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
|
3467 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
|
3468 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
|
3469 they're always supported. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3470 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3471 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
|
3472 into Emacs. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3473 @end defvar |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3474 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3475 @defun image-type-available-p type |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3476 @findex image-type-available-p |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3477 |
56437
bd1f1cbf959f
(Images): Fix Texinfo usage.
Juanma Barranquero <lekktu@gmail.com>
parents:
56233
diff
changeset
|
3478 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
|
3479 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
|
3480 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
|
3481 @code{image-types}. |
56109
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3482 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3483 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
|
3484 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
|
3485 @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
|
3486 @end defun |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3487 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3488 @menu |
25875 | 3489 * Image Descriptors:: How to specify an image for use in @code{:display}. |
3490 * XBM Images:: Special features for XBM format. | |
3491 * XPM Images:: Special features for XPM format. | |
3492 * GIF Images:: Special features for GIF format. | |
3493 * Postscript Images:: Special features for Postscript format. | |
3494 * Other Image Types:: Various other formats are supported. | |
3495 * Defining Images:: Convenient ways to define an image for later use. | |
3496 * Showing Images:: Convenient ways to display an image once it is defined. | |
3497 * Image Cache:: Internal mechanisms of image display. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3498 @end menu |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3499 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3500 @node Image Descriptors |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3501 @subsection Image Descriptors |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3502 @cindex image descriptor |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3503 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3504 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
|
3505 . @var{props})}, where @var{props} is a property list containing |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3506 alternating keyword symbols (symbols whose names start with a colon) and |
26400 | 3507 their values. You can use any Lisp object as a property, but the only |
3508 properties that have any special meaning are certain symbols, all of | |
3509 them keywords. | |
3510 | |
3511 Every image descriptor must contain the property @code{:type | |
3512 @var{type}} to specify the format of the image. The value of @var{type} | |
3513 should be an image type symbol; for example, @code{xpm} for an image in | |
3514 XPM format. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3515 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3516 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
|
3517 types: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3518 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3519 @table @code |
36730
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3520 @item :file @var{file} |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3521 The @code{:file} property says to load the image from file |
36730
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3522 @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
|
3523 in @code{data-directory}. |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3524 |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3525 @item :data @var{data} |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3526 The @code{:data} property says the actual contents of the image. |
36730
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3527 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
|
3528 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
|
3529 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
|
3530 |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3531 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
|
3532 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
|
3533 @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
|
3534 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
|
3535 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
|
3536 |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3537 @item :margin @var{margin} |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3538 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
|
3539 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
|
3540 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
|
3541 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
|
3542 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
|
3543 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
|
3544 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3545 @item :ascent @var{ascent} |
29151 | 3546 The @code{:ascent} property specifies the amount of the image's |
3547 height to use for its ascent---that is, the part above the baseline. | |
3548 The value, @var{ascent}, must be a number in the range 0 to 100, or | |
3549 the symbol @code{center}. | |
3550 | |
3551 If @var{ascent} is a number, that percentage of the image's height is | |
3552 used for its ascent. | |
3553 | |
3554 If @var{ascent} is @code{center}, the image is vertically centered | |
3555 around a centerline which would be the vertical centerline of text drawn | |
3556 at the position of the image, in the manner specified by the text | |
3557 properties and overlays that apply to the image. | |
3558 | |
3559 If this property is omitted, it defaults to 50. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3560 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3561 @item :relief @var{relief} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3562 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
|
3563 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
|
3564 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
|
3565 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
|
3566 an unpressed button. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3567 |
35364 | 3568 @item :conversion @var{algorithm} |
3569 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
|
3570 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
|
3571 displayed; the value, @var{algorithm}, specifies which algorithm. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3572 |
33996 | 3573 @table @code |
3574 @item laplace | |
3575 @itemx emboss | |
3576 Specifies the Laplace edge detection algorithm, which blurs out small | |
3577 differences in color while highlighting larger differences. People | |
3578 sometimes consider this useful for displaying the image for a | |
3579 ``disabled'' button. | |
3580 | |
3581 @item (edge-detection :matrix @var{matrix} :color-adjust @var{adjust}) | |
3582 Specifies a general edge-detection algorithm. @var{matrix} must be | |
3583 either a nine-element list or a nine-element vector of numbers. A pixel | |
3584 at position @math{x/y} in the transformed image is computed from | |
3585 original pixels around that position. @var{matrix} specifies, for each | |
3586 pixel in the neighborhood of @math{x/y}, a factor with which that pixel | |
3587 will influence the transformed pixel; element @math{0} specifies the | |
3588 factor for the pixel at @math{x-1/y-1}, element @math{1} the factor for | |
3589 the pixel at @math{x/y-1} etc., as shown below: | |
3590 @iftex | |
3591 @tex | |
3592 $$\pmatrix{x-1/y-1 & x/y-1 & x+1/y-1 \cr | |
3593 x-1/y & x/y & x+1/y \cr | |
3594 x-1/y+1& x/y+1 & x+1/y+1 \cr}$$ | |
3595 @end tex | |
3596 @end iftex | |
3597 @ifnottex | |
3598 @display | |
3599 (x-1/y-1 x/y-1 x+1/y-1 | |
3600 x-1/y x/y x+1/y | |
3601 x-1/y+1 x/y+1 x+1/y+1) | |
3602 @end display | |
3603 @end ifnottex | |
3604 | |
3605 The resulting pixel is computed from the color intensity of the color | |
3606 resulting from summing up the RGB values of surrounding pixels, | |
3607 multiplied by the specified factors, and dividing that sum by the sum | |
3608 of the factors' absolute values. | |
3609 | |
3610 Laplace edge-detection currently uses a matrix of | |
3611 @iftex | |
3612 @tex | |
3613 $$\pmatrix{1 & 0 & 0 \cr | |
3614 0& 0 & 0 \cr | |
3615 9 & 9 & -1 \cr}$$ | |
3616 @end tex | |
3617 @end iftex | |
3618 @ifnottex | |
3619 @display | |
3620 (1 0 0 | |
3621 0 0 0 | |
3622 9 9 -1) | |
3623 @end display | |
3624 @end ifnottex | |
3625 | |
3626 Emboss edge-detection uses a matrix of | |
3627 @iftex | |
3628 @tex | |
3629 $$\pmatrix{ 2 & -1 & 0 \cr | |
3630 -1 & 0 & 1 \cr | |
3631 0 & 1 & -2 \cr}$$ | |
3632 @end tex | |
3633 @end iftex | |
3634 @ifnottex | |
3635 @display | |
3636 ( 2 -1 0 | |
3637 -1 0 1 | |
3638 0 1 -2) | |
3639 @end display | |
3640 @end ifnottex | |
3641 | |
3642 @item disabled | |
3643 Specifies transforming the image so that it looks ``disabled''. | |
3644 @end table | |
3645 | |
3646 @item :mask @var{mask} | |
3647 If @var{mask} is @code{heuristic} or @code{(heuristic @var{bg})}, build | |
3648 a clipping mask for the image, so that the background of a frame is | |
3649 visible behind the image. If @var{bg} is not specified, or if @var{bg} | |
3650 is @code{t}, determine the background color of the image by looking at | |
3651 the four corners of the image, assuming the most frequently occurring | |
3652 color from the corners is the background color of the image. Otherwise, | |
3653 @var{bg} must be a list @code{(@var{red} @var{green} @var{blue})} | |
3654 specifying the color to assume for the background of the image. | |
3655 | |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
3656 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
|
3657 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
|
3658 specifying @code{:mask nil}. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3659 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3660 @item :pointer @var{shape} |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3661 This specifies the pointer shape when the mouse pointer is over this |
57225 | 3662 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
|
3663 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3664 @item :map @var{map} |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3665 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
|
3666 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3667 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
|
3668 @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
|
3669 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
|
3670 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3671 A rectangle is a cons |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3672 @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
|
3673 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
|
3674 corners of the rectangle area. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3675 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3676 A circle is a cons |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3677 @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
|
3678 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
|
3679 be a float or integer. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3680 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3681 A polygon is a cons |
57201
2950fcfcfa44
Correct various typos.
Luc Teirlinck <teirllm@auburn.edu>
parents:
57193
diff
changeset
|
3682 @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
|
3683 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
|
3684 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3685 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
|
3686 @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
|
3687 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
|
3688 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
|
3689 it is over the hot-spot. |
57225 | 3690 @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
|
3691 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3692 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
|
3693 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
|
3694 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
|
3695 @var{id} is @code{area4}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3696 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3697 |
33996 | 3698 @defun image-mask-p spec &optional frame |
3699 @tindex image-mask-p | |
3700 This function returns @code{t} if image @var{spec} has a mask bitmap. | |
3701 @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
|
3702 @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
|
3703 (@pxref{Input Focus}). |
33996 | 3704 @end defun |
3705 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3706 @node XBM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3707 @subsection XBM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3708 @cindex XBM |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3709 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3710 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
|
3711 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
|
3712 always supported. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3713 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3714 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
|
3715 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3716 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3717 @item :foreground @var{foreground} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3718 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
|
3719 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
|
3720 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
|
3721 foreground color. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3722 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3723 @item :background @var{background} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3724 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
|
3725 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
|
3726 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
|
3727 background color. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3728 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3729 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3730 If you specify an XBM image using data within Emacs instead of an |
28792 | 3731 external file, use the following three properties: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3732 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3733 @table @code |
28792 | 3734 @item :data @var{data} |
3735 The value, @var{data}, specifies the contents of the image. | |
3736 There are three formats you can use for @var{data}: | |
3737 | |
3738 @itemize @bullet | |
3739 @item | |
3740 A vector of strings or bool-vectors, each specifying one line of the | |
3741 image. Do specify @code{:height} and @code{:width}. | |
3742 | |
3743 @item | |
3744 A string containing the same byte sequence as an XBM file would contain. | |
3745 You must not specify @code{:height} and @code{:width} in this case, | |
3746 because omitting them is what indicates the data has the format of an | |
3747 XBM file. The file contents specify the height and width of the image. | |
3748 | |
3749 @item | |
3750 A string or a bool-vector containing the bits of the image (plus perhaps | |
3751 some extra bits at the end that will not be used). It should contain at | |
3752 least @var{width} * @code{height} bits. In this case, you must specify | |
3753 @code{:height} and @code{:width}, both to indicate that the string | |
3754 contains just the bits rather than a whole XBM file, and to specify the | |
3755 size of the image. | |
3756 @end itemize | |
3757 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3758 @item :width @var{width} |
28792 | 3759 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
|
3760 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3761 @item :height @var{height} |
28792 | 3762 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
|
3763 @end table |
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 @node XPM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3766 @subsection XPM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3767 @cindex XPM |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3768 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3769 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
|
3770 additional image property @code{:color-symbols} is also meaningful with |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3771 the @code{xpm} image type: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3772 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3773 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3774 @item :color-symbols @var{symbols} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3775 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
|
3776 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
|
3777 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
|
3778 specifies the actual color to use for displaying that name. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3779 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3780 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3781 @node GIF Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3782 @subsection GIF Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3783 @cindex GIF |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3784 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3785 For GIF images, specify image type @code{gif}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3786 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3787 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3788 @item :index @var{index} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3789 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
|
3790 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
|
3791 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
|
3792 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
|
3793 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3794 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3795 @ignore |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3796 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
|
3797 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
|
3798 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
|
3799 every 0.1 seconds. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3800 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3801 (defun show-anim (file max) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3802 "Display multi-image GIF file FILE which contains MAX subimages." |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3803 (display-anim (current-buffer) file 0 max t)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3804 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3805 (defun display-anim (buffer file idx max first-time) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3806 (when (= idx max) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3807 (setq idx 0)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3808 (let ((img (create-image file nil :image idx))) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3809 (save-excursion |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3810 (set-buffer buffer) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3811 (goto-char (point-min)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3812 (unless first-time (delete-char 1)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3813 (insert-image img)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3814 (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
|
3815 @end ignore |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3816 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3817 @node Postscript Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3818 @subsection Postscript Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3819 @cindex Postscript images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3820 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3821 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
|
3822 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
|
3823 these three properties: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3824 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3825 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3826 @item :pt-width @var{width} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3827 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
|
3828 points (1/72 inch). @var{width} must be an integer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3829 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3830 @item :pt-height @var{height} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3831 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
|
3832 (1/72 inch). @var{height} must be an integer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3833 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3834 @item :bounding-box @var{box} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3835 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
|
3836 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
|
3837 @samp{BoundingBox} comment found in Postscript files. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3838 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3839 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3840 %%BoundingBox: 22 171 567 738 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3841 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3842 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3843 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3844 Displaying Postscript images from Lisp data is not currently |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3845 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
|
3846 See the @file{etc/NEWS} file to make sure. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3847 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3848 @node Other Image Types |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3849 @subsection Other Image Types |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3850 @cindex PBM |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3851 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3852 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
|
3853 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
|
3854 image properties are supported. |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3855 |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3856 @table @code |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3857 @item :foreground @var{foreground} |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3858 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
|
3859 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
|
3860 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
|
3861 foreground color. |
32552
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3862 |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3863 @item :background @var{background} |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3864 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
|
3865 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
|
3866 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
|
3867 background color. |
32552
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
3868 @end table |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3869 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3870 For JPEG images, specify image type @code{jpeg}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3871 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3872 For TIFF images, specify image type @code{tiff}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3873 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3874 For PNG images, specify image type @code{png}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3875 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3876 @node Defining Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3877 @subsection Defining Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3878 |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3879 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
|
3880 @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
|
3881 |
59574
9ce057395159
(Defining Images): Mention DATA-P arg of create-image.
Richard M. Stallman <rms@gnu.org>
parents:
59505
diff
changeset
|
3882 @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
|
3883 @tindex create-image |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3884 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
|
3885 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
|
3886 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
|
3887 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
|
3888 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3889 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
|
3890 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
|
3891 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
|
3892 from the file's name. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3893 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3894 The remaining arguments, @var{props}, specify additional image |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3895 properties---for example, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3896 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3897 @example |
59574
9ce057395159
(Defining Images): Mention DATA-P arg of create-image.
Richard M. Stallman <rms@gnu.org>
parents:
59505
diff
changeset
|
3898 (create-image "foo.xpm" 'xpm nil :heuristic-mask t) |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3899 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3900 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3901 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
|
3902 supported. Otherwise it returns an image descriptor. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3903 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3904 |
41058
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3905 @defmac defimage symbol specs &optional doc |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3906 @tindex defimage |
41058
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3907 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
|
3908 @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
|
3909 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
|
3910 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3911 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
|
3912 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
|
3913 @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
|
3914 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
|
3915 @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
|
3916 @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
|
3917 example: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3918 |
25875 | 3919 @example |
3920 (defimage test-image | |
46338
6cf0fbc1d7da
defimage does not evaluate SPECS.
Richard M. Stallman <rms@gnu.org>
parents:
46245
diff
changeset
|
3921 ((:type xpm :file "~/test1.xpm") |
6cf0fbc1d7da
defimage does not evaluate SPECS.
Richard M. Stallman <rms@gnu.org>
parents:
46245
diff
changeset
|
3922 (:type xbm :file "~/test1.xbm"))) |
25875 | 3923 @end example |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3924 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3925 @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
|
3926 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
|
3927 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
|
3928 stored in @var{symbol}. |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3929 |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
3930 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
|
3931 as @code{nil}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3932 @end defmac |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3933 |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3934 @defun find-image specs |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3935 @tindex find-image |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3936 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
|
3937 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
|
3938 |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3939 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
|
3940 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
|
3941 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
|
3942 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
|
3943 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
|
3944 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
|
3945 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
|
3946 @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
|
3947 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
|
3948 |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3949 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
|
3950 @code{data-directory}. |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3951 @end defun |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
3952 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3953 @node Showing Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3954 @subsection Showing Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3955 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3956 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
|
3957 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
|
3958 section. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3959 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3960 @defun insert-image image &optional string area slice |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3961 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
|
3962 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
|
3963 returned by @code{create-image}, or the value of a symbol defined with |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3964 @code{defimage}. The argument @var{string} specifies the text to put |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3965 in the buffer to hold the image. If it is omitted or @code{nil}, |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3966 @code{insert-image} uses @code{" "} by default. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3967 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3968 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
|
3969 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
|
3970 @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
|
3971 @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
|
3972 buffer's text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3973 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3974 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
|
3975 @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
|
3976 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
|
3977 @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
|
3978 @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
|
3979 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
|
3980 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
|
3981 image. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3982 |
25875 | 3983 Internally, this function inserts @var{string} in the buffer, and gives |
3984 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
|
3985 Property}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3986 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3987 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3988 @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
|
3989 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
|
3990 @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
|
3991 equally sized slices. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3992 @end defun |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3993 |
29471 | 3994 @defun put-image image pos &optional string area |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3995 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
|
3996 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
|
3997 marker. It specifies the buffer position where the image should appear. |
29471 | 3998 The argument @var{string} specifies the text that should hold the image |
3999 as an alternative to the default. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4000 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4001 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
|
4002 by @code{create-image} or stored by @code{defimage}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4003 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4004 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
|
4005 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
|
4006 @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
|
4007 @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
|
4008 buffer's text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4009 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4010 Internally, this function creates an overlay, and gives it a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4011 @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
|
4012 property whose value is the image. (Whew!) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4013 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4014 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4015 @defun remove-images start end &optional buffer |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4016 This function removes images in @var{buffer} between positions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4017 @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
|
4018 images are removed from the current buffer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4019 |
27331
be0a552c8320
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
4020 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
|
4021 @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
|
4022 @code{insert-image} or in other ways. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4023 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4024 |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4025 @defun image-size spec &optional pixels frame |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4026 @tindex image-size |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4027 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
|
4028 @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
|
4029 specification. @var{pixels} non-@code{nil} means return sizes |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
4030 measured in pixels, otherwise return sizes measured in canonical |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
4031 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
|
4032 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
|
4033 @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
|
4034 Focus}). |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4035 @end defun |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4036 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4037 @node Image Cache |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4038 @subsection Image Cache |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4039 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4040 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
|
4041 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
|
4042 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
|
4043 |
28770 | 4044 When an image is looked up in the cache, its specification is compared |
4045 with cached image specifications using @code{equal}. This means that | |
4046 all images with equal specifications share the same image in the cache. | |
4047 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4048 @defvar image-cache-eviction-delay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4049 @tindex image-cache-eviction-delay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4050 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
|
4051 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
|
4052 length of time, Emacs removes it from the image cache. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4053 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4054 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
|
4055 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
|
4056 debugging. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4057 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4058 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4059 @defun clear-image-cache &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4060 @tindex clear-image-cache |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4061 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
|
4062 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
|
4063 are cleared. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4064 @end defun |
27447
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
4065 |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4066 @node Buttons |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4067 @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
|
4068 @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
|
4069 @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
|
4070 @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
|
4071 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4072 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
|
4073 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
|
4074 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
|
4075 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
|
4076 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4077 A button is essentially a set of properties attached (via text |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4078 properties or overlays) to a region of text in an Emacs buffer. These |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4079 properties are called @dfn{button properties}. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4080 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4081 One of the these properties (@code{action}) is a function, which will |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4082 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
|
4083 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
|
4084 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
|
4085 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4086 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
|
4087 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
|
4088 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
|
4089 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
|
4090 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
|
4091 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
|
4092 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
|
4093 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
|
4094 entries). |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4095 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4096 @menu |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4097 * 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
|
4098 * Button Types:: Defining common properties for classes of buttons. |
55246 | 4099 * 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
|
4100 * 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
|
4101 * Button Buffer Commands:: Buffer-wide commands and bindings for buttons. |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4102 @end menu |
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 @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
|
4105 @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
|
4106 @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
|
4107 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4108 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
|
4109 appearance and behavior, and other arbitrary properties may be used |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4110 for application specific purposes. Some properties that have special |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4111 meaning to the button package include: |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4112 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4113 @table @code |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4114 @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
|
4115 @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
|
4116 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
|
4117 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
|
4118 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
|
4119 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4120 @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
|
4121 @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
|
4122 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
|
4123 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
|
4124 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
|
4125 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
|
4126 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4127 @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
|
4128 @kindex face @r{(button property)} |
55246 | 4129 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
|
4130 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
|
4131 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4132 @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
|
4133 @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
|
4134 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
|
4135 mouse-overs (merged with the usual button face); by default this is |
55246 | 4136 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
|
4137 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4138 @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
|
4139 @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
|
4140 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
|
4141 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
|
4142 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
|
4143 @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
|
4144 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4145 @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
|
4146 @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
|
4147 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
|
4148 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
|
4149 @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
|
4150 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4151 @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
|
4152 @kindex help-index @r{(button property)} |
55246 | 4153 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
|
4154 @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
|
4155 |
59467
9c3931bf6cd0
(Button Properties): Add follow-link keyword.
Kim F. Storm <storm@cua.dk>
parents:
59463
diff
changeset
|
4156 @item follow-link |
9c3931bf6cd0
(Button Properties): Add follow-link keyword.
Kim F. Storm <storm@cua.dk>
parents:
59463
diff
changeset
|
4157 @kindex follow-link @r{(button property)} |
59505
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4158 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
|
4159 on this button, @xref{Links and Mouse-1}. |
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4160 |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4161 @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
|
4162 @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
|
4163 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
|
4164 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
|
4165 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
|
4166 @end table |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4167 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4168 There are other properties defined for the regions of text in a |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4169 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
|
4170 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4171 @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
|
4172 @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
|
4173 @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
|
4174 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4175 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
|
4176 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
|
4177 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
|
4178 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
|
4179 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
|
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 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
|
4182 @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
|
4183 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
|
4184 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
|
4185 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
|
4186 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
|
4187 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
|
4188 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4189 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
|
4190 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
|
4191 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
|
4192 @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
|
4193 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
|
4194 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4195 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4196 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
|
4197 buttons is not necessary---buttons without any specified type use the |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4198 built-in button-type @code{button}---but it is encouraged, since |
53468
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
4199 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
|
4200 |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
4201 @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
|
4202 @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
|
4203 @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
|
4204 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4205 Buttons are associated with a region of text, using an overlay or |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4206 text properties to hold button-specific information, all of which are |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4207 initialized from the button's type (which defaults to the built-in |
55246 | 4208 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
|
4209 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
|
4210 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
|
4211 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
|
4212 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4213 For convenience, there are two sorts of button-creation functions, |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4214 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
|
4215 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
|
4216 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
|
4217 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4218 The button-creation functions all take the @code{&rest} argument |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4219 @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
|
4220 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
|
4221 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
|
4222 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
|
4223 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
|
4224 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
|
4225 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
|
4226 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4227 The following functions add a button using an overlay |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4228 (@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
|
4229 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4230 @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
|
4231 @tindex make-button |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4232 This makes a button from @var{beg} to @var{end} in the |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4233 current buffer, and returns it. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4234 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4235 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4236 @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
|
4237 @tindex insert-button |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4238 This insert a button with the label @var{label} at point, |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4239 and returns it. |
53467
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 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4242 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
|
4243 (@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
|
4244 button actually part of the text instead of being a property of the |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4245 buffer. Buttons using text properties do not create markers into the |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4246 buffer, which is important for speed when you use extremely large |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4247 numbers of buttons. Both functions return the position of the start |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4248 of the new button: |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4249 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4250 @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
|
4251 @tindex make-text-button |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4252 This makes a button from @var{beg} to @var{end} in the current buffer, using |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4253 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
|
4254 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4255 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4256 @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
|
4257 @tindex insert-text-button |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4258 This inserts a button with the label @var{label} at point, using text |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4259 properties. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4260 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4261 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4262 @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
|
4263 @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
|
4264 @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
|
4265 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4266 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
|
4267 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
|
4268 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
|
4269 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4270 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
|
4271 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
|
4272 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
|
4273 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
|
4274 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
|
4275 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4276 @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
|
4277 @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
|
4278 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
|
4279 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4280 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4281 @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
|
4282 @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
|
4283 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
|
4284 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4285 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4286 @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
|
4287 @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
|
4288 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
|
4289 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4290 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4291 @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
|
4292 @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
|
4293 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
|
4294 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4295 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4296 @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
|
4297 @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
|
4298 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
|
4299 @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
|
4300 @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
|
4301 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
|
4302 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4303 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4304 @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
|
4305 @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
|
4306 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
|
4307 @end defun |
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 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
|
4310 @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
|
4311 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
|
4312 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4313 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4314 @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
|
4315 @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
|
4316 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
|
4317 @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
|
4318 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4319 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4320 @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
|
4321 @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
|
4322 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
|
4323 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4324 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4325 @defun button-type-put type prop val |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4326 @tindex button-type-put |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4327 Set the button-type @var{type}'s @var{prop} property to @var{val}. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4328 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4329 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4330 @defun button-type-get type prop |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4331 @tindex button-type-get |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4332 Get the property of button-type @var{type} named @var{prop}. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4333 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4334 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4335 @defun button-type-subtype-p type supertype |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4336 @tindex button-type-subtype-p |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4337 Return @code{t} if button-type @var{type} is a subtype of @var{supertype}. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4338 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4339 |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4340 @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
|
4341 @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
|
4342 @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
|
4343 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4344 These are commands and functions for locating and operating on |
55246 | 4345 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
|
4346 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4347 @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
|
4348 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
|
4349 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
|
4350 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
|
4351 @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
|
4352 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
|
4353 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
|
4354 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
|
4355 |
59505
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4356 If the button has a non-@code{nil} @code{follow-link} property, and |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4357 @var{mouse-1-click-follows-link} is set, a quick @key{Mouse-1} click |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4358 will also activate the @code{push-button} command. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4359 @xref{Links and Mouse-1}. |
59505
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4360 |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4361 @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
|
4362 @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
|
4363 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
|
4364 @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
|
4365 @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
|
4366 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
|
4367 @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
|
4368 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
|
4369 @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
|
4370 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
|
4371 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
|
4372 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
|
4373 @end deffn |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4374 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4375 @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
|
4376 @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
|
4377 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
|
4378 @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
|
4379 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
|
4380 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
|
4381 @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
|
4382 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
|
4383 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
|
4384 @end deffn |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4385 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4386 @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
|
4387 @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
|
4388 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
|
4389 @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
|
4390 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
|
4391 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
|
4392 @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
|
4393 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
|
4394 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
|
4395 @end deffn |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4396 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4397 @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
|
4398 @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
|
4399 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
|
4400 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
|
4401 @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
|
4402 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4403 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4404 @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
|
4405 @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
|
4406 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
|
4407 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
|
4408 @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
|
4409 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4410 |
6598 | 4411 @node Blinking |
4412 @section Blinking Parentheses | |
4413 @cindex parenthesis matching | |
4414 @cindex blinking | |
4415 @cindex balancing parentheses | |
4416 @cindex close parenthesis | |
4417 | |
4418 This section describes the mechanism by which Emacs shows a matching | |
4419 open parenthesis when the user inserts a close parenthesis. | |
4420 | |
4421 @defvar blink-paren-function | |
4422 The value of this variable should be a function (of no arguments) to | |
4423 be called whenever a character with close parenthesis syntax is inserted. | |
4424 The value of @code{blink-paren-function} may be @code{nil}, in which | |
4425 case nothing is done. | |
4426 @end defvar | |
4427 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4428 @defopt blink-matching-paren |
6598 | 4429 If this variable is @code{nil}, then @code{blink-matching-open} does |
4430 nothing. | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4431 @end defopt |
6598 | 4432 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4433 @defopt blink-matching-paren-distance |
6598 | 4434 This variable specifies the maximum distance to scan for a matching |
4435 parenthesis before giving up. | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4436 @end defopt |
6598 | 4437 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4438 @defopt blink-matching-delay |
12098 | 4439 This variable specifies the number of seconds for the cursor to remain |
4440 at the matching parenthesis. A fraction of a second often gives | |
4441 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
|
4442 @end defopt |
12098 | 4443 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4444 @deffn Command blink-matching-open |
6598 | 4445 This function is the default value of @code{blink-paren-function}. It |
4446 assumes that point follows a character with close parenthesis syntax and | |
4447 moves the cursor momentarily to the matching opening character. If that | |
4448 character is not already on the screen, it displays the character's | |
4449 context in the echo area. To avoid long delays, this function does not | |
4450 search farther than @code{blink-matching-paren-distance} characters. | |
4451 | |
4452 Here is an example of calling this function explicitly. | |
4453 | |
4454 @smallexample | |
4455 @group | |
4456 (defun interactive-blink-matching-open () | |
4457 @c Do not break this line! -- rms. | |
4458 @c The first line of a doc string | |
4459 @c must stand alone. | |
4460 "Indicate momentarily the start of sexp before point." | |
4461 (interactive) | |
4462 @end group | |
4463 @group | |
4464 (let ((blink-matching-paren-distance | |
4465 (buffer-size)) | |
4466 (blink-matching-paren t)) | |
4467 (blink-matching-open))) | |
4468 @end group | |
4469 @end smallexample | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4470 @end deffn |
6598 | 4471 |
4472 @node Usual Display | |
4473 @section Usual Display Conventions | |
4474 | |
4475 The usual display conventions define how to display each character | |
4476 code. You can override these conventions by setting up a display table | |
4477 (@pxref{Display Tables}). Here are the usual display conventions: | |
4478 | |
4479 @itemize @bullet | |
4480 @item | |
4481 Character codes 32 through 126 map to glyph codes 32 through 126. | |
4482 Normally this means they display as themselves. | |
4483 | |
4484 @item | |
4485 Character code 9 is a horizontal tab. It displays as whitespace | |
4486 up to a position determined by @code{tab-width}. | |
4487 | |
4488 @item | |
4489 Character code 10 is a newline. | |
4490 | |
4491 @item | |
4492 All other codes in the range 0 through 31, and code 127, display in one | |
9009 | 4493 of two ways according to the value of @code{ctl-arrow}. If it is |
6598 | 4494 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
|
4495 first glyph is the @acronym{ASCII} code for @samp{^}. (A display table can |
6598 | 4496 specify a glyph to use instead of @samp{^}.) Otherwise, these codes map |
4497 just like the codes in the range 128 to 255. | |
4498 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4499 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
|
4500 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
|
4501 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
|
4502 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
|
4503 emacs, The GNU Emacs Manual}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4504 |
6598 | 4505 @item |
4506 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
|
4507 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
|
4508 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
|
4509 table can specify a glyph to use instead of @samp{\}.) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4510 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4511 @item |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4512 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
|
4513 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
|
4514 character. |
6598 | 4515 @end itemize |
4516 | |
4517 The usual display conventions apply even when there is a display | |
4518 table, for any character whose entry in the active display table is | |
4519 @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
|
4520 specify the characters for which you want special behavior. |
6598 | 4521 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
4522 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
|
4523 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
|
4524 buffer where you expect it, if it was eliminated as part of end-of-line |
25454 | 4525 conversion (@pxref{Coding System Basics}). |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
4526 |
6598 | 4527 These variables affect the way certain characters are displayed on the |
4528 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
|
4529 they also affect the indentation functions. These variables also affect |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4530 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
|
4531 mode line using the new values, call the function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4532 @code{force-mode-line-update} (@pxref{Mode Line Format}). |
6598 | 4533 |
4534 @defopt ctl-arrow | |
4535 @cindex control characters in display | |
4536 This buffer-local variable controls how control characters are | |
4537 displayed. If it is non-@code{nil}, they are displayed as a caret | |
4538 followed by the character: @samp{^A}. If it is @code{nil}, they are | |
4539 displayed as a backslash followed by three octal digits: @samp{\001}. | |
4540 @end defopt | |
4541 | |
4542 @c Following may have overfull hbox. | |
4543 @defvar default-ctl-arrow | |
4544 The value of this variable is the default value for @code{ctl-arrow} in | |
4545 buffers that do not override it. @xref{Default Value}. | |
4546 @end defvar | |
4547 | |
58496
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4548 @defopt tab-width |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4549 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
|
4550 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
|
4551 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
|
4552 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
|
4553 @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
|
4554 @end defopt |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4555 |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
4556 @defopt indicate-empty-lines |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
4557 @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
|
4558 @cindex fringes, and empty line indication |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
4559 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
|
4560 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
|
4561 support it (window systems). @xref{Fringes}. |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
4562 @end defopt |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
4563 |
58496
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4564 @defvar indicate-buffer-boundaries |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4565 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
|
4566 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
|
4567 |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4568 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
|
4569 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
|
4570 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
|
4571 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
|
4572 there is text below the screen. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4573 |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4574 There are four kinds of basic values: |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4575 |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4576 @table @asis |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4577 @item @code{nil} |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4578 Don't display the icons. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4579 @item @code{left} |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4580 Display them in the left fringe. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4581 @item @code{right} |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4582 Display them in the right fringe. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4583 @item @var{anything-else} |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4584 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
|
4585 in the right fringe. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4586 @end table |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4587 |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4588 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
|
4589 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
|
4590 @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
|
4591 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
|
4592 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
|
4593 the right fringe. |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4594 @end defvar |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4595 |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4596 @defvar default-indicate-buffer-boundaries |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
4597 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
|
4598 @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
|
4599 @end defvar |
6598 | 4600 |
4601 @node Display Tables | |
4602 @section Display Tables | |
4603 | |
4604 @cindex display table | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4605 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
|
4606 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
|
4607 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
|
4608 set. |
6598 | 4609 |
4610 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
|
4611 @dfn{glyphs}, each glyph being a graphic that takes up one character |
6598 | 4612 position on the screen. You can also define how to display each glyph |
4613 on your terminal, using the @dfn{glyph table}. | |
4614 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4615 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
|
4616 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
|
4617 @code{force-mode-line-update} (@pxref{Mode Line Format}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4618 |
6598 | 4619 @menu |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4620 * 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
|
4621 * 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
|
4622 * Glyphs:: How to define a glyph, and what glyphs mean. |
6598 | 4623 @end menu |
4624 | |
4625 @node Display Table Format | |
4626 @subsection Display Table Format | |
4627 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4628 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
|
4629 @code{display-table} as its subtype. |
6598 | 4630 |
4631 @defun make-display-table | |
4632 This creates and returns a display table. The table initially has | |
4633 @code{nil} in all elements. | |
4634 @end defun | |
4635 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4636 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
|
4637 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
|
4638 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
|
4639 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
|
4640 display that character according to the usual display conventions |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4641 (@pxref{Usual Display}). |
12067 | 4642 |
4643 If you use the display table to change the display of newline | |
4644 characters, the whole buffer will be displayed as one long ``line.'' | |
6598 | 4645 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4646 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
|
4647 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
|
4648 means to use the default for that slot, as stated below. |
6598 | 4649 |
4650 @table @asis | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4651 @item 0 |
6598 | 4652 The glyph for the end of a truncated screen line (the default for this |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4653 is @samp{$}). @xref{Glyphs}. On graphical terminals, Emacs uses |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4654 arrows in the fringes to indicate truncation, so the display table has |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4655 no effect. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4656 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4657 @item 1 |
6598 | 4658 The glyph for the end of a continued line (the default is @samp{\}). |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4659 On graphical terminals, Emacs uses curved arrows in the fringes to |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4660 indicate continuation, so the display table has no effect. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4661 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4662 @item 2 |
6598 | 4663 The glyph for indicating a character displayed as an octal character |
4664 code (the default is @samp{\}). | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4665 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4666 @item 3 |
6598 | 4667 The glyph for indicating a control character (the default is @samp{^}). |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4668 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4669 @item 4 |
6598 | 4670 A vector of glyphs for indicating the presence of invisible lines (the |
4671 default is @samp{...}). @xref{Selective Display}. | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4672 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4673 @item 5 |
8925 | 4674 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
|
4675 default is @samp{|}). @xref{Splitting Windows}. This takes effect only |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4676 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
|
4677 a scroll bar separates the two windows. |
6598 | 4678 @end table |
4679 | |
4680 For example, here is how to construct a display table that mimics the | |
4681 effect of setting @code{ctl-arrow} to a non-@code{nil} value: | |
4682 | |
4683 @example | |
4684 (setq disptab (make-display-table)) | |
4685 (let ((i 0)) | |
4686 (while (< i 32) | |
4687 (or (= i ?\t) (= i ?\n) | |
4688 (aset disptab i (vector ?^ (+ i 64)))) | |
4689 (setq i (1+ i))) | |
4690 (aset disptab 127 (vector ?^ ??))) | |
4691 @end example | |
4692 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4693 @defun display-table-slot display-table slot |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4694 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
|
4695 @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
|
4696 5 inclusive, or a slot name (symbol). Valid symbols are |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4697 @code{truncation}, @code{wrap}, @code{escape}, @code{control}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4698 @code{selective-display}, and @code{vertical-border}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4699 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4700 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4701 @defun set-display-table-slot display-table slot value |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4702 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
|
4703 @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
|
4704 5 inclusive, or a slot name (symbol). Valid symbols are |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4705 @code{truncation}, @code{wrap}, @code{escape}, @code{control}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4706 @code{selective-display}, and @code{vertical-border}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4707 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4708 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4709 @defun describe-display-table display-table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4710 @tindex describe-display-table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4711 This function displays a description of the display table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4712 @var{display-table} in a help buffer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4713 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4714 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4715 @deffn Command describe-current-display-table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4716 @tindex describe-current-display-table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4717 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
|
4718 help buffer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4719 @end deffn |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4720 |
6598 | 4721 @node Active Display Table |
4722 @subsection Active Display Table | |
4723 @cindex active display table | |
4724 | |
4725 Each window can specify a display table, and so can each buffer. When | |
4726 a buffer @var{b} is displayed in window @var{w}, display uses the | |
4727 display table for window @var{w} if it has one; otherwise, the display | |
4728 table for buffer @var{b} if it has one; otherwise, the standard display | |
4729 table if any. The display table chosen is called the @dfn{active} | |
4730 display table. | |
4731 | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4732 @defun window-display-table &optional window |
6598 | 4733 This function returns @var{window}'s display table, or @code{nil} |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4734 if @var{window} does not have an assigned display table. The default |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4735 for @var{window} is the selected window. |
6598 | 4736 @end defun |
4737 | |
4738 @defun set-window-display-table window table | |
4739 This function sets the display table of @var{window} to @var{table}. | |
4740 The argument @var{table} should be either a display table or | |
4741 @code{nil}. | |
4742 @end defun | |
4743 | |
4744 @defvar buffer-display-table | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4745 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
|
4746 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
|
4747 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
|
4748 table. |
6598 | 4749 @end defvar |
4750 | |
4751 @defvar standard-display-table | |
4752 This variable's value is the default display table, used whenever a | |
4753 window has no display table and neither does the buffer displayed in | |
4754 that window. This variable is @code{nil} by default. | |
4755 @end defvar | |
4756 | |
4757 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
|
4758 if the window specifies none, its buffer specifies none, and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4759 @code{standard-display-table} is @code{nil}---then Emacs uses the usual |
6598 | 4760 display conventions for all character codes in that window. @xref{Usual |
4761 Display}. | |
4762 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4763 A number of functions for changing the standard display table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4764 are defined in the library @file{disp-table}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4765 |
6598 | 4766 @node Glyphs |
4767 @subsection Glyphs | |
4768 | |
4769 @cindex glyph | |
4770 A @dfn{glyph} is a generalization of a character; it stands for an | |
4771 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
|
4772 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
|
4773 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
|
4774 |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4775 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
|
4776 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
|
4777 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
|
4778 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
|
4779 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
|
4780 outputting it. (524288 is |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4781 @ifnottex |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4782 2**19.) |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4783 @end ifnottex |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4784 @tex |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4785 $2^{19}$.) |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4786 @end tex |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4787 @xref{Faces}. |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4788 |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4789 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
|
4790 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
|
4791 variable @code{glyph-table}. |
6598 | 4792 |
4793 @defvar glyph-table | |
4794 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
|
4795 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
|
4796 |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4797 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
|
4798 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
|
4799 @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
|
4800 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
|
4801 on character terminals. On graphical displays, all glyphs are simple. |
6598 | 4802 @end defvar |
4803 | |
4804 Here are the possible types of elements in the glyph table: | |
4805 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4806 @table @asis |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4807 @item @var{string} |
6598 | 4808 Send the characters in @var{string} to the terminal to output |
4809 this glyph. This alternative is available on character terminals, | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4810 but not under a window system. |
6598 | 4811 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4812 @item @var{integer} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4813 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
|
4814 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
|
4815 number as its code. |
6598 | 4816 |
4817 @item @code{nil} | |
47482
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
4818 This glyph is simple. |
6598 | 4819 @end table |
4820 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4821 @defun create-glyph string |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4822 @tindex create-glyph |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4823 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
|
4824 display by sending @var{string} to the terminal. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4825 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4826 |
6598 | 4827 @node Beeping |
4828 @section Beeping | |
4829 @cindex beeping | |
4830 @cindex bell | |
4831 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4832 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
|
4833 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
|
4834 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
|
4835 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
|
4836 appropriate. (@xref{Errors}.) |
6598 | 4837 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4838 @defun ding &optional do-not-terminate |
6598 | 4839 @cindex keyboard macro termination |
4840 This function beeps, or flashes the screen (see @code{visible-bell} below). | |
4841 It also terminates any keyboard macro currently executing unless | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4842 @var{do-not-terminate} is non-@code{nil}. |
6598 | 4843 @end defun |
4844 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4845 @defun beep &optional do-not-terminate |
6598 | 4846 This is a synonym for @code{ding}. |
4847 @end defun | |
4848 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4849 @defopt visible-bell |
6598 | 4850 This variable determines whether Emacs should flash the screen to |
4851 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
|
4852 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
|
4853 provided the terminal's Termcap entry defines the visible bell |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4854 capability (@samp{vb}). |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4855 @end defopt |
6598 | 4856 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4857 @defvar ring-bell-function |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4858 If this is non-@code{nil}, it specifies how Emacs should ``ring the |
25875 | 4859 bell.'' Its value should be a function of no arguments. If this is |
4860 non-@code{nil}, it takes precedence over the @code{visible-bell} | |
4861 variable. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4862 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4863 |
6598 | 4864 @node Window Systems |
4865 @section Window Systems | |
4866 | |
4867 Emacs works with several window systems, most notably the X Window | |
4868 System. Both Emacs and X use the term ``window'', but use it | |
4869 differently. An Emacs frame is a single window as far as X is | |
4870 concerned; the individual Emacs windows are not known to X at all. | |
4871 | |
4872 @defvar window-system | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4873 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
|
4874 under. The possible values are |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4875 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4876 @table @code |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4877 @item x |
6598 | 4878 @cindex X Window System |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4879 Emacs is displaying using X. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4880 @item pc |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4881 Emacs is displaying using MS-DOS. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4882 @item w32 |
27332
5cfe77eaff45
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27331
diff
changeset
|
4883 Emacs is displaying using Windows. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4884 @item mac |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4885 Emacs is displaying using a Macintosh. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4886 @item nil |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4887 Emacs is using a character-based terminal. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4888 @end table |
6598 | 4889 @end defvar |
4890 | |
4891 @defvar window-setup-hook | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
4892 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
|
4893 initialization files. Emacs runs this hook after it has completed |
25875 | 4894 loading your init file, the default initialization file (if |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
4895 any), and the terminal-specific Lisp code, and running the hook |
6598 | 4896 @code{term-setup-hook}. |
4897 | |
4898 This hook is used for internal purposes: setting up communication with | |
4899 the window system, and creating the initial window. Users should not | |
4900 interfere with it. | |
4901 @end defvar | |
52401 | 4902 |
4903 @ignore | |
4904 arch-tag: ffdf5714-7ecf-415b-9023-fbc6b409c2c6 | |
4905 @end ignore |