Mercurial > emacs
annotate lispref/display.texi @ 78661:048b9f8ae3b7
(Images): Delete redundant @findex.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Sat, 25 Aug 2007 22:57:54 +0000 |
parents | cf26f3823573 |
children | cd4709291938 92ccd83174e6 |
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, |
75348 | 4 @c 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. |
6598 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/display | |
60995
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. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
29 * Display Property:: Enabling special display features. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
30 * Images:: Displaying images in Emacs buffers. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
31 * Buttons:: Adding clickable buttons to Emacs buffers. |
71009
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
32 * Abstract Display:: Emacs' Widget for Object Collections. |
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 |
71719
fc057bd26f1f
(Refresh Screen): Clarify force-window-update.
Kim F. Storm <storm@cua.dk>
parents:
71710
diff
changeset
|
62 This function forces some or all windows to be updated on next redisplay. |
fc057bd26f1f
(Refresh Screen): Clarify force-window-update.
Kim F. Storm <storm@cua.dk>
parents:
71710
diff
changeset
|
63 If @var{object} is a window, it forces redisplay of that window. If |
53422
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 |
71325
ab800262f66c
(Forcing Redisplay): Add redisplay-preemption-period.
Kim F. Storm <storm@cua.dk>
parents:
71264
diff
changeset
|
97 @defvar redisplay-preemption-period |
71329
3e4b5e8df594
(Forcing Redisplay): Clarify previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71328
diff
changeset
|
98 This variable specifies how many seconds Emacs waits between checks |
3e4b5e8df594
(Forcing Redisplay): Clarify previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71328
diff
changeset
|
99 for new input during redisplay. (The default is 0.1 seconds.) If |
3e4b5e8df594
(Forcing Redisplay): Clarify previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71328
diff
changeset
|
100 input has arrived when Emacs checks, it pre-empts redisplay and |
3e4b5e8df594
(Forcing Redisplay): Clarify previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71328
diff
changeset
|
101 processes the available input before trying again to redisplay. |
3e4b5e8df594
(Forcing Redisplay): Clarify previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71328
diff
changeset
|
102 |
3e4b5e8df594
(Forcing Redisplay): Clarify previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71328
diff
changeset
|
103 If this variable is @code{nil}, Emacs does not check for input during |
3e4b5e8df594
(Forcing Redisplay): Clarify previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71328
diff
changeset
|
104 redisplay, and redisplay cannot be preempted by input. |
71325
ab800262f66c
(Forcing Redisplay): Add redisplay-preemption-period.
Kim F. Storm <storm@cua.dk>
parents:
71264
diff
changeset
|
105 |
72058
92e52d7e4ecd
(Forcing Redisplay): Don't mention systems which
Kim F. Storm <storm@cua.dk>
parents:
72012
diff
changeset
|
106 This variable is only obeyed on graphical terminals. For |
92e52d7e4ecd
(Forcing Redisplay): Don't mention systems which
Kim F. Storm <storm@cua.dk>
parents:
72012
diff
changeset
|
107 text terminals, see @ref{Terminal Output}. |
71325
ab800262f66c
(Forcing Redisplay): Add redisplay-preemption-period.
Kim F. Storm <storm@cua.dk>
parents:
71264
diff
changeset
|
108 @end defvar |
ab800262f66c
(Forcing Redisplay): Add redisplay-preemption-period.
Kim F. Storm <storm@cua.dk>
parents:
71264
diff
changeset
|
109 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
110 @defvar redisplay-dont-pause |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
111 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
|
112 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
|
113 regardless of whether input is available. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
114 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
115 |
71776
93e3d16a8207
(Forcing Redisplay): Add `redisplay' function.
Kim F. Storm <storm@cua.dk>
parents:
71748
diff
changeset
|
116 @defun redisplay &optional force |
93e3d16a8207
(Forcing Redisplay): Add `redisplay' function.
Kim F. Storm <storm@cua.dk>
parents:
71748
diff
changeset
|
117 This function performs an immediate redisplay provided there are no |
93e3d16a8207
(Forcing Redisplay): Add `redisplay' function.
Kim F. Storm <storm@cua.dk>
parents:
71748
diff
changeset
|
118 pending input events. This is equivalent to @code{(sit-for 0)}. |
93e3d16a8207
(Forcing Redisplay): Add `redisplay' function.
Kim F. Storm <storm@cua.dk>
parents:
71748
diff
changeset
|
119 |
93e3d16a8207
(Forcing Redisplay): Add `redisplay' function.
Kim F. Storm <storm@cua.dk>
parents:
71748
diff
changeset
|
120 If the optional argument @var{force} is non-@code{nil}, it forces an |
93e3d16a8207
(Forcing Redisplay): Add `redisplay' function.
Kim F. Storm <storm@cua.dk>
parents:
71748
diff
changeset
|
121 immediate and complete redisplay even if input is available. |
72789
3bc9f54f9bdb
(Forcing Redisplay): Document return value of function redisplay.
Kim F. Storm <storm@cua.dk>
parents:
72758
diff
changeset
|
122 |
3bc9f54f9bdb
(Forcing Redisplay): Document return value of function redisplay.
Kim F. Storm <storm@cua.dk>
parents:
72758
diff
changeset
|
123 Returns @code{t} if redisplay was performed, or @code{nil} otherwise. |
71776
93e3d16a8207
(Forcing Redisplay): Add `redisplay' function.
Kim F. Storm <storm@cua.dk>
parents:
71748
diff
changeset
|
124 @end defun |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
125 |
6598 | 126 @node Truncation |
127 @section Truncation | |
128 @cindex line wrapping | |
76841 | 129 @cindex line truncation |
6598 | 130 @cindex continuation lines |
131 @cindex @samp{$} in display | |
132 @cindex @samp{\} in display | |
133 | |
71745
5df595f18fa2
(Truncation): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71730
diff
changeset
|
134 When a line of text extends beyond the right edge of a window, Emacs |
5df595f18fa2
(Truncation): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71730
diff
changeset
|
135 can @dfn{continue} the line (make it ``wrap'' to the next screen |
5df595f18fa2
(Truncation): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71730
diff
changeset
|
136 line), or @dfn{truncate} the line (limit it to one screen line). The |
5df595f18fa2
(Truncation): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71730
diff
changeset
|
137 additional screen lines used to display a long text line are called |
5df595f18fa2
(Truncation): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71730
diff
changeset
|
138 @dfn{continuation} lines. Continuation is not the same as filling; |
5df595f18fa2
(Truncation): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71730
diff
changeset
|
139 continuation happens on the screen only, not in the buffer contents, |
5df595f18fa2
(Truncation): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71730
diff
changeset
|
140 and it breaks a line precisely at the right margin, not at a word |
5df595f18fa2
(Truncation): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71730
diff
changeset
|
141 boundary. @xref{Filling}. |
5df595f18fa2
(Truncation): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71730
diff
changeset
|
142 |
5df595f18fa2
(Truncation): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71730
diff
changeset
|
143 On a graphical display, tiny arrow images in the window fringes |
5df595f18fa2
(Truncation): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71730
diff
changeset
|
144 indicate truncated and continued lines (@pxref{Fringes}). On a text |
5df595f18fa2
(Truncation): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71730
diff
changeset
|
145 terminal, a @samp{$} in the rightmost column of the window indicates |
5df595f18fa2
(Truncation): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71730
diff
changeset
|
146 truncation; a @samp{\} on the rightmost column indicates a line that |
71957
61cb5aae3bc3
Put period and comma inside quotes.
Richard M. Stallman <rms@gnu.org>
parents:
71882
diff
changeset
|
147 ``wraps.'' (The display table can specify alternate characters to use |
71745
5df595f18fa2
(Truncation): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71730
diff
changeset
|
148 for this; @pxref{Display Tables}). |
6598 | 149 |
150 @defopt truncate-lines | |
151 This buffer-local variable controls how Emacs displays lines that extend | |
152 beyond the right edge of the window. The default is @code{nil}, which | |
153 specifies continuation. If the value is non-@code{nil}, then these | |
154 lines are truncated. | |
155 | |
156 If the variable @code{truncate-partial-width-windows} is non-@code{nil}, | |
157 then truncation is always used for side-by-side windows (within one | |
158 frame) regardless of the value of @code{truncate-lines}. | |
159 @end defopt | |
160 | |
12098 | 161 @defopt default-truncate-lines |
6598 | 162 This variable is the default value for @code{truncate-lines}, for |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
163 buffers that do not have buffer-local values for it. |
12098 | 164 @end defopt |
6598 | 165 |
166 @defopt truncate-partial-width-windows | |
167 This variable controls display of lines that extend beyond the right | |
168 edge of the window, in side-by-side windows (@pxref{Splitting Windows}). | |
169 If it is non-@code{nil}, these lines are truncated; otherwise, | |
170 @code{truncate-lines} says what to do with them. | |
171 @end defopt | |
172 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
173 When horizontal scrolling (@pxref{Horizontal Scrolling}) is in use in |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
174 a window, that forces truncation. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
175 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
176 If your buffer contains @emph{very} long lines, and you use |
12067 | 177 continuation to display them, just thinking about them can make Emacs |
12098 | 178 redisplay slow. The column computation and indentation functions also |
179 become slow. Then you might find it advisable to set | |
180 @code{cache-long-line-scans} to @code{t}. | |
12067 | 181 |
182 @defvar cache-long-line-scans | |
183 If this variable is non-@code{nil}, various indentation and motion | |
12098 | 184 functions, and Emacs redisplay, cache the results of scanning the |
185 buffer, and consult the cache to avoid rescanning regions of the buffer | |
186 unless they are modified. | |
12067 | 187 |
12098 | 188 Turning on the cache slows down processing of short lines somewhat. |
12067 | 189 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
190 This variable is automatically buffer-local in every buffer. |
12067 | 191 @end defvar |
192 | |
6598 | 193 @node The Echo Area |
194 @section The Echo Area | |
195 @cindex error display | |
196 @cindex echo area | |
197 | |
63957
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
198 The @dfn{echo area} is used for displaying error messages |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
199 (@pxref{Errors}), for messages made with the @code{message} primitive, |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
200 and for echoing keystrokes. It is not the same as the minibuffer, |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
201 despite the fact that the minibuffer appears (when active) in the same |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
202 place on the screen as the echo area. The @cite{GNU Emacs Manual} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
203 specifies the rules for resolving conflicts between the echo area and |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
204 the minibuffer for use of that screen space (@pxref{Minibuffer,, The |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
205 Minibuffer, emacs, The GNU Emacs Manual}). |
6598 | 206 |
63957
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
207 You can write output in the echo area by using the Lisp printing |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
208 functions with @code{t} as the stream (@pxref{Output Functions}), or |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
209 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
|
210 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
211 @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
|
212 * 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
|
213 * Progress:: Informing user about progress of a long operation. |
63957
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
214 * Logging Messages:: Echo area messages are logged for the user. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
215 * Echo Area Customization:: Controlling the echo area. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
216 @end menu |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
217 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
218 @node Displaying Messages |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
219 @subsection Displaying Messages in the Echo Area |
76841 | 220 @cindex display message in echo area |
63957
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
221 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
222 This section describes the functions for explicitly producing echo |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
223 area messages. Many other Emacs features display messages there, too. |
6598 | 224 |
65740
a0447a0dfab8
(Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents:
65598
diff
changeset
|
225 @defun message format-string &rest arguments |
a0447a0dfab8
(Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents:
65598
diff
changeset
|
226 This function displays a message in the echo area. The argument |
a0447a0dfab8
(Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents:
65598
diff
changeset
|
227 @var{format-string} is similar to a C language @code{printf} format |
62118
e5a04a0e92c1
(The Echo Area): Correct format function cross reference.
Eli Zaretskii <eliz@gnu.org>
parents:
61980
diff
changeset
|
228 string. See @code{format} in @ref{Formatting Strings}, for the details |
6598 | 229 on the conversion specifications. @code{message} returns the |
230 constructed string. | |
231 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
232 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
|
233 error stream, followed by a newline. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
234 |
65740
a0447a0dfab8
(Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents:
65598
diff
changeset
|
235 If @var{format-string}, or strings among the @var{arguments}, have |
a0447a0dfab8
(Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents:
65598
diff
changeset
|
236 @code{face} text properties, these affect the way the message is displayed. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
237 |
6598 | 238 @c Emacs 19 feature |
65740
a0447a0dfab8
(Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents:
65598
diff
changeset
|
239 If @var{format-string} is @code{nil} or the empty string, |
a0447a0dfab8
(Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents:
65598
diff
changeset
|
240 @code{message} clears the echo area; if the echo area has been |
a0447a0dfab8
(Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents:
65598
diff
changeset
|
241 expanded automatically, this brings it back to its normal size. |
a0447a0dfab8
(Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents:
65598
diff
changeset
|
242 If the minibuffer is active, this brings the minibuffer contents back |
a0447a0dfab8
(Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents:
65598
diff
changeset
|
243 onto the screen immediately. |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
244 |
6598 | 245 @example |
246 @group | |
247 (message "Minibuffer depth is %d." | |
248 (minibuffer-depth)) | |
249 @print{} Minibuffer depth is 0. | |
250 @result{} "Minibuffer depth is 0." | |
251 @end group | |
252 | |
253 @group | |
254 ---------- Echo Area ---------- | |
255 Minibuffer depth is 0. | |
256 ---------- Echo Area ---------- | |
257 @end group | |
258 @end example | |
32261
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
259 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
260 To automatically display a message in the echo area or in a pop-buffer, |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
261 depending on its size, use @code{display-message-or-buffer} (see below). |
6598 | 262 @end defun |
263 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
264 @defmac with-temp-message message &rest body |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
265 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
|
266 the execution of @var{body}. It displays @var{message}, executes |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
267 @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
|
268 the previous echo area contents. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
269 @end defmac |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
270 |
65740
a0447a0dfab8
(Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents:
65598
diff
changeset
|
271 @defun message-or-box format-string &rest arguments |
22843
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
272 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
|
273 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
|
274 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
|
275 @code{last-nonmenu-event} (@pxref{Command Loop Info}) is either |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
276 @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
|
277 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
|
278 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
|
279 @ref{Yes-or-No Queries}.) |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
280 |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
281 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
|
282 @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
|
283 @end defun |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
284 |
65740
a0447a0dfab8
(Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents:
65598
diff
changeset
|
285 @defun message-box format-string &rest arguments |
71882
98630b6d51a1
* display.texi (Displaying Messages): Add anchor.
Nick Roberts <nickrob@snap.net.nz>
parents:
71776
diff
changeset
|
286 @anchor{message-box} |
22843
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
287 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
|
288 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
|
289 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
|
290 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
|
291 @code{message}. |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
292 @end defun |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
293 |
32261
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
294 @defun display-message-or-buffer message &optional buffer-name not-this-window frame |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
295 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
|
296 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
|
297 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
|
298 in the echo area, using @code{message}. Otherwise, |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
299 @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
|
300 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
301 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
|
302 buffer is used, the window used to display it. |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
303 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
304 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
|
305 @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
|
306 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
|
307 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
|
308 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
|
309 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
310 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
|
311 @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
|
312 @end defun |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
313 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
314 @defun current-message |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
315 This function returns the message currently being displayed in the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
316 echo area, or @code{nil} if there is none. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
317 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
318 |
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
|
319 @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
|
320 @subsection Reporting Operation Progress |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
321 @cindex progress reporting |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
322 |
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 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
|
324 user about the progress it makes. This way the user can estimate |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
325 remaining time and clearly see that Emacs is busy working, not hung. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
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 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
|
328 reporting operation progress. Here is a working example that does |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
329 nothing useful: |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
330 |
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 @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
|
332 (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
|
333 (make-progress-reporter "Collecting mana for Emacs..." |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
334 0 500))) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
335 (dotimes (k 500) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
336 (sit-for 0.01) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
337 (progress-reporter-update progress-reporter k)) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
338 (progress-reporter-done progress-reporter)) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
339 @end smallexample |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
340 |
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 @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
|
342 This function creates and returns a @dfn{progress reporter}---an |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
343 object you will use as an argument for all other functions listed |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
344 here. The idea is to precompute as much data as possible to make |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
345 progress reporting very fast. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
346 |
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 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
|
348 @var{message} in the echo area, followed by progress percentage. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
349 @var{message} is treated as a simple string. If you need it to depend |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
350 on a filename, for instance, use @code{format} before calling this |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
351 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
|
352 |
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 @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
|
354 final states of your operation. For instance, if you scan a buffer, |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
355 they should be the results of @code{point-min} and @code{point-max} |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
356 correspondingly. It is required that @var{max-value} is greater than |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
357 @var{min-value}. If you create progress reporter when some part of |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
358 the operation has already been completed, then specify |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
359 @var{current-value} argument. But normally you should omit it or set |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
360 it to @code{nil}---it will default to @var{min-value} then. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
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 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
|
363 reporter will wait for at least @var{min-change} more percents of the |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
364 operation to be completed before printing next message. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
365 @var{min-time} specifies the minimum time in seconds to pass between |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
366 successive prints. It can be fractional. Depending on Emacs and |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
367 system capabilities, progress reporter may or may not respect this |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
368 last argument or do it with varying precision. Default value for |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
369 @var{min-change} is 1 (one percent), for @var{min-time}---0.2 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
370 (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
|
371 |
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 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
|
373 message is printed immediately. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
374 @end defun |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
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 @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
|
377 This function does the main work of reporting progress of your |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
378 operation. It displays the message of @var{reporter}, followed by |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
379 progress percentage determined by @var{value}. If percentage is zero, |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
380 or close enough according to the @var{min-change} and @var{min-time} |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
381 arguments, then it is omitted from the output. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
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 @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
|
384 @code{make-progress-reporter}. @var{value} specifies the current |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
385 state of your operation and must be between @var{min-value} and |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
386 @var{max-value} (inclusive) as passed to |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
387 @code{make-progress-reporter}. For instance, if you scan a buffer, |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
388 then @var{value} should be the result of a call to @code{point}. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
389 |
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 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
|
391 to @code{make-progress-reporter} and so does not output new messages |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
392 on every invocation. It is thus very fast and normally you should not |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
393 try to reduce the number of calls to it: resulting overhead will most |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
394 likely negate your effort. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
395 @end defun |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
396 |
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 @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
|
398 This function is similar to @code{progress-reporter-update} except |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
399 that it prints a message in the echo area unconditionally. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
400 |
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 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
|
402 @code{progress-reporter-update}. Optional @var{new-message} allows |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
403 you to change the message of the @var{reporter}. Since this functions |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
404 always updates the echo area, such a change will be immediately |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
405 presented to the user. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
406 @end defun |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
407 |
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 @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
|
409 This function should be called when the operation is finished. It |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
410 prints the message of @var{reporter} followed by word ``done'' in the |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
411 echo area. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
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 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
|
414 @code{progress-reporter-update} to print ``100%.'' Firstly, it may |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
415 never print it, there are many good reasons for this not to happen. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
416 Secondly, ``done'' is more explicit. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
417 @end defun |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
418 |
66143 | 419 @defmac dotimes-with-progress-reporter (var count [result]) message body@dots{} |
63957
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
420 This is a convenience macro that works the same way as @code{dotimes} |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
421 does, but also reports loop progress using the functions described |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
422 above. It allows you to save some typing. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
423 |
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 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
|
425 this macro this way: |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
426 |
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 @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
|
428 (dotimes-with-progress-reporter |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
429 (k 500) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
430 "Collecting some mana for Emacs..." |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
431 (sit-for 0.01)) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
432 @end example |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
433 @end defmac |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
434 |
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 @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
|
436 @subsection Logging Messages in @samp{*Messages*} |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
437 @cindex logging echo-area messages |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
438 |
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 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
|
440 in the @samp{*Messages*} buffer so that the user can refer back to |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
441 them. This includes all the messages that are output with |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
442 @code{message}. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
443 |
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 @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
|
445 This variable specifies how many lines to keep in the @samp{*Messages*} |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
446 buffer. The value @code{t} means there is no limit on how many lines to |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
447 keep. The value @code{nil} disables message logging entirely. Here's |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
448 how to display a message and prevent it from being logged: |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
449 |
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 @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
|
451 (let (message-log-max) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
452 (message @dots{})) |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
453 @end example |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
454 @end defopt |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
455 |
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 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
|
457 facility combines successive identical messages. It also combines |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
458 successive related messages for the sake of two cases: question |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
459 followed by answer, and a series of progress messages. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
460 |
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 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
|
462 ones produced by @code{y-or-n-p}: the first is @samp{@var{question}}, |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
463 and the second is @samp{@var{question}...@var{answer}}. The first |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
464 message conveys no additional information beyond what's in the second, |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
465 so logging the second message discards the first from the log. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
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 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
|
468 those produced by @code{make-progress-reporter}. They have the form |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
469 @samp{@var{base}...@var{how-far}}, where @var{base} is the same each |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
470 time, while @var{how-far} varies. Logging each message in the series |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
471 discards the previous one, provided they are consecutive. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
472 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
473 The functions @code{make-progress-reporter} and @code{y-or-n-p} |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
474 don't have to do anything special to activate the message log |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
475 combination feature. It operates whenever two consecutive messages |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
476 are logged that share a common prefix ending in @samp{...}. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
477 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
478 @node Echo Area Customization |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
479 @subsection Echo Area Customization |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
480 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
481 These variables control details of how the echo area works. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
482 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
483 @defvar cursor-in-echo-area |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
484 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
|
485 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
|
486 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
|
487 point---not in the echo area at all. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
488 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
489 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
|
490 for brief periods of time. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
491 @end defvar |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
492 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
493 @defvar echo-area-clear-hook |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
494 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
|
495 @code{(message nil)} or for any other reason. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
496 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
497 |
12098 | 498 @defvar echo-keystrokes |
499 This variable determines how much time should elapse before command | |
27971 | 500 characters echo. Its value must be an integer or floating point number, |
501 which specifies the | |
12098 | 502 number of seconds to wait before echoing. If the user types a prefix |
503 key (such as @kbd{C-x}) and then delays this many seconds before | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
504 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
|
505 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
|
506 sequence are echoed immediately.) |
12098 | 507 |
508 If the value is zero, then command input is not echoed. | |
509 @end defvar | |
510 | |
63957
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
511 @defvar message-truncate-lines |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
512 Normally, displaying a long message resizes the echo area to display |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
513 the entire message. But if the variable @code{message-truncate-lines} |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
514 is non-@code{nil}, the echo area does not resize, and the message is |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
515 truncated to fit it, as in Emacs 20 and before. |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
516 @end defvar |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
517 |
64841
c171f553d289
(Echo Area Customization): Don't define max-mini-window-height here;
Richard M. Stallman <rms@gnu.org>
parents:
64411
diff
changeset
|
518 The variable @code{max-mini-window-height}, which specifies the |
c171f553d289
(Echo Area Customization): Don't define max-mini-window-height here;
Richard M. Stallman <rms@gnu.org>
parents:
64411
diff
changeset
|
519 maximum height for resizing minibuffer windows, also applies to the |
c171f553d289
(Echo Area Customization): Don't define max-mini-window-height here;
Richard M. Stallman <rms@gnu.org>
parents:
64411
diff
changeset
|
520 echo area (which is really a special use of the minibuffer window. |
c171f553d289
(Echo Area Customization): Don't define max-mini-window-height here;
Richard M. Stallman <rms@gnu.org>
parents:
64411
diff
changeset
|
521 @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
|
522 |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
523 @node Warnings |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
524 @section Reporting Warnings |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
525 @cindex warnings |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
526 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
527 @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
|
528 possible problem, but continue running. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
529 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
530 @menu |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
531 * 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
|
532 * 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
|
533 * 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
|
534 @end menu |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
535 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
536 @node Warning Basics |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
537 @subsection Warning Basics |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
538 @cindex severity level |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
539 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
540 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
|
541 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
|
542 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
|
543 meanings: |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
544 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
545 @table @code |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
546 @item :emergency |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
547 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
|
548 if you do not attend to it promptly. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
549 @item :error |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
550 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
|
551 @item :warning |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
552 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
|
553 raise suspicion of a possible problem. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
554 @item :debug |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
555 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
|
556 @end table |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
557 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
558 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
|
559 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
|
560 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
|
561 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
|
562 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
|
563 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
|
564 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
|
565 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
|
566 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
|
567 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
|
568 @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
|
569 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
|
570 |
52156
198af82c7606
(Warning Basics): Fix typo.
John Paul Wallington <jpw@pobox.com>
parents:
52141
diff
changeset
|
571 @cindex warning type |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
572 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
|
573 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
|
574 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
|
575 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
|
576 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
|
577 list. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
578 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
579 @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
|
580 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
|
581 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
|
582 severity level, with @code{:warning} being the default. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
583 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
584 @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
|
585 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
|
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 @defun lwarn type level message &rest args |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
589 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
|
590 @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
|
591 equivalent to @code{display-warning}. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
592 @end defun |
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 @defun warn message &rest args |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
595 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
|
596 @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
|
597 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
|
598 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
|
599 specify a specific warning type. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
600 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
601 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
602 @node Warning Variables |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
603 @subsection Warning Variables |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
604 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
605 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
|
606 the variables described in this section. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
607 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
608 @defvar warning-levels |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
609 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
|
610 severity levels. Each element defines one severity level, |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
611 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
|
612 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
613 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
|
614 @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
|
615 @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
|
616 @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
|
617 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
|
618 that information. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
619 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
620 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
|
621 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
|
622 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
623 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
|
624 @end defvar |
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 @defvar warning-prefix-function |
54023 | 627 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
|
628 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
|
629 @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
|
630 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
|
631 the beginning of the warning message. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
632 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
633 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
|
634 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
|
635 entry (this value need not be an actual member of |
54023 | 636 @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
|
637 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
|
638 a given severity level. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
639 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
640 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
|
641 to call. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
642 @end defvar |
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 @defvar warning-series |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
645 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
|
646 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
|
647 that means to leave point on the first warning of the series, rather |
54023 | 648 than keep moving it for each warning so that it appears on the last one. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
649 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
|
650 @code{warning-series} becomes @code{nil} again. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
651 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
652 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
|
653 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
|
654 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
|
655 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
|
656 of warnings. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
657 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
658 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
|
659 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
|
660 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
661 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
|
662 each warning separately. |
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 @defvar warning-fill-prefix |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
666 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
|
667 use for filling each warning's text. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
668 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
669 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
670 @defvar warning-type-format |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
671 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
|
672 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
|
673 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
|
674 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
|
675 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
|
676 all. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
677 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
678 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
679 @node Warning Options |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
680 @subsection Warning Options |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
681 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
682 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
|
683 when a Lisp program reports a warning. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
684 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
685 @defopt warning-minimum-level |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
686 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
|
687 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
|
688 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
|
689 warnings. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
690 @end defopt |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
691 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
692 @defopt warning-minimum-log-level |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
693 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
|
694 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
|
695 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
|
696 @end defopt |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
697 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
698 @defopt warning-suppress-types |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
699 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
|
700 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
|
701 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
|
702 type, then that warning is not displayed immediately. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
703 @end defopt |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
704 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
705 @defopt warning-suppress-log-types |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
706 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
|
707 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
|
708 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
|
709 that warning is not logged. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
710 @end defopt |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
711 |
12067 | 712 @node Invisible Text |
713 @section Invisible Text | |
714 | |
715 @cindex invisible text | |
716 You can make characters @dfn{invisible}, so that they do not appear on | |
717 the screen, with the @code{invisible} property. This can be either a | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
718 text property (@pxref{Text Properties}) or a property of an overlay |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
719 (@pxref{Overlays}). Cursor motion also partly ignores these |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
720 characters; if the command loop finds point within them, it moves |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
721 point to the other side of them. |
12067 | 722 |
723 In the simplest case, any non-@code{nil} @code{invisible} property makes | |
724 a character invisible. This is the default case---if you don't alter | |
725 the default value of @code{buffer-invisibility-spec}, this is how the | |
48948
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
726 @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
|
727 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
|
728 to set @code{buffer-invisibility-spec} yourself. |
12067 | 729 |
730 More generally, you can use the variable @code{buffer-invisibility-spec} | |
731 to control which values of the @code{invisible} property make text | |
732 invisible. This permits you to classify the text into different subsets | |
733 in advance, by giving them different @code{invisible} values, and | |
734 subsequently make various subsets visible or invisible by changing the | |
735 value of @code{buffer-invisibility-spec}. | |
736 | |
737 Controlling visibility with @code{buffer-invisibility-spec} is | |
25875 | 738 especially useful in a program to display the list of entries in a |
739 database. It permits the implementation of convenient filtering | |
740 commands to view just a part of the entries in the database. Setting | |
741 this variable is very fast, much faster than scanning all the text in | |
742 the buffer looking for properties to change. | |
12067 | 743 |
744 @defvar buffer-invisibility-spec | |
745 This variable specifies which kinds of @code{invisible} properties | |
56233
e4e80ee3d6db
(Invisible Text): Setting buffer-invisibility-spec makes it buffer-local.
Richard M. Stallman <rms@gnu.org>
parents:
56185
diff
changeset
|
746 actually make a character invisible. Setting this variable makes it |
e4e80ee3d6db
(Invisible Text): Setting buffer-invisibility-spec makes it buffer-local.
Richard M. Stallman <rms@gnu.org>
parents:
56185
diff
changeset
|
747 buffer-local. |
12067 | 748 |
749 @table @asis | |
750 @item @code{t} | |
751 A character is invisible if its @code{invisible} property is | |
752 non-@code{nil}. This is the default. | |
753 | |
754 @item a list | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
755 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
|
756 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
|
757 the character is invisible. The list can have two kinds of elements: |
12067 | 758 |
759 @table @code | |
760 @item @var{atom} | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
761 A character is invisible if its @code{invisible} property value |
12067 | 762 is @var{atom} or if it is a list with @var{atom} as a member. |
763 | |
764 @item (@var{atom} . t) | |
76850
21e50d7ec51d
(Invisible Text): Correct buffer-invisibility-spec regarding ellipsis.
Richard M. Stallman <rms@gnu.org>
parents:
76841
diff
changeset
|
765 A character is invisible if its @code{invisible} property value is |
21e50d7ec51d
(Invisible Text): Correct buffer-invisibility-spec regarding ellipsis.
Richard M. Stallman <rms@gnu.org>
parents:
76841
diff
changeset
|
766 @var{atom} or if it is a list with @var{atom} as a member. Moreover, |
21e50d7ec51d
(Invisible Text): Correct buffer-invisibility-spec regarding ellipsis.
Richard M. Stallman <rms@gnu.org>
parents:
76841
diff
changeset
|
767 a sequence of such characters displays as an ellipsis. |
12067 | 768 @end table |
769 @end table | |
770 @end defvar | |
771 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
772 Two functions are specifically provided for adding elements to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
773 @code{buffer-invisibility-spec} and removing elements from it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
774 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
775 @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
|
776 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
|
777 @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
|
778 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
|
779 @code{invisible} property is @code{t} remains invisible. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
780 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
781 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
782 @defun remove-from-invisibility-spec element |
54023 | 783 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
|
784 @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
|
785 is not in the list. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
786 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
787 |
48948
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
788 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
|
789 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
|
790 @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
|
791 @code{invisible} property: |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
792 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
793 @example |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
794 ;; @r{If you want to display an ellipsis:} |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
795 (add-to-invisibility-spec '(my-symbol . t)) |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
796 ;; @r{If you don't want ellipsis:} |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
797 (add-to-invisibility-spec 'my-symbol) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
798 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
799 (overlay-put (make-overlay beginning end) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
800 'invisible 'my-symbol) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
801 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
802 ;; @r{When done with the overlays:} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
803 (remove-from-invisibility-spec '(my-symbol . t)) |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
804 ;; @r{Or respectively:} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
805 (remove-from-invisibility-spec 'my-symbol) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
806 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
807 |
15761
77d451c08a30
Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
15074
diff
changeset
|
808 @vindex line-move-ignore-invisible |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
809 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
|
810 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
|
811 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
|
812 @code{line-move-ignore-invisible} is non-@code{nil} (the default), but |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
813 only because they are explicitly programmed to do so. |
12098 | 814 |
69462
831f4f793f95
(Invisible Text): The impossible position is
Richard M. Stallman <rms@gnu.org>
parents:
69421
diff
changeset
|
815 However, if a command ends with point inside or immediately before |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
816 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
|
817 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
|
818 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
|
819 moved point back into an invisible range, Emacs moves point back to |
69462
831f4f793f95
(Invisible Text): The impossible position is
Richard M. Stallman <rms@gnu.org>
parents:
69421
diff
changeset
|
820 the beginning of that range, and then back one more character. If the |
831f4f793f95
(Invisible Text): The impossible position is
Richard M. Stallman <rms@gnu.org>
parents:
69421
diff
changeset
|
821 command moved point forward into an invisible range, Emacs moves point |
831f4f793f95
(Invisible Text): The impossible position is
Richard M. Stallman <rms@gnu.org>
parents:
69421
diff
changeset
|
822 forward up to the first visible character that follows the invisible |
831f4f793f95
(Invisible Text): The impossible position is
Richard M. Stallman <rms@gnu.org>
parents:
69421
diff
changeset
|
823 text. |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
824 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
825 Incremental search can make invisible overlays visible temporarily |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
826 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
|
827 this, the overlay should have a non-@code{nil} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
828 @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
|
829 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
|
830 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
|
831 overlaps the overlay on exit from the search. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
832 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
833 During the search, such overlays are made temporarily visible by |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
834 temporarily modifying their invisible and intangible properties. If you |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
835 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
|
836 @code{isearch-open-invisible-temporary} property which is a function. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
837 The function is called with two arguments: the first is the overlay, and |
26986 | 838 the second is @code{nil} to make the overlay visible, or @code{t} to |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
839 make it invisible again. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
840 |
6598 | 841 @node Selective Display |
842 @section Selective Display | |
77010
e009ed31b7cf
Improve index entries. Remove redundant ones.
Richard M. Stallman <rms@gnu.org>
parents:
76850
diff
changeset
|
843 @c @cindex selective display Duplicates selective-display |
6598 | 844 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
845 @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
|
846 hiding certain lines on the screen. |
6598 | 847 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
848 The first variant, explicit selective display, is designed for use |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
849 in a Lisp program: it controls which lines are hidden by altering the |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
850 text. This kind of hiding in some ways resembles the effect of the |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
851 @code{invisible} property (@pxref{Invisible Text}), but the two |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
852 features are different and do not work the same way. |
12067 | 853 |
854 In the second variant, the choice of lines to hide is made | |
12098 | 855 automatically based on indentation. This variant is designed to be a |
12067 | 856 user-level feature. |
6598 | 857 |
858 The way you control explicit selective display is by replacing a | |
9009 | 859 newline (control-j) with a carriage return (control-m). The text that |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
860 was formerly a line following that newline is now hidden. Strictly |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
861 speaking, it is temporarily no longer a line at all, since only |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
862 newlines can separate lines; it is now part of the previous line. |
6598 | 863 |
864 Selective display does not directly affect editing commands. For | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
865 example, @kbd{C-f} (@code{forward-char}) moves point unhesitatingly |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
866 into hidden text. However, the replacement of newline characters with |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
867 carriage return characters affects some editing commands. For |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
868 example, @code{next-line} skips hidden lines, since it searches only |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
869 for newlines. Modes that use selective display can also define |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
870 commands that take account of the newlines, or that control which |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
871 parts of the text are hidden. |
6598 | 872 |
873 When you write a selectively displayed buffer into a file, all the | |
874 control-m's are output as newlines. This means that when you next read | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
875 in the file, it looks OK, with nothing hidden. The selective display |
6598 | 876 effect is seen only within Emacs. |
877 | |
878 @defvar selective-display | |
879 This buffer-local variable enables selective display. This means that | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
880 lines, or portions of lines, may be made hidden. |
6598 | 881 |
882 @itemize @bullet | |
883 @item | |
25875 | 884 If the value of @code{selective-display} is @code{t}, then the character |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
885 control-m marks the start of hidden text; the control-m, and the rest |
25875 | 886 of the line following it, are not displayed. This is explicit selective |
887 display. | |
6598 | 888 |
889 @item | |
890 If the value of @code{selective-display} is a positive integer, then | |
891 lines that start with more than that many columns of indentation are not | |
892 displayed. | |
893 @end itemize | |
894 | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
895 When some portion of a buffer is hidden, the vertical movement |
6598 | 896 commands operate as if that portion did not exist, allowing a single |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
897 @code{next-line} command to skip any number of hidden lines. |
6598 | 898 However, character movement commands (such as @code{forward-char}) do |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
899 not skip the hidden portion, and it is possible (if tricky) to insert |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
900 or delete text in an hidden portion. |
6598 | 901 |
902 In the examples below, we show the @emph{display appearance} of the | |
903 buffer @code{foo}, which changes with the value of | |
904 @code{selective-display}. The @emph{contents} of the buffer do not | |
905 change. | |
906 | |
907 @example | |
908 @group | |
909 (setq selective-display nil) | |
910 @result{} nil | |
911 | |
912 ---------- Buffer: foo ---------- | |
913 1 on this column | |
914 2on this column | |
915 3n this column | |
916 3n this column | |
917 2on this column | |
918 1 on this column | |
919 ---------- Buffer: foo ---------- | |
920 @end group | |
921 | |
922 @group | |
923 (setq selective-display 2) | |
924 @result{} 2 | |
925 | |
926 ---------- Buffer: foo ---------- | |
927 1 on this column | |
928 2on this column | |
929 2on this column | |
930 1 on this column | |
931 ---------- Buffer: foo ---------- | |
932 @end group | |
933 @end example | |
934 @end defvar | |
935 | |
936 @defvar selective-display-ellipses | |
937 If this buffer-local variable is non-@code{nil}, then Emacs displays | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
938 @samp{@dots{}} at the end of a line that is followed by hidden text. |
6598 | 939 This example is a continuation of the previous one. |
940 | |
941 @example | |
942 @group | |
943 (setq selective-display-ellipses t) | |
944 @result{} t | |
945 | |
946 ---------- Buffer: foo ---------- | |
947 1 on this column | |
948 2on this column ... | |
949 2on this column | |
950 1 on this column | |
951 ---------- Buffer: foo ---------- | |
952 @end group | |
953 @end example | |
954 | |
955 You can use a display table to substitute other text for the ellipsis | |
956 (@samp{@dots{}}). @xref{Display Tables}. | |
957 @end defvar | |
958 | |
959 @node Temporary Displays | |
960 @section Temporary Displays | |
961 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
962 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
|
963 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
|
964 editing. Many help commands use this feature. |
6598 | 965 |
966 @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
|
967 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
|
968 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
|
969 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
|
970 displayed in some window, but not selected. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
971 |
52923
41c0ac1a4ed4
(Temporary Displays): Add xref to `Documentation Tips'.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52903
diff
changeset
|
972 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
|
973 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
|
974 @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
|
975 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
|
976 into clickable cross-references. @xref{Docstring hyperlinks, , Tips |
67874c814e45
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
977 for Documentation Strings}, in particular the item on hyperlinks in |
67874c814e45
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
978 documentation strings, for more details. |
6598 | 979 |
980 The string @var{buffer-name} specifies the temporary buffer, which | |
981 need not already exist. The argument must be a string, not a buffer. | |
982 The buffer is erased initially (with no questions asked), and it is | |
983 marked as unmodified after @code{with-output-to-temp-buffer} exits. | |
984 | |
985 @code{with-output-to-temp-buffer} binds @code{standard-output} to the | |
986 temporary buffer, then it evaluates the forms in @var{forms}. Output | |
987 using the Lisp output functions within @var{forms} goes by default to | |
988 that buffer (but screen display and messages in the echo area, although | |
989 they are ``output'' in the general sense of the word, are not affected). | |
990 @xref{Output Functions}. | |
991 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
992 Several hooks are available for customizing the behavior |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
993 of this construct; they are listed below. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
994 |
6598 | 995 The value of the last form in @var{forms} is returned. |
996 | |
997 @example | |
998 @group | |
999 ---------- Buffer: foo ---------- | |
1000 This is the contents of foo. | |
1001 ---------- Buffer: foo ---------- | |
1002 @end group | |
1003 | |
1004 @group | |
1005 (with-output-to-temp-buffer "foo" | |
1006 (print 20) | |
1007 (print standard-output)) | |
1008 @result{} #<buffer foo> | |
1009 | |
1010 ---------- Buffer: foo ---------- | |
1011 20 | |
1012 | |
1013 #<buffer foo> | |
1014 | |
1015 ---------- Buffer: foo ---------- | |
1016 @end group | |
1017 @end example | |
1018 @end defspec | |
1019 | |
1020 @defvar temp-buffer-show-function | |
9009 | 1021 If this variable is non-@code{nil}, @code{with-output-to-temp-buffer} |
6598 | 1022 calls it as a function to do the job of displaying a help buffer. The |
1023 function gets one argument, which is the buffer it should display. | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1024 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1025 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
|
1026 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
|
1027 @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
|
1028 selected. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1029 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1030 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1031 @defvar temp-buffer-setup-hook |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1032 This normal hook is run by @code{with-output-to-temp-buffer} before |
42082 | 1033 evaluating @var{body}. When the hook runs, the temporary buffer is |
1034 current. This hook is normally set up with a function to put the | |
1035 buffer in Help mode. | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1036 @end defvar |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1037 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1038 @defvar temp-buffer-show-hook |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1039 This normal hook is run by @code{with-output-to-temp-buffer} after |
42082 | 1040 displaying the temporary buffer. When the hook runs, the temporary buffer |
1041 is current, and the window it was displayed in is selected. This hook | |
1042 is normally set up with a function to make the buffer read only, and | |
1043 find function names and variable names in it, provided the major mode | |
1044 is Help mode. | |
6598 | 1045 @end defvar |
1046 | |
1047 @defun momentary-string-display string position &optional char message | |
1048 This function momentarily displays @var{string} in the current buffer at | |
1049 @var{position}. It has no effect on the undo list or on the buffer's | |
1050 modification status. | |
1051 | |
1052 The momentary display remains until the next input event. If the next | |
1053 input event is @var{char}, @code{momentary-string-display} ignores it | |
1054 and returns. Otherwise, that event remains buffered for subsequent use | |
1055 as input. Thus, typing @var{char} will simply remove the string from | |
1056 the display, while typing (say) @kbd{C-f} will remove the string from | |
1057 the display and later (presumably) move point forward. The argument | |
1058 @var{char} is a space by default. | |
1059 | |
1060 The return value of @code{momentary-string-display} is not meaningful. | |
1061 | |
12098 | 1062 If the string @var{string} does not contain control characters, you can |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1063 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
|
1064 deleting) an overlay with a @code{before-string} property. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1065 @xref{Overlay Properties}. |
12098 | 1066 |
6598 | 1067 If @var{message} is non-@code{nil}, it is displayed in the echo area |
1068 while @var{string} is displayed in the buffer. If it is @code{nil}, a | |
1069 default message says to type @var{char} to continue. | |
1070 | |
1071 In this example, point is initially located at the beginning of the | |
1072 second line: | |
1073 | |
1074 @example | |
1075 @group | |
1076 ---------- Buffer: foo ---------- | |
1077 This is the contents of foo. | |
1078 @point{}Second line. | |
1079 ---------- Buffer: foo ---------- | |
1080 @end group | |
1081 | |
1082 @group | |
1083 (momentary-string-display | |
1084 "**** Important Message! ****" | |
1085 (point) ?\r | |
1086 "Type RET when done reading") | |
1087 @result{} t | |
1088 @end group | |
1089 | |
1090 @group | |
1091 ---------- Buffer: foo ---------- | |
1092 This is the contents of foo. | |
1093 **** Important Message! ****Second line. | |
1094 ---------- Buffer: foo ---------- | |
1095 | |
1096 ---------- Echo Area ---------- | |
1097 Type RET when done reading | |
1098 ---------- Echo Area ---------- | |
1099 @end group | |
1100 @end example | |
1101 @end defun | |
1102 | |
1103 @node Overlays | |
1104 @section Overlays | |
1105 @cindex overlays | |
1106 | |
1107 You can use @dfn{overlays} to alter the appearance of a buffer's text on | |
12098 | 1108 the screen, for the sake of presentation features. An overlay is an |
1109 object that belongs to a particular buffer, and has a specified | |
1110 beginning and end. It also has properties that you can examine and set; | |
1111 these affect the display of the text within the overlay. | |
6598 | 1112 |
68084 | 1113 An overlay uses markers to record its beginning and end; thus, |
54023 | 1114 editing the text of the buffer adjusts the beginning and end of each |
1115 overlay so that it stays with the text. When you create the overlay, | |
1116 you can specify whether text inserted at the beginning should be | |
1117 inside the overlay or outside, and likewise for the end of the overlay. | |
1118 | |
6598 | 1119 @menu |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1120 * 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
|
1121 * Overlay Properties:: How to read and set properties. |
6598 | 1122 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
|
1123 * Finding Overlays:: Searching for overlays. |
6598 | 1124 @end menu |
1125 | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1126 @node Managing Overlays |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1127 @subsection Managing Overlays |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1128 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1129 This section describes the functions to create, delete and move |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1130 overlays, and to examine their contents. Overlay changes are not |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1131 recorded in the buffer's undo list, since the overlays are not |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1132 part of the buffer's contents. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1133 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1134 @defun overlayp object |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1135 This function returns @code{t} if @var{object} is an overlay. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1136 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1137 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1138 @defun make-overlay start end &optional buffer front-advance rear-advance |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1139 This function creates and returns an overlay that belongs to |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1140 @var{buffer} and ranges from @var{start} to @var{end}. Both @var{start} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1141 and @var{end} must specify buffer positions; they may be integers or |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1142 markers. If @var{buffer} is omitted, the overlay is created in the |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1143 current buffer. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1144 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1145 The arguments @var{front-advance} and @var{rear-advance} specify the |
64411
4dcefa44889e
(Managing Overlays): Clarify make-overlay args for insertion types.
Richard M. Stallman <rms@gnu.org>
parents:
64174
diff
changeset
|
1146 marker insertion type for the start of the overlay and for the end of |
4dcefa44889e
(Managing Overlays): Clarify make-overlay args for insertion types.
Richard M. Stallman <rms@gnu.org>
parents:
64174
diff
changeset
|
1147 the overlay, respectively. @xref{Marker Insertion Types}. If they |
4dcefa44889e
(Managing Overlays): Clarify make-overlay args for insertion types.
Richard M. Stallman <rms@gnu.org>
parents:
64174
diff
changeset
|
1148 are both @code{nil}, the default, then the overlay extends to include |
4dcefa44889e
(Managing Overlays): Clarify make-overlay args for insertion types.
Richard M. Stallman <rms@gnu.org>
parents:
64174
diff
changeset
|
1149 any text inserted at the beginning, but not text inserted at the end. |
4dcefa44889e
(Managing Overlays): Clarify make-overlay args for insertion types.
Richard M. Stallman <rms@gnu.org>
parents:
64174
diff
changeset
|
1150 If @var{front-advance} is non-@code{nil}, text inserted at the |
4dcefa44889e
(Managing Overlays): Clarify make-overlay args for insertion types.
Richard M. Stallman <rms@gnu.org>
parents:
64174
diff
changeset
|
1151 beginning of the overlay is excluded from the overlay. If |
4dcefa44889e
(Managing Overlays): Clarify make-overlay args for insertion types.
Richard M. Stallman <rms@gnu.org>
parents:
64174
diff
changeset
|
1152 @var{rear-advance} is non-@code{nil}, text inserted at the end of the |
4dcefa44889e
(Managing Overlays): Clarify make-overlay args for insertion types.
Richard M. Stallman <rms@gnu.org>
parents:
64174
diff
changeset
|
1153 overlay is included in the overlay. |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1154 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1155 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1156 @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
|
1157 This function returns the position at which @var{overlay} starts, |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1158 as an integer. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1159 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1160 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1161 @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
|
1162 This function returns the position at which @var{overlay} ends, |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1163 as an integer. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1164 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1165 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1166 @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
|
1167 This function returns the buffer that @var{overlay} belongs to. It |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1168 returns @code{nil} if @var{overlay} has been deleted. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1169 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1170 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1171 @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
|
1172 This function deletes @var{overlay}. The overlay continues to exist as |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1173 a Lisp object, and its property list is unchanged, but it ceases to be |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1174 attached to the buffer it belonged to, and ceases to have any effect on |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1175 display. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1176 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1177 A deleted overlay is not permanently disconnected. You can give it a |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1178 position in a buffer again by calling @code{move-overlay}. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1179 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1180 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1181 @defun move-overlay overlay start end &optional buffer |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1182 This function moves @var{overlay} to @var{buffer}, and places its bounds |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1183 at @var{start} and @var{end}. Both arguments @var{start} and @var{end} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1184 must specify buffer positions; they may be integers or markers. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1185 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1186 If @var{buffer} is omitted, @var{overlay} stays in the same buffer it |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1187 was already associated with; if @var{overlay} was deleted, it goes into |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1188 the current buffer. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1189 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1190 The return value is @var{overlay}. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1191 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1192 This is the only valid way to change the endpoints of an overlay. Do |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1193 not try modifying the markers in the overlay by hand, as that fails to |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1194 update other vital data structures and can cause some overlays to be |
71957
61cb5aae3bc3
Put period and comma inside quotes.
Richard M. Stallman <rms@gnu.org>
parents:
71882
diff
changeset
|
1195 ``lost.'' |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1196 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1197 |
60782
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1198 @defun remove-overlays &optional start end name value |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1199 This function removes all the overlays between @var{start} and |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1200 @var{end} whose property @var{name} has the value @var{value}. It can |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1201 move the endpoints of the overlays in the region, or split them. |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1202 |
61980
f3d536670495
Fix typos and Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61972
diff
changeset
|
1203 If @var{name} is omitted or @code{nil}, it means to delete all overlays in |
60782
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1204 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
|
1205 @code{nil}, that means the beginning and end of the buffer respectively. |
60782
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1206 Therefore, @code{(remove-overlays)} removes all the overlays in the |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1207 current buffer. |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1208 @end defun |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1209 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1210 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
|
1211 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1212 @example |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1213 ;; @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
|
1214 (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
|
1215 @result{} #<overlay from 1 to 10 in display.texi> |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1216 (overlay-start foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1217 @result{} 1 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1218 (overlay-end foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1219 @result{} 10 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1220 (overlay-buffer foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1221 @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
|
1222 ;; @r{Give it a property we can check later.} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1223 (overlay-put foo 'happy t) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1224 @result{} t |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1225 ;; @r{Verify the property is present.} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1226 (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
|
1227 @result{} t |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1228 ;; @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
|
1229 (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
|
1230 @result{} #<overlay from 5 to 20 in display.texi> |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1231 (overlay-start foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1232 @result{} 5 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1233 (overlay-end foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1234 @result{} 20 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1235 ;; @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
|
1236 (delete-overlay foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1237 @result{} nil |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1238 ;; @r{Verify it is deleted.} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1239 foo |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1240 @result{} #<overlay in no buffer> |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1241 ;; @r{A deleted overlay has no position.} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1242 (overlay-start foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1243 @result{} nil |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1244 (overlay-end foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1245 @result{} nil |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1246 (overlay-buffer foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1247 @result{} nil |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1248 ;; @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
|
1249 (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
|
1250 @result{} #<overlay from 1 to 20 in display.texi> |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1251 ;; @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
|
1252 (overlay-start foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1253 @result{} 1 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1254 (overlay-end foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1255 @result{} 20 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1256 (overlay-buffer foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1257 @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
|
1258 ;; @r{Moving and deleting the overlay does not change its properties.} |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1259 (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
|
1260 @result{} t |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1261 @end example |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1262 |
73780
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1263 Emacs stores the overlays of each buffer in two lists, divided |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1264 around an arbitrary ``center position.'' One list extends backwards |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1265 through the buffer from that center position, and the other extends |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1266 forwards from that center position. The center position can be anywhere |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1267 in the buffer. |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1268 |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1269 @defun overlay-recenter pos |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1270 This function recenters the overlays of the current buffer around |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1271 position @var{pos}. That makes overlay lookup faster for positions |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1272 near @var{pos}, but slower for positions far away from @var{pos}. |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1273 @end defun |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1274 |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1275 A loop that scans the buffer forwards, creating overlays, can run |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1276 faster if you do @code{(overlay-recenter (point-max))} first. |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1277 |
6598 | 1278 @node Overlay Properties |
1279 @subsection Overlay Properties | |
1280 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1281 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
|
1282 alter how a character is displayed can come from either source. But in |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1283 most respects they are different. @xref{Text Properties}, for comparison. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1284 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1285 Text properties are considered a part of the text; overlays and |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1286 their properties are specifically considered not to be part of the |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1287 text. Thus, copying text between various buffers and strings |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1288 preserves text properties, but does not try to preserve overlays. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1289 Changing a buffer's text properties marks the buffer as modified, |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1290 while moving an overlay or changing its properties does not. Unlike |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1291 text property changes, overlay property changes are not recorded in |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1292 the buffer's undo list. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1293 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1294 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
|
1295 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1296 @defun overlay-get overlay prop |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1297 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
|
1298 @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
|
1299 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
|
1300 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
|
1301 is @code{nil}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1302 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1303 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1304 @defun overlay-put overlay prop value |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1305 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
|
1306 @var{overlay} to @var{value}. It returns @var{value}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1307 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1308 |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1309 @defun overlay-properties overlay |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1310 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
|
1311 @end defun |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1312 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1313 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
|
1314 overlay properties and text properties for a given character. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1315 @xref{Examining Properties}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1316 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1317 Many overlay properties have special meanings; here is a table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1318 of them: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1319 |
6598 | 1320 @table @code |
1321 @item priority | |
1322 @kindex priority @r{(overlay property)} | |
52380
7a80a66265e6
(Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents:
52156
diff
changeset
|
1323 This property's value (which should be a nonnegative integer number) |
7a80a66265e6
(Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents:
52156
diff
changeset
|
1324 determines the priority of the overlay. The priority matters when two |
7a80a66265e6
(Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents:
52156
diff
changeset
|
1325 or more overlays cover the same character and both specify the same |
7a80a66265e6
(Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents:
52156
diff
changeset
|
1326 property; the one whose @code{priority} value is larger takes priority |
7a80a66265e6
(Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents:
52156
diff
changeset
|
1327 over the other. For the @code{face} property, the higher priority |
7a80a66265e6
(Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents:
52156
diff
changeset
|
1328 value does not completely replace the other; instead, its face |
7a80a66265e6
(Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents:
52156
diff
changeset
|
1329 attributes override the face attributes of the lower priority |
7a80a66265e6
(Overlay Properties): Clarify how priorities affect use of the properties.
Richard M. Stallman <rms@gnu.org>
parents:
52156
diff
changeset
|
1330 @code{face} property. |
6598 | 1331 |
1332 Currently, all overlays take priority over text properties. Please | |
1333 avoid using negative priority values, as we have not yet decided just | |
1334 what they should mean. | |
1335 | |
1336 @item window | |
1337 @kindex window @r{(overlay property)} | |
1338 If the @code{window} property is non-@code{nil}, then the overlay | |
1339 applies only on that window. | |
1340 | |
12067 | 1341 @item category |
1342 @kindex category @r{(overlay property)} | |
1343 If an overlay has a @code{category} property, we call it the | |
12098 | 1344 @dfn{category} of the overlay. It should be a symbol. The properties |
12067 | 1345 of the symbol serve as defaults for the properties of the overlay. |
1346 | |
6598 | 1347 @item face |
1348 @kindex face @r{(overlay property)} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1349 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
|
1350 font and which colors. @xref{Faces}, for more information. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1351 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1352 In the simplest case, the value is a face name. It can also be a list; |
25875 | 1353 then each element can be any of these possibilities: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1354 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1355 @itemize @bullet |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1356 @item |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1357 A face name (a symbol or string). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1358 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1359 @item |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1360 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
|
1361 @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
|
1362 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
|
1363 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
|
1364 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
|
1365 Attributes}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1366 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1367 @item |
77123 | 1368 A cons cell, either of the form @code{(foreground-color . @var{color-name})} or |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1369 @code{(background-color . @var{color-name})}. These elements specify |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1370 just the foreground color or just the background color. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1371 |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
1372 @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
|
1373 @code{(:foreground @var{color-name})}; likewise for the background. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1374 @end itemize |
6598 | 1375 |
1376 @item mouse-face | |
1377 @kindex mouse-face @r{(overlay property)} | |
1378 This property is used instead of @code{face} when the mouse is within | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1379 the range of the overlay. |
6598 | 1380 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1381 @item display |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1382 @kindex display @r{(overlay property)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1383 This property activates various features that change the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1384 way text is displayed. For example, it can make text appear taller |
38278 | 1385 or shorter, higher or lower, wider or narrower, or replaced with an image. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1386 @xref{Display Property}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1387 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1388 @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
|
1389 @kindex help-echo @r{(overlay property)} |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
1390 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
|
1391 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
|
1392 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
|
1393 help-echo}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1394 |
6598 | 1395 @item modification-hooks |
1396 @kindex modification-hooks @r{(overlay property)} | |
1397 This property's value is a list of functions to be called if any | |
1398 character within the overlay is changed or if text is inserted strictly | |
12067 | 1399 within the overlay. |
1400 | |
1401 The hook functions are called both before and after each change. | |
1402 If the functions save the information they receive, and compare notes | |
1403 between calls, they can determine exactly what change has been made | |
1404 in the buffer text. | |
1405 | |
1406 When called before a change, each function receives four arguments: the | |
1407 overlay, @code{nil}, and the beginning and end of the text range to be | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6598
diff
changeset
|
1408 modified. |
6598 | 1409 |
12067 | 1410 When called after a change, each function receives five arguments: the |
1411 overlay, @code{t}, the beginning and end of the text range just | |
1412 modified, and the length of the pre-change text replaced by that range. | |
1413 (For an insertion, the pre-change length is zero; for a deletion, that | |
1414 length is the number of characters deleted, and the post-change | |
12098 | 1415 beginning and end are equal.) |
12067 | 1416 |
64156
06f333c0aec7
(Inverse Video): Delete mode-line-inverse-video.
Richard M. Stallman <rms@gnu.org>
parents:
63967
diff
changeset
|
1417 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
|
1418 @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
|
1419 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
|
1420 |
77542
170b9bea2267
(Overlay Properties): Add xref to Special Properties.
Richard M. Stallman <rms@gnu.org>
parents:
77360
diff
changeset
|
1421 Text properties also support the @code{modification-hooks} property, |
170b9bea2267
(Overlay Properties): Add xref to Special Properties.
Richard M. Stallman <rms@gnu.org>
parents:
77360
diff
changeset
|
1422 but the details are somewhat different (@pxref{Special Properties}). |
170b9bea2267
(Overlay Properties): Add xref to Special Properties.
Richard M. Stallman <rms@gnu.org>
parents:
77360
diff
changeset
|
1423 |
6598 | 1424 @item insert-in-front-hooks |
1425 @kindex insert-in-front-hooks @r{(overlay property)} | |
12067 | 1426 This property's value is a list of functions to be called before and |
1427 after inserting text right at the beginning of the overlay. The calling | |
1428 conventions are the same as for the @code{modification-hooks} functions. | |
6598 | 1429 |
1430 @item insert-behind-hooks | |
1431 @kindex insert-behind-hooks @r{(overlay property)} | |
12067 | 1432 This property's value is a list of functions to be called before and |
1433 after inserting text right at the end of the overlay. The calling | |
1434 conventions are the same as for the @code{modification-hooks} functions. | |
6598 | 1435 |
1436 @item invisible | |
1437 @kindex invisible @r{(overlay property)} | |
12067 | 1438 The @code{invisible} property can make the text in the overlay |
1439 invisible, which means that it does not appear on the screen. | |
1440 @xref{Invisible Text}, for details. | |
1441 | |
1442 @item intangible | |
1443 @kindex intangible @r{(overlay property)} | |
1444 The @code{intangible} property on an overlay works just like the | |
12098 | 1445 @code{intangible} text property. @xref{Special Properties}, for details. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1446 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1447 @item isearch-open-invisible |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1448 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
|
1449 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
|
1450 Text}. |
6598 | 1451 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1452 @item isearch-open-invisible-temporary |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1453 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
|
1454 visible, temporarily, during the search. @xref{Invisible Text}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1455 |
6598 | 1456 @item before-string |
1457 @kindex before-string @r{(overlay property)} | |
1458 This property's value is a string to add to the display at the beginning | |
1459 of the overlay. The string does not appear in the buffer in any | |
25875 | 1460 sense---only on the screen. |
6598 | 1461 |
1462 @item after-string | |
1463 @kindex after-string @r{(overlay property)} | |
1464 This property's value is a string to add to the display at the end of | |
1465 the overlay. The string does not appear in the buffer in any | |
25875 | 1466 sense---only on the screen. |
12067 | 1467 |
1468 @item evaporate | |
1469 @kindex evaporate @r{(overlay property)} | |
1470 If this property is non-@code{nil}, the overlay is deleted automatically | |
56451
b190e160aa91
(Overlay Properties): Adding `evaporate' prop deletes empty overlay immediately.
Richard M. Stallman <rms@gnu.org>
parents:
56437
diff
changeset
|
1471 if it becomes empty (i.e., if its length becomes zero). If you give |
b190e160aa91
(Overlay Properties): Adding `evaporate' prop deletes empty overlay immediately.
Richard M. Stallman <rms@gnu.org>
parents:
56437
diff
changeset
|
1472 an empty overlay a non-@code{nil} @code{evaporate} property, that deletes |
b190e160aa91
(Overlay Properties): Adding `evaporate' prop deletes empty overlay immediately.
Richard M. Stallman <rms@gnu.org>
parents:
56437
diff
changeset
|
1473 it immediately. |
16123
ec5f48fe0320
Mention local-value property on an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
15761
diff
changeset
|
1474 |
29102 | 1475 @item local-map |
29076 | 1476 @cindex keymap of character (and overlays) |
29102 | 1477 @kindex local-map @r{(overlay property)} |
29076 | 1478 If this property is non-@code{nil}, it specifies a keymap for a portion |
1479 of the text. The property's value replaces the buffer's local map, when | |
1480 the character after point is within the overlay. @xref{Active Keymaps}. | |
33996 | 1481 |
1482 @item keymap | |
1483 @kindex keymap @r{(overlay property)} | |
1484 The @code{keymap} property is similar to @code{local-map} but overrides the | |
1485 buffer's local map (and the map specified by the @code{local-map} | |
1486 property) rather than replacing it. | |
29076 | 1487 @end table |
1488 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1489 @node Finding Overlays |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1490 @subsection Searching for Overlays |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1491 |
6598 | 1492 @defun overlays-at pos |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1493 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
|
1494 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
|
1495 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
|
1496 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
|
1497 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1498 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
|
1499 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
|
1500 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1501 @smallexample |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1502 (defun find-overlays-specifying (prop) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1503 (let ((overlays (overlays-at (point))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1504 found) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1505 (while overlays |
37170
29f2615d958f
(Finding Overlays): Fix example code.
Gerd Moellmann <gerd@gnu.org>
parents:
36935
diff
changeset
|
1506 (let ((overlay (car overlays))) |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1507 (if (overlay-get overlay prop) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1508 (setq found (cons overlay found)))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1509 (setq overlays (cdr overlays))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1510 found)) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1511 @end smallexample |
6598 | 1512 @end defun |
1513 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1514 @defun overlays-in beg end |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1515 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
|
1516 @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
|
1517 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
|
1518 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
|
1519 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
|
1520 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1521 |
6598 | 1522 @defun next-overlay-change pos |
1523 This function returns the buffer position of the next beginning or end | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1524 of an overlay, after @var{pos}. If there is none, it returns |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1525 @code{(point-max)}. |
6598 | 1526 @end defun |
1527 | |
12067 | 1528 @defun previous-overlay-change pos |
1529 This function returns the buffer position of the previous beginning or | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1530 end of an overlay, before @var{pos}. If there is none, it returns |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1531 @code{(point-min)}. |
12067 | 1532 @end defun |
1533 | |
76301
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1534 As an example, here's a simplified (and inefficient) version of the |
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1535 primitive function @code{next-single-char-property-change} |
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1536 (@pxref{Property Search}). It searches forward from position |
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1537 @var{pos} for the next position where the value of a given property |
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1538 @code{prop}, as obtained from either overlays or text properties, |
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1539 changes. |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1540 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1541 @smallexample |
76301
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1542 (defun next-single-char-property-change (position prop) |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1543 (save-excursion |
76301
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1544 (goto-char position) |
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1545 (let ((propval (get-char-property (point) prop))) |
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1546 (while (and (not (eobp)) |
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1547 (eq (get-char-property (point) prop) propval)) |
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1548 (goto-char (min (next-overlay-change (point)) |
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1549 (next-single-property-change (point) prop))))) |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1550 (point))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1551 @end smallexample |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1552 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1553 @node Width |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1554 @section Width |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1555 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1556 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
|
1557 check the width of a character. @xref{Primitive Indent}, and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1558 @ref{Screen Lines}, for related functions. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1559 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1560 @defun char-width char |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1561 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
|
1562 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
|
1563 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1564 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1565 @defun string-width string |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1566 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
|
1567 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
|
1568 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1569 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1570 @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
|
1571 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
|
1572 @var{width} columns, as a new string. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1573 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1574 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
|
1575 @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
|
1576 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
|
1577 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
|
1578 go beyond it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1579 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1580 The optional argument @var{start-column} specifies the starting column. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1581 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
|
1582 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
|
1583 @var{string} extends across the column @var{start-column}, that |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1584 character is not included. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1585 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1586 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
|
1587 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
|
1588 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
|
1589 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
|
1590 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
|
1591 @var{string} extends across the column @var{start-column}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1592 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1593 If @var{ellipsis} is non-@code{nil}, it should be a string which will |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1594 replace the end of @var{str} (including any padding) if it extends |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1595 beyond @var{end-column}, unless the display width of @var{str} is |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1596 equal to or less than the display width of @var{ellipsis}. If |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1597 @var{ellipsis} is non-@code{nil} and not a string, it stands for |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1598 @code{"..."}. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1599 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1600 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1601 (truncate-string-to-width "\tab\t" 12 4) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1602 @result{} "ab" |
52002
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
1603 (truncate-string-to-width "\tab\t" 12 4 ?\s) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1604 @result{} " ab " |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1605 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1606 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1607 |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1608 @node Line Height |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1609 @section Line Height |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1610 @cindex line height |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1611 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1612 The total height of each display line consists of the height of the |
71103
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1613 contents of the line, plus optional additional vertical line spacing |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1614 above or below the display line. |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1615 |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1616 The height of the line contents is the maximum height of any |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1617 character or image on that display line, including the final newline |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1618 if there is one. (A display line that is continued doesn't include a |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1619 final newline.) That is the default line height, if you do nothing to |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1620 specify a greater height. (In the most common case, this equals the |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1621 height of the default frame font.) |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1622 |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1623 There are several ways to explicitly specify a larger line height, |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1624 either by specifying an absolute height for the display line, or by |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1625 specifying vertical space. However, no matter what you specify, the |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1626 actual line height can never be less than the default. |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1627 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1628 @kindex line-height @r{(text property)} |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1629 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
|
1630 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
|
1631 newline. |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1632 |
71103
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1633 If the property value is @code{t}, the newline character has no |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1634 effect on the displayed height of the line---the visible contents |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1635 alone determine the height. This is useful for tiling small images |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1636 (or image slices) without adding blank areas between the images. |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1637 |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1638 If the property value is a list of the form @code{(@var{height} |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1639 @var{total})}, that adds extra space @emph{below} the display line. |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1640 First Emacs uses @var{height} as a height spec to control extra space |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1641 @emph{above} the line; then it adds enough space @emph{below} the line |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1642 to bring the total line height up to @var{total}. In this case, the |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1643 other ways to specify the line spacing are ignored. |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1644 |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1645 Any other kind of property value is a height spec, which translates |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1646 into a number---the specified line height. There are several ways to |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1647 write a height spec; here's how each of them translates into a number: |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1648 |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1649 @table @code |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1650 @item @var{integer} |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1651 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
|
1652 @item @var{float} |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1653 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
|
1654 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
|
1655 @item (@var{face} . @var{ratio}) |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1656 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
|
1657 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
|
1658 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
|
1659 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
|
1660 @item (nil . @var{ratio}) |
59212
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1661 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
|
1662 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
|
1663 @end table |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1664 |
71103
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1665 Thus, any valid height spec determines the height in pixels, one way |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1666 or another. If the line contents' height is less than that, Emacs |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1667 adds extra vertical space above the line to achieve the specified |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1668 total height. |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1669 |
61980
f3d536670495
Fix typos and Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61972
diff
changeset
|
1670 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
|
1671 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
|
1672 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
|
1673 parts of Emacs text. |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1674 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1675 @vindex default-line-spacing |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1676 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
|
1677 @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
|
1678 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
|
1679 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
|
1680 parameter. An integer value specifies the number of pixels put below |
68708
c0833efdd110
"Graphical display", not window system.
Richard M. Stallman <rms@gnu.org>
parents:
68648
diff
changeset
|
1681 lines on graphical displays. A floating point number specifies the |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1682 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
|
1683 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1684 @vindex line-spacing |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1685 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
|
1686 buffer-local @code{line-spacing} variable. An integer value specifies |
68708
c0833efdd110
"Graphical display", not window system.
Richard M. Stallman <rms@gnu.org>
parents:
68648
diff
changeset
|
1687 the number of pixels put below lines on graphical displays. A floating |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1688 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
|
1689 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
|
1690 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1691 @kindex line-spacing @r{(text property)} |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1692 Finally, a newline can have a @code{line-spacing} text or overlay |
71103
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1693 property that overrides the default frame line spacing and the buffer |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1694 local @code{line-spacing} variable, for the display line ending in |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1695 that newline. |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1696 |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1697 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
|
1698 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
|
1699 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
|
1700 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
|
1701 height. |
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1702 |
6598 | 1703 @node Faces |
1704 @section Faces | |
40469
aa8474236e9e
Index "faces" instead of "face".
Richard M. Stallman <rms@gnu.org>
parents:
40310
diff
changeset
|
1705 @cindex faces |
6598 | 1706 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1707 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
|
1708 family, foreground color, background color, optional underlining, and |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1709 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
|
1710 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
|
1711 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
|
1712 comes with. |
6598 | 1713 |
1714 @cindex face id | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1715 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
|
1716 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
|
1717 faces in Lisp programs by the symbols that name them. |
6598 | 1718 |
12067 | 1719 @defun facep object |
63777
fd183c9e3b18
(Faces): `facep' returns t for strings that are face names.
Luc Teirlinck <teirllm@auburn.edu>
parents:
63734
diff
changeset
|
1720 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
|
1721 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
|
1722 face data). It returns @code{nil} otherwise. |
12067 | 1723 @end defun |
1724 | |
6598 | 1725 Each face name is meaningful for all frames, and by default it has the |
1726 same meaning in all frames. But you can arrange to give a particular | |
1727 face name a special meaning in one frame if you wish. | |
1728 | |
1729 @menu | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1730 * 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
|
1731 * 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
|
1732 * 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
|
1733 * 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
|
1734 * 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
|
1735 * Face Functions:: How to define and examine faces. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1736 * Auto Faces:: Hook for automatic face assignment. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1737 * Font Lookup:: Looking up the names of available fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1738 and information about them. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1739 * Fontsets:: A fontset is a collection of fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1740 that handle a range of character sets. |
6598 | 1741 @end menu |
1742 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1743 @node Defining Faces |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1744 @subsection Defining Faces |
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 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
|
1747 kind of customization item (@pxref{Customization}) which the user can |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1748 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
|
1749 emacs, The GNU Emacs Manual}). |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1750 |
66143 | 1751 @defmac defface face spec doc [keyword value]@dots{} |
63134
ca65a2108220
(Defining Faces): Explain that face name should not end in `-face'.
Richard M. Stallman <rms@gnu.org>
parents:
63117
diff
changeset
|
1752 This declares @var{face} as a customizable face that defaults |
ca65a2108220
(Defining Faces): Explain that face name should not end in `-face'.
Richard M. Stallman <rms@gnu.org>
parents:
63117
diff
changeset
|
1753 according to @var{spec}. You should not quote the symbol @var{face}, |
ca65a2108220
(Defining Faces): Explain that face name should not end in `-face'.
Richard M. Stallman <rms@gnu.org>
parents:
63117
diff
changeset
|
1754 and it should not end in @samp{-face} (that would be redundant). The |
25875 | 1755 argument @var{doc} specifies the face documentation. The keywords you |
63134
ca65a2108220
(Defining Faces): Explain that face name should not end in `-face'.
Richard M. Stallman <rms@gnu.org>
parents:
63117
diff
changeset
|
1756 can use in @code{defface} are the same as in @code{defgroup} and |
ca65a2108220
(Defining Faces): Explain that face name should not end in `-face'.
Richard M. Stallman <rms@gnu.org>
parents:
63117
diff
changeset
|
1757 @code{defcustom} (@pxref{Common Keywords}). |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1758 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1759 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
|
1760 @var{spec}, then uses any customizations that were read from the |
25875 | 1761 init file (@pxref{Init File}) to override that specification. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1762 |
78146
714a2d0b9062
(Defining Faces): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
78094
diff
changeset
|
1763 When you evaluate a @code{defface} form with @kbd{C-M-x} in Emacs |
78094
7cec7ea0f05d
(Defining Faces): Explain C-M-x feature for defface.
Richard M. Stallman <rms@gnu.org>
parents:
77865
diff
changeset
|
1764 Lisp mode (@code{eval-defun}), a special feature of @code{eval-defun} |
7cec7ea0f05d
(Defining Faces): Explain C-M-x feature for defface.
Richard M. Stallman <rms@gnu.org>
parents:
77865
diff
changeset
|
1765 overrides any customizations of the face. This way, the face reflects |
78146
714a2d0b9062
(Defining Faces): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
78094
diff
changeset
|
1766 exactly what the @code{defface} says. |
78094
7cec7ea0f05d
(Defining Faces): Explain C-M-x feature for defface.
Richard M. Stallman <rms@gnu.org>
parents:
77865
diff
changeset
|
1767 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1768 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
|
1769 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
|
1770 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
|
1771 @sc{car}, @var{display}, specifies a class of terminals. (The first |
68084 | 1772 element, if its @sc{car} is @code{default}, is special---it specifies |
61854
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1773 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
|
1774 @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
|
1775 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
|
1776 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
|
1777 @code{custom-face-attributes}. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1778 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1779 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
|
1780 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
|
1781 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
|
1782 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
|
1783 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1784 @table @asis |
61854
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1785 @item @code{default} |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1786 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
|
1787 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
|
1788 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
|
1789 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
|
1790 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1791 @item @code{t} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1792 This element of @var{spec} matches all frames. Therefore, any |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1793 subsequent elements of @var{spec} are never used. Normally |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1794 @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
|
1795 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1796 @item a list |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1797 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
|
1798 @code{(@var{characteristic} @var{value}@dots{})}. Here |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1799 @var{characteristic} specifies a way of classifying frames, and the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1800 @var{value}s are possible classifications which @var{display} should |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1801 apply to. Here are the possible values of @var{characteristic}: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1802 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1803 @table @code |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1804 @item type |
32802
66f219c7e8ca
(Defining Faces): Document `graphic' display type in face specs.
Miles Bader <miles@gnu.org>
parents:
32552
diff
changeset
|
1805 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
|
1806 graphics-capable display), @code{x}, @code{pc} (for the MS-DOS console), |
70604
cb9bbccfa10f
(Defining Faces): Mention `mac', and add an xref to where window-system is
Eli Zaretskii <eliz@gnu.org>
parents:
69849
diff
changeset
|
1807 @code{w32} (for MS Windows 9X/NT/2K/XP), @code{mac} (for the Macintosh |
cb9bbccfa10f
(Defining Faces): Mention `mac', and add an xref to where window-system is
Eli Zaretskii <eliz@gnu.org>
parents:
69849
diff
changeset
|
1808 display), or @code{tty} (a non-graphics-capable display). |
cb9bbccfa10f
(Defining Faces): Mention `mac', and add an xref to where window-system is
Eli Zaretskii <eliz@gnu.org>
parents:
69849
diff
changeset
|
1809 @xref{Window Systems, window-system}. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1810 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1811 @item class |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1812 What kinds of colors the frame supports---either @code{color}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1813 @code{grayscale}, or @code{mono}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1814 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1815 @item background |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1816 The kind of background---either @code{light} or @code{dark}. |
45745 | 1817 |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1818 @item min-colors |
61854
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1819 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
|
1820 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
|
1821 @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
|
1822 |
45745 | 1823 @item supports |
46170 | 1824 Whether or not the frame can display the face attributes given in |
1825 @var{value}@dots{} (@pxref{Face Attributes}). See the documentation | |
1826 for the function @code{display-supports-face-attributes-p} for more | |
1827 information on exactly how this testing is done. @xref{Display Face | |
1828 Attribute Testing}. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1829 @end table |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1830 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1831 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
|
1832 given @var{characteristic}, any of those values is acceptable. If |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1833 @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
|
1834 different @var{characteristic}; then @emph{each} characteristic of the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1835 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
|
1836 @var{display}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1837 @end table |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1838 @end defmac |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1839 |
25875 | 1840 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
|
1841 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1842 @example |
25875 | 1843 @group |
77026
f9914fb8f8fa
(Defining Faces): Fix example.
Richard M. Stallman <rms@gnu.org>
parents:
77024
diff
changeset
|
1844 (defface region |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1845 '((((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
|
1846 :background "blue3") |
25875 | 1847 @end group |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1848 (((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
|
1849 :background "lightgoldenrod2") |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1850 (((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
|
1851 :background "blue3") |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1852 (((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
|
1853 :background "lightgoldenrod2") |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1854 (((class color) (min-colors 8)) |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1855 :background "blue" :foreground "white") |
25875 | 1856 (((type tty) (class mono)) |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1857 :inverse-video t) |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1858 (t :background "gray")) |
25875 | 1859 @group |
1860 "Basic face for highlighting the region." | |
1861 :group 'basic-faces) | |
1862 @end group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1863 @end example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1864 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1865 Internally, @code{defface} uses the symbol property |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1866 @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
|
1867 @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
|
1868 with the customization buffer, @code{customized-face} for the |
2b9aa367d2f8
(Defining Faces): Add `customized-face'.
Juri Linkov <juri@jurta.org>
parents:
63583
diff
changeset
|
1869 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
|
1870 saved, and @code{face-documentation} for the documentation string. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1871 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1872 @defopt frame-background-mode |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1873 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
|
1874 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
|
1875 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
|
1876 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
|
1877 as if they had a light background. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1878 @end defopt |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1879 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1880 @node Face Attributes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1881 @subsection Face Attributes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1882 @cindex face attributes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1883 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1884 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
|
1885 attributes}. This table lists all the face attributes, and what they |
72175
c9a89b23ca0f
(Face Attributes): Simplify wording.
Richard M. Stallman <rms@gnu.org>
parents:
72058
diff
changeset
|
1886 mean. You can specify more than one face for a given piece of text; |
c9a89b23ca0f
(Face Attributes): Simplify wording.
Richard M. Stallman <rms@gnu.org>
parents:
72058
diff
changeset
|
1887 Emacs merges the attributes of all the faces to determine how to |
c9a89b23ca0f
(Face Attributes): Simplify wording.
Richard M. Stallman <rms@gnu.org>
parents:
72058
diff
changeset
|
1888 display the text. @xref{Displaying Faces}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1889 |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1890 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
|
1891 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
|
1892 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
|
1893 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
|
1894 specify all attributes. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1895 |
25875 | 1896 Some of these font attributes are meaningful only on certain kinds of |
1897 displays---if your display cannot handle a certain attribute, the | |
1898 attribute is ignored. (The attributes @code{:family}, @code{:width}, | |
1899 @code{:height}, @code{:weight}, and @code{:slant} correspond to parts of | |
1900 an X Logical Font Descriptor.) | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1901 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1902 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1903 @item :family |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1904 Font family name, or fontset name (@pxref{Fontsets}). If you specify a |
25875 | 1905 font family name, the wild-card characters @samp{*} and @samp{?} are |
1906 allowed. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1907 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1908 @item :width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1909 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
|
1910 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
|
1911 @code{extra-condensed}, @code{condensed}, @code{semi-condensed}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1912 @code{normal}, @code{semi-expanded}, @code{expanded}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1913 @code{extra-expanded}, or @code{ultra-expanded}. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1914 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1915 @item :height |
32089
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1916 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
|
1917 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
|
1918 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
|
1919 (from the underlying face), and should return the new height. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1920 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1921 @item :weight |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1922 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
|
1923 @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
|
1924 @code{normal}, @code{semi-light}, @code{light}, @code{extra-light}, |
25875 | 1925 or @code{ultra-light}. |
25809
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1926 |
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1927 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
|
1928 extra bright, and any weight less than normal is displayed as |
25875 | 1929 half-bright (provided the terminal supports the feature). |
1930 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1931 @item :slant |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1932 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
|
1933 @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
|
1934 |
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1935 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
|
1936 the terminal supports the feature. |
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1937 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1938 @item :foreground |
59277
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
1939 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
|
1940 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
|
1941 @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
|
1942 @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
|
1943 blue, and @samp{#ffffff} is white.) |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1944 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1945 @item :background |
59277
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
1946 Background color, a string, like the foreground color. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1947 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1948 @item :inverse-video |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1949 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
|
1950 value should be @code{t} (yes) or @code{nil} (no). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1951 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1952 @item :stipple |
25875 | 1953 The background stipple, a bitmap. |
1954 | |
1955 The value can be a string; that should be the name of a file containing | |
1956 external-format X bitmap data. The file is found in the directories | |
1957 listed in the variable @code{x-bitmap-file-path}. | |
1958 | |
40310
34f1a01f25fa
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
39404
diff
changeset
|
1959 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
|
1960 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
|
1961 @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
|
1962 @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
|
1963 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
|
1964 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
|
1965 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
|
1966 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1967 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
|
1968 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1969 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
|
1970 used automatically to handle certain shades of gray. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1971 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1972 @item :underline |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1973 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
|
1974 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
|
1975 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
|
1976 value @code{nil} means do not underline. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1977 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1978 @item :overline |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1979 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
|
1980 The value is used like that of @code{:underline}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1981 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1982 @item :strike-through |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1983 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
|
1984 color. The value is used like that of @code{:underline}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1985 |
32089
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1986 @item :inherit |
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1987 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
|
1988 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
|
1989 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
|
1990 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
|
1991 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
|
1992 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1993 @item :box |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1994 Whether or not a box should be drawn around characters, its color, the |
25875 | 1995 width of the box lines, and 3D appearance. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1996 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1997 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1998 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
|
1999 they mean: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2000 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2001 @table @asis |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2002 @item @code{nil} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2003 Don't draw a box. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2004 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2005 @item @code{t} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2006 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
|
2007 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2008 @item @var{color} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2009 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
|
2010 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2011 @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
|
2012 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
|
2013 @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
|
2014 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2015 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
|
2016 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
|
2017 color of the face for 3D boxes. |
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 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
|
2020 @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
|
2021 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
|
2022 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
|
2023 is used. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2024 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2025 |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
2026 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
|
2027 @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
|
2028 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
|
2029 semi-obsolete, but they still work: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2030 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2031 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2032 @item :font |
25875 | 2033 This attribute specifies the font name. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2034 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2035 @item :bold |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2036 A non-@code{nil} value specifies a bold font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2037 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2038 @item :italic |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2039 A non-@code{nil} value specifies an italic font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2040 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2041 |
71957
61cb5aae3bc3
Put period and comma inside quotes.
Richard M. Stallman <rms@gnu.org>
parents:
71882
diff
changeset
|
2042 For compatibility, you can still set these ``attributes,'' even |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
2043 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
|
2044 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2045 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2046 @item :font |
25875 | 2047 You can specify an X font name as the ``value'' of this ``attribute''; |
2048 that sets the @code{:family}, @code{:width}, @code{:height}, | |
2049 @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
|
2050 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2051 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
|
2052 the pattern is used to set these attributes. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2053 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2054 @item :bold |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2055 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
|
2056 This actually works by setting the @code{:weight} attribute. |
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 @item :italic |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2059 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
|
2060 This actually works by setting the @code{:slant} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2061 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2062 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2063 @defvar x-bitmap-file-path |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2064 This variable specifies a list of directories for searching |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2065 for bitmap files, for the @code{:stipple} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2066 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2067 |
25911
b192e4e3a9f5
Rename pixmap-spec-p to bitmap-spec-p.
Gerd Moellmann <gerd@gnu.org>
parents:
25875
diff
changeset
|
2068 @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
|
2069 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
|
2070 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
|
2071 @code{nil} otherwise. |
25875 | 2072 @end defun |
2073 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2074 @node Attribute Functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2075 @subsection Face Attribute Functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2076 |
72208
513c469ffd50
(Face Functions): Fix explanations of FRAME=t or nil.
Richard M. Stallman <rms@gnu.org>
parents:
72175
diff
changeset
|
2077 This section describes the functions for accessing and modifying the |
513c469ffd50
(Face Functions): Fix explanations of FRAME=t or nil.
Richard M. Stallman <rms@gnu.org>
parents:
72175
diff
changeset
|
2078 attributes of an existing face. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2079 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2080 @defun set-face-attribute face frame &rest arguments |
72175
c9a89b23ca0f
(Face Attributes): Simplify wording.
Richard M. Stallman <rms@gnu.org>
parents:
72058
diff
changeset
|
2081 This function sets one or more attributes of face @var{face} for frame |
c9a89b23ca0f
(Face Attributes): Simplify wording.
Richard M. Stallman <rms@gnu.org>
parents:
72058
diff
changeset
|
2082 @var{frame}. The attributes you specify this way override whatever |
c9a89b23ca0f
(Face Attributes): Simplify wording.
Richard M. Stallman <rms@gnu.org>
parents:
72058
diff
changeset
|
2083 the @code{defface} says. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2084 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2085 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
|
2086 the values for them. They should consist of alternating attribute names |
25875 | 2087 (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
|
2088 Thus, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2089 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2090 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2091 (set-face-attribute 'foo nil |
46721
12862351ee03
Fix set-face-attribute example.
Richard M. Stallman <rms@gnu.org>
parents:
46338
diff
changeset
|
2092 :width 'extended |
12862351ee03
Fix set-face-attribute example.
Richard M. Stallman <rms@gnu.org>
parents:
46338
diff
changeset
|
2093 :weight 'bold |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2094 :underline "red") |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2095 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2096 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2097 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2098 sets the attributes @code{:width}, @code{:weight} and @code{:underline} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2099 to the corresponding values. |
72175
c9a89b23ca0f
(Face Attributes): Simplify wording.
Richard M. Stallman <rms@gnu.org>
parents:
72058
diff
changeset
|
2100 |
72208
513c469ffd50
(Face Functions): Fix explanations of FRAME=t or nil.
Richard M. Stallman <rms@gnu.org>
parents:
72175
diff
changeset
|
2101 If @var{frame} is @code{t}, this function sets the default attributes |
513c469ffd50
(Face Functions): Fix explanations of FRAME=t or nil.
Richard M. Stallman <rms@gnu.org>
parents:
72175
diff
changeset
|
2102 for new frames. Default attribute values specified this way override |
513c469ffd50
(Face Functions): Fix explanations of FRAME=t or nil.
Richard M. Stallman <rms@gnu.org>
parents:
72175
diff
changeset
|
2103 the @code{defface} for newly created frames. |
513c469ffd50
(Face Functions): Fix explanations of FRAME=t or nil.
Richard M. Stallman <rms@gnu.org>
parents:
72175
diff
changeset
|
2104 |
513c469ffd50
(Face Functions): Fix explanations of FRAME=t or nil.
Richard M. Stallman <rms@gnu.org>
parents:
72175
diff
changeset
|
2105 If @var{frame} is @code{nil}, this function sets the attributes for |
513c469ffd50
(Face Functions): Fix explanations of FRAME=t or nil.
Richard M. Stallman <rms@gnu.org>
parents:
72175
diff
changeset
|
2106 all existing frames, and the default for new frames. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2107 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2108 |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2109 @defun face-attribute face attribute &optional frame inherit |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2110 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
|
2111 @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
|
2112 that means the selected frame (@pxref{Input Focus}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2113 |
72175
c9a89b23ca0f
(Face Attributes): Simplify wording.
Richard M. Stallman <rms@gnu.org>
parents:
72058
diff
changeset
|
2114 If @var{frame} is @code{t}, this returns whatever new-frames default |
c9a89b23ca0f
(Face Attributes): Simplify wording.
Richard M. Stallman <rms@gnu.org>
parents:
72058
diff
changeset
|
2115 value you previously specified with @code{set-face-attribute} for the |
c9a89b23ca0f
(Face Attributes): Simplify wording.
Richard M. Stallman <rms@gnu.org>
parents:
72058
diff
changeset
|
2116 @var{attribute} attribute of @var{face}. If you have not specified |
c9a89b23ca0f
(Face Attributes): Simplify wording.
Richard M. Stallman <rms@gnu.org>
parents:
72058
diff
changeset
|
2117 one, it returns @code{nil}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2118 |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2119 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
|
2120 @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
|
2121 @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
|
2122 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
|
2123 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
|
2124 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
|
2125 @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
|
2126 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
|
2127 absolute. |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2128 |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2129 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
|
2130 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
|
2131 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
|
2132 (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
|
2133 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2134 For example, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2135 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2136 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2137 (face-attribute 'bold :weight) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2138 @result{} bold |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2139 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2140 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2141 |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2142 @defun face-attribute-relative-p attribute value |
71643
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2143 This function returns non-@code{nil} if @var{value}, when used as the |
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2144 value of the face attribute @var{attribute}, is relative. This means |
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2145 it would modify, rather than completely override, any value that comes |
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2146 from a subsequent face in the face list or that is inherited from |
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2147 another face. |
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2148 |
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2149 @code{unspecified} is a relative value for all attributes. |
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2150 For @code{:height}, floating point values are also relative. |
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2151 |
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2152 For example: |
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2153 |
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2154 @example |
77360
467b5b7572bd
(Attribute Functions): Fix example for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
77123
diff
changeset
|
2155 (face-attribute-relative-p :height 2.0) |
467b5b7572bd
(Attribute Functions): Fix example for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
77123
diff
changeset
|
2156 @result{} t |
71643
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2157 @end example |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2158 @end defun |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2159 |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2160 @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
|
2161 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
|
2162 @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
|
2163 @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
|
2164 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
|
2165 @end defun |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2166 |
71730
cd88ff0d05f5
(Attribute Functions): Move paragraph about compatibility with Emacs < 21.
Richard M. Stallman <rms@gnu.org>
parents:
71719
diff
changeset
|
2167 The functions above did not exist before Emacs 21. For compatibility |
cd88ff0d05f5
(Attribute Functions): Move paragraph about compatibility with Emacs < 21.
Richard M. Stallman <rms@gnu.org>
parents:
71719
diff
changeset
|
2168 with older Emacs versions, you can use the following functions to set |
cd88ff0d05f5
(Attribute Functions): Move paragraph about compatibility with Emacs < 21.
Richard M. Stallman <rms@gnu.org>
parents:
71719
diff
changeset
|
2169 and examine the face attributes which existed in those versions. |
72208
513c469ffd50
(Face Functions): Fix explanations of FRAME=t or nil.
Richard M. Stallman <rms@gnu.org>
parents:
72175
diff
changeset
|
2170 They use values of @code{t} and @code{nil} for @var{frame} |
513c469ffd50
(Face Functions): Fix explanations of FRAME=t or nil.
Richard M. Stallman <rms@gnu.org>
parents:
72175
diff
changeset
|
2171 just like @code{set-face-attribute} and @code{face-attribute}. |
71730
cd88ff0d05f5
(Attribute Functions): Move paragraph about compatibility with Emacs < 21.
Richard M. Stallman <rms@gnu.org>
parents:
71719
diff
changeset
|
2172 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2173 @defun set-face-foreground face color &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2174 @defunx set-face-background face color &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2175 These functions set the foreground (or background, respectively) color |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2176 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
|
2177 string, the name of a color. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2178 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2179 Certain shades of gray are implemented by stipple patterns on |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2180 black-and-white screens. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2181 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2182 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2183 @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
|
2184 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
|
2185 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
|
2186 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
|
2187 (@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
|
2188 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2189 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
|
2190 they are used automatically to handle certain shades of gray. |
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 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2193 @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
|
2194 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
|
2195 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
|
2196 @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
|
2197 @var{font}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2198 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2199 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2200 @defun set-face-bold-p face bold-p &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2201 This function specifies whether @var{face} should be bold. If |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2202 @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
|
2203 This actually sets the @code{:weight} attribute. |
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 set-face-italic-p face italic-p &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2207 This function specifies whether @var{face} should be italic. If |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2208 @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
|
2209 This actually sets the @code{:slant} attribute. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2210 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2211 |
75592
fa3660d23cc6
(Attribute Functions): Fix name and description of the UNDERLINE arg
Juanma Barranquero <lekktu@gmail.com>
parents:
75348
diff
changeset
|
2212 @defun set-face-underline-p face underline &optional frame |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2213 This function sets the underline attribute of face @var{face}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2214 Non-@code{nil} means do underline; @code{nil} means don't. |
75592
fa3660d23cc6
(Attribute Functions): Fix name and description of the UNDERLINE arg
Juanma Barranquero <lekktu@gmail.com>
parents:
75348
diff
changeset
|
2215 If @var{underline} is a string, underline with that color. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2216 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2217 |
65073
408e294257ab
(Attribute Functions): Add set-face-inverse-video-p.
Juri Linkov <juri@jurta.org>
parents:
64921
diff
changeset
|
2218 @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
|
2219 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
|
2220 @var{face}. |
408e294257ab
(Attribute Functions): Add set-face-inverse-video-p.
Juri Linkov <juri@jurta.org>
parents:
64921
diff
changeset
|
2221 @end defun |
408e294257ab
(Attribute Functions): Add set-face-inverse-video-p.
Juri Linkov <juri@jurta.org>
parents:
64921
diff
changeset
|
2222 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2223 @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
|
2224 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
|
2225 @var{face}. |
25751
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 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2228 These functions examine the attributes of a face. If you don't |
72208
513c469ffd50
(Face Functions): Fix explanations of FRAME=t or nil.
Richard M. Stallman <rms@gnu.org>
parents:
72175
diff
changeset
|
2229 specify @var{frame}, they refer to the selected frame; @code{t} refers |
513c469ffd50
(Face Functions): Fix explanations of FRAME=t or nil.
Richard M. Stallman <rms@gnu.org>
parents:
72175
diff
changeset
|
2230 to the default data for new frames. They return the symbol |
513c469ffd50
(Face Functions): Fix explanations of FRAME=t or nil.
Richard M. Stallman <rms@gnu.org>
parents:
72175
diff
changeset
|
2231 @code{unspecified} if the face doesn't define any value for that |
513c469ffd50
(Face Functions): Fix explanations of FRAME=t or nil.
Richard M. Stallman <rms@gnu.org>
parents:
72175
diff
changeset
|
2232 attribute. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2233 |
46245
fb42c0446cbf
Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents:
46240
diff
changeset
|
2234 @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
|
2235 @defunx face-background face &optional frame inherit |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2236 These functions return the foreground color (or background color, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2237 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
|
2238 |
54777 | 2239 If @var{inherit} is @code{nil}, only a color directly defined by the face is |
2240 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
|
2241 @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
|
2242 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
|
2243 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
|
2244 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
|
2245 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2246 |
46245
fb42c0446cbf
Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents:
46240
diff
changeset
|
2247 @defun face-stipple face &optional frame inherit |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2248 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
|
2249 @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
|
2250 |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2251 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
|
2252 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
|
2253 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
|
2254 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
|
2255 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
|
2256 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
|
2257 @var{inherit}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2258 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2259 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2260 @defun face-font face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2261 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
|
2262 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2263 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2264 @defun face-bold-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2265 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
|
2266 bolder than normal. It returns @code{nil} otherwise. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2267 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2268 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2269 @defun face-italic-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2270 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
|
2271 @code{nil} otherwise. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2272 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2273 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2274 @defun face-underline-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2275 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
|
2276 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2277 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2278 @defun face-inverse-video-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2279 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
|
2280 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2281 |
59277
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
2282 @node Displaying Faces |
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
2283 @subsection Displaying Faces |
6598 | 2284 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2285 Here are the ways to specify which faces to use for display of text: |
6598 | 2286 |
2287 @itemize @bullet | |
2288 @item | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2289 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
|
2290 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
|
2291 face is used only when no other face is specified.) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2292 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2293 @item |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2294 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
|
2295 @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
|
2296 before @code{default}. |
6598 | 2297 |
2298 @item | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2299 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
|
2300 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
|
2301 Properties}. |
6598 | 2302 |
2303 If the character has a @code{mouse-face} property, that is used instead | |
2304 of the @code{face} property when the mouse is ``near enough'' to the | |
2305 character. | |
2306 | |
2307 @item | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2308 With overlays. An overlay can have @code{face} and @code{mouse-face} |
6598 | 2309 properties too; they apply to all the text covered by the overlay. |
2310 | |
2311 @item | |
12098 | 2312 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
|
2313 highlighted with the face @code{region} (@pxref{Standard Faces,,, |
88aad5396aac
(Standard Faces): Delete node.
Juri Linkov <juri@jurta.org>
parents:
65073
diff
changeset
|
2314 emacs, The GNU Emacs Manual}). |
12098 | 2315 |
2316 @item | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
2317 With special glyphs. Each glyph can specify a particular face |
6598 | 2318 number. @xref{Glyphs}. |
2319 @end itemize | |
2320 | |
2321 If these various sources together specify more than one face for a | |
2322 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
|
2323 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
|
2324 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
|
2325 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
|
2326 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
|
2327 @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
|
2328 line or a header line), and last the @code{default} face. |
6598 | 2329 |
2330 When multiple overlays cover one character, an overlay with higher | |
2331 priority overrides those with lower priority. @xref{Overlays}. | |
2332 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2333 @node Font Selection |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2334 @subsection Font Selection |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2335 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2336 @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
|
2337 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
|
2338 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
|
2339 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
|
2340 it is. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2341 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2342 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
|
2343 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
|
2344 family, a font pattern is constructed. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2345 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2346 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
|
2347 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
|
2348 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
|
2349 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
|
2350 ``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
|
2351 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
|
2352 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
|
2353 try. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2354 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2355 @defvar face-font-selection-order |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2356 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
|
2357 @code{:width}, @code{:height}, @code{:weight}, and @code{:slant}. The |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2358 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
|
2359 decreasing importance. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2360 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2361 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
|
2362 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
|
2363 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
|
2364 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2365 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
|
2366 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
|
2367 (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
|
2368 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
|
2369 non-normal faces contrast with normal ones, whenever possible. |
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 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
|
2372 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
|
2373 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
|
2374 and so on. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2375 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2376 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
|
2377 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
|
2378 @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
|
2379 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
|
2380 @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
|
2381 quite right. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2382 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2383 |
33373 | 2384 @defvar face-font-family-alternatives |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2385 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
|
2386 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
|
2387 this form: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2388 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2389 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2390 (@var{family} @var{alternate-families}@dots{}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2391 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2392 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2393 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
|
2394 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
|
2395 family that does exist. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2396 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2397 |
33373 | 2398 @defvar face-font-registry-alternatives |
2399 This variable lets you specify alternative font registries to try, if a | |
2400 given registry is specified and doesn't exist. Each element should have | |
2401 this form: | |
2402 | |
2403 @example | |
2404 (@var{registry} @var{alternate-registries}@dots{}) | |
2405 @end example | |
2406 | |
2407 If @var{registry} is specified but not available, Emacs will try the | |
2408 other registries given in @var{alternate-registries}, one by one, | |
2409 until it finds a registry that does exist. | |
2410 @end defvar | |
2411 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2412 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
|
2413 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
|
2414 XFree86 servers. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2415 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2416 @defvar scalable-fonts-allowed |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2417 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
|
2418 @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
|
2419 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
|
2420 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2421 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
|
2422 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
|
2423 expression in the list. For example, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2424 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2425 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2426 (setq scalable-fonts-allowed '("muleindian-2$")) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2427 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2428 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2429 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2430 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
|
2431 @end defvar |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2432 |
52002
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2433 @defvar face-font-rescale-alist |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2434 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
|
2435 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
|
2436 |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2437 @example |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2438 (@var{fontname-regexp} . @var{scale-factor}) |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2439 @end example |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2440 |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2441 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
|
2442 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
|
2443 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
|
2444 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
|
2445 nominal heights and widths would suggest. |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2446 @end defvar |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2447 |
6598 | 2448 @node Face Functions |
2449 @subsection Functions for Working with Faces | |
2450 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2451 Here are additional functions for creating and working with faces. |
6598 | 2452 |
2453 @defun make-face name | |
2454 This function defines a new face named @var{name}, initially with all | |
2455 attributes @code{nil}. It does nothing if there is already a face named | |
2456 @var{name}. | |
2457 @end defun | |
2458 | |
2459 @defun face-list | |
2460 This function returns a list of all defined face names. | |
2461 @end defun | |
2462 | |
2463 @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
|
2464 This function defines a face named @var{new-name} as a copy of the existing |
6598 | 2465 face named @var{old-face}. It creates the face @var{new-name} if that |
2466 doesn't already exist. | |
2467 | |
2468 If the optional argument @var{frame} is given, this function applies | |
2469 only to that frame. Otherwise it applies to each frame individually, | |
2470 copying attributes from @var{old-face} in each frame to @var{new-face} | |
2471 in the same frame. | |
2472 | |
2473 If the optional argument @var{new-frame} is given, then @code{copy-face} | |
2474 copies the attributes of @var{old-face} in @var{frame} to @var{new-name} | |
2475 in @var{new-frame}. | |
2476 @end defun | |
2477 | |
12098 | 2478 @defun face-id face |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2479 This function returns the face number of face @var{face}. |
6598 | 2480 @end defun |
2481 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2482 @defun face-documentation face |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
2483 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
|
2484 @code{nil} if none was specified for it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
2485 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
2486 |
6598 | 2487 @defun face-equal face1 face2 &optional frame |
2488 This returns @code{t} if the faces @var{face1} and @var{face2} have the | |
2489 same attributes for display. | |
2490 @end defun | |
2491 | |
2492 @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
|
2493 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
|
2494 differently from the default face. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2495 @end defun |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2496 |
63659
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2497 @cindex face alias |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2498 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
|
2499 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
|
2500 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
|
2501 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
|
2502 |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2503 @example |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2504 (put 'modeline 'face-alias 'mode-line) |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2505 @end example |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2506 |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2507 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2508 @node Auto Faces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2509 @subsection Automatic Face Assignment |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2510 @cindex automatic face assignment |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2511 @cindex faces, automatic choice |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2512 |
77865
1616acf69fc8
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
77542
diff
changeset
|
2513 This hook is used for automatically assigning facesto text in the |
1616acf69fc8
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
77542
diff
changeset
|
2514 buffer. It is part of the implementation of Jit-Lock mode, used by |
1616acf69fc8
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
77542
diff
changeset
|
2515 Font-Lock. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2516 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2517 @defvar fontification-functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2518 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
|
2519 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
|
2520 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2521 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
|
2522 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
|
2523 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
|
2524 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2525 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
|
2526 @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
|
2527 @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
|
2528 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
|
2529 already. |
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 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
|
2532 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
|
2533 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
|
2534 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
|
2535 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
|
2536 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2537 For efficiency, we recommend writing these functions so that they |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2538 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
|
2539 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2540 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2541 @node Font Lookup |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2542 @subsection Looking Up Fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2543 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2544 @defun x-list-fonts pattern &optional face frame maximum |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2545 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
|
2546 @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
|
2547 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
|
2548 @var{face} currently is on @var{frame}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2549 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2550 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
|
2551 characters: the @samp{*} character matches any substring, and the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2552 @samp{?} character matches any single character. Pattern matching |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2553 of font names ignores case. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2554 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2555 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
|
2556 (a symbol) and @var{frame} should be a frame. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2557 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2558 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
|
2559 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
|
2560 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
|
2561 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
|
2562 many fonts match the pattern. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2563 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2564 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2565 @defun x-family-fonts &optional family frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2566 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
|
2567 @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
|
2568 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
|
2569 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
|
2570 contain the wildcards @samp{?} and @samp{*}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2571 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2572 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
|
2573 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
|
2574 (@pxref{Input Focus}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2575 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2576 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
|
2577 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2578 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2579 [@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
|
2580 @var{fixed-p} @var{full} @var{registry-and-encoding}] |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2581 @end example |
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 The first five elements correspond to face attributes; if you |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2584 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
|
2585 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2586 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
|
2587 @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
|
2588 @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
|
2589 @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
|
2590 encoding of the font. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2591 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2592 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
|
2593 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2594 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2595 @defun x-font-family-list &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2596 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
|
2597 @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
|
2598 describes the selected frame's display (@pxref{Input Focus}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2599 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2600 The value is a list of elements of this form: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2601 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2602 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2603 (@var{family} . @var{fixed-p}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2604 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2605 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2606 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2607 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
|
2608 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
|
2609 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2610 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2611 @defvar font-list-limit |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2612 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
|
2613 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
|
2614 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
|
2615 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
|
2616 currently 100. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2617 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2618 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2619 @node Fontsets |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2620 @subsection Fontsets |
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 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
|
2623 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
|
2624 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
|
2625 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
|
2626 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
|
2627 information about defining a fontset under Lisp program control. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2628 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2629 @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
|
2630 This function defines a new fontset according to the specification |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2631 string @var{fontset-spec}. The string should have this format: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2632 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2633 @smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2634 @var{fontpattern}, @r{[}@var{charsetname}:@var{fontname}@r{]@dots{}} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2635 @end smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2636 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2637 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2638 Whitespace characters before and after the commas are ignored. |
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 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
|
2641 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
|
2642 @samp{fontset-@var{alias}}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2643 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2644 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
|
2645 @var{fontpattern} in its entirety. The short name is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2646 @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
|
2647 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
|
2648 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
|
2649 function does nothing. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2650 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2651 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
|
2652 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
|
2653 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
|
2654 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
|
2655 status. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2656 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2657 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
|
2658 See below for the details. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2659 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2660 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2661 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
|
2662 use (in this fontset) for one particular character set. Here, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2663 @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
|
2664 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
|
2665 times in the specification string. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2666 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2667 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
|
2668 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
|
2669 @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
|
2670 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
|
2671 with @samp{ISO8859-1}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2672 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2673 In addition, when several consecutive fields are wildcards, Emacs |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2674 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
|
2675 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
|
2676 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
|
2677 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
|
2678 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2679 Thus if @var{fontpattern} is this, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2680 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2681 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2682 -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2683 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2684 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2685 @noindent |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52940
diff
changeset
|
2686 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
|
2687 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2688 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2689 -*-fixed-medium-r-normal-*-24-*-ISO8859-1 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2690 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2691 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2692 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2693 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
|
2694 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2695 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2696 -*-fixed-medium-r-normal-*-24-*-gb2312*-* |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2697 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2698 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2699 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
|
2700 specification. Most X distributions include only Chinese fonts that |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2701 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
|
2702 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
|
2703 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2704 @smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2705 Emacs.Fontset-0: -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24,\ |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2706 chinese-gb2312:-*-*-medium-r-normal-*-24-*-gb2312*-* |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2707 @end smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2708 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2709 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2710 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
|
2711 @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
|
2712 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
|
2713 field. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2714 |
52932
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2715 @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
|
2716 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
|
2717 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
|
2718 |
52940
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2719 If @var{name} is @code{nil}, this function modifies the default |
54023 | 2720 fontset, whose short name is @samp{fontset-default}. |
52940
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2721 |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2722 @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
|
2723 @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
|
2724 @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
|
2725 (inclusive). |
52932
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2726 |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2727 @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
|
2728 @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
|
2729 |
52940
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2730 @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
|
2731 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
|
2732 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
|
2733 (possibly including an encoding name at the tail). |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2734 |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2735 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
|
2736 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
|
2737 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
|
2738 |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
2739 @smallexample |
52932
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2740 (set-fontset-font nil 'japanese-jisx0208 '(nil . "JISX0208.1983")) |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
2741 @end smallexample |
52932
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2742 @end defun |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2743 |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2744 @defun char-displayable-p char |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2745 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
|
2746 @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
|
2747 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
|
2748 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2749 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
|
2750 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
|
2751 @end defun |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2752 |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2753 @node Fringes |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2754 @section Fringes |
77010
e009ed31b7cf
Improve index entries. Remove redundant ones.
Richard M. Stallman <rms@gnu.org>
parents:
76850
diff
changeset
|
2755 @cindex fringes |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2756 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2757 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
|
2758 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
|
2759 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
|
2760 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2761 @menu |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2762 * Fringe Size/Pos:: Specifying where to put the window fringes. |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2763 * Fringe Indicators:: Displaying indicator icons in the window fringes. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2764 * Fringe Cursors:: Displaying cursors in the right fringe. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2765 * Fringe Bitmaps:: Specifying bitmaps for fringe indicators. |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2766 * 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
|
2767 * 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
|
2768 @end menu |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2769 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2770 @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
|
2771 @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
|
2772 |
65799
2d967531d264
(Fringe Size/Pos): Simplify and add detail.
Nick Roberts <nickrob@snap.net.nz>
parents:
65740
diff
changeset
|
2773 The following buffer-local variables control the position and width |
2d967531d264
(Fringe Size/Pos): Simplify and add detail.
Nick Roberts <nickrob@snap.net.nz>
parents:
65740
diff
changeset
|
2774 of the window fringes. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2775 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2776 @defvar fringes-outside-margins |
65799
2d967531d264
(Fringe Size/Pos): Simplify and add detail.
Nick Roberts <nickrob@snap.net.nz>
parents:
65740
diff
changeset
|
2777 The fringes normally appear between the display margins and the window |
2d967531d264
(Fringe Size/Pos): Simplify and add detail.
Nick Roberts <nickrob@snap.net.nz>
parents:
65740
diff
changeset
|
2778 text. If the value is non-@code{nil}, they appear outside the display |
2d967531d264
(Fringe Size/Pos): Simplify and add detail.
Nick Roberts <nickrob@snap.net.nz>
parents:
65740
diff
changeset
|
2779 margins. @xref{Display Margins}. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2780 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2781 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2782 @defvar left-fringe-width |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2783 This variable, if non-@code{nil}, specifies the width of the left |
65799
2d967531d264
(Fringe Size/Pos): Simplify and add detail.
Nick Roberts <nickrob@snap.net.nz>
parents:
65740
diff
changeset
|
2784 fringe in pixels. A value of @code{nil} means to use the left fringe |
2d967531d264
(Fringe Size/Pos): Simplify and add detail.
Nick Roberts <nickrob@snap.net.nz>
parents:
65740
diff
changeset
|
2785 width from the window's frame. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2786 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2787 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2788 @defvar right-fringe-width |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2789 This variable, if non-@code{nil}, specifies the width of the right |
65799
2d967531d264
(Fringe Size/Pos): Simplify and add detail.
Nick Roberts <nickrob@snap.net.nz>
parents:
65740
diff
changeset
|
2790 fringe in pixels. A value of @code{nil} means to use the right fringe |
2d967531d264
(Fringe Size/Pos): Simplify and add detail.
Nick Roberts <nickrob@snap.net.nz>
parents:
65740
diff
changeset
|
2791 width from the window's frame. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2792 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2793 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2794 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
|
2795 buffer in a window. If you change them while the buffer is visible, |
54023 | 2796 you can call @code{set-window-buffer} to display it once again in the |
2797 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
|
2798 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2799 @defun set-window-fringes window left &optional right outside-margins |
54023 | 2800 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
|
2801 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
|
2802 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2803 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
|
2804 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
|
2805 @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
|
2806 @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
|
2807 should appear outside of the display margins. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2808 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2809 |
53929
3ef7a4a3c230
(Fringes): Use consistent wording.
Kim F. Storm <storm@cua.dk>
parents:
53829
diff
changeset
|
2810 @defun window-fringes &optional window |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2811 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
|
2812 @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
|
2813 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
|
2814 @var{right-width} @var{outside-margins})}. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2815 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2816 |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2817 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2818 @node Fringe Indicators |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2819 @subsection Fringe Indicators |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2820 @cindex fringe indicators |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2821 @cindex indicators, fringe |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2822 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2823 The @dfn{fringe indicators} are tiny icons Emacs displays in the |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2824 window fringe (on a graphic display) to indicate truncated or |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2825 continued lines, buffer boundaries, overlay arrow, etc. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2826 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2827 @defopt indicate-empty-lines |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2828 @cindex fringes, and empty line indication |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2829 When this is non-@code{nil}, Emacs displays a special glyph in the |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2830 fringe of each empty line at the end of the buffer, on graphical |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2831 displays. @xref{Fringes}. This variable is automatically |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2832 buffer-local in every buffer. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2833 @end defopt |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2834 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2835 @defvar indicate-buffer-boundaries |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2836 This buffer-local variable controls how the buffer boundaries and |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2837 window scrolling are indicated in the window fringes. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2838 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2839 Emacs can indicate the buffer boundaries---that is, the first and last |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2840 line in the buffer---with angle icons when they appear on the screen. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2841 In addition, Emacs can display an up-arrow in the fringe to show |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2842 that there is text above the screen, and a down-arrow to show |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2843 there is text below the screen. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2844 |
72758
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2845 There are three kinds of basic values: |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2846 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2847 @table @asis |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2848 @item @code{nil} |
72758
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2849 Don't display any of these fringe icons. |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2850 @item @code{left} |
72758
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2851 Display the angle icons and arrows in the left fringe. |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2852 @item @code{right} |
72758
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2853 Display the angle icons and arrows in the right fringe. |
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2854 @item any non-alist |
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2855 Display the angle icons in the left fringe |
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2856 and don't display the arrows. |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2857 @end table |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2858 |
72758
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2859 Otherwise the value should be an alist that specifies which fringe |
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2860 indicators to display and where. Each element of the alist should |
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2861 have the form @code{(@var{indicator} . @var{position})}. Here, |
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2862 @var{indicator} is one of @code{top}, @code{bottom}, @code{up}, |
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2863 @code{down}, and @code{t} (which covers all the icons not yet |
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2864 specified), while @var{position} is one of @code{left}, @code{right} |
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2865 and @code{nil}. |
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2866 |
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2867 For example, @code{((top . left) (t . right))} places the top angle |
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2868 bitmap in left fringe, and the bottom angle bitmap as well as both |
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2869 arrow bitmaps in right fringe. To show the angle bitmaps in the left |
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2870 fringe, and no arrow bitmaps, use @code{((top . left) (bottom . left))}. |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2871 @end defvar |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2872 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2873 @defvar default-indicate-buffer-boundaries |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2874 The value of this variable is the default value for |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2875 @code{indicate-buffer-boundaries} in buffers that do not override it. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2876 @end defvar |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2877 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2878 @defvar fringe-indicator-alist |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2879 This buffer-local variable specifies the mapping from logical fringe |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2880 indicators to the actual bitmaps displayed in the window fringes. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2881 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2882 These symbols identify the logical fringe indicators: |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2883 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2884 @table @asis |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2885 @item Truncation and continuation line indicators: |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2886 @code{truncation}, @code{continuation}. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2887 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2888 @item Buffer position indicators: |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2889 @code{up}, @code{down}, |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2890 @code{top}, @code{bottom}, |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2891 @code{top-bottom}. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2892 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2893 @item Empty line indicator: |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2894 @code{empty-line}. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2895 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2896 @item Overlay arrow indicator: |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2897 @code{overlay-arrow}. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2898 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2899 @item Unknown bitmap indicator: |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2900 @code{unknown}. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2901 @end table |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2902 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2903 The value is an alist where each element @code{(@var{indicator} . @var{bitmaps})} |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2904 specifies the fringe bitmaps used to display a specific logical |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2905 fringe indicator. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2906 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2907 Here, @var{indicator} specifies the logical indicator type, and |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2908 @var{bitmaps} is list of symbols @code{(@var{left} @var{right} |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2909 [@var{left1} @var{right1}])} which specifies the actual bitmap shown |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2910 in the left or right fringe for the logical indicator. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2911 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2912 The @var{left} and @var{right} symbols specify the bitmaps shown in |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2913 the left and/or right fringe for the specific indicator. The |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2914 @var{left1} or @var{right1} bitmaps are used only for the `bottom' and |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2915 `top-bottom indicators when the last (only) line in has no final |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2916 newline. Alternatively, @var{bitmaps} may be a single symbol which is |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2917 used in both left and right fringes. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2918 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2919 When @code{fringe-indicator-alist} has a buffer-local value, and there |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2920 is no bitmap defined for a logical indicator, or the bitmap is |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2921 @code{t}, the corresponding value from the (non-local) |
69611
1d437dedbd3a
(Fringe Indicators): Fix typos.
Nick Roberts <nickrob@snap.net.nz>
parents:
69521
diff
changeset
|
2922 @code{default-fringe-indicator-alist} is used. |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2923 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2924 To completely hide a specific indicator, set the bitmap to @code{nil}. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2925 @end defvar |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2926 |
69611
1d437dedbd3a
(Fringe Indicators): Fix typos.
Nick Roberts <nickrob@snap.net.nz>
parents:
69521
diff
changeset
|
2927 @defvar default-fringe-indicator-alist |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2928 The value of this variable is the default value for |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2929 @code{fringe-indicator-alist} in buffers that do not override it. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2930 @end defvar |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2931 |
71638 | 2932 Standard fringe bitmaps for indicators: |
2933 @example | |
2934 left-arrow right-arrow up-arrow down-arrow | |
2935 left-curly-arrow right-curly-arrow | |
2936 left-triangle right-triangle | |
2937 top-left-angle top-right-angle | |
2938 bottom-left-angle bottom-right-angle | |
2939 left-bracket right-bracket | |
2940 filled-rectangle hollow-rectangle | |
2941 filled-square hollow-square | |
2942 vertical-bar horizontal-bar | |
2943 empty-line question-mark | |
2944 @end example | |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2945 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2946 @node Fringe Cursors |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2947 @subsection Fringe Cursors |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2948 @cindex fringe cursors |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2949 @cindex cursor, fringe |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2950 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2951 When a line is exactly as wide as the window, Emacs displays the |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2952 cursor in the right fringe instead of using two lines. Different |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2953 bitmaps are used to represent the cursor in the fringe depending on |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2954 the current buffer's cursor type. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2955 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2956 @table @asis |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2957 @item Logical cursor types: |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2958 @code{box} , @code{hollow}, @code{bar}, |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2959 @code{hbar}, @code{hollow-small}. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2960 @end table |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2961 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2962 The @code{hollow-small} type is used instead of @code{hollow} when the |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2963 normal @code{hollow-rectangle} bitmap is too tall to fit on a specific |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2964 display line. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2965 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2966 @defvar overflow-newline-into-fringe |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2967 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
|
2968 counting the final newline character) are not continued. Instead, |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2969 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
|
2970 fringe. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2971 @end defvar |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2972 |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2973 @defvar fringe-cursor-alist |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2974 This variable specifies the mapping from logical cursor type to the |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2975 actual fringe bitmaps displayed in the right fringe. The value is an |
71663 | 2976 alist where each element @code{(@var{cursor} . @var{bitmap})} specifies |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2977 the fringe bitmaps used to display a specific logical cursor type in |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2978 the fringe. Here, @var{cursor} specifies the logical cursor type and |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2979 @var{bitmap} is a symbol specifying the fringe bitmap to be displayed |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2980 for that logical cursor type. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2981 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2982 When @code{fringe-cursor-alist} has a buffer-local value, and there is |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2983 no bitmap defined for a cursor type, the corresponding value from the |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2984 (non-local) @code{default-fringes-indicator-alist} is used. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2985 @end defvar |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2986 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2987 @defvar default-fringes-cursor-alist |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2988 The value of this variable is the default value for |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2989 @code{fringe-cursor-alist} in buffers that do not override it. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2990 @end defvar |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2991 |
71638 | 2992 Standard bitmaps for displaying the cursor in right fringe: |
2993 @example | |
2994 filled-rectangle hollow-rectangle filled-square hollow-square | |
2995 vertical-bar horizontal-bar | |
2996 @end example | |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2997 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2998 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2999 @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
|
3000 @subsection Fringe Bitmaps |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3001 @cindex fringe bitmaps |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3002 @cindex bitmaps, fringe |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3003 |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
3004 The @dfn{fringe bitmaps} are the actual bitmaps which represent the |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
3005 logical fringe indicators for truncated or continued lines, buffer |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
3006 boundaries, overlay arrow, etc. Fringe bitmap symbols have their own |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
3007 name space. The fringe bitmaps are shared by all frames and windows. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
3008 You can redefine the built-in fringe bitmaps, and you can define new |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
3009 fringe bitmaps. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3010 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3011 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
|
3012 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
|
3013 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
|
3014 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
|
3015 @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
|
3016 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
|
3017 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
|
3018 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
|
3019 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
|
3020 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
|
3021 foreground color for the bitmap. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3022 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3023 @defun fringe-bitmaps-at-pos &optional pos window |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3024 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
|
3025 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
|
3026 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
|
3027 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
|
3028 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
|
3029 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
|
3030 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3031 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
|
3032 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
|
3033 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
|
3034 @var{window}. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3035 @end defun |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3036 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3037 @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
|
3038 @subsection Customizing Fringe Bitmaps |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3039 |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
3040 @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
|
3041 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
|
3042 or replaces an existing bitmap with that name. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3043 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3044 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
|
3045 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
|
3046 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
|
3047 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
|
3048 to the rightmost pixel of the bitmap. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3049 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3050 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
|
3051 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
|
3052 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
|
3053 @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
|
3054 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3055 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
|
3056 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
|
3057 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
|
3058 or @code{bottom}. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3059 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3060 The @var{align} argument may also be a list @code{(@var{align} |
57225 | 3061 @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
|
3062 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
|
3063 @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
|
3064 height. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3065 @end defun |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3066 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3067 @defun destroy-fringe-bitmap bitmap |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3068 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
|
3069 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
|
3070 restores the standard definition of that bitmap, instead of |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3071 eliminating it entirely. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3072 @end defun |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3073 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3074 @defun set-fringe-bitmap-face bitmap &optional face |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3075 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
|
3076 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
|
3077 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
|
3078 |
60958
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3079 @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
|
3080 @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
|
3081 @end defun |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3082 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3083 @node Overlay Arrow |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3084 @subsection The Overlay Arrow |
77010
e009ed31b7cf
Improve index entries. Remove redundant ones.
Richard M. Stallman <rms@gnu.org>
parents:
76850
diff
changeset
|
3085 @c @cindex overlay arrow Duplicates variable names |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3086 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3087 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
|
3088 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
|
3089 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
|
3090 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
|
3091 @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
|
3092 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3093 @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
|
3094 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
|
3095 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
|
3096 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
|
3097 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
|
3098 @end defvar |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3099 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3100 @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
|
3101 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
|
3102 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
|
3103 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
|
3104 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
|
3105 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
|
3106 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
|
3107 overwritten. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3108 |
66341
8ad92df59512
(Overlay Arrow): Clarify about local bindings of overlay-arrow-position.
Richard M. Stallman <rms@gnu.org>
parents:
66209
diff
changeset
|
3109 The overlay-arrow string is displayed in any given buffer if the value |
8ad92df59512
(Overlay Arrow): Clarify about local bindings of overlay-arrow-position.
Richard M. Stallman <rms@gnu.org>
parents:
66209
diff
changeset
|
3110 of @code{overlay-arrow-position} in that buffer points into that |
8ad92df59512
(Overlay Arrow): Clarify about local bindings of overlay-arrow-position.
Richard M. Stallman <rms@gnu.org>
parents:
66209
diff
changeset
|
3111 buffer. Thus, it works to can display multiple overlay arrow strings |
8ad92df59512
(Overlay Arrow): Clarify about local bindings of overlay-arrow-position.
Richard M. Stallman <rms@gnu.org>
parents:
66209
diff
changeset
|
3112 by creating buffer-local bindings of @code{overlay-arrow-position}. |
8ad92df59512
(Overlay Arrow): Clarify about local bindings of overlay-arrow-position.
Richard M. Stallman <rms@gnu.org>
parents:
66209
diff
changeset
|
3113 However, it is usually cleaner to use |
8ad92df59512
(Overlay Arrow): Clarify about local bindings of overlay-arrow-position.
Richard M. Stallman <rms@gnu.org>
parents:
66209
diff
changeset
|
3114 @code{overlay-arrow-variable-list} to achieve this result. |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3115 @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
|
3116 @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
|
3117 @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
|
3118 @end defvar |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3119 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3120 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
|
3121 @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
|
3122 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3123 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
|
3124 @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
|
3125 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3126 @defvar overlay-arrow-variable-list |
61980
f3d536670495
Fix typos and Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61972
diff
changeset
|
3127 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
|
3128 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
|
3129 @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
|
3130 this list. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3131 @end defvar |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3132 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3133 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
|
3134 @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
|
3135 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
|
3136 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
|
3137 overlay arrow position. If either property is not set, the default |
71663 | 3138 @code{overlay-arrow-string} or @code{overlay-arrow} fringe indicator |
3139 is used. | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3140 |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3141 @node Scroll Bars |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3142 @section Scroll Bars |
76837 | 3143 @cindex scroll bars |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3144 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3145 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
|
3146 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
|
3147 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
|
3148 @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
|
3149 meaning the default). @xref{Layout Parameters}. |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3150 |
60958
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3151 @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
|
3152 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
|
3153 @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
|
3154 @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
|
3155 @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
|
3156 (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
|
3157 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
|
3158 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
|
3159 @end defun |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3160 |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
3161 @vindex vertical-scroll-bar |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
3162 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
|
3163 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
|
3164 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
|
3165 @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
|
3166 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
|
3167 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
3168 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
|
3169 @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
|
3170 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3171 @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
|
3172 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
|
3173 @var{window}. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3174 |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3175 @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
|
3176 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
|
3177 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
|
3178 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
|
3179 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
|
3180 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3181 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
|
3182 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
|
3183 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
|
3184 selected window is used. |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3185 @end defun |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3186 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3187 @defun window-scroll-bars &optional window |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3188 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
|
3189 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
|
3190 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
|
3191 @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
|
3192 @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
|
3193 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
|
3194 bar actually occupies. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3195 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3196 @var{horizontal-type} is not actually meaningful. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3197 @end defun |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3198 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3199 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
|
3200 @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
|
3201 @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
|
3202 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
|
3203 @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
|
3204 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
|
3205 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
|
3206 specifying the same buffer that is already displayed. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3207 |
58496
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3208 @defvar scroll-bar-mode |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3209 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
|
3210 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
|
3211 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
|
3212 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
|
3213 @end defvar |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3214 |
60958
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3215 @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
|
3216 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
|
3217 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
|
3218 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
|
3219 @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
|
3220 @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
|
3221 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
|
3222 account. |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3223 @end defun |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3224 |
58496
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3225 @defvar scroll-bar-width |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3226 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
|
3227 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
|
3228 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
|
3229 @end defvar |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3230 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3231 @node Display Property |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3232 @section The @code{display} Property |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3233 @cindex display specification |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3234 @kindex display @r{(text property)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3235 |
25875 | 3236 The @code{display} text property (or overlay property) is used to |
3237 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
|
3238 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
|
3239 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
|
3240 specifications. |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3241 |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3242 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
|
3243 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
|
3244 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
|
3245 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
|
3246 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
|
3247 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
|
3248 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
|
3249 |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3250 @smallexample |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3251 (defun foo () |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3252 (goto-char (point-min)) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3253 (dotimes (i 5) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3254 (let ((string (concat "A"))) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3255 (put-text-property (point) (1+ (point)) 'display string) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3256 (forward-char 1) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3257 (put-text-property (point) (1+ (point)) 'display string) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3258 (forward-char 1)))) |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3259 @end smallexample |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3260 |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3261 @noindent |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3262 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
|
3263 @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
|
3264 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
|
3265 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
|
3266 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
|
3267 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
|
3268 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
|
3269 results: |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3270 |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3271 @smallexample |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3272 (defun foo () |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3273 (goto-char (point-min)) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3274 (dotimes (i 5) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3275 (let ((string (concat "A"))) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3276 (put-text-property (point) (2+ (point)) 'display string) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3277 (put-text-property (point) (1+ (point)) 'display string) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3278 (forward-char 2)))) |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3279 @end smallexample |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3280 |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3281 @noindent |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3282 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
|
3283 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
|
3284 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
|
3285 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
|
3286 @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
|
3287 |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3288 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
|
3289 display specifications and what they mean. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3290 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3291 @menu |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
3292 * 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
|
3293 * 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
|
3294 * Other Display Specs:: Displaying an image; magnifying text; moving it |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
3295 up or down on the page; adjusting the width |
25875 | 3296 of spaces within text. |
3297 * 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
|
3298 @end menu |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3299 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3300 @node Specified Space |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3301 @subsection Specified Spaces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3302 @cindex spaces, specified height or width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3303 @cindex variable-width spaces |
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 To display a space of specified width and/or height, use a display |
25875 | 3306 specification of the form @code{(space . @var{props})}, where |
3307 @var{props} is a property list (a list of alternating properties and | |
3308 values). You can put this property on one or more consecutive | |
3309 characters; a space of the specified height and width is displayed in | |
3310 place of @emph{all} of those characters. These are the properties you | |
44281 | 3311 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
|
3312 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3313 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3314 @item :width @var{width} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3315 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
|
3316 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
|
3317 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
|
3318 (@pxref{Pixel Specification}). |
25751
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 :relative-width @var{factor} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3321 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
|
3322 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
|
3323 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
|
3324 character, multiplied by @var{factor}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3325 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3326 @item :align-to @var{hpos} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3327 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
|
3328 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
|
3329 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
|
3330 specification (@pxref{Pixel Specification}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3331 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3332 |
44281 | 3333 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
|
3334 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
|
3335 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3336 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3337 @item :height @var{height} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3338 Specifies the height of the space. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3339 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
|
3340 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
|
3341 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
|
3342 (@pxref{Pixel Specification}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3343 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3344 @item :relative-height @var{factor} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3345 Specifies the height of the space, multiplying the ordinary height |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3346 of the text having this display specification by @var{factor}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3347 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3348 @item :ascent @var{ascent} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3349 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
|
3350 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
|
3351 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
|
3352 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
|
3353 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
|
3354 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3355 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3356 |
44281 | 3357 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
|
3358 |
60509
b6fee46c2fad
(Specified Space): Property :width is support on
Kim F. Storm <storm@cua.dk>
parents:
60503
diff
changeset
|
3359 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
|
3360 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
|
3361 are not. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3362 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3363 @node Pixel Specification |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3364 @subsection Pixel Specification for Spaces |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3365 @cindex spaces, pixel specification |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3366 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3367 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
|
3368 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
|
3369 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
|
3370 as an absolute number of pixels. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3371 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3372 The following expressions are supported: |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3373 |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3374 @smallexample |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3375 @group |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
3376 @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
|
3377 @var{num} ::= @var{integer} | @var{float} | @var{symbol} |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3378 @var{unit} ::= in | mm | cm | width | height |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3379 @end group |
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3380 @group |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3381 @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
|
3382 | scroll-bar | text |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3383 @var{pos} ::= left | center | right |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3384 @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
|
3385 @var{op} ::= + | - |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3386 @end group |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3387 @end smallexample |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3388 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3389 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
|
3390 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
|
3391 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
|
3392 buffer-local variable binding is used. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3393 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3394 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
|
3395 pixels per inch, millimeter, and centimeter, respectively. The |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3396 @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
|
3397 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
|
3398 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
|
3399 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3400 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
|
3401 @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
|
3402 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
|
3403 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3404 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
|
3405 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
|
3406 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
|
3407 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3408 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
|
3409 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
|
3410 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
|
3411 position has been set (by the first occurrence of one of these |
57225 | 3412 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
|
3413 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
|
3414 the left-margin, use |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3415 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3416 @example |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3417 :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
|
3418 @end example |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3419 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3420 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
|
3421 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
|
3422 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
|
3423 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3424 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
|
3425 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
|
3426 @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
|
3427 @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
|
3428 image. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3429 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3430 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
|
3431 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
|
3432 the value of the expressions. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3433 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3434 @node Other Display Specs |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3435 @subsection Other Display Specifications |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3436 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3437 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
|
3438 in the @code{display} text property. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3439 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3440 @table @code |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3441 @item @var{string} |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3442 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
|
3443 |
68282
6efd3312bd38
(Other Display Specs): Delete duplicate entry for
Richard M. Stallman <rms@gnu.org>
parents:
68084
diff
changeset
|
3444 Recursive display specifications are not supported---@var{string}'s |
6efd3312bd38
(Other Display Specs): Delete duplicate entry for
Richard M. Stallman <rms@gnu.org>
parents:
68084
diff
changeset
|
3445 @code{display} properties, if any, are not used. |
6efd3312bd38
(Other Display Specs): Delete duplicate entry for
Richard M. Stallman <rms@gnu.org>
parents:
68084
diff
changeset
|
3446 |
68946
956ccc6ec126
(Other Display Specs, Image Descriptors): Revert erroneous changes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
68708
diff
changeset
|
3447 @item (image . @var{image-props}) |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3448 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
|
3449 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
|
3450 instead of the text that has the display specification. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3451 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3452 @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
|
3453 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
|
3454 (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
|
3455 @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
|
3456 @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
|
3457 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
|
3458 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
|
3459 of the entire image. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3460 |
32467 | 3461 @item ((margin nil) @var{string}) |
3462 A display specification of this form means to display @var{string} | |
3463 instead of the text that has the display specification, at the same | |
68282
6efd3312bd38
(Other Display Specs): Delete duplicate entry for
Richard M. Stallman <rms@gnu.org>
parents:
68084
diff
changeset
|
3464 position as that text. It is equivalent to using just @var{string}, |
6efd3312bd38
(Other Display Specs): Delete duplicate entry for
Richard M. Stallman <rms@gnu.org>
parents:
68084
diff
changeset
|
3465 but it is done as a special case of marginal display (@pxref{Display |
6efd3312bd38
(Other Display Specs): Delete duplicate entry for
Richard M. Stallman <rms@gnu.org>
parents:
68084
diff
changeset
|
3466 Margins}). |
36935 | 3467 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3468 @item (space-width @var{factor}) |
25875 | 3469 This display specification affects all the space characters within the |
3470 text that has the specification. It displays all of these spaces | |
3471 @var{factor} times as wide as normal. The element @var{factor} should | |
3472 be an integer or float. Characters other than spaces are not affected | |
3473 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
|
3474 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3475 @item (height @var{height}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3476 This display specification makes the text taller or shorter. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3477 Here are the possibilities for @var{height}: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3478 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3479 @table @asis |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3480 @item @code{(+ @var{n})} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3481 This means to use a font that is @var{n} steps larger. A ``step'' is |
25875 | 3482 defined by the set of available fonts---specifically, those that match |
3483 what was otherwise specified for this text, in all attributes except | |
3484 height. Each size for which a suitable font is available counts as | |
3485 another step. @var{n} should be an integer. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3486 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3487 @item @code{(- @var{n})} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3488 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
|
3489 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3490 @item a number, @var{factor} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3491 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
|
3492 as tall as the default font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3493 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3494 @item a symbol, @var{function} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3495 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
|
3496 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
|
3497 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3498 @item anything else, @var{form} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3499 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
|
3500 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
|
3501 @code{height} bound to the current specified font height. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3502 @end table |
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 @item (raise @var{factor}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3505 This kind of display specification raises or lowers the text |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3506 it applies to, relative to the baseline of the line. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3507 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3508 @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
|
3509 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
|
3510 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
|
3511 lower down. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3512 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3513 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
|
3514 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
|
3515 faces used for the text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3516 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3517 |
69849
85e6a1c82a54
(Other Display Specs): Arrange a @code{DOTTED-LIST} to
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
69611
diff
changeset
|
3518 @c We put all the `@code{(when ...)}' on one line to encourage |
85e6a1c82a54
(Other Display Specs): Arrange a @code{DOTTED-LIST} to
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
69611
diff
changeset
|
3519 @c makeinfo's end-of-sentence heuristics to DTRT. Previously, the dot |
85e6a1c82a54
(Other Display Specs): Arrange a @code{DOTTED-LIST} to
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
69611
diff
changeset
|
3520 @c was at eol; the info file ended up w/ two spaces rendered after it. |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3521 You can make any display specification conditional. To do that, |
69849
85e6a1c82a54
(Other Display Specs): Arrange a @code{DOTTED-LIST} to
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
69611
diff
changeset
|
3522 package it in another list of the form |
85e6a1c82a54
(Other Display Specs): Arrange a @code{DOTTED-LIST} to
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
69611
diff
changeset
|
3523 @code{(when @var{condition} . @var{spec})}. |
85e6a1c82a54
(Other Display Specs): Arrange a @code{DOTTED-LIST} to
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
69611
diff
changeset
|
3524 Then the specification @var{spec} applies only when |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3525 @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
|
3526 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
|
3527 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
|
3528 @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
|
3529 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
|
3530 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
|
3531 string. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3532 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3533 @node Display Margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3534 @subsection Displaying in the Margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3535 @cindex display margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3536 @cindex margins, display |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3537 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3538 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
|
3539 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
|
3540 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
|
3541 property. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3542 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3543 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
|
3544 display specification of the form @code{(margin right-margin)} or |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3545 @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
|
3546 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
|
3547 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
|
3548 text or images in the margin mouse-sensitive. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3549 |
42297
c4f9d48801a8
Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents:
42082
diff
changeset
|
3550 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
|
3551 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
|
3552 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
|
3553 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
|
3554 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
|
3555 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
|
3556 before-string. |
c4f9d48801a8
Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents:
42082
diff
changeset
|
3557 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3558 Before the display margins can display anything, you must give |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3559 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
|
3560 variables: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3561 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3562 @defvar left-margin-width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3563 This variable specifies the width of the left margin. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3564 It is buffer-local in all buffers. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3565 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3566 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3567 @defvar right-margin-width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3568 This variable specifies the width of the right margin. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3569 It is buffer-local in all buffers. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3570 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3571 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3572 Setting these variables does not immediately affect the window. These |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3573 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
|
3574 Thus, you can make changes take effect by calling |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3575 @code{set-window-buffer}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3576 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3577 You can also set the margin widths immediately. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3578 |
36935 | 3579 @defun set-window-margins window left &optional right |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3580 This function specifies the margin widths for window @var{window}. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
3581 The argument @var{left} controls the left margin and |
36935 | 3582 @var{right} controls the right margin (default @code{0}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3583 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3584 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3585 @defun window-margins &optional window |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3586 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
|
3587 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
|
3588 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
|
3589 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3590 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3591 @node Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3592 @section Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3593 @cindex images in buffers |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3594 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3595 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
|
3596 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
|
3597 property of text that is displayed (@pxref{Display Property}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3598 |
72571
871eeda78fd7
* display.texi (Images): Add xrref to display-images-p.
Chong Yidong <cyd@stupidchicken.com>
parents:
72208
diff
changeset
|
3599 Emacs is usually able to display images when it is run on a |
871eeda78fd7
* display.texi (Images): Add xrref to display-images-p.
Chong Yidong <cyd@stupidchicken.com>
parents:
72208
diff
changeset
|
3600 graphical terminal. Images cannot be displayed in a text terminal, on |
871eeda78fd7
* display.texi (Images): Add xrref to display-images-p.
Chong Yidong <cyd@stupidchicken.com>
parents:
72208
diff
changeset
|
3601 certain graphical terminals that lack the support for this, or if |
871eeda78fd7
* display.texi (Images): Add xrref to display-images-p.
Chong Yidong <cyd@stupidchicken.com>
parents:
72208
diff
changeset
|
3602 Emacs is compiled without image support. You can use the function |
871eeda78fd7
* display.texi (Images): Add xrref to display-images-p.
Chong Yidong <cyd@stupidchicken.com>
parents:
72208
diff
changeset
|
3603 @code{display-images-p} to determine if images can in principle be |
871eeda78fd7
* display.texi (Images): Add xrref to display-images-p.
Chong Yidong <cyd@stupidchicken.com>
parents:
72208
diff
changeset
|
3604 displayed (@pxref{Display Feature Testing}). |
871eeda78fd7
* display.texi (Images): Add xrref to display-images-p.
Chong Yidong <cyd@stupidchicken.com>
parents:
72208
diff
changeset
|
3605 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3606 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
|
3607 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
|
3608 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
|
3609 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
|
3610 can be used to modify the set of known names for these dynamic |
57225 | 3611 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
|
3612 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3613 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
|
3614 libraries @code{libXpm} version 3.4k and @code{libz}), GIF (requiring |
76828 | 3615 @code{libungif} 4.1.0), PostScript, PBM, JPEG (requiring the |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3616 @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
|
3617 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
|
3618 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3619 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
|
3620 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
|
3621 @code{pbm}, @code{jpeg}, @code{tiff}, and @code{png}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3622 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3623 @defvar image-types |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3624 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
|
3625 potentially supported in the current configuration. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3626 @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
|
3627 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
|
3628 unavailable dynamic libraries, for example). |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3629 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3630 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
|
3631 @code{image-type-available-p}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3632 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3633 |
56109
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3634 @defvar image-library-alist |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3635 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
|
3636 display them. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3637 |
56437
bd1f1cbf959f
(Images): Fix Texinfo usage.
Juanma Barranquero <lekktu@gmail.com>
parents:
56233
diff
changeset
|
3638 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
|
3639 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
|
3640 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
|
3641 external libraries to load. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3642 |
56185
4f36c90f5404
(Images): Remove redundant @vindex directives.
Juanma Barranquero <lekktu@gmail.com>
parents:
56109
diff
changeset
|
3643 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
|
3644 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
|
3645 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
|
3646 they're always supported. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3647 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3648 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
|
3649 into Emacs. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3650 @end defvar |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3651 |
78661
048b9f8ae3b7
(Images): Delete redundant @findex.
Richard M. Stallman <rms@gnu.org>
parents:
78455
diff
changeset
|
3652 @defun image-type-available-p type |
56437
bd1f1cbf959f
(Images): Fix Texinfo usage.
Juanma Barranquero <lekktu@gmail.com>
parents:
56233
diff
changeset
|
3653 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
|
3654 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
|
3655 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
|
3656 @code{image-types}. |
56109
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3657 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3658 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
|
3659 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
|
3660 @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
|
3661 @end defun |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3662 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3663 @menu |
25875 | 3664 * Image Descriptors:: How to specify an image for use in @code{:display}. |
3665 * XBM Images:: Special features for XBM format. | |
3666 * XPM Images:: Special features for XPM format. | |
3667 * GIF Images:: Special features for GIF format. | |
76828 | 3668 * PostScript Images:: Special features for PostScript format. |
25875 | 3669 * Other Image Types:: Various other formats are supported. |
3670 * Defining Images:: Convenient ways to define an image for later use. | |
3671 * Showing Images:: Convenient ways to display an image once it is defined. | |
3672 * Image Cache:: Internal mechanisms of image display. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3673 @end menu |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3674 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3675 @node Image Descriptors |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3676 @subsection Image Descriptors |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3677 @cindex image descriptor |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3678 |
68946
956ccc6ec126
(Other Display Specs, Image Descriptors): Revert erroneous changes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
68708
diff
changeset
|
3679 An image description is a list of the form @code{(image . @var{props})}, |
956ccc6ec126
(Other Display Specs, Image Descriptors): Revert erroneous changes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
68708
diff
changeset
|
3680 where @var{props} is a property list containing alternating keyword |
956ccc6ec126
(Other Display Specs, Image Descriptors): Revert erroneous changes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
68708
diff
changeset
|
3681 symbols (symbols whose names start with a colon) and their values. |
956ccc6ec126
(Other Display Specs, Image Descriptors): Revert erroneous changes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
68708
diff
changeset
|
3682 You can use any Lisp object as a property, but the only properties |
956ccc6ec126
(Other Display Specs, Image Descriptors): Revert erroneous changes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
68708
diff
changeset
|
3683 that have any special meaning are certain symbols, all of them keywords. |
26400 | 3684 |
3685 Every image descriptor must contain the property @code{:type | |
3686 @var{type}} to specify the format of the image. The value of @var{type} | |
3687 should be an image type symbol; for example, @code{xpm} for an image in | |
3688 XPM format. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3689 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3690 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
|
3691 types: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3692 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3693 @table @code |
36730
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3694 @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
|
3695 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
|
3696 @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
|
3697 in @code{data-directory}. |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3698 |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3699 @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
|
3700 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
|
3701 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
|
3702 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
|
3703 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
|
3704 |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3705 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
|
3706 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
|
3707 @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
|
3708 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
|
3709 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
|
3710 |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3711 @item :margin @var{margin} |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3712 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
|
3713 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
|
3714 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
|
3715 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
|
3716 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
|
3717 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
|
3718 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3719 @item :ascent @var{ascent} |
29151 | 3720 The @code{:ascent} property specifies the amount of the image's |
3721 height to use for its ascent---that is, the part above the baseline. | |
3722 The value, @var{ascent}, must be a number in the range 0 to 100, or | |
3723 the symbol @code{center}. | |
3724 | |
3725 If @var{ascent} is a number, that percentage of the image's height is | |
3726 used for its ascent. | |
3727 | |
3728 If @var{ascent} is @code{center}, the image is vertically centered | |
3729 around a centerline which would be the vertical centerline of text drawn | |
3730 at the position of the image, in the manner specified by the text | |
3731 properties and overlays that apply to the image. | |
3732 | |
3733 If this property is omitted, it defaults to 50. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3734 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3735 @item :relief @var{relief} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3736 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
|
3737 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
|
3738 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
|
3739 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
|
3740 an unpressed button. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3741 |
35364 | 3742 @item :conversion @var{algorithm} |
3743 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
|
3744 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
|
3745 displayed; the value, @var{algorithm}, specifies which algorithm. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3746 |
33996 | 3747 @table @code |
3748 @item laplace | |
3749 @itemx emboss | |
3750 Specifies the Laplace edge detection algorithm, which blurs out small | |
3751 differences in color while highlighting larger differences. People | |
3752 sometimes consider this useful for displaying the image for a | |
3753 ``disabled'' button. | |
3754 | |
3755 @item (edge-detection :matrix @var{matrix} :color-adjust @var{adjust}) | |
3756 Specifies a general edge-detection algorithm. @var{matrix} must be | |
3757 either a nine-element list or a nine-element vector of numbers. A pixel | |
3758 at position @math{x/y} in the transformed image is computed from | |
3759 original pixels around that position. @var{matrix} specifies, for each | |
3760 pixel in the neighborhood of @math{x/y}, a factor with which that pixel | |
3761 will influence the transformed pixel; element @math{0} specifies the | |
3762 factor for the pixel at @math{x-1/y-1}, element @math{1} the factor for | |
3763 the pixel at @math{x/y-1} etc., as shown below: | |
3764 @iftex | |
3765 @tex | |
3766 $$\pmatrix{x-1/y-1 & x/y-1 & x+1/y-1 \cr | |
3767 x-1/y & x/y & x+1/y \cr | |
3768 x-1/y+1& x/y+1 & x+1/y+1 \cr}$$ | |
3769 @end tex | |
3770 @end iftex | |
3771 @ifnottex | |
3772 @display | |
3773 (x-1/y-1 x/y-1 x+1/y-1 | |
3774 x-1/y x/y x+1/y | |
3775 x-1/y+1 x/y+1 x+1/y+1) | |
3776 @end display | |
3777 @end ifnottex | |
3778 | |
3779 The resulting pixel is computed from the color intensity of the color | |
3780 resulting from summing up the RGB values of surrounding pixels, | |
3781 multiplied by the specified factors, and dividing that sum by the sum | |
3782 of the factors' absolute values. | |
3783 | |
3784 Laplace edge-detection currently uses a matrix of | |
3785 @iftex | |
3786 @tex | |
3787 $$\pmatrix{1 & 0 & 0 \cr | |
3788 0& 0 & 0 \cr | |
3789 9 & 9 & -1 \cr}$$ | |
3790 @end tex | |
3791 @end iftex | |
3792 @ifnottex | |
3793 @display | |
3794 (1 0 0 | |
3795 0 0 0 | |
3796 9 9 -1) | |
3797 @end display | |
3798 @end ifnottex | |
3799 | |
3800 Emboss edge-detection uses a matrix of | |
3801 @iftex | |
3802 @tex | |
3803 $$\pmatrix{ 2 & -1 & 0 \cr | |
3804 -1 & 0 & 1 \cr | |
3805 0 & 1 & -2 \cr}$$ | |
3806 @end tex | |
3807 @end iftex | |
3808 @ifnottex | |
3809 @display | |
3810 ( 2 -1 0 | |
3811 -1 0 1 | |
3812 0 1 -2) | |
3813 @end display | |
3814 @end ifnottex | |
3815 | |
3816 @item disabled | |
71957
61cb5aae3bc3
Put period and comma inside quotes.
Richard M. Stallman <rms@gnu.org>
parents:
71882
diff
changeset
|
3817 Specifies transforming the image so that it looks ``disabled.'' |
33996 | 3818 @end table |
3819 | |
3820 @item :mask @var{mask} | |
3821 If @var{mask} is @code{heuristic} or @code{(heuristic @var{bg})}, build | |
3822 a clipping mask for the image, so that the background of a frame is | |
3823 visible behind the image. If @var{bg} is not specified, or if @var{bg} | |
3824 is @code{t}, determine the background color of the image by looking at | |
3825 the four corners of the image, assuming the most frequently occurring | |
3826 color from the corners is the background color of the image. Otherwise, | |
3827 @var{bg} must be a list @code{(@var{red} @var{green} @var{blue})} | |
3828 specifying the color to assume for the background of the image. | |
3829 | |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
3830 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
|
3831 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
|
3832 specifying @code{:mask nil}. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3833 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3834 @item :pointer @var{shape} |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3835 This specifies the pointer shape when the mouse pointer is over this |
57225 | 3836 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
|
3837 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3838 @item :map @var{map} |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3839 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
|
3840 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3841 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
|
3842 @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
|
3843 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
|
3844 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3845 A rectangle is a cons |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3846 @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
|
3847 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
|
3848 corners of the rectangle area. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3849 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3850 A circle is a cons |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3851 @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
|
3852 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
|
3853 be a float or integer. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3854 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3855 A polygon is a cons |
57201
2950fcfcfa44
Correct various typos.
Luc Teirlinck <teirllm@auburn.edu>
parents:
57193
diff
changeset
|
3856 @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
|
3857 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
|
3858 |
70843
4f398d726c7c
(Pointer Shape): Node deleted.
Richard M. Stallman <rms@gnu.org>
parents:
70604
diff
changeset
|
3859 When the mouse pointer lies on a hot-spot area of an image, the |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3860 @var{plist} of that hot-spot is consulted; if it contains a @code{help-echo} |
70843
4f398d726c7c
(Pointer Shape): Node deleted.
Richard M. Stallman <rms@gnu.org>
parents:
70604
diff
changeset
|
3861 property, that defines a tool-tip for the hot-spot, and if it contains |
4f398d726c7c
(Pointer Shape): Node deleted.
Richard M. Stallman <rms@gnu.org>
parents:
70604
diff
changeset
|
3862 a @code{pointer} property, that defines the shape of the mouse cursor when |
4f398d726c7c
(Pointer Shape): Node deleted.
Richard M. Stallman <rms@gnu.org>
parents:
70604
diff
changeset
|
3863 it is on the hot-spot. |
57225 | 3864 @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
|
3865 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3866 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
|
3867 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
|
3868 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
|
3869 @var{id} is @code{area4}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3870 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3871 |
33996 | 3872 @defun image-mask-p spec &optional frame |
3873 This function returns @code{t} if image @var{spec} has a mask bitmap. | |
3874 @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
|
3875 @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
|
3876 (@pxref{Input Focus}). |
33996 | 3877 @end defun |
3878 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3879 @node XBM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3880 @subsection XBM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3881 @cindex XBM |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3882 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3883 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
|
3884 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
|
3885 always supported. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3886 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3887 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
|
3888 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3889 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3890 @item :foreground @var{foreground} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3891 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
|
3892 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
|
3893 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
|
3894 foreground color. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3895 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3896 @item :background @var{background} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3897 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
|
3898 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
|
3899 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
|
3900 background color. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3901 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3902 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3903 If you specify an XBM image using data within Emacs instead of an |
28792 | 3904 external file, use the following three properties: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3905 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3906 @table @code |
28792 | 3907 @item :data @var{data} |
3908 The value, @var{data}, specifies the contents of the image. | |
3909 There are three formats you can use for @var{data}: | |
3910 | |
3911 @itemize @bullet | |
3912 @item | |
3913 A vector of strings or bool-vectors, each specifying one line of the | |
3914 image. Do specify @code{:height} and @code{:width}. | |
3915 | |
3916 @item | |
3917 A string containing the same byte sequence as an XBM file would contain. | |
3918 You must not specify @code{:height} and @code{:width} in this case, | |
3919 because omitting them is what indicates the data has the format of an | |
3920 XBM file. The file contents specify the height and width of the image. | |
3921 | |
3922 @item | |
3923 A string or a bool-vector containing the bits of the image (plus perhaps | |
3924 some extra bits at the end that will not be used). It should contain at | |
3925 least @var{width} * @code{height} bits. In this case, you must specify | |
3926 @code{:height} and @code{:width}, both to indicate that the string | |
3927 contains just the bits rather than a whole XBM file, and to specify the | |
3928 size of the image. | |
3929 @end itemize | |
3930 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3931 @item :width @var{width} |
28792 | 3932 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
|
3933 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3934 @item :height @var{height} |
28792 | 3935 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
|
3936 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3937 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3938 @node XPM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3939 @subsection XPM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3940 @cindex XPM |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3941 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3942 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
|
3943 additional image property @code{:color-symbols} is also meaningful with |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3944 the @code{xpm} image type: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3945 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3946 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3947 @item :color-symbols @var{symbols} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3948 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
|
3949 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
|
3950 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
|
3951 specifies the actual color to use for displaying that name. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3952 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3953 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3954 @node GIF Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3955 @subsection GIF Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3956 @cindex GIF |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3957 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3958 For GIF images, specify image type @code{gif}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3959 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3960 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3961 @item :index @var{index} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3962 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
|
3963 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
|
3964 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
|
3965 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
|
3966 @end table |
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 @ignore |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3969 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
|
3970 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
|
3971 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
|
3972 every 0.1 seconds. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3973 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3974 (defun show-anim (file max) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3975 "Display multi-image GIF file FILE which contains MAX subimages." |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3976 (display-anim (current-buffer) file 0 max t)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3977 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3978 (defun display-anim (buffer file idx max first-time) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3979 (when (= idx max) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3980 (setq idx 0)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3981 (let ((img (create-image file nil :image idx))) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3982 (save-excursion |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3983 (set-buffer buffer) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3984 (goto-char (point-min)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3985 (unless first-time (delete-char 1)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3986 (insert-image img)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3987 (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
|
3988 @end ignore |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3989 |
76828 | 3990 @node PostScript Images |
3991 @subsection PostScript Images | |
3992 @cindex postscript images | |
3993 | |
3994 To use PostScript for an image, specify image type @code{postscript}. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3995 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
|
3996 these three properties: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3997 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3998 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3999 @item :pt-width @var{width} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4000 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
|
4001 points (1/72 inch). @var{width} must be an integer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4002 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4003 @item :pt-height @var{height} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4004 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
|
4005 (1/72 inch). @var{height} must be an integer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4006 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4007 @item :bounding-box @var{box} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4008 The value, @var{box}, must be a list or vector of four integers, which |
76828 | 4009 specifying the bounding box of the PostScript image, analogous to the |
4010 @samp{BoundingBox} comment found in PostScript files. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4011 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4012 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4013 %%BoundingBox: 22 171 567 738 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4014 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4015 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4016 |
76828 | 4017 Displaying PostScript images from Lisp data is not currently |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
4018 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
|
4019 See the @file{etc/NEWS} file to make sure. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
4020 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4021 @node Other Image Types |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4022 @subsection Other Image Types |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4023 @cindex PBM |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4024 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4025 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
|
4026 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
|
4027 image properties are supported. |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
4028 |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
4029 @table @code |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
4030 @item :foreground @var{foreground} |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
4031 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
|
4032 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
|
4033 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
|
4034 foreground color. |
32552
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
4035 |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
4036 @item :background @var{background} |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
4037 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
|
4038 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
|
4039 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
|
4040 background color. |
32552
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
4041 @end table |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4042 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
4043 For JPEG images, specify image type @code{jpeg}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4044 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4045 For TIFF images, specify image type @code{tiff}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4046 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4047 For PNG images, specify image type @code{png}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4048 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4049 @node Defining Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4050 @subsection Defining Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4051 |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4052 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
|
4053 @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
|
4054 |
59574
9ce057395159
(Defining Images): Mention DATA-P arg of create-image.
Richard M. Stallman <rms@gnu.org>
parents:
59505
diff
changeset
|
4055 @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
|
4056 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
|
4057 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
|
4058 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
|
4059 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
|
4060 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4061 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
|
4062 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
|
4063 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
|
4064 from the file's name. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4065 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4066 The remaining arguments, @var{props}, specify additional image |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4067 properties---for example, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4068 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4069 @example |
59574
9ce057395159
(Defining Images): Mention DATA-P arg of create-image.
Richard M. Stallman <rms@gnu.org>
parents:
59505
diff
changeset
|
4070 (create-image "foo.xpm" 'xpm nil :heuristic-mask t) |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4071 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4072 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4073 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
|
4074 supported. Otherwise it returns an image descriptor. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4075 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4076 |
41058
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
4077 @defmac defimage symbol specs &optional doc |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
4078 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
|
4079 @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
|
4080 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
|
4081 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4082 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
|
4083 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
|
4084 @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
|
4085 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
|
4086 @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
|
4087 @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
|
4088 example: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4089 |
25875 | 4090 @example |
4091 (defimage test-image | |
46338
6cf0fbc1d7da
defimage does not evaluate SPECS.
Richard M. Stallman <rms@gnu.org>
parents:
46245
diff
changeset
|
4092 ((:type xpm :file "~/test1.xpm") |
6cf0fbc1d7da
defimage does not evaluate SPECS.
Richard M. Stallman <rms@gnu.org>
parents:
46245
diff
changeset
|
4093 (:type xbm :file "~/test1.xbm"))) |
25875 | 4094 @end example |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4095 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4096 @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
|
4097 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
|
4098 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
|
4099 stored in @var{symbol}. |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
4100 |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
4101 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
|
4102 as @code{nil}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4103 @end defmac |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4104 |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4105 @defun find-image specs |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4106 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
|
4107 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
|
4108 |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4109 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
|
4110 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
|
4111 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
|
4112 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
|
4113 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
|
4114 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
|
4115 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
|
4116 @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
|
4117 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
|
4118 |
65546
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4119 The image is looked for in @code{image-load-path}. |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4120 @end defun |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4121 |
65546
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4122 @defvar image-load-path |
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4123 This variable's value is a list of locations in which to search for |
65598
bae76b0c6f5e
Updated documentation for `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65560
diff
changeset
|
4124 image files. If an element is a string or a variable symbol whose |
bae76b0c6f5e
Updated documentation for `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65560
diff
changeset
|
4125 value is a string, the string is taken to be the name of a directory |
bae76b0c6f5e
Updated documentation for `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65560
diff
changeset
|
4126 to search. If an element is a variable symbol whose value is a list, |
bae76b0c6f5e
Updated documentation for `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65560
diff
changeset
|
4127 that is taken to be a list of directory names to search. |
65546
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4128 |
65560
9007bcbba781
(Defining Images): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
65546
diff
changeset
|
4129 The default is to search in the @file{images} subdirectory of the |
9007bcbba781
(Defining Images): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
65546
diff
changeset
|
4130 directory specified by @code{data-directory}, then the directory |
9007bcbba781
(Defining Images): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
65546
diff
changeset
|
4131 specified by @code{data-directory}, and finally in the directories in |
65546
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4132 @code{load-path}. Subdirectories are not automatically included in |
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4133 the search, so if you put an image file in a subdirectory, you have to |
65560
9007bcbba781
(Defining Images): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
65546
diff
changeset
|
4134 supply the subdirectory name explicitly. For example, to find the |
65598
bae76b0c6f5e
Updated documentation for `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65560
diff
changeset
|
4135 image @file{images/foo/bar.xpm} within @code{data-directory}, you |
65560
9007bcbba781
(Defining Images): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
65546
diff
changeset
|
4136 should specify the image as follows: |
65546
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4137 |
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4138 @example |
65560
9007bcbba781
(Defining Images): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
65546
diff
changeset
|
4139 (defimage foo-image '((:type xpm :file "foo/bar.xpm"))) |
65546
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4140 @end example |
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4141 @end defvar |
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4142 |
69418
2f43ac9fe122
(Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents:
69067
diff
changeset
|
4143 @defun image-load-path-for-library library image &optional path no-error |
69521
3a3fa8d383e2
(Defining Images): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
69517
diff
changeset
|
4144 This function returns a suitable search path for images used by the |
3a3fa8d383e2
(Defining Images): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
69517
diff
changeset
|
4145 Lisp package @var{library}. |
3a3fa8d383e2
(Defining Images): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
69517
diff
changeset
|
4146 |
77123 | 4147 The function searches for @var{image} first using @code{image-load-path}, |
4148 excluding @file{@code{data-directory}/images}, and then in | |
71638 | 4149 @code{load-path}, followed by a path suitable for @var{library}, which |
4150 includes @file{../../etc/images} and @file{../etc/images} relative to | |
4151 the library file itself, and finally in | |
4152 @file{@code{data-directory}/images}. | |
69462
831f4f793f95
(Invisible Text): The impossible position is
Richard M. Stallman <rms@gnu.org>
parents:
69421
diff
changeset
|
4153 |
69464
68172dbc9679
(Defining Images): Clean up last change.
Richard M. Stallman <rms@gnu.org>
parents:
69462
diff
changeset
|
4154 Then this function returns a list of directories which contains first |
68172dbc9679
(Defining Images): Clean up last change.
Richard M. Stallman <rms@gnu.org>
parents:
69462
diff
changeset
|
4155 the directory in which @var{image} was found, followed by the value of |
68172dbc9679
(Defining Images): Clean up last change.
Richard M. Stallman <rms@gnu.org>
parents:
69462
diff
changeset
|
4156 @code{load-path}. If @var{path} is given, it is used instead of |
69473
279f737753d8
(Defining Images): In image-load-path-for-library, always return list
Bill Wohler <wohler@newt.com>
parents:
69464
diff
changeset
|
4157 @code{load-path}. |
279f737753d8
(Defining Images): In image-load-path-for-library, always return list
Bill Wohler <wohler@newt.com>
parents:
69464
diff
changeset
|
4158 |
279f737753d8
(Defining Images): In image-load-path-for-library, always return list
Bill Wohler <wohler@newt.com>
parents:
69464
diff
changeset
|
4159 If @var{no-error} is non-@code{nil} and a suitable path can't be |
279f737753d8
(Defining Images): In image-load-path-for-library, always return list
Bill Wohler <wohler@newt.com>
parents:
69464
diff
changeset
|
4160 found, don't signal an error. Instead, return a list of directories as |
279f737753d8
(Defining Images): In image-load-path-for-library, always return list
Bill Wohler <wohler@newt.com>
parents:
69464
diff
changeset
|
4161 before, except that @code{nil} appears in place of the image directory. |
69418
2f43ac9fe122
(Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents:
69067
diff
changeset
|
4162 |
2f43ac9fe122
(Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents:
69067
diff
changeset
|
4163 Here is an example that uses a common idiom to provide compatibility |
2f43ac9fe122
(Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents:
69067
diff
changeset
|
4164 with versions of Emacs that lack the variable @code{image-load-path}: |
2f43ac9fe122
(Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents:
69067
diff
changeset
|
4165 |
2f43ac9fe122
(Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents:
69067
diff
changeset
|
4166 @example |
71638 | 4167 (defvar image-load-path) ; shush compiler |
4168 (let* ((load-path (image-load-path-for-library | |
4169 "mh-e" "mh-logo.xpm")) | |
69494
a996c2fa0b6a
(Defining Images): Fix example in image-load-path-for-library by not
Bill Wohler <wohler@newt.com>
parents:
69473
diff
changeset
|
4170 (image-load-path (cons (car load-path) |
a996c2fa0b6a
(Defining Images): Fix example in image-load-path-for-library by not
Bill Wohler <wohler@newt.com>
parents:
69473
diff
changeset
|
4171 (when (boundp 'image-load-path) |
a996c2fa0b6a
(Defining Images): Fix example in image-load-path-for-library by not
Bill Wohler <wohler@newt.com>
parents:
69473
diff
changeset
|
4172 image-load-path)))) |
69418
2f43ac9fe122
(Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents:
69067
diff
changeset
|
4173 (mh-tool-bar-folder-buttons-init)) |
2f43ac9fe122
(Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents:
69067
diff
changeset
|
4174 @end example |
2f43ac9fe122
(Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents:
69067
diff
changeset
|
4175 @end defun |
2f43ac9fe122
(Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents:
69067
diff
changeset
|
4176 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4177 @node Showing Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4178 @subsection Showing Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4179 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4180 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
|
4181 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
|
4182 section. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4183 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
4184 @defun insert-image image &optional string area slice |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4185 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
|
4186 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
|
4187 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
|
4188 @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
|
4189 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
|
4190 @code{insert-image} uses @code{" "} by default. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4191 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4192 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
|
4193 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
|
4194 @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
|
4195 @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
|
4196 buffer's text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4197 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
4198 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
|
4199 @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
|
4200 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
|
4201 @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
|
4202 @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
|
4203 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
|
4204 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
|
4205 image. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
4206 |
25875 | 4207 Internally, this function inserts @var{string} in the buffer, and gives |
4208 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
|
4209 Property}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4210 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4211 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
4212 @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
|
4213 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
|
4214 @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
|
4215 equally sized slices. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
4216 @end defun |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
4217 |
29471 | 4218 @defun put-image image pos &optional string area |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4219 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
|
4220 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
|
4221 marker. It specifies the buffer position where the image should appear. |
29471 | 4222 The argument @var{string} specifies the text that should hold the image |
4223 as an alternative to the default. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4224 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4225 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
|
4226 by @code{create-image} or stored by @code{defimage}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4227 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4228 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
|
4229 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
|
4230 @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
|
4231 @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
|
4232 buffer's text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4233 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4234 Internally, this function creates an overlay, and gives it a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4235 @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
|
4236 property whose value is the image. (Whew!) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4237 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4238 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4239 @defun remove-images start end &optional buffer |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4240 This function removes images in @var{buffer} between positions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4241 @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
|
4242 images are removed from the current buffer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4243 |
27331
be0a552c8320
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
4244 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
|
4245 @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
|
4246 @code{insert-image} or in other ways. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4247 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4248 |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4249 @defun image-size spec &optional pixels frame |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4250 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
|
4251 @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
|
4252 specification. @var{pixels} non-@code{nil} means return sizes |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
4253 measured in pixels, otherwise return sizes measured in canonical |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
4254 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
|
4255 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
|
4256 @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
|
4257 Focus}). |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4258 @end defun |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4259 |
66197
53c764d16ccf
* display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents:
66143
diff
changeset
|
4260 @defvar max-image-size |
53c764d16ccf
* display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents:
66143
diff
changeset
|
4261 This variable is used to define the maximum size of image that Emacs |
66209
97afbe22dea4
(Showing Images): Add max-image-size integer value.
Kim F. Storm <storm@cua.dk>
parents:
66197
diff
changeset
|
4262 will load. Emacs will refuse to load (and display) any image that is |
97afbe22dea4
(Showing Images): Add max-image-size integer value.
Kim F. Storm <storm@cua.dk>
parents:
66197
diff
changeset
|
4263 larger than this limit. |
97afbe22dea4
(Showing Images): Add max-image-size integer value.
Kim F. Storm <storm@cua.dk>
parents:
66197
diff
changeset
|
4264 |
97afbe22dea4
(Showing Images): Add max-image-size integer value.
Kim F. Storm <storm@cua.dk>
parents:
66197
diff
changeset
|
4265 If the value is an integer, it directly specifies the maximum |
97afbe22dea4
(Showing Images): Add max-image-size integer value.
Kim F. Storm <storm@cua.dk>
parents:
66197
diff
changeset
|
4266 image height and width, measured in pixels. If it is a floating |
97afbe22dea4
(Showing Images): Add max-image-size integer value.
Kim F. Storm <storm@cua.dk>
parents:
66197
diff
changeset
|
4267 point number, it specifies the maximum image height and width |
97afbe22dea4
(Showing Images): Add max-image-size integer value.
Kim F. Storm <storm@cua.dk>
parents:
66197
diff
changeset
|
4268 as a ratio to the frame height and width. If the value is |
97afbe22dea4
(Showing Images): Add max-image-size integer value.
Kim F. Storm <storm@cua.dk>
parents:
66197
diff
changeset
|
4269 non-numeric, there is no explicit limit on the size of images. |
66197
53c764d16ccf
* display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents:
66143
diff
changeset
|
4270 |
53c764d16ccf
* display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents:
66143
diff
changeset
|
4271 The purpose of this variable is to prevent unreasonably large images |
53c764d16ccf
* display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents:
66143
diff
changeset
|
4272 from accidentally being loaded into Emacs. It only takes effect the |
53c764d16ccf
* display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents:
66143
diff
changeset
|
4273 first time an image is loaded. Once an image is placed in the image |
53c764d16ccf
* display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents:
66143
diff
changeset
|
4274 cache, it can always be displayed, even if the value of |
53c764d16ccf
* display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents:
66143
diff
changeset
|
4275 @var{max-image-size} is subsequently changed (@pxref{Image Cache}). |
53c764d16ccf
* display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents:
66143
diff
changeset
|
4276 @end defvar |
53c764d16ccf
* display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents:
66143
diff
changeset
|
4277 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4278 @node Image Cache |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4279 @subsection Image Cache |
76835 | 4280 @cindex image cache |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4281 |
78455
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4282 Emacs stores images in an image cache so that it can display them |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4283 again more efficiently. When Emacs displays an image, it searches the |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4284 image cache for an existing image specification @code{equal} to the |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4285 desired specification. If a match is found, the image is displayed |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4286 from the cache; otherwise, Emacs loads the image normally. |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4287 |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4288 Occasionally, you may need to tell Emacs to refresh the images |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4289 associated with a given image specification. For example, suppose you |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4290 display an image using a specification that contains a @code{:file} |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4291 property. The image is loaded from the given file and stored in the |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4292 image cache. If you later display the image again, using the same |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4293 image specification, the image is displayed from the image cache. |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4294 Normally, this is not a problem. However, if the image file has |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4295 changed in the meantime, Emacs would be displaying the old version of |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4296 the image. In such a situation, it is necessary to ``refresh'' the |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4297 image using @code{image-refresh}. |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4298 |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4299 @defun image-refresh spec &optional frame |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4300 This function refreshes any images having image specifications |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4301 @code{equal} to @var{spec} on frame @var{frame}. If @var{frame} is |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4302 @code{nil}, the selected frame is used. If @var{frame} is @code{t}, |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4303 the refresh is applied to all existing frames. |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4304 |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4305 This works by removing all image with image specifications matching |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4306 @var{spec} from the image cache. Thus, the next time the image is |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4307 displayed, Emacs will load the image again. |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4308 @end defun |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4309 |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4310 @defun clear-image-cache &optional frame |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4311 This function clears the entire image cache. If @var{frame} is |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4312 non-@code{nil}, only the cache for that frame is cleared. Otherwise, |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4313 all frames' caches are cleared. |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4314 @end defun |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4315 |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4316 If an image in the image cache has not been displayed for a specified |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4317 period of time, Emacs removes it from the cache and frees the |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4318 associated memory. |
28770 | 4319 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4320 @defvar image-cache-eviction-delay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4321 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
|
4322 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
|
4323 length of time, Emacs removes it from the image cache. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4324 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4325 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
|
4326 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
|
4327 debugging. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4328 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4329 |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4330 @node Buttons |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4331 @section Buttons |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4332 @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
|
4333 @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
|
4334 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4335 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
|
4336 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
|
4337 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
|
4338 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
|
4339 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4340 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
|
4341 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
|
4342 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
|
4343 |
71748 | 4344 One of 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
|
4345 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
|
4346 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
|
4347 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
|
4348 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4349 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
|
4350 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
|
4351 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
|
4352 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
|
4353 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
|
4354 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
|
4355 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
|
4356 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
|
4357 entries). |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4358 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4359 @menu |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4360 * 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
|
4361 * Button Types:: Defining common properties for classes of buttons. |
55246 | 4362 * 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
|
4363 * 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
|
4364 * 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
|
4365 @end menu |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4366 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4367 @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
|
4368 @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
|
4369 @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
|
4370 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4371 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
|
4372 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
|
4373 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
|
4374 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
|
4375 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4376 @table @code |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4377 @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
|
4378 @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
|
4379 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
|
4380 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
|
4381 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
|
4382 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4383 @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
|
4384 @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
|
4385 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
|
4386 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
|
4387 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
|
4388 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
|
4389 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4390 @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
|
4391 @kindex face @r{(button property)} |
55246 | 4392 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
|
4393 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
|
4394 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4395 @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
|
4396 @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
|
4397 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
|
4398 mouse-overs (merged with the usual button face); by default this is |
55246 | 4399 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
|
4400 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4401 @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
|
4402 @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
|
4403 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
|
4404 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
|
4405 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
|
4406 @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
|
4407 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4408 @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
|
4409 @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
|
4410 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
|
4411 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
|
4412 @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
|
4413 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4414 @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
|
4415 @kindex help-index @r{(button property)} |
55246 | 4416 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
|
4417 @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
|
4418 |
59467
9c3931bf6cd0
(Button Properties): Add follow-link keyword.
Kim F. Storm <storm@cua.dk>
parents:
59463
diff
changeset
|
4419 @item follow-link |
9c3931bf6cd0
(Button Properties): Add follow-link keyword.
Kim F. Storm <storm@cua.dk>
parents:
59463
diff
changeset
|
4420 @kindex follow-link @r{(button property)} |
59505
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4421 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
|
4422 on this button, @xref{Links and Mouse-1}. |
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4423 |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4424 @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
|
4425 @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
|
4426 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
|
4427 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
|
4428 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
|
4429 @end table |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4430 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4431 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
|
4432 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
|
4433 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4434 @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
|
4435 @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
|
4436 @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
|
4437 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4438 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
|
4439 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
|
4440 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
|
4441 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
|
4442 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
|
4443 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4444 @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
|
4445 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
|
4446 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
|
4447 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
|
4448 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
|
4449 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
|
4450 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4451 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
|
4452 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
|
4453 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
|
4454 @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
|
4455 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
|
4456 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4457 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4458 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
|
4459 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
|
4460 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
|
4461 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
|
4462 |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
4463 @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
|
4464 @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
|
4465 @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
|
4466 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4467 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
|
4468 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
|
4469 initialized from the button's type (which defaults to the built-in |
55246 | 4470 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
|
4471 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
|
4472 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
|
4473 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
|
4474 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4475 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
|
4476 those that add button properties to an existing region of a buffer, |
68084 | 4477 called @code{make-...button}, and those that also insert the button |
4478 text, called @code{insert-...button}. | |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4479 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4480 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
|
4481 @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
|
4482 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
|
4483 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
|
4484 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
|
4485 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
|
4486 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
|
4487 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
|
4488 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4489 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
|
4490 (@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
|
4491 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4492 @defun make-button beg end &rest properties |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4493 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
|
4494 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
|
4495 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4496 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4497 @defun insert-button label &rest properties |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4498 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
|
4499 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
|
4500 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4501 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4502 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
|
4503 (@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
|
4504 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
|
4505 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
|
4506 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
|
4507 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
|
4508 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
|
4509 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4510 @defun make-text-button beg end &rest properties |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4511 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
|
4512 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
|
4513 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4514 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4515 @defun insert-text-button label &rest properties |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4516 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
|
4517 properties. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4518 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4519 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4520 @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
|
4521 @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
|
4522 @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
|
4523 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4524 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
|
4525 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
|
4526 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
|
4527 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4528 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
|
4529 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
|
4530 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
|
4531 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
|
4532 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
|
4533 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4534 @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
|
4535 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
|
4536 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4537 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4538 @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
|
4539 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
|
4540 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4541 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4542 @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
|
4543 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
|
4544 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4545 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4546 @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
|
4547 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
|
4548 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4549 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4550 @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
|
4551 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
|
4552 @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
|
4553 @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
|
4554 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
|
4555 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4556 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4557 @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
|
4558 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
|
4559 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4560 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4561 @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
|
4562 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
|
4563 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4564 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4565 @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
|
4566 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
|
4567 @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
|
4568 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4569 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4570 @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
|
4571 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
|
4572 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4573 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4574 @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
|
4575 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
|
4576 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4577 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4578 @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
|
4579 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
|
4580 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4581 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4582 @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
|
4583 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
|
4584 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4585 |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4586 @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
|
4587 @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
|
4588 @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
|
4589 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4590 These are commands and functions for locating and operating on |
55246 | 4591 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
|
4592 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4593 @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
|
4594 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
|
4595 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
|
4596 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
|
4597 @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
|
4598 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
|
4599 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
|
4600 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
|
4601 |
59505
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4602 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
|
4603 @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
|
4604 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
|
4605 @xref{Links and Mouse-1}. |
59505
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4606 |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4607 @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
|
4608 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
|
4609 @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
|
4610 @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
|
4611 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
|
4612 @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
|
4613 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
|
4614 @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
|
4615 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
|
4616 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
|
4617 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
|
4618 @end deffn |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4619 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4620 @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
|
4621 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
|
4622 @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
|
4623 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
|
4624 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
|
4625 @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
|
4626 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
|
4627 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
|
4628 @end deffn |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4629 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4630 @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
|
4631 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
|
4632 @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
|
4633 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
|
4634 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
|
4635 @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
|
4636 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
|
4637 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
|
4638 @end deffn |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4639 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4640 @defun next-button pos &optional count-current |
77024 | 4641 @defunx previous-button pos &optional count-current |
4642 Return the next button after (for @code{next-button} or before (for | |
4643 @code{previous-button}) position @var{pos} in the current buffer. If | |
4644 @var{count-current} is non-@code{nil}, count any button at @var{pos} | |
4645 in the search, instead of starting at the next button. | |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4646 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4647 |
71009
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4648 @node Abstract Display |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4649 @section Abstract Display |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4650 @cindex ewoc |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4651 @cindex display, abstract |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4652 @cindex display, arbitrary objects |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4653 @cindex model/view/controller |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4654 @cindex view part, model/view/controller |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4655 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4656 The Ewoc package constructs buffer text that represents a structure |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4657 of Lisp objects, and updates the text to follow changes in that |
71201
02a3005af4a5
(Abstract Display): Fix typo.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
71103
diff
changeset
|
4658 structure. This is like the ``view'' component in the |
71009
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4659 ``model/view/controller'' design paradigm. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4660 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4661 An @dfn{ewoc} is a structure that organizes information required to |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4662 construct buffer text that represents certain Lisp data. The buffer |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4663 text of the ewoc has three parts, in order: first, fixed @dfn{header} |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4664 text; next, textual descriptions of a series of data elements (Lisp |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4665 objects that you specify); and last, fixed @dfn{footer} text. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4666 Specifically, an ewoc contains information on: |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4667 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4668 @itemize @bullet |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4669 @item |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4670 The buffer which its text is generated in. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4671 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4672 @item |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4673 The text's start position in the buffer. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4674 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4675 @item |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4676 The header and footer strings. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4677 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4678 @item |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4679 A doubly-linked chain of @dfn{nodes}, each of which contains: |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4680 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4681 @itemize |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4682 @item |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4683 A @dfn{data element}, a single Lisp object. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4684 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4685 @item |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4686 Links to the preceding and following nodes in the chain. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4687 @end itemize |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4688 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4689 @item |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4690 A @dfn{pretty-printer} function which is responsible for |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4691 inserting the textual representation of a data |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4692 element value into the current buffer. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4693 @end itemize |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4694 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4695 Typically, you define an ewoc with @code{ewoc-create}, and then pass |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4696 the resulting ewoc structure to other functions in the Ewoc package to |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4697 build nodes within it, and display it in the buffer. Once it is |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4698 displayed in the buffer, other functions determine the correspondance |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4699 between buffer positions and nodes, move point from one node's textual |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4700 representation to another, and so forth. @xref{Abstract Display |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4701 Functions}. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4702 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4703 A node @dfn{encapsulates} a data element much the way a variable |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4704 holds a value. Normally, encapsulation occurs as a part of adding a |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4705 node to the ewoc. You can retrieve the data element value and place a |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4706 new value in its place, like so: |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4707 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4708 @lisp |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4709 (ewoc-data @var{node}) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4710 @result{} value |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4711 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4712 (ewoc-set-data @var{node} @var{new-value}) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4713 @result{} @var{new-value} |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4714 @end lisp |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4715 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4716 @noindent |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4717 You can also use, as the data element value, a Lisp object (list or |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4718 vector) that is a container for the ``real'' value, or an index into |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4719 some other structure. The example (@pxref{Abstract Display Example}) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4720 uses the latter approach. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4721 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4722 When the data changes, you will want to update the text in the |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4723 buffer. You can update all nodes by calling @code{ewoc-refresh}, or |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4724 just specific nodes using @code{ewoc-invalidate}, or all nodes |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4725 satisfying a predicate using @code{ewoc-map}. Alternatively, you can |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4726 delete invalid nodes using @code{ewoc-delete} or @code{ewoc-filter}, |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4727 and add new nodes in their place. Deleting a node from an ewoc deletes |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4728 its associated textual description from buffer, as well. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4729 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4730 @menu |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4731 * Abstract Display Functions:: |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4732 * Abstract Display Example:: |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4733 @end menu |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4734 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4735 @node Abstract Display Functions |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4736 @subsection Abstract Display Functions |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4737 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4738 In this subsection, @var{ewoc} and @var{node} stand for the |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4739 structures described above (@pxref{Abstract Display}), while |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4740 @var{data} stands for an arbitrary Lisp object used as a data element. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4741 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4742 @defun ewoc-create pretty-printer &optional header footer nosep |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4743 This constructs and returns a new ewoc, with no nodes (and thus no data |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4744 elements). @var{pretty-printer} should be a function that takes one |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4745 argument, a data element of the sort you plan to use in this ewoc, and |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4746 inserts its textual description at point using @code{insert} (and never |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4747 @code{insert-before-markers}, because that would interfere with the |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4748 Ewoc package's internal mechanisms). |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4749 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4750 Normally, a newline is automatically inserted after the header, |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4751 the footer and every node's textual description. If @var{nosep} |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4752 is non-@code{nil}, no newline is inserted. This may be useful for |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4753 displaying an entire ewoc on a single line, for example, or for |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4754 making nodes ``invisible'' by arranging for @var{pretty-printer} |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4755 to do nothing for those nodes. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4756 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4757 An ewoc maintains its text in the buffer that is current when |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4758 you create it, so switch to the intended buffer before calling |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4759 @code{ewoc-create}. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4760 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4761 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4762 @defun ewoc-buffer ewoc |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4763 This returns the buffer where @var{ewoc} maintains its text. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4764 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4765 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4766 @defun ewoc-get-hf ewoc |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4767 This returns a cons cell @code{(@var{header} . @var{footer})} |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4768 made from @var{ewoc}'s header and footer. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4769 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4770 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4771 @defun ewoc-set-hf ewoc header footer |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4772 This sets the header and footer of @var{ewoc} to the strings |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4773 @var{header} and @var{footer}, respectively. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4774 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4775 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4776 @defun ewoc-enter-first ewoc data |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4777 @defunx ewoc-enter-last ewoc data |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4778 These add a new node encapsulating @var{data}, putting it, respectively, |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4779 at the beginning or end of @var{ewoc}'s chain of nodes. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4780 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4781 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4782 @defun ewoc-enter-before ewoc node data |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4783 @defunx ewoc-enter-after ewoc node data |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4784 These add a new node encapsulating @var{data}, adding it to |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4785 @var{ewoc} before or after @var{node}, respectively. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4786 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4787 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4788 @defun ewoc-prev ewoc node |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4789 @defunx ewoc-next ewoc node |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4790 These return, respectively, the previous node and the next node of @var{node} |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4791 in @var{ewoc}. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4792 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4793 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4794 @defun ewoc-nth ewoc n |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4795 This returns the node in @var{ewoc} found at zero-based index @var{n}. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4796 A negative @var{n} means count from the end. @code{ewoc-nth} returns |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4797 @code{nil} if @var{n} is out of range. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4798 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4799 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4800 @defun ewoc-data node |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4801 This extracts the data encapsulated by @var{node} and returns it. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4802 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4803 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4804 @defun ewoc-set-data node data |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4805 This sets the data encapsulated by @var{node} to @var{data}. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4806 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4807 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4808 @defun ewoc-locate ewoc &optional pos guess |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4809 This determines the node in @var{ewoc} which contains point (or |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4810 @var{pos} if specified), and returns that node. If @var{ewoc} has no |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4811 nodes, it returns @code{nil}. If @var{pos} is before the first node, |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4812 it returns the first node; if @var{pos} is after the last node, it returns |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4813 the last node. The optional third arg @var{guess} |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4814 should be a node that is likely to be near @var{pos}; this doesn't |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4815 alter the result, but makes the function run faster. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4816 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4817 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4818 @defun ewoc-location node |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4819 This returns the start position of @var{node}. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4820 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4821 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4822 @defun ewoc-goto-prev ewoc arg |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4823 @defunx ewoc-goto-next ewoc arg |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4824 These move point to the previous or next, respectively, @var{arg}th node |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4825 in @var{ewoc}. @code{ewoc-goto-prev} does not move if it is already at |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4826 the first node or if @var{ewoc} is empty, whereas @code{ewoc-goto-next} |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4827 moves past the last node, returning @code{nil}. Excepting this special |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4828 case, these functions return the node moved to. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4829 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4830 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4831 @defun ewoc-goto-node ewoc node |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4832 This moves point to the start of @var{node} in @var{ewoc}. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4833 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4834 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4835 @defun ewoc-refresh ewoc |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4836 This function regenerates the text of @var{ewoc}. It works by |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4837 deleting the text between the header and the footer, i.e., all the |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4838 data elements' representations, and then calling the pretty-printer |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4839 function for each node, one by one, in order. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4840 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4841 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4842 @defun ewoc-invalidate ewoc &rest nodes |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4843 This is similar to @code{ewoc-refresh}, except that only @var{nodes} in |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4844 @var{ewoc} are updated instead of the entire set. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4845 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4846 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4847 @defun ewoc-delete ewoc &rest nodes |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4848 This deletes each node in @var{nodes} from @var{ewoc}. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4849 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4850 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4851 @defun ewoc-filter ewoc predicate &rest args |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4852 This calls @var{predicate} for each data element in @var{ewoc} and |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4853 deletes those nodes for which @var{predicate} returns @code{nil}. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4854 Any @var{args} are passed to @var{predicate}. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4855 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4856 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4857 @defun ewoc-collect ewoc predicate &rest args |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4858 This calls @var{predicate} for each data element in @var{ewoc} |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4859 and returns a list of those elements for which @var{predicate} |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4860 returns non-@code{nil}. The elements in the list are ordered |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4861 as in the buffer. Any @var{args} are passed to @var{predicate}. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4862 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4863 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4864 @defun ewoc-map map-function ewoc &rest args |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4865 This calls @var{map-function} for each data element in @var{ewoc} and |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4866 updates those nodes for which @var{map-function} returns non-@code{nil}. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4867 Any @var{args} are passed to @var{map-function}. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4868 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4869 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4870 @node Abstract Display Example |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4871 @subsection Abstract Display Example |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4872 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4873 Here is a simple example using functions of the ewoc package to |
71957
61cb5aae3bc3
Put period and comma inside quotes.
Richard M. Stallman <rms@gnu.org>
parents:
71882
diff
changeset
|
4874 implement a ``color components display,'' an area in a buffer that |
71009
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4875 represents a vector of three integers (itself representing a 24-bit RGB |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4876 value) in various ways. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4877 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4878 @example |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4879 (setq colorcomp-ewoc nil |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4880 colorcomp-data nil |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4881 colorcomp-mode-map nil |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4882 colorcomp-labels ["Red" "Green" "Blue"]) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4883 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4884 (defun colorcomp-pp (data) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4885 (if data |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4886 (let ((comp (aref colorcomp-data data))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4887 (insert (aref colorcomp-labels data) "\t: #x" |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4888 (format "%02X" comp) " " |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4889 (make-string (ash comp -2) ?#) "\n")) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4890 (let ((cstr (format "#%02X%02X%02X" |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4891 (aref colorcomp-data 0) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4892 (aref colorcomp-data 1) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4893 (aref colorcomp-data 2))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4894 (samp " (sample text) ")) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4895 (insert "Color\t: " |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4896 (propertize samp 'face `(foreground-color . ,cstr)) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4897 (propertize samp 'face `(background-color . ,cstr)) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4898 "\n")))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4899 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4900 (defun colorcomp (color) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4901 "Allow fiddling with COLOR in a new buffer. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4902 The buffer is in Color Components mode." |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4903 (interactive "sColor (name or #RGB or #RRGGBB): ") |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4904 (when (string= "" color) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4905 (setq color "green")) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4906 (unless (color-values color) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4907 (error "No such color: %S" color)) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4908 (switch-to-buffer |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4909 (generate-new-buffer (format "originally: %s" color))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4910 (kill-all-local-variables) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4911 (setq major-mode 'colorcomp-mode |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4912 mode-name "Color Components") |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4913 (use-local-map colorcomp-mode-map) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4914 (erase-buffer) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4915 (buffer-disable-undo) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4916 (let ((data (apply 'vector (mapcar (lambda (n) (ash n -8)) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4917 (color-values color)))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4918 (ewoc (ewoc-create 'colorcomp-pp |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4919 "\nColor Components\n\n" |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4920 (substitute-command-keys |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4921 "\n\\@{colorcomp-mode-map@}")))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4922 (set (make-local-variable 'colorcomp-data) data) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4923 (set (make-local-variable 'colorcomp-ewoc) ewoc) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4924 (ewoc-enter-last ewoc 0) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4925 (ewoc-enter-last ewoc 1) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4926 (ewoc-enter-last ewoc 2) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4927 (ewoc-enter-last ewoc nil))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4928 @end example |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4929 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4930 @cindex controller part, model/view/controller |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4931 This example can be extended to be a ``color selection widget'' (in |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4932 other words, the controller part of the ``model/view/controller'' |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4933 design paradigm) by defining commands to modify @code{colorcomp-data} |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4934 and to ``finish'' the selection process, and a keymap to tie it all |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4935 together conveniently. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4936 |
71638 | 4937 @smallexample |
71009
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4938 (defun colorcomp-mod (index limit delta) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4939 (let ((cur (aref colorcomp-data index))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4940 (unless (= limit cur) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4941 (aset colorcomp-data index (+ cur delta))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4942 (ewoc-invalidate |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4943 colorcomp-ewoc |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4944 (ewoc-nth colorcomp-ewoc index) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4945 (ewoc-nth colorcomp-ewoc -1)))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4946 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4947 (defun colorcomp-R-more () (interactive) (colorcomp-mod 0 255 1)) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4948 (defun colorcomp-G-more () (interactive) (colorcomp-mod 1 255 1)) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4949 (defun colorcomp-B-more () (interactive) (colorcomp-mod 2 255 1)) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4950 (defun colorcomp-R-less () (interactive) (colorcomp-mod 0 0 -1)) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4951 (defun colorcomp-G-less () (interactive) (colorcomp-mod 1 0 -1)) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4952 (defun colorcomp-B-less () (interactive) (colorcomp-mod 2 0 -1)) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4953 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4954 (defun colorcomp-copy-as-kill-and-exit () |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4955 "Copy the color components into the kill ring and kill the buffer. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4956 The string is formatted #RRGGBB (hash followed by six hex digits)." |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4957 (interactive) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4958 (kill-new (format "#%02X%02X%02X" |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4959 (aref colorcomp-data 0) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4960 (aref colorcomp-data 1) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4961 (aref colorcomp-data 2))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4962 (kill-buffer nil)) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4963 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4964 (setq colorcomp-mode-map |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4965 (let ((m (make-sparse-keymap))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4966 (suppress-keymap m) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4967 (define-key m "i" 'colorcomp-R-less) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4968 (define-key m "o" 'colorcomp-R-more) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4969 (define-key m "k" 'colorcomp-G-less) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4970 (define-key m "l" 'colorcomp-G-more) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4971 (define-key m "," 'colorcomp-B-less) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4972 (define-key m "." 'colorcomp-B-more) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4973 (define-key m " " 'colorcomp-copy-as-kill-and-exit) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4974 m)) |
71638 | 4975 @end smallexample |
71009
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4976 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4977 Note that we never modify the data in each node, which is fixed when the |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4978 ewoc is created to be either @code{nil} or an index into the vector |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4979 @code{colorcomp-data}, the actual color components. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4980 |
6598 | 4981 @node Blinking |
4982 @section Blinking Parentheses | |
4983 @cindex parenthesis matching | |
77010
e009ed31b7cf
Improve index entries. Remove redundant ones.
Richard M. Stallman <rms@gnu.org>
parents:
76850
diff
changeset
|
4984 @cindex blinking parentheses |
6598 | 4985 @cindex balancing parentheses |
4986 | |
4987 This section describes the mechanism by which Emacs shows a matching | |
4988 open parenthesis when the user inserts a close parenthesis. | |
4989 | |
4990 @defvar blink-paren-function | |
4991 The value of this variable should be a function (of no arguments) to | |
4992 be called whenever a character with close parenthesis syntax is inserted. | |
4993 The value of @code{blink-paren-function} may be @code{nil}, in which | |
4994 case nothing is done. | |
4995 @end defvar | |
4996 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
4997 @defopt blink-matching-paren |
6598 | 4998 If this variable is @code{nil}, then @code{blink-matching-open} does |
4999 nothing. | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5000 @end defopt |
6598 | 5001 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5002 @defopt blink-matching-paren-distance |
6598 | 5003 This variable specifies the maximum distance to scan for a matching |
5004 parenthesis before giving up. | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5005 @end defopt |
6598 | 5006 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5007 @defopt blink-matching-delay |
12098 | 5008 This variable specifies the number of seconds for the cursor to remain |
5009 at the matching parenthesis. A fraction of a second often gives | |
5010 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
|
5011 @end defopt |
12098 | 5012 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5013 @deffn Command blink-matching-open |
6598 | 5014 This function is the default value of @code{blink-paren-function}. It |
5015 assumes that point follows a character with close parenthesis syntax and | |
5016 moves the cursor momentarily to the matching opening character. If that | |
5017 character is not already on the screen, it displays the character's | |
5018 context in the echo area. To avoid long delays, this function does not | |
5019 search farther than @code{blink-matching-paren-distance} characters. | |
5020 | |
5021 Here is an example of calling this function explicitly. | |
5022 | |
5023 @smallexample | |
5024 @group | |
5025 (defun interactive-blink-matching-open () | |
5026 @c Do not break this line! -- rms. | |
5027 @c The first line of a doc string | |
5028 @c must stand alone. | |
5029 "Indicate momentarily the start of sexp before point." | |
5030 (interactive) | |
5031 @end group | |
5032 @group | |
5033 (let ((blink-matching-paren-distance | |
5034 (buffer-size)) | |
5035 (blink-matching-paren t)) | |
5036 (blink-matching-open))) | |
5037 @end group | |
5038 @end smallexample | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5039 @end deffn |
6598 | 5040 |
5041 @node Usual Display | |
5042 @section Usual Display Conventions | |
5043 | |
5044 The usual display conventions define how to display each character | |
5045 code. You can override these conventions by setting up a display table | |
5046 (@pxref{Display Tables}). Here are the usual display conventions: | |
5047 | |
5048 @itemize @bullet | |
5049 @item | |
5050 Character codes 32 through 126 map to glyph codes 32 through 126. | |
5051 Normally this means they display as themselves. | |
5052 | |
5053 @item | |
5054 Character code 9 is a horizontal tab. It displays as whitespace | |
5055 up to a position determined by @code{tab-width}. | |
5056 | |
5057 @item | |
5058 Character code 10 is a newline. | |
5059 | |
5060 @item | |
5061 All other codes in the range 0 through 31, and code 127, display in one | |
9009 | 5062 of two ways according to the value of @code{ctl-arrow}. If it is |
6598 | 5063 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
|
5064 first glyph is the @acronym{ASCII} code for @samp{^}. (A display table can |
6598 | 5065 specify a glyph to use instead of @samp{^}.) Otherwise, these codes map |
5066 just like the codes in the range 128 to 255. | |
5067 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5068 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
|
5069 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
|
5070 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
|
5071 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
|
5072 emacs, The GNU Emacs Manual}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5073 |
6598 | 5074 @item |
5075 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
|
5076 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
|
5077 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
|
5078 table can specify a glyph to use instead of @samp{\}.) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
5079 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
5080 @item |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
5081 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
|
5082 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
|
5083 character. |
6598 | 5084 @end itemize |
5085 | |
5086 The usual display conventions apply even when there is a display | |
5087 table, for any character whose entry in the active display table is | |
5088 @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
|
5089 specify the characters for which you want special behavior. |
6598 | 5090 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
5091 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
|
5092 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
|
5093 buffer where you expect it, if it was eliminated as part of end-of-line |
25454 | 5094 conversion (@pxref{Coding System Basics}). |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
5095 |
6598 | 5096 These variables affect the way certain characters are displayed on the |
5097 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
|
5098 they also affect the indentation functions. These variables also affect |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5099 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
|
5100 mode line using the new values, call the function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5101 @code{force-mode-line-update} (@pxref{Mode Line Format}). |
6598 | 5102 |
5103 @defopt ctl-arrow | |
5104 @cindex control characters in display | |
5105 This buffer-local variable controls how control characters are | |
5106 displayed. If it is non-@code{nil}, they are displayed as a caret | |
5107 followed by the character: @samp{^A}. If it is @code{nil}, they are | |
5108 displayed as a backslash followed by three octal digits: @samp{\001}. | |
5109 @end defopt | |
5110 | |
5111 @c Following may have overfull hbox. | |
5112 @defvar default-ctl-arrow | |
5113 The value of this variable is the default value for @code{ctl-arrow} in | |
5114 buffers that do not override it. @xref{Default Value}. | |
5115 @end defvar | |
5116 | |
58496
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
5117 @defopt tab-width |
65369
822218f80ae4
2005-09-08 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
65121
diff
changeset
|
5118 The value of this buffer-local variable is the spacing between tab |
822218f80ae4
2005-09-08 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
65121
diff
changeset
|
5119 stops used for displaying tab characters in Emacs buffers. The value |
822218f80ae4
2005-09-08 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
65121
diff
changeset
|
5120 is in units of columns, and the default is 8. Note that this feature |
822218f80ae4
2005-09-08 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
65121
diff
changeset
|
5121 is completely independent of the user-settable tab stops used by the |
822218f80ae4
2005-09-08 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
65121
diff
changeset
|
5122 command @code{tab-to-tab-stop}. @xref{Indent Tabs}. |
58496
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
5123 @end defopt |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
5124 |
6598 | 5125 @node Display Tables |
5126 @section Display Tables | |
5127 | |
5128 @cindex display table | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
5129 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
|
5130 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
|
5131 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
|
5132 set. |
6598 | 5133 |
5134 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
|
5135 @dfn{glyphs}, each glyph being a graphic that takes up one character |
6598 | 5136 position on the screen. You can also define how to display each glyph |
5137 on your terminal, using the @dfn{glyph table}. | |
5138 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5139 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
|
5140 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
|
5141 @code{force-mode-line-update} (@pxref{Mode Line Format}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5142 |
6598 | 5143 @menu |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
5144 * 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
|
5145 * 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
|
5146 * Glyphs:: How to define a glyph, and what glyphs mean. |
6598 | 5147 @end menu |
5148 | |
5149 @node Display Table Format | |
5150 @subsection Display Table Format | |
5151 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
5152 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
|
5153 @code{display-table} as its subtype. |
6598 | 5154 |
5155 @defun make-display-table | |
5156 This creates and returns a display table. The table initially has | |
5157 @code{nil} in all elements. | |
5158 @end defun | |
5159 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5160 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
|
5161 codes; the element at index @var{c} says how to display the character |
72820
501a2788cfa4
(Display Table Format): Wording clarification
Richard M. Stallman <rms@gnu.org>
parents:
72789
diff
changeset
|
5162 code @var{c}. The value should be @code{nil} or a vector of the |
501a2788cfa4
(Display Table Format): Wording clarification
Richard M. Stallman <rms@gnu.org>
parents:
72789
diff
changeset
|
5163 glyphs to be output (@pxref{Glyphs}). @code{nil} says to display the |
501a2788cfa4
(Display Table Format): Wording clarification
Richard M. Stallman <rms@gnu.org>
parents:
72789
diff
changeset
|
5164 character @var{c} according to the usual display conventions |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5165 (@pxref{Usual Display}). |
12067 | 5166 |
72820
501a2788cfa4
(Display Table Format): Wording clarification
Richard M. Stallman <rms@gnu.org>
parents:
72789
diff
changeset
|
5167 @strong{Warning:} if you use the display table to change the display |
501a2788cfa4
(Display Table Format): Wording clarification
Richard M. Stallman <rms@gnu.org>
parents:
72789
diff
changeset
|
5168 of newline characters, the whole buffer will be displayed as one long |
501a2788cfa4
(Display Table Format): Wording clarification
Richard M. Stallman <rms@gnu.org>
parents:
72789
diff
changeset
|
5169 ``line.'' |
6598 | 5170 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5171 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
|
5172 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
|
5173 means to use the default for that slot, as stated below. |
6598 | 5174 |
5175 @table @asis | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5176 @item 0 |
6598 | 5177 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
|
5178 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
|
5179 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
|
5180 no effect. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
5181 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5182 @item 1 |
6598 | 5183 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
|
5184 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
|
5185 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
|
5186 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5187 @item 2 |
6598 | 5188 The glyph for indicating a character displayed as an octal character |
5189 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
|
5190 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5191 @item 3 |
6598 | 5192 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
|
5193 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5194 @item 4 |
6598 | 5195 A vector of glyphs for indicating the presence of invisible lines (the |
5196 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
|
5197 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5198 @item 5 |
8925 | 5199 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
|
5200 default is @samp{|}). @xref{Splitting Windows}. This takes effect only |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5201 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
|
5202 a scroll bar separates the two windows. |
6598 | 5203 @end table |
5204 | |
5205 For example, here is how to construct a display table that mimics the | |
5206 effect of setting @code{ctl-arrow} to a non-@code{nil} value: | |
5207 | |
5208 @example | |
5209 (setq disptab (make-display-table)) | |
5210 (let ((i 0)) | |
5211 (while (< i 32) | |
5212 (or (= i ?\t) (= i ?\n) | |
5213 (aset disptab i (vector ?^ (+ i 64)))) | |
5214 (setq i (1+ i))) | |
5215 (aset disptab 127 (vector ?^ ??))) | |
5216 @end example | |
5217 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
5218 @defun display-table-slot display-table slot |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5219 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
|
5220 @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
|
5221 5 inclusive, or a slot name (symbol). Valid symbols are |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5222 @code{truncation}, @code{wrap}, @code{escape}, @code{control}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5223 @code{selective-display}, and @code{vertical-border}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5224 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5225 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
5226 @defun set-display-table-slot display-table slot value |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5227 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
|
5228 @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
|
5229 5 inclusive, or a slot name (symbol). Valid symbols are |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5230 @code{truncation}, @code{wrap}, @code{escape}, @code{control}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5231 @code{selective-display}, and @code{vertical-border}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5232 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5233 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5234 @defun describe-display-table display-table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5235 This function displays a description of the display table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5236 @var{display-table} in a help buffer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5237 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5238 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5239 @deffn Command describe-current-display-table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5240 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
|
5241 help buffer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5242 @end deffn |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5243 |
6598 | 5244 @node Active Display Table |
5245 @subsection Active Display Table | |
5246 @cindex active display table | |
5247 | |
5248 Each window can specify a display table, and so can each buffer. When | |
5249 a buffer @var{b} is displayed in window @var{w}, display uses the | |
5250 display table for window @var{w} if it has one; otherwise, the display | |
5251 table for buffer @var{b} if it has one; otherwise, the standard display | |
5252 table if any. The display table chosen is called the @dfn{active} | |
5253 display table. | |
5254 | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
5255 @defun window-display-table &optional window |
6598 | 5256 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
|
5257 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
|
5258 for @var{window} is the selected window. |
6598 | 5259 @end defun |
5260 | |
5261 @defun set-window-display-table window table | |
5262 This function sets the display table of @var{window} to @var{table}. | |
5263 The argument @var{table} should be either a display table or | |
5264 @code{nil}. | |
5265 @end defun | |
5266 | |
5267 @defvar buffer-display-table | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
5268 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
|
5269 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
|
5270 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
|
5271 table. |
6598 | 5272 @end defvar |
5273 | |
5274 @defvar standard-display-table | |
5275 This variable's value is the default display table, used whenever a | |
5276 window has no display table and neither does the buffer displayed in | |
5277 that window. This variable is @code{nil} by default. | |
5278 @end defvar | |
5279 | |
5280 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
|
5281 if the window specifies none, its buffer specifies none, and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5282 @code{standard-display-table} is @code{nil}---then Emacs uses the usual |
6598 | 5283 display conventions for all character codes in that window. @xref{Usual |
5284 Display}. | |
5285 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5286 A number of functions for changing the standard display table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5287 are defined in the library @file{disp-table}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5288 |
6598 | 5289 @node Glyphs |
5290 @subsection Glyphs | |
5291 | |
5292 @cindex glyph | |
5293 A @dfn{glyph} is a generalization of a character; it stands for an | |
75875
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5294 image that takes up a single character position on the screen. Normally |
75755 | 5295 glyphs come from vectors in the display table (@pxref{Display Tables}). |
72822
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5296 |
75875
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5297 A glyph is represented in Lisp as a @dfn{glyph code}. A glyph code |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5298 can be @dfn{simple} or it can be defined by the @dfn{glyph table}. A |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5299 simple glyph code is just a way of specifying a character and a face |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5300 to output it in. @xref{Faces}. |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5301 |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5302 The following functions are used to manipulate simple glyph codes: |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5303 |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5304 @defun make-glyph-code char &optional face |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5305 This function returns a simple glyph code representing char @var{char} |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5306 with face @var{face}. |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5307 @end defun |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5308 |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5309 @defun glyph-char glyph |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5310 This function returns the character of simple glyph code @var{glyph}. |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5311 @end defun |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5312 |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5313 @defun glyph-face glyph |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5314 This function returns face of simple glyph code @var{glyph}, or |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5315 @code{nil} if @var{glyph} has the default face (face-id 0). |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5316 @end defun |
47482
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
5317 |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
5318 On character terminals, you can set up a @dfn{glyph table} to define |
75875
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5319 the meaning of glyph codes (represented as small integers). |
6598 | 5320 |
5321 @defvar glyph-table | |
72822
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5322 The value of this variable is the current glyph table. It should be |
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5323 @code{nil} or a vector whose @var{g}th element defines glyph code |
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5324 @var{g}. |
47482
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
5325 |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
5326 If a glyph code is greater than or equal to the length of the glyph |
72822
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5327 table, that code is automatically simple. If @code{glyph-table} is |
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5328 @code{nil} then all glyph codes are simple. |
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5329 |
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5330 The glyph table is used only on character terminals. On graphical |
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5331 displays, all glyph codes are simple. |
6598 | 5332 @end defvar |
5333 | |
72822
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5334 Here are the meaningful types of elements in the glyph table: |
6598 | 5335 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5336 @table @asis |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5337 @item @var{string} |
6598 | 5338 Send the characters in @var{string} to the terminal to output |
72822
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5339 this glyph code. |
6598 | 5340 |
75875
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5341 @item @var{code} |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5342 Define this glyph code as an alias for glyph code @var{code} created |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5343 by @code{make-glyph-code}. You can use such an alias to define a |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5344 small-numbered glyph code which specifies a character with a face. |
6598 | 5345 |
5346 @item @code{nil} | |
72822
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5347 This glyph code is simple. |
6598 | 5348 @end table |
5349 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5350 @defun create-glyph string |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5351 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
|
5352 display by sending @var{string} to the terminal. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5353 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5354 |
6598 | 5355 @node Beeping |
5356 @section Beeping | |
77010
e009ed31b7cf
Improve index entries. Remove redundant ones.
Richard M. Stallman <rms@gnu.org>
parents:
76850
diff
changeset
|
5357 @c @cindex beeping "beep" is adjacent |
6598 | 5358 @cindex bell |
5359 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5360 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
|
5361 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
|
5362 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
|
5363 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
|
5364 appropriate. (@xref{Errors}.) |
6598 | 5365 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
5366 @defun ding &optional do-not-terminate |
6598 | 5367 @cindex keyboard macro termination |
5368 This function beeps, or flashes the screen (see @code{visible-bell} below). | |
5369 It also terminates any keyboard macro currently executing unless | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
5370 @var{do-not-terminate} is non-@code{nil}. |
6598 | 5371 @end defun |
5372 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
5373 @defun beep &optional do-not-terminate |
6598 | 5374 This is a synonym for @code{ding}. |
5375 @end defun | |
5376 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5377 @defopt visible-bell |
6598 | 5378 This variable determines whether Emacs should flash the screen to |
5379 represent a bell. Non-@code{nil} means yes, @code{nil} means no. This | |
68708
c0833efdd110
"Graphical display", not window system.
Richard M. Stallman <rms@gnu.org>
parents:
68648
diff
changeset
|
5380 is effective on graphical displays, and on text-only terminals |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
5381 provided the terminal's Termcap entry defines the visible bell |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
5382 capability (@samp{vb}). |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5383 @end defopt |
6598 | 5384 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
5385 @defvar ring-bell-function |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5386 If this is non-@code{nil}, it specifies how Emacs should ``ring the |
25875 | 5387 bell.'' Its value should be a function of no arguments. If this is |
5388 non-@code{nil}, it takes precedence over the @code{visible-bell} | |
5389 variable. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5390 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5391 |
6598 | 5392 @node Window Systems |
5393 @section Window Systems | |
5394 | |
5395 Emacs works with several window systems, most notably the X Window | |
71957
61cb5aae3bc3
Put period and comma inside quotes.
Richard M. Stallman <rms@gnu.org>
parents:
71882
diff
changeset
|
5396 System. Both Emacs and X use the term ``window,'' but use it |
6598 | 5397 differently. An Emacs frame is a single window as far as X is |
5398 concerned; the individual Emacs windows are not known to X at all. | |
5399 | |
5400 @defvar window-system | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5401 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
|
5402 under. The possible values are |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5403 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5404 @table @code |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5405 @item x |
6598 | 5406 @cindex X Window System |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5407 Emacs is displaying using X. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5408 @item pc |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5409 Emacs is displaying using MS-DOS. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5410 @item w32 |
27332
5cfe77eaff45
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27331
diff
changeset
|
5411 Emacs is displaying using Windows. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5412 @item mac |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5413 Emacs is displaying using a Macintosh. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5414 @item nil |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5415 Emacs is using a character-based terminal. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5416 @end table |
6598 | 5417 @end defvar |
5418 | |
5419 @defvar window-setup-hook | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5420 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
|
5421 initialization files. Emacs runs this hook after it has completed |
25875 | 5422 loading your init file, the default initialization file (if |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
5423 any), and the terminal-specific Lisp code, and running the hook |
6598 | 5424 @code{term-setup-hook}. |
5425 | |
5426 This hook is used for internal purposes: setting up communication with | |
5427 the window system, and creating the initial window. Users should not | |
5428 interfere with it. | |
5429 @end defvar | |
52401 | 5430 |
5431 @ignore | |
5432 arch-tag: ffdf5714-7ecf-415b-9023-fbc6b409c2c6 | |
5433 @end ignore |